Previous: , Up: Introduction   [Contents][Index]

1.5 Typesetting conventions used in this manual

TODO keywords, tags, properties, etc.

Org mainly uses three types of keywords: TODO keywords, tags and property names. In this manual we use the following conventions:

TODO
WAITING

TODO keywords are written with all capitals, even if they are user-defined.

boss
ARCHIVE

User-defined tags are written in lowercase; built-in tags with special meaning are written with all capitals.

Release
PRIORITY

User-defined properties are capitalized; built-in properties with special meaning are written with all capitals.

Moreover, Org uses option keywords (like #+TITLE to set the title) and environment keywords (like #+BEGIN_HTML to start a HTML environment). They are written in uppercase in the manual to enhance its readability, but you can use lowercase in your Org files3.

Keybindings and commands

The manual suggests two global keybindings: C-c a for org-agenda and C-c c for org-capture. These are only suggestions, but the rest of the manual assumes that you are using these keybindings.

Also, the manual lists both the keys and the corresponding commands for accessing a functionality. Org mode often uses the same key for different functions, depending on context. The command that is bound to such keys has a generic name, like org-metaright. In the manual we will, wherever possible, give the function that is internally called by the generic command. For example, in the chapter on document structure, M-right will be listed to call org-do-demote, while in the chapter on tables, it will be listed to call org-table-move-column-right. If you prefer, you can compile the manual without the command names by unsetting the flag cmdnames in org.texi.


Footnotes

(3)

Easy templates insert lowercase keywords and Babel dynamically inserts #+results.

Previous: , Up: Introduction   [Contents][Index]