Commit Graph

2885 Commits

Author SHA1 Message Date
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 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
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 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
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 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 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
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
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 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 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 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 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
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 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
Marco Wahl 6a3dffdf24 org-manual: Make doc consistent with code about column insert 2020-03-31 00:09:10 +02: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 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 46886f22d9 doc/org-manual.org (Completion): Fix documentation
* doc/org-manual.org (Completion): Fix documentation.
2020-02-24 10:34:46 +01:00
Bastien 79ed6d208e org-manual.org: Fix repository link
* doc/org-manual.org (Using Org's git repository): Fix
repository link.

Thanks to Gustavo Barros for reporting this.
2020-02-13 08:19:24 +01:00
Bastien c39c5c6559 Fix info dircategory
Thanks to Drew Adams and Steve Berman for reporting this.
2020-02-12 17:41:51 +01:00
Bastien c93ed7feb6 doc/doc-setup.org: Update maintainer 2020-02-12 17:41:29 +01:00
Nicolas Goaziou d20e45b187 org-manual: New "features" section about source blocks
* doc/org-manual.org (Features): New section.

The main motivation behind this is to avoid starting "Working with
source code" section with a wall of text that hides the menu.
2020-02-08 13:06:41 +01:00
Nicolas Goaziou 4f26e31203 org-manual: Clarify "link" format for Babel code
* doc/org-manual.org (Format): Clarify "link" format.

Reported-by: Matt Huszagh <huszaghmatt@gmail.com>
2020-02-08 09:26:24 +01:00
Bastien 151a31917b doc/org-manual.org: Don't document deleted command
* doc/org-manual.org (Remote editing): Don't document deleted command.
2020-02-02 08:35:43 +01:00
Bastien c6a34dc01f org-manual.org: Enhance documentation for Org Indent Mode
* doc/org-manual.org (Org Indent Mode): Document
`org-indent-mode-turns-on-hiding-stars' and
`org-indent-mode-turns-off-org-adapt-indentation' and add them to
the variable index.

See https://github.com/MatthewZMD/.emacs.d/issues/28 for details on
what was confusing.

Thanks to Neil Hansen for pointing this.
2020-01-26 08:58:44 +01:00
Kyle Meyer 36cd249e75 guide: Match recommended global keybindings to manual's
* doc/org-guide.org (Activation): Match recommended global keybindings
to those in the manual.

In the guide's .texi to .org conversion in 1a678f184 (Generate compact
guide from an Org file, 2019-03-19), the leading "C-c"s of the
bindings were lost.  Restore them.

Also, drop org-switchb, which was pruned from the manual's suggested
bindings in d03515590, and tweak the surrounding text more closely
match the manual's.

Reported-by: Nick Dokos <ndokos@gmail.com>
2020-01-17 20:55:47 -05:00
Nicolas Goaziou e3681b0b08 org-manual: Fix typo
* doc/org-manual.org (Hard indentation): Fix typo.
2020-01-09 17:54:51 +01:00
Nicolas Goaziou 2c598d7499 org-manual: Update "ol-man.el" example
* doc/org-manual.org (Adding Hyperlink Types): Remove
unnecessary (require 'org) in example and fix function name.
2020-01-09 17:49:15 +01:00
Tom Gillespie b1cd1595df org-manual: Use ol-man.el in "Adding Hyperlink Types"
doc/org-manual.org (Adding Hyperlink Types): Update the name of the
example file from org-man.el to ol-man.el to reflect the renaming of
files related to Org links.

I found this thoroughly confusing when trying to (require 'org-man)
since it was clearly referenced as being in "contrib/", hopefully this
change will prevent anyone else from encountering the same confusion.
2020-01-09 17:44:39 +01:00
Kyle Meyer ff5fc050d3 Update copyright year to 2020 2020-01-01 13:38:46 -05:00
Nicolas Goaziou cac0e46559 org-manual: Refer to link format in "Escape Character"
* doc/org-manual.org (Escape Character): Mention Link Format section
for completeness.
2019-12-24 14:41:44 +01:00
Nicolas Goaziou 49c9cf2b6e org-manual: Tiny fix
* doc/org-manual.org (Internal Links): Tiny fix.
2019-12-23 10:39:59 +01:00
Nicolas Goaziou 546cbad531 Link syntax require to escape every square bracket
* lisp/ol.el (org-link-make-regexps): Update regexp to forbid any
un-escaped square bracket in the URI.
(org-link-escape):
(org-link-unescape):
* testing/lisp/test-ol.el (test-ol/escape):
(test-ol/unescape):
(test-ol/store-link):
* testing/lisp/test-org.el (test-org/custom-id):
(test-org/fuzzy-links):
* testing/lisp/test-ox.el (test-org-export/resolve-fuzzy-link): Adapt
to new syntax.
* doc/org-manual.org (Link Format): Update documentation.

The new syntax allowed un-escaped opening square brackets in the URI
part of bracket links. Unfortunately, it led to bug as described here:

  <https://lists.gnu.org/archive/html/emacs-orgmode/2019-12/msg00312.html>

Now, we require to escape every square bracket in the URI.
2019-12-22 14:52:53 +01:00
Nicolas Goaziou fa74fbb33c org-manual: Fix typo
* doc/org-manual.org (Field coordinates in formulas): Fix typo.
2019-12-17 10:33:41 +01:00
Nicolas Goaziou bc0d219e97 org-manual: Improve internal links documentation
* doc/org-manual.org (Internal Links): Document starred links.  Fix
documentation for text search.
2019-12-17 10:16:58 +01:00
Nicolas Goaziou b64a3308aa org-capture: Get capture templates from anonymous functions
* lisp/org-capture.el (org-capture-get-template): Allow specifying
template from an anonymous function.
* doc/org-manual.org (Template elements): Document it.
2019-12-12 22:33:22 +01:00
Paul Eggert f9a55cba31 Backport commit b0f20651e from Emacs
; Spelling fixes
b0f20651e3cbb8a66f11ffae4c18634019c20cd4
Paul Eggert
Tue Dec 10 20:05:49 2019 -0800
2019-12-11 21:22:50 -05:00
Paul Eggert ac90e86c32 Backport commit d1a791f8e from Emacs
Spelling fixes
d1a791f8edc1b8f2189b6f1b3be7b946fef1edbc
Paul Eggert
Mon Dec 9 18:45:18 2019 -0800
2019-12-11 21:19:55 -05:00
Marco Wahl 9b85eaa65a org-manual: Unify to two spaces after a dot 2019-12-11 23:10:42 +01:00
Marco Wahl 67e48de639 org-manual: Fix typo 2019-12-11 22:58:30 +01:00
Nicolas Goaziou 74c9b11e80 org-manual: Fix typo
* doc/org-manual.org (Column Width and Alignment): Fix typo.
2019-12-11 22:07:42 +01:00
Nicolas Goaziou 2e6853e798 org-manual: Improve an example
* doc/org-manual.org (Computed tag filtering): Do not suggest using
one-armed `if' constructs.  Remove misleading "org" prefix, and source
block indentation.
2019-12-11 21:51:20 +01:00
Nicolas Goaziou a8da497261 org-manual: Suggest kbd macro for bindings
* doc/org-manual.org (Capture templates): Suggest kbd macro for
bindings.
2019-12-11 21:39:09 +01:00
Nicolas Goaziou 3e3819392e org-manual: Use proper markup
* doc/org-manual.org (Computed tag filtering): Use proper
markup. E.g., use verbatim for anything meant to appear in an Org
document.  Use fixed-width for single line examples. Fix spacing after
"e.g.". Use active voice and present tense.
2019-12-11 21:35:05 +01:00
Nicolas Goaziou fffb57aa39 org-manual: Fix typo
* doc/org-manual.org (Computed tag filtering): Fix spacing after
"i.e.".
2019-12-11 21:27:52 +01:00
Marco Wahl 5a7fadf59a manual: Fix in section [Computed tag filtering] 2019-12-11 15:50:56 +01:00
Nicolas Goaziou f4e5b75b47 org-manual: Fix `org-latex-subtitle-format' documentation
* doc/org-manual.org (LaTeX specific export settings): Fix
`org-latex-subtitle-format' documentation.
2019-11-23 17:45:23 +01:00