org-syntax: Update syntax
[worg.git] / dev / org-syntax.org
1 #+TITLE: Org Syntax (draft)
2 #+AUTHOR: Nicolas Goaziou
3 #+OPTIONS: toc:t ':t author:nil
4 #+LANGUAGE: en
5 #+CATEGORY: worg
6 #+BIND: sentence-end-double-space t
7
8 This document describes and comments Org syntax as it is currently
9 read by its parser (Org Elements) and, therefore, by the export
10 framework.  It also includes a few comments on that syntax.
11
12 A core concept in this syntax is that only headlines and sections are
13 context-free[fn:1][fn:2].  Every other syntactical part only exists
14 within specific environments.
15
16 Three categories are used to classify these environments: "Greater
17 elements", "elements", and "objects", from the broadest scope to the
18 narrowest.  The word "element" is used for both Greater and non-Greater
19 elements, the context should make that clear.
20
21 The paragraph is the unit of measurement.  An element defines
22 syntactical parts that are at the same level as a paragraph,
23 i.e. which cannot contain or be included in a paragraph.  An object is
24 a part that could be included in an element.  Greater elements are all
25 parts that can contain an element.
26
27 Empty lines belong to the largest element ending before them.  For
28 example, in a list, empty lines between items belong are part of the
29 item before them, but empty lines at the end of a list belong to the
30 plain list element.
31
32 Unless specified otherwise, case is not significant.
33
34 * Headlines and Sections
35   :PROPERTIES:
36   :CUSTOM_ID: Headlines_and_Sections
37   :END:
38
39   A headline is defined as:
40
41   #+BEGIN_EXAMPLE
42   STARS KEYWORD PRIORITY TITLE TAGS
43   #+END_EXAMPLE
44
45   STARS is a string starting at column 0, containing at least one
46   asterisk (and up to ~org-inlinetask-min-level~ if =org-inlinetask=
47   library is loaded) and ended by a space character.  The number of
48   asterisks is used to define the level of the headline.  It's the
49   sole compulsory part of a headline.
50
51   KEYWORD is a TODO keyword, which has to belong to the list defined
52   in ~org-todo-keywords-1~.  Case is significant.
53
54   PRIORITY is a priority cookie, i.e. a single letter preceded by
55   a hash sign # and enclosed within square brackets.
56
57   TITLE can be made of any character but a new line.  Though, it will
58   match after every other part have been matched.
59     
60   TAGS is made of words containing any alpha-numeric character,
61   underscore, at sign, hash sign or percent sign, and separated with
62   colons.
63     
64   Examples of valid headlines include:
65
66   #+BEGIN_EXAMPLE
67   ,*
68
69   ,** DONE
70
71   ,*** Some e-mail
72
73   ,**** TODO [#A] COMMENT Title :tag:a2%:
74   #+END_EXAMPLE
75     
76   If the first word appearing in the title is "COMMENT", the headline
77   will be considered as "commented".  If that first word is "QUOTE",
78   it will be considered as "quoted".  In both situations, case is
79   significant.
80
81   If its title is ~org-footnote-section~, it will be considered as
82   a "footnote section".  Case is significant.
83
84   If "ARCHIVE" is one of its tags, it will be considered as
85   "archived".  Case is significant.
86
87   A headline contains directly one section (optionally), followed by
88   any number of deeper level headlines.
89
90   A section contains directly any greater element or element.  Only
91   a headline can contain a section.  As an exception, text before the
92   first headline in the document also belongs to a section.
93
94   If a quoted headline contains a section, the latter will be
95   considered as a "quote section".
96
97   As an example, consider the following document:
98
99   #+BEGIN_SRC org
100   An introduction.
101   
102   ,* A Headline 
103   
104     Some text.
105   
106   ,** Sub-Topic 1
107   
108   ,** Sub-Topic 2
109   
110   ,*** Additional entry 
111   
112   ,** QUOTE Another Sub-Topic
113   
114      Some other text.
115   #+END_SRC
116
117   Its internal structure could be summarized as:
118
119   #+BEGIN_EXAMPLE
120   (document
121    (section)
122    (headline
123     (section)
124     (headline)
125     (headline
126      (headline))
127     (headline
128      (quote-section))))
129   #+END_EXAMPLE
130   
131 * Affiliated Keywords
132   :PROPERTIES:
133   :CUSTOM_ID: Affiliated_keywords
134   :END:
135
136   With the exception of [[#Inlinetasks][inlinetasks]], [[#Plain_Lists_and_Items][items]], [[#Clock,_Diary_Sexp_and_Planning][planning]], [[#Clock,_Diary_Sexp_and_Planning][clocks]], [[#Node_Properties][node
137   properties]] and [[#Table_Rows][table rows]], every other element type can be assigned
138   attributes.
139
140   This is done by adding specific keywords, named "affiliated
141   keywords", just above the element considered, no blank line
142   allowed.
143
144   Affiliated keywords are built upon one of the following patterns:
145   "#+KEY: VALUE", "#+KEY[OPTIONAL]: VALUE" or "#+ATTR_BACKEND: VALUE".
146
147   KEY is either "CAPTION", "HEADER", "NAME", "PLOT" or "RESULTS"
148   string.
149
150   BACKEND is a string constituted of alpha-numeric characters, hyphens
151   or underscores.
152
153   OPTIONAL and VALUE can contain any character but a new line.  Only
154   "CAPTION" and "RESULTS" keywords can have an optional value.
155
156   An affiliated keyword can appear more than once if KEY is either
157   "CAPTION" or "HEADER" or if its pattern is "#+ATTR_BACKEND: VALUE".
158
159   "CAPTION", "AUTHOR", "DATE" and "TITLE" keywords can contain objects
160   in their value and their optional value, if applicable.
161
162 * Greater Elements
163   :PROPERTIES:
164   :CUSTOM_ID: Greater_Elements
165   :END:
166
167   Unless specified otherwise, greater elements can contain directly
168   any other element or greater element excepted:
169
170   - elements of their own type,
171   - [[#Node_Properties][node properties]], which can only be found in [[#Drawers_and_Property_Drawers][property drawers]],
172   - [[#Plain_Lists_and_Items][items]], which can only be found in [[#Plain_Lists_and_Items][plain lists]].
173
174 ** Greater Blocks
175    :PROPERTIES:
176    :CUSTOM_ID: Greater_Blocks
177    :END:
178
179    Greater blocks consist in the following pattern:
180
181    #+BEGIN_EXAMPLE
182    ,#+BEGIN_NAME PARAMETERS
183    CONTENTS
184    ,#+END_NAME
185    #+END_EXAMPLE
186
187    NAME can contain any non-whitespace character.
188
189    PARAMETERS can contain any character other than new line, and can
190    be omitted.
191
192    If NAME is "CENTER", it will be a "center block".  If it is
193    "QUOTE", it will be a "quote block".
194
195    If the block is neither a center block, a quote block or a [[#Blocks][block
196    element]], it will be a "special block".
197
198    CONTENTS can contain any element, except : a line =#+END_NAME= on
199    its own.  Also lines beginning with STARS must be quoted by
200    a comma.
201
202 ** Drawers and Property Drawers
203    :PROPERTIES:
204    :CUSTOM_ID: Drawers_and_Property_Drawers
205    :END:
206
207    Pattern for drawers is:
208
209    #+BEGIN_EXAMPLE
210    :NAME:
211    CONTENTS
212    :END:
213    #+END_EXAMPLE
214
215    NAME can contain word-constituent characters, hyphens and
216    underscores.
217
218    If NAME is "PROPERTIES", the drawer will become a "property
219    drawer".
220
221    In a property drawer, CONTENTS can only contain [[#Node_Properties][node property]]
222    elements.  Otherwise it can contain any element but another drawer
223    or property drawer.
224
225 ** Dynamic Blocks
226    :PROPERTIES:
227    :CUSTOM_ID: Dynamic_Blocks
228    :END:
229
230    Pattern for dynamic blocks is:
231
232    #+BEGIN_EXAMPLE
233    ,#+BEGIN: NAME PARAMETERS
234    CONTENTS
235    ,#+END:
236    #+END_EXAMPLE
237
238    NAME cannot contain any whitespace character.
239
240    PARAMETERS can contain any character and can be omitted.
241
242 ** Footnote Definitions
243    :PROPERTIES:
244    :CUSTOM_ID: Footnote_Definitions
245    :END:
246
247    Pattern for footnote definitions is:
248
249    #+BEGIN_EXAMPLE
250    [LABEL] CONTENTS
251    #+END_EXAMPLE
252
253    It must start at column 0.
254
255    LABEL is either a number or follows the pattern "fn:WORD", where
256    word can contain any word-constituent character, hyphens and
257    underscore characters.
258
259    CONTENTS can contain any element excepted another footnote
260    definition.  It ends at the next footnote definition, the next
261    headline, two consecutive empty lines or the end of buffer.
262
263 ** Inlinetasks
264    :PROPERTIES:
265    :CUSTOM_ID: Inlinetasks
266    :END:
267
268    Inlinetasks are defined by ~org-inlinetask-min-level~ contiguous
269    asterisk characters starting at column 0, followed by a whitespace
270    character.
271
272    Optionally, inlinetasks can be ended with a string constituted of
273    ~org-inlinetask-min-level~ contiguous asterisk characters starting
274    at column 0, followed by a space and the "END" string.
275
276    Inlinetasks are recognized only after =org-inlinetask= library is
277    loaded.
278
279 ** Plain Lists and Items
280    :PROPERTIES:
281    :CUSTOM_ID: Plain_Lists_and_Items
282    :END:
283
284    Items are defined by a line starting with the following pattern:
285    "BULLET COUNTER-SET CHECK-BOX TAG", in which only BULLET is
286    mandatory.
287
288    BULLET is either an asterisk, a hyphen, a plus sign character or
289    follows either the pattern "COUNTER." or "COUNTER)".  In any case,
290    BULLET is follwed by a whitespace character or line ending.
291
292    COUNTER can be a number or a single letter.
293
294    COUNTER-SET follows the pattern [@COUNTER].
295
296    CHECK-BOX is either a single whitespace character, a "X" character
297    or a hyphen, enclosed within square brackets.
298
299    TAG follows "TAG-TEXT ::" pattern, where TAG-TEXT can contain any
300    character but a new line.
301
302    An item ends before the next item, the first line less or equally
303    indented than its starting line, or two consecutive empty lines.
304    Indentation of lines within other greater elements do not count,
305    neither do inlinetasks boundaries.
306
307    A plain list is a set of consecutive items of the same indentation.
308    It can only directly contain items.
309
310    If first item in a plain list has a counter in its bullet, the
311    plain list will be an "ordered plain-list".  If it contains a tag,
312    it will be a "descriptive list".  Otherwise, it will be an
313    "unordered list".  List types are mutually exclusive.
314
315    For example, consider the following excerpt of an Org document:
316
317    #+BEGIN_EXAMPLE
318    1. item 1
319    2. [X] item 2
320       - some tag :: item 2.1
321    #+END_EXAMPLE
322
323    Its internal structure is as follows:
324
325    #+BEGIN_EXAMPLE
326    (ordered-plain-list
327     (item)
328     (item
329      (descriptive-plain-list
330       (item))))
331    #+END_EXAMPLE
332
333 ** Tables
334    :PROPERTIES:
335    :CUSTOM_ID: Tables
336    :END:
337
338    Tables start at lines beginning with either a vertical bar or the
339    "+-" string followed by plus or minus signs only, assuming they are
340    not preceded with lines of the same type.  These lines can be
341    indented.
342
343    A table starting with a vertical bar has "org" type.  Otherwise it
344    has "table.el" type.
345
346    Org tables end at the first line not starting with a vertical bar.
347    Table.el tables end at the first line not starting with either
348    a vertical line or a plus sign.  Such lines can be indented.
349
350    An org table can only contain table rows.  A table.el table does
351    not contain anything.
352
353    One or more "#+TBLFM: FORMULAS" lines, where "FORMULAS" can contain
354    any character, can follow an org table.
355
356 * Elements
357   :PROPERTIES:
358   :CUSTOM_ID: Elements
359   :END:
360
361   Elements cannot contain any other element.
362
363   Only [[#Keywords][keywords]] whose name belongs to
364   ~org-element-document-properties~, [[#Blocks][verse blocks]] , [[#Paragraphs][paragraphs]] and
365   [[#Table_Rows][table rows]] can contain objects.
366
367 ** Babel Call
368    :PROPERTIES:
369    :CUSTOM_ID: Babel_Call
370    :END:
371
372    Pattern for babel calls is:
373
374    #+BEGIN_EXAMPLE
375    ,#+CALL: VALUE
376    #+END_EXAMPLE
377
378    VALUE is optional.  It can contain any character but a new line.
379
380 ** Blocks
381    :PROPERTIES:
382    :CUSTOM_ID: Blocks
383    :END:
384
385    Like [[#Greater_Blocks][greater blocks]], pattern for blocks is:
386
387    #+BEGIN_EXAMPLE
388    ,#+BEGIN_NAME DATA
389    CONTENTS
390    ,#+END_NAME
391    #+END_EXAMPLE
392
393    NAME cannot contain any whitespace character.
394
395    If NAME is "COMMENT", it will be a "comment block".  If it is
396    "EXAMPLE", it will be an "example block".  If it is "SRC", it will
397    be a "source block".  If it is "VERSE", it will be a "verse block".
398
399    If NAME is a string matching the name of any export back-end
400    loaded, the block will be an "export block".
401
402    DATA can contain any character but a new line.  It can be ommitted,
403    unless the block is a "source block".  In this case, it must follow
404    the pattern "LANGUAGE SWITCHES ARGUMENTS", where SWITCHES and
405    ARGUMENTS are optional.
406
407    LANGUAGE cannot contain any whitespace character.
408
409    SWITCHES is made of any number of "SWITCH" patterns, separated by
410    blank lines.
411
412    A SWITCH pattern is either "-l "FORMAT"", where FORMAT can contain
413    any character but a double quote and a new line, "-S" or "+S",
414    where S stands for a single letter.
415
416    ARGUMENTS can contain any character but a new line.
417
418    CONTENTS can contain any character, including new lines.  Though it
419    will only contain Org objects if the block is a verse block.
420    Otherwise, contents will not be parsed.
421
422 ** Clock, Diary Sexp and Planning
423    :PROPERTIES:
424    :CUSTOM_ID: Clock,_Diary_Sexp_and_Planning
425    :END:
426
427    A clock follows the pattern:
428    
429    #+BEGIN_EXAMPLE
430    CLOCK: TIMESTAMP DURATION
431    #+END_EXAMPLE
432
433    Both TIMESTAMP and DURATION are optional.
434
435    TIMESTAMP is a [[#Timestamp][timestamp]] object.
436
437    DURATION follows the pattern:
438
439    #+BEGIN_EXAMPLE
440    => HH:MM
441    #+END_EXAMPLE
442
443    HH is a number containing any number of digits.  MM is a two digit
444    numbers.
445
446    A diary sexp is a line starting at column 0 with "%%(" string.  It
447    can then contain any character besides a new line.
448
449    A planning is a line filled with at most three INFO parts, where
450    each of them follows the pattern:
451
452    #+BEGIN_EXAMPLE
453    KEYWORD: TIMESTAMP
454    #+END_EXAMPLE
455
456    KEYWORD is either "DEADLINE", "SCHEDULED" or "CLOSED".  TIMESTAMP
457    is is a [[#Timestamp][timestamp]] object.
458
459    Even though a planning element can exist anywhere in a section or
460    a greater element, it will only affect the headline containing the
461    section if it is put on the line following that headline.
462
463 ** Comments
464    :PROPERTIES:
465    :CUSTOM_ID: Comments
466    :END:
467
468    A "comment line" starts with a hash signe and a whitespace
469    character or an end of line.
470
471    Comments can contain any number of consecutive comment lines.
472
473 ** Fixed Width Areas
474    :PROPERTIES:
475    :CUSTOM_ID: Fixed_Width_Areas
476    :END:
477
478    A "fixed-width line" start with a colon character and a whitespace
479    or an end of line.
480
481    Fixed width areas can contain any number of consecutive fixed-width
482    lines.
483
484 ** Horizontal Rules
485    :PROPERTIES:
486    :CUSTOM_ID: Horizontal_Rules
487    :END:
488
489    A horizontal rule is a line made of at least 5 consecutive hyphens.
490    It can be indented.
491
492 ** Keywords
493    :PROPERTIES:
494    :CUSTOM_ID: Keywords
495    :END:
496
497    Keywords follow the syntax:
498
499    #+BEGIN_EXAMPLE
500    ,#+KEY: VALUE
501    #+END_EXAMPLE
502
503    KEY can contain any non-whitespace character, but it cannot be
504    equal to "CALL" or any affiliated keyword.
505
506    VALUE can contain any character excepted a new line.
507
508    If KEY belongs to ~org-element-document-properties~, VALUE can
509    contain objects.
510
511 ** LaTeX Environments
512    :PROPERTIES:
513    :CUSTOM_ID: LaTeX_Environments
514    :END:
515
516    Pattern for LaTeX environments is:
517
518    #+BEGIN_EXAMPLE
519    \begin{NAME}ARGUMENTS
520    CONTENTS
521    \end{NAME}
522    #+END_EXAMPLE
523
524    NAME is constituted of alpha-numeric characters and may end with an
525    asterisk.
526
527    ARGUMENTS is is any number (including zero) of ARGUMENT constructs
528    like ~[DATA]~ or ~{DATA}~.  DATA can contain any character excepted
529    a new line or the one ending ARGUMENT.
530
531    CONTENTS can contain anything but the "\end{NAME}" string.
532
533 ** Node Properties
534    :PROPERTIES:
535    :CUSTOM_ID: Node_Properties
536    :END:
537
538    Patter for node properties is:
539
540    #+BEGIN_EXAMPLE
541    :PROPERTY: VALUE
542    #+END_EXAMPLE
543
544    PROPERTY can contain any non-whitespace character.  VALUE can
545    contain any character but a new line.
546
547    Node properties can only exist in a [[#Drawers_and_Property_Drawers][property drawers]].
548
549 ** Paragraphs
550    :PROPERTIES:
551    :CUSTOM_ID: Paragraphs
552    :END:
553
554    Paragraphs are the default element, which means that any
555    unrecognized context is a paragraph.
556
557    Empty lines and other elements end paragraphs.
558
559    Paragraphs can contain every type of object.
560
561 ** Table Rows
562    :PROPERTIES:
563    :CUSTOM_ID: Table_Rows
564    :END:
565
566    A table rows is either constituted of a vertical bar and any number
567    of [[#Table_Cells][table cells]] or a vertical bar followed by a hyphen.
568
569    In the first case the table row has the "standard" type.  In the
570    second case, it has the "rule" type.
571
572    Table rows can only exist in [[#Tables][tables]].
573
574 * Objects
575   :PROPERTIES:
576   :CUSTOM_ID: Objects
577   :END:
578
579   Objects can only be found in the following locations:
580
581   - [[#Affiliated_keywords][affiliated keywords]] defined in ~org-element-parsed-keywords~,
582   - [[#Keywords][document properties]],
583   - [[#Headlines_and_Sections][headline]] titles,
584   - [[#Inlinetasks][inlinetask]] titles,
585   - [[#Plain_Lists_and_Items][item]] tags,
586   - [[#Paragraphs][paragraphs]],
587   - [[#Table_Cells][table cells]],
588   - [[#Table_Rows][table rows]], which can only contain table cell
589     objects,
590   - [[#Blocks][verse blocks]].
591     
592   Most objects cannot contain objects.  Those which can will be
593   specified.
594
595 ** Entities and LaTeX Fragments
596    :PROPERTIES:
597    :CUSTOM_ID: Entities_and_LaTeX_Fragments
598    :END:
599
600    An entity follows the pattern:
601
602    #+BEGIN_EXAMPLE
603    \NAME POST
604    #+END_EXAMPLE
605
606    where NAME has a valid association in either ~org-entities~ or
607    ~org-entities-user~.
608
609    POST is the end of line, "{}" string, or a non-alphabetical
610    character.  It isn't separated from NAME by a whitespace character.
611
612    A LaTeX fragment can follow multiple patterns:
613
614    #+BEGIN_EXAMPLE
615    \NAME POST
616    \(CONTENTS\)
617    \[CONTENTS\]
618    $$CONTENTS$$
619    PRE$CHAR$POST
620    PRE$BORDER1 BODY BORDER2$
621    #+END_EXAMPLE
622
623    NAME contains alphabetical characters only and must not have an
624    association in either ~org-entities~ or ~org-entities-user~.
625
626    POST is the same as for entities.
627
628    CONTENTS can contain any character but cannot contain "\)" in the
629    second template or "\]" in the third one.
630
631    PRE is either the beginning of line or a character different from
632    ~$~.
633
634    CHAR is a non-whitespace character different from ~.~, ~,~, ~?~,
635    ~;~, ~'~ or a double quote.
636
637    POST is any of ~-~, ~.~, ~,~, ~?~, ~;~, ~:~, ~'~, a double quote,
638    a whitespace character and the end of line.
639
640    BORDER1 is a non-whitespace character different from ~.~, ~;~, ~.~
641    and ~$~.
642
643    BODY can contain any character excepted ~$~, and may not span over
644    more than 3 lines.
645
646    BORDER2 is any non-whitespace character different from ~,~, ~.~ and
647    ~$~.
648
649    #+ATTR_ASCII: :width 5
650    -----
651
652    #+BEGIN_QUOTE
653    It would introduce incompatibilities with previous Org versions,
654    but support for ~$...$~ (and for symmetry, ~$$...$$~) constructs
655    ought to be removed.
656
657    They are slow to parse, fragile, redundant and imply false
658    positives.  --- ngz
659    #+END_QUOTE
660
661 ** Export Snippets
662    :PROPERTIES:
663    :CUSTOM_ID: Export_Snippets
664    :END:
665
666    Patter for export snippets is:
667
668    #+BEGIN_EXAMPLE
669    @@NAME:VALUE@@
670    #+END_EXAMPLE
671
672    NAME can contain any alpha-numeric character and hyphens.
673
674    VALUE can contain anything but "@@" string.
675
676 ** Footnote References
677    :PROPERTIES:
678    :CUSTOM_ID: Footnote_References
679    :END:
680
681    There are four patterns for footnote references:
682
683    #+BEGIN_EXAMPLE
684    [MARK]
685    [fn:LABEL]
686    [fn:LABEL:DEFINITION]
687    [fn::DEFINITION]
688    #+END_EXAMPLE
689
690    MARK is a number.
691
692    LABEL can contain any word constituent character, hyphens and
693    underscores.
694
695    DEFINITION can contain any character.  Though opening and closing
696    square brackets must be balanced in it.  It can contain any object
697    encountered in a paragraph, even other footnote references.
698
699    If the reference follows the third pattern, it is called an "inline
700    footnote".  If it follows the fourth one, i.e. if LABEL is omitted,
701    it is an "anonymous footnote".
702
703 ** Inline Babel Calls and Source Blocks
704    :PROPERTIES:
705    :CUSTOM_ID: Inline_Babel_Calls_and_Source_Blocks
706    :END:
707
708    Inline Babel calls follow any of the following patterns:
709
710    #+BEGIN_EXAMPLE
711    call_NAME(ARGUMENTS)
712    call_NAME[HEADER](ARGUMENTS)[HEADER]
713    #+END_EXAMPLE
714
715    NAME can contain any character besides ~(~, ~)~ and "\n".
716
717    HEADER can contain any character besides ~]~ and "\n".
718
719    ARGUMENTS can contain any character besides ~)~ and "\n".
720
721    Inline source blocks follow any of the following patterns:
722    
723    #+BEGIN_EXAMPLE
724    src_LANG{BODY}
725    src_LANG[OPTIONS]{BODY}
726    #+END_EXAMPLE
727
728    LANG can contain any non-whitespace character.
729
730    OPTIONS and BODY can contain any character but "\n".
731
732 ** Line Breaks
733    :PROPERTIES:
734    :CUSTOM_ID: Line_Breaks
735    :END:
736
737    A line break consists in "\\SPACE" pattern at the end of an
738    otherwise non-empty line.
739
740    SPACE can contain any number of tabs and spaces, including 0.
741
742 ** Links
743    :PROPERTIES:
744    :CUSTOM_ID: Links
745    :END:
746
747    There are 4 major types of links:
748
749    #+BEGIN_EXAMPLE
750    RADIO                     ("radio" link)
751    <PROTOCOL:PATH>           ("angle" link)
752    PRE PROTOCOL:PATH2 POST   ("plain" link)
753    [[PATH3]DESCRIPTION]      ("regular" link)
754    #+END_EXAMPLE
755
756    RADIO is a string matched by some [[#Targets_and_Radio_Targets][radio target]].  It can contain
757    [[#Entities_and_LaTeX_Fragments][entities]], [[#Entities_and_LaTeX_Fragments][latex fragments]], [[#Subscript_and_Superscript][subscript]] and [[#Subscript_and_Superscript][superscript]] only.
758
759    PROTOCOL is a string among ~org-link-types~.
760
761    PATH can contain any character but ~]~, ~<~, ~>~ and ~\n~.
762
763    PRE and POST are non word constituent.  They can be, respectively,
764    the beginning or the end of a line.
765
766    PATH2 can contain any non-whitespace character excepted ~(~, ~)~,
767    ~<~ and ~>~.  It must end with a word-constituent character, or any
768    non-whitespace non-punctuation character followed by ~/~.
769
770    DESCRIPTION must be enclosed within square brackets.  It can
771    contain any character but square brackets.  Object-wise, it can
772    contain any object found in a paragraph excepted a [[#Footnote_References][footnote
773    reference]], a [[#Targets_and_Radio_Targets][radio target]] and a [[#Line_Breaks][line break]].  It cannot contain
774    another link either, unless it is a plain link.
775
776    DESCRIPTION is optional.
777
778    PATH3 is built according to the following patterns:
779
780    #+BEGIN_EXAMPLE
781    FILENAME           ("file" type)
782    PROTOCOL:PATH4     ("PROTOCOL" type)
783    id:ID              ("id" type)
784    #CUSTOM-ID         ("custom-id" type)
785    (CODEREF)          ("coderef" type)
786    FUZZY              ("fuzzy" type)
787    #+END_EXAMPLE
788
789    FILENAME is a file name, either absolute or relative.
790
791    PATH4 can contain any character besides square brackets.
792
793    ID is constituted of hexadecimal numbers separated with hyphens.
794
795    PATH4, CUSTOM-ID, CODEREF and FUZZY can contain any character
796    besides square brackets.
797
798    #+ATTR_ASCII: :width 5
799    -----
800
801    #+BEGIN_QUOTE
802    I suggest to remove angle links.  If one needs spaces in PATH, she
803    can use standard link syntax instead.
804
805    I also suggest to remove ~org-link-types~ dependency in PROTOCOL
806    and match ~[a-zA-Z]~ instead, for portability.  --- ngz
807    #+END_QUOTE
808
809 ** Macros
810    :PROPERTIES:
811    :CUSTOM_ID: Macros
812    :END:
813
814    Macros follow the pattern:
815
816    #+BEGIN_EXAMPLE
817    {{{NAME(ARGUMENTS)}}}
818    #+END_EXAMPLE
819
820    NAME must start with a letter and can be followed by any number of
821    alpha-numeric characters, hyphens and underscores.
822
823    ARGUMENTS can contain anything but "}}}" string.  Values within
824    ARGUMENTS are separated by commas.  Non-separating commas have to
825    be escaped with a backslash character.
826
827 ** Targets and Radio Targets
828    :PROPERTIES:
829    :CUSTOM_ID: Targets_and_Radio_Targets
830    :END:
831
832    Radio targets follow the pattern:
833
834    #+BEGIN_EXAMPLE
835    <<<CONTENTS>>>
836    #+END_EXAMPLE
837
838    CONTENTS can be any character besides ~<~, ~>~ and "\n".  As far as
839    objects go, it can contain [[#Entities_and_LaTeX_Fragments][entities]], [[#Entities_and_LaTeX_Fragments][latex fragments]], [[#Subscript_and_Superscript][subscript]] and
840    [[#Subscript_and_Superscript][superscript]] only.
841
842    Targets follow the pattern:
843
844    #+BEGIN_EXAMPLE
845    <<TARGET>>
846    #+END_EXAMPLE
847
848    TARGET can contain any character besides ~<~, ~>~ and "\n".  It
849    cannot contain any object.
850
851 ** Statistics Cookies
852    :PROPERTIES:
853    :CUSTOM_ID: Statistics_Cookies
854    :END:
855
856    Statistics cookies follow either pattern:
857
858    #+BEGIN_EXAMPLE
859    [PERCENT%]
860    [NUM1/NUM2]
861    #+END_EXAMPLE
862
863    PERCENT, NUM1 and NUM2 are numbers or the empty string.
864
865 ** Subscript and Superscript
866    :PROPERTIES:
867    :CUSTOM_ID: Subscript_and_Superscript
868    :END:
869
870    Pattern for subscript is:
871
872    #+BEGIN_EXAMPLE
873    CHAR_SCRIPT
874    #+END_EXAMPLE
875
876    Pattern for superscript is:
877
878    #+BEGIN_EXAMPLE
879    CHAR^SCRIPT
880    #+END_EXAMPLE
881
882    CHAR is any non-whitespace character.
883
884    SCRIPT can be ~*~, a string made of word-constituent characters
885    maybe preceded by a plus or a minus sign, an expression enclosed in
886    parenthesis (resp. curly brackets) containing balanced parenthesis
887    (resp. curly brackets).
888
889 ** Table Cells
890    :PROPERTIES:
891    :CUSTOM_ID: Table_Cells
892    :END:
893
894    Table cells follow the pattern:
895
896    #+BEGIN_EXAMPLE
897    CONTENTS|
898    #+END_EXAMPLE
899
900    CONTENTS can contain any character excepted a vertical bar.
901
902 ** Timestamps
903    :PROPERTIES:
904    :CUSTOM_ID: Timestamp
905    :END:
906
907    There are seven possible patterns for timestamps:
908    
909    #+BEGIN_EXAMPLE
910    <%%(SEXP)>                                   (diary)
911    <DATE TIME REPEATER-OR-DELAY>                                  (active)
912    [DATE TIME REPEATER-OR-DELAY]                                  (inactive)
913    <DATE TIME REPEATER-OR-DELAY>--<DATE TIME REPEATER-OR-DELAY>   (active range)
914    <DATE TIME-TIME REPEATER-OR-DELAY>                             (active range)
915    [DATE TIME REPEATER-OR-DELAY]--[DATE TIME REPEATER-OR-DELAY]   (inactive range)
916    [DATE TIME-TIME REPEATER-OR-DELAY]                             (inactive range)
917    #+END_EXAMPLE
918
919    SEXP can contain any character excepted ~>~ and ~\n~.
920
921    DATE follows the pattern:
922
923    #+BEGIN_EXAMPLE
924    YYYY-MM-DD DAYNAME
925    #+END_EXAMPLE
926
927    Y, M and D are digits.  DAYNAME can contain any non
928    whitespace-character besides ~+~, ~-~, ~]~, ~>~, a digit or ~\n~.
929
930    TIME follows the pattern =H:MM~.  H can be one or two digit long
931    and can start with 0.
932
933    REPEATER-OR-DELAY follows the pattern:
934
935    #+BEGIN_EXAMPLE
936    MARK VALUE UNIT
937    #+END_EXAMPLE
938
939    MARK is ~+~ (cumulate type), ~++~ (catch-up type) or ~.+~ (restart
940    type) for a repeater, and ~-~ (all type) or ~--~ (first type) for
941    warning delays.
942
943    VALUE is a number.
944
945    UNIT is a character among ~h~ (hour), ~d~ (day), ~w~ (week), ~m~
946    (month), ~y~ (year).
947
948    MARK, VALUE and UNIT are not separated by whitespace characters.
949
950    There can be two REPEATER-OR-DELAY in the timestamp: one as
951    a repeater and one as a warning delay.
952
953 ** Text Markup
954    :PROPERTIES:
955    :CUSTOM_ID: Emphasis_Markers
956    :END:
957
958    Text markup follows the pattern:
959
960    #+BEGIN_EXAMPLE
961    PRE MARKER CONTENTS MARKER POST
962    #+END_EXAMPLE
963
964    PRE is a whitespace character, ~(~, ~{~ ~'~ or a double quote.  It
965    can also be a beginning of line.
966
967    MARKER is a character among ~*~ (bold), ~=~ (verbatim), ~/~
968    (italic), ~+~ (strike-through), ~_~ (underline), ~~~ (code).
969
970    CONTENTS is a string following the pattern:
971
972    #+BEGIN_EXAMPLE
973    BORDER BODY BORDER
974    #+END_EXAMPLE
975
976    BORDER can be any non-whitespace character excepted ~,~, ~'~ or
977    a double quote.
978
979    BODY can contain contain any character but may not span over more
980    than 3 lines.
981
982    BORDER and BODY are not separated by whitespaces.
983
984    CONTENTS can contain any object encountered in a paragraph when
985    markup is "bold", "italic", "strike-through" or "underline".
986
987    POST is a whitespace character, ~-~, ~.~, ~,~, ~:~, ~!~, ~?~, ~'~,
988    ~)~, ~}~ or a double quote.  It can also be an end of line.
989
990    PRE, MARKER, CONTENTS, MARKER and POST are not separated by
991    whitespace characters.
992
993    #+ATTR_ASCII: :width 5
994    -----
995    
996    #+BEGIN_QUOTE
997    All of this is wrong if ~org-emphasis-regexp-components~ or
998    ~org-emphasis-alist~ are modified.
999
1000    This should really be simplified and made persistent (i.e. no
1001    defcustom allowed).  Otherwise, portability and parsing are
1002    jokes.
1003
1004    Also, CONTENTS should be anything within code and verbatim
1005    emphasis, by definition.  --- ngz
1006    #+END_QUOTE
1007
1008 * Footnotes
1009
1010 [fn:1] In particular, the parser requires stars at column 0 to be
1011 quoted by a comma when they do not define a headline.
1012
1013 [fn:2] It also means that only headlines and sections can be
1014 recognized just by looking at the beginning of the line.
1015
1016 As a consequence, using ~org-element-at-point~ or
1017 ~org-element-context~ will move up to the parent headline, and parse
1018 top-down from there until context around is found.
1019
1020
1021 # Local Variables:
1022 # sentence-end-double-space: t
1023 # End: