11414Scindi.ig
21414Scindidevtag.tmac - macro package for adding tags to roff documents.
31414Scindi
41414ScindiFile position: <groff_source_top>/tmac/devtag.tmac
53062ScindiInstalled position: groff's main macro directory.
63062Scindi
71414Scindi------------------------------------------------------------------------
81414Scindi    Legalize
91414Scindi------------------------------------------------------------------------
101414Scindi
111414ScindiThis file is part of groff, the GNU roff type-setting system.
121414Scindi
131414ScindiCopyright (C) 2004 Free Software Foundation, Inc.
141414Scindiwritten by Gaius Mulley <gaius@glam.ac.uk>.
151414Scindi
161414Scindigroff is free software; you can redistribute it and/or modify it under
171414Scindithe terms of the GNU General Public License as published by the Free
181414ScindiSoftware Foundation; either version 2, or (at your option) any later
191414Scindiversion.
201414Scindi
211414Scindigroff is distributed in the hope that it will be useful, but WITHOUT
224087ScindiANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
231414ScindiFITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
241414Scindifor more details.
251414Scindi
261414ScindiYou should have received a copy of the GNU General Public License
271414Scindialong with groff; see the file COPYING.  If not, write to the Free
281414ScindiSoftware Foundation, 51 Franklin St - Fifth Floor, Boston, MA
291414Scindi02110-1301, USA.
301414Scindi
311414Scindi
321414Scindi------------------------------------------------------------------------
331414Scindi    Description
341414Scindi------------------------------------------------------------------------
351414Scindi
361414ScindiA simple set of macros to provide markup devices (currently only grohtml)
371414Scindiwith tags that define the meaning of the formatted text and also
381414Scindibasic formatting instructions.  It generalizes the tag concept used within
393062Scindigrohtml and in the future it is hoped that more markup based devices
403062Scindican capitalize on this work.  It also clearly defines those tags which are
413062Scindihonoured by grohtml.  Note that not all tags are included here.  Some
423062Scindiof the grohtml specific tags (header specific and jobname, etc.) are
433062Scindicalled directly from within www.tmac.  The tags defined here are
443062Scindireasonably generic and could be applied to other devices.
453062Scindi..
461414Scindi.
471414Scindi.do if d DEVTAG-NH .nx
483062Scindi.
493062Scindi.nr _C \n(.C
501414Scindi.cp 0
511414Scindi.
524087Scindi.\" --------------------------------------------------------------------
534087Scindi.\" DEVTAG <name>
544087Scindi.\"
554087Scindi.\"   Emit a tag <name>
564087Scindi.\"
574087Scindi.de DEVTAG
581414Scindi.  tag devtag:\\$*
593062Scindi..
603062Scindi.\" --------------------------------------------------------------------
613062Scindi.\" DEVTAG-NEXT <name>
621414Scindi.\"
631414Scindi.\"   When the troff state changes, emit tag <name>
643062Scindi.\"
653062Scindi.de DEVTAG-NEXT
664087Scindi.  taga devtag:\\$*
671414Scindi..
681414Scindi.
691414Scindi.\" --------------------------------------------------------------------
701414Scindi.\"  SH <level>
711414Scindi.\"  NH <level>
721414Scindi.\"       tell device we are starting a numbered heading
731414Scindi.\"       Takes a single parameter <level>. <level> 1
741414Scindi.\"       is the outer most level.
751414Scindi.
761414Scindi.de DEVTAG-NH
774087Scindi.   DEVTAG ".NH \\$1"
784087Scindi..
791414Scindi.als DEVTAG-SH DEVTAG-NH
801414Scindi.
811414Scindi.\" --------------------------------------------------------------------
821414Scindi.\"  COL <n>
831414Scindi.\"     indicate that the following text is aligned for the column <n>
841414Scindi.\"     n: [1..MAX(n)]
85.
86.de DEVTAG-COL
87.   DEVTAG ".col \\$1"
88..
89.
90.\" --------------------------------------------------------------------
91.\"  EO-H
92.\"     indicate that a header has finished.
93.
94.de DEVTAG-EO-H
95.   DEVTAG ".eo.h"
96..
97.\" --------------------------------------------------------------------
98.\"  EO-TL
99.\"     indicate that a title has finished.
100.
101.de DEVTAG-EO-TL
102.   DEVTAG ".eo.tl"
103..
104.\" --------------------------------------------------------------------
105.\"  TL
106.\"     indicate that the following text forms a title.
107.
108.de DEVTAG-TL
109.   DEVTAG ".tl"
110..
111.
112.\" --------------------------------------------------------------------
113.\"  COL-NEXT <n>
114.\"     emit a column tag just before the next glyph.
115.
116.de DEVTAG-COL-NEXT
117.   DEVTAG-NEXT ".col \\$1"
118..
119.
120.
121.cp \n[_C]
122.
123.
124.\" --------------------------------------------------------------------
125.\" Emacs settings
126.\" --------------------------------------------------------------------
127.
128.\" Local Variables:
129.\" mode: nroff
130.\" End:
131.\" EOF
132