doc/asciidoc.conf

   1 # AsciiDoc configuration file
   2 # Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
   3
   4 # This file sets the following ELinks specific AsciiDoc macros:
   5 #
   6 # General purpose:
   7 # - man:page[section]: which is used for linking between ELinks manpages.
   8 #
   9 # API Doc:
  10 # - id:[]
  11 # - enum:[]
  12 # - func:[]
  13 # - struct:[]
  14 # - macro:[]
  15 # - typedef:[]
  16 # - ref:[]
  17
  18 [replacements]
  19 (^|[^-])--($|[^-])=\1--\2
  20
  21 # Some macros can have optional {0} value, that is what
  22 # the {0%...} and {0#...} handles.
  23
  24 #############################################################################
  25 # DocBook
  26
  27 ifdef::backend-docbook[]
  28
  29 # To be replaced later
  30 [attributes]
  31 squote='
  32
  33 # No interlinking between elinks manpages
  34 [man-inlinemacro]
  35 {0%{target}}
  36 {0#<citerefentry>}
  37 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  38 {0#</citerefentry>}
  39
  40 # No interlinking between elinks manpages
  41 [otherman-inlinemacro]
  42 {0%{target}}
  43 {0#<citerefentry>}
  44 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  45 {0#</citerefentry>}
  46
  47 # For manpages use less verbose linking
  48 ifdef::doctype-manpage[]
  49 [link-inlinemacro]
  50 {0%&lt;{target}&gt;}
  51 {0#{0} &lt;{target}&gt;}
  52
  53 [http-inlinemacro]
  54 {0%&lt;http:{target}&gt;}
  55 {0#{0} &lt;http:{target}&gt;}
  56
  57 [mailto-inlinemacro]
  58 &lt;{target}&gt;
  59
  60 [header]
  61 template::[header-declarations]
  62 <refentry>
  63 <refmeta>
  64 <refentrytitle>{mantitle}</refentrytitle>
  65 <manvolnum>{manvolnum}</manvolnum>
  66 <refmiscinfo class="source">ELinks</refmiscinfo>
  67 <refmiscinfo class="version">{elinks_version}</refmiscinfo>
  68 <refmiscinfo class="manual">{description}</refmiscinfo>
  69 </refmeta>
  70 <refnamediv>
  71   <refname>{manname}</refname>
  72   <refpurpose>{manpurpose}</refpurpose>
  73 </refnamediv>
  74
  75 endif::doctype-manpage[]
  76 endif::backend-docbook[]
  77
  78 #############################################################################
  79 # XHTML11
  80
  81 ifdef::backend-xhtml11[]
  82
  83 [attributes]
  84 squote='
  85
  86 # Use the man:[] macro to link between elinks manpages
  87 [man-inlinemacro]
  88 <a href="{target}.{0}.html">{target}({0})</a>
  89
  90 [otherman-inlinemacro]
  91 <b>{target}({0})</b>
  92
  93 # API Doc macros
  94
  95 [id-inlinemacro]
  96 <a id="{0}" href="#{0}">{0}</a>
  97
  98 [enum-inlinemacro]
  99 <a id="{target}">enum {target}: {0}</a>
 100
 101 [func-inlinemacro]
 102 <a id="{target}">{target}(): {0}</a>
 103
 104 [struct-inlinemacro]
 105 <a id="{target}">struct {target}: {0}</a>
 106
 107 [macro-inlinemacro]
 108 <a id="{target}">struct {target}: {0}</a>
 109
 110 [typedef-inlinemacro]
 111 <a id="{target}">typedef {target}: {0}</a>
 112
 113 [ref-inlinemacro]
 114 <a href="{target}#{0}">{0}</a>
 115
 116 endif::backend-xhtml11[]