Commit graph

3166 commits

Author SHA1 Message Date
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
Maxim Nikulin 4de2fff87d Add quotes to emacsclient arguments in examples
* doc/org-manual.org:
* lisp/org-protocol.el: Quote emacsclient arguments
in examples to prevent interpreting of ampersands as intent
to run processes in background by bash and similar shells.
Single quotes may cause a problem with cmd.exe, so use
double quotes despite they are a bit less safe in bash and Co.
2021-03-29 00:32:29 -04:00
Maxim Nikulin a17243f9a5 org-manual.org: Fix typo in org-protocol capture example
* doc/org-manual.org: Use "&" as parameter separator in query part
of example for org-protocol capture URI.
2021-03-29 00:32:29 -04:00
Kyle Meyer 68db6fc064 Merge branch 'maint' 2021-03-25 00:53:11 -04:00
Kyle Meyer 4f98c86b3b manual: Grammar fix
* doc/org-manual.org (Publishing action): Fix conjugation.
2021-03-24 22:24:59 -04:00
Greg Minshall d156399445 Update example :publishing-function names in manual
* doc/org-manual.org (Publishing action): Fix references to
org-latex-publish-to-pdf and org-org-publish-to-org.
2021-03-24 22:24:55 -04:00
Stefan Kangas 2e1c984153 Prefer HTTPS to HTTP in most links 2021-03-21 15:21:22 -04:00
Stefan Kangas 8cc992f7b2 Prefer HTTPS to HTTP for links to gnu.org 2021-03-21 14:29:13 -04:00
Kyle Meyer be35212683 Merge branch 'maint' 2021-03-16 23:52:34 -04:00
Kyle Meyer e07cb2ad3c manual: Fix org-latex-listings reference in footnote
* doc/org-manual.org (Footnotes): Refer to org-latex-listings instead
of org-export-latex-listings.

The last occurrence of org-export-latex-listings was deleted with the
contrib/oldexp/ removal in Org 8.
2021-03-16 23:52:09 -04:00
Stefan Monnier 129c33dddf * lisp/org-agenda.el: Use lexical-binding
- Removed the global (defvar date) and (defvar entry) so as not to
  conflict with function arguments of that name.  Instead I added such
  `defvar`s in the body of each of the functions where it
  seemed needed.
- I added some FIXMEs for some issues I found along the way.
- Added an `org-dlet` macro, just like I had done for `calendar-dlet`,
  but I also use `defvar` "manually" at some places, when splitting an
  existing `let` into a mix of `let`s and `dlet`s seemed too much trouble.
- Removed uses of `org-let and `org-let2` not only because I consider
  them offensive to my sense of aesthetics but also because they're
  basically incompatible with lexical scoping.
  I replaced them with uses of `cl-progv` which are a bit more verbose.
  Maybe we should define some `org-progv` macro on top of `cl-progv` to
  make the code less verbose, but I didn't do that because I like the
  fact that the current code makes uses of `eval` a bit more obvious
  (since these behave differently with lexical scoping than with
  lexical binding, it seemed worthwhile).
- Removed the use of `eval` in `org-store-agenda-views` which was only
  placed there in order to use a macro before it's defined (it would
  have been simpler/cleaner to just move that functions *after* the
  macro, but with the new code the problem doesn't occur any more anyway).
- Replaced a few `(lambda...) with actual closures.

Detailed changes follow:

(date, entry): Don't declare as being globally dynbound.
(org-agenda-format-date-aligned): Remove unused var `weekyear`.
(org-agenda-mode): `run-mode-hooks` is always available nowadays.
(org-agenda-undo): Remove unused var `last-undo-buffer`.
(org-agenda): Rename arg to `keys` and then dyn-bind it as `org-keys`.
Remove unused vars `buf` and `key`.
(org-agenda): Use `pcase` and `cl-progv` instead of `org-let`.
(org-let, org-let2): Mark as obsolete.
(org-agenda-run-series): Use `cl-progv` instead of `org-let` and `org-let2`.
(org-agenda-run-series): New function.
(org--batch-agenda): New function extracted from `org-batch-agenda`.
(org-batch-agenda): Use it.
(org--batch-agenda-csv): New function extracted from `org-batch-agenda-csv`.
(org-batch-agenda-csv): Use it.
(org--batch-store-agenda-views): New function, extracted from
`org-batch-store-agenda-views`.
(org-store-agenda-views, org-batch-store-agenda-views): Use it.
(org--batch-store-agenda-views): Use `cl-progv` instead of
`org-eval-in-environment`.
(org-agenda-write): Use `cl-progv` instead of `org-let`.
Use `with-current-buffer`.
(org-agenda-filter-any): Use `cl-some` instead of `eval`.
(org-agenda-list): Remove unused var `e`.
(org-search-view): η-reduce.
(crm-separator): Declare var.
(org-agenda-skip-if): Remove unused var `beg`.
(org-agenda-list-stuck-projects): Use a closure rather than `(lambda..).
(diary-modify-entry-list-string-function, diary-file-name-prefix)
(diary-display-function): Declare vars.
(org-diary): Declare `date` and `entry` as dynbound.
(org-agenda-get-day-entries): Use `org-dlet`.
(org-agenda-get-timestamps, org-agenda-get-progress)
(org-agenda-get-deadlines, org-agenda-get-scheduled, org-agenda-get-blocks):
Declare `date` as dynbound.
(org-agenda-get-sexps, org-class): Declare `date` and `entry` as dynbound.
(org-agenda-format-item): Declare the vars mentioned in
`org-compile-prefix-format` as dyn-bound.
Also binding `extra`, suggested by Kyle Meyer <kyle@kyleam.com>.
(org-compile-prefix-format): Remove unused var `e`.
Use `member` rather than or+equal.
(org-set-sorting-strategy): Minor simplification.
(org-entries-lessp): Use `org-dlet`.
(org-agenda-redo): Declare var `org-agenda-tag-filter-while-redo`.
(org-agenda-redo): Use `cl-progv` rather than `org-let`.
(org-agenda-filter): Remove unused var `rpl-fn`.
Use `org-pushnew-to-end` to replace `add-to-list` on lexical var.
(org-agenda-filter-by-tag): Remove unused var `n`.
(org-agenda-filter-apply): Use `org-dlet`.
(org-agenda-compute-starting-span): Remove unused var `dg`.
(org-agenda-forward-block): Remove unused var `pos`.
(org-archive-from-agenda): Declare var.
(org-agenda-refile): Remove unused var `pos`.
(org-agenda-headline-snapshot-before-repeat): Declare var.
(org-agenda-todo): Remove redundant use of `bound-and-true-p`.
(org-agenda-add-note): Remove unused var `hdmarker` and unused `arg`.
(org-agenda-change-all-lines): Remove unused var `pl`.
(org-agenda-priority): Remove unused var `marker`.
(org-agenda-set-effort): Remove unused var `newhead`.
(org-agenda-schedule): Remove unused var `type`.
(org-agenda-clock-cancel): Remove unused `arg`.
(org-agenda-execute-calendar-command): Use `org-dlet`.
(org-agenda-bulk-action): Use closures instead of `(lambda ...).
(org-agenda-show-the-flagging-note): Remove unused vars `heading` and
`newhead`.
(org-agenda-remove-flag): Avoid `setq`.

* testing/org-test.el (org--compile-when): New macro.
(org-test-jump): Use it so compilation doesn't fail or generate broken
code when `jump` is not available.

* testing/lisp/test-org-src.el:
* testing/lisp/test-org-attach.el:
* testing/lisp/test-org-agenda.el:
* testing/lisp/test-ob-java.el: Pass explicit filename to `require`
so as not to rely on ".../testing" being in `load-path` during compilation.

* lisp/org-num.el: Require` org`.

* lisp/org-macs.el (org-eval-in-environment): Declare obsolete.
(org-dlet, org-pushnew-to-end): New macros.

* doc/Makefile (org.texi, orgguide.texi, %_letter.tex): Simplify quoting.

* contrib/lisp/ob-sclang.el: Don't crash compilation when `sclang`
is not available.

* contrib/lisp/ob-clojure-literate.el: Don't crash compilation when `cider`
is not available.

* contrib/lisp/ob-arduino.el: Don't crash compilation when `arduino-mode`
is not available.

* .gitignore: Add files generated during `make packages/org`.
2021-03-09 22:56:33 -05:00
Kyle Meyer d726503251 Merge branch 'maint' 2021-03-02 01:14:26 -05:00
Kyle Meyer b712b9618a manual: Add publishing-function to publishing example
* doc/org-manual.org (Example: simple publishing configuration): Add
:publishing-function to org-publish-project-alist.

This appears to have been necessary since 0ccf650b4 (org-e-publish:
Remove default value for publishing function, 2012-10-08).

Reported-by: dalanicolai <dalanicolai@gmail.com>
Ref: https://orgmode.org/list/CACJP=3k2jL1z0d-uALFGoutffFF2o=7-L39zUns6si0KAhZ-_g@mail.gmail.com
2021-03-02 01:13:11 -05:00
Kyle Meyer 8244e7ba85 manual: Fix org-html-publish-to-html reference
* doc/org-manual.org (Publishing action): Fix reference to
org-html-publish-to-html.

Reported-by: dalanicolai <dalanicolai@gmail.com>
Ref: https://orgmode.org/list/CACJP=3k2jL1z0d-uALFGoutffFF2o=7-L39zUns6si0KAhZ-_g@mail.gmail.com
2021-03-02 01:12:48 -05:00
Kyle Meyer e0fb2339f4 Merge branch 'km/from-emacs-master'
Porting from Emacs's master to Org's maint branch has been on hold
leading up to the Emacs 27.2 release to avoid any required fixup syncs
carrying those commits into the emacs-27 branch.  This merge brings
those changes into master.  The km/from-emacs-master branch should be
merged to maint when Emacs 27.2 has been released (assuming Org 9.5
hasn't been released, in which case maint will be tracking 9.5.x and
already include these changes).
2021-02-14 18:06:23 -05:00
Stefan Kangas d8e8a97a14 Backport commit a8caa6690 from Emacs
* doc/org-manual.org (Link Abbreviations):
* lisp/org/ol.el (org-link-shell-confirm-function)
(org-link-elisp-confirm-function):
* lisp/org/org.el (org-highlight-links): Avoid recommending Google.

Avoid recommending Google
a8caa66906b157c9c2b4c4dc1c447b6a9e747c5e
Stefan Kangas
Thu Jan 28 19:36:12 2021 +0100
2021-02-14 17:38:07 -05:00
TEC 5b0eb9aada manual, news: Document org-html-meta-tags
* docs/org-manual.org, etc/ORG-NEWS: Document and announce the new
setting `org-html-meta-tags'.

[km: spacing and spelling tweaks]
2021-02-07 19:37:20 -05:00
Kyle Meyer 72e368a2e9 Merge branch 'maint' 2021-01-24 22:17:01 -05:00
Daniel Gröber aeb9f036ff org-macs: Allow specifying relative time in hours
* lisp/org-macs.el (org-matcher-time): Handle hour ("h") time stamp
modifier.
* doc/org-manual.org (The date/time prompt): Document hour modifier.

This adds support for date expressions such as +12h to
org-matcher-time. The regexp this function uses to parse such relative
expressions already includes the "h" character but doesn't actually
handle that case.

AFAICT org-mode commit ec921a2a68 ("Support hourly repeat cookies")
neglected to add support here.

TINYCHANGE
2021-01-24 22:16:45 -05:00
stardiviner 86ad8d2791 org.el: Complete tags from both global and buffer local
* lisp/org.el (org-fast-tag-selection): Merge buffer local tags with
global alist of tags. And it obeys the option
org-complete-tags-always-offer-all-agenda-tags.

* doc/org-manual.org: Update the TAB key doc in tags selection UI.

* etc/ORG-NEWS: Mention the change in org-set-tags-command.
2021-01-14 00:15:55 -05:00
Kyle Meyer 291993888d Merge branch 'maint' 2021-01-01 15:02:10 -05:00
Kyle Meyer 99eafe3787 Update copyright year to 2021 2021-01-01 14:59:01 -05:00
Bastien 35e419bfd6 Merge branch 'maint' 2020-12-15 14:57:01 +01:00
Bastien a846152e4d doc/org-manual.org: Enhance examples
* doc/org-manual.org (Link Abbreviations): Enhance examples.
2020-12-15 14:56:45 +01:00
Bastien 7934e70522 Merge branch 'maint' 2020-12-15 09:04:30 +01:00
Bastien 678f4d4b35 doc/org-manual.org: Remove a reference
* doc/org-manual.org (Cache results of evaluation): Remove a
reference.

The reference leads to a bug report that does not clearly explain the
situation here.  Also, it contains the string "@somewhere" that fails
to be correctly exported in Texinfo.
2020-12-15 09:02:45 +01:00
TEC 1af809c573 org-manual.org: document org-plot changes
* doc/org-manual.org: Document changes to org-plot.el.
2020-12-14 06:38:59 +01:00
Gustav Wikström a71ac14e46 New startup options, #+startup: show<n>levels
* lisp/org.el (org-startup-folded, org-startup-options)
  (org-set-startup-visibility): Add new startup options
2020-12-10 10:35:59 +01:00
Kyle Meyer b3b29e1d59 Merge branch 'maint' 2020-11-27 01:35:31 -05:00
Florian Dufour ccf81be2a2 org-capture.el: Add :tree-type 'month' in org-capture-templates description
* lisp/org-capture.el (org-capture-templates): Enhance description and
add 'month' value for :tree-type in description.

* doc/org-manual.org: Fix typo for displaying 'month' in :tree-type
property.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TINYCHANGE

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

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

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

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

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

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

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

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

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

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

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

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

Reported-by: Jorge P. de Morais Neto <jorge@disroot.org>
  <87a73gstpz.fsf@disroot.org>
2020-04-12 18:26:31 -04:00
Nicolas Goaziou 5b41528bcb manual: Tiny rewording
* doc/org-manual.org (Repeated tasks): Add missing commas.
2020-04-07 12:22:39 +02:00
Nicolas Goaziou 3c87b8263d org-manual: Use present tense if possible
* doc/org-manual.org (Repeated tasks): Prefer present tense over
future tense whenever applicable.
2020-04-06 15:36:59 +02:00
Nicolas Goaziou fb593f7556 Handle ".+" repeater with hours step
* doc/org-manual.org (Repeated tasks): Document new feature.
* lisp/org.el (org-auto-repeat-maybe): Repeat from now when ".+" is
used in conjunction of hours increment.
* testing/lisp/test-org.el (test-org/auto-repeat-maybe): Add tests.
2020-04-06 15:18:48 +02:00
Marco Wahl b9935765f7 Merge branch 'maint' 2020-03-31 00:12:14 +02:00
Marco Wahl 6a3dffdf24 org-manual: Make doc consistent with code about column insert 2020-03-31 00:09:10 +02:00
Nicolas Goaziou 97f0f1aad2 org-manual: Fix typo
* doc/org-manual.org (The clock table): Add missing closing marker.
2020-03-29 12:37:08 +02:00
Kyle Meyer ba685555c4 org-clock: Mention semimonth step in manual and add test
* doc/org-manual.org (The clock table): Mention new semimonth :step
value.
* testing/lisp/test-org-clock.el (test-org-clock/clocktable/step):
Test :step semimonth.

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

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

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

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

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

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

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

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

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

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

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

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

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

* lisp/org-src.el (org-src-tab-acts-natively): Ditto.
2020-02-21 16:35:56 +01:00
Nicolas Goaziou 5d2075abad org-manual: Stick to typographic conventions
* doc/org-manual.org (Subscripts and Superscripts): Use ~...~ markup
for symbols and capital letters for keywords. Also prefer direct voice
and present tense whenever possible.
2020-02-20 09:57:38 +01:00