Commit Graph

747 Commits

Author SHA1 Message Date
Nicolas Goaziou 14420911f7 org-manual: Add a footnote about point movement on invisible text
* doc/org-manual.org (Link Format): Add a footnote about invisible
  text.

Reported-by: Alain.Cochard@unistra.fr
<http://lists.gnu.org/r/emacs-orgmode/2018-07/msg00015.html>
2018-07-04 23:46:58 +02:00
Nicolas Goaziou beaf58a815 org-manual: Do not document entities as a way to escape markup
* doc/org-manual.org (Special Symbols): Do not document entities as
  a way to escape markup.  In this example, a zero width space is more
  appropriate.
2018-07-04 23:37:48 +02:00
Nicolas Goaziou 9cc47f8853 org-manual: Tiny change
* doc/org-manual.org (Hacking): Tiny change.
2018-07-04 23:35:04 +02:00
Nicolas Goaziou b94e6e2b45 org-manual: Move "MobileOrg" into "Miscellaneous"
* doc/org-manual.org (MobileOrg): Moved into "Miscellaneous".

MobileOrg doesn't belong to Org proper.  It should be documented in
the manual, but not at the top level.
2018-07-04 23:35:04 +02:00
Nicolas Goaziou fb714739cb org-manual: Rename "Markup for Rich Export"
* doc/org-manual.org (Markup for Rich Contents): Renamed from "Markup
  for Rich Export".  Rewrite the introduction and the description.
(Exporting): Fix cross-reference.

At this point, the export framework hasn't been described so it could
be confusing to use it in the section name.
2018-07-04 23:35:04 +02:00
Nicolas Goaziou 53ec5f0a05 org-manual: Improve and relocate linter documentation
* doc/org-manual.org (Org Syntax): Move to "Miscellaneous".  Expound
  documentation about how to use the linter.

The syntax happens too early in the manual, before most elements are
even described.
2018-07-04 23:35:04 +02:00
Nicolas Goaziou b3e00f0c53 org-manual: Rename "Advanced Configuration"
* doc/org-manual.org (Advanced Export Configuration): Renamed from
  "Advanced Configuration".
(Example blocks in LaTeX export): Fix link.

When browsing the menu, "Advanced Configuration" is too vague, and
doesn't correlate immediately to Export.
2018-07-04 23:35:04 +02:00
Nicolas Goaziou dc41eb2bdc org-manual: Fix some typos and add a missing index entry
* doc/org-manual.org (Paragraphs): Fix markup typo.  Add missing "line
  breaks" index entry.
(Captions): Use plural form for index entry, as other occurrences in
the document.
(Literal Examples): Use "markup rules" instead of "markup", as other
occurrences in the document.
2018-07-04 23:35:04 +02:00
Nicolas Goaziou 1690c6597c org-manual: Remove wrong index entries
* doc/org-manual.org (Special Symbols): Remove index entries belonging
  to "Embedded LaTeX" section.
2018-07-04 23:35:03 +02:00
Nicolas Goaziou bedc1e6579 org-manual: Split "Images and Tables" section
* doc/org-manual.org (Built-in Table Editor): Add more information
  about table syntax.
(Handling Links): Move `org-toggle-inline-images' function to the new
"Images" section.
(Images and Tables): Remove section.
(Images):
(Captions): New sections.
(Tables in LaTeX export):
(Images in LaTeX export):
(Footnotes): Fix cross-references.

Also re-order "Markup for Rich Export" children.  The idea is to start
out with the paragraph definition, then describe the syntax for
objects that can be included in a paragraph.  Then, proceed with
elements that act as paragraph separators, and finish with less used
syntax.
2018-07-04 23:34:47 +02:00
Nicolas Goaziou 5057e39891 org-manual: Fix typo
* doc/org-manual.org (Modifying column view on-the-fly): Remove
  spurious colons.
2018-06-29 00:42:10 +02:00
Nicolas Goaziou d6a8188941 org-manual: Fix typo
* doc/org-manual.org (Property Syntax): Fix typo in Glenn Gloud's
  name.
2018-06-28 23:47:12 +02:00
Nicolas Goaziou 9e21814c65 org-manual: Remove last "C-c a" references
* doc/org-manual.org (Basic TODO Functionality):
(TODO keywords as types):
(Tag Searches):
(Property Searches): Remove "C-c a" bindings since we cannot, and
shouldn't, assume users bound this key combination to `org-agenda'.
2018-06-28 23:34:11 +02:00
Nicolas Goaziou 0480b9d8b6 org-manual: Fix aesthetics of a table
* doc/org-manual.org (External Links): Narrow the first column in
  a table.  Normalize capitalization in the table.
2018-06-28 22:59:18 +02:00
Nicolas Goaziou e801f6446d org-manual: Do not rely on `org-version'
* doc/org-manual.org (Export Setup): "version" macro does not rely on
  `org-version' anymore. It checks "Version" keyword in "org.el".
2018-06-28 22:54:59 +02:00
Nicolas Goaziou accf99cbc0 Deprecate `org-effort-durations'
* lisp/org.el (org-effort-duration): Remove unused variable.
* lisp/org-compat.el (org-effort-durations): Make
  `org-effort-duration' an alias for `org-duration-units'.
* lisp/org-clock.el (org-clock-modify-effort-estimate): Fix docstring.
* doc/org-manual.org (Footnotes): Clarify footnote.

The variable is inactive since introduction of "org-duration" library.
2018-06-25 17:13:04 +02:00
Siraphob Phipathananunth 2fcf55f273 org-manual: Fix "cursor" to "point", fix grammar and add cross-references
* doc/org-manual : More wording and grammar is fixed, cross-references
to other sections are added when key terms appear (e.g. agenda,
property, completion).
2018-06-25 16:51:21 +02:00
Nicolas Goaziou 58f2950167 org-manual: Add missing markup for properties
* doc/org-manual.org (The clock table): Add missing markup for
  properties.
2018-06-25 16:41:04 +02:00
Nicolas Goaziou 04cbfe3f31 org-manual: Add missing {{{var(...)}}} markup
* doc/org-manual.org (The clock table): Add missing {{{var(...)}}}
  markup.
2018-06-25 16:34:58 +02:00
Nicolas Goaziou 5c376ae4a7 org-manual: Fix case of a tag
* doc/org-manual.org (Setting options for custom commands): Use lower
  case for user defined example tags.
2018-06-24 22:42:09 +02:00
Nicolas Goaziou 5f78791b80 org-manual: Add missing markup
* doc/org-manual.org (The clock table): Add missing "=" markup for
  parts of an Org buffer.  Add "@noindent" directives.
2018-06-24 20:48:52 +02:00
Nicolas Goaziou e4ecd04dda org-manual: Fix formula markup
* doc/org-manual.org (Formula syntax for Calc): Add zero width spaces
  to avoid unwanted markup.
2018-06-24 20:40:41 +02:00
Nicolas Goaziou 5dd9d7adb3 org-manual: Remove references to "timeline"
* doc/org-manual.org (Basic TODO Functionality):
(Priorities):
(Timestamps, Deadlines and Scheduling):
(Agenda Views):
(Change display):
(Footnotes): Remove references to the now removed "timeline" feature.
2018-06-24 20:11:18 +02:00
Nicolas Goaziou 07b35fa906 org-manual: Fix internal links
* doc/org-manual.org (Code Evaluation and Security Issues):
(Structure of Code Blocks):
(Packages that Org cooperates with): Fix case.
2018-06-24 20:00:23 +02:00
Nicolas Goaziou 644d0259ce org-manual: Fix some info links
* doc/org-manual.org (Packages that Org cooperates with):
(Footnotes): Use "::" as node separator instead of ":".
2018-06-24 19:56:37 +02:00
Nicolas Goaziou 1bdee35231 org-manual: Add a missing cross reference
* doc/org-manual.org (Handling Links): Downcase tags.  Add a link to
  explicit what a "tags view" is.
2018-06-23 09:15:43 +02:00
Nicolas Goaziou 9b06cc975b org-manual: Add missing markup
* doc/org-manual.org (Using the Mapping API): Add `code' markup around
  ~save-excursion~, since this is an Elisp special form.
2018-06-23 09:15:43 +02:00
Ben Phipathananunth cccaca986e org-manual: Fix various grammatical errors and fix terminology
* doc/org-manual: All occurrences of "the cursor" are replaced with
  "point".  Begin changing "function" to "Lisp function" as used in
  the Emacs manual.
2018-06-23 09:15:43 +02:00
Nicolas Goaziou b563ef4762 Revert "org-manual: Fix link"
This reverts commit e61fddf4ce.
2018-06-19 10:44:49 +02:00
Nicolas Goaziou e61fddf4ce org-manual: Fix link
* doc/org-manual.org (Activation): Fix link.
2018-06-19 10:22:58 +02:00
Nicolas Goaziou 467b3f9728 org-manual: Shorten author field
* doc/org-manual.org (Export Setup): Shorten author field, which was
  larger than the width of the page, and not fair to all the people
  involved in the manual.
2018-06-17 10:22:47 +02:00
Nicolas Goaziou b2ffbf4b2f org-manual: Fix typos
* doc/org-manual.org (Subscripts and Superscripts):
(Initial visibility):
(Durations and time values):
(TODO dependencies):
(Tracking your habits):
(Deadlines and Scheduling):
(Literal Examples):
(The Export Dispatcher):
(Export Settings):
(Include Files): Fix typos.
2018-06-17 10:10:59 +02:00
Nicolas Goaziou ab8f90122a org-manual: Fix typo
* doc/org-manual.org (Internal archiving): Fix typo.
2018-06-17 09:52:00 +02:00
Nicolas Goaziou 05dcbfa2d4 org-manual: Fix typo
* doc/org-manual.org (Inserting deadlines or schedules): Fix typo.
2018-06-17 09:48:29 +02:00
Nicolas Goaziou f47917ce26 org-manual: Small fix
* doc/org-manual.org (Languages): Improve rendering in PDF
  output. Change Objective Caml into OCaml.
2018-06-15 00:24:40 +02:00
Nicolas Goaziou e943404735 org-manual: Remove reference to "verbatim" blocks
* doc/org-manual.org (Working with Source Code): Remove reference to
  "verbatim" blocks.
2018-06-14 23:56:39 +02:00
Nicolas Goaziou dcbb1acd92 org-manual: Fix typo
* doc/org-manual.org (Footnotes): Add missing "see" before
  cross-reference.
2018-06-14 21:24:22 +02:00
Nicolas Goaziou 69675967e9 org-manual: Add missing structure template key
* doc/org-manual.org (Structure Templates): Add "E" key.
2018-06-14 16:37:39 +02:00
Nicolas Goaziou c0e89ad4d5 org-manual: Fix typo
* doc/org-manual.org (Footnotes): Add missing "see" before
  cross-reference.
2018-06-13 21:41:50 +02:00
Nicolas Goaziou a0dacdc495 org-manual: Fix typo
* doc/org-manual.org (ASCII specific attributes): Use =...= markup for
  contents meant to be written in an Org document.
2018-06-12 08:53:05 +02:00
Kyle Meyer cecbe4ec8f org-manual: Fix typos
* doc/org-manual.org (Tag Hierarchy, ASCII specific attributes): Fix
typos.

These correspond to the org.texi typos in 89859f2bd.
2018-06-06 17:59:23 -04:00
Nicolas Goaziou b0e28fa4c6 org-manual: Document how to activate C++ and D languages
* doc/org-manual.org (Languages): Document how to activate C++ and
  D languages.
2018-05-30 12:46:55 +02:00
Nicolas Goaziou 97fb642a64 org-manual: Fix titlecase in second level section
* doc/org-manual.org (The Spreadsheet): Use titlecase.
2018-05-27 22:06:36 +02:00
Nicolas Goaziou 6bfa32eb58 org-manual: Fix footnote location
* doc/org-manual.org (Summary of In-Buffer Settings): Fix footnote
  location.
2018-05-27 22:05:25 +02:00
Nicolas Goaziou e43c7a3575 org-manual: Auto-adjust footnotes upon insertion
* doc/org-manual.org: Re-order footnotes.
* .dir-locals.el (org-mode): Auto-adjust footnotes.
2018-05-27 22:03:42 +02:00
Nicolas Goaziou 1f0561b63c org-manual: Use .dir-locals instead of file local variables
* .dir-locals.el (org-mode): Update settings.
* doc/org-manual.org (Local variables): Remove.
2018-05-27 21:41:18 +02:00
Nicolas Goaziou 4fde09061e org-manual: Fix last modification
* doc/org-manual.org (Results of Evaluation): Fix footnote reference.
Use regular quotes so smart quotes can kick in, rewrite "header arg"
to "header argument". Use present tense instead of future.
2018-05-27 21:37:20 +02:00
Aaron Ecay 1643f70d30 org-manual.org: Add a footnote about :file-ext
As suggested by Alex Fenton in
<https://lists.gnu.org/archive/cgi-bin/namazu.cgi?query=%2Bmessage-id%3A%3C6427e745-9ca4-2356-a262-ef257082a9ce%40pressure.to%3E&submit=Search&idxname=emacs-orgmode>.
2018-05-27 17:35:00 +01:00
Aaron Ecay 87c70f8101 org-manual.org: add file-local variables controlling footnotes
So that this fileʼs style remains consistent even if editors have
customized orgʼs footnote variables for their own use.
2018-05-27 17:34:10 +01:00
Nicolas Goaziou 8def68b723 org-manual: Document `org-complete-tags-always-offer-all-agenda-tags'
* doc/org-manual.org (Setting Tags): Document
  `org-complete-tags-always-offer-all-agenda-tags'.
2018-05-19 13:51:29 +02:00
Nicolas Goaziou 2ec5d36ecc org-manual: Use "source code block" instead of "src code block"
* doc/org-manual.org (Code Evaluation and Security Issues): Replace
  "src" with "source".
2018-05-13 22:47:44 +02:00
Marco Wahl eb49917bc4 org-manual: Fix a macro call 2018-05-11 22:01:18 +02:00
Marco Wahl 47dfa0e545 org-manual: Remove one trailing whitespace 2018-05-11 21:57:41 +02:00
Nicolas Goaziou 4fe6891cdf org-manual: Add non-breaking spaces
* doc/org-manual.org (Weekly/daily agenda):
* doc/org-manual.org (History and Acknowledgments): Add non-breaking
  spaces in names.
2018-05-11 19:53:33 +02:00
Gregor Zattler 4c41e1d03a Tiny doc fixes
* doc/org-manual.org (Dates and Times) (Timestamps, Deadlines and
  Scheduling): Document "diary-float" instead of obsolete "org-float".
* doc/Documentation_Standards.org (org-manual.org specific
  conventions): Fix file name and directory of Org manual.

Copyright-paperwork-exempt: yes
TINYCHANGE
2018-05-09 21:11:18 +02:00
Nicolas Goaziou d4a8e3de84 org-manual: Document "sep" header argument
* doc/org-manual.org (Results of Evaluation): Document "sep" header
  argument.
2018-05-09 01:45:04 +02:00
Nicolas Goaziou c703ee1a23 org-manual: Tiny rewording
* doc/org-manual.org (Summary): Tiny rewording.
2018-05-02 15:03:00 +02:00
Nicolas Goaziou 66b8d813a0 org-manual: Fix typo
* doc/org-manual.org (Summary): Fix typo.
2018-05-02 14:56:21 +02:00
Nicolas Goaziou 0b8aa5b3cb org-manual: Document "tangle-mode" header argument
* doc/org-manual.org (Extracting Source Code): Document "tangle-mode"
  header argument.
2018-05-02 12:48:38 +02:00
Nicolas Goaziou c64cdff088 org-manual: Document :wrap header argument
* doc/org-manual.org (Results of Evaluation): Document :wrap header
  argument.
2018-05-02 12:44:01 +02:00
Nicolas Goaziou fa51fc2922 org-manual: Fix typo
* doc/org-manual.org (Exporting Code Blocks): Fix typo.
2018-05-02 12:18:59 +02:00
Nicolas Goaziou 94f902834a org-manual: Slight rewording
* doc/org-manual.org (Macro Replacement): Slight rewording.
2018-04-30 09:26:50 +02:00
Nicolas Goaziou 61cfd675f3 org-manual: Document "results" macro
* doc/org-manual.org (Macro Replacement): Document "results" macro.
2018-04-29 12:32:26 +02:00
Nicolas Goaziou 181b13cc57 org-manual: Use starred internal links for consistency
* doc/org-manual.org (Structure Editing):
(Plain Lists): Use starred internal links.
2018-04-28 17:00:47 +02:00
Bastien 2b6004f57e org-agenda.el: Update the logic of regexp filters
* lisp/org-agenda.el (org-agenda-filter-by-regexp): Remove
existing regexp filter.  Only cumulate filters when called
with two prefix arguments.

It seems more common and reasonable to hit "=" to filter
then hit "=" again to remove the filter.  Cumulative filters
are still accessible through hitting `C-u C-u ='.
2018-04-28 14:12:37 +02:00
Bastien 011f1c6181 Let `org-agenda-set-restriction-lock' remove restriction at point
* lisp/org-compat.el (org-speedbar-set-agenda-restriction):
* lisp/org-agenda.el (org-agenda-set-restriction-lock):
If there is an agenda restriction at point, remove it.

* doc/org-manual.org:
* etc/ORG-NEWS: Document the new feature.
2018-04-28 12:09:56 +02:00
Nicolas Goaziou 2a8d944c85 org-manual: Fix typo
* doc/org-manual.org (Org Crypt): Use correct environment for Org
  example.
2018-04-27 16:13:41 +02:00
Gregor Zattler 5d8b85e280 org-manual: Document CRYPTKEY property
doc/org-manual.org: Document CRYPTKEY property.

TINYCHANGE
2018-04-27 15:11:29 +02:00
Bastien f80f7ed98b org-clock.el: New option :tags to insert tags in clock reports
* lisp/org-clock.el (org-clocktable-defaults)
(org-clocktable-write-default, org-clock-get-table-data):
Rename :tags to :match and use :tags to insert a column with
the headline's tags.

Thanks to Raymond Zeitler for suggesting this.
2018-04-26 20:55:27 +02:00
Bastien 1ac57ccda0 org-manual.org: Small enhancement for org-timestamp-up/down 2018-04-26 14:42:09 +02:00
Bastien 4faa2e1a45 org-manual.org: Small rephrasing 2018-04-26 13:37:58 +02:00
Bastien e3794f6dce Continue previous commit 2018-04-26 11:42:04 +02:00
Bastien 889a075834 org-manual.org: Tiny enhancement for `org-toggle-ordered-property'
Thanks to Allen Li for pointing this.
2018-04-26 11:39:44 +02:00
Nicolas Goaziou 92785f7bf6 org-manual: Improve list of Babel languages
* doc/org-manual.org (Languages): Re-order table.  Use verbatim markup
  for identifiers.

* doc/org.texi: Sync file.
2018-04-25 10:19:02 +02:00
Nicolas Goaziou b4e82fb050 org-manual: Sync manual with org.texi 2018-04-24 23:26:27 +02:00
Nicolas Goaziou 222cfe7daf org-manual: Sync with maint
* doc/org-manual.org:
* doc/org.texi (Variable Index):
(Markdown Export): Sync with maint.
2018-04-20 11:16:06 +02:00
Nicolas Goaziou 5b695bfa10 org-manual: Fix `org-insert-structure-template' documentation 2018-04-12 15:35:55 +02:00
Nicolas Goaziou 52cbeec20a org-manual: Re-order Babel result formats alphabetically 2018-04-12 15:29:52 +02:00
stardiviner b088389c6b ob-core: Add document and test for "graphics" format
* doc/org-manual.org: Document value.

* lisp/ob-core.el (org-babel-common-header-args-w-values): Handle
  symbol "graphics".

* testing/lisp/test-ob.el (test-ob/result-graphics-link-type-header-argument):
  New test.
2018-04-12 15:16:04 +02:00
stardiviner 296b0de4e8 ob-core: Add "link" results format
* lisp/ob-core.el (org-babel-execute-src-block): Handle "link" :results
  format.

* doc/org-manual.org: Add document for new result format "link".

* testing/lisp/test-ob.el (test-ob/result-file-link-type-header-argument):
  New test.
2018-04-12 15:15:59 +02:00
Rasmus 39837b4b31 org: Change org-insert-structure-template to C-c C-,
* lisp/org.el (org-mode-map):
* doc/org-manual.org (With): Change keybinding of
  org-insert-structure-template.

See the thread titled "Poll: new keybinding for
org-insert-structure-template?" in December 2017 for details.
2018-04-08 12:47:12 +02:00
Rasmus b56df737b7 org: org-structure-template-alist uses string keys
* lisp/org-tempo.el (org-tempo-keywords-alist):
  (org-tempo-setup):
  (org-tempo-add-templates):
* testing/lisp/test-org-tempo.el (test-org-tempo/add-new-templates):
* lisp/org.el (org-structure-template-alist): Use string keys.
  (org--insert-structure-template-mks):
  (org--insert-structure-template-unique-keys): New functions for block selection.
  (org-insert-structure-template): Use new functions.
* etc/ORG-NEWS:
* doc/org-manual.org: Reflect changes.
2018-04-08 12:47:12 +02:00
Nicolas Goaziou f8924a2393 org-manual: Improve accuracy of a paragraph
* doc/org-manual.org (Column Width and Alignment): Reword paragraph
  about shrunk columns.  Document that a column is expanded only when
  text near its shrunk part is displayed.
2018-04-02 20:30:40 +02:00
Kyle Meyer 8ead9e5ba3 org-manual: Fix clone instructions
The same fix was applied to org.texi in b1a6395df.
2018-04-01 17:39:50 -04:00
Grégoire Jadi 452f4d8527 org-manual: Fix typo in variable name 2018-03-29 22:18:36 +02:00
Marco Wahl 00386b4924 org-manual: Fix typo in Tracking TODO state changes
Also update org.texi from org-manual.org export.
2018-03-29 12:56:34 +02:00
Nicolas Goaziou bfd6d3c867 org-manual: Fix typo in capture protocol
Reported-by: Буковская Агнесса <aggie@yandex.ru>
<http://lists.gnu.org/r/emacs-orgmode/2018-03/msg00528.html>
2018-03-28 17:13:56 +02:00
Nicolas Goaziou a20ed49289 org-manual: Fix link to Calc manual 2018-03-28 16:27:57 +02:00
Nicolas Goaziou 661644aba7 org-manual: Fix typos in copying 2018-03-28 16:27:57 +02:00
Nicolas Goaziou 97fc9a79ec org-manual: Remove "email" keyword 2018-03-28 16:15:43 +02:00
Nicolas Goaziou 5ee6d18862 org-manual: Fix typo 2018-03-28 16:15:43 +02:00
Nicolas Goaziou 243608f153 org-manual: Normalize S-<cursor> keybindigs 2018-03-28 16:15:43 +02:00
Nicolas Goaziou b946c93865 org-manual: Fix typo 2018-03-28 16:15:43 +02:00
Nicolas Goaziou c154c3db02 org-manual: Fix whitespace issues 2018-03-28 16:15:43 +02:00
Nicolas Goaziou c1777f12a6 org-manual: Fix typo 2018-03-28 16:15:43 +02:00
Nicolas Goaziou fde21b962e org-manual: Fix table size 2018-03-28 16:15:43 +02:00
Nicolas Goaziou 6d4ae97103 Rename "manual.org" into "org-manual.org" 2018-03-28 16:15:40 +02:00