Commit Graph

3396 Commits

Author SHA1 Message Date
Ihor Radchenko a08c37603f
Merge branch 'bugfix' 2023-01-06 16:31:43 +03:00
Ihor Radchenko 28a9664844
org-manual.org: Clarify that `org-insert-property-drawer' is not a command
* doc/org-manual.org (Drawers): Emphasize that
`org-insert-property-drawer' is not interactive command, but a
function.

Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/tp3pbi$dk$1@ciao.gmane.io
2023-01-06 16:30:42 +03:00
Kyle Meyer 96a402780c Merge branch 'bugfix' 2023-01-01 13:15:12 -05:00
Kyle Meyer a43866e1cf Update remaining copyright years
Most copyright years were updated with the port of Emacs's cae528457
in e0815d754.  Update the remaining copyright years for files that
have Free Software Foundation as the copyright holder but aren't
included in the Emacs repo.
2023-01-01 13:13:15 -05:00
Eli Zaretskii e0815d7545 Backport commit cae528457 from Emacs
; Add 2023 to copyright years.
cae528457cb862dc886a34240c9d4c73035b6659
Eli Zaretskii
Sun Jan 1 05:31:12 2023 -0500
2023-01-01 12:44:47 -05:00
Ihor Radchenko 5bc5add326
lisp/org-keys.el: Provide terminal binding for `org-insert-structure-template'
* lisp/org-keys.el (or): Add alternative terminal binding for
`org-insert-structure-template'.  The default binding may not be
available in some terminals.

* doc/org-manual.org (Using Org on a TTY): List the new binding in the
manual.

Reported-by: Anthony Carrico <acarrico@memebeam.org>
Link: https://orgmode.org/list/d9222967-5747-bf54-8041-4a8453fe81fc@memebeam.org
2022-12-29 17:27:37 +03:00
Ihor Radchenko b2adb68afa
* doc/org-manual.org: Clarify :results file link with no :file
(Type):
(Format): Document that :results file link is using the source block
result as file path when :file header argument is not present.

Reported-by: dalanicolai <dalanicolai@gmail.com>
Link: https://orgmode.org/list/CACJP=3=HrzaB+b2bTk2=-hrcv0STx41eFjedgtp=qXvGjVJQWA@mail.gmail.com
2022-12-29 16:59:45 +03:00
Ihor Radchenko 04d2cc59e5
Merge branch 'bugfix' 2022-12-18 17:43:03 +03:00
Ihor Radchenko 12e10eb0dd
* doc/org-guide.org: Fix typos
(Visibility Cycling): Fix macro.
(Multi-state Workflow): Fix emphasis.
(Timestamps):
(Clocking Work Time):
(The Agenda Dispatcher): Fix heading link.

Reported-by: Cauim de Souza Lima <cauimsouza@gmail.com>
Link: https://orgmode.org/list/CAHFpVgHiZtBQ9U5CzJ1P1jGQVJhTGiP9uVdi9ttcP535urZkUg@mail.gmail.com
2022-12-18 17:41:52 +03:00
Ihor Radchenko dd4e06ddc3
org-manual: Document third-party package compatibility
* doc/org-manual.org (Installation): Document that we only guarantee
compatibility with the latest stable versions of third-party packages.

Link: https://orgmode.org/list/86iljd3x90.fsf@gmail.com
2022-12-18 15:43:40 +03:00
Ihor Radchenko 47bcdce19b
doc/org-manual.org: Document `org-hide-drawer-startup'
* doc/org-manual.org (Summary of In-Buffer Settings): Document the new
setting.
2022-12-13 14:13:01 +03:00
Ihor Radchenko dbad11b354
org-manual: Update `org-table-blank-field' command description
* doc/org-manual.org (Re-aligning and field motion): Update the
command description according to up-to-date docstring.

Reported-by: André A. Gomes <andremegafone@gmail.com>
Link: https://orgmode.org/list/87zgfrvzz1.fsf@localhost
2022-12-10 16:53:58 +03:00
Stefan Kangas c8ad9e4b28 Backport commit 8617edfff from Emacs
; Fix typos
8617edfffd07eb80561b4de6a37c5b0b5f442e07
Stefan Kangas
Wed Nov 30 16:59:41 2022 +0100
2022-11-30 17:19:12 -05:00
Ihor Radchenko eed4708b66
org-babel: Add new :results discard header argument
* lisp/ob-core.el (org-babel-result-cond): Unconditionally return nil
and suppress all the processing for :results discard.
(org-babel-common-header-args-w-values):
(org-babel-sha1-hash): Add the new value to know :results value list.
* doc/org-manual.org (Handling):
* etc/ORG-NEWS (New =:results discard= header argument): Document the
new value.

Reported-by: Daniel Ortmann <daniel.ortmann@oracle.com>
Link: https://orgmode.org/list/87tu2tjary.fsf@localhost
2022-11-27 08:32:51 +08:00
Ihor Radchenko 50a3558011
org-manual: Clarify auto-detection of code block result type
* doc/org-manual.org (How to evaluate source code): Link to Results of
evaluation section for details about the inserted code block result.
(Type): Clarify that auto-detecting result type relies on specific
language backend, linking to the relevant manual section.
(Languages): Clarify that Worg is a website.

Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/25461.4423.734070.149776@gargle.gargle.HOWL
2022-11-24 09:53:39 +08:00
Kyle Meyer 28f220d1da org-manual: Deleting trailing space to pass Emacs's pre-commit check 2022-11-23 15:45:00 -05:00
Ihor Radchenko b57674a847
org-manual: Document `org-babel-pre-tangle-hook' and `org-babel-tangle-body-hook'
* doc/org-manual.org (Tangle hooks): Document the missing hooks.
2022-11-22 10:48:46 +08:00
Kyle Meyer aed55381bd Merge branch 'km/from-emacs-master' 2022-11-20 22:30:47 -05:00
Stefan Kangas 257df88645 Backport commit 16318bfb5 from Emacs
; Fix typos
16318bfb518aa7bc06e502e6fad7e53ec91067f9
Stefan Kangas
Sun Nov 20 12:59:39 2022 +0100
2022-11-20 22:28:30 -05:00
Rudolf Adamkovič 62e1513b5a
ox-html: Update from MathJax 2 to MathJax 3+
* lisp/ox-html.el (
org-html-mathjax-options,
org-html-mathjax-template,
org-html--build-mathjax-config
): Update from MathJax 2 to 3 while maintaining compatibility.  All
legacy options should continue to work, except for the 'path' option
which must now point to MathJax 3 or later.
* testing/lisp/test-ox-html.el (
ox-html/mathjax-path-none,
ox-html/mathjax-path-default,
ox-html/mathjax-path-custom,
ox-html/mathjax-path-in-buffer,
ox-html/mathjax-options-default,
ox-html/mathjax-options-custom,
ox-html/mathjax-options-in-buffer,
ox-html/mathjax-legacy-scale-default,
ox-html/mathjax-legacy-scale-custom,
ox-html/mathjax-legacy-scale-in-buffer,
ox-html/mathjax-legacy-scale-message,
ox-html/mathjax-legacy-scale-message-in-buffer,
ox-html/mathjax-legacy-scale-ignore,
ox-html/mathjax-legacy-autonumber-ams,
ox-html/mathjax-legacy-autonumber-ams-in-buffer,
ox-html/mathjax-legacy-autonumber-none,
ox-html/mathjax-legacy-autonumber-none-in-buffer,
ox-html/mathjax-legacy-autonumber-all,
ox-html/mathjax-legacy-autonumber-all-in-buffer,
ox-html/mathjax-legacy-autonumber-message,
ox-html/mathjax-legacy-autonumber-message-in-buffer,
ox-html/mathjax-legacy-font-tex,
ox-html/mathjax-legacy-font-tex-in-buffer,
ox-html/mathjax-legacy-font-stix-web,
ox-html/mathjax-legacy-font-stix-web-in-buffer,
ox-html/mathjax-legacy-font-asana-math,
ox-html/mathjax-legacy-font-asana-math-in-buffer,
ox-html/mathjax-legacy-font-neo-euler,
ox-html/mathjax-legacy-font-neo-euler-in-buffer,
ox-html/mathjax-legacy-font-gyre-pagella,
ox-html/mathjax-legacy-font-gyre-pagella-in-buffer,
ox-html/mathjax-legacy-font-gyre-termes,
ox-html/mathjax-legacy-font-gyre-termes-in-buffer,
ox-html/mathjax-legacy-font-latin-modern,
ox-html/mathjax-legacy-font-latin-modern-in-buffer,
ox-html/mathjax-legacy-line-breaks-true,
ox-html/mathjax-legacy-line-breaks-true-in-buffer,
ox-html/mathjax-legacy-line-breaks-false,
ox-html/mathjax-legacy-line-breaks-false-in-buffer,
ox-html/mathjax-legacy-line-breaks-message,
ox-html/mathjax-legacy-line-breaks-message-in-buffer): Test MathJax in
general and also the conversion of legacy options from MathJax 2 to 3.
* testing/org-test.el (org-test-capture-messages): Add a new macro
useful for testing the messages put in the echo area.
* etc/ORG-NEWS: Document MathJax 2 to 3 upgrade, highlighting the
benefits of the new version but also mentioning the fact that the user
may need to update the `path' option in `org-html-mathjax-options'.
* doc/org-manual.org (Math formatting in HTML export): Update the link
to the MathJax CDN and the example of how to use `+HTML_MATHJAX' with
MathJax 3.  Also, remove the note on MathJax extensions, as they did
not work (and do not work) as documented.

Link: https://list.orgmode.org/orgmode/m2a667n4ax.fsf@me.com/
2022-11-21 10:44:56 +08:00
Bastien 46c4335e44 Merge branch 'bugfix' 2022-11-20 23:23:52 +01:00
Giovanni Ridolfi 225d58341b doc/org-manual.org: Fix keybinding
* doc/org-manual.org (Internal archiving): Fix keybinding.

TINYCHANGE
2022-11-20 23:21:26 +01:00
Ihor Radchenko 4c40fc3d4d
org: Allow spaces in #+LINK abbreviation definitions
* lisp/org.el (org-set-regexps-and-options): Allow spaces when
defining link abbreviations via #+LINK keyword.
* testing/lisp/test-org-element.el (test-org-element/link-parser): Add
a new test.
* doc/org-manual.org (Link Abbreviations): Add example demonstrating
link abbreviation with spaces.

Reported-by: Rudolf Adamkovič <salutis@me.com>
Link: https://orgmode.org/list/87zgf7zujc.fsf@localhost
2022-11-20 13:15:02 +08:00
Ihor Radchenko 0b124d7968
doc/org-manual.org: Clarify that :results none can be used as reference
* doc/org-manual.org (Handling): Clarify that :results none are still
computed and can be used when referenced.
2022-11-18 16:44:44 +08:00
Ihor Radchenko 9e62aaf5e4
doc/org-manual.org: Suggest keywords to have space after colon
* doc/org-manual.org (Summary of In-Buffer Settings): Declare that
keywords have space after colon.  This is not strictly true with the
current parser, but it will avoid problems when no space is given and
the value contains ":" in it.

Reported-by: Olivier <olivier107@gmail.com>
Link: https://orgmode.org/list/CAEfUq3hwMVQ-aJg51Sm1PmY3y1VFERARXcs5J3ZxHUDcn9j0sA@mail.gmail.com
2022-11-18 16:24:58 +08:00
Ihor Radchenko 79c64d8c3a
org-manual: Work around Emacs bug#59293
* doc/org-manual.org (Cache results of evaluation): Avoid (1) in the
code.  It is incorrectly recognized as a footnote reference by info.el

Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/25457.22124.839301.412560@gargle.gargle.HOWL
2022-11-17 13:40:51 +08:00
Ihor Radchenko d4299eeac7
org-manual: Clarify similarities and differences between HTML pre/postamble
* doc/org-manual.org (HTML preamble and postamble): Clarify that
`org-html-postamble' can take the same values with
`org-html-preamble'.  Highlight, that `org-html-postamble' can also be
set to `auto'.

Reported-by: Tim Cross <theophilusx@gmail.com>
Link: https://orgmode.org/list/86wn8gbvk0.fsf@gmail.com
2022-11-16 12:47:59 +08:00
Ihor Radchenko 4260f5a8d7
org-manual: Clarify Handling :results class
* doc/org-manual.org (Handling): Clarify that only one of the possible
handling options can be selected.

Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/25457.22124.839301.412560@gargle.gargle.HOWL
2022-11-14 11:45:38 +08:00
Ihor Radchenko 044f09aa6d
org-manual: Use "subtree" everywhere instead of "sub-tree"
* doc/org-manual.org (Property Syntax):
(The Export Dispatcher):
(Export Settings):
(CSS support):
(LaTeX header and sectioning structure):
(Structure of Code Blocks):
(ODT export commands):
(Header arguments in Org mode properties):
(Exporting Code Blocks):
(Noweb Reference Syntax):
(Using the Mapping API): Replace "sub-tree" with "subtree".

Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/25422.27044.980916.495348@gargle.gargle.HOWL
2022-11-10 09:54:19 +08:00
Daniel Ziltener 5e0c5c186d
org-babel: Add new "strip-tangle" :noweb argument value
* lisp/ob-tangle.el (org-babel-tangle-single-block): Strip noweb tags
from block if :noweb has been set to "strip-tangle".
* lisp/ob-core.el (org-babel-common-header-args-w-values): Add
"strip-tangle" as new allowed value.
* lisp/ob-core.el (org-babel-noweb-p): Add "strip-tangle" at the
appropriate positions.
* testing/lisp/test-ob-tangle.el (ob-tangle/strip-tangle): Add new test
case for "strip-tangle".
* doc/org-manual.org (Noweb Reference Syntax): Adjust documentation for
the noweb header argument.
* etc/ORG-NEWS: Add entry for new header argument value.

This patch adds the "strip-tangle" option for the :noweb header
argument.  This strips the noweb tags before tangling the block.  This can
be useful for e.g. testing purposes where one wants to use a block as
test case that can be both run inline as well as tangled into a file for
automated testing.

TINYCHANGE
2022-11-07 10:54:13 +08:00
Ihor Radchenko f5c89ba5f9
org-manual: Clarify :results file graphics header argument meaning
* doc/org-manual.org (Format): Clarify the difference between
:results file and :results file graphics.  Update the example to
something that can be tried locally.
2022-11-05 11:40:34 +08:00
Ihor Radchenko 5098404b19
org-manual: Document that hours are allowed in repeater intervals
* doc/org-manual.org (Timestamps): Mention that +Nh is a valid
repeater.

Reported-by: Jean Louis <bugs@gnu.support>
Link: https://orgmode.org/list/Y19mbeNMz1wXcQxK@protected.localdomain
2022-10-31 14:22:41 +08:00
Ihor Radchenko 5a358b3a35
org-manual: Detail one month response time in the mailing list
* doc/org-manual.org (Feedback): Ask to wait up to one month for the
bug review and followup otherwise.
2022-10-29 17:39:43 +08:00
stardiviner 46b71f9108
org.el: Support auto display inline images when cycling
* lisp/org.el (org-toggle-inline-images): Support region.
(org-display-inline-images): Fix refresh argument logic.
(org-remove-inline-images): Support region.

* lisp/org-keys.el (org-toggle-inline-images): Update arguments.

* lisp/org-cycle.el (org-cycle-inline-images-display): Add new option to
control whether auto display inline images when cycling.
(org-cycle-display-inline-images): Add new hook function to auto display
inline images when cycling.
(org-cycle-hook): Add `org-cycle-display-inline-images' into cycling
hook by default.

* doc/org-manual.org (Exporting):
* etc/ORG-NEWS: Document the new option.
2022-10-26 12:43:07 +08:00
Ihor Radchenko cce846e5f7
org-manual: Clarify `org-timer-start' command description
* doc/org-manual.org (Taking Notes with a Relative Timer): Emphasize
that timer at point is only taken into account when called with prefix
argument.

Reported-by: Ypo <ypuntot@gmail.com>
Link: https://orgmode.org/list/ae3befcf-1f62-fc84-e63c-16cd45bbaf78@gmail.com
2022-10-21 13:36:15 +08:00
Kyle Meyer 21155f007c Merge branch 'km/from-emacs-master'
- Take the change from 58a46fab0 (doc/org-manual.org: Mention that
   Network Theory Ltd. is closed, 2022-10-16) over Emacs's a95062e036d
   (Delete broken link to Network Theory Ltd, 2022-10-15).

 - Do not keep the {http => https}://staff.science.uva.nl/c.dominik/
   change from Emacs's 318722541 because that value is intended to be
   an example for the http row (with an https example in the next
   row).
2022-10-16 17:43:29 -04:00
Stefan Kangas b7aad5b095 Backport commit 318722541 from Emacs
; Prefer HTTPS to HTTP in many URLs
3187225416c66061b67e89092addc15cad2202b9
Stefan Kangas
Sat Oct 15 13:06:45 2022 +0200

[ km: Note that the staff.science.uva.nl change in the "External
  Links" table will be discarded in the merge because the value is
  supposed to be an example of an http link, not an https one (which
  is covered by the next row). ]
2022-10-16 17:42:05 -04:00
Stefan Kangas 43546a5cbe Backport commit a95062e03 from Emacs
* doc/org-manual.org (Summary): Remove broken link to Network Theory Ltd.

Delete broken link to Network Theory Ltd.
a95062e036d9d5fc45d9a3ba1c10b0bd9b587399
Stefan Kangas
Sat Oct 15 13:06:45 2022 +0200

[ km: Note that this is already covered by Org's 58a46fab0 and that
  version will be taken in the merge. ]
2022-10-16 17:40:27 -04:00
Bastien e47e9aa079 Merge branch 'bugfix' 2022-10-16 08:12:29 +02:00
Bastien 58a46fab0d doc/org-manual.org: Mention that Network Theory Ltd. is closed
See https://list.orgmode.org/orgmode/87edv9ti73.fsf@no.workgroup/

Suggested-by: Gregor Zattler <telegraph@gmx.net>
2022-10-16 07:43:20 +02:00
Ihor Radchenko 3fc782e9b8
org-manual: Fix typos
* doc/org-manual.org (Debugging formulas):
(Using third-party styles and templates):
(Publishing links): Fix typos.

Most of the suggestions have been incorporated.  A few missing are
added here.

Reported-by: TonyMc <afmcc@btinternet.com>
Link: https://orgmode.org/list/20171014123248.51568eec@Tourifreet
2022-10-16 12:37:20 +08:00
Ihor Radchenko 2d6032db96
org-manual: Clarify nil value of ~org-crypt-key~
* doc/org-manual.org (Org Crypt): Explain that nil value of
~org-crypt-key~ bypasses the per-heading properties.

Reported-by: Ignacio Casso <ignaciocasso@hotmail.com>
Link: https://orgmode.org/list/PAXPR06MB7760DA356C7C27045BEB64F6C6449@PAXPR06MB7760.eurprd06.prod.outlook.com
2022-10-14 10:16:47 +08:00
Ihor Radchenko 1966a7a8a8
org-manual: Document :eval yes header argument value
* doc/org-manual.org (Limit code block evaluation): Document that
:eval can be set to "yes" to evaluate the code all the time without
prompt.

Reported-by: Charles Millar <millarc@verizon.net>
Link: https://orgmode.org/list/87v8uj6l6m.fsf@localhost
2022-10-08 12:11:42 +08:00
Nicholas Vollmer 7f3a6cf6e7
org-capture: Add template hook properties
* lisp/org-capture.el (org-capture-templates): Document template hook properties.
(org-capture-finalize): Execute :prepare/:before/:after-finalize functions.
(org-capture-place-template): Execute :hook functions.

* doc/org-manual.org: Document template hook properties.

* etc/ORG-NEWS: Add news entry for template hook properties.

* testing/lisp/test-org-capture.el: Add tests for template hook properties.
2022-10-07 13:38:52 +08:00
Ihor Radchenko eece396db8
org-manual: Add example illustrating date tree
* doc/org-manual.org (Footnotes): Add an example of date tree.

Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/25406.43056.751008.896240@gargle.gargle.HOWL
2022-10-07 12:02:37 +08:00
Ihor Radchenko 9ef449224b
org-manual: Fix the location of "date tree" index entry
* doc/org-manual.org (Using capture):
(Template elements): Move the index reference to more appropriate
location.

Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/25406.43056.751008.896240@gargle.gargle.HOWL
2022-10-07 12:01:10 +08:00
Stefan Kangas e28e3aaabb
Improve documentation of org-agenda-skip-*
* doc/org-manual.org (Special Agenda Views): Improve indexing.
* lisp/org-agenda.el (org-agenda-skip-function)
(org-agenda-skip-entry-if, org-agenda-skip-subtree-if): Expand
docstrings.
(org-agenda-skip-if): Doc fix; clarify wording.
2022-10-07 11:47:44 +08:00
Ihor Radchenko 580f286140
doc/org-manual.org: Fix typo
* doc/org-manual.org (Using the Mapping API): Fix incorrect
description of the return value of `org-map-entries'.  The return
value is a list, not alist.

Reported-by: Ignacio Casso <ignaciocasso@hotmail.com>
Link: https://orgmode.org/list/PAXPR06MB7760636DC6C66FB22B27E692C62F9@PAXPR06MB7760.eurprd06.prod.outlook.com
2022-10-06 19:10:21 +08:00
Ihor Radchenko 5adde9f3fe
* doc/org-manual.org (Handling Links): Remove incorrect footnote
The timestamps are, in fact, not removed in the link.

Reported-by: Ypo <ypuntot@gmail.com>
Link: https://list.orgmode.org/d7823d10-db69-e52b-8469-4beeb5996915@gmail.com/
2022-10-05 17:53:37 +08:00
Kyle Meyer 42c418693f Merge branch 'km/from-emacs-master' 2022-10-04 18:37:42 -04:00
Kyle Meyer aeb934b598 Merge branch 'km/from-emacs-28' 2022-10-04 18:36:31 -04:00
Stefan Kangas 69ba7a20be Backport commit 2a8d08360 from Emacs
The w3 package was removed from GNU ELPA in 2020 as it doesn't run on
a recent Emacs, and development had stopped over a decade before that.
If anyone wants to revive the w3 package, they should look this all
over, but it doesn't make sense for us to maintain this support code.
Ref: https://debbugs.gnu.org/25395

* lisp/ol.el (org-store-link): Remove w3 support code and related
documentation and comments.  (Bug#56435)
* doc/org-manual.org (Handling Links): Don't mention W3.

Drop support for the dead third-party w3 package
2a8d083607e7e0fe9358f1f6526dbd8aa928af61
Stefan Kangas
Sat Jul 9 17:27:49 2022 +0200
2022-10-04 17:10:50 -04:00
Stefan Kangas de5bdb090d Backport commit 19de241a7 from Emacs
* doc/org-manual.org (Using CDLaTeX to enter math, Footnotes): Recommend
NonGNU ELPA over MELPA.

Recommend NonGNU ELPA over MELPA
19de241a7dc193c0d0423019824627adb28f8944
Stefan Kangas
Fri Sep 16 14:04:27 2022 +0200
2022-10-04 16:27:35 -04:00
Ihor Radchenko 0641ece57b
org-manual: Inline single-sentence footnotes
* doc/Documentation_Standards.org (org-manual.org specific
conventions): Document that we prefer to use inline footnote
definitions when a footnote consists of a single sentence.  This is to
reduce footnote re-numbering in diffs when a new footnote is added to
the manual.
* doc/org-manual.org: Inline single-sentence footnotes.  Renumber the
rest.
2022-10-04 10:18:26 +08:00
Ihor Radchenko 180966c645
org-manual: Do not use #+findex inside Footnote
* doc/org-manual.org (Timestamps):
(Footnotes): Move #+findex entries to the footnote reference.  They do
not work when in Footnote section.
2022-10-04 10:16:47 +08:00
Kyle Meyer b196a05f5a Clean up spacing to pass Emacs's pre-commit check
Avoid trailing spaces and spaces before tabs.
2022-10-03 17:57:03 -04:00
Nicholas Vollmer af6b48e801
doc/org-manual.org fix capture Template elements typo 2022-09-28 12:11:41 +08:00
Ihor Radchenko f99902ecdf
ox-publish: Allow linking to encrypted Org files
* lisp/ox-html.el (org-html-link): Convert .org.gpg file links to
.html, in addition to previously performed .org -> .html convertion.
(org-html-link-org-files-as-html): Update the docstring.
* doc/org-manual.org (Publishing links):
* etc/ORG-NEWS (Publishing now supports links to encrypted Org files):
Document the new feature.
2022-09-25 16:34:12 +08:00
TEC f0ff1df486
manual: Note undocumented tangle hooks
* doc/org-manual.org (Tangle hooks): Note that the pre-tangle and
tangle-body hooks are undocumented.
2022-09-23 20:14:52 +08:00
TEC 5a96768dfa
manual: Document org-babel-tangle-finished-hook
* etc/ORG-NEWS: Mention new hook, `org-babel-tangle-finished-hook'.

* doc/org-manual.org (Tangle hooks): Mention new hook,
`org-babel-tangle-finished-hook'.
2022-09-23 20:14:52 +08:00
TEC ae2140b1e6
org-manual: Fix typo in beamer example
* doc/org-manual.org (Beamer specific syntax): Fix closing keyword of
the beamer export example.
2022-09-22 14:48:37 +08:00
stardiviner 95df82c5fc
org.el: Support subtree-level org-image-actual-width overriding
* lisp/org.el (org-display-inline-image--width): Support new property
"ORG-IMAGE-ACTUAL-WIDTH" overriding global variable
`org-image-actual-width'.
2022-09-21 15:45:30 +08:00
Joost Helberg 3f3ff643d2
org-clock: Make quarter work as parameter for :step in clocktable
Hi,

many years ago a colleague and myself wrote a patch for quarters into
org-mode/clocktable for blocks, today I noticed that :step should allow
'quarter' as an argument too. Here's the tiny patch to allow that.

* doc/org-manual.org (The clock table): Document the new clocktable
option.
* lisp/org-clock.el:
(org-clocktable-steps): Add new 'quarter allowed value.

TINYCHANGE
2022-09-09 21:02:56 +08:00
Sébastien Miquel 72f66ca0b9
New babel syntax to pass src block contents as argument
* lisp/ob-ref.el (org-babel-ref-resolve): Add support for
`named-block[]' syntax, resolving to the contents of a named-block.
* lisp/ob-core.el (org-babel-read-element): Read a code block into its
contents, like other blocks.
* testing/listp/test-ob.el (test-ob/block-content-resolution): Test
block content resolution.
* doc/org-manual.org: Document syntax.
* etc/ORG-NEWS: Document syntax.
2022-08-31 11:31:16 +08:00
Rohit Patnaik b7f4afe86c
lisp/ox-md.el: Add top level header setting
* lisp/ox-md.el (defcustom org-md-toplevel-hlevel): Define the customizable
variable that defines the top level heading to use when exporting to markdown.
(org-export-define-derived-backend): Read the value of the new
`org-md-toplevel-hlevel' variable into the `:options-alist' for this backend
(org-md--build-toc): Use the newly defined top-level heading setting to control
the heading level for the "Table of Contents" text.
(org-md-headline): Use the newly defined top-level heading setting as an offset
to the heading level calculated by `org-export-get-relative-level'.

This patch adds a new setting: `org-md-toplevel-hlevel' that controls which
Markdown heading level is used for top level headings.  This change makes
markdown export more like HTML export, which has a `org-html-toplevel-hlevel'
variable which does the same thing for HTML export.

TINYCHANGE
2022-08-26 21:00:28 +08:00
Ihor Radchenko 5184c4382d
org-export: Make results of named code blocks a valid link target
* lisp/ox.el (org-export-search-cells): Use #+RESULTS keyword as
search cell when #+NAME is not provided.  Update the docstring
accordingly.
(org-export-resolve-fuzzy-link): Update the docstring.

* doc/org-manual.org (Exporting Code Blocks): Document the new
behavior and explain the details of exporting links to named code
blocks/results.

Fixes https://orgmode.org/list/010201826cb68597-bf75d596-7890-4dd0-b9ff-0c7b617b4dd4-000000@eu-west-1.amazonses.com
2022-08-22 19:50:10 +08:00
Ihor Radchenko 1b5ccb1097
org-manual: Document `org-babel-default-inline-header-args'
* doc/org-manual.org (System-wide header arguments): Update the
default value of `org-babel-default-header-args'.  Document that
inline source blocks use a different set of the default arguments.
2022-08-22 19:48:47 +08:00
Max Nikulin 8d93f9b6b4
org-manual.org: Update links to MathJax docs
* doc/org-manual.org (Footnotes): Fix links to particular sections in
MathJax manual.

Scheme is not changed to https: since the site prefers http:

    curl -I https://docs.mathjax.org/
    HTTP/2 302
    date: Sun, 03 Oct 2021 16:04:15 GMT
    location: http://docs.mathjax.org/en/latest/
2022-08-22 10:35:07 +08:00
Duy Nguyen 2cc2d8f1f6
lisp/org-clock.el: Show file title in org-clock clocktable
* lisp/org-clock.el (org-clocktable-defaults): Add default value for
new clock table option `:filetitle'.
(org-clock-get-file-title): Add new function to extract title of org file.
(org-clocktable-write-default): Print org file name in clock table if
`:filetitle' is set to `t'.

* doc/org-manual.org (The clock table): Include new `:filetitle'
option in manual for clock table.

* etc/ORG-NEWS (New =:filetitle= option for clock table): Include new
`:filetitle' option for clock table.

Allow user to show org file title instead of file name in the
clock table.  If the file does not have a title defined, the file name
will be shown in the clock table.

TINYCHANGE
2022-08-20 14:11:39 +08:00
Juan Manuel Macias 243ded74ba
doc/org-manual.org: documentation for `org-latex-language-alist'
* etc/ORG-NEWS: update the news with the new variable.
2022-08-20 13:45:19 +08:00
Ihor Radchenko 45e02e6bc6
* doc/org-manual.org (Formula syntax for Calc): Fix typo
Add missing ")".

Reported in https://orgmode.org/list/60220ee13e35ee2e3956654d6d3ef866@openmail.cc
2022-08-19 13:35:24 +08:00
Bastien b428839f1b doc/org-manual.org: Add note about Emacs compatibility
* doc/org-manual.org (Installation): Add note about Org compatibility
with Emacs versions.
2022-08-12 08:28:52 +02:00
Trevor Ballard 3626f0384a
doc/org-manual.org: Fix typo in "The global TODO list"
* doc/org-manual.org (The global TODO list): Fix typo in manual
section for "The global TODO list".  Change "the" to "that" in the
third sentence to get "By default, this lists items with a state that
is not a DONE state."

TINYCHANGE
2022-08-03 19:30:12 +08:00
András Simonyi 24d2826f04
* doc/org-manual.org: Document "PRINT_BIBLIOGRAPHY" options 2022-07-31 10:25:36 +08:00
Ihor Radchenko eb5622b7ad
* doc/org-manual.org (Footnotes): Fix typo
Reported in https://orgmode.org/list/4F9E0E55-38BD-4210-8294-5A7E1DCACB01@easesoftware.com
2022-07-25 21:46:53 +08:00
Kyle Meyer 5a64429b27 Merge branch 'bugfix'
As mentioned in 2e36ac2ac (Merge single quote fixes from Emacs's
master, 2022-07-24), this merge is keeping Org main's side of
org-babel-lua-read-string and org-agenda-sorting-strategy rather than
the variant introduced in the Emacs repo that's now in bugfix.

Note that for org-agenda-sorting-strategy docstring I think it'd
probably be preferable to change main's

    \\='(time-up category-keep priority-down)

to a bare

    (time-up category-keep priority-down)

but, at least for this merge, I'm sticking to choosing between the
variables that are in one of the sides.
2022-07-24 16:53:32 -04:00
Stefan Kangas 745bdebe73 Backport commit ba0871bef from Emacs
; Fix typos: prefer American spelling
ba0871bef1e7d321f1124a6ad20e9be158a976dd
Stefan Kangas
Wed Jul 13 13:04:22 2022 +0200
2022-07-24 16:22:33 -04:00
Ihor Radchenko b713b9afa1
mk: Add make target "repro" for easy bug testing
* mk/default.mk (REPRO_DEBUG): New custom variable enabling extra
debugging facilities in Emacs instance open by make repro.
(REPRO_ARGS): Extra arguments passed to Emacs by make repro.
(REPRO_INIT):
(REPRO): Define Emacs cmd for testing.
* mk/targets.mk (.PHONY):
(repro): Add new target.
* doc/org-manual.org (Feedback): Describe the new make target.
2022-07-22 21:35:37 +08:00
Ihor Radchenko 79f0969ccc
* doc/org-manual.org (Using CDLaTeX to enter math): Clarify ' binding
See https://orgmode.org/list/CAJczNmB95tdWgYcb6gP-B4LH5+W0sBMyA+Z38Fh7Sy+ksfpmbw@mail.gmail.com
2022-07-17 16:50:43 +08:00
Ihor Radchenko 2d52741088
orgmanual-org: Mention results export as default for inline src blocks
* doc/org-manual.org (Exporting Code Blocks): Clarify that results are
exported by default for inline source blocks.

The issue has been reported in https://orgmode.org/list/CACJP=3n_8tqzBZ7GhmD+f44NPPTLBy31htxHxRHsELXTeMoy2Q@mail.gmail.com
2022-07-02 12:02:09 +08:00
Stefan Kangas 381a2ae4dd
* doc/org-manual.org (Speeding Up Your Agendas): Fix typos 2022-06-30 15:29:33 +08:00
Stefan Kangas a722f6f8ea
Document org-agenda-ignore-properties in manual
* doc/org-manual.org (Speeding Up Your Agendas): Document
`org-agenda-ignore-properties'.
2022-06-29 17:15:12 +08:00
Stefan Kangas 6dc785288d Backport commit 1f6750b53 from Emacs
Avoid treating number as an enum in the org manual
1f6750b53a872a5747dff92b8f61cfede0c5a6a6
Stefan Kangas
Fri Jun 24 19:18:50 2022 +0200

[km] This same change was sent to the Org list and applied to main in
     db3870bfc.
2022-06-26 22:53:26 -04:00
Stefan Kangas 13d97ee18c
Prefer "website" to "homepage"
Emacs now advises using "website" (instead of "homepage") and
consequently to use the "URL" comment header instead of "Homepage".

* README:
* README_ELPA:
* doc/org-guide.org (Creating Footnotes):
* doc/org-manual.org (Creating Footnotes):
* etc/styles/README (URL): Prefer "website" to "homepage".

* lisp/*.el:
* mk/org-fixup.el: Replace the "Homepage" header comment with "URL".
2022-06-26 10:10:48 +08:00
Stefan Kangas db3870bfc0
Avoid treating a number as an enum in manual
* doc/org-manual.org (The Agenda Dispatcher): Avoid treating
number as enum.  The previous formatting contained "1." list at
the beginning of line.
2022-06-25 13:43:06 +08:00
Daniel Fleischer 4a0d951c64 ox-latex tabbing environment support
* lisp/ox-latex.el: New `org-latex--align-string-tabbing',
`org-table--org-tabbing' functions.  Modified `org-latex-table-cell' to
use optional tabbing delimiters.

* etc/ORG-NEWS: support in ox-latex for tabbing environment.

* doc/org-manual.org: mention support for new environment.

Created-by: Bob Vergauwen <emacs@vergauwen.me>
2022-06-21 07:34:21 +03:00
Kyle Meyer 4f454b18e4 Merge branch 'bugfix' 2022-06-19 16:32:55 -04:00
Stefan Kangas 02a22d6fad Backport commit 9a4862a97 from Emacs
doc/misc/org.org: Remove spurious markup.
9a4862a9738c2abab8fb4fb2e4e57b69dea679d7
Stefan Kangas
Wed Jun 8 13:16:32 2022 +0200
2022-06-19 16:29:01 -04:00
Ihor Radchenko 41b7410a8c
doc/Makefile: Limit memory consumption when generating docs
* doc/Makefile: Do not disable garbage collection completely (as it
was after 3684c7967) when generating docs.  Use no too large 50Mb
`gc-cons-threshold' instead.

See
https://yhetil.org/emacs-devel/9778F176-E724-4E61-B0FB-327BCDD316C0@acm.org
for the testing behind the 50Mb constant.
2022-06-17 13:18:39 +08:00
Ihor Radchenko 65e92c4383
doc/org-manual.org: Fix un-escaped macro
* doc/org-manual.org (Key bindings in Texinfo export): Escape macro
definition inside example block.
2022-06-16 20:26:32 +08:00
Ihor Radchenko 0cc4f492fe
org-manual: Fix example block with unsupported language name parameter
* doc/org-manual.org (Breaking Down Tasks into Subtasks): Remove
unsupported LANG parameter from #+begin_example LANG.
2022-06-16 20:24:36 +08:00
Ihor Radchenko 3684c79672
doc/Makefile: Disable GC during export
* doc/Makefile (org.texi):
(orgguide.texi): Set `gc-cons-threshold` to `most-positive=fixnum' and
thus disable garbage collection while exporting manuals.  This reduces
the manual generation time.
2022-06-16 08:32:24 +08:00
Ryan Scott 226119124d
ob-core.el/babel: Special handling for attachment links in src block
* ob-core.el (org-babel-merge-params): Specifying the symbol 'attach`
or string "'attach" as the value of the `:dir' header now functions as
":dir (org-attach-dir nil t) :mkdirp t".
(org-babel-result-to-file): Optional TYPE argument accepts symbol
'attachment to fixup up paths under `(org-attach-dir)' and use the
link type "attachment:" when that is detected.
(org-babel-insert-result): Pass symbol `attachment' as TYPE to
`org-babel-result-to-file'.
* org-attach.el (org-attach-dir): Added autoload header to simplify
dependencies necessary to support this feature (called in
`org-babel-merge-params').
* test-ob.el (test-ob-core/dir-attach): Added unit test for the new
attach feature.
2022-06-14 21:44:25 +08:00
Robert Pluim a8b32247d9
doc/org-manual.org: Reference org-cyclic and org-block
* doc/org-manual.org (Footnotes): Add `org-cyclic' and `org-block' to
note about org diary functions.  Add function indices for `org-date',
`org-anniversary', `org-cyclic', and `org-block'.
2022-06-11 12:48:48 +08:00
Daniel Fleischer 1105da80a7 doc/org-manual.org: variable rename
* doc/org-manual.org: (invisible edits) org-fold-catch-invisible-edits

Suggested-by: Yury Kholodkov <marleng@disroot.org>
2022-06-06 09:34:30 +03:00
Matt Lundin 292116b627
manual: Fix function name and key index reference
* doc/org-manual.org: Change name to `org-cycle-force-archived` to
avoid obsolete name and fix key index reference.
2022-05-26 12:36:58 +08:00
TEC 2cb62c0798
news and manual: Mention ox-latex's engraved code
* etc/ORG-NEWS: Mention the addition of the "engraved" source block
transcoding backend.

* doc/org-manual.org (Footnotes, LaTeX specific properties, Source
blocks in LaTeX export): Basic documentation on the "engraved" source
block transcoding backend.
2022-05-13 00:43:18 +08:00
TEC b4e4b3c502
ox-latex: Replace `org-latex-listings'
* lisp/ox-latex.el (org-latex-src-block, org-latex-keyword,
org-latex-inline-src-block, org-latex-template,
org-latex--caption/label-string, org-latex-engraved-preamble,
org-latex-listings): Replace `org-latex-listings' with
`org-latex-src-block-backend', which now can be set to listings/verbatim
and no longer advertises t/nil as valid values.

* lisp/ox-beamer.el (org-beamer-template): Update in the same manner as
`org-latex-template'.

* lisp/org-compat.el: Make `org-latex-listings' an obsolete alias for
`org-latex-src-block-backend'.

* testing/lisp/test-ox.el: Replace `org-latex-listings' reference with
`org-latex-src-block-backend'.

* doc/org-manual.org (Footnotes, LaTeX specific properties, Literal
Examples): Replace references to `org-latex-listings' with
`org-latex-src-block-backend'.

* etc/ORG-NEWS: Add a news entry noting this change.

The variable `org-latex-listings' originally indicated whether source
blocks should use the listings LaTeX package, or not.  This usage has
evolved over the years, and now it sets one of four different
fontification backends.  This renaming should make the variable name a
bit less misleading.
2022-05-13 00:43:17 +08:00
Ihor Radchenko dba46b7bc0
* doc/org-manual.org (Tracking your habits): Fix module tag habits -> habit
Reported in https://orgmode.org/list/4971b4a8-4519-ac09-a2e1-49a910e27601@fiander.info
2022-05-01 11:06:05 +08:00
Sébastien Miquel 2063596b90
ob-core.el: Add `:noweb-prefix` babel header argument
* lisp/ob-core.el (org-babel-expand-noweb-references): Add support for
`noweb-prefix' header argument, to not repeat the prefix characters
when expanding a noweb reference.
(org-babel-common-header-args-w-values):
(org-babel-safe-header-args): Add `noweb-prefix' value.
* doc/org-manual.org: Document `noweb-prefix' babel header argument.
* etc/ORG-NEWS: Document `:noweb-prefix'.
2022-04-30 16:13:55 +08:00
Nick Dokos e359b01a63
doc/org-manual.org: Fix clocktable dynamic block examples 2022-04-27 16:52:57 +08:00
Ihor Radchenko a8f4270ac1
org-manual: Update to new org-fold function names 2022-04-25 19:40:02 +08:00
Cody Harris a0755ebccf
doc/org-manual.org: Fix a typo in the manual
Also automatically fix up a few lines of indentation that had mixed
tabs and spaces.

TINYCHANGE
2022-04-15 17:09:04 +08:00
Bastien db53a3bad9 Merge branch 'bugfix' 2022-03-28 14:30:39 +02:00
Bastien c70ca5e24e doc/org-manual.org: Fix typo
* doc/org-manual.org (Repeated tasks): Fix typo.

Reported-by: Johnson <j3soon@gapp.nthu.edu.tw>
2022-03-28 14:29:33 +02:00
Bastien b944fecdfc doc/org-manual.org: Minor rewording
* doc/org-manual.org (Summary): Minor rewording.

Relying on http://atomized.org/blog/2018/09/19/what-even-is-org-mode/
as a source of inspiration.
2022-03-28 12:01:53 +02:00
Juan Manuel Macias 1291e89d2d ox-latex: Add a `t' value for `:float' in tables and figures
* org-latex--inline-image: default `figure' environment
* org-latex--decorate-table: default table environment
* doc/org-manual.org (Tables in LaTeX export): add `t' and arbitrary
`:float' values
* doc/org-manual.org (Images in LaTeX export): add `t' and arbitrary
`:float' values
2022-02-22 20:10:58 +01:00
Jonas Bernoulli 98588ebfe1 ox-texinfo: Allow enabling compact syntax for @itemx per file
* doc/org-manual.org (Plain lists in Texinfo export): Document the
:texinfo-compact-itemx export option and variable
org-texinfo-compact-itemx.
(Texinfo specific properties): Mention new export option and variable.
* lisp/ox-texinfo.el: Add org-texinfo-compact-itemx to the
:options-alist of the texinfo backend.
* lisp/ox-texinfo.el (org-texinfo-compact-itemx): New option.
* lisp/ox-texinfo.el (org-texinfo--massage-key-item): Add INFO
argument and use the :texinfo-compact-itemx export option.
* lisp/ox-texinfo.el (org-texinfo-item): Use the
:texinfo-compact-itemx export option.
2022-02-09 00:38:23 +01:00
Jonas Bernoulli 1312e1a938 ox-texinfo: Define definition commands using description lists
* doc/org-manual.org (Plain lists in Texinfo export): Document use
of definition command prefixes in description lists.
* lisp/ox-texinfo.el: Add org-texinfo--separate-definitions to the
list of :filter-parse-tree functions of the texinfo backend.
* lisp/ox-texinfo.el (org-texinfo--definition-command-alist)
(org-texinfo--definition-command-regexp): New variables.
* lisp/ox-texinfo.el (org-texinfo--separate-definitions)
(org-texinfo--match-definition, org-texinfo--split-definition)
(org-texinfo--split-plain-list, org-texinfo--massage-key-item):
New functions.
2022-02-09 00:35:59 +01:00
Jonas Bernoulli e52743fb30 ox-texinfo: Optionally use @itemx for certain description list items
* doc/org-manual.org (Plain lists in Texinfo export): Reorder and
document new functionality.
* lisp/ox-texinfo.el (org-texinfo-item): In a description list when
its :compact attribute is non-nil, then transcode consecutive items
using one @item and one or more @itemx commands, if all of them
except for the last one lack content.
2022-02-08 22:45:36 +01:00
Jonas Bernoulli 3d0f592de7 ox-texinfo: Add function for use by kbd macro
* doc/doc-setup.org: Use org-texinfo-kbd-macro for kbd macro.
* doc/org-manual.org: Add new node "Key bindings in Texinfo export".
* lisp/ox-texinfo.el (org-texinfo--quoted-keys-regexp): New variable.
* lisp/ox-texinfo.el (org-texinfo-kbd-macro): New function.
2022-02-08 22:45:27 +01:00
Samim Pezeshki 22e6ed6b89 agenda: Add header to agenda clock report table
* lisp/org-agenda.el (org-agenda-list): Add header to agenda clock
report table.

TINYCHANGE
2022-01-26 21:07:49 +01:00
Kyle Meyer aae2ac3a68 Merge branch 'bugfix' 2022-01-01 15:21:37 -05:00
Kyle Meyer 5a229cbc44 Update copyright year to 2022 2022-01-01 15:17:08 -05:00
Marco Wahl be03334a7e Merge branch 'bugfix' into main 2021-12-21 12:13:46 +01:00
Marco Wahl b6c5f028a0 Fix parallel make of docs
* doc/Makefile: Split multiple target "org.texi orgguide.texi".
* mk/org-fixup.el (org-make-manual, org-make-guide):  New functions.
  (org-make-manuals): Make obsolete.

Reported by Ulrich Müller.  https://list.orgmode.org/uee67gr96@gentoo.org/
2021-12-21 12:12:21 +01:00
Kyle Meyer 8ca254696b Merge branch 'bugfix' 2021-12-02 20:43:14 -05:00
Kyle Meyer 0acd2fed20 manual: Rename nodes to silence Emacs name check
* doc/org-manual.org (Advanced Export Configuration):
(Extracting Source Code): Rename "Hooks" subheading so that ox-texinfo
does not make it unique by appending " (N)".

The Emacs repo has a check for problematic characters in info nodes
that flagged "Hooks (2)" (bug#52126).  As mentioned in that thread,
this case is actually probably not problematic because the name
doesn't _start_ with "(".  However, it's easy enough to sidestep the
warning, and adding the extra context doesn't hurt.
2021-12-02 20:40:58 -05:00
Ihor Radchenko d8293676c3
Merge branch 'bugfix' 2021-11-23 21:51:46 +08:00
Ihor Radchenko ce0f5c3beb
org-manual.org: Clarify how to handle markup ambiguity
* doc/org-manual.org (Emphasis and Monospace): Advice users to insert
zero width space to force Org ignore emphasis markers.
2021-11-23 21:41:11 +08:00
TEC b21d11c614
Document new :tangle-mode forms
* etc/ORG-NEWS: Mention new forms that :tangle-mode accepts.

* doc/org-manual.org (Header arguments): Mention new forms that
:tangle-mode accepts.
2021-11-21 03:06:20 +08:00
Kyle Meyer af40fa9ae7 Merge branch 'bugfix' 2021-11-20 13:22:37 -05:00
Stefan Kangas c5d6656328 Backport commit 42d4e24ff from Emacs
; Fix typos
42d4e24ff3f13ccbd401d93d70ecdee99b88a26d
Stefan Kangas
Fri Nov 12 13:59:58 2021 +0100
2021-11-20 13:03:45 -05:00
Bruce D'Arcus 30dbfc6cf1
org-manual: minor org-cite additions
* doc/org-manual.org (Handling citations): Add note and example to load
a processor package, and on the PRINT_BIBLIOGRAPHY keyword.
2021-11-18 16:07:07 +08:00
Juan Manuel Macías 85998490d9 ox-latex: add `options' latex attribute to tables
* lisp/ox-latex.el (org-latex--org-table): The `:options' LaTeX
attribute allows adding an optional argument (`\begin{env}[opt]'),
since certain tabular environments, such as `longtblr', accept optional
arguments.
* doc/org-manual.org (Tables in LaTeX export): this feature in the manual.
* etc/ORG-NEWS (New :options attribute when exporting tables to
LaTeX): this feature in `ORG-NEWS'.
2021-11-06 14:50:27 +01:00
Kyle Meyer 0a21425c84 Merge branch 'bugfix' 2021-11-01 20:52:23 -04:00
Hanno Perrey e7085eaa57 Backport commit f1c928637 from Emacs
* doc/org-manual.org (Templates in contexts): Add missing parenthesis to
code example for org-capture template contexts as documented in
docstring.

; * doc/misc/org.org: fix capture context example
f1c9286376d570e898d349200412021fd67e13d2
Hanno Perrey
Sun Oct 31 16:23:41 2021 +0100
2021-11-01 20:46:17 -04:00
Marco Wahl 7810804222 Merge branch 'bugfix' into main 2021-10-18 15:13:27 +02:00
Marco Wahl 37791bb4fc org-manual: Fix one kindex entry
Reminder: the kindex can be accessed via key "i" in info.  This fixes
also the pdf generation.
2021-10-18 15:09:58 +02:00
Nicolas Goaziou 08e9d34907 Merge branch 'bugfix' 2021-10-08 22:42:49 +02:00
Nicolas Goaziou f7fb7a3cf2 manual: Additional fixes to citations
* doc/org-manual.org (Citations): Mention binding for
`org-cite-insert'.  Fix spacing using non-breaking spaces.  Revert
some code uses introduced in the previous commit.
2021-10-08 22:40:23 +02:00
Nicolas Goaziou b06c6c7e78 org-manual: Typography fixes
* doc/org-manual.org (Citation export processors): Use fixed-with
areas for single-line examples.  Upcase keywords.  External commands
or symbols use code instead of verbatim.  Remove indentation when
appropriate.
2021-10-08 22:36:59 +02:00
Nicolas Goaziou 002a07b391 org-manual: Typography fixes
* doc/org-manual.org (Citation export processors): Use fixed-with
areas for single-line examples.  Upcase keywords.  External commands
or symbols use code instead of verbatim.  Remove indentation when
appropriate.
2021-10-08 22:23:33 +02:00
Nicolas Goaziou 1b56c2842d Merge branch 'bugfix' 2021-10-06 14:29:54 +02:00
Kyle Meyer 6874af8724 manual: Drop keybinding for org-table-blank-field
* doc/org-manual.org (Re-aligning and field motion): Update for
keybinding removal.

The keybinding was removed in 0c4e844c8 (Remove default binding for
org-table-blank-field, 2021-04-28).
2021-10-05 23:17:18 -04:00
Kyle Meyer 06578d7450 Merge branch 'bugfix' 2021-10-02 13:48:07 -04:00
Kyle Meyer e8b1aedff2 doc/doc-setup.org: Absorb header from Emacs repo
In the Emacs repository, this file's header was updated in include
copyright information in b3d310fa96 (Fixes for doc/misc org source
files, 2021-02-26).  Copy it over.
2021-10-02 13:35:46 -04:00
Bastien a46cf533fa Revert "org-manual.org: Another way to run version from git"
This reverts commit aaa184f766.
2021-10-02 19:20:39 +02:00
Max Nikulin aaa184f766 org-manual.org: Another way to run version from git
* doc/org-manual.org (Using Org's git repository): Suggest '-L' command
line option to test git version without modification of init file.
2021-10-02 19:17:15 +02:00
Max Nikulin 50e6ccff3a org-manual.org: Mention org-contrib NonGNU ELPA package
* doc/org-manual.org (Installing Org's contributed packages): Add a link
to the NonGNU ELPA package as an option to install org-contrib.  Mention
the list of external packages on Worg.
2021-10-02 19:17:14 +02:00
Max Nikulin 749368f4f0 org-manual.el: Restore `load-path' for git version
* doc/org-manual.org (Using Org's git repository): Add example of
`load-path' adjustment that was earlier in the previous section
and was removed by commit f9cdda8234, so 'above' became a dangling
reference.
2021-10-02 19:17:12 +02:00
Bastien 73875939a8 doc/Makefile: Also make orgguide.html 2021-09-29 15:06:08 +02:00
Bastien 33799db8c2 doc/org-manual.org: End sentences with two spaces, fix indentation 2021-09-29 13:04:10 +02:00
Juan Manuel Macías 6dcddb1b6f doc/org-manual.org: Fix Shakespeare's sonnet
* doc/org-manual.org (Verse blocks in LaTeX export): The previous
version of Shakespeare's sonnet is replaced by the version included in
Wikipedia (Shakespeare, William. Duncan-Jones, Katherine. Shakespeare’s
Sonnets. Bloomsbury Arden 2010. p. 113).
* etc/ORG-NEWS (Support verse blocks in LaTeX export): The last
sentence is superfluous.  There is no explanation below.
2021-09-29 13:00:24 +02:00
András Simonyi 158332224d doc/org-manual.org: Remove a couple of stray words
* doc/org-manual.org (Citation handling): Remove a pair of unnecessary words.
2021-09-29 08:55:58 +02:00
Kyle Meyer d4105060d2 orgcard.tex: Use en-dash for copyright years
This matches what's in the Emacs tree (and generated automatically by
admin/update-copyright).
2021-09-29 00:15:06 -04:00
Bruce D'Arcus 3b4ab1c3e4 doc/org-manual.org (Citations): Enhance
* doc/org-manual.org (Citations): Enhance.

This is based on a preliminary draft provided by Emmanuel Charpentier.
2021-09-28 06:59:20 +02:00
Max Nikulin 09dc3fa304 org-protocol.el: decode "+" in query part as space
* lisp/org-protocol.el (org-protocol-convert-query-to-plist):
Replace "+" chars by spaces before passing parameter string
to decoder.  Allow making org-protocol URIs with help of URLSearchParams
JavaScript class.
* lisp/org-protocol.el doc/org-manual.org etc/ORG-NEWS: Add examples
demonstrating new opportunity for browser bookmarklets.

Make parsing of URI parameters a bit closer to URL standard
https://url.spec.whatwg.org/#urlencoded-parsing
2021-09-27 17:50:49 +02:00
Bastien 4594423811 doc/org-manual.org: Fix typo
* doc/org-manual.org (Citation handling): Fix typo.
2021-09-27 14:32:52 +02:00
Bastien 177745e4c9 doc/org-manual.org (Citations handling): New section
* doc/org-manual.org (Citations handling): New section.
2021-09-27 12:15:43 +02:00
Bastien 2db02f9931 Merge branch 'bugfix' 2021-09-27 12:02:40 +02:00
Bastien 529a1bd829 doc/org-manual.org: Reintroduce lost footnote definition.
* doc/org-manual.org (Footnotes): Reintroduce lost footnote
definition.

Reported-by: Tim Landscheidt <tim@tim-landscheidt.de>
<https://list.orgmode.org/877dhx2qzj.fsf@vagabond.tim-landscheidt.de/>
2021-09-27 12:01:07 +02:00
Daniel Fleischer 7d67719d68 org-manual: comment about latex code-block export
* doc/org-manual.org: when using the latex Minted package, one needs to
set the '-shell-escape' flag in 'org-latex-pdf-process'.

Signed-off-by: Daniel Fleischer <danflscr@gmail.com>
2021-09-27 11:59:33 +02:00
Thomas S. Dye 45a5f17add org-manual.org: Augment TODO keywords example 2021-09-25 15:57:47 +02:00
Bastien e64d5bcc61 Merge branch 'bugfix' 2021-09-25 15:18:38 +02:00
TEC 4a11766cac docs: Update outdated code.orgmode.org links
* CONTRIBUTE, docs/org-manual.org, docs/ORG-NEWS: Replace mentions
of https://code.orgmode.org with references to the new repository
on Savannah (https://git.savannah.gnu.org).
2021-09-25 15:13:25 +02:00
Marco Wahl 4271f228db org-manual: Undo the last change in Shakespeare's verse
See commit 215d80d02b.
2021-09-20 12:09:31 +02:00
William Denton d700c036ba
org-manual: Add referring to tables in other files
* doc/org-manual.org (Passing arguments): Note
the other-file.org:example-table syntax.

TINYCHANGE
2021-09-19 21:35:36 +08:00
Daniel Fleischer 6600dc096d
org-manual: added section about regexps
* doc/org-manual.org: Inform users than regexps in Org are Elisp regular
expressions, so we add a short section linking to the relevant info node
and put some links to this new section in places where regexp are
presented.

Signed-off-by: Daniel Fleischer <danflscr@gmail.com>
2021-09-17 18:14:32 +08:00
Stefan Kangas 215d80d02b
Fix a small number of typos 2021-09-17 17:01:57 +08:00
Bastien 72af213be8 Merge branch 'maint' 2021-09-12 18:07:13 +02:00
Bastien 4be129f543 doc/Makefile: Clean up *.info files too
Continue 9802877fb by cleaning up *.info files and removing
duplicate *.html pattern.
2021-09-12 18:05:37 +02:00
Marco Wahl b4e575ee87 org-manual/guide: use function quotes for hooks and key-bindings 2021-08-31 23:04:49 +02:00
Yasushi SHOJI ebba483cf9
org-manual: Document the option 'none' for :results handling
The commit d4b739fbf2 added the "none" header argument but didn't
add it to the manual.  Document it in the manual so that users can
discover it.

Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
2021-08-31 21:40:51 +08:00
Yasushi SHOJI 3b79fe1c00
org-manual: Move the default result handing at the top
`replace` is the default option for the :results header option for the
source blocks.  Move it to the top of the list.

Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
2021-08-31 21:40:50 +08:00
Jorge P. de Morais Neto 09cf4a075e manual: Improve organisation of a section.
* doc/org-manual.org (Tracking TODO state changes): Move sentence.

The sentence was misplaced, interrupting the train of thought.  I also
did not understand the need for disabling paragraph indentation, so I
removed the directive.
2021-08-11 22:45:47 +02:00
Greg Minshall c34aae1d6b doc/Makefile: `cleanall` target now deletes doc/{org,orgguide}.texi
* doc/Makefile: `cleanall` target now deletes doc/{org,orgguide}.texi

In the past, at least one of these seems to have been a tracked
(source?) file.  That is no longer the case.
2021-05-29 22:36:08 +02:00
Juan Manuel Macias f4aac6090d ox-latex: add LaTeX attributes to quote block
* doc/org-manual.org (Quote blocks in LaTeX export): manual updated
* etc/ORG-NEWS (Support quote blocks in LaTeX export): news updated
* lisp/ox-latex.el (latex): add `org-latex-default-quote-environment' to `:options-alist'
(org-latex-default-quote-environment): the default quote environment
is `quote'
(org-latex-quote-block): add two attributes: `environment' and `options'
2021-05-29 22:21:59 +02:00
Nicolas Goaziou 846801e82c manual: More capitalization
* doc/org-manual.org (Verse blocks in LaTeX export): This is
a follow-up to last commit.
2021-05-20 15:57:16 +02:00
Nicolas Goaziou 7ca7d8dd18 manual: Fix capitalization of "ATTR_LATEX"
* doc/org-manual.org (Verse blocks in LaTeX export): Do not use fancy
"ATTR_LaTeX" syntax.  Preferred syntax in Org Documents is
"attr_latex", but it is capitalized here for emphasis.
2021-05-20 15:53:29 +02:00
Bastien 4362b93018 Merge branch 'maint' 2021-05-16 10:36:42 +02:00
Bastien 9802877fbe doc/Makefile: Use the .info extension for org.info and orgguide.info
* doc/Makefile (install): Use the .info extension when generating
info files (org.info and orgguide.info).
2021-05-16 10:36:02 +02:00
Juan Manuel Macías 91373e15c8 ox-latex.el: Support specific attributes for verse block
* lisp/ox-latex.el (org-latex-verse-block): Support verse-specific
attributes.

* doc/org-manual.org (Verse blocks in LaTeX export): New section.

Link: https://orgmode.org/list/874kfdn0k5.fsf@posteo.net/
2021-05-15 16:13:49 +02:00
Adam Spiers 33027f992d New command `org-refile-reverse' bound to C-c C-M-w
* lisp/org-refile.el (org-refile-reverse): New command.

* lisp/org-keys.el (org-mode-map): Bind C-c C-M-w to
`org-refile-reverse'.

* doc/org-manual.org (Refile and Copy): Document
`org-refile-reverse'.

* etc/ORG-NEWS (New command ~org-refile-reverse~ (=C-c C-M-w=)):
Announce the new command.

Link: https://orgmode.org/list/20200830001047.21362-1-orgmode@adamspiers.org/
2021-05-15 16:13:49 +02:00
Bastien 97d9460945 Merge branch 'maint' 2021-05-07 07:18:16 +02:00
Bastien 4d26075039 doc/org-manual.org (Features Overview): Fix typo
* doc/org-manual.org (Features Overview): Fix typo.

Reported-by: Ian Nehera <delta29@shaw.ca>
2021-05-07 07:17:48 +02:00
Bastien bee8e3adf8 Merge branch 'maint' 2021-05-06 12:13:04 +02:00
Bastien 15200c25d5 doc/org-manual.org: Small rephrasing
* doc/org-manual.org (Features Overview): Small rephrasing.

Reported-by: Ian Nehera <delta29@shaw.ca>
Link: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=47738
2021-05-06 12:10:25 +02:00
Bastien 4b553e5d70 doc/org-manual.org (List of Contributions): Add Timothy E Chapman
* doc/org-manual.org (List of Contributions): Add Timothy E Chapman.
2021-05-05 13:56:05 +02:00
Bastien 7c0c9a2b88 doc/org-manual.org: Add Kyle Meyer and Ihor Radchenko
* doc/org-manual.org (List of Contributions): Add Kyle Meyer and
Ihor Radchenko.
2021-05-05 09:40:11 +02:00
Bastien d48276b894 Replace `org-speed-commands-user' by `org-speed-commands'
* etc/ORG-NEWS: Announce `org-speed-commands'.

* doc/org-manual.org (Speed Keys): Document `org-speed-commands'
instead of `org-speed-commands-user'.

* lisp/org-compat.el (org-speed-commands-user): Make an obsolete
variable.

* lisp/org-keys.el (org-speed-commands-user): Remove.
(org-speed-commands): Rename from `org-speed-commands-default' and
make a defcustom.  Add the docstring of `org-speed-commands-user'.
(org-speed-command-help): Throw a message about obsolete option
`org-speed-commands-user' when set in the user configuration.
(org-speed-command-activate): Update docstring.

Link: https://orgmode.org/list/87eeep3c1u.fsf@bzg.fr/
2021-05-03 16:30:04 +02:00
Eric S Fraga 479a3da22e org-manual.org: describe external reference for :var header
* org-manual.org: the description of the :var header argument for
working with source code has been expanded to mention the possibility
of having an external reference, a reference to an element in another
file.
2021-05-03 15:00:14 +02:00
Bastien 678cb68f78 doc/*: Update references to the old contrib/ directory
* doc/org-manual.org (Installing Org's contributed packages)
(Feedback, External Links, TODO dependencies)
(Capturing column view, Exporting, Add-on Packages)
(List of Contributions, Footnotes): Update references to the old
contrib/ directory.

* doc/org-guide.org (Installation): Ditto.
2021-05-03 13:12:36 +02:00
Gustavo Barros e8562a3327 date/time prompt: Provide support for HHhMM time input
* lisp/org.el (org-read-date-analyze): Add support for HHhMM time
input, in similar way as for am/pm times.
* doc/org-manual.org (The date/time prompt): Add example to illustrate
the feature.

TINYCHANGE
2021-05-01 17:40:17 +02:00
Bastien Guerry 611e806ef9 doc/org-manual.org: Document the new property :refile-targets
* doc/org-manual.org (Template elements): Document the new
property :refile-targets.
2021-05-01 13:12:44 +02:00
Bastien Guerry f9cdda8234 doc/org-manual.org: Deprecate installation thru Org ELPA or archives
* doc/org-manual.org (Installation): Do not document installation
through Org ELPA or an archive as these installation methods will
become obsolete after Org 9.5.
2021-04-28 09:40:01 +02:00
Cheong Yiu Fung bd267679c6 manual: Add hints for visible-only export
* doc/org-manual.org (The Export Dispatcher): Add a reference to
sparse trees, which may come handy when exporting only visible part of
the buffer.
2021-04-27 22:29:58 +02:00
Bastien Guerry 31d48755bf Merge branch 'maint' 2021-04-27 09:43:11 +02:00
Bastien Guerry 13a1a4fb96 Be more consistent about treating tags as case-sensitive
* lisp/org-agenda.el (org-agenda-finalize):
(org-agenda-format-item): Do not downcase tags.
(org-downcase-keep-props): Remove unused function.
(org-agenda-filter-expand-tags): Do not case-fold search.

* lisp/org.el (org-tags-expand): Document `downcased' argument as
obsolete and do not allow to expand downcased tags.

* testing/lisp/test-org.el (test-org/tags-expand): Remove test for
downcased tags expansion.

* doc/org-manual.org (TODO keywords, tags, properties, etc.):
Suggest that user-defined are usually lowercase, but don't make it
a requirement.

Reported-by: David Masterson <dsmasterson92630@outlook.com>
Link: https://orgmode.org/list/SJ0PR03MB5455D8D0C4F71AA495A9ABF79B709@SJ0PR03MB5455.namprd03.prod.outlook.com/
2021-04-27 09:41:26 +02:00
Kyle Meyer c93066d8e2 Merge branch 'maint' 2021-04-26 23:01:06 -04:00
Kyle Meyer 37f291ac08 guide: Fix kbd syntax
* doc/org-guide.org (HTML Export): Fix kdb syntax.
2021-04-26 22:52:16 -04:00
Cheong Yiu Fung 58cacdf0e0 org-manual.org: Fix syntax
* doc/org-manual.org (HTML export commands): Fix kbd representation.

TINYCHANGE
2021-04-26 22:52:06 -04:00
Gustav Wikström 3d52843269 Org-id: Clarify customization documentation for org-id, ts option
* lisp/org-id.el (org-id-ts-format, org-id-method): Clarify docstrings.
* doc/org-manual.org (Handling Links): Mention org-id-method in
the manual.
2021-04-19 22:55:48 +02:00
Nicolas Goaziou edadbb8bab Merge branch 'maint' 2021-04-19 10:09:04 +02:00
Erik Hetzner f6eca6505d manual: Fix publish options
* doc/org-manual.org (Publishing sample configuration):
* doc/org-guide.org (Publishing):
Fix stylesheet setting in publish: :style is not a valid option; use
:html-head instead. :table-of-contents is not a valid option; use
:with-toc instead. :publishing-function is required.
2021-04-19 10:08:37 +02:00
Nicolas Goaziou 949270d4bf Merge branch 'maint' 2021-04-19 01:10:20 +02:00
Nicolas Goaziou 140df469ed manual: Remove date keyword
* doc/org-manual.org: Remove date keyword.

It uses an invalid macro call.  Also, Texinfo export does not support
date keyword anyway.
2021-04-19 01:08:59 +02:00
Nicolas Goaziou e4f4a153df Merge branch 'maint' 2021-04-18 11:56:48 +02:00
Jorge P. de Morais Neto d317d77d8e manual: Fix typo about org-latex-images-centered
* doc/org-manual.org (Images in LaTeX export): Fix typo about
org-latex-images-centered.
2021-04-18 11:56:20 +02:00
Kyle Meyer 4d9dabc36f Merge branch 'maint' 2021-03-29 00:34:15 -04:00