tests: small cleanups
[gtk-doc.git] / db2man / docbook-to-man.ts
blob7faa417473af63ea808174926237d05c257f2c99
1 #############################################################################
3 #       docbook-to-man.ts
5 #############################################################################
7 # Copyright (c) 1996 X Consortium
8 # Copyright (c) 1996 Dalrymple Consulting
9
10 # Permission is hereby granted, free of charge, to any person obtaining a copy
11 # of this software and associated documentation files (the "Software"), to deal
12 # in the Software without restriction, including without limitation the rights
13 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 # copies of the Software, and to permit persons to whom the Software is
15 # furnished to do so, subject to the following conditions:
16
17 # The above copyright notice and this permission notice shall be included in
18 # all copies or substantial portions of the Software.
19
20 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
23 # X CONSORTIUM OR DALRYMPLE CONSULTING BE LIABLE FOR ANY CLAIM, DAMAGES OR
24 # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26 # OTHER DEALINGS IN THE SOFTWARE.
27
28 # Except as contained in this notice, the names of the X Consortium and
29 # Dalrymple Consulting shall not be used in advertising or otherwise to
30 # promote the sale, use or other dealings in this Software without prior
31 # written authorization.
32
33 #############################################################################
35 # Written 5/29/96 by Fred Dalrymple
37 #############################################################################
39 #  Variables
41 Var:    callout 0
42 Var:    orderlist 0
43 Var:    procstep 0
44 Var:    procsubstep 0
49 #############################################################################
51 #  Hierarchy (and document meta stuff)
53 #   ####     #####     #####     #####     #####     #####     ####     #####     
55 GI:             REFENTRY
56 StartText:      ^.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
57                 ^.TH "${_followrel descendant REFENTRYTITLE 1000}"
58                 "${_followrel descendant MANVOLNUM 1000}"
59                 "${REVISION}" ""
60                 "${_followrel descendant REFMISCINFO 1000}"^
61 EndText:        ^...\\" created by instant / docbook-to-man, ${date}^
64 GI:             DOCINFO
65 Ignore:         all
68 GI:             TITLE
69 Context:        DOCINFO
70 #       inside DocInfo, which we're ignoring
73 GI:             REFMETA
74 Ignore:         all
77 GI:             REFNAMEDIV
78 StartText:      ^.SH "NAME"^
81 GI:             REFDESCRIPTOR
82 StartText:      \\fB
83 EndText:        \\fR\s
86 GI:             REFNAME
87 Relation:       sibling- REFDESCRIPTOR
88 #       inhibit REFNAMEs when a REFDESCRIPTOR is present
89 Ignore:         all
92 GI:             REFNAME
93 StartText:      ${_isset refnameseen xxx 20}
94 EndText:        ${_set refnameseen xxx}
97 GI:             _refname
98 SpecID:         20
99 StartText:      ,\s
102 GI:             REFPURPOSE
103 StartText:      \s\\-\s
104 EndText:        ^
107 GI:             REFCLASS
108 StartText:      ^.PP^
109 EndText:        ^
112 GI:             REFSYNOPSISDIV
113 StartText:      ^.SH "SYNOPSIS"^
114 EndText:        ^
117 GI:             REFSECT1
118 StartText:      ^.SH "${_followrel child TITLE 1001}"^
119 EndText:        ^
122 GI:             REFSECT2
123 StartText:      ^.SS "${_followrel child TITLE 1000}"^
124 EndText:        ^
127 GI:             REFSECT3
128 StartText:      ^.SS "${_followrel child TITLE 1000}"^
129 EndText:        ^
132 GI:             BRIDGEHEAD
133 StartText:      ^.PP^\\fB
134 EndText:        \\fP^.PP^
137 GI:             TITLE
138 Context:        REFSECT1
139 Ignore:         all
142 GI:             TITLE
143 Context:        REFSECT2
144 Ignore:         all
147 GI:             TITLE
148 Context:        REFSECT3
149 Ignore:         all
152 GI:             LEGALNOTICE
153 #       part of the DocInfo structure, which is ignored
154 Ignore:         all
157 GI:             TITLE
158 Context:        LEGALNOTICE
159 #       part of the DocInfo structure, which is ignored
160 Ignore:         all
163 GI:             REFENTRYTITLE
164 Context:        REFMETA
165 #       part of the DocInfo structure, which is ignored
166 Ignore:         all
169 GI:             MANVOLNUM
170 Context:        REFMETA
171 #       part of the DocInfo structure, which is ignored, though this element
172 #       if accessed directly by the _followrel call from the REFENTRY element.
173 Ignore:         all
176 GI:             REFMISCINFO
177 #       part of the DocInfo structure, which is ignored
178 Ignore:         all
181 GI:             SUBTITLE
182 #       part of the DocInfo structure, which is ignored
183 Ignore:         all
186 GI:             AUTHORGROUP
187 #       part of the DocInfo structure, which is ignored
188 Ignore:         all
191 GI:             AUTHOR
192 Context:        AUTHORGROUP
193 #       part of the DocInfo structure, which is ignored
194 Ignore:         all
197 GI:             EDITOR
198 Context:        AUTHORGROUP
199 #       part of the DocInfo structure, which is ignored
200 Ignore:         all
203 GI:             COLLAB
204 Context:        AUTHORGROUP
205 #       part of the DocInfo structure, which is ignored
206 Ignore:         all
209 GI:             COLLABNAME
210 Context:        COLLAB
211 #       part of the DocInfo structure, which is ignored
212 Ignore:         all
215 GI:             CORPAUTHOR
216 Context:        AUTHORGROUP
217 #       part of the DocInfo structure, which is ignored
218 Ignore:         all
221 GI:             OTHERCREDIT
222 Context:        AUTHORGROUP
223 #       part of the DocInfo structure, which is ignored
224 Ignore:         all
228 #############################################################################
230 #  (before we get into the branch stuff, we turn off paragraphs in some
231 #   contexts where they would break the flow.  Generally, this happens
232 #   within indented areas, such as within lists.
234 #   ####     #####     #####     #####     #####     #####     ####     #####     
236 GI:             PARA
237 Context:        LISTITEM
238 NthChild:       1
239 #       nothing in this context
242 GI:             PARA
243 Context:        GLOSSDEF
244 NthChild:       1
245 #       nothing in this context
248 GI:             PARA
249 Context:        STEP
250 NthChild:       1
251 #       nothing in this context
254 GI:             PARA
255 Context:        CALLOUT
256 NthChild:       1
257 #       nothing in this context
260 GI:             PARA
261 Context:        MSGTEXT
262 NthChild:       1
263 #       nothing in this context
266 GI:             PARA
267 Relation:       parent ENTRY
268 NthChild:       1
269 #       first one does nothing in this context
272 GI:             PARA
273 Relation:       parent ENTRY
274 StartText:      ^.br^
279 #############################################################################
281 #  Regular "branch" stuff
283 #   ####     #####     #####     #####     #####     #####     ####     #####     
285 GI:             FORMALPARA
286 #       it's all done in TITLE (FORMALPARA) and PARA
289 GI:             TITLE
290 Context:        FORMALPARA
291 StartText:      ^.PP^\\fB
292 EndText:        \\fR^
295 GI:             PARA
296 Relation:       ancestor LISTITEM
297 StartText:      ^.IP "" 10^
300 GI:             PARA
301 Relation:       ancestor STEP
302 StartText:      ^.IP "" 10^
305 GI:             PARA
306 StartText:      ^.PP^
309 GI:             SIMPARA
310 StartText:      ^.PP^
313 GI:             PROGRAMLISTING
314 StartText:      ^.PP^.nf^\\f(CW
315 EndText:        \\fR^.fi^.PP^
318 GI:             LITERALLAYOUT
319 StartText:      ^.PP^.nf^
320 EndText:        ^.fi^
323 GI:             BLOCKQUOTE
324 StartText:      ^.PP^.RS^
325 EndText:        ^.RE^
328 GI:             TITLE
329 Context:        BLOCKQUOTE
330 StartText:      ^\\fB
331 EndText:        \\fR^.PP^
334 GI:             EPIGRAPH
335 StartText:      ^.PP^.RS^
336 EndText:        ^.RE^
339 GI:             ATTRIBUTION
340 StartText:      ^\\fI
341 EndText:        \\fR^.PP^
344 GI:             ABSTRACT
345 Relation:       child TITLE
348 GI:             ABSTRACT
349 StartText:      ^.SS "Abstract"^
352 GI:             TITLE
353 Context:        ABSTRACT
354 StartText:      ^.SS "
355 EndText:        "^
356 Substitute:     " ""
359 GI:             REVHISTORY
360 StartText:      ^.SS "Revision History"^
361 EndText:        ^
364 GI:             REVISION
365 StartText:      ^.PP^\\fBRevision:\\fR\s
366 EndText:        ^
369 GI:             REVNUMBER
370 StartText:      #\s
371 EndText:        ;\s
374 GI:             DATE
375 EndText:        ;\s
378 GI:             AUTHORINITIALS
379 Context:        REVISION
380 StartText:      \s
383 GI:             REVREMARK
384 StartText:      ;\s\s
385 EndText:        ^
388 GI:             PROGRAMLISTINGCO
389 #       nothing to do specifically in ProgramListingCO -- it falls to
390 #       the content of ProgramListing and any callout list
393 GI:             SCREEN
394 StartText:      ^.PP^.nf^
395 EndText:        ^.fi^
398 GI:             SCREENCO
399 #       nothing to do specifically in ScreenCO -- it falls to
400 #       the content of Screen and any callout list
403 GI:             SCREENSHOT
404 #       nothing specific to do here -- defer to any ScreenInfo or the
405 #       included graphic
408 GI:             SCREENINFO
409 StartText:      ^.PP^\\fI
410 EndText:        \\fR^.PP^
413 GI:             GRAPHICCO
414 #       nothing to do specifically in GraphicCO -- it falls to
415 #       the content of Graphic and any callout list
418 GI:             INFORMALEXAMPLE
419 #       nothing special to do here -- it falls to the content.
422 GI:             EXAMPLE
423 #       nothing special to do here -- it falls to the content.
426 GI:             TITLE
427 Context:        EXAMPLE
428 StartText:      ^.PP^\\fB
429 EndText:        \\fR^
432 GI:             FIGURE
433 #       nothing special to do here -- it falls to the content.
436 GI:             TITLE
437 Context:        FIGURE
438 StartText:      ^.PP^\\fB
439 EndText:        \\fR^
442 GI:             SIDEBAR
443 Relation:       child TITLE
444 StartText:      ^.PP^.RS^
445 EndText:        ^.RE^
448 GI:             SIDEBAR
449 StartText:      ^.PP^.RS^\\fB[ Sidebar ]\\fR^
450 EndText:        ^.RE^
453 GI:             TITLE
454 Context:        SIDEBAR
455 StartText:      ^\\fB[ Sidebar:\s
456 EndText:        \s]\\fR^
459 GI:             HIGHLIGHTS
460 StartText:      ^.SS "Highlights"^
463 GI:             AUTHORBLURB
464 #       nothing to do specially -- an included title may occur
467 GI:             TITLE
468 Context:        AUTHORBLURB
469 StartText:      ^.PP^\\fB
470 EndText:        \\fR^
474 #############################################################################
476 #  Call-out material
478 #   ####     #####     #####     #####     #####     #####     ####     #####     
480 GI:             CO
481 #       nothing to do for the anchor of a callout
484 GI:             AREASPEC
485 Ignore:         all
486 #       not much to do with representing the anchor of callouts in n/troff
489 GI:             AREA
490 Ignore:         all
491 #       part of AreaSpec, which is being ignored
494 GI:             AREASET
495 Ignore:         all
496 #       part of AreaSpec, which is being ignored
500 #############################################################################
502 #  Address block
504 #   ####     #####     #####     #####     #####     #####     ####     #####     
506 GI:             ADDRESS
507 StartText:      ^.PP^.nf^
508 EndText:        ^.fi^
511 GI:             STREET
512 #       just the content...
515 GI:             POB
516 #       just the content...
519 GI:             POSTCODE
520 #       just the content...
523 GI:             CITY
524 EndText:        ,\s
527 GI:             STATE
528 #       just the content
531 GI:             COUNTRY
532 #       just the content
535 GI:             PHONE
536 StartText:      ^voice:\s
539 GI:             FAX
540 StartText:      ^fax:\s
543 GI:             OTHERADDR
544 #       just the content..
547 GI:             EMAIL
548 Context:        ADDRESS
549 #       just the content..
553 #############################################################################
555 #  Lists
557 #   ####     #####     #####     #####     #####     #####     ####     #####     
559 GI:             GLOSSLIST
560 Relation:       ancestor ITEMIZEDLIST
561 StartText:      ^.RS^
562 EndText:        ^.RE^
565 GI:             GLOSSLIST
566 Relation:       ancestor GLOSSLIST
567 StartText:      ^.RS^
568 EndText:        ^.RE^
571 GI:             GLOSSLIST
572 Relation:       ancestor ORDEREDLIST
573 StartText:      ^.RS^
574 EndText:        ^.RE^
577 GI:             GLOSSLIST
578 Relation:       ancestor SIMPLELIST
579 StartText:      ^.RS^
580 EndText:        ^.RE^
583 GI:             GLOSSLIST
584 Relation:       ancestor VARIABLELIST
585 StartText:      ^.RS^
586 EndText:        ^.RE^
589 GI:             GLOSSLIST
590 Relation:       ancestor SEGMENTEDLIST
591 StartText:      ^.RS^
592 EndText:        ^.RE^
595 GI:             GLOSSLIST
596 #       Nothing to do here..  see glossentry, etc
599 GI:             GLOSSENTRY
600 #       nothing to do..
603 GI:             GLOSSTERM
604 Context:        GLOSSENTRY
605 StartText:      ^.IP "
606 EndText:        " 10^
607 Substitute:     " ""
610 GI:             GLOSSTERM
611 StartText:      \\fB
612 EndText:        \\fP
615 GI:             ACRONYM
616 Context:        GLOSSENTRY
617 StartText:      (\\fIacronym:\s\\fR
618 EndText:        )\s\s
621 GI:             ABBREV
622 Context:        GLOSSENTRY
623 StartText:      (\\fIabbreviation:\s\\fR
624 EndText:        )\s\s
627 GI:             GLOSSSEE
628 StartText:      ^\\fISee \\fR
631 GI:             GLOSSDEF
632 #       nothing special to do -- just pass the content.
635 GI:             GLOSSSEEALSO
636 StartText:      ^^\\fISee Also \\fR
639 GI:             ITEMIZEDLIST
640 Relation:       ancestor ITEMIZEDLIST
641 StartText:      ^.RS^
642 EndText:        ^.RE^
645 GI:             ITEMIZEDLIST
646 Relation:       ancestor GLOSSLIST
647 StartText:      ^.RS^
648 EndText:        ^.RE^
651 GI:             ITEMIZEDLIST
652 Relation:       ancestor ORDEREDLIST
653 StartText:      ^.RS^
654 EndText:        ^.RE^
657 GI:             ITEMIZEDLIST
658 Relation:       ancestor SIMPLELIST
659 StartText:      ^.RS^
660 EndText:        ^.RE^
663 GI:             ITEMIZEDLIST
664 Relation:       ancestor VARIABLELIST
665 StartText:      ^.RS^
666 EndText:        ^.RE^
669 GI:             ITEMIZEDLIST
670 Relation:       ancestor SEGMENTEDLIST
671 StartText:      ^.RS^
672 EndText:        ^.RE^
675 GI:             ITEMIZEDLIST
676 #       nothing to do..
679 GI:             LISTITEM
680 Context:        ITEMIZEDLIST
681 StartText:      ^.IP "\ \ \ \\(bu" 6^
684 GI:             ORDEREDLIST
685 Relation:       ancestor ITEMIZEDLIST
686 StartText:      ^.RS^
687 EndText:        ^.RE^
690 GI:             ORDEREDLIST
691 Relation:       ancestor GLOSSLIST
692 StartText:      ^.RS^
693 EndText:        ^.RE^
696 GI:             ORDEREDLIST
697 Relation:       ancestor ORDEREDLIST
698 StartText:      ^.RS^
699 EndText:        ^.RE^
702 GI:             ORDEREDLIST
703 Relation:       ancestor SIMPLELIST
704 StartText:      ^.RS^
705 EndText:        ^.RE^
708 GI:             ORDEREDLIST
709 Relation:       ancestor VARIABLELIST
710 StartText:      ^.RS^
711 EndText:        ^.RE^
714 GI:             ORDEREDLIST
715 Relation:       ancestor SEGMENTEDLIST
716 StartText:      ^.RS^
717 EndText:        ^.RE^
720 GI:             ORDEREDLIST
721 StartText:      ${_set orderlist 1}
724 GI:             LISTITEM
725 Context:        ORDEREDLIST
726 StartText:      ^.IP "\ \ \ ${orderlist}." 6^
727 Increment:      orderlist
730 GI:             SIMPLELIST
731 Relation:       ancestor ITEMIZEDLIST
732 StartText:      ^.RS^
733 EndText:        ^.RE^
736 GI:             SIMPLELIST
737 Relation:       ancestor GLOSSLIST
738 StartText:      ^.RS^
739 EndText:        ^.RE^
742 GI:             SIMPLELIST
743 Relation:       ancestor ORDEREDLIST
744 StartText:      ^.RS^
745 EndText:        ^.RE^
748 GI:             SIMPLELIST
749 Relation:       ancestor SIMPLELIST
750 StartText:      ^.RS^
751 EndText:        ^.RE^
754 GI:             SIMPLELIST
755 Relation:       ancestor VARIABLELIST
756 StartText:      ^.RS^
757 EndText:        ^.RE^
760 GI:             SIMPLELIST
761 Relation:       ancestor SEGMENTEDLIST
762 StartText:      ^.RS^
763 EndText:        ^.RE^
766 GI:             SIMPLELIST
767 #       nothing to do here..
770 GI:             MEMBER
771 PAttSet:        TYPE INLINE
772 NthChild:       1
775 GI:             MEMBER
776 PAttSet:        TYPE INLINE
777 StartText:      ,\s
780 GI:             MEMBER
781 PAttSet:        TYPE HORIZ
782 NthChild:       1
783 StartText:      ^.PP^\t
786 GI:             MEMBER
787 PAttSet:        TYPE HORIZ
788 StartText:      \t
791 GI:             MEMBER
792 PAttSet:        TYPE VERT
793 StartText:      ^.IP "" 10^
794 EndText:        ^
797 GI:             VARIABLELIST
798 Relation:       ancestor ITEMIZEDLIST
799 StartText:      ^.RS^
800 EndText:        ^.RE^
803 GI:             VARIABLELIST
804 Relation:       ancestor GLOSSLIST
805 StartText:      ^.RS^
806 EndText:        ^.RE^
809 GI:             VARIABLELIST
810 Relation:       ancestor ORDEREDLIST
811 StartText:      ^.RS^
812 EndText:        ^.RE^
815 GI:             VARIABLELIST
816 Relation:       ancestor SIMPLELIST
817 StartText:      ^.RS^
818 EndText:        ^.RE^
821 GI:             VARIABLELIST
822 Relation:       ancestor VARIABLELIST
823 StartText:      ^.RS^
824 EndText:        ^.RE^
827 GI:             VARIABLELIST
828 Relation:       ancestor SEGMENTEDLIST
829 StartText:      ^.RS^
830 EndText:        ^.RE^
833 GI:             VARIABLELIST
834 #       nothing to do now, see VarListEntry
837 GI:             VARLISTENTRY
838 #       nothing to do now, see Term
841 GI:             TERM
842 StartText:      ^.IP "
843 EndText:        " 10^
844 Substitute:     " ""
847 GI:             LISTITEM
848 Context:        VARLISTENTRY
849 #       nothing special to do..
852 GI:             SEGMENTEDLIST
853 Relation:       ancestor ITEMIZEDLIST
854 StartText:      ^.RS^${_followrel child TITLE 400}^.TS^tab(\a);^l l l l l l l l l l l l l l l l l l.^
855 EndText:        ^.TE^.RE^
858 GI:             SEGMENTEDLIST
859 Relation:       ancestor GLOSSLIST
860 StartText:      ^.RS^${_followrel child TITLE 400}^.TS^tab(\a);^l l l l l l l l l l l l l l l l l l.^
861 EndText:        ^.TE^.RE^
864 GI:             SEGMENTEDLIST
865 Relation:       ancestor ORDEREDLIST
866 StartText:      ^.RS^${_followrel child TITLE 400}^.TS^tab(\a);^l l l l l l l l l l l l l l l l l l.^
867 EndText:        ^.TE^.RE^
870 GI:             SEGMENTEDLIST
871 Relation:       ancestor SIMPLELIST
872 StartText:      ^.RS^${_followrel child TITLE 400}^.TS^tab(\a);^l l l l l l l l l l l l l l l l l l.^
873 EndText:        ^.TE^.RE^
876 GI:             SEGMENTEDLIST
877 Relation:       ancestor VARIABLELIST
878 StartText:      ^.RS^${_followrel child TITLE 400}^.TS^tab(\a);^l l l l l l l l l l l l l l l l l l.^
879 EndText:        ^.TE^.RE^
882 GI:             SEGMENTEDLIST
883 Relation:       ancestor SEGMENTEDLIST
884 StartText:      ^.RS^${_followrel child TITLE 400}^.TS^tab(\a);^l l l l l l l l l l l l l l l l l l.^
885 EndText:        ^.TE^.RE^
888 GI:             SEGMENTEDLIST
889 Relation:       child TITLE
890 StartText:      ^${_followrel child TITLE 400}^.TS^tab(\a);^l l l l l l l l l l l l l l l l l l.^
891 EndText:        ^.TE^
894 GI:             TITLE
895 Context:        SEGMENTEDLIST
896 #       ignored by default -- must be called by SEGMENTEDLIST gi
897 Ignore:         all
900 GI:             _segmentedlist_title
901 SpecID:         400
902 StartText:      ^.sp 1^\\fB
903 EndText:        \\fR^
906 GI:             SEGTITLE
907 StartText:      \\fB
908 EndText:        \\fR\a
911 GI:             SEGLISTITEM
912 StartText:      ^
913 EndText:        ^
916 GI:             SEG
917 EndText:        \a
920 GI:             PROCEDURE
921 #       defer to the content...
922 StartText:      ${_set procstep 1}${_set procsubstep 1}
925 GI:             TITLE
926 Context:        PROCEDURE
927 StartText:      ^.PP^\\fB
928 EndText:        \\fR^
931 GI:             STEP
932 Context:        SUBSTEPS
933 StartText:      ^.PP^\\fISubstep ${procsubstep}.\s\s
934 EndText:        ^
935 Increment:      procsubstep 1
938 GI:             STEP
939 StartText:      ^.PP^\\fIStep ${procstep}.\s\s
940 EndText:        ^
941 Increment:      procstep 1
944 GI:             TITLE
945 Context:        STEP
946 StartText:      ^\\fB
947 EndText:        \\fR^.PP^
950 GI:             SUBSTEPS
951 StartText:      ^.RS^
952 EndText:        ^.RE^
955 GI:             CALLOUTLIST
956 StartText:      ${_set callout 1}
957 #       nothing to do specifically, defer to the content...
960 GI:             TITLE
961 Context:        CALLOUTLIST
962 StartText:      ^\\fB
963 EndText:        \\fR^.PP^
966 GI:             CALLOUT
967 StartText:      ^.PP^\\fICallout ${callout}.\s\s\\fR
968 EndText:        ^
969 Increment:      callout
973 #############################################################################
975 #  Messages
977 #   ####     #####     #####     #####     #####     #####     ####     #####     
979 GI:             MSGSET
980 StartText:      ^.SS "Message Set"^
983 GI:             MSGENTRY
984 StartText:      ^.PP^\\fBMessage Entry\\fR^.RS^
985 EndText:        ^.RE^
988 GI:             MSG
989 Relation:       child TITLE
990 StartText:      ^.PP^
991 EndText:        ^
994 GI:             MSG
995 StartText:      ^.PP^\\fBMessage:\\fR^.PP^
996 EndText:        ^
999 GI:             TITLE
1000 Context:        MSG
1001 StartText:      ^.PP^\\fB
1002 EndText:        \\fR^.PP^
1005 GI:             MSGINFO
1006 #       nothing specific -- just groups (MsgLevel | MsgOrig | MsgAud)*
1009 GI:             MSGEXPLAN
1010 #       nothing special -- defer to content
1013 GI:             TITLE
1014 Context:        MSGEXPLAN
1015 StartText:      ^.PP^\\fB
1016 EndText:        \\fR^
1019 GI:             MSGMAIN
1020 #       defer to content
1023 GI:             TITLE
1024 Context:        MSGMAIN
1025 StartText:      ^\\fB
1026 EndText:        \\fR^
1029 GI:             MSGSUB
1030 #       defer to content
1033 GI:             TITLE
1034 Context:        MSGSUB
1035 StartText:      ^.PP^\\fB
1036 EndText:        \\fR^
1039 GI:             MSGREL
1040 #       defer to content
1043 GI:             TITLE
1044 Context:        MSGREL
1045 StartText:      ^.PP^\\fB
1046 EndText:        \\fR^
1049 GI:             MSGLEVEL
1050 StartText:      ^.PP^\\fIMessage level:\s\s\\fR
1051 EndText:        ^
1054 GI:             MSGORIG
1055 StartText:      ^.PP^\\fIMessage origin:\s\s\\fR
1056 EndText:        ^
1059 GI:             MSGAUD
1060 StartText:      ^.PP^\\fIMessage audience:\s\s\\fR
1061 EndText:        ^
1064 GI:             MSGTEXT
1065 Context:        PARA
1066 StartText:      \\fI
1067 EndText:        \\fP
1070 GI:             MSGTEXT
1071 StartText:      \\fR^\\fIMessage text:\\fR\s\s
1072 EndText:        ^
1076 #############################################################################
1078 #  Admonitions
1080 #   ####     #####     #####     #####     #####     #####     ####     #####     
1082 GI:             CAUTION
1083 Relation:       child TITLE
1084 StartText:      ^.PP^.RS
1085 EndText:        ^.RE^
1088 GI:             CAUTION
1089 StartText:      ^.PP^.RS^\\fBCaution:\s\s
1090 EndText:        ^.RE^
1093 GI:             TITLE
1094 Context:        CAUTION
1095 StartText:      ^\\fBCaution:\s\s
1096 EndText:        \\fR^.PP^
1099 GI:             IMPORTANT
1100 Relation:       child TITLE
1101 StartText:      ^.PP^.RS^
1102 EndText:        ^.RE^
1105 GI:             IMPORTANT
1106 StartText:      ^.PP^.RS^\\fBImportant:\s\s
1107 EndText:        ^.RE^
1110 GI:             TITLE
1111 Context:        IMPORTANT
1112 StartText:      ^\\fBImportant:\s\s
1113 EndText:        \\fR^.PP^
1116 GI:             NOTE
1117 Relation:       child TITLE
1118 StartText:      ^.PP^.RS
1119 EndText:        ^.RE^
1122 GI:             NOTE
1123 StartText:      ^.PP^.RS^\\fBNote:\s\s
1124 EndText:        ^.RE^
1127 GI:             TITLE
1128 Context:        NOTE
1129 StartText:      ^\\fBNote:\s\s
1130 EndText:        \\fR^.PP^
1133 GI:             TIP
1134 Relation:       child TITLE
1135 StartText:      ^.PP^.RS
1136 EndText:        ^.RE^
1139 GI:             TIP
1140 StartText:      ^.PP^.RS^\\fBTip:\s\s
1141 EndText:        ^.RE^
1144 GI:             TITLE
1145 Context:        TIP
1146 StartText:      ^\\fBTip:\s\s
1147 EndText:        \\fR^.PP^
1150 GI:             WARNING
1151 Relation:       child TITLE
1152 StartText:      ^.PP^.RS
1153 EndText:        ^.RE^
1156 GI:             WARNING
1157 StartText:      ^.PP^.RS^\\fBWarning:\s\s
1158 EndText:        ^.RE^
1161 GI:             TITLE
1162 Context:        WARNING
1163 StartText:      ^\\fBWarning:\s\s
1164 EndText:        \\fR^.PP^
1168 #############################################################################
1170 #  Synopses
1172 #   ####     #####     #####     #####     #####     #####     ####     #####     
1174 GI:             SYNOPSIS
1175 StartText:      ^.PP^.nf^
1176 EndText:        ^.fi^
1179 GI:             CMDSYNOPSIS
1180 StartText:      ^.PP^
1181 EndText:        ^
1184 GI:             ARG
1185 Context:        GROUP
1186 NthChild:       1
1187 EndText:        ${_attval REP REPEAT 505}\s
1190 GI:             ARG
1191 Context:        GROUP
1192 StartText:      \s|\s
1193 EndText:        ${_attval REP REPEAT 505}\s
1196 GI:             ARG
1197 AttValue:       CHOICE OPT
1198 StartText:      \s[
1199 EndText:        ${_attval REP REPEAT 505}]\s
1202 GI:             ARG
1203 #       no special attrs -- just pass content through
1204 EndText:        ${_attval REP REPEAT 505}\s
1207 GI:             _arg_group
1208 SpecID:         505
1209 StartText:      \s\\&...
1210 Ignore:         all
1213 GI:             GROUP
1214 AttValue:       CHOICE OPT
1215 StartText:      \s[
1216 EndText:        ]\s${_attval REP REPEAT 505}
1219 GI:             GROUP
1220 AttValue:       CHOICE REQ
1221 StartText:      \s{
1222 EndText:        }\s${_attval REP REPEAT 505}
1225 GI:             GROUP
1226 AttValue:       CHOICE OPTMULT
1227 StartText:      \s[[
1228 EndText:        ]]\s${_attval REP REPEAT 505}
1231 GI:             GROUP
1232 AttValue:       CHOICE REQMULT
1233 StartText:      \s{{
1234 EndText:        }}\s${_attval REP REPEAT 505}
1237 GI:             GROUP
1238 AttValue:       CHOICE PLAIN
1239 EndText:        ${_attval REP REPEAT 505}
1242 GI:             SBR
1243 StartText:      ^.br^
1246 GI:             SYNOPFRAGMENT
1247 #       nothing special to do here -- just pass through content (Arg | Group)+
1250 GI:             SYNOPFRAGMENTREF
1251 #       WHAT TO DO HERE??   pass through the content, but what about the
1252 #       linkend?  (will call it across...)
1253 EndText:        \s\\fI(refers to: ${_followlink LINKEND 1000})\\fR
1256 GI:             FUNCSYNOPSIS
1257 StartText:      ^.PP^.nf^
1258 EndText:        ^.fi^
1261 GI:             FUNCSYNOPSISINFO
1262 StartText:      ^
1263 EndText:        ^
1266 GI:             FUNCPROTOTYPE
1267 #       nothing special -- just pass through content (looks like
1268 #       a function def
1269 StartText:      ^.sp 1^
1272 GI:             FUNCDEF
1273 StartText:      ^\\fB
1274 EndText:        \\fR(
1277 GI:             FUNCPARAMS
1278 StartText:      ^\t\t\t\\fB
1279 EndText:        \\fR^
1282 GI:             VOID
1283 StartText:      \\fBvoid\\fR);
1286 GI:             VARARGS
1287 StartText:      \\fB\\&...\\fR);
1290 GI:             PARAMDEF
1291 Relation:       sibling+ PARAMDEF
1292 StartText:      ^\\fB
1293 EndText:        \\fR,^
1296 GI:             PARAMDEF
1297 StartText:      ^\\fB
1298 EndText:        \\fR);^
1302 #############################################################################
1304 #  Links
1306 #   ####     #####     #####     #####     #####     #####     ####     #####     
1308 GI:             LINK
1309 StartText:      \\fI
1310 EndText:        \\fR
1313 GI:             OLINK
1314 StartText:      \\fI
1315 EndText:        \s(link to external document ${TargetDocEnt})\s\\fR
1318 GI:             ULINK
1319 StartText:      \\fI
1320 EndText:        \s(link to URL ${URL})\s\\fR
1323 GI:             FOOTNOTEREF
1324 #       just let the footnote ref mark come through
1327 GI:             FOOTNOTE
1328 #       just let footnote body come through (-man doesn't support footnotes)
1331 GI:             XREF
1332 AttValue:       ENDTERM
1333 StartText:      \\fI(cross-reference to ``${_followlink ENDTERM 1000}'')\\fR\s
1336 GI:             XREF
1337 StartText:      \\fI(cross-reference to ``${_followlink LINKEND 600})''\\fR\s
1340 GI:             _xref
1341 SpecID:         600
1342 StartText:      ${XREFLABEL}
1343 Ignore:         all
1346 GI:             ANCHOR
1347 #       nothing to do -- this just marks a place..
1351 #############################################################################
1353 #  Graphics and Equations
1355 #   ####     #####     #####     #####     #####     #####     ####     #####     
1357 GI:             GRAPHIC
1358 AttValue:       ENTITYREF
1359 StartText:      ^.PP^.if t .P! "${_filename}"^
1362 GI:             INLINEGRAPHIC
1363 StartText:      ^.if t .P! "${_filename}"^
1366 GI:             INFORMALEQUATION
1367 #       nothing special to do -- defer to graphic content..
1370 GI:             EQUATION
1371 #       nothing special to do -- defer to graphic content..
1374 GI:             TITLE
1375 Context:        EQUATION
1376 StartText:      ^.PP^\\fB
1377 EndText:        \\fR^
1380 GI:             INLINEEQUATION
1381 #       nothing special to do -- defer to graphic content..
1385 #############################################################################
1387 #  Tables
1389 #   ####     #####     #####     #####     #####     #####     ####     #####     
1392 GI:             INFORMALTABLE
1393 StartText:      ^${_calstable tbl tablestart}^
1394 EndText:        ^${_calstable tbl tableend}^
1397 GI:             TABLE
1398 StartText:      ^.PP^\\fB${_followrel child TITLE 1000}\\fR
1399                 ^${_calstable tbl tablestart}^
1400 EndText:        ^${_calstable tbl tableend}^
1403 GI:             TITLE
1404 Context:        TABLE
1405 #       handled in TABLE element
1406 Ignore:         all
1409 GI:             TGROUP
1410 StartText:      ^${_calstable tbl tablegroup}^${_followrel child THEAD 700}${_followrel child TBODY 700}${_followrel child TFOOT 701}
1411 EndText:        ${_calstable tbl tablegroupend}
1414 GI:             COLSPEC
1415 Ignore:         all
1418 GI:             SPANSPEC
1419 Ignore:         all
1422 GI:             THEAD TBODY TFOOT
1423 #       they're called explicitly from TGROUP, but ignored here
1424 Ignore:         all
1427 GI:             _thead_tbody
1428 SpecID:         700
1429 #       nothing special to do -- just pass through content
1432 GI:             _tfoot
1433 SpecID:         701
1434 StartText:      ^${_calstable tbl tablefoot}^
1437 GI:             ROW
1438 StartText:      ^${_calstable tbl rowstart}
1439 EndText:        ${_calstable tbl rowend}
1442 GI:             ENTRY
1443 StartText:      ${_calstable tbl entrystart}
1444 EndText:        ${_calstable tbl entryend}
1447 GI:             ENTRYTBL
1448 StartText:
1449 EndText:
1450 Message:        ^IMPLEMENT <${_gi} ${_allatts}>^
1454 #############################################################################
1456 #  Index terms
1458 #   ####     #####     #####     #####     #####     #####     ####     #####     
1460 GI:             INDEXTERM
1461 StartText:      ^.iX\s
1462 EndText:        ^
1465 GI:             PRIMARY
1466 StartText:      "
1467 EndText:        "
1470 GI:             SECONDARY
1471 StartText:      \s"
1472 EndText:        "
1475 GI:             TERTIARY
1476 StartText:      \s"
1477 EndText:        "
1480 GI:             SEE
1481 StartText:      \s"See:\s
1482 EndText:        "
1485 GI:             SEEALSO
1486 StartText:      \s"SeeAlso:\s
1487 EndText:        "
1491 #############################################################################
1493 #  Author / OtherCredit material
1495 #   ####     #####     #####     #####     #####     #####     ####     #####     
1497 GI:             OTHERCREDIT
1498 #       nothing specific -- defer to content
1501 GI:             HONORIFIC
1502 #       nothing specific -- defer to content
1503 EndText:        \s
1506 GI:             FIRSTNAME
1507 #       nothing specific -- defer to content
1508 EndText:        \s
1511 GI:             SURNAME
1512 #       nothing specific -- defer to content
1513 EndText:        \s
1516 GI:             LINEAGE
1517 #       nothing specific -- defer to content
1518 EndText:        \s
1521 GI:             OTHERNAME
1522 #       nothing specific -- defer to content
1523 StartText:      (
1524 EndText:        )\s
1527 GI:             AFFILIATION
1528 #       nothing specific -- defer to content
1529 EndText:        \s
1532 GI:             SHORTAFFIL
1533 #       nothing specific -- defer to content
1534 EndText:        \s
1537 GI:             JOBTITLE
1538 #       nothing specific -- defer to content
1539 EndText:        \s
1542 GI:             ORGNAME
1543 #       nothing specific -- defer to content
1544 EndText:        \s
1547 GI:             ORGDIV
1548 #       nothing specific -- defer to content
1549 EndText:        \s
1552 GI:             CONTRIB
1553 #       nothing specific -- defer to content
1554 EndText:        \s
1558 #############################################################################
1560 #  "Leaf" material
1562 #   ####     #####     #####     #####     #####     #####     ####     #####     
1564 GI:             ABBREV
1565 #       no special presentation
1568 GI:             ACCEL
1569 #       no special presentation
1572 GI:             ACRONYM
1573 #       no special presentation
1576 GI:             AUTHORINITIALS
1577 #       no special presentation
1580 GI:             CITATION
1581 StartText:      \\fI
1582 EndText:        \\fP
1585 GI:             CITETITLE
1586 AttValue:       PUBWORK
1587 StartText:      \\fI
1588 EndText:        \\fP (${PUBWORK})\s
1591 GI:             CITETITLE
1592 StartText:      \\fI
1593 EndText:        \\fP
1596 GI:             CITEREFENTRY
1597 #       defer to content..
1600 GI:             REFENTRYTITLE
1601 StartText:      \\fB
1602 EndText:        \\fP
1605 GI:             MANVOLNUM
1606 StartText:      \\fB(
1607 EndText:        )\\fP
1610 GI:             COMMENT
1611 #       docbook says to inhibit this from finished products...
1612 Ignore:         all
1615 GI:             EMAIL
1616 #       no special presentation
1619 GI:             EMPHASIS
1620 StartText:      \\fI
1621 EndText:        \\fP
1624 GI:             FIRSTTERM
1625 StartText:      \\fI
1626 EndText:        \\fR
1629 GI:             FOREIGNPHRASE
1630 #       no special presentation
1633 GI:             PHRASE
1634 #       no special presentation
1637 GI:             QUOTE
1638 StartText:      ``\\fI
1639 EndText:        \\fP''
1642 GI:             TRADEMARK
1643 EndText:        \\u\\s-2TM\\s+2\\d
1646 GI:             WORDASWORD
1647 #       no special presentation
1650 GI:             ACTION
1651 #       no special presentation
1654 GI:             APPLICATION
1655 StartText:      \\fB
1656 EndText:        \\fP
1659 GI:             CLASSNAME
1660 StartText:      \\fB
1661 EndText:        \\fP
1664 GI:             COMMAND
1665 StartText:      \\fB
1666 EndText:        \\fP
1669 GI:             COMPUTEROUTPUT
1670 StartText:      \\f(CW
1671 EndText:        \\fP
1674 GI:             DATABASE
1675 #       no special presentation
1678 GI:             ERRORNAME
1679 StartText:      \\fB
1680 EndText:        \\fP
1683 GI:             ERRORTYPE
1684 #       no special presentation
1687 GI:             FILENAME
1688 StartText:      \\fB
1689 EndText:        \\fP
1692 GI:             FUNCTION
1693 StartText:      \\fB
1694 EndText:        \\fP
1697 GI:             GUIBUTTON
1698 StartText:      \\fB
1699 EndText:        \\fP
1702 GI:             GUIICON
1703 StartText:      \\fB
1704 EndText:        \\fP
1707 GI:             GUILABEL
1708 #       no special presentation
1711 GI:             GUIMENU
1712 #       no special presentation
1715 GI:             GUIMENUITEM
1716 #       no special presentation
1719 GI:             GUISUBMENU
1720 #       no special presentation
1723 GI:             HARDWARE
1724 #       no special presentation
1727 GI:             INTERFACE
1728 #       no special presentation
1731 GI:             INTERFACEDEFINITION
1732 StartText:      \\fB
1733 EndText:        \\fP
1736 GI:             KEYCAP
1737 StartText:      \\fB<
1738 EndText:        >\\fP
1741 GI:             KEYCODE
1742 #       no special presentation
1745 GI:             KEYCOMBO
1746 #       no special presentation -- defer to the content
1749 GI:             KEYSYM
1750 StartText:      \\fB<
1751 EndText:        >\\fP
1754 GI:             LINEANNOTATION
1755 StartText:      \\fI
1756 EndText:        \\fP
1759 GI:             LITERAL
1760 StartText:      \\fB
1761 EndText:        \\fP
1764 GI:             MARKUP
1765 StartText:      \\f(CW
1766 EndText:        \\fP
1769 GI:             MEDIALABEL
1770 #       no special presentation
1773 GI:             MENUCHOICE
1774 #       no special presentation
1777 GI:             SHORTCUT
1778 #       no special presentation
1781 GI:             MOUSEBUTTON
1782 #       no special presentation
1785 GI:             OPTION
1786 StartText:      \\fB
1787 EndText:        \\fP
1790 GI:             OPTIONAL
1791 StartText:      [
1792 EndText:        ]
1795 GI:             PARAMETER
1796 StartText:      \\fB
1797 EndText:        \\fR
1800 GI:             PROPERTY
1801 StartText:      \\fB
1802 EndText:        \\fP
1805 GI:             REPLACEABLE
1806 StartText:      \\fI
1807 EndText:        \\fP
1810 GI:             RETURNVALUE
1811 StartText:      \\fB
1812 EndText:        \\fR
1815 GI:             SGMLTAG
1816 AttValue:       CLASS ELEMENT
1817 StartText:      \\fB<
1818 EndText:        >\\fP
1821 GI:             SGMLTAG
1822 StartText:      \\fB
1823 EndText:        \\fP
1826 GI:             STRUCTFIELD
1827 StartText:      \\fB
1828 EndText:        \\fR
1831 GI:             STRUCTNAME
1832 StartText:      \\fB
1833 EndText:        \\fR
1836 GI:             SYMBOL
1837 AttValue:       ROLE Variable
1838 StartText:      \\fI
1839 EndText:        \\fP
1842 GI:             SYMBOL
1843 StartText:      \\fI
1844 EndText:        \\fP
1847 GI:             SYSTEMITEM
1848 AttValue:       CLASS CONSTANT
1849 StartText:      \\fB
1850 EndText:        \\fP
1853 GI:             SYSTEMITEM
1854 AttValue:       CLASS ENVIRONVAR
1855 StartText:      \\fB
1856 EndText:        \\fP
1859 GI:             SYSTEMITEM
1860 AttValue:       CLASS RESOURCE
1861 StartText:      \\fB
1862 EndText:        \\fP
1865 GI:             SYSTEMITEM
1866 StartText:      \\fB
1867 EndText:        \\fP
1870 GI:             TOKEN
1871 StartText:      \\fB
1872 EndText:        \\fP
1875 GI:             TYPE
1876 StartText:      \\fB
1877 EndText:        \\fP
1880 GI:             USERINPUT
1881 StartText:      \\fB
1882 EndText:        \\fP
1885 GI:             AUTHOR
1886 #       no special presentation - defer to content
1889 GI:             CORPAUTHOR
1890 #       no special presentation
1893 GI:             MODESPEC
1894 #       nothing to render (this is meta information for Links)
1897 GI:             PRODUCTNAME
1898 StartText:      \\fB
1899 EndText:        \\fP
1902 GI:             PRODUCTNUMBER
1903 #       no special presentation
1906 GI:             SUBSCRIPT
1907 StartText:      \\d
1908 EndText:        \\u
1911 GI:             SUPERSCRIPT
1912 StartText:      \\u
1913 EndText:        \\d
1917 #############################################################################
1919 #  stuff that gets ignored (and doesn't belong elsewhere)
1921 #   ####     #####     #####     #####     #####     #####     ####     #####     
1923 GI:             TITLEABBREV
1924 #       this element is ignored in favor of the real title
1925 Ignore:         all
1930 #############################################################################
1932 #  handle layout-specific stuff and PIs
1934 #   ####     #####     #####     #####     #####     #####     ####     #####     
1936 GI:             BEGINPAGE
1937 StartText:      ^.br\s
1938 EndText:        ^
1941 GI:             _x-break
1942 StartText:      ^.br\s
1943 EndText:        ^
1946 GI:             _sml-break
1947 StartText:      ^.br\s
1948 EndText:        ^
1951 GI:             _sml-need
1952 StartText:      ^.ne\s
1953 EndText:        ^
1956 GI:             _sml-size
1957 StartText:      ^.ps\s
1958 EndText:        ^
1961 GI:             _sml-indent
1962 StartText:      ^.in\s
1963 EndText:        ^
1966 GI:             _sml-space
1967 StartText:      ^.sp\s
1968 EndText:        ^
1971 GI:             _sml-tabset
1972 StartText:      ^.ta\s
1973 EndText:        ^
1977 #############################################################################
1979 #  General purpose transpecs
1981 #   ####     #####     #####     #####     #####     #####     ####     #####     
1983 GI:             _passthrough
1984 SpecID:         1000
1987 GI:             _passthrough2
1988 SpecID:         1001
1989 StartText:      ${+caps}
1990 Ignore:         all
1993 GI:             _doTitle
1994 SpecID:         1010
1995 StartText:      ^.PP^\\fB
1996 EndText:        \\fR^.PP^
2000 #############################################################################
2002 #  Catch-all for unknown PIs -- ignore them...
2004 #   ####     #####     #####     #####     #####     #####     ####     #####     
2006 GI:             _*
2007 Ignore:         data
2011 #############################################################################
2013 #  Catch-all for unknown elements -- just output their content..
2015 #   ####     #####     #####     #####     #####     #####     ####     #####     
2017 #GI:    *