1# Copyright 2010-2020 Free Software Foundation, Inc.
2#
3# This file is part of GNU Texinfo.
4#
5# GNU Texinfo is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation; either version 3 of the License,
8# or (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18# Information from tp/Texinfo/Common.pm
19
20# Not in Common.pm
21value                   brace
22
23##############################################################
24# no brace commands - single letter commands
25
26*                       nobrace
27# space
28\x20                    nobrace
29\t                      nobrace
30\n                      nobrace
31-                       nobrace
32|                       nobrace
33/                       nobrace
34:                       nobrace
35!                       nobrace
36?                       nobrace
37.                       nobrace
38@                       nobrace
39&                       nobrace
40}                       nobrace
41{                       nobrace
42\\                      nobrace
43
44##########################################################
45#
46# line commands
47#
48##########################################################
49node                    line                            LINE_line
50bye                     line                            LINE_skipline
51end                     line                            LINE_text
52# set, clear
53set                     line                            LINE_special
54clear                   line                            LINE_special
55unmacro                 line                            LINE_special
56# comments
57c                       line                            LINE_lineraw
58comment                 line                            LINE_lineraw
59# special
60definfoenclose          line,deprecated                 3
61alias                   line                            2
62# number of arguments is not known in advance.
63columnfractions         line                            1
64# file names
65setfilename             line,global_unique              LINE_text
66verbatiminclude         line                            LINE_text
67include                 line                            LINE_text
68
69raisesections           line                            LINE_skipline
70lowersections           line                            LINE_skipline
71contents                line,global                     LINE_skipline
72shortcontents           line,global                     LINE_skipline
73summarycontents         line,global                     LINE_skipline
74insertcopying           line,global                     LINE_skipline
75clickstyle              line,global                     LINE_special
76# more relevant in preamble
77documentencoding        line,global                     LINE_text
78novalidate              line,global_unique              LINE_skipline
79dircategory             line                            LINE_line
80# with direntry is significant
81pagesizes               line,global_unique              LINE_line
82# or one? 200mm,150mm 11.5in
83finalout                line                            LINE_skipline
84paragraphindent         line,global                     1
85# or a number and forbids anything else on the line
86firstparagraphindent    line,global                     1
87frenchspacing           line,global                     1
88codequoteundirected     line,global                     1
89codequotebacktick       line,global                     1
90xrefautomaticsectiontitle line,global                   1
91deftypefnnewline        line,global                     1
92fonttextsize            line,global_unique              1
93allowcodebreaks         line,global                     1
94exampleindent           line,global                     1
95footnotestyle           line,global_unique              1
96urefbreakstyle          line,global                     1
97afourpaper              line                            LINE_skipline
98afivepaper              line                            LINE_skipline
99afourlatex              line                            LINE_skipline
100afourwide               line                            LINE_skipline
101bsixpaper               line                            LINE_skipline
102headings                line,global                     1
103setchapternewpage       line,global_unique              1
104
105# only relevant in TeX, and special
106everyheading            line,global_unique              LINE_lineraw
107everyfooting            line,global_unique              LINE_lineraw
108evenheading             line,global_unique              LINE_lineraw
109evenfooting             line,global_unique              LINE_lineraw
110oddheading              line,global_unique              LINE_lineraw
111oddfooting              line,global_unique              LINE_lineraw
112
113smallbook               line                            LINE_skipline
114syncodeindex            line                            2
115synindex                line                            2
116defindex                line                            1
117defcodeindex            line                            1
118documentlanguage        line,global                     LINE_text
119kbdinputstyle           line,global                     1
120everyheadingmarks       line,global_unique              1
121everyfootingmarks       line,global_unique              1
122evenheadingmarks        line,global_unique              1
123oddheadingmarks         line,global_unique              1
124evenfootingmarks        line,global_unique              1
125oddfootingmarks         line,global_unique              1
126
127# formatting
128center                  line                            LINE_line
129printindex              line,global                     1
130listoffloats            line,global                     LINE_line
131# especially in titlepage
132#  shorttitle
133shorttitlepage          line,global_unique              LINE_line
134settitle                line,global_unique              LINE_line
135author                  line,global                     LINE_line
136subtitle                line,global                     LINE_line
137title                   line,global_unique              LINE_line
138sp                      line                            1
139page                    line                            LINE_skipline
140need                    line                            1
141
142# not valid for info (should be in @iftex)
143vskip                   line                            LINE_lineraw
144
145exdent                  line                            LINE_line
146
147item_LINE               line                            LINE_line
148itemx                   line                            LINE_line
149
150subentry                line                            LINE_line
151
152##########################################################
153#
154# miscellaneous commands
155#
156##########################################################
157
158# formatting
159noindent                other                           OTHER_skipspace
160indent                  other                           OTHER_skipspace
161headitem                other                           OTHER_skipspace
162item                    other                           OTHER_skipspace
163tab                     other                           OTHER_skipspace
164# only valid in heading or footing
165thischapter             other,in_heading                OTHER_noarg
166thischaptername         other,in_heading                OTHER_noarg
167thischapternum          other,in_heading                OTHER_noarg
168thisfile                other,in_heading                OTHER_noarg
169thispage                other,in_heading                OTHER_noarg
170thistitle               other,in_heading                OTHER_noarg
171# obsolete @-commands.
172refill                  other,deprecated                OTHER_noarg
173
174
175
176##########################################################
177#
178# brace commands
179#
180##########################################################
181
182# letter_no_arg_commands
183aa                      brace                           0
184AA                      brace                           0
185ae                      brace                           0
186oe                      brace                           0
187AE                      brace                           0
188OE                      brace                           0
189o                       brace                           0
190O                       brace                           0
191ss                      brace                           0
192l                       brace                           0
193L                       brace                           0
194DH                      brace                           0
195dh                      brace                           0
196TH                      brace                           0
197th                      brace                           0
198
199# no arg commands
200TeX                     brace                           0
201LaTeX                   brace                           0
202bullet                  brace                           0
203copyright               brace                           0
204registeredsymbol        brace                           0
205dots                    brace                           0
206enddots                 brace                           0
207equiv                   brace                           0
208error                   brace                           0
209expansion               brace                           0
210arrow                   brace                           0
211minus                   brace                           0
212point                   brace                           0
213print                   brace                           0
214result                  brace                           0
215today                   brace                           0
216exclamdown              brace                           0
217questiondown            brace                           0
218pounds                  brace                           0
219ordf                    brace                           0
220ordm                    brace                           0
221atchar                  brace                           0
222ampchar                 brace                           0
223lbracechar              brace                           0
224rbracechar              brace                           0
225backslashchar           brace                           0
226hashchar                brace                           0
227comma                   brace                           0
228euro                    brace                           0
229geq                     brace                           0
230leq                     brace                           0
231tie                     brace                           0
232textdegree              brace                           0
233click                   brace                           0
234quotedblleft            brace                           0
235quotedblright           brace                           0
236quoteleft               brace                           0
237quoteright              brace                           0
238quotedblbase            brace                           0
239quotesinglbase          brace                           0
240guillemetleft           brace                           0
241guillemetright          brace                           0
242guillemotleft           brace                           0
243guillemotright          brace                           0
244guilsinglleft           brace                           0
245guilsinglright          brace                           0
246
247# accent commands - can be called with or without braces
248\"                      brace,accent                    BRACE_accent
249~                       brace,accent                    BRACE_accent
250^                       brace,accent                    BRACE_accent
251`                       brace,accent                    BRACE_accent
252'                       brace,accent                    BRACE_accent
253,                       brace,accent                    BRACE_accent
254=                       brace,accent                    BRACE_accent
255ringaccent              brace,accent                    BRACE_accent
256H                       brace,accent                    BRACE_accent
257dotaccent               brace,accent                    BRACE_accent
258u                       brace,accent                    BRACE_accent
259ubaraccent              brace,accent                    BRACE_accent
260udotaccent              brace,accent                    BRACE_accent
261v                       brace,accent                    BRACE_accent
262ogonek                  brace,accent                    BRACE_accent
263tieaccent               brace,accent                    BRACE_accent
264dotless                 brace,accent                    BRACE_accent
265
266# Style commands
267asis                    brace                           BRACE_style
268cite                    brace                           BRACE_style
269clicksequence           brace                           BRACE_style
270dfn                     brace                           BRACE_style
271emph                    brace                           BRACE_style
272sc                      brace                           BRACE_style
273t                       brace                           BRACE_style
274var                     brace                           BRACE_style
275headitemfont            brace                           BRACE_style
276code                    brace,code_style                BRACE_style
277command                 brace,code_style                BRACE_style
278env                     brace,code_style                BRACE_style
279file                    brace,code_style                BRACE_style
280kbd                     brace,code_style                BRACE_style
281option                  brace,code_style                BRACE_style
282samp                    brace,code_style                BRACE_style
283strong                  brace                           BRACE_style
284sub                     brace                           BRACE_style
285sup                     brace                           BRACE_style
286
287# Regular font style commands
288r                       brace                           BRACE_style
289i                       brace                           BRACE_style
290b                       brace                           BRACE_style
291sansserif               brace                           BRACE_style
292slanted                 brace                           BRACE_style
293
294U                       brace                           1
295dmn                     brace                           1
296titlefont               brace,global                    1
297
298w                       brace                           BRACE_other
299key                     brace                           BRACE_other
300
301hyphenation             brace,global                    BRACE_other
302anchor                  brace                           1
303errormsg                brace                           1
304sortas                  brace                           1
305seeentry                brace                           1
306seealso                 brace                           1
307
308# more code style commands
309indicateurl             brace,code_style                1
310verb                    brace,code_style                BRACE_other
311t                       brace,code_style                BRACE_other
312
313# context brace commands - commands that enclose full texts
314footnote                brace,global                    BRACE_context
315caption                 brace                           BRACE_context
316shortcaption            brace                           BRACE_context
317math                    brace                           BRACE_context
318
319# explained commands
320abbr                    brace                           2
321acronym                 brace                           2
322
323# inline format command
324inlineraw               brace,inline                    2
325inlinefmt               brace,inline                    2
326inlinefmtifelse         brace,inline                    3
327
328# inline conditional commands
329inlineifclear           brace,inline                    2
330inlineifset             brace,inline                    2
331
332email                   brace                           2
333
334uref                    brace                           3
335url                     brace                           3
336inforef                 brace,ref,deprecated            3
337
338xref                    brace,ref                       5
339ref                     brace,ref                       5
340pxref                   brace,ref                       5
341image                   brace                           5
342
343
344##########################################################
345
346# def* commands
347deffn                   block,def
348defvr                   block,def
349deftypefn               block,def
350deftypeop               block,def
351deftypevr               block,def
352defcv                   block,def
353deftypecv               block,def
354defop                   block,def
355deftp                   block,def
356#   shortcuts
357defun                   block,def,def_alias
358defmac                  block,def,def_alias
359defspec                 block,def,def_alias
360defvar                  block,def,def_alias
361defopt                  block,def,def_alias
362deftypefun              block,def,def_alias
363deftypevar              block,def,def_alias
364defivar                 block,def,def_alias
365deftypeivar             block,def,def_alias
366defmethod               block,def,def_alias
367deftypemethod           block,def,def_alias
368
369# def*x
370deffnx                  line,def                        LINE_line
371defvrx                  line,def                        LINE_line
372deftypefnx              line,def                        LINE_line
373deftypeopx              line,def                        LINE_line
374deftypevrx              line,def                        LINE_line
375defcvx                  line,def                        LINE_line
376deftypecvx              line,def                        LINE_line
377defopx                  line,def                        LINE_line
378deftpx                  line,def                        LINE_line
379#   shortcuts
380defunx                  line,def,def_alias              LINE_line
381defmacx                 line,def,def_alias              LINE_line
382defspecx                line,def,def_alias              LINE_line
383defvarx                 line,def,def_alias              LINE_line
384defoptx                 line,def,def_alias              LINE_line
385deftypefunx             line,def,def_alias              LINE_line
386deftypevarx             line,def,def_alias              LINE_line
387defivarx                line,def,def_alias              LINE_line
388deftypeivarx            line,def,def_alias              LINE_line
389defmethodx              line,def,def_alias              LINE_line
390deftypemethodx          line,def,def_alias              LINE_line
391
392multitable              block,blockitem                 BLOCK_multitable
393
394# menu commands
395menu                    block,menu
396detailmenu              block,menu,global
397direntry                block,menu
398
399# align commands
400raggedright             block
401flushleft               block
402flushright              block
403
404cartouche               block
405group                   block
406indentedblock           block
407smallindentedblock      block
408
409# region commands
410titlepage               block,global_unique             BLOCK_region
411copying                 block,global_unique             BLOCK_region
412documentdescription     block,global_unique             BLOCK_region
413
414# preformatted commands
415example                 block,preformatted,preformatted_code    BLOCK_variadic
416smallexample            block,preformatted,preformatted_code
417lisp                    block,preformatted,preformatted_code
418smalllisp               block,preformatted,preformatted_code
419display                 block,preformatted
420smalldisplay            block,preformatted
421format                  block,preformatted
422smallformat             block,preformatted
423
424# format raw commands
425html                    block,format_raw
426tex                     block,format_raw
427xml                     block,format_raw
428docbook                 block,format_raw
429
430# raw commands
431verbatim                block                           BLOCK_raw
432ignore                  block                           BLOCK_raw
433macro                   block                           BLOCK_raw
434rmacro                  block                           BLOCK_raw
435
436table                   block,blockitem                 1
437ftable                  block,blockitem                 1
438vtable                  block,blockitem                 1
439itemize                 block,blockitem                 1
440enumerate               block,blockitem                 1
441quotation               block                           1
442smallquotation          block                           1
443
444float                   block                           2
445displaymath             block                           0
446
447##################################################################
448# Conditional commands
449ifhtml                  block                           BLOCK_conditional
450ifnothtml               block                           BLOCK_conditional
451iftex                   block                           BLOCK_conditional
452ifnottex                block                           BLOCK_conditional
453ifxml                   block                           BLOCK_conditional
454ifnotxml                block                           BLOCK_conditional
455ifdocbook               block                           BLOCK_conditional
456ifnotdocbook            block                           BLOCK_conditional
457ifinfo                  block                           BLOCK_conditional
458ifnotinfo               block                           BLOCK_conditional
459ifplaintext             block                           BLOCK_conditional
460ifnotplaintext          block                           BLOCK_conditional
461ifset                   block                           BLOCK_conditional
462ifclear                 block                           BLOCK_conditional
463ifcommanddefined        block                           BLOCK_conditional
464ifcommandnotdefined     block                           BLOCK_conditional
465
466##########################################################
467# Root commands
468node                    root,line                       LINE_line
469top                     root,line,sectioning,global_unique      LINE_line
470chapter                 root,line,sectioning            LINE_line
471unnumbered              root,line,sectioning            LINE_line
472chapheading             line,sectioning                 LINE_line
473appendix                root,line,sectioning            LINE_line
474section                 root,line,sectioning            LINE_line
475unnumberedsec           root,line,sectioning            LINE_line
476heading                 line,sectioning                 LINE_line
477appendixsec             root,line,sectioning            LINE_line
478subsection              root,line,sectioning            LINE_line
479unnumberedsubsec        root,line,sectioning            LINE_line
480subheading              line,sectioning                 LINE_line
481appendixsubsec          root,line,sectioning            LINE_line
482subsubsection           root,line,sectioning            LINE_line
483unnumberedsubsubsec     root,line,sectioning            LINE_line
484subsubheading           line,sectioning                 LINE_line
485appendixsubsubsec       root,line,sectioning            LINE_line
486
487part                    root,line,sectioning,global     LINE_line
488appendixsection         root,line,sectioning            LINE_line
489majorheading            line,sectioning                 LINE_line
490centerchap              root,line,sectioning,deprecated LINE_line
491
492