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=@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 # For manpages use less verbose linking
  41 ifdef::doctype-manpage[]
  42 [link-inlinemacro]
  43 {0%&lt;{target}&gt;}
  44 {0#{0} &lt;{target}&gt;}
  45
  46 [http-inlinemacro]
  47 {0%&lt;http:{target}&gt;}
  48 {0#{0} &lt;http:{target}&gt;}
  49
  50 [mailto-inlinemacro]
  51 &lt;{target}&gt;
  52
  53 endif::doctype-manpage[]
  54 endif::backend-docbook[]
  55
  56 #############################################################################
  57 # XHTML11
  58
  59 ifdef::backend-xhtml11[]
  60
  61 [attributes]
  62 squote='
  63
  64 # Use the man:[] macro to link between elinks manpages
  65 [man-inlinemacro]
  66 {eval:re.match("elinks", "{target}") != None}<a href="{target}.{0}.html">{target}({0})</a>
  67 {eval:re.match("elinks", "{target}") == None}<b>{target}({0})</b>
  68
  69 # API Doc macros
  70
  71 [id-inlinemacro]
  72 <a id="{0}" href="#{0}">{0}</a>
  73
  74 [enum-inlinemacro]
  75 <a id="{target}">enum {target}: {0}</a>
  76
  77 [func-inlinemacro]
  78 <a id="{target}">{target}(): {0}</a>
  79
  80 [struct-inlinemacro]
  81 <a id="{target}">struct {target}: {0}</a>
  82
  83 [macro-inlinemacro]
  84 <a id="{target}">struct {target}: {0}</a>
  85
  86 [typedef-inlinemacro]
  87 <a id="{target}">typedef {target}: {0}</a>
  88
  89 [ref-inlinemacro]
  90 <a href="{target}#{0}">{0}</a>
  91
  92 endif::backend-xhtml11[]