Next: , Up: Context-Free Elements   [Index]


18.1.3.1 Headlines

A headline is defined as:

STARS KEYWORD PRIORITY TITLE TAGS
STARS

is a string starting at column 0, containing at least one asterisk and ended by a space character. The number of asterisks is used to define the level of the headline. It’s the sole compulsory part of a headline.

KEYWORD

is a TODO keyword, which has to belong to the list defined in org-todo-keywords-1, which contains all ‘TOOD’ and ‘DONE’ keywords in a buffer. Case is significant.

PRIORITY

is a priority cookie, i.e. a single letter preceded by a hash sign # and enclosed within square brackets.

TITLE

can be made of any character but a new line. Though, it will match after every other part have been matched.

TAGS

is made of words containing any alpha-numeric character, underscore, at sign, hash sign or percent sign, and separated with colons.

COMMENT

If the first word appearing in the title is “COMMENT”, the headline will be considered as “commented”. Case is significant.

FOOTNOTES

If the headline’s title is the value contained in org-footnote-section (e.g. “Footnotes”), it will be considered as a “footnote section”. Case is significant.

ARCHIVE

If “ARCHIVE” is one of its tags, it will be considered as “archived”. Case is significant.

SECTION

A headline contains directly one section (optionally), followed by any number of deeper level headlines.