Commit Graph

512 Commits

Author SHA1 Message Date
Marco Wahl 6a3dffdf24 org-manual: Make doc consistent with code about column insert 2020-03-31 00:09:10 +02:00
Nicolas Goaziou 97f0f1aad2 org-manual: Fix typo
* doc/org-manual.org (The clock table): Add missing closing marker.
2020-03-29 12:37:08 +02:00
Kyle Meyer ba685555c4 org-clock: Mention semimonth step in manual and add test
* doc/org-manual.org (The clock table): Mention new semimonth :step
value.
* testing/lisp/test-org-clock.el (test-org-clock/clocktable/step):
Test :step semimonth.

Add a NEWS entry as well.
2020-03-26 21:04:00 -04:00
Carsten Dominik 87f483240a Fix a typo 2020-03-23 14:48:22 +01:00
Carsten Dominik 1a978953a2 * doc/org-manual.org (Capturing column view): Doc :match parameter. 2020-03-23 14:40:11 +01:00
Kyle Meyer 4b26289f00 manual: Clarify which structure editing commands use the region
* doc/org-manual.org (Structure Editing): Combine org-do-promote and
org-do-demote into a single entry that includes the remark about their
treatment of an active region.

At the end of the structure editing node, there is a note that
promotion and demotion works on the region, if active, but that
applies only to org-do-demote and org-do-promote, not
org-promote-subtree and org-demote-subtree.  Reposition this comment
to avoid any confusion.

Suggested-by: B Goodr <bgoodr@gmail.com>
2020-03-17 23:40:05 -04:00
Nicolas Goaziou 73bd246ca7 org-manual: Add missing description
* doc/org-manual.org (Escape Character): Add missing description.
2020-03-17 09:50:47 +01:00
Nicolas Goaziou e81cd90bb0 org-manual: Use `kbd' macro for keybindings
* doc/org-manual.org (Handling Links): Use `kbd' macro for
keybindings.
2020-03-17 09:30:43 +01:00
Glenn Morris 173d2d9862 Backport commit e135414b2 from Emacs
with-eval-after-load is a cleaner, standard feature that works
for every file
* doc/org-manual.org (Handling Links):
Replace load-hooks with with-eval-after-load

Replace doc references to load-hooks
e135414b271e71c16e28efc2e3f29b803ab67424
Glenn Morris
Thu Jan 16 21:53:37 2020 -0800
2020-03-15 22:51:31 -04:00
Nicolas Goaziou ecb993eff4 org-manual: Add missing parenthesis
* doc/org-manual.org (Property Searches): Add missing parenthesis
around function name, as expected in manual's conventions.
2020-03-15 14:19:12 +01:00
Nicolas Goaziou e68db498c5 org-manual: Small tweaks
* doc/org-manual.org (Features Overview): Change title.
(Languages): Tweak columns width.
2020-03-15 14:07:50 +01:00
Kyle Meyer 8ac1600974 Merge branch 'maint' 2020-03-06 23:09:12 -05:00
Kyle Meyer 01ee25c605 manual: Fix description of a table range example
* doc/org-manual.org (Range references): Correct statement about the
number of fields that an example range includes.

Reported-by: Sebastian Miele <sebastian.miele@gmail.com>
<87eeu8kzyj.fsf@gmail.com>
2020-03-06 23:09:04 -05:00
Kyle Meyer d92d7ff697 manual: Clarify that table ranges are inclusive
* doc/org-manual.org (Range references): Note that field ranges
include the ends.

Suggested-by: Sebastian Miele <sebastian.miele@gmail.com>
<878skdrepp.fsf@gmail.com>
2020-03-06 23:08:24 -05:00
Bastien e6df039848 doc/org-manual.org (How to create a useful backtrace): Fix typo
* doc/org-manual.org (How to create a useful backtrace): Fix typo.
2020-02-29 12:56:06 +01:00
Bastien f360f9ec58 doc/org-manual.org (How to create a useful backtrace): Fix typo
* doc/org-manual.org (How to create a useful backtrace): Fix typo.
2020-02-29 12:55:56 +01:00
Bastien 14a56eb915 Merge branch 'maint' 2020-02-24 10:42:36 +01:00
Bastien 46886f22d9 doc/org-manual.org (Completion): Fix documentation
* doc/org-manual.org (Completion): Fix documentation.
2020-02-24 10:34:46 +01:00
Nicolas Goaziou 2ab655fb6e org-manual: Fix typo
* doc/org-manual.org (Subscripts and Superscripts): Do not use quote
for symbols.
2020-02-23 11:59:10 +01:00
Jack Kamm 194a85d689 org-manual.org: Remove outdated information about ob-python results
* doc/org-manual.org (Results of Evaluation): Remove incorrect
information about how python session blocks extract results (outdated
since cc89d5523), and about how python session output differs from
non-session output (the examples no longer differ since b506bb68d).
2020-02-22 09:37:33 -08:00
Bastien 08428fed78 ob-shell.el: Delete `org-babel-shell-return-value-is-exit-status'
* lisp/ob-shell.el (org-babel-sh-evaluate): Return the output
by default.  Return exit status as the "value" when :result is
explicitely set to "value".

* lisp/ob-shell.el
(org-babel-shell-return-value-is-exit-status): Delete option.

* doc/org-manual.org (Collection): Be more accurate.

See the whole thread here:
https://lists.gnu.org/archive/html/emacs-orgmode/2020-02/msg00715.html

Thanks to everyone in this discussion.
2020-02-22 10:58:55 +01:00
Bastien e360cd8f3a Change the default values for several options
* doc/org-manual.org (Execute commands in the active region):
Update the manual given the new defaults.

* etc/ORG-NEWS (New default settings for some options): New
section.

* lisp/org.el (org-loop-over-headlines-in-active-region):
Change the default value to `t'.
(org-fontify-done-headline): Ditto.

* lisp/org-agenda.el
(org-agenda-loop-over-headlines-in-active-region): Ditto.

* lisp/org-src.el (org-src-tab-acts-natively): Ditto.
2020-02-21 16:35:56 +01:00
Nicolas Goaziou 5d2075abad org-manual: Stick to typographic conventions
* doc/org-manual.org (Subscripts and Superscripts): Use ~...~ markup
for symbols and capital letters for keywords. Also prefer direct voice
and present tense whenever possible.
2020-02-20 09:57:38 +01:00
Bastien 86cbaff2b8 org-manual.org: Enhance the "Subscripts and Superscripts" section
* doc/org-manual.org (Subscripts and Superscripts): Be more
explicit about the interaction between the relevant options.
2020-02-19 22:27:44 +01:00
Nicolas Goaziou f4bed78a19 Move custom links to new tooling
* contrib/lisp/ol-bookmark.el (org-bookmark-open):
* contrib/lisp/ol-elisp-symbol.el (elisp-symbol-open):
* contrib/lisp/ol-git-link.el (org-gitbare-open):
(org-git-open):
* contrib/lisp/ol-man.el (org-man-open):
* contrib/lisp/ol-mew.el (org-mew-open):
* contrib/lisp/ol-notmuch.el (org-notmuch-open):
(org-notmuch-search-open):
(org-notmuch-tree-open):
* contrib/lisp/ol-vm.el (org-vm-open):
(org-vm-imap-open):
* contrib/lisp/ol-wl.el (org-wl-open):
* contrib/lisp/org-mac-link.el (org-mac-together-item-open):
(org-mac-addressbook-item-open):
(org-mac-skim-open):
(org-mac-acrobat-open):
(org-mac-outlook-message-open):
(org-mac-evernote-note-open):
(org-devonthink-item-open):
(org-mac-message-open):
* contrib/lisp/org-mairix.el (org-mairix-open):
* lisp/ol-bbdb.el (org-bbdb-export):
(org-bbdb-open):
* lisp/ol-bibtex.el (org-bibtex-open):
* lisp/ol-docview.el (org-docview-open):
* lisp/ol-eshell.el (org-eshell-open):
* lisp/ol-eww.el ("eww"):
* lisp/ol-gnus.el (org-gnus-open):
* lisp/ol-info.el (org-info-open):
* lisp/ol-irc.el (org-irc-visit):
* lisp/ol-mhe.el (org-mhe-open):
* lisp/ol-rmail.el ("rmail"):
(org-rmail-open):
* lisp/ol.el (org-link--open-doi):
(org-link--open-elisp):
(org-link--open-help):
(org-link--open-shell):
* lisp/org-id.el (org-id-open):
* testing/lisp/test-ox.el (test-org-export/custom-protocol-maybe): Use
new tooling.
* doc/org-manual.org (Adding Hyperlink Types): Adapt example.
2020-02-19 18:42:50 +01:00
Bastien 325962c003 org.el: New option `org-startup-numeroted' and #+startup: num
* lisp/org.el (org-startup-numeroted): New option.
(org-startup-options): New "num" and "nonum" startup keywords.
(org-mode): Startup according `org-startup-numeroted' or the
local #+startup setup.

* doc/org-manual.org (Dynamic Headline Numbering)
(Summary of In-Buffer Settings): Document
`org-startup-numeroted' and #startup: num.

* etc/ORG-NEWS: Document the new startup option.

Thanks to Guillaume MULLER for this idea.
2020-02-18 13:27:33 +01:00
Bastien 430b644f79 Merge branch 'maint' 2020-02-13 08:19:34 +01:00
Bastien 79ed6d208e org-manual.org: Fix repository link
* doc/org-manual.org (Using Org's git repository): Fix
repository link.

Thanks to Gustavo Barros for reporting this.
2020-02-13 08:19:24 +01:00
Bastien 73445c0fab Merge branch 'maint' 2020-02-12 17:56:43 +01:00
Bastien c39c5c6559 Fix info dircategory
Thanks to Drew Adams and Steve Berman for reporting this.
2020-02-12 17:41:51 +01:00
Bastien 5d21fbbcf3 doc/org-manual.org: Fix typo
Thanks to Colin Baxter for reporting this.
2020-02-12 09:10:12 +01:00
Bastien eaa220f6a7 Small code enhancement
* doc/org-manual.org (Checkboxes): Minor update.

* lisp/org-list.el (org-at-radio-list-p): Respect the
attributes #+ATTR_* syntax.
2020-02-12 08:40:46 +01:00
Bastien 4028cc731b Use "#+attr_org: :radio" before lists to enable radio buttons
* doc/org-manual.org (Checkboxes): Document the use of
"#+attr_org".

* lisp/org.el (org-ctrl-c-ctrl-c): When the list at point is
preceded by "#+attr_org: :radio" use `org-toggle-radio-button'
instead of `org-toggle-checkbox'.

* lisp/org-list.el (org-at-radio-list-p): New defsubst.
(org-toggle-checkbox): Use it.

* etc/ORG-NEWS: Document the use of "#+attr_org".
2020-02-12 01:51:46 +01:00
Bastien 561feb128d Add `org-toggle-radio-button' and related minor mode
* doc/org-manual.org (Checkboxes): Document the new minor mode
and command.

* lisp/org-keys.el (org-mode-map): Bind C-c C-x C-r to
`org-toggle-radio-button'.

* lisp/org-list.el (org-list-checkbox-radio-mode): New minor
mode to let C-c C-c call `org-toggle-radio-button' instead of
`org-toggle-checkbox'.
(org-toggle-radio-button): New command.

* lisp/org.el (org-ctrl-c-ctrl-c): Use `org-toggle-radio-button'.

* etc/ORG-NEWS: Document the new minor mode and command.

Thanks to Phil Sainty for sharing this idea and links to similar
implementations.
2020-02-11 23:55:53 +01:00
Bastien e3b79ad2bf Allow a new value for `org-adapt-indentation'
* doc/org-manual.org (Hard indentation): Add a footnote
mentioning the new value for `org-adapt-indentation'

* etc/ORG-NEWS: Mention the new value for
`org-adapt-indentation'.

* lisp/org.el (org-logbook-drawer-re): New constant.
(org-adapt-indentation): Allow 'headline-data as a new value
to only adapt indentation for headline data.
(org-fixup-indentation, org--get-expected-indentation): Handle
`org-adapt-indentation' set to 'headline-data.

* lisp/org-indent.el (org-indent-mode)
(org-indent-add-properties): Handle `org-adapt-indentation'
set to 'headline-data.

* lisp/org-clock.el (org-clock-in): Call `org-indent-line'
after clock timestamp insertion.
2020-02-09 17:30:42 +01:00
Bastien a62751a6a5 Add `org-clock-toggle-auto-clockout'
* doc/org-manual.org: Document the new command.

* lisp/org-clock.el (org-clock-toggle-auto-clockout): New
command.
2020-02-09 11:17:42 +01:00
Bastien 88794cab06 New option `org-clock-auto-clockout-timer'
* etc/ORG-NEWS (New option ~org-clock-auto-clockout-timer~):
Mention the new option `org-clock-auto-clockout-timer'.

* doc/org-manual.org (Clocking out automatically after some
idle time): Document `org-clock-auto-clockout-timer'.

* lisp/org.el (org-clock-auto-clockout-insinuate): New
function to add a hook for auto-clocking out the current tasks
after `org-clock-auto-clockout-timer' seconds.

* lisp/org-clock.el (org-clock-auto-clockout-timer): New option.
(org-clock-auto-clockout): New function, use the new option.
2020-02-09 11:05:12 +01:00
Nicolas Goaziou c23fa7b178 Merge branch 'maint' 2020-02-08 13:08:43 +01:00
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
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