Commit Graph

2803 Commits

Author SHA1 Message Date
Carsten Dominik 6dfd4e38d0 Simplify the "Hard Indentation" section in the manual
* doc/org-manual.org (Hard Indentation): Simplify section.
2019-08-18 11:06:33 +02:00
Carsten Dominik 16f3fd69c3 Various small changes to the manual
* doc/org-manual.org: Compactify the summary of in-buffer
options. Move Org Protocol section to the Miscellaneous chapter.
2019-08-18 09:42:40 +02:00
Carsten Dominik f8d81f4aaa Fix indentation problem in manual that broke structure
* doc/org-manual.org (Summary of In-Buffer Settings): Fix indentation problem.
2019-08-17 22:11:32 +02:00
Carsten Dominik a37dee547e Make Attachment subsections unnumbered 2019-08-17 18:03:20 +02:00
Carsten Dominik 6b21c97bbe Rename sections in the manual
* doc/org-manual.org (Refiling and Archiving): Renamed from
Refile, Copy and Archiving.
(Capture and Attachments): Renamed from Capture, Attachments,
RSS Feeds and Protocols.
2019-08-17 18:01:01 +02:00
Carsten Dominik 1c9be12119 Restructure Miscellaneous section of the manual
doc/org-manual.org: Restructure Miscellaneous section of the manual,
remove Customization subsection
2019-08-17 17:55:52 +02:00
Nicolas Goaziou 552bb0764a org-manual: Fix typo
* doc/org-manual.org (Literal Examples): Fix typo.
2019-08-17 15:40:36 +02:00
Nicolas Goaziou 8229a59828 Merge branch 'maint' 2019-08-17 15:31:05 +02:00
Nicolas Goaziou 4cb3a37533 org-manual: Fix typo
* doc/org-manual.org (LaTeX specific export settings): Fix typo.

Reported-by: Emmanuel Charpentier <emm.charpentier@free.fr>
<http://lists.gnu.org/r/emacs-orgmode/2019-07/msg00153.html>
2019-08-17 15:29:16 +02:00
Nicolas Goaziou 9e083fdf42 org-manual: More visible information about "comma escape"
* doc/org-manual.org (Literal Examples): Move information about "comma
escape" outside of the footnote.  Delete related footnote.

Suggested-by: Štěpán Němec
2019-08-17 15:21:09 +02:00
Nicolas Goaziou d841b38086 org-manual: Slight rewording for indented source blocks
* doc/org-manual.org (Literal Examples): Slight rewording.  Merge
indentation information into the same paragraph.
2019-08-17 14:50:08 +02:00
Nicolas Goaziou d8778d9305 org-manual: Fix typo
* doc/org-manual.org (Literal Examples): The major mode name differs
from the symbol used.
(Footnotes): Fix typo.
2019-08-17 14:32:16 +02:00
Nicolas Goaziou c7bce7a986 org-manual: Fix typo
* doc/org-manual.org (Dynamic Headline Numbering): Fix typo.
2019-08-17 09:21:18 +02:00
Nicolas Goaziou 836f1396fc Clarify the difference between org-indent-mode and hard indentation
doc/org-manual.org (A Cleaner Outline View): Clarify the difference
between org-indent-mode and hard indentation.
2019-08-17 02:00:42 +02:00
Nicolas Goaziou 518691598d org-manual: Fix wrong footnote number
* doc/org-manual.org (External Links): Fix footnote number.
2019-08-17 01:52:09 +02:00
Nicolas Goaziou 00cf093dd1 Revert " Clarify the difference between org-indent-mode and hard indentation"
This reverts commit ebf10f126c.

The change propagates an error in a footnote number.
2019-08-17 01:51:21 +02:00
Carsten Dominik ebf10f126c Clarify the difference between org-indent-mode and hard indentation
doc/org-manual.org (A Cleaner Outline View): Clarify the difference
between org-indent-mode and hard indentation
2019-08-16 23:31:57 +02:00
Carsten Dominik bb275b85df Remove duplicate information from the manual
* doc/org-manual.org (Tracking TODO state changes): Remove duplicated
information.
2019-08-16 17:27:01 +02:00
Carsten Dominik 07e48a7af6 Merge branch 'fix-org-columns-formatdocumentation' 2019-08-16 09:37:54 +02:00
Carsten Dominik 6dda536f9f Clear up unclear setting of columns format for the agenda
* lisp/org.el (org-columns-default-format-for-agenda): New option.

* lisp/org-colview.el (org-overriding-columns-format): Updated documentation.
(org-agenda-columns): `Use org-columns-default-format-for-agenda'

* doc/org-manual.org (Using Column View in the Agenda): Fix the
description how to set the columns format for agenda views.
2019-08-16 09:34:55 +02: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 64739aa065 Implement force logging of a TODO state change
* lisp/org.el (org-todo): Make a tripple `C-u' prefix force
          logging the todo state change with timestamp and a note.
          Ignoting blocking a change now needs four `C-u' prefixes,
          because this is probably hardly ever used.

	* doc/org-manual.org (Tracking TODO state changes): Document
          forcing of state change logging with `C-u C-u C-u C-c C-t'.
2019-08-01 08:10:20 +02:00
Kyle Meyer 9a543b97a5 orgguide: Fix typo
* doc/orgguide.texi (Embedded @LaTeX{}): Fix typo.

Reported-by: Thomas Nguyen <thomas.nguyen1@okcps.org>
2019-07-23 23:24:31 -04:00
Marco Wahl 13442ab719 org-manual: Fix key to toggle persistent marks 2019-07-24 00:02:27 +02:00
Carsten Dominik e059c1c1da Improve formatting and alignment in the refernce card 2019-07-19 10:36:57 +02:00
Carsten Dominik df7c78220a Document org-indent-mode and template insertion in refcard 2019-07-19 10:19:22 +02:00
Carsten Dominik 9e1e682135 Improve the mention of indent-mode in the guide 2019-07-19 08:58:16 +02:00
Marco Wahl 96267295a6 org-manual.org: Clarification about keys in Search view 2019-07-15 11:03:44 +02:00
Marco Wahl dc2198971b org-agenda: Respect narrowing for agenda restricted to buffer
* lisp/org-agenda.el (org-agenda): Add a condition to check if
  narrowing is in effect and in case set the agenda restriction markers.
* etc/ORG-NEWS (Respect narrowing when agenda command is restricted to buffer):
* doc/org-manual.org (The Agenda Dispatcher): Mention the behavior.
2019-07-15 00:22:51 +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
Marcin Borkowski c2ef61ffcf Explain the `org-agenda-todo-ignore-...` variables in the manual 2019-07-09 12:19:25 +02:00
Gustav Wikström ae9cd4370b org-attach*, org, org-manual, org-news, ox-html, testing/*
* lisp/org-attach.el

Changed the way attachments deal with property-inheritance.  It now
adheres to the =org-use-property-inheritance= setting by default but
it can be customized if needed (I recommend to enable it!).
The property ATTACH_DIR is deprecated in favour of the shorter and simpler
property DIR.

Added an explicit option to =org-attach= for unsetting
attachment-directories (i.e. remove DIR property and deal with the
attachments by interaction).

Added attachment link type with the prefix "attachment:".

Added customizations:
- org-attach-dir-relative
- org-attach-preferred-new-method
- org-attach-use-inheritance
- org-attach-id-to-path-function

Hooks added:
- org-attach-after-change-hook
- org-attach-open-hook

A new linktype "attachment" is added in order to reduce
link-duplication when wanting to link to files in attached folders of
nodes.  This works for both ID and DIR properties.  The goal is to
make the functionality for attachment links mirror the functionality
for file links.

* lisp/org-attach-git.el

New file, existing functionality.  Code here has been factored out
from org-attach.el and if GIT-functionality is to be used this module
needs to be required sepatately.  It extends org-attach by use of its
hooks.

Activating git functionality in org-attach is done by loading
org-attach-git from now on, instead of customizing a variable.

Naming of both functions and tests has been modified to match the move
of functionality into its own module.

* lisp/org.el

Inline images are shown also using attachment-links, exactly the same
as it works for file-links today.

Make org-open-at-point respect ARG when opening attachment-dir.

* lisp/org-compat.el

org-attach-directory has been deprecated in favour for
org-attach-id-dir.  The new name matches its purpose better.

* lisp/ox-html.el

Export attachment links to images as inline images, in the same way as
file links work today.

* etc/ORG-NEWS

Mention the changes in this patch.

* doc/org-manual.org

The chapter "Refile, Copy, Archive" has been split into two separate
chapters.
- "Refile, Copy and Archiving" for information related to moving
  existing data around.

- "Capture, Attachments, RSS Feeds and Protocols" for information
  related to working with external data.

The attachment-part has been rewritten and extended to match the
changes in this patch.

The new attachment link type is mentioned both inside the attachments
chapter and in the chapter dealing with links.

Documentation related to external links has been improved.

* testing/lisp/test-org-attach-annex.el

Require org-attach-git instead of org-attach, since this file tests
the GIT-functionality.

* testing/lisp/test-org-attach.el

Add tests for org-attach.

* testing/org-test.el

Define a symbol for a file to test attachments with.

* testing/examples/*

A bunch of new example files and folders are created and are used in
testing of org-attach to verify its functionality.
2019-07-07 19:55:49 +02:00
Nicolas Goaziou 9ddfe45314 org-table: Improve `org-table-copy-down'
* lisp/org-table.el (org-table--increment-field): New function.
(org-table-copy-down): Use new function.
* testing/lisp/test-org-table.el (test-org-table/copy-down): New test.
* doc/org-manual.org (Calculations): Update documentation.
2019-06-28 00:07:25 +02:00
Nicolas Goaziou 2263634823 org-manual: Fix typo
* doc/org-manual.org (From Carsten): Fix typo.
2019-06-22 09:33:33 +02:00
Kyle Meyer 81920b3f86 Merge branch 'maint' 2019-06-09 21:39:18 -04:00
Paul Eggert 65a6f54605 Backport commit 852d28176 from Emacs
Update author/maintainer info
852d28176990d035366142bfde36a0440a317228
Paul Eggert
Sun May 26 01:00:16 2019 -0700
2019-06-09 21:35:45 -04:00
Gregor Zattler f4083eefd8 manual: Fix URL
* doc/org-manual.org (External Links): Fix URL
2019-06-07 23:34:46 +02:00
Nicolas Goaziou fb50912228 org-manual: Fix link to CDLaTeX mode
* doc/org-manual.org (Using CDLaTeX to enter math): Fix link to
  CDLaTeX mode.

Reported-by: Qqwy/Wiebe-Marten <qqwy@gmx.com>
<http://lists.gnu.org/r/emacs-orgmode/2019-06/msg00028.html>
2019-06-05 23:15:49 +02:00
Sacha Chua a41e9950ae Add :target option for the TOC keyword
* doc/org-manual.org, etc/ORG_NEWS: Document :target option
  for the TOC keyword.

* lisp/ox.el (org-export-resolve-link): New function.

* lisp/ox-ascii.el (org-ascii-keyword): Added :target to the TOC
  keyword.
  (org-ascii--build-toc): Changed LOCAL argument to SCOPE.

* lisp/ox-html.el (org-html-keyword): Added :target to the TOC keyword.

* lisp/ox-md.el (org-md-keyword): Added :target to the TOC keyword.
  (org-md--build-toc): Changed LOCAL argument to SCOPE.

* lisp/ox-odt.el (org-odt-keyword): Added :target to the TOC keyword.

* testing/lisp/test-ox.el (test-org-export/collect-headlines): Added
  tests for specifying scope by CUSTOM_ID or by fuzzy matching.
  (test-org-export/resolve-link): New test.
2019-05-30 15:25:46 +02:00
Kyle Meyer 84a4b73fd6 Merge branch 'maint' 2019-05-16 21:23:18 -04:00
Cheong Yiu Fung 2c9f259d65 org-manual: Small fixes
* doc/org-manual.org (Handling Links): Update variable
`org-id-link-to-org-use-id', which was changed in v7.9.2.

TINYCHANGE
2019-05-16 21:22:19 -04:00
Nicolas Goaziou cd1af27a2a Merge branch 'maint' 2019-05-10 19:38:27 +02:00
Josiah Schwab 4df7051255 manual: Update ADS link abbreviation example
* doc/org-manual.org (Link Abbreviations): Change URL.

Reported-by: Alain Kalker <a.c.kalker@gmail.com>
<http://lists.gnu.org/r/emacs-orgmode/2019-05/msg00083.html>

TINYCHANGE
2019-05-10 19:36:58 +02:00
Nicolas Goaziou c47c686d5f Merge branch 'maint' 2019-05-08 14:19:04 +02:00
Nicolas Goaziou e95ac0bac3 org-manual: Delete reference to removed function
* doc/org-manual.org (Inserting deadlines or schedules): Remove
  reference to `org-mark-entry-for-agenda-action`.

Reported-by: Christian Heinrich <com-orgmode@gladbachcity.de>
<http://lists.gnu.org/r/emacs-orgmode/2019-05/msg00060.html>
2019-05-08 14:17:30 +02:00
Nicolas Goaziou 8db6f52c0d Merge branch 'maint' 2019-04-25 10:28:45 +02:00
Sebastian Miele 4ec550fd5a org-manual: Fix typo
* doc/org-manual.org (Footnotes): Fix typo.
2019-04-25 10:28:05 +02:00
Nicolas Goaziou 262bcb4557 org-manual: Add missing description for Beamer export
* doc/org-manual.org (Beamer Export): Add missing description.
2019-04-23 10:42:45 +02:00