docs/master: style annotate

docs/master

annotate style @ 151:ff3a6a0e6255

Added system for references within the document. Macros: .Id and .Cf. ``.Id foo'' places a marker at that place. ``.Cf foo'' puts the section number of the marked place there. ``.Cf foo.page'' puts the page number of the marked place there.

author	markus schnalke <meillo@marmaro.de>
date	Fri, 06 Jul 2012 14:59:08 +0200
parents	83681ad27ec8
children	1b9bdc178610

rev	line source
meillo@0	1 .do xflag 3
meillo@0	2 .de __
meillo@0	3 ..
meillo@0	4 .blm __ \" ignore empty lines in input
meillo@0	5 .lc_ctype en_US.utf8
meillo@0	6 .mediasize a4
meillo@0	7
meillo@0	8 .fp 1 R LinLibertine_R otf
meillo@0	9 .feature R +onum
meillo@0	10 .fp 2 I LinLibertine_RI otf
meillo@0	11 .feature I +onum
meillo@0	12 .fp 3 B LinLibertine_RB otf
meillo@0	13 .feature B +onum
meillo@0	14 .fp 4 BI LinLibertine_RBI otf
meillo@0	15 .feature BI +onum
meillo@0	16 .fp 5 CW TerminusMedium-4.36 ttf
meillo@0	17 .fp 0 CI TerminusMediumItalic-4.36 ttf
meillo@0	18 .fp 0 CB TerminusBold-4.36 ttf
meillo@0	19 .fp 0 L TerminusMedium-4.36 ttf
meillo@82	20 .ftr CW -\-`\`'\'
meillo@82	21 .ftr CI -\-`\`'\'
meillo@82	22 .ftr CB -\-`\`'\'
meillo@82	23 .ftr L -\-`\`'\'
meillo@15	24 .fp 0 SC LinLibertine_R otf
meillo@15	25 .feature SC +onum +smcp
meillo@15	26 .fp 0 IC LinLibertine_RI otf
meillo@15	27 .feature IC +onum +smcp
meillo@0	28 .fp 0 BC LinLibertine_RB otf
meillo@0	29 .feature BC +onum +smcp
meillo@0	30
meillo@0	31 .ig
meillo@75	32 . nr PS 11
meillo@75	33 . nr VS 13
meillo@75	34 . padj
meillo@0	35 ..
meillo@0	36
meillo@0	37 .nr PI 3n
meillo@41	38 .nr PD .3v
meillo@91	39 .nr QI 6n
meillo@0	40 .nr lu 0
meillo@0	41 .af PN i
meillo@0	42
meillo@15	43 .ds _E '\\\\n(PN''\f(SCMarkus Schnalke: The Modern Mail Handler\fP' \" left
meillo@15	44 .ds _O '\f(SCChapter \\\\n(H1\ \ \\\\*(_C\fP''\\\\n(PN' \" right
meillo@29	45 .ds _o '\f(SC\\\\*(_C\fP''\\\\n(PN' \" right
meillo@0	46 .ds CH "
meillo@0	47
meillo@0	48 .nr HM 3.3c
meillo@0	49 .nr FM 6.6c
meillo@75	50 .nr LL 13c
meillo@75	51 .ll 13c
meillo@0	52 .nr LT \n(LL
meillo@0	53
meillo@81	54 . \" _M - change margins for text block on next page
meillo@81	55 .de _M
meillo@99	56 .if t .if o .nr PO 5c
meillo@99	57 .if t .if e .nr PO 3c
meillo@0	58 .ds CF "
meillo@0	59 ..
meillo@0	60 .wh -1u _M
meillo@0	61
meillo@90	62 . \" Lp - enlarge the current page by one line to avoid widows
meillo@90	63 .de Lp
meillo@90	64 .ch FO -\n(FMu+1v
meillo@90	65 ..
meillo@90	66
meillo@81	67 . \" CW - Set text in CW font (similar to .B and .I)
meillo@0	68 .de CW
meillo@0	69 .nr PQ \\n(.f
meillo@0	70 .if t \{\
meillo@0	71 . ft CW
meillo@0	72 . if !^\\$1^^ \&\\$1\f\\n(PQ\\$2
meillo@0	73 .\}
meillo@0	74 .if n \{\
meillo@0	75 . ie ^\\$1^^ .ul 999
meillo@0	76 . el .ul 1
meillo@0	77 . if \\n(.$=1 \&\\$1
meillo@0	78 . if \\n(.$>1 \&\\$1\c
meillo@0	79 . if \\n(.$>1 \&\\$2
meillo@0	80 .\}
meillo@0	81 ..
meillo@0	82
meillo@81	83 . \" refer(1) stuff
meillo@35	84 .ds [. " [
meillo@0	85 .ds .] ]
meillo@0	86 .rm ]<
meillo@0	87 .de ]<
meillo@0	88 . LP
meillo@0	89 . de FP
meillo@0	90 . IP \\\\$1.
meillo@0	91 \\..
meillo@0	92 . rm FS FE
meillo@0	93 ..
meillo@0	94
meillo@81	95 . \" PT - page top macro of ms
meillo@0	96 .am PT
meillo@0	97 . rs
meillo@0	98 ..
meillo@0	99
meillo@81	100
meillo@81	101 . \" RN - Reset PN and continue on an odd page ($1=number-format)
meillo@81	102 .de RN
meillo@81	103 .ie e .pn 1
meillo@81	104 .el \{
meillo@81	105 . pn 0
meillo@81	106 . bp
meillo@81	107 .\}
meillo@81	108 .ie \\n(.$=1 .af PN \\$1
meillo@81	109 .el .af PN 1
meillo@81	110 ..
meillo@81	111
meillo@81	112
meillo@81	113 . \" T_ - Add TOC entry ($1=pre-space $2=indent-level $3=text)
meillo@81	114 .de T_
meillo@79	115 .tm TOC____.sp \\$1
meillo@79	116 .tm TOC____\&\\h'\\$2u2u\\n(PIu'\\$3\0\0\a\t\\n(PN\fR
meillo@79	117 ..
meillo@79	118
meillo@81	119 . \" NH - redefine numbered heading
meillo@0	120 .de NH
meillo@0	121 .SH
meillo@0	122 .nr NS \\$1
meillo@0	123 .if !\\n(.$ .nr NS 1
meillo@0	124 .if !\\n(NS .nr NS 1
meillo@0	125 .nr H\\n(NS +1
meillo@6	126 .if \\n(NS<2 .nr H2 0
meillo@6	127 .if \\n(NS<3 .nr H3 0
meillo@0	128 .ds SN \\n(H1
meillo@6	129 .if \\n(NS>1 .as SN \&.\\n(H2
meillo@6	130 .if \\n(NS>2 .as SN \&.\\n(H3
meillo@0	131 ..
meillo@0	132
meillo@81	133 . \" H- - Chapter unnumbered and not in TOC ($2=="no" -> no page hdrs)
meillo@40	134 .de H-
meillo@29	135 .EH "
meillo@29	136 .OH "
meillo@29	137 .bp
meillo@81	138 .if e .rs \" move to an odd page
meillo@29	139 .if e .bp
meillo@29	140 .lg 0
meillo@29	141 .nr PS +6
meillo@29	142 .nr VS +6
meillo@29	143 .SH
meillo@29	144 .ce 1
meillo@29	145 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@29	146 \&\\$1
meillo@29	147 .br
meillo@29	148 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@29	149 .nr PS -6
meillo@29	150 .nr VS -6
meillo@29	151 .lg
meillo@40	152 .if !,\\$2,no, \{
meillo@40	153 . EH "\\\\*(_E
meillo@40	154 . ie \\n(H1 .OH "\\\\*(_O
meillo@40	155 . el .OH "\\\\*(_o
meillo@40	156 . ds CF \\n(PN
meillo@40	157 .\}
meillo@81	158 .RT
meillo@29	159 .sp 4
meillo@29	160 .nr PP 0
meillo@29	161 ..
meillo@29	162
meillo@81	163 . \" H0 - Chapter ($2=="no" -> not numbered)
meillo@0	164 .de H0
meillo@0	165 .EH "
meillo@0	166 .OH "
meillo@0	167 .bp
meillo@81	168 .if e .rs \" begin chapter on an odd page
meillo@0	169 .if e .bp
meillo@81	170 .lg 0
meillo@81	171 .nr PS +6
meillo@81	172 .nr VS +6
meillo@81	173 .ie ,\\$2,no, .SH
meillo@81	174 .el \{\
meillo@0	175 . NH 1
meillo@0	176 . ce 1
meillo@0	177 Chapter \\*(SN
meillo@0	178 . sp .5
meillo@0	179 .\}
meillo@81	180 .ce 1
meillo@81	181 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@0	182 \&\\$1
meillo@81	183 .br
meillo@81	184 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@81	185 .nr PS -6
meillo@81	186 .nr VS -6
meillo@81	187 .lg
meillo@81	188 .\" add to TOC
meillo@79	189 .rm t_
meillo@79	190 .if !,\\$2,no, .ds t_ \\*(SN\0\0
meillo@79	191 .T_ .5v 0 "\fB\\*(t_\\$1
meillo@81	192 .\" set page headers and footers
meillo@29	193 .EH "\\\\*(_E
meillo@81	194 .ds _C "\\$1
meillo@29	195 .ie \\n(H1 .OH "\\\\*(_O
meillo@29	196 .el .OH "\\\\*(_o
meillo@29	197 .ds CF \\n(PN
meillo@81	198 .RT
meillo@0	199 .sp 4
meillo@0	200 .nr PP 0
meillo@0	201 ..
meillo@0	202
meillo@39	203
meillo@81	204 . \" H1 - Section ($2=="no" -> not numbered)
meillo@0	205 .de H1
meillo@0	206 .br
meillo@0	207 .ne 7
meillo@1	208 .sp
meillo@81	209 .lg 0
meillo@81	210 .nr PS +2
meillo@81	211 .nr VS +2
meillo@81	212 .ie '\\$2'no' .SH
meillo@81	213 .el .NH 2
meillo@6	214 .if !'\\$2'no' \&\\*(SN
meillo@81	215 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@81	216 \&\\$1
meillo@81	217 .br
meillo@81	218 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@81	219 .nr PS -2
meillo@81	220 .nr VS -2
meillo@81	221 .lg
meillo@81	222 .if !'\\$2'no' .T_ .3v 1 "\\*(SN\0\0\\$1 \" add to TOC
meillo@81	223 .RT
meillo@6	224 .nr PP 0
meillo@6	225 ..
meillo@6	226
meillo@81	227 . \" H2 - Subsection
meillo@6	228 .de H2
meillo@6	229 .br
meillo@7	230 .ne 4
meillo@59	231 .NH 3
meillo@81	232 \&\\*(SN \\$1
meillo@81	233 .T_ 0 2 "\\*(SN\0\0\\$1 \" add to TOC
meillo@11	234 .RT
meillo@11	235 .nr PP 0
meillo@11	236 ..
meillo@11	237
meillo@81	238 . \" U2 - Subsection unnumbered
meillo@11	239 .de U2
meillo@11	240 .br
meillo@11	241 .ne 4
meillo@11	242 .SH
meillo@81	243 \&\\$1
meillo@11	244 .RT
meillo@0	245 .nr PP 0
meillo@0	246 ..
meillo@0	247
meillo@81	248 . \" U3 - Subsubsection unnumbered
meillo@73	249 .de U3
meillo@73	250 .br
meillo@73	251 .ne 4
meillo@73	252 .RT
meillo@73	253 .sp
meillo@73	254 .I "\\$1
meillo@73	255 .RT
meillo@73	256 .nr PP 0
meillo@73	257 ..
meillo@73	258
meillo@81	259 . \" P - Paragraph (indented unless following a heading)
meillo@0	260 .de P
meillo@0	261 .ie \\n(PP .PP
meillo@0	262 .el .LP
meillo@0	263 .nr PP 1
meillo@0	264 ..
meillo@0	265
meillo@81	266 . \" IP - Paragraph with hanging label
meillo@0	267 .am IP
meillo@0	268 .nr PP 0
meillo@0	269 ..
meillo@0	270
meillo@81	271 . \" BU - Bulleted paragraph
meillo@6	272 .de BU
meillo@6	273 .IP \(bu
meillo@6	274 ..
meillo@6	275
meillo@98	276 . \" QS - Block quote start
meillo@98	277 .de QS
meillo@91	278 .ti \\n(.iu
meillo@137	279 .\"RT
meillo@98	280 .sp 2u*\\n(PDu
meillo@91	281 .ne 1.1
meillo@0	282 .ps -1
meillo@103	283 .vs -1
meillo@91	284 .in +\\n(QIu
meillo@91	285 .ll -\\n(QIu
meillo@91	286 .ti \\n(.iu
meillo@98	287 .\"if \\n(Qp .ti +\\n(PIu
meillo@98	288 .\"nr QP 1
meillo@98	289 .\"rr Qp
meillo@98	290 ..
meillo@98	291
meillo@98	292 . \" QP - Block quote paragraph
meillo@98	293 .de QP
meillo@98	294 .sp \n(PDu
meillo@98	295 .ne 1.1
meillo@98	296 .ti +\\n(PIu
meillo@98	297 ..
meillo@98	298
meillo@98	299 . \" QP - Block quote end
meillo@98	300 .de QE
meillo@98	301 .sp \\n(PDu
meillo@98	302 .in -\\n(QIu
meillo@98	303 .ll +\\n(QIu
meillo@98	304 .ti \\n(.iu
meillo@103	305 .ps +1
meillo@103	306 .vs +1
meillo@0	307 ..
meillo@0	308
meillo@81	309 . \" DS - Code display
meillo@0	310 .am DS
meillo@0	311 .ft CW
meillo@0	312 .ps -1
meillo@0	313 .ta T 8n
meillo@0	314 ..
meillo@0	315
meillo@82	316 . \" VS - verbatim text start (\\ -> ^G; ' -> disabled; . -> ^B)
meillo@82	317 .de VS
meillo@82	318 .br
meillo@119	319 .ne 3
meillo@82	320 .sp \n(DDu
meillo@119	321 .di _V
meillo@82	322 .nf
meillo@82	323 .ft CW
meillo@119	324 .ps -.5
meillo@82	325 .\" set up verbatim environment
meillo@82	326 \.blm
meillo@82	327 \.ec
meillo@82	328 \.c2 ""
meillo@82	329 \.cc
meillo@82	330 ..
meillo@82	331
meillo@82	332 . \" VE - verbatim text end (NOTE: Needs to be called as ^BVE !)
meillo@82	333 .de VE
meillo@82	334 \" restore the special characters
meillo@82	335 cc
meillo@82	336 .c2
meillo@82	337 .ec
meillo@119	338 .br
meillo@119	339 .di
meillo@119	340 .ne \\n(dnu+1v \" ensure enough space on the page
meillo@119	341 .if t .in +.5i
meillo@119	342 .if n .in +8n
meillo@119	343 .ta T 8n
meillo@119	344 \.ec \" set up verbatim environment, once again
meillo@119	345 \.c2 ""
meillo@119	346 \.cc
meillo@119	347 _V \" output the verbatim content
meillo@119	348 \" restore the special characters
meillo@119	349 cc
meillo@119	350 .c2
meillo@119	351 .ec
meillo@82	352 .blm __
meillo@82	353 .if t .in -.5i
meillo@82	354 .if n .in -8n
meillo@82	355 .sp \n(DDu
meillo@82	356 .ft P
meillo@82	357 .fi
meillo@82	358 .TA
meillo@82	359 ..
meillo@82	360
meillo@83	361 . \" VF - verbatim text from file ($1=filename)
meillo@83	362 .de VF
meillo@83	363 .VS
meillo@83	364 so $1
meillo@83	365 VE
meillo@83	366 ..
meillo@83	367
meillo@81	368 . \" FA - XXX somehow related to footnotes?
meillo@0	369 .am FA
meillo@0	370 .ps 8
meillo@0	371 .vs 9
meillo@0	372 ..
meillo@18	373
meillo@18	374 .de Fn \" file name
meillo@18	375 .CW "\\$1" "\\$2
meillo@18	376 ..
meillo@18	377 .de Pn \" program name
meillo@18	378 .CW "\\$1" "\\$2
meillo@18	379 ..
meillo@18	380 .de Fu \" function
meillo@18	381 .CW "\\$1" "\\$2
meillo@18	382 ..
meillo@19	383 .de Ev \" env variable
meillo@19	384 .CW "\\$1" "\\$2
meillo@19	385 ..
meillo@18	386 .de Cl \" command line
meillo@18	387 `\c
meillo@18	388 .CW "\\$1" "'\\$2
meillo@18	389 ..
meillo@18	390 .de Sw \" switch
meillo@18	391 .CW "\\$1" "\\$2
meillo@18	392 ..
meillo@84	393 .de Ar \" argument
meillo@84	394 .CW "\f(CI\\$1" "\\$2
meillo@84	395 ..
meillo@18	396 .de Mp \" man page
meillo@18	397 .I "\\$1" "\\$2
meillo@18	398 ..
meillo@18	399 .de Pe \" profile entry
meillo@18	400 .CW "\\$1" "\\$2
meillo@18	401 ..
meillo@84	402 .de Hd \" mail header field
meillo@84	403 .CW "\\$1:\&" "\\$2
meillo@84	404 ..
meillo@67	405
meillo@81	406 .de Ci \" commit hash ref
meillo@70	407 .ds _t \\$1
meillo@70	408 .substring _t 0 6
meillo@67	409 [\(rh
meillo@70	410 .CW "\\*(_t" "]\\$2
meillo@67	411 ..
meillo@77	412
meillo@151	413 . \" Cf - reference within the document ($1=name of ref file)
meillo@151	414 .de Cf
meillo@151	415 \.if !\\nZ .so refs/\\$1 \c
meillo@151	416 \\$2
meillo@77	417 ..
meillo@151	418
meillo@151	419 . \" Id - put a referenceable marker here ($1=identifier)
meillo@151	420 .de Id
meillo@151	421 .tm REF____\\$1\t\\*(SN\t\\n(PN
meillo@151	422 ..