1 #############################################################################
5 #############################################################################
7 # Copyright (c) 1996 X Consortium
8 # Copyright (c) 1996 Dalrymple Consulting
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:
17 # The above copyright notice and this permission notice shall be included in
18 # all copies or substantial portions of the Software.
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.
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.
33 #############################################################################
35 # Written 5/29/96 by Fred Dalrymple
37 #############################################################################
49 #############################################################################
51 # Hierarchy (and document meta stuff)
53 # #### ##### ##### ##### ##### ##### #### #####
56 StartText: ^.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
57 ^.TH "${_followrel descendant REFENTRYTITLE 1000}"
58 "${_followrel descendant MANVOLNUM 1000}"
60 "${_followrel descendant REFMISCINFO 1000}"^
61 EndText: ^...\\" created by instant / docbook-to-man, ${date}^
70 # inside DocInfo, which we're ignoring
78 StartText: ^.SH "NAME"^
87 Relation: sibling- REFDESCRIPTOR
88 # inhibit REFNAMEs when a REFDESCRIPTOR is present
93 StartText: ${_isset refnameseen xxx 20}
94 EndText: ${_set refnameseen xxx}
113 StartText: ^.SH "SYNOPSIS"^
118 StartText: ^.SH "${_followrel child TITLE 1001}"^
123 StartText: ^.SS "${_followrel child TITLE 1000}"^
128 StartText: ^.SS "${_followrel child TITLE 1000}"^
153 # part of the DocInfo structure, which is ignored
159 # part of the DocInfo structure, which is ignored
165 # part of the DocInfo structure, which is ignored
171 # part of the DocInfo structure, which is ignored, though this element
172 # if accessed directly by the _followrel call from the REFENTRY element.
177 # part of the DocInfo structure, which is ignored
182 # part of the DocInfo structure, which is ignored
187 # part of the DocInfo structure, which is ignored
193 # part of the DocInfo structure, which is ignored
199 # part of the DocInfo structure, which is ignored
205 # part of the DocInfo structure, which is ignored
211 # part of the DocInfo structure, which is ignored
217 # part of the DocInfo structure, which is ignored
223 # part of the DocInfo structure, which is ignored
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 # #### ##### ##### ##### ##### ##### #### #####
239 # nothing in this context
245 # nothing in this context
251 # nothing in this context
257 # nothing in this context
263 # nothing in this context
267 Relation: parent ENTRY
269 # first one does nothing in this context
273 Relation: parent ENTRY
279 #############################################################################
281 # Regular "branch" stuff
283 # #### ##### ##### ##### ##### ##### #### #####
286 # it's all done in TITLE (FORMALPARA) and PARA
296 Relation: ancestor LISTITEM
297 StartText: ^.IP "" 10^
301 Relation: ancestor STEP
302 StartText: ^.IP "" 10^
314 StartText: ^.PP^.nf^\\f(CW
315 EndText: \\fR^.fi^.PP^
345 Relation: child TITLE
349 StartText: ^.SS "Abstract"^
360 StartText: ^.SS "Revision History"^
365 StartText: ^.PP^\\fBRevision:\\fR\s
389 # nothing to do specifically in ProgramListingCO -- it falls to
390 # the content of ProgramListing and any callout list
399 # nothing to do specifically in ScreenCO -- it falls to
400 # the content of Screen and any callout list
404 # nothing specific to do here -- defer to any ScreenInfo or the
414 # nothing to do specifically in GraphicCO -- it falls to
415 # the content of Graphic and any callout list
419 # nothing special to do here -- it falls to the content.
423 # nothing special to do here -- it falls to the content.
433 # nothing special to do here -- it falls to the content.
443 Relation: child TITLE
449 StartText: ^.PP^.RS^\\fB[ Sidebar ]\\fR^
455 StartText: ^\\fB[ Sidebar:\s
460 StartText: ^.SS "Highlights"^
464 # nothing to do specially -- an included title may occur
474 #############################################################################
478 # #### ##### ##### ##### ##### ##### #### #####
481 # nothing to do for the anchor of a callout
486 # not much to do with representing the anchor of callouts in n/troff
491 # part of AreaSpec, which is being ignored
496 # part of AreaSpec, which is being ignored
500 #############################################################################
504 # #### ##### ##### ##### ##### ##### #### #####
512 # just the content...
516 # just the content...
520 # just the content...
553 #############################################################################
557 # #### ##### ##### ##### ##### ##### #### #####
560 Relation: ancestor ITEMIZEDLIST
566 Relation: ancestor GLOSSLIST
572 Relation: ancestor ORDEREDLIST
578 Relation: ancestor SIMPLELIST
584 Relation: ancestor VARIABLELIST
590 Relation: ancestor SEGMENTEDLIST
596 # Nothing to do here.. see glossentry, etc
617 StartText: (\\fIacronym:\s\\fR
623 StartText: (\\fIabbreviation:\s\\fR
628 StartText: ^\\fISee \\fR
632 # nothing special to do -- just pass the content.
636 StartText: ^^\\fISee Also \\fR
640 Relation: ancestor ITEMIZEDLIST
646 Relation: ancestor GLOSSLIST
652 Relation: ancestor ORDEREDLIST
658 Relation: ancestor SIMPLELIST
664 Relation: ancestor VARIABLELIST
670 Relation: ancestor SEGMENTEDLIST
680 Context: ITEMIZEDLIST
681 StartText: ^.IP "\ \ \ \\(bu" 6^
685 Relation: ancestor ITEMIZEDLIST
691 Relation: ancestor GLOSSLIST
697 Relation: ancestor ORDEREDLIST
703 Relation: ancestor SIMPLELIST
709 Relation: ancestor VARIABLELIST
715 Relation: ancestor SEGMENTEDLIST
721 StartText: ${_set orderlist 1}
726 StartText: ^.IP "\ \ \ ${orderlist}." 6^
731 Relation: ancestor ITEMIZEDLIST
737 Relation: ancestor GLOSSLIST
743 Relation: ancestor ORDEREDLIST
749 Relation: ancestor SIMPLELIST
755 Relation: ancestor VARIABLELIST
761 Relation: ancestor SEGMENTEDLIST
767 # nothing to do here..
793 StartText: ^.IP "" 10^
798 Relation: ancestor ITEMIZEDLIST
804 Relation: ancestor GLOSSLIST
810 Relation: ancestor ORDEREDLIST
816 Relation: ancestor SIMPLELIST
822 Relation: ancestor VARIABLELIST
828 Relation: ancestor SEGMENTEDLIST
834 # nothing to do now, see VarListEntry
838 # nothing to do now, see Term
848 Context: VARLISTENTRY
849 # nothing special to do..
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.^
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.^
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.^
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.^
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.^
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.^
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.^
895 Context: SEGMENTEDLIST
896 # ignored by default -- must be called by SEGMENTEDLIST gi
900 GI: _segmentedlist_title
902 StartText: ^.sp 1^\\fB
921 # defer to the content...
922 StartText: ${_set procstep 1}${_set procsubstep 1}
933 StartText: ^.PP^\\fISubstep ${procsubstep}.\s\s
935 Increment: procsubstep 1
939 StartText: ^.PP^\\fIStep ${procstep}.\s\s
941 Increment: procstep 1
956 StartText: ${_set callout 1}
957 # nothing to do specifically, defer to the content...
967 StartText: ^.PP^\\fICallout ${callout}.\s\s\\fR
973 #############################################################################
977 # #### ##### ##### ##### ##### ##### #### #####
980 StartText: ^.SS "Message Set"^
984 StartText: ^.PP^\\fBMessage Entry\\fR^.RS^
989 Relation: child TITLE
995 StartText: ^.PP^\\fBMessage:\\fR^.PP^
1001 StartText: ^.PP^\\fB
1006 # nothing specific -- just groups (MsgLevel | MsgOrig | MsgAud)*
1010 # nothing special -- defer to content
1015 StartText: ^.PP^\\fB
1035 StartText: ^.PP^\\fB
1045 StartText: ^.PP^\\fB
1050 StartText: ^.PP^\\fIMessage level:\s\s\\fR
1055 StartText: ^.PP^\\fIMessage origin:\s\s\\fR
1060 StartText: ^.PP^\\fIMessage audience:\s\s\\fR
1071 StartText: \\fR^\\fIMessage text:\\fR\s\s
1076 #############################################################################
1080 # #### ##### ##### ##### ##### ##### #### #####
1083 Relation: child TITLE
1089 StartText: ^.PP^.RS^\\fBCaution:\s\s
1095 StartText: ^\\fBCaution:\s\s
1100 Relation: child TITLE
1101 StartText: ^.PP^.RS^
1106 StartText: ^.PP^.RS^\\fBImportant:\s\s
1112 StartText: ^\\fBImportant:\s\s
1117 Relation: child TITLE
1123 StartText: ^.PP^.RS^\\fBNote:\s\s
1129 StartText: ^\\fBNote:\s\s
1134 Relation: child TITLE
1140 StartText: ^.PP^.RS^\\fBTip:\s\s
1146 StartText: ^\\fBTip:\s\s
1151 Relation: child TITLE
1157 StartText: ^.PP^.RS^\\fBWarning:\s\s
1163 StartText: ^\\fBWarning:\s\s
1168 #############################################################################
1172 # #### ##### ##### ##### ##### ##### #### #####
1175 StartText: ^.PP^.nf^
1187 EndText: ${_attval REP REPEAT 505}\s
1193 EndText: ${_attval REP REPEAT 505}\s
1197 AttValue: CHOICE OPT
1199 EndText: ${_attval REP REPEAT 505}]\s
1203 # no special attrs -- just pass content through
1204 EndText: ${_attval REP REPEAT 505}\s
1214 AttValue: CHOICE OPT
1216 EndText: ]\s${_attval REP REPEAT 505}
1220 AttValue: CHOICE REQ
1222 EndText: }\s${_attval REP REPEAT 505}
1226 AttValue: CHOICE OPTMULT
1228 EndText: ]]\s${_attval REP REPEAT 505}
1232 AttValue: CHOICE REQMULT
1234 EndText: }}\s${_attval REP REPEAT 505}
1238 AttValue: CHOICE PLAIN
1239 EndText: ${_attval REP REPEAT 505}
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
1257 StartText: ^.PP^.nf^
1261 GI: FUNCSYNOPSISINFO
1267 # nothing special -- just pass through content (looks like
1278 StartText: ^\t\t\t\\fB
1283 StartText: \\fBvoid\\fR);
1287 StartText: \\fB\\&...\\fR);
1291 Relation: sibling+ PARAMDEF
1302 #############################################################################
1306 # #### ##### ##### ##### ##### ##### #### #####
1315 EndText: \s(link to external document ${TargetDocEnt})\s\\fR
1320 EndText: \s(link to URL ${URL})\s\\fR
1324 # just let the footnote ref mark come through
1328 # just let footnote body come through (-man doesn't support footnotes)
1333 StartText: \\fI(cross-reference to ``${_followlink ENDTERM 1000}'')\\fR\s
1337 StartText: \\fI(cross-reference to ``${_followlink LINKEND 600})''\\fR\s
1342 StartText: ${XREFLABEL}
1347 # nothing to do -- this just marks a place..
1351 #############################################################################
1353 # Graphics and Equations
1355 # #### ##### ##### ##### ##### ##### #### #####
1359 StartText: ^.PP^.if t .P! "${_filename}"^
1363 StartText: ^.if t .P! "${_filename}"^
1366 GI: INFORMALEQUATION
1367 # nothing special to do -- defer to graphic content..
1371 # nothing special to do -- defer to graphic content..
1376 StartText: ^.PP^\\fB
1381 # nothing special to do -- defer to graphic content..
1385 #############################################################################
1389 # #### ##### ##### ##### ##### ##### #### #####
1393 StartText: ^${_calstable tbl tablestart}^
1394 EndText: ^${_calstable tbl tableend}^
1398 StartText: ^.PP^\\fB${_followrel child TITLE 1000}\\fR
1399 ^${_calstable tbl tablestart}^
1400 EndText: ^${_calstable tbl tableend}^
1405 # handled in TABLE element
1410 StartText: ^${_calstable tbl tablegroup}^${_followrel child THEAD 700}${_followrel child TBODY 700}${_followrel child TFOOT 701}
1411 EndText: ${_calstable tbl tablegroupend}
1422 GI: THEAD TBODY TFOOT
1423 # they're called explicitly from TGROUP, but ignored here
1429 # nothing special to do -- just pass through content
1434 StartText: ^${_calstable tbl tablefoot}^
1438 StartText: ^${_calstable tbl rowstart}
1439 EndText: ${_calstable tbl rowend}
1443 StartText: ${_calstable tbl entrystart}
1444 EndText: ${_calstable tbl entryend}
1450 Message: ^IMPLEMENT <${_gi} ${_allatts}>^
1454 #############################################################################
1458 # #### ##### ##### ##### ##### ##### #### #####
1481 StartText: \s"See:\s
1486 StartText: \s"SeeAlso:\s
1491 #############################################################################
1493 # Author / OtherCredit material
1495 # #### ##### ##### ##### ##### ##### #### #####
1498 # nothing specific -- defer to content
1502 # nothing specific -- defer to content
1507 # nothing specific -- defer to content
1512 # nothing specific -- defer to content
1517 # nothing specific -- defer to content
1522 # nothing specific -- defer to content
1528 # nothing specific -- defer to content
1533 # nothing specific -- defer to content
1538 # nothing specific -- defer to content
1543 # nothing specific -- defer to content
1548 # nothing specific -- defer to content
1553 # nothing specific -- defer to content
1558 #############################################################################
1562 # #### ##### ##### ##### ##### ##### #### #####
1565 # no special presentation
1569 # no special presentation
1573 # no special presentation
1577 # no special presentation
1588 EndText: \\fP (${PUBWORK})\s
1597 # defer to content..
1611 # docbook says to inhibit this from finished products...
1616 # no special presentation
1630 # no special presentation
1634 # no special presentation
1643 EndText: \\u\\s-2TM\\s+2\\d
1647 # no special presentation
1651 # no special presentation
1675 # no special presentation
1684 # no special presentation
1708 # no special presentation
1712 # no special presentation
1716 # no special presentation
1720 # no special presentation
1724 # no special presentation
1728 # no special presentation
1731 GI: INTERFACEDEFINITION
1742 # no special presentation
1746 # no special presentation -- defer to the content
1770 # no special presentation
1774 # no special presentation
1778 # no special presentation
1782 # no special presentation
1816 AttValue: CLASS ELEMENT
1837 AttValue: ROLE Variable
1848 AttValue: CLASS CONSTANT
1854 AttValue: CLASS ENVIRONVAR
1860 AttValue: CLASS RESOURCE
1886 # no special presentation - defer to content
1890 # no special presentation
1894 # nothing to render (this is meta information for Links)
1903 # no special presentation
1917 #############################################################################
1919 # stuff that gets ignored (and doesn't belong elsewhere)
1921 # #### ##### ##### ##### ##### ##### #### #####
1924 # this element is ignored in favor of the real title
1930 #############################################################################
1932 # handle layout-specific stuff and PIs
1934 # #### ##### ##### ##### ##### ##### #### #####
1977 #############################################################################
1979 # General purpose transpecs
1981 # #### ##### ##### ##### ##### ##### #### #####
1995 StartText: ^.PP^\\fB
2000 #############################################################################
2002 # Catch-all for unknown PIs -- ignore them...
2004 # #### ##### ##### ##### ##### ##### #### #####
2011 #############################################################################
2013 # Catch-all for unknown elements -- just output their content..
2015 # #### ##### ##### ##### ##### ##### #### #####