Commit Graph

668 Commits

Author SHA1 Message Date
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