tmac/www.tmac

   1 .ig
   2 www.tmac - macro package for adding HTML elements to roff documents.
   3
   4 File position: <groff_source_top>/tmac/www.tmac
   5 Installed position: groff's main macro directory.
   6
   7 ------------------------------------------------------------------------
   8     Legalize
   9 ------------------------------------------------------------------------
  10
  11 This file is part of groff, the GNU roff type-setting system.
  12
  13 Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
  14 written by Gaius Mulley <gaius@glam.ac.uk>, with additions by
  15 Werner Lemberg <wl@gnu.org> and Bernd Warken <bwarken@mayn.de>.
  16
  17 groff is free software; you can redistribute it and/or modify it under
  18 the terms of the GNU General Public License as published by the Free
  19 Software Foundation; either version 2, or (at your option) any later
  20 version.
  21
  22 groff is distributed in the hope that it will be useful, but WITHOUT
  23 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  24 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  25 for more details.
  26
  27 You should have received a copy of the GNU General Public License
  28 along with groff; see the file COPYING.  If not, write to the Free
  29 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  30 02111-1307, USA.
  31
  32
  33 ------------------------------------------------------------------------
  34     Description
  35 ------------------------------------------------------------------------
  36
  37 A simple set of macros to provide HTML documents with basic
  38 www functionality.  It should work with any macro set.
  39 ..
  40 .
  41 .\" --------------------------------------------------------------------
  42 .\" Setup
  43 .\" --------------------------------------------------------------------
  44 .
  45 .nr _C \n(.C
  46 .cp 0
  47 .
  48 .nr www-html 0
  49 .if '\*[.T]'html' .nr www-html 1
  50 .
  51 .\" set up www-image-template
  52 .
  53 .if !d www-image-template \
  54 .  ds www-image-template
  55 .
  56 .if r ps4html \{\
  57 .  \" remove the title command when we are generating images for html
  58 .  \" (stops a title accidentally appearing inside an image)
  59 .  di www-notitle
  60 .  tl ''''
  61 .  di
  62 .  rm tl
  63 .  de tl
  64 .  .
  65 .\}
  66 .
  67 .
  68 .\" --------------------------------------------------------------------
  69 .\" Test for `.substring'; result in register `www.substring_ok'.
  70 .\" The automated break points in .URL addresses are only added if
  71 .\" this register is non-zero.
  72 .\"
  73 .nr www:substring_ok 0
  74 .de www:@test_substring
  75 .  if !d substring \
  76 .    return
  77 .  ds \\$0:s abcdefg\"
  78 .  substring \\$0:s 1 1
  79 .  if !'\\*[\\$0:s]'b' \{\
  80 .    rm \\$0:s
  81 .    return
  82 .  \}
  83 .  ds \\$0:s abcdefg\"
  84 .  substring \\$0:s 0 0
  85 .  if !'\\*[\\$0:s]'a' \{\
  86 .    rm \\$0:s
  87 .    return
  88 .  \}
  89 .  ds \\$0:s abcdefg\"
  90 .  substring \\$0:s 1 -1
  91 .  if !'\\*[\\$0:s]'bcdefg' \{\
  92 .    rm \\$0:s
  93 .    return
  94 .  \}
  95 .  nr www:substring_ok 1
  96 .  rm \\$0:s
  97 ..
  98 .www:@test_substring
  99 .rm www:@test_substring
 100 .
 101 .
 102 .\" --------------------------------------------------------------------
 103 .\" Local Macros
 104 .\" --------------------------------------------------------------------
 105 .
 106 .\" --------------------------------------------------------------------
 107 .\" www:error (<test>...)
 108 .\"
 109 .\" Print error message
 110 .\"
 111 .de www-error
 112 .  tm \\n[.F]:\\n[.c]: macro error: \\$*
 113 ..
 114 .als www:error www-error
 115 .
 116 .\" --------------------------------------------------------------------
 117 .\" www:lenstr (<register_name> <string_name>)
 118 .\"
 119 .\" Store length of string named <string_name> into register named
 120 .\" <register_name>.
 121 .\"
 122 .de www:lenstr
 123 .  if !(\\n[.$] == 2) \{\
 124 .    tm .\\$0 expects 2 arguments.
 125 .    ab
 126 .  \}
 127 .  length \\$0:n x\\*[\\$2]
 128 .  nr \\$1 (\\n[\\$0:n]-1)
 129 .  rr \\$0:n
 130 ..
 131 .\" --------------------------------------------------------------------
 132 .\" www:splitstr (<name>)
 133 .\"
 134 .\" Add a space character between any two adjacent characters in string
 135 .\" <name> and restore result into the string variable <name>; space
 136 .\" characters are first replaced by the word `space'.
 137 .\"
 138 .de www:splitstr
 139 .  if !(\\n[.$] == 1) \
 140 .    www:error .\\$0 expects 1 argument.
 141 .  if '\\*[\\$1]'' \
 142 .    return
 143 .  ds \\$0:r "\\*[\\$1]\""
 144 .  ds \\$0:s\"
 145 .  while 1 \{\
 146 .    ds \\$0:c "\\*[\\$0:r]\""
 147 .    substring \\$0:c 0 0\"
 148 .    ie '\\*[\\$0:c]' ' \
 149 .      as \\$0:s " space\""
 150 .    el \
 151 .      as \\$0:s " \\*[\\$0:c]\""
 152 .    www:lenstr \\$0:n \\$0:r
 153 .    if (\\n[\\$0:n] <= 1) \{\
 154 .      break
 155 .    \}
 156 .    substring \\$0:r 1 -1\"
 157 .  \}
 158 .  if !'\\*[\\$0:s]'' \
 159 .    substring \\$0:s 1 -1
 160 .  ds \\$1 \\*[\\$0:s]
 161 .  rm \\$0:c
 162 .  rr \\$0:n
 163 .  rm \\$0:r
 164 .  rm \\$0:s
 165 ..
 166 .\" --------------------------------------------------------------------
 167 .\" www:url_breaks (<string_name>)
 168 .\"
 169 .\" Add `\:' (possible break point) within URL strings after `/'.
 170 .\"
 171 .\" Smart about multiple `/', existing `\:', and space characters;
 172 .\" does not set a break point if less than 5 characters would go to
 173 .\" the next line.
 174 .\"
 175 .de www:url_breaks
 176 .  if !(\\n[.$] == 1) \
 177 .    www:error .\\$0 expects 1 argument.
 178 .  if !\n[www:substring_ok] \
 179 .    return
 180 .  ds \\$0:s "\\*[\\$1]\""
 181 .  www:splitstr \\$0:s
 182 .  www:url_breaks_splitted \\$0:s \\*[\\$0:s]
 183 .  ds \\$1 "\\*[\\$0:s]\""
 184 .  rm \\$0:s
 185 ..
 186 .\" --------------------------------------------------------------------
 187 .\" www:url_breaks_splitted (<result> <char> [<char>...])
 188 .\"
 189 .\" Add `\:' within URL strings, but arguments are a splitted string.
 190 .\"
 191 .\" Arguments: >=2: <result> <char> [<char>...]
 192 .\"
 193 .de www:url_breaks_splitted
 194 .  nr \\$0:min 5        \" minimal number of characters for next line
 195 .  if (\\n[.$] < 2) \
 196 .    www:error .\\$0 expects at least 2 arguments.
 197 .  ds \\$0:res \\$1\"
 198 .  shift
 199 .  ds \\$0:s\"
 200 .  nr \\$0:done 0
 201 .  while !\\n[\\$0:done] \{\
 202 .    if (\\n[.$] <= 0) \{\
 203 .      nr \\$0:done 1
 204 .      break
 205 .    \}
 206 .    if '\\$1'space' \{\
 207 .      as \\$0:s " \""
 208 .      shift
 209 .      continue
 210 .    \}
 211 .    if (\\n[.$] < \\n[\\$0:min]) \{\
 212 .      as \\$0:s "\\$1\""
 213 .      shift
 214 .      continue
 215 .    \}
 216 .    if !'\\$1'/' \{\
 217 .      as \\$0:s "\\$1\""
 218 .      shift
 219 .      continue
 220 .    \}
 221 .    \" we are at a `/' character
 222 .    while '\\$1'/' \{\
 223 .      as \\$0:s /\"
 224 .      if (\\n[.$] == 0) \{\
 225 .        nr \\$0:done 1
 226 .        break
 227 .      \}
 228 .      shift
 229 .    \}
 230 .    if \\n[\\$0:done] \
 231 .      break
 232 .    if (\\n[.$] < \\n[\\$0:min]) \
 233 .      continue
 234 .    if '\\$1'\:' \
 235 .      shift
 236 .    as \\$0:s \:\"
 237 .  \}
 238 .  ds \\*[\\$0:res] \\*[\\$0:s]\"
 239 .  rm \\$0:res
 240 .  rm \\$0:s
 241 ..
 242 .\" --------------------------------------------------------------------
 243 .\" User Interface
 244 .\" --------------------------------------------------------------------
 245 .
 246 .\" --------------------------------------------------------------------
 247 .\" HTML (<address> <description> [<punctuation>])
 248 .\"
 249 .\" the main auxiliary macro for the HTML interface
 250 .\"
 251 .de HTML
 252 .  if \\n[www-html] \{\
 253 .    \" the following line makes the vertical mode leave, so to say
 254 .    nop \&
 255 .    nop \X^html:\\$*^
 256 .  \}
 257 ..
 258 .\"
 259 .\" an auxiliary macro for HTML (without following space)
 260 .\"
 261 .de HTML-NS
 262 .  if \\n[www-html] \
 263 .    nop \X^html:\\$*^\c
 264 ..
 265 .\" --------------------------------------------------------------------
 266 .\" HX n
 267 .\"
 268 .\"   Automatic heading level cut off.
 269 .\"
 270 .\"   N is the depth limit of automatically linked headings.  So a depth
 271 .\"   of 2 would cause grohtml to generate a list of links for `.NH 1'
 272 .\"   and `.NH 2' but not for `.NH 3'.
 273 .\"
 274 .de HX
 275 .  if \\n[www-html] \
 276 .    nop \X^index:\\$*^
 277 ..
 278 .\" --------------------------------------------------------------------
 279 .\" BCL foreground background active not-visited visited
 280 .\"
 281 .de BCL
 282 .  HTML <body text=\\$1 bgcolor=\\$2 link=\\$3 alink=\\$4 vlink=\\$5>
 283 ..
 284 .\" --------------------------------------------------------------------
 285 .\" BGIMG imagefile
 286 .\"
 287 .de BGIMG
 288 .  HTML <body background=\\$1>
 289 ..
 290 .\" --------------------------------------------------------------------
 291 .\" URL url [description] [after]
 292 .\"     if description is absent then the url becomes the anchor text
 293 .\"
 294 .de URL
 295 .  ds \\$0:adr \\$1\"
 296 .  www:url_breaks \\$0:adr
 297 .  ie \\n[www-html] \{\
 298 .    ie '\\$2'' \
 299 .       HTML <a href="\\$1">\\$1</a>\\$3
 300 .    el \
 301 .       HTML <a href="\\$1">\\$2</a>\\$3
 302 .  \}
 303 .  el \{\
 304 .    if !r ps4html .ad l
 305 .    ie '\\$2'' \
 306 .       nop \%\[la]\m[blue]\f[C]\\*[\\$0:adr]\f[]\m[]\[ra]\\$3
 307 .    el \
 308 .       nop \m[blue]\\$2\m[] \%\[la]\f[C]\\*[\\$0:adr]\f[]\[ra]\\$3
 309 .    if !r ps4html .ad
 310 .  \}
 311 .  rm \\$0:adr
 312 ..
 313 .\" --------------------------------------------------------------------
 314 .\" FTP url description [after]
 315 .\"
 316 .\"   Same as URL.
 317 .\"
 318 .als FTP URL
 319 .\" --------------------------------------------------------------------
 320 .\" MTO address description [after]
 321 .\"
 322 .\"   ADDRESS is the email address (without the `mailto:' prefix).
 323 .\"
 324 .\"   DESCRIPTION is the optional name.  If an empty argument is given,
 325 .\"   ADDRESS is used instead.
 326 .\"
 327 .\"   AFTER is optional stuff printed immediately after ADDRESS
 328 .\"   (resp. DESCRIPTION).
 329 .\"
 330 .\"     Example:
 331 .\"
 332 .\"       Foobar has been written by
 333 .\"       .MTO fred@foo.bar "Fredrick Bloggs" .
 334 .\"
 335 .de MTO
 336 .  ie \\n[www-html] \{\
 337 .    ie '\\$2'' \
 338 .      URL mailto:\\$1 \\$1 "\\$3"
 339 .    el \
 340 .      URL mailto:\\$1 "\\$2" "\\$3"
 341 .  \}
 342 .  el \{\
 343 .    ie '\\$2'' \
 344 .      nop \%\m[blue]\f[C]\\$1\f[]\m[]\\$3
 345 .    el \
 346 .      nop \m[blue]\\$2\m[] \%\[la]\f[C]\\$1\f[]\[ra]\\$3
 347 .  \}
 348 ..
 349 .\" --------------------------------------------------------------------
 350 .\" TAG name
 351 .\"
 352 .\"   Generate an html name NAME.
 353 .\"
 354 .de TAG
 355 .  HTML <a name="\\$1"></a>
 356 ..
 357 .\" --------------------------------------------------------------------
 358 .\" IMG [-R|-L|-C] filename [width] [height]
 359 .\"
 360 .\"   Include an image of any type (will only work for -Thtml).
 361 .\"
 362 .\"   Alignment is centered by default (-C).
 363 .\"   Default value for WIDTH is 1i.
 364 .\"   If HEIGHT is not given, WIDTH is used as the height.
 365 .\"
 366 .de IMG
 367 .  ie \\n[www-html] \{\
 368 .    ie '\\$2'-R' \
 369 .      HTML-TAG ".right-image"
 370 .    el \{\
 371 .      ie '\\$2'-L' \
 372 .        HTML-TAG ".left-image"
 373 .      el \
 374 .        HTML-TAG ".centered-image"
 375 .    \}
 376 .    nr www-width 100
 377 .    if !'\\$3'' \
 378 .      nr www-width \\$3
 379 .    nr www-height \\n[www-width]
 380 .    if !'\\$4'' \
 381 .      nr www-height \\$4
 382 .    HTML <img src="\\$1" width=\\n[www-width] height=\\n[www-height]>
 383 .  \}
 384 .  el \
 385 .    nop \[la]\f[C]\\$1\f[]\[ra]
 386 ..
 387 .\" --------------------------------------------------------------------
 388 .\" HTML-TAG
 389 .\"
 390 .\"   Emit a tag for grohtml.  This is an internal macro.
 391 .\"
 392 .de HTML-TAG
 393 .  if \\n[www-html] \{\
 394 .    \" the following line makes the vertical mode leave, so to say
 395 .    nop \&
 396 .    nop \X^html-tag:\\$*^
 397 .  \}
 398 ..
 399 .\" --------------------------------------------------------------------
 400 .\" HTML-TAG-NS
 401 .\"
 402 .\"   Emit a tag for grohtml (without a space).  This is an internal macro.
 403 .\"
 404 .de HTML-TAG-NS
 405 .  if \\n[www-html] \
 406 .    nop \X^html-tag:\\$*^\c
 407 ..
 408 .\" --------------------------------------------------------------------
 409 .\" PIMG  [-R|-L|-C] filename [width] [height]
 410 .\"
 411 .\"   Include a png image.  It will work for -Tps and -Thtml.
 412 .\"   The default value for WIDTH and HEIGHT is zero; the default
 413 .\"   alignment is centering (-C).
 414 .\"
 415 .\" Note: This macro can only be used with the `-U' option of groff,
 416 .\"       activating unsafe mode, if not used with -Thtml; the PNG image
 417 .\"       is then converted to the EPS format using netpbm utilities.
 418 .\"
 419 .de PIMG
 420 .  ie \\n[www-html] \{\
 421 .    ie '\\$1'-R' \
 422 .      HTML-TAG ".right-image"
 423 .    el \{\
 424 .      ie '\\$1'-L' \
 425 .        HTML-TAG ".left-image"
 426 .      el \
 427 .        HTML-TAG ".centered-image"
 428 .    \}
 429 .    nr www-width 0
 430 .    nr www-height 0
 431 .    if !'\\$3'' \
 432 .      nr www-width (\\$3 * 100 / 240)
 433 .    if !'\\$4'' \
 434 .      nr www-height (\\$4 * 100 / 240)
 435 .    ie (\\n[www-width] == 0) \{\
 436 .      ie (\\n[www-height] == 0) \
 437 .        HTML <img src="\\$2">
 438 .      el \
 439 .        HTML <img src="\\$1" height=\\n[www-height]>
 440 .    \}
 441 .    el \{\
 442 .      ie (\\n[www-height] == 0) \
 443 .        HTML <img src="\\$2" width=\\n[www-width]>
 444 .      el \
 445 .        HTML <img src="\\$2" width=\\n[www-width] height=\\n[www-height]>
 446 .    \}
 447 .  \}
 448 .  el \{\
 449 .    if !r ps4html \{\
 450 .      www-make-unique-name
 451 .      sy pngtopnm \\$2 | pnmcrop -white | @PNMTOPS_NOSETPAGE@ -noturn > \\*[www-unique-name].eps
 452 .      ie '\\$1'-C' \
 453 .        PSPIC \\*[www-unique-name].eps \\$3 \\$4
 454 .      el \
 455 .        PSPIC \\$1 \\*[www-unique-name].eps \\$3 \\$4
 456 .    \}
 457 .  \}
 458 ..
 459 .
 460 .\" --------------------------------------------------------------------
 461 .\" auxiliary definitions for MPIMG
 462 .\"
 463 .nr www-left-ll-trap 0
 464 .nr www-left-po-trap 0
 465 .nr www-right-ll-trap 0
 466 .
 467 .de www-finish-left-po
 468 .  po -\\n[www-left-indent]u
 469 .  wh \\n[www-left-po-trap]u
 470 .  nr www-left-indent 0
 471 ..
 472 .
 473 .de www-finish-right-ll
 474 .  ll +\\n[www-right-indent]u
 475 .  \" now see whether we need to inline www-finish-left-ll
 476 .  if (\\n[www-left-ll-trap]u > 0) \
 477 .    if ((\\n[www-right-ll-trap]u + 1v) >= \\n[www-left-ll-trap]u) \{\
 478 .      mk www-left-po-trap
 479 .      nr www-left-po-trap +1v
 480 .      wh \\n[www-left-po-trap]u www-finish-left-po
 481 .      ll +\\n[www-left-indent]u
 482 .      wh \\n[www-left-ll-trap]u
 483 .      nr www-left-ll-trap 0
 484 .    \}
 485 .  \" and see whether we need to inline www-finish-left-po
 486 .  if (\\n[www-left-po-trap]u > 0) \
 487 .    if ((\\n[www-right-ll-trap]u + 1v) >= \\n[www-left-po-trap]u) \{\
 488 .      po -\\n[www-left-indent]u
 489 .      wh \\n[www-left-po-trap]u
 490 .      nr www-left-indent 0
 491 .    \}
 492 .  wh \\n[www-right-ll-trap]u
 493 .  nr www-right-ll-trap 0
 494 ..
 495 .
 496 .de www-finish-left-ll
 497 .  if (\\n[www-right-ll-trap] > 0) \
 498 .    if ((\\n[www-left-ll-trap] + 1v) >= \\n[www-right-ll-trap]) \{\
 499 .      ll +\\n[www-right-indent]u
 500 .      nr www-right-ll-trap 0
 501 .    \}
 502 .  mk www-left-po-trap
 503 .  nr www-left-po-trap +1v
 504 .  wh \\n[www-left-po-trap]u www-finish-left-po
 505 .  ll +\\n[www-left-indent]u
 506 .  wh \\n[www-left-ll-trap]u
 507 .  nr www-left-ll-trap 0
 508 ..
 509 .\" --------------------------------------------------------------------
 510 .\" MPIMG [-R|-L] filename [width] [height]
 511 .\"
 512 .\"   Include a png image and wrap text around it.  It will work for
 513 .\"   -Tps and -Thtml.  The default value for WIDTH is 1i; default value
 514 .\"   for HEIGHT is WIDTH; the default alignment is left (-L).
 515 .\"
 516 .\" Note: This macro can only be used with the `-U' option of groff,
 517 .\"       activating unsafe mode, if not used with -Thtml; the PNG image
 518 .\"       is then converted to the EPS format using netpbm utilities.
 519 .\"
 520 .de MPIMG
 521 .  nr www-width 1i
 522 .  if !'\\$3'' \
 523 .    nr www-width \\$3
 524 .  nr www-height \\n[www-width]
 525 .  if !'\\$4'' \
 526 .    nr www-height \\$4
 527 .  nr www-width (\\n[www-width] * 100 / 240)
 528 .  nr www-height (\\n[www-height] * 100 / 240)
 529 .  ie \\n[www-html] \{\
 530 .    ie '\\$1'-R' \
 531 .      HTML <img src="\\$2" align=right width=\\n[www-width] height=\\n[www-height]>
 532 .    el \
 533 .      HTML <img src="\\$2" align=left width=\\n[www-width] height=\\n[www-height]>
 534 .  \}
 535 .  el \{\
 536 .    if !r ps4html \{\
 537 .      www-make-unique-name
 538 .      sy pngtopnm \\$2 | pnmcrop -white | @PNMTOPS_NOSETPAGE@ -noturn > \\*[www-unique-name].eps
 539 .      ie '\\$1'-R' \{\
 540 .        \" we must now disable a possible left image trap
 541 .        sp -1
 542 .        if (\\n[www-left-ll-trap] > 0) \
 543 .          wh \\n[www-left-ll-trap]u
 544 .        if (\\n[www-left-po-trap] > 0) \
 545 .          wh \\n[www-left-po-trap]u
 546 .        PSPIC -R \\*[www-unique-name].eps \\$3 \\$4
 547 .        sp -\\n[ps-desht]u
 548 .        nr www-right-indent \\n[ps-deswid]u
 549 .        ll -\\n[www-right-indent]u
 550 .        mk www-right-ll-trap
 551 .        nr www-right-ll-trap +(\\n[ps-desht]u - 1v)
 552 .        wh \\n[www-right-ll-trap]u www-finish-right-ll
 553 .        \" now restore possible left trap
 554 .        if (\\n[www-left-ll-trap] > 0) \
 555 .          wh \\n[www-left-ll-trap]u www-finish-left-ll
 556 .        if (\\n[www-left-po-trap] > 0) \
 557 .          wh \\n[www-left-po-trap]u
 558 .      \}
 559 .      el \{\
 560 .        \" we must now disable a possible right image trap
 561 .        if (\\n[www-right-ll-trap] > 0) \
 562 .          wh \\n[www-right-ll-trap]u
 563 .        PSPIC -L \\*[www-unique-name].eps \\$3 \\$4
 564 .        sp -\\n[ps-desht]u
 565 .        nr www-left-indent \\n[ps-deswid]u
 566 .        po +\\n[www-left-indent]u
 567 .        ll -\\n[www-left-indent]u
 568 .        mk www-left-ll-trap
 569 .        nr www-left-ll-trap +(\\n[ps-desht]u - 1v)
 570 .        wh \\n[www-left-ll-trap]u www-finish-left-ll
 571 .        \" now restore possible right trap
 572 .        if (\\n[www-right-ll-trap] > 0) \
 573 .          wh \\n[www-right-ll-trap]u www-finish-right-ll
 574 .      \}
 575 .    \}
 576 .  \}
 577 ..
 578 .\" --------------------------------------------------------------------
 579 .\" HnS n
 580 .\"
 581 .\"   Begin heading.  Heading level is N.
 582 .\"
 583 .\" HnE
 584 .\"
 585 .\"   End heading.
 586 .\"
 587 .\" If your heading contains URL, FTP, MTO macros you might wish to
 588 .\" disable automatic links to headings.  This can be done via `-P-l'
 589 .\" from the command line or by using a cakk to `.HX 0'.
 590 .\"
 591 .nr www-heading-no -1
 592 .
 593 .de HnS
 594 .  ie '\\$1'' \
 595 .    nr www-heading-no 1
 596 .  el \
 597 .    nr www-heading-no \\$1
 598 .  HTML-TAG ".NH \\n[www-heading-no]"
 599 ..
 600 .
 601 .de HnE
 602 .  if (\\n[www-heading-no] == -1) \
 603 .    www-error "HnE found without a corresponding HnS"
 604 .  br
 605 ..
 606 .\" --------------------------------------------------------------------
 607 .\" LK
 608 .\"
 609 .\"   Emit the automatically collected links derived from
 610 .\"   section/numbered headings at this position.
 611 .\"
 612 .de LK
 613 .  HTML-TAG ".links"
 614 ..
 615 .\" --------------------------------------------------------------------
 616 .\" HR
 617 .\"
 618 .\"   Produce a horizontal line
 619 .\"
 620 .de HR
 621 .  ie \\n[www-html] \{\
 622 .    ti 0
 623 .    HTML-NS <hr>
 624 .  \}
 625 .  el \
 626 .    sp
 627 ..
 628 .\" --------------------------------------------------------------------
 629 .\" NHR
 630 .\"
 631 .\"  Suppresses the generation of the top and bottom rules which grohtml
 632 .\"  emits by default.
 633 .\"
 634 .de NHR
 635 .  HTML-TAG ".no-auto-rule"
 636 ..
 637 .\"
 638 .\" www-end-nowhere - end of input trap called to finish diversion.
 639 .\"
 640 .de www-end-nowhere
 641 .  di
 642 ..
 643 .\" --------------------------------------------------------------------
 644 .\" HTL
 645 .\"
 646 .\"   Generate an HTML title only.  This differs from the -ms .TL macro
 647 .\"   which generates both an HTML title and a H1 heading.
 648 .\"
 649 .\"   This is useful when an author wishes to use a HTML title as search
 650 .\"   engine fodder but a graphic title in the document.
 651 .\"
 652 .\"   The macro terminates when a space or break is seen (.sp, .br).
 653 .\"
 654 .de HTL
 655 .  HTML-TAG ".html-tl"
 656 .  if !\\n[www-html] \{\
 657 .    di www-nowhere
 658 .    it 2 www-end-nowhere
 659 .  \}
 660 ..
 661 .
 662 .\" --------------------------------------------------------------------
 663 .\" auxiliary definitions for ULS / ULE
 664 .\"
 665 .ds www-level1 \[bu]\ \ \"
 666 .ds www-level2 \[sq]\ \ \"
 667 .ds www-level3 \[ci]\ \ \"
 668 .nr www-level 0
 669 .nr www-depth 0
 670 .
 671 .\"
 672 .\" Auxiliary macro for ULS.
 673 .\"
 674 .de www-push-level
 675 .  nr www-level +1
 676 .  if (\\n[www-level] > 3) \
 677 .    www-error "too many levels of indentation (\\n[www-level])"
 678 ..
 679 .\"
 680 .\" Auxiliary macro for ULE.
 681 .\"
 682 .de www-pop-level
 683 .  if !\\n[www-level] \
 684 .    www-error "trying to terminate a list which does not exist"
 685 .  nr www-level -1
 686 ..
 687 .\" --------------------------------------------------------------------
 688 .\" ULS
 689 .\"
 690 .\"   Start an unordered list.
 691 .\"
 692 .de ULS
 693 .  www-push-level
 694 .  ie \\n[www-html] \
 695 .    HTML "<ul>"
 696 .  el \{\
 697 .    if (\\n[www-level] == 1) \
 698 .      nr www-depth \\n[.i]
 699 .    nr www-depth +\w'\\*[www-level\\n[www-level]]'u
 700 .  \}
 701 ..
 702 .\" --------------------------------------------------------------------
 703 .\" ULE
 704 .\"
 705 .\"   End an unordered list.
 706 .\"
 707 .de ULE
 708 .  ie \\n[www-html] \
 709 .    HTML "</ul>"
 710 .  el \{\
 711 .    nr www-depth -\w'\\*[www-level\\n[www-level]]'u
 712 .    in \\n[www-depth]u
 713 .  \}
 714 .  www-pop-level
 715 ..
 716 .\" --------------------------------------------------------------------
 717 .\" LI
 718 .\"
 719 .\"   Insert a list item.
 720 .\"
 721 .de LI
 722 .  ie \\n[www-html] \
 723 .    HTML "<li>"
 724 .  el \{\
 725 .    in \\n[www-depth]u
 726 .    ti -\w'\\*[www-level\\n[www-level]]'u
 727 .    nop \\*[www-level\\n[www-level]]\c
 728 .  \}
 729 ..
 730 .\" --------------------------------------------------------------------
 731 .\" DC l text [color]
 732 .\"
 733 .\"   L is the letter to be dropped and enlarged.
 734 .\"
 735 .\"   TEXT is the following text whose height the first letter should not
 736 .\"   exceed.
 737 .\"
 738 .\"   COLOR is the optional color of the dropped letter (default black).
 739 .\"
 740 .de DC
 741 .  ds www-dropcolor black
 742 .  if !'\\$3'' \
 743 .    ds www-dropcolor \\$3
 744 .  ie '\*(.T'html' \{\
 745 .    www-make-unique-name
 746 .    MPIMG -L \\*[www-unique-name].png "(\\n[.v] * 2u)"
 747 .  \}
 748 .  el \{\
 749 .    ie r ps4html \{\
 750 .      www-make-unique-name
 751 .      \" To avoid interferences with another DC macro call which is located
 752 .      \" very near to the current one, we draw the glyph on a separate page.
 753 .      \" Otherwise it could theoretically happen that the dropped capital
 754 .      \" glyphs overlap.
 755 .      bp
 756 .      ev www-DC
 757 .      vs 80p
 758 .      nop \O[5i\\*[www-unique-name].png]\O[1]
 759 .      nop \m[\\*[www-dropcolor]]\s[40]\O[3]\\$1\O[4]
 760 .      nop \O[2]\O[0]
 761 .      br
 762 .      ev
 763 .      bp
 764 .    \}
 765 .    el \{\
 766 .      nr dummy \w'\\$1'u
 767 .      nr dcht ((\\n[.v] + \\n[rst]) * \\n[.ps] / \\n[rst])
 768 .      char \[dcap] \m[\\*[www-dropcolor]]\s'\\n[dcht]u'\\$1
 769 .      nop \v'\\n[.v]u'\\[dcap]\v'-\\n[.v]u'\c
 770 '      ti \w'\\[dcap]'u
 771 .    \}
 772 .  \}
 773 .  nop \\$2
 774 ..
 775 .\" --------------------------------------------------------------------
 776 .\" Setup around HTML-IMAGE and friends
 777 .\"
 778 .\" now set up TS, TE, EQ, EN default macros
 779 .\"
 780 .do if !d TS .do ds TS HTML-IMAGE
 781 .do if !d TE .do ds TE HTML-IMAGE-END
 782 .do if !d EQ .do ds EQ HTML-IMAGE
 783 .do if !d EN .do ds EN HTML-IMAGE-END
 784 .\"
 785 .\" supplementary macros used by other macro sets
 786 .\"
 787 .\" here are some tags specially for -Tps or -Thtml when invoked by
 788 .\" pre-html to generate png images from postscript.
 789 .
 790 .\" --------------------------------------------------------------------
 791 .\" HTML-DO-IMAGE - tells troff to issue an image marker which can be
 792 .\"                 read back by pre-html
 793 .\"
 794 .de HTML-DO-IMAGE
 795 .  if r ps4html \
 796 .    nop \O[5\\$2\\$1.png]\O[1]\O[3]
 797 .  if \\n[www-html] \
 798 .    nop \O[5\\$2\\$1.png]\O[0]\O[3]
 799 ..
 800 .\" --------------------------------------------------------------------
 801 .\" HTML-IMAGE-END - terminates an image for html
 802 .\"
 803 .de HTML-IMAGE-END
 804 .  if r ps4html \
 805 .    nop \O[4]\O[2]\O[0]
 806 .  if \\n[www-html] \
 807 .    nop \O[4]\O[2]\O[1]
 808 ..
 809 .
 810 .nr www-png-no 0
 811 .
 812 .\" --------------------------------------------------------------------
 813 .\" www-make-unique-name - generates another unique name in string
 814 .\"                        `www-unique-name'
 815 .\"
 816 .de www-make-unique-name
 817 .  nr www-png-no +1
 818 .  ds www-unique-name \\*[www-image-template]\\n[www-png-no]
 819 ..
 820 .\" --------------------------------------------------------------------
 821 .\" HTML-IMAGE and friends tell grohtml that this region of text needs
 822 .\"            to be rendered as an image.
 823 .\"
 824 .de HTML-IMAGE
 825 .  \" generates a centered image
 826 .  www-make-unique-name
 827 .  HTML-DO-IMAGE \\*[www-unique-name] c
 828 ..
 829 .
 830 .de HTML-IMAGE-RIGHT
 831 .  www-make-unique-name
 832 .  HTML-DO-IMAGE \\*[www-unique-name] r
 833 ..
 834 .
 835 .de HTML-IMAGE-LEFT
 836 .  www-make-unique-name
 837 .  HTML-DO-IMAGE \\*[www-unique-name] l
 838 ..
 839 .
 840 .de HTML-IMAGE-INLINE
 841 .  www-make-unique-name
 842 .  HTML-DO-IMAGE \\*[www-unique-name] i
 843 ..
 844 .
 845 .\" --------------------------------------------------------------------
 846 .\" Final Setup
 847 .\" --------------------------------------------------------------------
 848 .
 849 .if \n[www-html] \{\
 850 .   nh
 851 .   nr HY 0
 852 .\}
 853 .
 854 .\"
 855 .\" start of some code
 856 .\"
 857 .
 858 .de CDS
 859 .ft C
 860 .nf
 861 ..
 862 .\"
 863 .\" end of some code
 864 .\"
 865 .
 866 .de CDE
 867 .fi
 868 .ft P
 869 ..
 870 .
 871 .if r ps4html .nop \O[0]
 872 .cp \n(_C
 873 .
 874 .\" now set
 875 .
 876 .\" --------------------------------------------------------------------
 877 .\" Emacs settings
 878 .\" --------------------------------------------------------------------
 879 .
 880 .\" Local Variables:
 881 .\" mode: nroff
 882 .\" End:
 883 .\" EOF