docs/asciidoc.conf

   1 ## NUT macros: linkman, linkdoc
   2 #
   3 # Usage: linkman:command[manpage-section]
   4 #   This macro allows to handle variable manpage location, depending on the
   5 #   document type
   6 #
   7 # Note, {0} is the manpage section, while {target} is the command.
   8 #
   9 # Example: linkman:ups.conf[5]
  10 #
  11 # Show NUT link as: <command>(<section>); if section is defined, else just show
  12 #   the command.
  13 #
  14 ################################################################################
  15 #
  16 # Usage: linkdoc:document[display title,[anchor]]
  17 #   This macro allows to handle variable NUT documentation location, depending
  18 #   on the document type
  19 #
  20 # Note, {1} is the display title, {2} is the optional anchor name,
  21 #   {0} is the whole set of args ({1}...{n}) and {target} is the
  22 #   base document name.
  23 # Example:
  24 #   linkdoc:user-manual[user manual,NUT_Security]
  25 #   linkdoc:developer-guide[developer guide,_status_data]
  26
  27 [macros]
  28 (?su)[\\]?(?P<name>linkman):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
  29 (?su)[\\]?(?P<name>linkdoc):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
  30
  31 ifdef::basebackend-docbook[]
  32 ifdef::xhtml11_format[]
  33 [linkman-inlinemacro]
  34 <ulink url="man/{target}.html">{target}{0?({0})}</ulink>
  35 [linkdoc-inlinemacro]
  36 <ulink url="{target}.html{2?#{2}}">{1}</ulink>
  37 endif::xhtml11_format[]
  38
  39 # FIXME: linkdoc does not support 'anchor'
  40 ifdef::chunked_format[]
  41 [linkman-inlinemacro]
  42 <ulink url="../man/{target}.html">{target}{0?({0})}</ulink>
  43 [linkdoc-inlinemacro]
  44 <ulink url="../{target}.chunked/index.html">{1}</ulink>
  45 endif::chunked_format[]
  46
  47 # PDF output points online versions
  48 # FIXME: linkdoc does not support 'anchor'
  49 ifdef::pdf_format[]
  50 [linkman-inlinemacro]
  51 <ulink url="http://www.networkupstools.org/docs/man/{target}.html">{target}{0?({0})}</ulink>
  52 [linkdoc-inlinemacro]
  53 <ulink url="{target}.pdf">{1}</ulink>
  54 endif::pdf_format[]
  55 endif::basebackend-docbook[]