Commit Graph

3000 Commits

Author SHA1 Message Date
Nicolas Goaziou d20e45b187 org-manual: New "features" section about source blocks
* doc/org-manual.org (Features): New section.

The main motivation behind this is to avoid starting "Working with
source code" section with a wall of text that hides the menu.
2020-02-08 13:06:41 +01:00
Bastien 0e75ebc523 Implement and document looping over headlines in agenda
* doc/org-manual.org (Execute commands in the active region):
New section, documenting both
`org-loop-over-headlines-in-active-region' and
`org-agenda-loop-over-headlines-in-active-region' options.

* etc/ORG-NEWS (Looping agenda commands over headlines): Add
an entry about "Looping agenda commands over headlines".

* lisp/org-agenda.el (org-agenda-do-in-region): New function.
(org-agenda-maybe-loop): New macro.
(org-agenda-kill, org-agenda-archive-default)
(org-agenda-archive-default-with-confirmation)
(org-agenda-archive, org-agenda-archive-to-archive-sibling)
(org-agenda-archive-with, org-agenda-todo)
(org-agenda-set-property, org-agenda-set-effort)
(org-agenda-toggle-archive-tag, org-agenda-date-prompt)
(org-agenda-schedule, org-agenda-deadline)
(org-agenda-add-entry-to-org-agenda-diary-file): Use
`org-agenda-maybe-loop' to DTRT when the region is active.
(org-agenda-loop-over-headlines-in-active-region): New option.
2020-02-08 12:17:40 +01:00
Nicolas Goaziou 5ab6f6b77e Merge branch 'maint' 2020-02-08 09:27:47 +01:00
Nicolas Goaziou 4f26e31203 org-manual: Clarify "link" format for Babel code
* doc/org-manual.org (Format): Clarify "link" format.

Reported-by: Matt Huszagh <huszaghmatt@gmail.com>
2020-02-08 09:26:24 +01:00
Bastien 3d69f055b0 doc/org-manual.org: Use `org-refile-copy'
* doc/org-manual.org (Refile and Copy): Use `org-refile-copy',
the new name of `org-copy'.
2020-02-05 15:51:07 +01:00
Bastien eaf8b78a74 org-manual.org: Precision on the priority cookie syntax
* doc/org-manual.org (Priorities): Indicate that the priority
cookie should be placed right after the TODO keyword.
2020-02-02 08:39:12 +01:00
Bastien 151a31917b doc/org-manual.org: Don't document deleted command
* doc/org-manual.org (Remote editing): Don't document deleted command.
2020-02-02 08:35:43 +01:00
Bastien 80fc678acd doc/org-manual.org: Don't document deleted command
* doc/org-manual.org (Remote editing): Don't document deleted command.
2020-02-02 08:34:33 +01:00
Kisaragi Hiu 2062761f5c org-manual.org: Mention the format of effort estimates
* doc/org-manual.org (Effort Estimates): Mention the format of effort
estimates.

TINYCHANGE
2020-02-01 17:44:13 +01:00
Bastien 110b034151 Replace "org-table-electric-header" by "org-table-header-line"
* lisp/org-table.el (org-table-header-line-p)
(org-table-header-line-mode): Replace
"org-table-electric-header" by "org-table-header-line".

* doc/org-manual.org (Miscellaneous): Ditto.

Thanks to Samuel Wales for suggesting this name.
2020-02-01 09:52:57 +01:00
Bastien 3d0282ef87 New option `org-archive-subtree-save-file-p'
* lisp/org-agenda.el (org-agenda-archive-with): Bind
`org-archive-from-agenda' to `t' when archiving from agenda.

* lisp/org-archive.el (org-archive-subtree-save-file-p): New option.
(org-archive-subtree): Use the new option.

* doc/org-manual.org (Moving a tree to an archive file):
Mention the new option.

Thanks to Russ Allbery for suggesting a similar idea.
2020-01-31 10:42:40 +01:00
Bastien 4f98694bf7 Allow numeric values for priorities
* lisp/org.el (org-priority-highest, org-priority-default):
Allow integer.
(org-priority-get-priority-function): Tiny docstring change.
(org-priority-to-value): New defsubst.
(org--setup-collect-keywords, org-priority-regexp)
(org-priority, org-get-priority): Allow numeric values.

* doc/org-manual.org (Priorities): Illustrate the use of
numeric values for priorities.
2020-01-30 23:01:29 +01:00
Bastien 1de5e80adf Rename `org-x-priority' functions and variables to `org-priority-x'
* lisp/org.el (org-priority-enable-commands)
(org-priority-start-cycle-with-default)
(org-set-regexps-and-options, org-sort-entries, org-priority)
(org-get-priority, org-entry-properties)
(org-property-get-allowed-values, org-shiftup, org-shiftdown):
Rename `org-[x]-priority' functions and variables to
`org-priority-[x]'.

* lisp/org-pcomplete.el (org-priority-default)
(org-priority-highest)
(pcomplete/org-mode/file-option/priorities): Ditto.

* lisp/org-mouse.el (org-mouse-get-priority)
(org-mouse-priority-list): Ditto.

* lisp/org-agenda.el (org-agenda-fontify-priorities)
(org-agenda-format-item, org-agenda-priority): Ditto.

* lisp/ox-icalendar.el (org-icalendar--vtodo): Ditto.

* doc/org-manual.org (Priorities, Summary of In-Buffer Settings): Ditto.

* testing/lisp/test-org.el (test-org/set-regexps-and-options)
(test-org/entry-properties): Ditto.
2020-01-30 14:56:38 +01:00
Bastien b476ffd266 Implement the `org-table-electric-header-mode' minor mode
* lisp/org-table.el (org-table-electric-header-p): New option.
(org-table-temp-header-line, org-table-electric-header-mode): New
variables.
(org-table-set-header-line-format)
(org-table-electric-header-mode): New minor mode to display the
table's current first row as the header line when this first row
is not visible anymore.

* doc/org-manual.org (Miscellaneous): Document
`org-table-electric-header-mode'.
2020-01-29 15:17:32 +01:00
Bastien 910bf48a14 org-manual.org: Mention the GNU Kind Communications Guidelines
* doc/org-manual.org (Feedback): Mention the GNU Kind
Communications Guidelines.
2020-01-27 12:04:03 +01:00
Bastien 8237a5d33b org-manual.org (Org Mobile): Mention `org-tag-persistent-alist'
* doc/org-manual.org (Org Mobile): Mention `org-tag-persistent-alist'.

Thanks to Jorge P. de Morais Neto for mentioning this.
2020-01-26 17:57:46 +01:00
Nicolas Goaziou 4141355492 Merge branch 'maint' 2020-01-26 09:45:28 +01:00
Bastien c6a34dc01f org-manual.org: Enhance documentation for Org Indent Mode
* doc/org-manual.org (Org Indent Mode): Document
`org-indent-mode-turns-on-hiding-stars' and
`org-indent-mode-turns-off-org-adapt-indentation' and add them to
the variable index.

See https://github.com/MatthewZMD/.emacs.d/issues/28 for details on
what was confusing.

Thanks to Neil Hansen for pointing this.
2020-01-26 08:58:44 +01:00
Gustav Wikström 7cf58a55da Document org-attach-commands option
* doc/org-manual.org (Attachment options): Mention
  org-attach-commands in the manual next to all other options for the
  attachment functionality.
2020-01-19 10:50:14 +01:00
Gustav Wikström edefb2835d Additional option for org-attach-store-link-p
* doc/org-manual.org (Attachment options)
* etc/ORG-NEWS (New option in ~org-attach-store-link-p~)
* lisp/org-attach.el (org-attach-store-link-p)
  (org-attach-attach): Add option to store a link to the attached file
  with a file link.
2020-01-19 10:50:14 +01:00
Kyle Meyer c9ee3d8a9b Merge branch 'maint' 2020-01-17 20:57:07 -05:00
Kyle Meyer 36cd249e75 guide: Match recommended global keybindings to manual's
* doc/org-guide.org (Activation): Match recommended global keybindings
to those in the manual.

In the guide's .texi to .org conversion in 1a678f184 (Generate compact
guide from an Org file, 2019-03-19), the leading "C-c"s of the
bindings were lost.  Restore them.

Also, drop org-switchb, which was pruned from the manual's suggested
bindings in d03515590, and tweak the surrounding text more closely
match the manual's.

Reported-by: Nick Dokos <ndokos@gmail.com>
2020-01-17 20:55:47 -05:00
Nicolas Goaziou 3a6061e787 Merge branch 'maint' 2020-01-09 17:55:08 +01:00
Nicolas Goaziou e3681b0b08 org-manual: Fix typo
* doc/org-manual.org (Hard indentation): Fix typo.
2020-01-09 17:54:51 +01:00
Nicolas Goaziou ffb3f9e568 Merge branch 'maint' 2020-01-09 17:49:56 +01:00
Nicolas Goaziou 2c598d7499 org-manual: Update "ol-man.el" example
* doc/org-manual.org (Adding Hyperlink Types): Remove
unnecessary (require 'org) in example and fix function name.
2020-01-09 17:49:15 +01:00
Tom Gillespie b1cd1595df org-manual: Use ol-man.el in "Adding Hyperlink Types"
doc/org-manual.org (Adding Hyperlink Types): Update the name of the
example file from org-man.el to ol-man.el to reflect the renaming of
files related to Org links.

I found this thoroughly confusing when trying to (require 'org-man)
since it was clearly referenced as being in "contrib/", hopefully this
change will prevent anyone else from encountering the same confusion.
2020-01-09 17:44:39 +01:00
Kyle Meyer 93c11da002 Merge branch 'maint' 2020-01-01 13:39:26 -05:00
Kyle Meyer ff5fc050d3 Update copyright year to 2020 2020-01-01 13:38:46 -05:00
Nicolas Goaziou c60a7afea1 Merge branch 'maint' 2019-12-24 14:42:58 +01:00
Nicolas Goaziou cac0e46559 org-manual: Refer to link format in "Escape Character"
* doc/org-manual.org (Escape Character): Mention Link Format section
for completeness.
2019-12-24 14:41:44 +01:00
Nicolas Goaziou 2b1b90f936 Merge branch 'maint' 2019-12-23 10:40:28 +01:00
Nicolas Goaziou 49c9cf2b6e org-manual: Tiny fix
* doc/org-manual.org (Internal Links): Tiny fix.
2019-12-23 10:39:59 +01:00
Nicolas Goaziou 2eeafcaf34 Merge branch 'maint' 2019-12-22 14:58:14 +01:00
Nicolas Goaziou 546cbad531 Link syntax require to escape every square bracket
* lisp/ol.el (org-link-make-regexps): Update regexp to forbid any
un-escaped square bracket in the URI.
(org-link-escape):
(org-link-unescape):
* testing/lisp/test-ol.el (test-ol/escape):
(test-ol/unescape):
(test-ol/store-link):
* testing/lisp/test-org.el (test-org/custom-id):
(test-org/fuzzy-links):
* testing/lisp/test-ox.el (test-org-export/resolve-fuzzy-link): Adapt
to new syntax.
* doc/org-manual.org (Link Format): Update documentation.

The new syntax allowed un-escaped opening square brackets in the URI
part of bracket links. Unfortunately, it led to bug as described here:

  <https://lists.gnu.org/archive/html/emacs-orgmode/2019-12/msg00312.html>

Now, we require to escape every square bracket in the URI.
2019-12-22 14:52:53 +01:00
Nicolas Goaziou e64323a108 Merge branch 'maint' 2019-12-17 10:34:10 +01:00
Nicolas Goaziou fa74fbb33c org-manual: Fix typo
* doc/org-manual.org (Field coordinates in formulas): Fix typo.
2019-12-17 10:33:41 +01:00
Nicolas Goaziou 2cec49554d Merge branch 'maint' 2019-12-17 10:18:16 +01:00
Nicolas Goaziou bc0d219e97 org-manual: Improve internal links documentation
* doc/org-manual.org (Internal Links): Document starred links.  Fix
documentation for text search.
2019-12-17 10:16:58 +01:00
Nicolas Goaziou 31d2f48f69 Merge branch 'maint' 2019-12-12 22:35:10 +01:00
Nicolas Goaziou b64a3308aa org-capture: Get capture templates from anonymous functions
* lisp/org-capture.el (org-capture-get-template): Allow specifying
template from an anonymous function.
* doc/org-manual.org (Template elements): Document it.
2019-12-12 22:33:22 +01:00
Kyle Meyer 955e531d24 Merge branch 'maint' 2019-12-11 21:24:45 -05:00
Paul Eggert f9a55cba31 Backport commit b0f20651e from Emacs
; Spelling fixes
b0f20651e3cbb8a66f11ffae4c18634019c20cd4
Paul Eggert
Tue Dec 10 20:05:49 2019 -0800
2019-12-11 21:22:50 -05:00
Paul Eggert ac90e86c32 Backport commit d1a791f8e from Emacs
Spelling fixes
d1a791f8edc1b8f2189b6f1b3be7b946fef1edbc
Paul Eggert
Mon Dec 9 18:45:18 2019 -0800
2019-12-11 21:19:55 -05:00
Marco Wahl e3046e22d4 Merge branch 'maint' 2019-12-11 23:11:20 +01:00
Marco Wahl 9b85eaa65a org-manual: Unify to two spaces after a dot 2019-12-11 23:10:42 +01:00
Marco Wahl 67e48de639 org-manual: Fix typo 2019-12-11 22:58:30 +01:00
Nicolas Goaziou 6504e6d35f Merge branch 'maint' 2019-12-11 22:08:04 +01:00
Nicolas Goaziou 74c9b11e80 org-manual: Fix typo
* doc/org-manual.org (Column Width and Alignment): Fix typo.
2019-12-11 22:07:42 +01:00
Nicolas Goaziou ea302ea5b5 Merge branch 'maint' 2019-12-11 21:52:14 +01:00
Nicolas Goaziou 2e6853e798 org-manual: Improve an example
* doc/org-manual.org (Computed tag filtering): Do not suggest using
one-armed `if' constructs.  Remove misleading "org" prefix, and source
block indentation.
2019-12-11 21:51:20 +01:00
Nicolas Goaziou 8d5803ced9 Merge branch 'maint' 2019-12-11 21:39:57 +01:00
Nicolas Goaziou a8da497261 org-manual: Suggest kbd macro for bindings
* doc/org-manual.org (Capture templates): Suggest kbd macro for
bindings.
2019-12-11 21:39:09 +01:00
Nicolas Goaziou 3e3819392e org-manual: Use proper markup
* doc/org-manual.org (Computed tag filtering): Use proper
markup. E.g., use verbatim for anything meant to appear in an Org
document.  Use fixed-width for single line examples. Fix spacing after
"e.g.". Use active voice and present tense.
2019-12-11 21:35:05 +01:00
Nicolas Goaziou 37a2eff212 Merge branch 'maint' 2019-12-11 21:28:42 +01:00
Nicolas Goaziou fffb57aa39 org-manual: Fix typo
* doc/org-manual.org (Computed tag filtering): Fix spacing after
"i.e.".
2019-12-11 21:27:52 +01:00
Marco Wahl ace6372a03 Merge branch 'maint' 2019-12-11 15:52:57 +01:00
Marco Wahl 5a7fadf59a manual: Fix in section [Computed tag filtering] 2019-12-11 15:50:56 +01:00
Jason Dunsmore a410413be8 org-capture: Add support for month trees
* doc/org-manual.org: Add `:tree-type month' option for capture
  templates.
* lisp/org-capture.el (org-capture-set-target-location): Add
  `:tree-type month' option to capture templates to group entries by
  month.
* lisp/org-datetree.el (org-datetree-find-month-create): Add
  `org-datetree-find-month-create' function to add datetree entries
  grouped by month.
* testing/lisp/test-org-datetree.el
  (test-org-datetree/find-month-create): Add test for new function.
2019-12-09 20:08:28 +01:00
Marco Wahl b8f43ecbf4 org,colview: Quit column-view with C-c C-c. manual,news: Update
* lisp/org-colview.el (org-columns-toggle-or-columns-quit): New
  function.  Takes the place of removed function
  org-columns-set-tags-or-toggle.
2019-12-04 23:36:33 +01:00
Marco Wahl 8ded89cc38 Merge branch 'master' into next 2019-11-26 22:45:10 +01:00
Nicolas Goaziou f4e5b75b47 org-manual: Fix `org-latex-subtitle-format' documentation
* doc/org-manual.org (LaTeX specific export settings): Fix
`org-latex-subtitle-format' documentation.
2019-11-23 17:45:23 +01:00
Kyle Meyer a4fa04bbd4 Merge branch 'master' into next 2019-11-16 17:19:11 -05:00
Kyle Meyer 6912382400 Merge branch 'maint' 2019-11-16 17:18:49 -05:00
Jonas Bernoulli 5117d8a159 Fix typos 2019-11-16 17:17:36 -05:00
Sebastian Miele 634880a2e9 org-manual: Dynamic Blocks: Fix explanation of :content
* doc/org-manual.org (Dynamic Blocks): Correct the information given
on :content in the plist passed to the writer function.
2019-11-16 17:17:21 -05:00
Gustav Wikström cffe44ba94 Merge branch 'master' into next 2019-10-21 14:58:39 +02:00
Gustav Wikström 42b8db0d34 Improve handling of org attach id to path functions
* doc/org-manual.org (Attachment options)
* etc/ORG-NEWS (Org-Attach has been refactored and extended)
(New ID method based on timestamp)
* lisp/org-attach.el (org-attach-id-uuid-folder-format)
(org-attach-id-ts-folder-format)
(org-attach-id-to-path-function-list, org-attach-dir)
(org-attach-dir-from-id): Better handling of id to path
functionality. At the same time adding an id-to-path function
for timestamp-based ID that easily can be promoted to the
primary function by customization of the user.
2019-10-20 02:49:48 +02:00
Gustav Wikström 1bdff9f73d Org document property-drawers
Add functionality to define property-blocks on document level, in
addition to at headline level.

* doc/org-manual.org:
* etc/ORG-NEWS: Document new functionality.

* lisp/org.el (org-keyword-regexp): Define constant instead of
  hardcoding.
(org-file-properties): Renamed, see next line.
(org-keyword-properties): Renamed from above.  Due to the fact that
  properties can be defined for the whole document using property
  drawers this local variable needs a rename to make its name less
  ambigous.
(org-refresh-properties, org-refresh-property, org-entry-properties)
(org-refresh-category-properties, org-get-property-block)
(org-entry-get-with-inheritance, org-entry-put)
(org-insert-property-drawer, org-end-of-subtree): Made to work before
  first headline.
(org-at-property-block-p): New function to validate if point is at the
start of a property block.
(org-property-global-value): Renamed, see next line.
(org-property-global-or-keyword-value): Renamed from above to match
  its functionality better.
(org-back-to-heading-or-point-min): New function to make a document
  work as a level 0 node in the outline.
(org-at-keyword-p): Predicate function to answer to if we're currently
at a keyword line or not.
(org-up-heading-or-point-min): New function to make a document work as
a level 0 node in the outline.

* lisp/org-element.el (org-element--current-element): Can now detect
  property-blocks before first headline according to it's positional
  rules.

* lisp/org-attach.el (org-attach): Make it possible to call the
  attachment dispatcher also before the first headline, since document
  property drawers make attachments possible for the whole document
  now.

* lisp/org-capture.el: Modified only due to rename of function in
  org.el.

* lisp/org-compat.el (org-file-properties)
(org-property-global-value): Renamed functions declared obsolete.

* testing/lisp/test-org.el (org/insert-property-drawer)
(org/set-property, org/delete-property, org/delete-property-globally):
  Additions of tests to check if they work before first headline.
(org/at-property-p, org/at-property-block-p, org/get-property-block)
(org/entry-get, org/refresh-properties): New tests

* testing/examples/property-inheritance.org: Switch from
  property-keywords to a property-drawer in the testfile.
  Functionality should be the same, but now using a document drawer
  instead of property-keywords.

  Reason for switching is that I'd like us to slowly depricate
  property-keywords.

* testing/lisp/test-org-element.el:

* contrib/lisp/ox-taskjuggler.el: A comment is modified only due to
  rename of function in org.el.
2019-10-19 14:07:58 +02:00
Nicolas Goaziou bd5f5ece55 org-manual: Document Help links
* doc/org-manual.org (External Links): Document Help links.
2019-10-13 09:41:30 +02:00
Jens Lechtenboerger 7735362101 ox-html: Control wrapping of source lines
* lisp/ox-html.el (org-html-format-code, org-html-do-format-code):
  Use new export option :html-wrap-src-lines with variable
  org-html-wrap-src-lines to control whether source code lines should
  be wrapped in code elements or not.
* doc/org-manual.org: Document the new option
2019-10-13 09:27:34 +02:00
Paul Eggert e3090573be Backport commit 946a56a10 from Emacs
* lisp/org.el (org-doi-server-url): Prefer https: to http: un URLs.

Update some URLs
946a56a10fed769646a8b7c4ebc53f53c84be896
Paul Eggert
Mon Sep 23 00:12:52 2019 -0700

Notes(km):

  - It's not mentioned in 946a56a10's message, but that commit also
    drops the dx subdomain, an "earlier syntax which continues to be
    supported" according to https://www.doi.org/factsheets/DOI_PURL.html.

  - 946a56a10 replaced a link in the manual with https://api.uva.nl/
    (which the previous link redirects to).  Here we instead use the
    replacement link from master's f4083eefd (manual: Fix URL,
    2019-06-01).
2019-09-29 15:47:58 -04:00
Carsten Dominik 6f32e7af88 Merge branch 'improve-consistency-in-filter-commands' 2019-09-09 07:36:06 +02:00
Carsten Dominik 7ac2707658 Small adaptions in the manual on filters 2019-09-09 07:34:23 +02:00
Carsten Dominik 711852ec67 Bug fix in tags filter: Treat SPC selection correctly.
* lisp/org-agenda.el (org-agenda-filter-make-matcher-tag-exp): Fix
filtering for any tag at all.
2019-09-07 15:04:03 +02:00
Carsten Dominik 5bd71d3052 Manual typo fixes 2019-09-07 14:12:37 +02:00
Carsten Dominik 20519fde4e Document the new meaning of prefix arguments in filtering commands
* doc/org-manual.org (Filtering in the agenda): Document how prefix
arguments change the bahavior of filtering commands.
2019-09-07 07:54:07 +02:00
Michaël Cadilhac 85c65b12ec Document :hidefiles in clocktable
* doc/org-manual.org (The clock table): Do it.
2019-09-05 18:56:32 +02:00
Carsten Dominik d1bdf6c789 Small fix in manual 2019-09-04 10:10:45 +02:00
Carsten Dominik 05cb7cb4ad Fix bugs in filtering 2019-09-04 09:41:29 +02:00
Carsten Dominik 7ee4cb0245 Revert `org-agenda-filter-by-category' to non-prompting state 2019-09-03 15:47:39 +02:00
Carsten Dominik f230b730c5 Make the new filter interface the default, and improve the manual
* lisp/org-agenda.el: Bind `org-agenda-filter' to `/` and move
`org-agenda-filter-by-tag' to `\`.
* doc/org-manual (Filtering/limiting agenda items): Improve the entire
section.
2019-09-01 09:12:47 +02:00
Carsten Dominik fcc0d8f509 Clarify the reach of top-level headline filtering.
* doc/org-manual.org (Filtering in the agenda): Clarify the reach of
top-level headline filtering.
2019-08-30 08:51:02 +02:00
Carsten Dominik 713a414713 Small improvements to filtering
* lisp/org-agenda.el (org-agenda-filter): Append new filter elements
instead of prepending them.  And allow an additional leading `+' to
signal that the new elements should be added to the current filter
instad of replacing them.
2019-08-30 08:35:27 +02:00
Carsten Dominik 26cde0972d Document the new additional filter interface
* doc/org-manual.org (Filtering in the agenda): Document new filter
function.
2019-08-29 21:33:11 +02:00
Nicolas Goaziou 5c55d3a53c manual: Remove erroneous footnote about :file header argument
* doc/org-manual.org (Type): :file header argument no longer
implies :results file.
2019-08-24 00:04:06 +02:00
Nicolas Goaziou 2befc22b26 org-manual: Fix zero width space example
* doc/org-manual.org (Escape Character): Fix zero width space example.

Link syntax tolerates white spaces anywhere within the square
brackets, so the example would still be a valid link.
2019-08-20 14:15:55 +02:00
Nicolas Goaziou 9ddba91b94 org-manual: Remove reference to a removed feature
* doc/org-manual.org (The Very Busy {{{kbd(C-c C-c)}}} Key): Remove
reference to "automatic table editor", which is always active anyways.
2019-08-19 12:27:57 +02:00
Nicolas Goaziou 4d8142b812 org-manual: Final changes to mode names
* doc/org-manual.org (Activation):
(Basic TODO Functionality):
(Multiple keyword sets in one file):
(Priorities):
(The global TODO list):
(Editing support):
(Summary of In-Buffer Settings):
(Packages that conflict with Org mode):
(Adding Hyperlink Types): Change Lisp symbol into its proper name.

In particular, there is no "shift-selection-mode" in Emacs, but
a "shift-selection" feature.  There is a "shift-select-mode" variable,
however, but the entry in the Emacs manual is really about
"shift-selection".
2019-08-19 10:58:33 +02:00
Nicolas Goaziou edefa0fac2 org-manual: Additional org-indent-mode -> Org Indent mode change
* doc/org-manual.org (Footnotes): When writing about a mode, use its
full name, not the Lisp symbol.
2019-08-19 10:47:06 +02:00
Nicolas Goaziou af572ace74 org-manual: Fix typo
* doc/org-manual.org (Org Indent Mode): Fix typo.
2019-08-19 10:38:20 +02:00
Nicolas Goaziou 576d6ab6c6 org-manual: Fix typo
* doc/org-manual.org (Deadlines and Scheduling): Fix typo.
2019-08-19 10:30:33 +02:00
Nicolas Goaziou 3244abbe6d org-manual: Fix minor mode name
* doc/org-manual.org (Headlines):
(A Cleaner Outline View):
(Org Indent Mode): Prefer real name instead of Lisp symbol.  Fix
typos.
2019-08-19 10:30:02 +02:00
Nicolas Goaziou 810860a613 org-manual: Fix indentation
* doc/org-manual.org (Summary of In-Buffer Settings): Remove spurious
indentation.
2019-08-19 10:20:47 +02:00
Carsten Dominik 4789fc3bfd Renumber and validate all footnotes in the manual 2019-08-19 09:46:08 +02:00
Carsten Dominik bca4f1792e Introduce an early reference to org-indent-mode into the manual
* doc/org-manual.org (Headlines): Introduce a reference to
`org-indent-mode'.
2019-08-18 12:23:26 +02:00
Carsten Dominik 81ca61f54f Document noindent STARTUP keyword 2019-08-18 11:20:38 +02:00
Carsten Dominik 6dfd4e38d0 Simplify the "Hard Indentation" section in the manual
* doc/org-manual.org (Hard Indentation): Simplify section.
2019-08-18 11:06:33 +02:00
Carsten Dominik 16f3fd69c3 Various small changes to the manual
* doc/org-manual.org: Compactify the summary of in-buffer
options. Move Org Protocol section to the Miscellaneous chapter.
2019-08-18 09:42:40 +02:00
Carsten Dominik f8d81f4aaa Fix indentation problem in manual that broke structure
* doc/org-manual.org (Summary of In-Buffer Settings): Fix indentation problem.
2019-08-17 22:11:32 +02:00
Carsten Dominik a37dee547e Make Attachment subsections unnumbered 2019-08-17 18:03:20 +02:00
Carsten Dominik 6b21c97bbe Rename sections in the manual
* doc/org-manual.org (Refiling and Archiving): Renamed from
Refile, Copy and Archiving.
(Capture and Attachments): Renamed from Capture, Attachments,
RSS Feeds and Protocols.
2019-08-17 18:01:01 +02:00
Carsten Dominik 1c9be12119 Restructure Miscellaneous section of the manual
doc/org-manual.org: Restructure Miscellaneous section of the manual,
remove Customization subsection
2019-08-17 17:55:52 +02:00
Nicolas Goaziou 552bb0764a org-manual: Fix typo
* doc/org-manual.org (Literal Examples): Fix typo.
2019-08-17 15:40:36 +02:00
Nicolas Goaziou 8229a59828 Merge branch 'maint' 2019-08-17 15:31:05 +02:00
Nicolas Goaziou 4cb3a37533 org-manual: Fix typo
* doc/org-manual.org (LaTeX specific export settings): Fix typo.

Reported-by: Emmanuel Charpentier <emm.charpentier@free.fr>
<http://lists.gnu.org/r/emacs-orgmode/2019-07/msg00153.html>
2019-08-17 15:29:16 +02:00
Nicolas Goaziou 9e083fdf42 org-manual: More visible information about "comma escape"
* doc/org-manual.org (Literal Examples): Move information about "comma
escape" outside of the footnote.  Delete related footnote.

Suggested-by: Štěpán Němec
2019-08-17 15:21:09 +02:00
Nicolas Goaziou d841b38086 org-manual: Slight rewording for indented source blocks
* doc/org-manual.org (Literal Examples): Slight rewording.  Merge
indentation information into the same paragraph.
2019-08-17 14:50:08 +02:00
Nicolas Goaziou d8778d9305 org-manual: Fix typo
* doc/org-manual.org (Literal Examples): The major mode name differs
from the symbol used.
(Footnotes): Fix typo.
2019-08-17 14:32:16 +02:00
Nicolas Goaziou c7bce7a986 org-manual: Fix typo
* doc/org-manual.org (Dynamic Headline Numbering): Fix typo.
2019-08-17 09:21:18 +02:00
Nicolas Goaziou 836f1396fc Clarify the difference between org-indent-mode and hard indentation
doc/org-manual.org (A Cleaner Outline View): Clarify the difference
between org-indent-mode and hard indentation.
2019-08-17 02:00:42 +02:00
Nicolas Goaziou 518691598d org-manual: Fix wrong footnote number
* doc/org-manual.org (External Links): Fix footnote number.
2019-08-17 01:52:09 +02:00
Nicolas Goaziou 00cf093dd1 Revert " Clarify the difference between org-indent-mode and hard indentation"
This reverts commit ebf10f126c.

The change propagates an error in a footnote number.
2019-08-17 01:51:21 +02:00
Carsten Dominik ebf10f126c Clarify the difference between org-indent-mode and hard indentation
doc/org-manual.org (A Cleaner Outline View): Clarify the difference
between org-indent-mode and hard indentation
2019-08-16 23:31:57 +02:00
Carsten Dominik bb275b85df Remove duplicate information from the manual
* doc/org-manual.org (Tracking TODO state changes): Remove duplicated
information.
2019-08-16 17:27:01 +02:00
Carsten Dominik 07e48a7af6 Merge branch 'fix-org-columns-formatdocumentation' 2019-08-16 09:37:54 +02:00
Carsten Dominik 6dda536f9f Clear up unclear setting of columns format for the agenda
* lisp/org.el (org-columns-default-format-for-agenda): New option.

* lisp/org-colview.el (org-overriding-columns-format): Updated documentation.
(org-agenda-columns): `Use org-columns-default-format-for-agenda'

* doc/org-manual.org (Using Column View in the Agenda): Fix the
description how to set the columns format for agenda views.
2019-08-16 09:34:55 +02:00
Carsten Dominik f1c030bed5 Prefix argument to `org-todo' forces stage change logging
* lisp/org.el (org-use-fast-todo-selection): Allow values
`auto' and `expert'.
(org-todo): Change the interpretation of the prefix argument.
A single `C-u' now forces taking a logging time stamp and note.
(org-fast-todo-selection): Implement the `expert' option of
`org-use-fast-todo-selection' and avoid showing the selection
window.  Instead, show the options in the prompt.

* doc/org-manual.org: (Basic TODO Functionality): Document that `C-u
C-c C-t' is the simplest way to log a TODO state change.
(TODO keywords as workflow states): Slightly simplify text.
(TODO keywords as types): Document that tags should be used instead.
(Progress Logging, Closing items, Tracking TODO state changes):
Document that `C-u C-c C-t' is the simplest way to log a TODO
state change.
(Remote editing): Document using a prefix to the `org-agenda-todo'
command logs the state change.
(Using CDLaTeX to enter math): Document that CDLaTeX is	available on
MELPA.

* doc/org-guide.org (Progress Logging): Document the use of a
prefix to `org-todo' to force logging.
2019-08-14 09:58:38 +02:00
Carsten Dominik 64739aa065 Implement force logging of a TODO state change
* lisp/org.el (org-todo): Make a tripple `C-u' prefix force
          logging the todo state change with timestamp and a note.
          Ignoting blocking a change now needs four `C-u' prefixes,
          because this is probably hardly ever used.

	* doc/org-manual.org (Tracking TODO state changes): Document
          forcing of state change logging with `C-u C-u C-u C-c C-t'.
2019-08-01 08:10:20 +02:00
Kyle Meyer 9a543b97a5 orgguide: Fix typo
* doc/orgguide.texi (Embedded @LaTeX{}): Fix typo.

Reported-by: Thomas Nguyen <thomas.nguyen1@okcps.org>
2019-07-23 23:24:31 -04:00
Marco Wahl 13442ab719 org-manual: Fix key to toggle persistent marks 2019-07-24 00:02:27 +02:00
Carsten Dominik e059c1c1da Improve formatting and alignment in the refernce card 2019-07-19 10:36:57 +02:00
Carsten Dominik df7c78220a Document org-indent-mode and template insertion in refcard 2019-07-19 10:19:22 +02:00
Carsten Dominik 9e1e682135 Improve the mention of indent-mode in the guide 2019-07-19 08:58:16 +02:00
Marco Wahl 96267295a6 org-manual.org: Clarification about keys in Search view 2019-07-15 11:03:44 +02:00
Marco Wahl dc2198971b org-agenda: Respect narrowing for agenda restricted to buffer
* lisp/org-agenda.el (org-agenda): Add a condition to check if
  narrowing is in effect and in case set the agenda restriction markers.
* etc/ORG-NEWS (Respect narrowing when agenda command is restricted to buffer):
* doc/org-manual.org (The Agenda Dispatcher): Mention the behavior.
2019-07-15 00:22:51 +02:00
Carsten Dominik 8a30e8efef Fix typos in org-guide.org 2019-07-14 22:56:51 +02:00
Carsten Dominik aaca138324 Apply the proper way to describe a key in the guide 2019-07-14 14:05:44 +02:00
Carsten Dominik e571ca8e9d Document structure template insertion in the compact guide 2019-07-14 14:02:12 +02:00
Marcin Borkowski c2ef61ffcf Explain the `org-agenda-todo-ignore-...` variables in the manual 2019-07-09 12:19:25 +02:00
Gustav Wikström ae9cd4370b org-attach*, org, org-manual, org-news, ox-html, testing/*
* lisp/org-attach.el

Changed the way attachments deal with property-inheritance.  It now
adheres to the =org-use-property-inheritance= setting by default but
it can be customized if needed (I recommend to enable it!).
The property ATTACH_DIR is deprecated in favour of the shorter and simpler
property DIR.

Added an explicit option to =org-attach= for unsetting
attachment-directories (i.e. remove DIR property and deal with the
attachments by interaction).

Added attachment link type with the prefix "attachment:".

Added customizations:
- org-attach-dir-relative
- org-attach-preferred-new-method
- org-attach-use-inheritance
- org-attach-id-to-path-function

Hooks added:
- org-attach-after-change-hook
- org-attach-open-hook

A new linktype "attachment" is added in order to reduce
link-duplication when wanting to link to files in attached folders of
nodes.  This works for both ID and DIR properties.  The goal is to
make the functionality for attachment links mirror the functionality
for file links.

* lisp/org-attach-git.el

New file, existing functionality.  Code here has been factored out
from org-attach.el and if GIT-functionality is to be used this module
needs to be required sepatately.  It extends org-attach by use of its
hooks.

Activating git functionality in org-attach is done by loading
org-attach-git from now on, instead of customizing a variable.

Naming of both functions and tests has been modified to match the move
of functionality into its own module.

* lisp/org.el

Inline images are shown also using attachment-links, exactly the same
as it works for file-links today.

Make org-open-at-point respect ARG when opening attachment-dir.

* lisp/org-compat.el

org-attach-directory has been deprecated in favour for
org-attach-id-dir.  The new name matches its purpose better.

* lisp/ox-html.el

Export attachment links to images as inline images, in the same way as
file links work today.

* etc/ORG-NEWS

Mention the changes in this patch.

* doc/org-manual.org

The chapter "Refile, Copy, Archive" has been split into two separate
chapters.
- "Refile, Copy and Archiving" for information related to moving
  existing data around.

- "Capture, Attachments, RSS Feeds and Protocols" for information
  related to working with external data.

The attachment-part has been rewritten and extended to match the
changes in this patch.

The new attachment link type is mentioned both inside the attachments
chapter and in the chapter dealing with links.

Documentation related to external links has been improved.

* testing/lisp/test-org-attach-annex.el

Require org-attach-git instead of org-attach, since this file tests
the GIT-functionality.

* testing/lisp/test-org-attach.el

Add tests for org-attach.

* testing/org-test.el

Define a symbol for a file to test attachments with.

* testing/examples/*

A bunch of new example files and folders are created and are used in
testing of org-attach to verify its functionality.
2019-07-07 19:55:49 +02:00
Nicolas Goaziou 9ddfe45314 org-table: Improve `org-table-copy-down'
* lisp/org-table.el (org-table--increment-field): New function.
(org-table-copy-down): Use new function.
* testing/lisp/test-org-table.el (test-org-table/copy-down): New test.
* doc/org-manual.org (Calculations): Update documentation.
2019-06-28 00:07:25 +02:00
Nicolas Goaziou 2263634823 org-manual: Fix typo
* doc/org-manual.org (From Carsten): Fix typo.
2019-06-22 09:33:33 +02:00
Kyle Meyer 81920b3f86 Merge branch 'maint' 2019-06-09 21:39:18 -04:00
Paul Eggert 65a6f54605 Backport commit 852d28176 from Emacs
Update author/maintainer info
852d28176990d035366142bfde36a0440a317228
Paul Eggert
Sun May 26 01:00:16 2019 -0700
2019-06-09 21:35:45 -04:00
Gregor Zattler f4083eefd8 manual: Fix URL
* doc/org-manual.org (External Links): Fix URL
2019-06-07 23:34:46 +02:00
Nicolas Goaziou fb50912228 org-manual: Fix link to CDLaTeX mode
* doc/org-manual.org (Using CDLaTeX to enter math): Fix link to
  CDLaTeX mode.

Reported-by: Qqwy/Wiebe-Marten <qqwy@gmx.com>
<http://lists.gnu.org/r/emacs-orgmode/2019-06/msg00028.html>
2019-06-05 23:15:49 +02:00
Sacha Chua a41e9950ae Add :target option for the TOC keyword
* doc/org-manual.org, etc/ORG_NEWS: Document :target option
  for the TOC keyword.

* lisp/ox.el (org-export-resolve-link): New function.

* lisp/ox-ascii.el (org-ascii-keyword): Added :target to the TOC
  keyword.
  (org-ascii--build-toc): Changed LOCAL argument to SCOPE.

* lisp/ox-html.el (org-html-keyword): Added :target to the TOC keyword.

* lisp/ox-md.el (org-md-keyword): Added :target to the TOC keyword.
  (org-md--build-toc): Changed LOCAL argument to SCOPE.

* lisp/ox-odt.el (org-odt-keyword): Added :target to the TOC keyword.

* testing/lisp/test-ox.el (test-org-export/collect-headlines): Added
  tests for specifying scope by CUSTOM_ID or by fuzzy matching.
  (test-org-export/resolve-link): New test.
2019-05-30 15:25:46 +02:00
Kyle Meyer 84a4b73fd6 Merge branch 'maint' 2019-05-16 21:23:18 -04:00
Cheong Yiu Fung 2c9f259d65 org-manual: Small fixes
* doc/org-manual.org (Handling Links): Update variable
`org-id-link-to-org-use-id', which was changed in v7.9.2.

TINYCHANGE
2019-05-16 21:22:19 -04:00
Nicolas Goaziou cd1af27a2a Merge branch 'maint' 2019-05-10 19:38:27 +02:00
Josiah Schwab 4df7051255 manual: Update ADS link abbreviation example
* doc/org-manual.org (Link Abbreviations): Change URL.

Reported-by: Alain Kalker <a.c.kalker@gmail.com>
<http://lists.gnu.org/r/emacs-orgmode/2019-05/msg00083.html>

TINYCHANGE
2019-05-10 19:36:58 +02:00
Nicolas Goaziou c47c686d5f Merge branch 'maint' 2019-05-08 14:19:04 +02:00
Nicolas Goaziou e95ac0bac3 org-manual: Delete reference to removed function
* doc/org-manual.org (Inserting deadlines or schedules): Remove
  reference to `org-mark-entry-for-agenda-action`.

Reported-by: Christian Heinrich <com-orgmode@gladbachcity.de>
<http://lists.gnu.org/r/emacs-orgmode/2019-05/msg00060.html>
2019-05-08 14:17:30 +02:00
Nicolas Goaziou 8db6f52c0d Merge branch 'maint' 2019-04-25 10:28:45 +02:00
Sebastian Miele 4ec550fd5a org-manual: Fix typo
* doc/org-manual.org (Footnotes): Fix typo.
2019-04-25 10:28:05 +02:00
Nicolas Goaziou 262bcb4557 org-manual: Add missing description for Beamer export
* doc/org-manual.org (Beamer Export): Add missing description.
2019-04-23 10:42:45 +02:00
Emmanuel Charpentier 5b7b0fa8fb ox-latex: Support a :scale parameter
* lisp/ox-latex.el (org-latex-image-default-scale): Nev variable.
(org-latex--inline-image): Handle new :scale parameter.
* doc/org-manual.org (Images in LaTeX export): document the new :scale

Introduce a :scale #+ATTR_LATEX parameter, as well as a "" default
value for it.  When present, it overrides :width and :height
parameters (as it does for ODT export and in ox-pandoc exporters).

Implementation: uses \scalebox for tikz/pgf images, "scale=" parameter
of \includegraphics in other cases.
2019-04-22 14:01:59 +02:00
Nicolas Goaziou 6d283dcade Merge branch 'maint' 2019-04-17 14:22:21 +02:00
Sebastian Miele 0803e2d0ea org-manual: Minor fixes
* doc/org-manual.org (Motion): Fix the names of the four functions
  bound to C-c C-n, C-c C-p, C-c C-f, and C-c C-b.
2019-04-17 14:20:48 +02:00