Commit Graph

3117 Commits

Author SHA1 Message Date
Daniele Nicolodi b2d38a822d doc/org-manual.org: Extend table formulas Lisp form documentation
* doc/org-manual.org (Emacs Lisp forms as formulas): Be more
explicit about how fields are interpolated into the Lisp forms,
clarify the use of mode flags, and add a couple more examples.
2020-11-27 00:05:57 -05:00
Daniele Nicolodi 15469774dd org-table: Add mode flag to enable Calc units simplification mode
* org-table.el (org-table-eval-formula): Add the `u` mode flag to
enable Calc's units simplification mode.

* test-org-table.el (test-org-table/mode-string-u): Add Unit test for
the new mode flag.

* org-manual.org: Document new mode flag.
2020-11-24 20:59:39 -05:00
Kyle Meyer 0d525cbc7c Merge branch 'maint' 2020-11-19 23:04:32 -05:00
Dieter Faulbaum 5272d97e5c manual: Repeat cookies should be in the same order as the repeats
* doc/org-manual.org (Repeated tasks): Reorder repeat cookies so that
their order matches the order of the labels at the beginning of the
sentence.

TINYCHANGE
2020-11-19 23:03:49 -05:00
Greg Minshall a5d765481d doc/org-manual.org: add reference to org-table-transpose-table-at-point
* doc/org-manual.org (Built-in Table Editor): Add
org-table-transpose-table-at-point to list of miscellaneous commands.
2020-11-19 22:54:21 -05:00
Kyle Meyer b1883de538 Merge branch 'maint' 2020-11-12 01:01:21 -05:00
Kyle Meyer f6cf6bb6e2 manual: Mention org-agenda-set-effort
* doc/org-manual.org (Remote editing): Add entry for
org-agenda-set-effort.

Reported-by: Ian Garmaise <ian.g@phorixsol.com>
Ref: https://orgmode.org/list/CALWEx6WuTe_b2c-em8jTzx5k=XHGy1L=87tn5Ge9g3oHPp1fVA@mail.gmail.com
2020-11-12 00:45:57 -05:00
Kyle Meyer f0b8de9687 Merge branch 'maint' into master 2020-11-07 02:38:21 -05:00
Kyle Meyer 49f4c364fd manual: Re-attach a footnote to its definition
With the conflict resolution in 9410fbe06 (Merge branch 'maint',
2020-09-06), what was footnote definition 89 got moved to 161, but the
reference remained 89.  Re-link the footnote and definition, and then
renumber and sort the footnotes.
2020-11-07 02:36:37 -05:00
Kyle Meyer 8ba7cf17a2 manual: Drop orphan footnote definitions
* doc/org-manual.org (Footnotes): Drop two definitions whose
references were removed in the previous commit.
2020-11-07 02:33:38 -05:00
Ian Martins 3cc15f993f org-manual.org: Remove language list and fix Worg link
* doc/org-manual.org: Remove the language list and fix the Worg link
since the languages page has moved.  Renumber footnotes.

The language list in the manual is missing many languages.  Rather
than trying to keep the list up to date in two places that link to
each other, this removes the list from the manual which is updated
less frequently.  There were a few footnotes in the table, so this
also renumbers the remaining footnotes.

The languages page was moved in Worg to make it the index page in the
languages directory.  This updates the link in the manual to point to
its new location.
2020-11-06 07:19:04 -05:00
Matt Huszagh d9884cfa70 lisp/ob-core.el: Allow passing empty vector to :file-desc to omit description
* doc/org-manual.org (Type): Document empty vector argument for
file-desc.
* etc/ORG-NEWS (New argument for ~file-desc~ babel header): Add entry
to NEWS.
* lisp/ob-core.el (org-babel--file-desc): Add new function to evaluate
file description value.
(org-babel-execute-src-block): Correctly evaluate file description
when executing src block.
(org-babel-insert-result): Correctly evaluate file description value
when inserting the result of src block execution into the buffer.
* testing/lisp/test-ob.el (test-ob/file-desc-header-argument): Add
test case for new behavior.
2020-10-06 23:13:12 -04:00
Phil Hudson 83c93e6fed org-capture.el: Give a default value when prompting for a property
* lisp/org-capture.el (org-capture-templates)
(org-capture-fill-template): Enable declaring a default value
when prompting for a property during capture.

* lisp/org.el (org-read-property-value): Add parameter DEFAULT
for an initial/default/suggested property value.

* doc/org-manual.org: Document declaring a default value for a
prompted property during capture.
2020-09-23 14:12:08 +02:00
David Masterson e2bb60581b doc/org-manual.org (Org Crypt): Add info links to epa and GnuPG
* doc/org-manual.org (Org Crypt): Add info links to epa and GnuPG.

TINYCHANGE
2020-09-23 11:03:24 +02:00
Samuel W. Flint d06aa486d6 Add in support for filling in the bare link in org capture
* doc/org-manual.org: Document new %L capture template formatting
directive.
* lisp/org-capture.el (org-capture-templates): Document new %L capture
template formatting directive.
* lisp/org-capture.el (org-capture-fill-template): Add in support for
%L, bare link formatting, in org-capture-fill-template.

TINYCHANGE
2020-09-23 10:57:49 +02:00
Ihor Radchenko 8efec3d4cd Fix example of in-buffer setting of archive location in manual
* doc/org-manual.org (Summary of In-Buffer Settings): Fix archive
example.

The provided example '%s_done' is not valid syntax for archive
location. Should be '%s_done::'.
2020-09-13 00:50:15 -04:00
Nick Dokos b567445fcb Fix syntax of #+ATTR_HTML
* doc/org-manual.org (Tables in HTML export): Fix syntax of example.

The example in the "Tables in HTML export" section of the manual
uses the old syntax: `border="2"' etc.

Change it to use `:border 2' etc.
2020-09-13 00:46:34 -04:00
Bastien 9410fbe060 Merge branch 'maint' 2020-09-06 07:52:28 +02:00
Bastien 351a0a0b0c org-manual.org: Add a footnote for the difference between C-. and .
* doc/org-manual.org (The date/time prompt): Add a footnote for
the difference between `C-.' and `.' in the date prompt.

See <https://orgmode.org/list/20200905161804.3inpmz5o3nensyna@gmail.com>
2020-09-06 07:46:47 +02:00
Bastien ed8369aff2 org-manual.org: Two enhancements
* doc/org-manual.org (JavaScript supported display of web pages):
Small rephrasing.
(Exporting to minimal HTML): New section.

Reported-by: Paramjit Singh <paramjitrohits@gmail.com>
2020-09-05 11:44:43 +02:00
Bastien 2af977016f org-manual.org: Document more capture template elements
* doc/org-manual.org (Template elements, Template elements):
Document more template elements.

Reported-by: Ian Garmaise <ian.g@phorixsol.com>
2020-09-05 11:21:58 +02:00
Bastien 8538654591 Merge branch 'maint' 2020-09-05 11:09:52 +02:00
Bastien 00a782112a org-manual.org: Grammar fix
* doc/org-manual.org (The clock table): Grammar fix.

Reported-by: Nick Dokos <nick@dokosmarshall.org>
2020-09-05 10:46:17 +02:00
Kyle Meyer 3377105c92 Merge branch 'maint' into master 2020-09-04 20:32:58 -04:00
Kyle Meyer 4b2123fb71 manual: Clarify behavior of :file-desc
* doc/org-manual.org (Results of Evaluation): Distinguish between
behavior when the :file-desc header argument is not present and when
it has no value.

The current handling of the :file-desc argument is to omit the
description if the header argument isn't present and to use the :file
value as the description if :file-desc is present without a value.
This matches the original intention [*].

[*] https://orgmode.org/list/87vclky211.fsf@med.uni-goettingen.de

Reported-by: Matt Huszagh <huszaghmatt@gmail.com>
  https://orgmode.org/list/87sgbzl6uy.fsf@gmail.com
2020-09-04 20:32:50 -04:00
Bastien Guerry 13cf0dc6d6 Merge branch 'maint' 2020-09-04 15:45:23 +02:00
Bastien Guerry 2df7a8fab0 org-manual.org: Document . and C-. keybindings
* doc/org-manual.org (The date/time prompt): Document . and
C-. keybindings.

See <https://orgmode.org/list/20200829224748.32186-1-orgmode@adamspiers.org>
2020-09-04 15:44:41 +02:00
John Herrlin ea946353aa ob-core: file-mode option in source code block arguments
* ob-core.el (org-babel-execute-src-block): Source code block header
argument `:file-mode' can set file permissions if `:file' argument is
provided.
(org-babel-common-header-args-w-values): Add `:file-mode' to common
header arguments.

TINYCHANGE
2020-08-02 22:59:25 -04:00
Kyle Meyer a1e5bee5cb Merge branch 'maint' 2020-07-29 22:29:10 -04:00
Matt Huszagh 521d7f5fe4 org-manual.org: Modify file-desc header argument to match action
* doc/org-manual.org (Results of Evaluation): Correct description of
how file-desc behaves when no value is given.

TINYCHANGE
2020-07-29 22:24:04 -04:00
Marco Wahl 97188a0cff Merge branch 'maint' 2020-07-05 21:27:19 +02:00
Marco Wahl 5d686811ac manual: Fix typo
* doc/org-manual.org (Clocking Work Time):

TINYCHANGE

Patch by Arun Isaac. See https://orgmode.org/list/20200705112846.16510-1-arunisaac@systemreboot.net/.
2020-07-05 21:22:31 +02:00
Kyle Meyer aa32f65f83 Rename org-startup-numeroted variable to fix typo
* lisp/org.el (org-startup-numerated): Fix "numeroted" typo in
variable name.
(org-startup-options):
(org-mode):
* doc/org-manual.org (Dynamic Headline Numbering):
(Summary of In-Buffer Settings): Update for rename.

Also fix a few related typos in ORG-NEWS and the manual.

No compatibility alias has been added, as this variable hasn't yet
made it into a release.
2020-06-11 17:55:50 -04:00
Bastien Guerry c7a86a43ae Merge branch 'maint' 2020-06-05 10:40:14 +02:00
Bastien Guerry fa4dddf8d2 Fix broken links
* lisp/org.el:
* lisp/ol-bibtex.el:
* etc/ORG-NEWS (org-capture.el is now the default capture system):
* doc/org-manual.org (Cache results of evaluation): Fix broken links.
2020-06-05 10:39:52 +02:00
Bastien 9092c289b6 Bind `org-force-cycle-archived' to C-c C-TAB
* lisp/org-keys.el (org-mode-map): Bind `org-force-cycle-archived'
to C-c C-TAB instead of C-TAB to avoid conflict with native Emacs
keybinding.

* doc/org-manual.org (Internal archiving): Update a keybinding.
2020-06-01 14:39:28 +02:00
Bastien 3b2de48989 Merge branch 'maint' 2020-05-29 18:34:12 +02:00
Bastien f5997d5956 doc/org-manual.org (List of Contributions): Fix typo
* doc/org-manual.org (List of Contributions): Fix typo.
2020-05-29 18:34:01 +02:00
Bastien 412f0406da doc/org-manual.org: Mention `stuck' as an available agenda view
* doc/org-manual.org (Block agenda): Mention `stuck' as an
available agenda view for a block agenda.
2020-05-23 15:39:30 +02:00
Bastien da8eadd1e5 doc/org-manual.org: Document the `!' agenda command separately
* doc/org-manual.org (The Agenda Dispatcher): Document the `#' and
`!' agenda commands separately.
2020-05-23 15:37:05 +02:00
Nicolas Goaziou 80de8400c6 manual: Fix typo
* doc/org-manual.org (Headlines): Fix typo.
2020-05-22 17:24:20 +02:00
Bastien 27ec1c2cff doc: Mention that a space is needed after the star(s) in a headline
* doc/org-guide.org (Headlines): Mention that the stars at the
beginning of a headline must be followed by a space.

* doc/org-manual.org (Headlines): Ditto.
2020-05-22 16:26:09 +02:00
Nicolas Goaziou 817acdcdfb manual: Small rewording
* doc/org-manual.org (Attachments): Avoid using "cloud" term.
(Attachment defaults and dispatcher): Use present tense.
(Attachment options): Use Org attach instead of symbol org-attach.
2020-05-14 23:56:52 +02:00
Nicolas Goaziou 4a727d2cfc manual: Some typographical fixes
* doc/org-manual.org (Global and local cycling):
(Initial visibility): Use complete sentences.  Use @var{...} for
meta-syntactical variables.  Do not capitalize CONTENTS.
2020-05-14 15:21:11 +02:00
Kyle Meyer cd2b108d22 manual: Update for change in org-startup-folded default
* doc/org-manual.org (Initial visibility):
(Summary of In-Buffer Settings): Update description of
org-startup-folded default, which changed in 88f5ed91c.

Reported-by: Charles Millar <millarc@verizon.net>
<708b3f3d-147b-a798-52cf-a13809c7470f@verizon.net>
2020-05-14 00:00:27 -04:00
Jonas Bernoulli 71604cbc2d Fix typos 2020-05-13 23:27:49 -04:00
Kyle Meyer 4349402f3f Merge branch 'maint' 2020-05-12 22:47:05 -04:00
Kyle Meyer 75902a4732 manual: Fix special property descriptions for DEADLINE/SCHEDULED
* doc/org-manual.org (Special Properties): Remove claim that angular
brackets are stripped from DEADLINE and SCHEDULED time stamps, which
has not been true since v8.3, specifically 8d8ad9838.

It doesn't seem like 8d8ad9838 (Rewrite `org-entry-properties',
2014-09-30) intended to change this behavior, but let's stick with it
because some spots in Org's code base depend on it and it's likely
that third-party code does too.

Also, replace "time string" with "timestamp" in DEADLINE's description
for consistency with the other descriptions.
2020-05-10 17:22:32 -04:00
Kyle Meyer b171ff02f6 Merge branch 'maint' 2020-05-05 22:38:00 -04:00
Kyle Meyer c53ff9b251 orgcard: Update binding for org-columns-insert-dblock
As of 34b71a0ca (Add a dispatcher command for inserting dynamic
blocks, 2018-12-23), the binding was removed and the command is
available via org-dynamic-block-insert-dblock.
2020-05-05 22:31:43 -04:00
Kyle Meyer 861ffb3133 manual: Remove stale information about dynamic block bindings
* doc/org-manual.org (Capturing column view): Replace stale binding
with mention of org-dynamic-block-insert-dblock, and refer to
org-columns-insert-dblock rather than its obsolete variant.
(The clock table): Prune references to stale binding, rewrite
org-dynamic-block-insert-dblock key sequence in a clearer manner, and
add a dedicated entry for org-clock-report.

These bindings were replaced in 34b71a0ca (Add a dispatcher command
for inserting dynamic blocks, 2018-12-23).

Reported-by: Axel Kielhorn <org-mode@axelkielhorn.de>
<3CE37EF0-6C7A-4CC0-AFEE-2B82296D63E1@axelkielhorn.de>
2020-05-05 22:27:50 -04:00
Nicolas Goaziou a1ad6fe8fe manual: Fix markup typo
* doc/org-manual.org (Footnotes): Use code instead of verbatim for
Elisp variables. Also prefer asterisk for heading links.
2020-04-30 17:44:43 +02:00
Nicolas Goaziou 90cf5009cb manual: Replace load-path with load path
* doc/org-manual.org (Downloading Org as an archive):
(Using Org's git repository): Use "load path" when talking about the
concept, not the variable.
2020-04-29 19:55:50 +02:00
Nicolas Goaziou 178e47a0c5 Merge branch 'maint' 2020-04-24 11:04:24 +02:00
Nicolas Goaziou 0b3a2b3271 manual: Add a reference to `org-babel-expand-src-block'
* doc/org-manual.org (Noweb Reference Syntax): Add a reference to
`org-babel-expand-src-block'.
2020-04-24 11:03:20 +02:00
Nicolas Goaziou a5696b6e4f Merge branch 'maint' 2020-04-23 10:39:37 +02:00
Greg Minshall c8eaa5fcf1 manual: some clarification on <<noweb>> syntax
* doc/org-manual.org (Noweb Reference Syntax): Add some clarification
on <<noweb>>, #+name:, :noweb-ref.
2020-04-23 10:38:47 +02:00
Brian Powell bc90264ac6 ox-html: Add customizable format string for equations
* lisp/ox-html.el (org-html-equation-reference-format): New variable.
* doc/org-manual.org update to reference new variable
2020-04-21 19:44:03 +02:00
Nicolas Goaziou 55141cdead Merge branch 'maint' 2020-04-20 22:34:14 +02:00
Nicolas Goaziou baa44bd705 manual: Some additional clarifications in noweb expansion
* doc/org-manual.org (Cache results of evaluation):
(Extracting Source Code):
(Header arguments): Use noweb instead of Noweb.
(Noweb Reference Syntax): Add some clarifications.
2020-04-20 22:31:18 +02:00
Nicolas Goaziou 152a5ef58c Merge branch 'maint' 2020-04-20 11:21:36 +02:00
Nicolas Goaziou 53e9c7b89d manual: Clarify Noweb references section
* doc/org-manual.org (Noweb Reference Syntax): Clarify Noweb
references section.  In particular, insist on the different uses for
NAME keyword and :noweb-ref header arguments.
2020-04-20 11:19:50 +02:00
Nicolas Goaziou b889000ed2 Merge branch 'maint' 2020-04-19 18:48:43 +02:00
Nicolas Goaziou 104f07a02f manual: fix typo
* doc/org-manual.org (Using Emacs packaging system): Drop the end of
the sentence since Texinfo closes it after the link.
2020-04-19 18:42:58 +02:00
Nicolas Goaziou f4384fa397 Merge branch 'maint' 2020-04-19 18:39:37 +02:00
Nicolas Goaziou 3a08012705 manual: Fix installation instructions
* doc/org-manual.org (Using Emacs packaging system): Fix installation
instructions.  `M-x package-install RET org' does not work because
"org" is a built-in package, so it is not available for installation.
2020-04-19 18:38:23 +02:00
Marco Wahl 0e5be8a656 Merge branch 'maint' 2020-04-18 00:21:39 +02:00
Marco Wahl 22d2b0ac84 org-table: Insert column at point
* lisp/org-table.el (org-table-insert-column): Adjust the function to
insert the column at point (and not to the right.)

Org-manual, ORG-NEWS and testing are changed accordingly.
2020-04-18 00:13:24 +02:00
Nicolas Goaziou 62aa9d85d2 manual: Fix typo
* doc/org-manual.org (Attachment options): Fix typo.
2020-04-14 16:31:02 +02:00
Nicolas Goaziou 78027af09b org-manual: Fix typos.
* doc/org-manual.org (Attachment options): Fix typos.
2020-04-14 16:26:40 +02:00
Kyle Meyer 56cf753b63 Merge branch 'maint' 2020-04-13 23:57:32 -04:00
Kyle Meyer 4f9e07cbb4 manual: Correctly describe 'C-c -'s region behavior
* doc/org-manual.org (Plain Lists): Fix mismatch between the
documented and actual behavior by inverting the description of what
'C-c -' does, with and without a prefix argument, when the region is
active.

Reported-by: Jorge P. de Morais Neto <jorge+list@disroot.org>
  <87sgh7r3yl.fsf@disroot.org>
2020-04-13 23:56:36 -04:00
Kyle Meyer 65f5bb6e96 Merge branch 'maint' 2020-04-12 18:27:16 -04:00
Kyle Meyer 5b1c5bd51d manual: Fix an incorrect key binding
* doc/org-manual.org (Sparse Trees): Fix binding for visible-only
export toggle.

Reported-by: Jorge P. de Morais Neto <jorge@disroot.org>
  <87a73gstpz.fsf@disroot.org>
2020-04-12 18:26:31 -04:00
Nicolas Goaziou 5b41528bcb manual: Tiny rewording
* doc/org-manual.org (Repeated tasks): Add missing commas.
2020-04-07 12:22:39 +02:00
Nicolas Goaziou 3c87b8263d org-manual: Use present tense if possible
* doc/org-manual.org (Repeated tasks): Prefer present tense over
future tense whenever applicable.
2020-04-06 15:36:59 +02:00
Nicolas Goaziou fb593f7556 Handle ".+" repeater with hours step
* doc/org-manual.org (Repeated tasks): Document new feature.
* lisp/org.el (org-auto-repeat-maybe): Repeat from now when ".+" is
used in conjunction of hours increment.
* testing/lisp/test-org.el (test-org/auto-repeat-maybe): Add tests.
2020-04-06 15:18:48 +02:00
Marco Wahl b9935765f7 Merge branch 'maint' 2020-03-31 00:12:14 +02:00
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 c93ed7feb6 doc/doc-setup.org: Update maintainer 2020-02-12 17:41:29 +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
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