~bzg/worg

4b8c60feb44b1a4dcc7a9b02dcc22e74587ebc0d — Ihor Radchenko 2 months ago 6961c8f
org-syntax.org (Headings): Fix COMMENT string in headings

* org-syntax.org (Headings): COMMENT is not a part of the title.  Fix
the description accordingly.
1 files changed, 4 insertions(+), 3 deletions(-)

M org-syntax.org
M org-syntax.org => org-syntax.org +4 -3
@@ 354,7 354,7 @@ default values we provide here.
A Heading is an /unindented/ line structured according to the following pattern:

#+begin_example
STARS KEYWORD PRIORITY TITLE TAGS
STARS KEYWORD PRIORITY COMMENT TITLE TAGS
#+end_example

+ STARS :: A string consisting of one or more asterisks (up to


@@ 376,6 376,8 @@ STARS KEYWORD PRIORITY TITLE TAGS
  hash sign =#= and enclosed within square brackets (e.g. =[#A]= or =[#1]=).  This
  is called a "priority cookie".

+ COMMENT (optional) :: String "COMMENT".  Case is significant.

+ TITLE (optional) :: A series of objects from the standard set,
  excluding line break objects.  It is matched after =KEYWORD= and
  =PRIORITY=.


@@ 393,8 395,7 @@ STARS KEYWORD PRIORITY TITLE TAGS
,**** TODO [#A] COMMENT Title :tag:a2%:
#+end_example

If the first word appearing in the title is =COMMENT=, the heading
will be considered as "commented".  Case is significant.
If heading has =COMMENT=, it will be considered as "commented".

If the TITLE of a heading is exactly the value of ~org-footnote-section~
(=Footnotes= by default), it will be considered as a "footnote section".