Commit Graph

3431 Commits

Author SHA1 Message Date
Karthik Chikmagalur e87ecf88be
Document preview API for arbitrary link types
* etc/ORG-NEWS: Mention new commands and options for link preview.

* doc/org-manual.org: Add sections on
- previewing external links (Images and link previews), and
- adding the link preview feature to other link types (Adding
Hyperlink preview).
2024-11-27 19:34:34 +01:00
Visuwesh b6a72e134d
Add repeat-mode keymap for navigation commands
* lisp/org-keys.el (org-up-heading): Add new alias for
`outline-up-heading'.
(org-mode-map): Remap `outline-up-heading' to the new alias.
(org-navigation-repeat-map, org-link-navigation-repeat-map)
(org-block-navigation-repeat-map): Add new repeat-maps to make
navigation easier.
* doc/org-manual.org (Repeating commands): Document the new feature in the manual.
* etc/ORG-NEWS (Some navigation commands can now be repeated): Announce it.
2024-10-12 19:39:56 +02:00
Ihor Radchenko 8b8b61d277
Merge branch 'bugfix' 2024-09-22 10:11:45 +02:00
Ihor Radchenko 7cecc2aa2c
doc/org-manual.org (Choosing a working directory): Fix typo
:mkdirp, not :mkdir.

TINYCHANGE
2024-09-17 08:35:40 +02:00
Kyle Meyer 9f29451d86 Merge branch 'km/from-emacs-30' into bugfix 2024-09-14 11:58:26 -04:00
Stefan Kangas 0afa19e8bf Backport commit 4047072c7 from Emacs
* doc/org-manual.org (Link Abbreviations):
Update the FSF address to 31 Milk Street.

Update FSF's address
4047072c7d847afb5027dab27e97606a49c1d62e
Stefan Kangas
Mon Sep 2 21:02:09 2024 +0200
2024-09-14 11:54:29 -04:00
Rudolf Adamkovic 3428b522fb
doc/org-manual.org: Update a deprecated function
* doc/org-manual.org (Global and local cycling):
(Initial visibility): Replace `org-set-startup-visibility' with
`org-cycle-set-startup-visibility' as per "This function is obsolete
since 9.6; use ‘org-cycle-set-startup-visibility’ instead."
2024-08-31 16:39:55 +02:00
Ihor Radchenko d51dc4aa29
org-toggle-inline-images-command: New command for C-c C-x C-v binding
* lisp/org.el (org-toggle-inline-images-command): New command to
toggle images.  Unlike the old `org-toggle-inline-image', it is more
flexible and default to toggling images at point/current entry.
* lisp/org-keys.el (org-mode-map): Bind C-c C-x C-v to the new
command.
* doc/org-manual.org (Images): Update the manual describing the new
command behaviour.
* etc/ORG-NEWS (=C-c C-x C-v= command toggling inline image display
has been reworked): Document the breaking change.

Link: https://list.orgmode.org/6461a84b.a70a0220.b6d36.5d00@mx.google.com/
2024-08-18 12:23:10 +02:00
Ihor Radchenko 66f2f5ce43
Merge branch 'bugfix' 2024-08-10 14:47:52 +02:00
Ihor Radchenko 2f572779e5
doc/org-guide.org (Visibility Cycling): Fix incorrect statement
Fix incorrect assertion that initial visibility is overview.  It is
showeverything.

Reported-by: Matt M <home42@protonmail.com>
Link: https://orgmode.org/list/waxLE927Qoblcy_1hGRBGaOJjKgQ2K7NTFS9wFnEqHuW0BHAZYDkpGndbubOWtvpcJ06R378Mod8GsfA1UnuqLyT9QbQZFM8uaDxKHGPJhc=@protonmail.com
2024-08-04 20:13:04 +02:00
Ihor Radchenko d3d84ff6b9
Merge branch 'bugfix' 2024-07-25 13:22:41 +02:00
Stefan Kangas 23b9316ef9 Backport commit a79966156 from Emacs
Standardize possessive apostrophe usage in manuals, docs, and comments
a79966156633ae1e49e3fef17ff7212c8f35a26f
Stefan Kangas
Thu Jul 25 03:35:18 2024 +0200
2024-07-24 22:19:52 -04:00
Stefan Kangas 7832ebe386 Backport commit 00adee897 from Emacs
; Fix punctuation in docs
00adee897ac95912cb9ad6bd8a8d161db71945ac
Stefan Kangas
Sun Jul 21 17:35:13 2024 +0200
2024-07-21 17:25:20 -04:00
Stefan Kangas a97ea4f0b5 Backport commit a6cab228d from Emacs
; Fix typos
a6cab228d4d1a82a80eac81b057857a230eef0b5
Stefan Kangas
Thu Jul 18 11:46:50 2024 +0200
2024-07-20 15:24:27 -04:00
Ihor Radchenko 058aec0f38
doc/org-manual.org: Avoid using "outline node"
* doc/org-manual.org (Priorities):
(Checkboxes):
(Column View):
(Attachments):
(Attachment defaults and dispatcher):
(Attachment options):
(Attachment links):
(Automatic version-control with Git):
(Change display): Refer to heading or subtree instead of saying
"outline node" that does not make much sense in Org context where
outline syntax is fixed, unlike in `outline-mode'.
2024-07-14 12:13:36 +02:00
Ihor Radchenko 62cf25ae5c
doc/org-manual.org (org-capture): Fix description
* doc/org-manual.org (Using capture): Remove inaccurate reference to
"new Org outline node".  It does not make any sense and appear to
originate from confusingly named override `org-capture-entry'
in `org-capture'.
2024-07-14 12:13:00 +02:00
Hugo Heagren 50e34dde10
ox-beamer: Allow setting frame subtitle with headline property
* lisp/ox-beamer.el (org-beamer--format-frame): Allow a frame subtitle
to be specified in the BEAMER_SUBTITLE property.  If specified, put it
in the second non-optional argument to \begin{frame}.
* doc/org-manual.org (Frames and Blocks in Beamer): Document above
behaviour.
* etc/ORG-NEWS (Beamer export supports setting frame subtitles):
Document the new feature.
2024-07-10 16:00:31 +02:00
Ihor Radchenko 90d4ae92eb
ox: New custom option to disable macro replacement
* lisp/ox.el (org-export-replace-macros): New custom option
controlling macro replacement.
(org-export--annotate-info): Honor it, except when processing inline
code block results and their {{{results...}}} macro.
* etc/ORG-NEWS (Allow disabling macro replacement during export):
Announce the new option.
* doc/org-manual.org (Macro Replacement):
(Summary of the export process): Document the new option.
2024-07-10 15:46:14 +02:00
Ihor Radchenko d6c0bbe280
Merge branch 'bugfix' 2024-06-28 11:42:40 +02:00
Kyle Meyer a091ca9e66 Merge branch 'km/from-emacs-30' into bugfix 2024-06-27 23:14:54 -04:00
Stefan Kangas 5d7218ceff Backport commit c0eefebab from Emacs
; Fix typos
c0eefebabfee011f0ec7631d055e482e4965a24d
Stefan Kangas
Sun Jun 16 22:38:26 2024 +0200
2024-06-27 22:47:14 -04:00
Ihor Radchenko de775a36d9
org-manual: Fix grammar issues identified by LanguageTool
* doc/org-manual.org:
2024-06-23 13:14:40 +02:00
Ihor Radchenko 39272e2165
Merge branch 'bugfix' 2024-06-22 17:59:26 +02:00
Morgan Smith fc0fb90b67
; fix typos
* doc/org-manual.org: Add missing '~'.
* lisp/org-element-ast.el (org-element-deferred): Fix typo in docstring.
* lisp/org-element.el (org-element-archive-tag,
org-element-drawer-re-nogroup, org-element--cache-log-message): Fix
typos in docstring.
(org-element--current-element, org-element--cache-find,
org-element-cache-map): Fix typos in comments.
2024-06-19 17:34:31 +02:00
Nafiz Islam 5265153fc5
org-capture-templates: Allow headline/olp target to be function or symbol
* doc/org-manual.org: Add target spec format for function and symbol
for headline and olp.
* etc/ORG-NEWS: Announce the updated options for
`org-capture-templates'.
* lisp/org-capture.el (org-capture-templates): Update customization
type for `file+headline', `file+olp', and `file+olp+datetree' targets,
and update docstring.
(org-capture-expand-headline): Define a new function that computes
headline string from target spec.
(org-capture-expand-olp): Define a new function that computes olp list
from target spec.
(org-capture-set-target-location): Use `org-capture-expand-headline'
to expand headline, and use `org-capture-expand-olp' to expand outline
path.
* testing/lisp/test-org-capture.el (test-org-capture/entry): Add tests
for at most three different kinds of target for `file+headline',
`file+olp', and `file+olp+datetree'.
(test-org-capture/org-capture-expand-olp): Add tests for
`org-capture-expand-olp'.
2024-06-18 14:33:55 +02:00
Ihor Radchenko 266bd1c4a0
org-capture-templates: New placeholder to refer to %^{prompt}X answers
* lisp/org-capture.el (org-capture-fill-template): Support new
placeholder %\*N to insert answers to all prompts - %^{prompt} and
%^{prompt}X.
(org-capture-templates):
* etc/ORG-NEWS (New =%\*N= placeholder in ~org-capture-templates~):
* doc/org-manual.org (Template expansion): Document the new
placeholder.

Link: https://orgmode.org/list/87le40puvb.fsf@gmail.com
2024-06-06 17:17:38 +02:00
bruno 55e8068d69
ol: Add support for shortdoc link type
* lisp/ol.el (org-link--open-shortdoc org-link--store-shortdoc)
(org-link--complete-shortdoc): Add support for storing and inserting links
to `shortdoc' documentation groups for Emacs Lisp functions.
* doc/org-manual.org (External Links): Add shortdoc link type
documentation.
* etc/ORG-NEWS (=ol.el=: Support for =shortdoc= link type): Document
the new feature.
2024-06-06 13:50:27 +02:00
Kyle Meyer 377addb5b2 Merge branch 'km/from-emacs-master' 2024-05-28 23:01:23 -04:00
Stefan Monnier e8fe9642b0 Backport commit 445f376e4 from Emacs
Revert "ox-texinfo:: Require only TEXINFO_DIR_CATEGORY"
445f376e4e613ebee94d2844926269bfa8793858
Stefan Monnier
Sun Mar 3 22:09:24 2024 -0500
2024-05-28 22:58:43 -04:00
Stefan Monnier 338ff105c5 Backport commit 5254c582e from Emacs
* lisp/ox-texinfo.el: Remove redundant `:group` arguments.
Prefer #' to quote function names.
(org-texinfo-template): Use sane defaults for `@direntry`.

* doc/org.org (Texinfo specific export settings): Adjust accordingly.

ox-texinfo:: Require only TEXINFO_DIR_CATEGORY
5254c582efb3e7171e955dde653e7530d2d3ffef
Stefan Monnier
Sun Mar 3 16:57:56 2024 -0500
2024-05-28 22:58:43 -04:00
Stefan Kangas c49b8f68ca Backport commit 1e270e580 from Emacs
; Grammar fixes ("allow to" et al)
1e270e580d3bb9ca1b3766a296611f76ec13f6f1
Stefan Kangas
Sun Sep 17 16:49:21 2023 +0200
2024-05-28 22:58:43 -04:00
Stefan Kangas 4bd1c59d83 Backport commit c75c79971 from Emacs
* doc/org.org (External Links): Change an HTTPS link back to
HTTP, as it's used as an example to show the supported protocols.
Ref: https://lists.gnu.org/r/emacs-devel/2023-08/msg00018.html

; Fix http/https thinko in org manual
c75c7997197502189023c9f47140474fa7fd719e
Stefan Kangas
Fri Aug 4 09:57:27 2023 +0200
2024-05-28 22:58:43 -04:00
Stefan Kangas d2eba8b77f Backport commit 0910230be from Emacs
; Prefer HTTPS to HTTP in more links
0910230be6ee858d8d8849a1fc9559bfd163dc38
Stefan Kangas
Wed Aug 2 23:32:28 2023 +0200

[km] The http example should remain http.  That's reverted in the next
     commit.
2024-05-28 22:58:43 -04:00
Ihor Radchenko 6799350a85
org-manual: Explain how to handle ; inside formulas
* doc/org-manual.org (Emacs Lisp forms as formulas): Show an example
how to resolve ambiguity when the formula contains ;.

Reported-by: Nick Dokos <ndokos@gmail.com>
Link: https://orgmode.org/list/87ply5v1gj.fsf@localhost
2024-05-21 11:24:39 +02:00
Ihor Radchenko 3f539bc3d6
org-manual: Add better opening description to "Citation handling" section
* doc/org-manual.org (Citation handling): Rewrite the opening
paragraphs describing citations using less technical description.  The
new version aims to ordinary Org mode users and avoids talking about
Elisp libraries.
(Citations): Unify markup for citation processor names (use verbatim).
Mention that at least one #+PRINT_BIBLIOGRAPHY is mandatory to render
output.  Indicate that default citation style is "nil".
2024-05-20 15:24:13 +02:00
Lee Thompson 1a7d7a5a5b
lisp/ox-md.el: New mixed-style option for `org-md-headline-style'
* lisp/ox-md.el (org-md-headline-style): New setting `mixed' allows
for mixing Setext and ATX-style headlines when exporting to Markdown.
* doc/org-manual.org (Header and sectioning structure): Document
`mixed' headline style.
* etc/ORG-NEWS (New allowed value of ~org-md-headline-style~ to mix
ATX and Setext style headlines): Document the new feature.

When exporting to Markdown, there was previously no obvious way of
mixing Setext-style and ATX-style headlines.  Via the
`org-md-headline-style' custom setting, headlines could be exported as
either all-Setext or all-ATX, but not as a mix.

With this change setting `org-md-headline-style' to `'mixed' will
export the first two headline levels as Setext-style Markdown
headlines and the rest as ATX-style.

TINYCHANGE
2024-05-12 14:53:34 +03:00
Ihor Radchenko 4deb06ea0a
org-manual: Clarify what :results drawer does for inline code blocks
* doc/org-manual.org (Format): Move :results raw description up.
Adapt :results drawer description from the docstring of
`org-babel-insert-result', mentioning what it means in inline src
blocks.

Link: https://orgmode.org/list/87v8dfnwcp.fsf@localhost
2024-05-11 10:43:38 +03:00
Ihor Radchenko e380684c1a
doc/org-manual.org (The clock table): Fix too wide table in Texinfo output
* doc/org-manual.org (The clock table):
(Footnotes): Use numbered footnote to avoid too wide table columns.

Reported-by: Morgan Smith <Morgan.J.Smith@outlook.com>
Link: https://orgmode.org/list/CH3PR84MB34245E5ED43AA9A59D38E732C5E52@CH3PR84MB3424.NAMPRD84.PROD.OUTLOOK.COM
2024-05-09 14:07:52 +03:00
Ihor Radchenko 31748e67f0
doc/org-manual.org (Summary of the export process): Fix inaccuracies
* doc/org-manual.org (Summary of the export process): Mention that
some export backends may retain table rows with alignment markers.
Clarify that exporting parent nodes with children uses exported child
text.
2024-05-09 13:55:40 +03:00
Ihor Radchenko 773bba92a8
doc/org-manual.org: Improve example of publishing configuration
* doc/org-manual.org (Example: complex publishing configuration): Show
how to use evaluated expression with backquotes and `rx' macro in the
example.

Link: https://orgmode.org/list/LV8P223MB0920398F1619C446752BB1E1A2E42@LV8P223MB0920.NAMP223.PROD.OUTLOOK.COM
2024-05-07 12:21:46 +03:00
Cook, Malcolm 09520a056c
org-manual: Document command line installation
* doc/org-manual.org (Using Emacs packaging system): Document how to
upgrade Org mode without risking version conflicts.

TINYCHANGE
2024-05-03 15:23:06 +03:00
Ihor Radchenko 5da0eb6ea7
org-element-timestamp-parser: Allow time in diary sexp timestamps
* lisp/org-agenda.el (org-agenda-get-timestamps):
* lisp/org-element.el (org-element--timestamp-regexp): Adjust
timestamp regexp.
(org-element-timestamp-parser): Support the new syntax for diary sexp
timestamps.  The diary sexp is now stored in :diary-sexp property and
the time/time range is stored as usual.
(org-element-timestamp-interpreter): Interpret diary timestamp
according to its building blocks rather than raw value.
* testing/lisp/test-org-agenda.el (test-org-agenda/diary-timestamp):
New test checking for agenda support of times in diary timestamps.
*
testing/lisp/test-org-element.el (test-org-element/timestamp-interpreter):
Add parser tests.
* doc/org-manual.org (Timestamps): Add an example of the new syntax to
the manual.
* etc/ORG-NEWS (Diary type timestamps now support optional
time/timerange): Document the Org syntax addition.

This syntax modification is fixing an omission in org-element.el.  In
the past, org-agenda had explicit support for diary timestamps with
time/timerange, but that support was ad-hoc.  Now, after org-agenda
switched to use parser, we must modify Org syntax to fix the feature
regression.
2024-05-03 13:42:06 +03:00
Alexander Adolf 4e6fa96e26
lisp/org-colview.el: Add link parameter to colview dynamic block
* lisp/org-colview.el (org-columns--capture-view): Add new link
parameter, which when non-nil causes ITEM headlines to be linked to
their origins.
(org-dblock-write:columnview): Pass new link parameter to
`org-columns--capture-view', and explain its use in the docstring.
* testing/lisp/test-org-colview.el (test-org-colview/dblock): Add
new test for link feature.
* doc/org-manual.org (Capturing column view): Describe new :link
parameter.
* etc/ORG-NEWS (=colview= dynamic block can link to headlines):
Describe new link feature.
2024-04-26 15:44:46 +03:00
Alexander Adolf 5a98b4c563
lisp/org-colview.el: Add formatter parameter to colview dynamic block
* lisp/org-colview.el (org-dblock-write:column view): Factor out the
existing formatting code to new function
`org-columns-dblock-write-default', and honour new dblock parameter
:formatter for specifying a different formatting function.
(org-columns-dblock-write-default): New function with current
formatting code.
(org-columns--capture-view): Amend docstring to better explain the
format of the data being passed to the formatting function.
(org-clock-clocktable-formatter): New option to define a global
default formatting function, defaulting to the current behaviour.
* testing/lisp/test-org-colview.el (test-org-colview/dblock): New test
for formatting function.
(test-org-colview/dblock-formatter): New function used in formatting
test.
* doc/org-manual.org (Capturing column view): Describe new :formatter
parameter.
* etc/ORG-NEWS (New option ~org-columns-dblock-formatter~): Announce
new option.
(=colview= dynamic block supports custom formatting function):
Describe new custom formatting function feature.
2024-04-26 15:44:44 +03:00
Pedro A. Aranda f124b616d9
oc-biblatex: Allow native biblatex options in CITE_EXPORT
* lisp/oc-biblatex.el: (org-cite-biblatex--package-options) Add support
for options in the native biblatex package format.
* doc/org-manual.org: Document the added format and add an example.
* etc/ORG-NEWS: Announce new format for #+cite_export biblatex options.
2024-04-26 15:23:29 +03:00
Arash Esbati ff9d00c9c3
doc/org-manual.org: Document `org-emphasize'
* doc/org-manual.org (Emphasis and Monospace): Document the
command `org-emphasize'.

Link: https://lists.gnu.org/archive/html/emacs-orgmode/2024-04/msg00381.html
2024-04-23 14:30:52 +03:00
Ihor Radchenko 52bde22b9d
Merge branch 'bugfix' 2024-04-22 21:10:13 +03:00
Ihor Radchenko a9275d5fd1
doc/org-manual.org: Fix description of switches in literal examples
Fix erroneous assertion that switches are always at the end of "begin"
line.

Reported-by: João Pedro <jpedrodeamorim@gmail.com>
Link: https://orgmode.org/list/87zftm2ltt.fsf@ergo
2024-04-22 21:08:20 +03:00
Ihor Radchenko 5b0b7f2924
org-paste-subtree: With single/double prefix, force inserting sibling/child
* lisp/org.el (org-paste-subtree): When called with single or double
universal argument, force inserting sibling heading or child heading
accordingly.
* testing/lisp/test-org.el (test-org/paste-subtree): Add tests for the
new behavior.
* doc/org-manual.org (Structure Editing): Update the command description.
* etc/ORG-NEWS (~org-paste-subtree~ now handles =C-u= and =C-u C-u=
prefix arguments specially): Announce the change.

Link: https://orgmode.org/list/878rhxtszb.fsf@localhost
2024-04-21 14:59:37 +03:00
Ihor Radchenko 36d0928043
Clarify `org-use-sub-superscripts' and related options
* lisp/org.el (org-use-sub-superscripts): Update the docstring
explaining that (...) is understood as sub/superscript, even when
there are spaces inside.  Add a note that the underlying markup is not
altered.
* lisp/ox.el (org-export-with-sub-superscripts): Link to the
`org-use-sub-superscripts' docstring instead of duplicating the
docstring text.
* doc/org-manual.org (Subscripts and Superscripts): Clarify the
differences between `org-export-with-sub-superscripts' and
`org-use-sub-superscripts'.  Add a note that underlying markup does
not change.

Link: https://orgmode.org/list/87plvproor.fsf@localhost
2024-04-21 12:41:05 +03:00