Commit Graph

31 Commits

Author SHA1 Message Date
Ihor Radchenko 6a417d5798
doc/org-guide.org: Convert references to manual into info:org links
Reported-by: @inktvis_75:matrix.org
2023-11-23 12:43:29 +02:00
Yuval Langer dbb3912229
doc/org-guide.org: Add command names to listed keybindings
For every key binding listed, list the corresponding command name.
Useful for users of non-vanilla Emacs distributions with customized
key bindings.

Co-authored-by: Ihor Radchenko <yantar92@posteo.net>
Link: https://list.orgmode.org/orgmode/CAK0OjG2hOJry4L4TfefkdKQp3ALX7zML_NwS=gqhD79UE7O42g@mail.gmail.com/

TINYCHANGE
2023-07-19 12:47:28 +03:00
David Masterson d50956e480
org-manual, org-guide: Improve timestamp documentation
* doc/org-manual.org (Dates and Times): Explain the purpose of
timestamps in the opening paragraphs.
(Timestamps): Mention that time range.  Clarify that an entry may
contain multiple timestamps, providing an example.  Explain formal
time range meaning, with example.  Add cindex entry "time range".  Add
date range example.
* doc/org-guide.org: Syncronoize changes with org-manual, adding some
missing pieces.
(Timestamps): Remove useless cindex entries (org-guide does not
produce index).

Co-authored-by: Ihor Radchenko <yantar92@posteo.net>
Link: https://orgmode.org/list/SJ0PR03MB5455693CA8266256D46BA594A259A@SJ0PR03MB5455.namprd03.prod.outlook.com

TINYCHANGE
2023-06-18 13:23:36 +03:00
Ihor Radchenko b29edcaf82
Merge branch 'bugfix' 2023-06-11 12:25:27 +03:00
Ihor Radchenko e9d6a54791
* doc/org-guide.org (Timestamps): Document hour repeaters
This commit fixes out-of-sync update of the manual in 5098404b1.

Reported-by: David Masterson <dsmasterson@gmail.com>
Link: https://orgmode.org/list/SJ0PR03MB5455A8B8CF932CBB3D656FDAA257A@SJ0PR03MB5455.namprd03.prod.outlook.com
2023-06-11 12:23:37 +03:00
Ihor Radchenko f81ba451a7
Prefer "backend" over "back-end"
* doc/org-manual.org (Exporting): Add cindex entry for both "backend"
and "back-end" for better searchability.

All other changes are trivial.

Note that `org-element-export-snippet-parser' will still use :back-end
property.  So will ox.el in INFO channel.
2023-04-20 14:11:19 +02: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
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
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
Kyle Meyer 5a229cbc44 Update copyright year to 2022 2022-01-01 15:17:08 -05:00
Marco Wahl b4e575ee87 org-manual/guide: use function quotes for hooks and key-bindings 2021-08-31 23:04:49 +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
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
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
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
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
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
Bastien c39c5c6559 Fix info dircategory
Thanks to Drew Adams and Steve Berman for reporting this.
2020-02-12 17:41:51 +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
Kyle Meyer ff5fc050d3 Update copyright year to 2020 2020-01-01 13:38:46 -05:00
Jonas Bernoulli 5117d8a159 Fix typos 2019-11-16 17:17:36 -05:00
Carsten Dominik f1c030bed5 Prefix argument to `org-todo' forces stage change logging
* lisp/org.el (org-use-fast-todo-selection): Allow values
`auto' and `expert'.
(org-todo): Change the interpretation of the prefix argument.
A single `C-u' now forces taking a logging time stamp and note.
(org-fast-todo-selection): Implement the `expert' option of
`org-use-fast-todo-selection' and avoid showing the selection
window.  Instead, show the options in the prompt.

* doc/org-manual.org: (Basic TODO Functionality): Document that `C-u
C-c C-t' is the simplest way to log a TODO state change.
(TODO keywords as workflow states): Slightly simplify text.
(TODO keywords as types): Document that tags should be used instead.
(Progress Logging, Closing items, Tracking TODO state changes):
Document that `C-u C-c C-t' is the simplest way to log a TODO
state change.
(Remote editing): Document using a prefix to the `org-agenda-todo'
command logs the state change.
(Using CDLaTeX to enter math): Document that CDLaTeX is	available on
MELPA.

* doc/org-guide.org (Progress Logging): Document the use of a
prefix to `org-todo' to force logging.
2019-08-14 09:58:38 +02:00
Carsten Dominik 9e1e682135 Improve the mention of indent-mode in the guide 2019-07-19 08:58:16 +02:00
Carsten Dominik 8a30e8efef Fix typos in org-guide.org 2019-07-14 22:56:51 +02:00
Carsten Dominik aaca138324 Apply the proper way to describe a key in the guide 2019-07-14 14:05:44 +02:00
Carsten Dominik e571ca8e9d Document structure template insertion in the compact guide 2019-07-14 14:02:12 +02:00
Nicolas Goaziou d588274878 Factor out setup for doc
* doc/doc-setup.org: New file.
* doc/org-guide.org:
* doc/org-manual.org: Use new file.
2019-03-19 02:25:18 +01:00
Nicolas Goaziou 1a678f184f Generate compact guide from an Org file
* doc/orgguide.texi:
* doc/doclicense.texi:
* doc/docstyle.texi: Delete files.
* doc/org-guide.org: New file.
2019-03-19 02:25:01 +01:00