09a699cc2354fbc9f0800bd209b17a6a9c02666c
[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 ~org-comment-string~,
77   the headline will be considered as "commented".  If that first word
78   is ~org-quote-string~, it will be considered as "quoted".  In both
79   situations, case is 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 ~org-archive-tag~ 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 has to either be "PROPERTIES" or belong to ~org-drawers~ list.
216
217    If NAME is "PROPERTIES", the drawer will become a "property
218    drawer".
219
220    In a property drawers, CONTENTS can only contain [[#Node_Properties][node property]]
221    elements.  Otherwise it can contain any element but another drawer
222    or property drawer.
223
224    #+ATTR_ASCII: :width 5
225    -----
226
227    It would be nice if users hadn't to register drawers names before
228    using them in ~org-drawers~ (or through the ~#+DRAWERS:~ keyword).
229    Anything starting with ~^[ \t]*:\w+:[ \t]$~ and ending with
230    ~^[ \t]*:END:[ \t]$~ could be considered as a drawer.  --- ngz
231
232 ** Dynamic Blocks
233    :PROPERTIES:
234    :CUSTOM_ID: Dynamic_Blocks
235    :END:
236
237    Pattern for dynamic blocks is:
238
239    #+BEGIN_EXAMPLE
240    ,#+BEGIN: NAME PARAMETERS
241    CONTENTS
242    ,#+END:
243    #+END_EXAMPLE
244
245    NAME cannot contain any whitespace character.
246
247    PARAMETERS can contain any character and can be omitted.
248
249 ** Footnote Definitions
250    :PROPERTIES:
251    :CUSTOM_ID: Footnote_Definitions
252    :END:
253
254    Pattern for footnote definitions is:
255
256    #+BEGIN_EXAMPLE
257    [LABEL] CONTENTS
258    #+END_EXAMPLE
259
260    It must start at column 0.
261
262    LABEL is either a number or follows the pattern "fn:WORD", where
263    word can contain any word-constituent character, hyphens and
264    underscore characters.
265
266    CONTENTS can contain any element excepted another footnote
267    definition.  It ends at the next footnote definition, the next
268    headline, two consecutive empty lines or the end of buffer.
269
270 ** Inlinetasks
271    :PROPERTIES:
272    :CUSTOM_ID: Inlinetasks
273    :END:
274
275    Inlinetasks are defined by ~org-inlinetask-min-level~ contiguous
276    asterisk characters starting at column 0, followed by a whitespace
277    character.
278
279    Optionally, inlinetasks can be ended with a string constituted of
280    ~org-inlinetask-min-level~ contiguous characters starting at column
281    0, followed by a space and the "END" string.
282
283    Inlinetasks are recognized only after =org-inlinetask= library is
284    loaded.
285
286 ** Plain Lists and Items
287    :PROPERTIES:
288    :CUSTOM_ID: Plain_Lists_and_Items
289    :END:
290
291    Items are defined by a line starting with the following pattern:
292    "BULLET COUNTER-SET CHECK-BOX TAG", in which only BULLET is
293    mandatory.
294
295    BULLET is either an asterisk, a hyphen, a plus sign character or
296    follows either the pattern "COUNTER." or "COUNTER)".  In any case,
297    BULLET is follwed by a whitespace character or line ending.
298
299    COUNTER can be a number or a single letter.
300
301    COUNTER-SET follows the pattern [@COUNTER].
302
303    CHECK-BOX is either a single whitespace character, a "X" character
304    or a hyphen, enclosed within square brackets.
305
306    TAG follows "TAG-TEXT ::" pattern, where TAG-TEXT can contain any
307    character but a new line.
308
309    An item ends before the next item, the first line less or equally
310    indented than its starting line, or two consecutive empty lines.
311    Indentation of lines within other greater elements do not count,
312    neither do inlinetasks boundaries.
313
314    A plain list is a set of consecutive items of the same indentation.
315    It can only directly contain items.
316
317    If first item in a plain list has a counter in its bullet, the
318    plain list will be an "ordered plain-list".  If it contains a tag,
319    it will be a "descriptive list".  Otherwise, it will be an
320    "unordered list".  List types are mutually exclusive.
321
322    For example, consider the following excerpt of an Org document:
323
324    #+BEGIN_EXAMPLE
325    1. item 1
326    2. [X] item 2
327       - some tag :: item 2.1
328    #+END_EXAMPLE
329
330    Its internal structure is as follows:
331
332    #+BEGIN_EXAMPLE
333    (ordered-plain-list
334     (item)
335     (item
336      (descriptive-plain-list
337       (item))))
338    #+END_EXAMPLE
339
340 ** Tables
341    :PROPERTIES:
342    :CUSTOM_ID: Tables
343    :END:
344
345    Tables start at lines beginning with either a vertical bar or the
346    "+-" string followed by plus or minus signs only, assuming they are
347    not preceded with lines of the same type.  These lines can be
348    indented.
349
350    A table starting with a vertical bar has "org" type.  Otherwise it
351    has "table.el" type.
352
353    Org tables end at the first line not starting with a vertical bar.
354    Table.el tables end at the first line not starting with either
355    a vertical line or a plus sign.  Such lines can be indented.
356
357    An org table can only contain table rows.  A table.el table does
358    not contain anything.
359
360 * Elements
361   :PROPERTIES:
362   :CUSTOM_ID: Elements
363   :END:
364
365   Elements cannot contain any other element.
366
367   Only [[#Keywords][keywords]] whose name belongs to
368   ~org-element-document-properties~, [[#Blocks][verse blocks]] , [[#Paragraphs][paragraphs]] and
369   [[#Table_Rows][table rows]] can contain objects.
370
371 ** Babel Call
372    :PROPERTIES:
373    :CUSTOM_ID: Babel_Call
374    :END:
375
376    Pattern for babel calls is:
377
378    #+BEGIN_EXAMPLE
379    ,#+CALL: VALUE
380    #+END_EXAMPLE
381
382    VALUE is optional.  It can contain any character but a new line.
383
384 ** Blocks
385    :PROPERTIES:
386    :CUSTOM_ID: Blocks
387    :END:
388
389    Like [[#Greater_Blocks][greater blocks]], pattern for blocks is:
390
391    #+BEGIN_EXAMPLE
392    ,#+BEGIN_NAME DATA
393    CONTENTS
394    ,#+END_NAME
395    #+END_EXAMPLE
396
397    NAME cannot contain any whitespace character.
398
399    If NAME is "COMMENT", it will be a "comment block".  If it is
400    "EXAMPLE", it will be an "example block".  If it is "SRC", it will
401    be a "source block".  If it is "VERSE", it will be a "verse block".
402
403    If NAME is a string matching the name of any export back-end
404    loaded, the block will be an "export block".
405
406    DATA can contain any character but a new line.  It can be ommitted,
407    unless the block is a "source block".  In this case, it must follow
408    the pattern "LANGUAGE SWITCHES ARGUMENTS", where SWITCHES and
409    ARGUMENTS are optional.
410
411    LANGUAGE cannot contain any whitespace character.
412
413    SWITCHES is made of any number of "SWITCH" patterns, separated by
414    blank lines.
415
416    A SWITCH pattern is either "-l "FORMAT"", where FORMAT can contain
417    any character but a double quote and a new line, "-S" or "+S",
418    where S stands for a single letter.
419
420    ARGUMENTS can contain any character but a new line.
421
422    CONTENTS can contain any character, including new lines.  Though it
423    will only contain Org objects if the block is a verse block.
424    Otherwise, contents will not be parsed.
425
426 ** Clock, Diary Sexp and Planning
427    :PROPERTIES:
428    :CUSTOM_ID: Clock,_Diary_Sexp_and_Planning
429    :END:
430
431    A clock follows the pattern:
432    
433    #+BEGIN_EXAMPLE
434    CLOCK: TIMESTAMP DURATION
435    #+END_EXAMPLE
436
437    Both TIMESTAMP and DURATION are optional.
438
439    TIMESTAMP is a [[#Timestamp][timestamp]] object.
440
441    DURATION follows the pattern:
442
443    #+BEGIN_EXAMPLE
444    => HH:MM
445    #+END_EXAMPLE
446
447    HH is a number containing any number of digits.  MM is a two digit
448    numbers.
449
450    A diary sexp is a line starting at column 0 with "%%(" string.  It
451    can then contain any character besides a new line.
452
453    A planning is a line filled with more at most three INFO parts,
454    where each INFO part follows the pattern:
455
456    #+BEGIN_EXAMPLE
457    KEYWORD: TIMESTAMP
458    #+END_EXAMPLE
459
460    KEYWORD is a string among ~org-deadline-string~,
461    ~org-scheduled-string~ and ~org-closed-string~.  TIMESTAMP is is
462    a [[#Timestamp][timestamp]] object.
463
464    Even though a planning element can exist anywhere in a section or
465    a greater element, it will only affect the headline containing the
466    section if it is put on the line following that headline.
467
468 ** Comments
469    :PROPERTIES:
470    :CUSTOM_ID: Comments
471    :END:
472
473    A "comment line" starts with a hash signe and a whitespace
474    character or an end of line.
475
476    Comments can contain any number of consecutive comment lines.
477
478 ** Fixed Width Areas
479    :PROPERTIES:
480    :CUSTOM_ID: Fixed_Width_Areas
481    :END:
482
483    A "fixed-width line" start with a colon character and a whitespace
484    or an end of line.
485
486    Fixed width areas can contain any number of consecutive fixed-width
487    lines.
488
489 ** Horizontal Rules
490    :PROPERTIES:
491    :CUSTOM_ID: Horizontal_Rules
492    :END:
493
494    A horizontal rule is a line made of at least 5 consecutive hyphens.
495    It can be indented.
496
497 ** Keywords
498    :PROPERTIES:
499    :CUSTOM_ID: Keywords
500    :END:
501
502    Keywords follow the syntax:
503
504    #+BEGIN_EXAMPLE
505    ,#+KEY: VALUE
506    #+END_EXAMPLE
507
508    KEY can contain any non-whitespace character, but it cannot be
509    equal to "CALL" or any affiliated keyword.
510
511    VALUE can contain any character excepted a new line.
512
513    If KEY belongs to ~org-element-document-properties~, VALUE can
514    contain objects.
515
516 ** LaTeX Environments
517    :PROPERTIES:
518    :CUSTOM_ID: LaTeX_Environments
519    :END:
520
521    Pattern for LaTeX environments is:
522
523    #+BEGIN_EXAMPLE
524    \begin{NAME}
525    CONTENTS
526    \end{NAME}
527    #+END_EXAMPLE
528
529    NAME is constituted of alpha-numeric characters and may end with an
530    asterisk.
531
532    CONTENTS can contain anything but the "\end{NAME}" string.
533
534 ** Node Properties
535    :PROPERTIES:
536    :CUSTOM_ID: Node_Properties
537    :END:
538
539    Patter for node properties is:
540
541    #+BEGIN_EXAMPLE
542    :PROPERTY: VALUE
543    #+END_EXAMPLE
544
545    PROPERTY can contain any non-whitespace character.  VALUE can
546    contain any character but a new line.
547
548    Node properties can only exist in a [[#Drawers_and_Property_Drawers][property drawers]].
549
550 ** Paragraphs
551    :PROPERTIES:
552    :CUSTOM_ID: Paragraphs
553    :END:
554
555    Paragraphs are the default element, which means that any
556    unrecognized context is a paragraph.
557
558    Empty lines and other elements end paragraphs.
559
560    Paragraphs can contain every type of object.
561
562 ** Table Rows
563    :PROPERTIES:
564    :CUSTOM_ID: Table_Rows
565    :END:
566
567    A table rows is either constituted of a vertical bar and any number
568    of [[#Table_Cells][table cells]] or a vertical bar followed by a hyphen.
569
570    In the first case the table row has the "standard" type.  In the
571    second case, it has the "rule" type.
572
573    Table rows can only exist in [[#Tables][tables]].
574
575 * Objects
576   :PROPERTIES:
577   :CUSTOM_ID: Objects
578   :END:
579
580   Objects can only be found in the following locations:
581
582   - [[#Affiliated_keywords][affiliated keywords]] defined in ~org-element-parsed-keywords~,
583   - [[#Keywords][document properties]],
584   - [[#Headlines_and_Sections][headline]] titles,
585   - [[#Inlinetasks][inlinetask]] titles,
586   - [[#Plain_Lists_and_Items][item]] tags,
587   - [[#Paragraphs][paragraphs]],
588   - [[#Table_Cells][table cells]],
589   - [[#Table_Rows][table rows]], which can only contain table cell
590     objects,
591   - [[#Blocks][verse blocks]].
592     
593   Most objects cannot contain objects.  Those which can will be
594   specified.
595
596 ** Entities and LaTeX Fragments
597    :PROPERTIES:
598    :CUSTOM_ID: Entities_and_LaTeX_Fragments
599    :END:
600
601    An entity follows the pattern:
602
603    #+BEGIN_EXAMPLE
604    \NAME POST
605    #+END_EXAMPLE
606
607    where NAME has a valid association in either ~org-entities~ or
608    ~org-entities-user~.
609
610    POST is the end of line, "{}" string, or a non-alphabetical
611    character.  It isn't separated from NAME by a whitespace character.
612
613    A LaTeX fragment can follow multiple patterns:
614
615    #+BEGIN_EXAMPLE
616    \NAME POST
617    \(CONTENTS\)
618    \[CONTENTS\]
619    $$CONTENTS$$
620    PRE$CHAR$POST
621    PRE$BORDER1 BODY BORDER2$
622    #+END_EXAMPLE
623
624    NAME contains alphabetical characters only and must not have an
625    association in either ~org-entities~ or ~org-entities-user~.
626
627    POST is the same as for entities.
628
629    CONTENTS can contain any character but cannot contain "\)" in the
630    second template or "\]" in the third one.
631
632    PRE is either the beginning of line or a character different from
633    ~$~.
634
635    CHAR is a non-whitespace character different from ~.~, ~,~, ~?~,
636    ~;~, ~'~ or a double quote.
637
638    POST is any of ~-~, ~.~, ~,~, ~?~, ~;~, ~:~, ~'~, a double quote,
639    a whitespace character and the end of line.
640
641    BORDER1 is a non-whitespace character different from ~.~, ~;~, ~.~
642    and ~$~.
643
644    BODY can contain any character excepted ~$~, and may not span over
645    more than 3 lines.
646
647    BORDER2 is any non-whitespace character different from ~,~, ~.~ and
648    ~$~.
649
650    #+ATTR_ASCII: :width 5
651    -----
652
653    #+BEGIN_QUOTE
654    It would introduce incompatibilities with previous Org versions,
655    but support for "$...$" (and for symmetry, ~$$...$$~) constructs
656    ought to be removed.
657
658    They are slow to parse, fragile, redundant, imply false positives
659    and do not look good in LaTeX output anyway.  Even the LaTeX
660    community suggests to use ~\(...\)~ over ~$...$~.  --- ngz
661    #+END_QUOTE
662
663 ** Export Snippets
664    :PROPERTIES:
665    :CUSTOM_ID: Export_Snippets
666    :END:
667
668    Patter for export snippets is:
669
670    #+BEGIN_EXAMPLE
671    @@NAME:VALUE@@
672    #+END_EXAMPLE
673
674    NAME can contain any alpha-numeric character and hyphens.
675
676    VALUE can contain anything but "@@" string.
677
678 ** Footnote References
679    :PROPERTIES:
680    :CUSTOM_ID: Footnote_References
681    :END:
682
683    There are four patterns for footnote references:
684
685    #+BEGIN_EXAMPLE
686    [MARK]
687    [fn:LABEL]
688    [fn:LABEL:DEFINITION]
689    [fn::DEFINITION]
690    #+END_EXAMPLE
691
692    MARK is a number.
693
694    LABEL can contain any word constituent character, hyphens and
695    underscores.
696
697    DEFINITION can contain any character.  Though opening and closing
698    square brackets must be balanced in it.  It can contain any object
699    encountered in a paragraph, even other footnote references.
700
701    If the reference follows the third pattern, it is called an "inline
702    footnote".  If it follows the fourth one, i.e. if LABEL is omitted,
703    it is an "anonymous footnote".
704
705 ** Inline Babel Calls and Source Blocks
706    :PROPERTIES:
707    :CUSTOM_ID: Inline_Babel_Calls_and_Source_Blocks
708    :END:
709
710    Inline Babel calls follow any of the following patterns:
711
712    #+BEGIN_EXAMPLE
713    call_NAME(ARGUMENTS)
714    call_NAME[HEADER](ARGUMENTS)[HEADER]
715    #+END_EXAMPLE
716
717    NAME can contain any character besides ~(~, ~)~ and "\n".
718
719    HEADER can contain any character besides ~]~ and "\n".
720
721    ARGUMENTS can contain any character besides ~)~ and "\n".
722
723    Inline source blocks follow any of the following patterns:
724    
725    #+BEGIN_EXAMPLE
726    src_LANG{BODY}
727    src_LANG[OPTIONS]{BODY}
728    #+END_EXAMPLE
729
730    LANG can contain any non-whitespace character.
731
732    OPTIONS and BODY can contain any character but "\n".
733
734 ** Line Breaks
735    :PROPERTIES:
736    :CUSTOM_ID: Line_Breaks
737    :END:
738
739    A line break consists in "\\SPACE" pattern at the end of an
740    otherwise non-empty line.
741
742    SPACE can contain any number of tabs and spaces, including 0.
743
744 ** Links
745    :PROPERTIES:
746    :CUSTOM_ID: Links
747    :END:
748
749    There are 4 major types of links:
750
751    #+BEGIN_EXAMPLE
752    RADIO                     ("radio" link)
753    <PROTOCOL:PATH>           ("angle" link)
754    PRE PROTOCOL:PATH2 POST   ("plain" link)
755    [[PATH3]DESCRIPTION]      ("regular" link)
756    #+END_EXAMPLE
757
758    RADIO is a string matched by some [[#Targets_and_Radio_Targets][radio target]].  It can contain
759    [[#Entities_and_LaTeX_Fragments][entities]], [[#Entities_and_LaTeX_Fragments][latex fragments]], [[#Subscript_and_Superscript][subscript]] and [[#Subscript_and_Superscript][superscript]] only.
760
761    PROTOCOL is a string among ~org-link-types~.
762
763    PATH can contain any character but ~]~, ~<~, ~>~ and ~\n~.
764
765    PRE and POST are non word constituent.  They can be, respectively,
766    the beginning or the end of a line.
767
768    PATH2 can contain any non-whitespace character excepted ~(~, ~)~,
769    ~<~ and ~>~.  It must end with a word-constituent character, or any
770    non-whitespace non-punctuation character followed by ~/~.
771
772    DESCRIPTION must be enclosed within square brackets.  It can
773    contain any character but square brackets.  Object-wise, it can
774    contain any object found in a paragraph excepted a [[#Footnote_References][footnote
775    reference]], a [[#Targets_and_Radio_Targets][radio target]] and a [[#Line_Breaks][line break]].  It cannot contain
776    another link either, unless it is a plain link.
777
778    DESCRIPTION is optional.
779
780    PATH3 is built according to the following patterns:
781
782    #+BEGIN_EXAMPLE
783    FILENAME           ("file" type)
784    PROTOCOL:PATH4     ("PROTOCOL" type)
785    id:ID              ("id" type)
786    #CUSTOM-ID         ("custom-id" type)
787    (CODEREF)          ("coderef" type)
788    FUZZY              ("fuzzy" type)
789    #+END_EXAMPLE
790
791    FILENAME is a file name, either absolute or relative.
792
793    PATH4 can contain any character besides square brackets.
794
795    ID is constituted of hexadecimal numbers separated with hyphens.
796
797    PATH4, CUSTOM-ID, CODEREF and FUZZY can contain any character
798    besides square brackets.
799
800    #+ATTR_ASCII: :width 5
801    -----
802
803    #+BEGIN_QUOTE
804    I suggest to remove angle links.  If one needs spaces in PATH, she
805    can use standard link syntax instead.
806
807    I also suggest to remove ~org-link-types~ dependency in PROTOCOL
808    and match ~[a-zA-Z]~ instead, for portability.  --- ngz
809    #+END_QUOTE
810
811 ** Macros
812    :PROPERTIES:
813    :CUSTOM_ID: Macros
814    :END:
815
816    Macros follow the pattern:
817
818    #+BEGIN_EXAMPLE
819    {{{NAME(ARGUMENTS)}}}
820    #+END_EXAMPLE
821
822    NAME must start with a letter and can be followed by any number of
823    alpha-numeric characters, hyphens and underscores.
824
825    ARGUMENTS can contain anything but "}}}" string.  Values within
826    ARGUMENTS are separated by commas.  Non-separating commas have to
827    be escaped with a backslash character.
828
829 ** Targets and Radio Targets
830    :PROPERTIES:
831    :CUSTOM_ID: Targets_and_Radio_Targets
832    :END:
833
834    Radio targets follow the pattern:
835
836    #+BEGIN_EXAMPLE
837    <<<CONTENTS>>>
838    #+END_EXAMPLE
839
840    CONTENTS can be any character besides ~<~, ~>~ and "\n".  As far as
841    objects go, it can contain [[#Entities_and_LaTeX_Fragments][entities]], [[#Entities_and_LaTeX_Fragments][latex fragments]], [[#Subscript_and_Superscript][subscript]] and
842    [[#Subscript_and_Superscript][superscript]] only.
843
844    Targets follow the pattern:
845
846    #+BEGIN_EXAMPLE
847    <<TARGET>>
848    #+END_EXAMPLE
849
850    TARGET can contain any character besides ~<~, ~>~ and "\n".  It
851    cannot contain any object.
852
853 ** Statistics Cookies
854    :PROPERTIES:
855    :CUSTOM_ID: Statistics_Cookies
856    :END:
857
858    Statistics cookies follow either pattern:
859
860    #+BEGIN_EXAMPLE
861    [PERCENT%]
862    [NUM1/NUM2]
863    #+END_EXAMPLE
864
865    PERCENT, NUM1 and NUM2 are numbers or the empty string.
866
867 ** Subscript and Superscript
868    :PROPERTIES:
869    :CUSTOM_ID: Subscript_and_Superscript
870    :END:
871
872    Pattern for subscript is:
873
874    #+BEGIN_EXAMPLE
875    CHAR_SCRIPT
876    #+END_EXAMPLE
877
878    Pattern for superscript is:
879
880    #+BEGIN_EXAMPLE
881    CHAR^SCRIPT
882    #+END_EXAMPLE
883
884    CHAR is any non-whitespace character.
885
886    SCRIPT can be ~*~, a string made of word-constituent characters
887    maybe preceded by a plus or a minus sign, an expression enclosed in
888    parenthesis (resp. curly brackets) containing balanced parenthesis
889    (resp. curly brackets).
890
891 ** Table Cells
892    :PROPERTIES:
893    :CUSTOM_ID: Table_Cells
894    :END:
895
896    Table cells follow the pattern:
897
898    #+BEGIN_EXAMPLE
899    CONTENTS|
900    #+END_EXAMPLE
901
902    CONTENTS can contain any character excepted a vertical bar.
903
904 ** Timestamps
905    :PROPERTIES:
906    :CUSTOM_ID: Timestamp
907    :END:
908
909    There are seven possible patterns for timestamps:
910    
911    #+BEGIN_EXAMPLE
912    <%%(SEXP)>                                     (diary)
913    <DATE TIME REPEATER>                         (active)
914    [DATE TIME REPEATER]                         (inactive)
915    <DATE TIME REPEATER>--<DATE TIME REPEATER>   (active range)
916    <DATE TIME-TIME REPEATER>                    (active range)
917    [DATE TIME REPEATER]--[DATE TIME REPEATER]   (inactive range)
918    [DATE TIME-TIME REPEATER]                    (inactive range)
919    #+END_EXAMPLE
920
921    SEXP can contain any character excepted ~>~ and ~\n~.
922
923    DATE follows the pattern:
924
925    #+BEGIN_EXAMPLE
926    YYYY-MM-DD DAYNAME
927    #+END_EXAMPLE
928
929    Y, M and D are digits.  DAYNAME can contain any non
930    whitespace-character besides ~+~, ~-~, ~]~, ~>~, a digit or ~\n~.
931
932    TIME follows the pattern =H:MM~.  H can be one or two digit long
933    and can start with 0.
934
935    REPEATER follows the patter:
936
937    #+BEGIN_EXAMPLE
938    MARK VALUE UNIT
939    #+END_EXAMPLE
940
941    MARK is ~+~ (cumulate type), ~++~ (catch-up type) or ~.+~ (restart
942    type).
943
944    VALUE is a number.
945
946    UNIT is a character among ~h~ (hour), ~d~ (day), ~w~ (week), ~m~
947    (month), ~y~ (year).
948
949    MARK, VALUE and UNIT are not separated by whitespace characters.
950
951 ** Text Markup
952    :PROPERTIES:
953    :CUSTOM_ID: Emphasis_Markers
954    :END:
955
956    Text markup follows the pattern:
957
958    #+BEGIN_EXAMPLE
959    PRE MARKER CONTENTS MARKER POST
960    #+END_EXAMPLE
961
962    PRE is a whitespace character, ~(~, ~{~ ~'~ or a double quote.  It
963    can also be a beginning of line.
964
965    MARKER is a character among ~*~ (bold), ~=~ (verbatim), ~/~
966    (italic), ~+~ (strike-through), ~_~ (underline), ~~~ (code).
967
968    CONTENTS is a string following the pattern:
969
970    #+BEGIN_EXAMPLE
971    BORDER BODY BORDER
972    #+END_EXAMPLE
973
974    BORDER can be any non-whitespace character excepted ~,~, ~'~ or
975    a double quote.
976
977    BODY can contain contain any character but may not span over more
978    than 3 lines.
979
980    BORDER and BODY are not separated by whitespaces.
981
982    CONTENTS can contain any object encountered in a paragraph when
983    markup is "bold", "italic", "strike-through" or "underline".
984
985    POST is a whitespace character, ~-~, ~.~, ~,~, ~:~, ~!~, ~?~, ~'~,
986    ~)~, ~}~ or a double quote.  It can also be an end of line.
987
988    PRE, MARKER, CONTENTS, MARKER and POST are not separated by
989    whitespace characters.
990
991    #+ATTR_ASCII: :width 5
992    -----
993    
994    #+BEGIN_QUOTE
995    All of this is wrong if ~org-emphasis-regexp-components~ or
996    ~org-emphasis-alist~ are modified.
997
998    This should really be simplified and made persistent (i.e. no
999    defcustom allowed).  Otherwise, portability and parsing are
1000    jokes.
1001
1002    Also, CONTENTS should be anything within code and verbatim
1003    emphasis, by definition.  --- ngz
1004    #+END_QUOTE
1005
1006 * Footnotes
1007
1008 [fn:1] In particular, the parser requires stars at column 0 to be
1009 quoted by a comma when they do not define a headline.
1010
1011 [fn:2] It also means that only headlines and sections can be
1012 recognized just by looking at the beginning of the line.
1013
1014 As a consequence, using ~org-element-at-point~ or
1015 ~org-element-context~ will move up to the parent headline, and parse
1016 top-down from there until context around is found.
1017
1018
1019 # Local Variables:
1020 # sentence-end-double-space: t
1021 # End: