1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
elinks/doc/asciidoc.conf
Jonas Fonseca ba6221c6f6 Redo the whole doc/ build thing
You can now use: make {all-docs,pdf,html,man,api,update-man}
     instead of: make {all-docs,pdf-docs,html-docs,man-docs}

Away is building into separate dirs. This makes make able to actually get
dependencies right, since there are now a collection of 'common' build
rules, some of which have even been moved to use the cmd infrastructure.

To update the man pages there is a new update-man rule. It builds the
manual pages and copies them to their proper place under man/ while doing
the final preformatting.

As good thing is that the (two) man pages are moved to .txt files and
include the generated content.

The API building thing is also refined. It builds into api/ and builds it's
list of files dynamically by searching throught the .h files in the src/
directory. Documented header files must contain a comment like this:

	/* API Doc :: <api-name> */

where <api-name> is the name used for the file under api/, for example
dom-scanner.
2006-01-11 11:02:43 +01:00

58 lines
1.2 KiB
Plaintext

# AsciiDoc configuration file
# Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
# The elink macro can have optional {0} value, that is what
# the {0%...} and {0#...} handles.
#############################################################################
# DocBook
ifdef::backend-docbook[]
[man-inlinemacro]
{target}({0})
## For manpages use less verbose linking
ifdef::doctype-manpage[]
[link-inlinemacro]
{0%&lt;{target}&gt;}
{0#{0} &lt;{target}&gt;}
[http-inlinemacro]
{0%&lt;http:{target}&gt;}
{0#{0} &lt;http:{target}&gt;}
[mailto-inlinemacro]
&lt;{target}&gt;
endif::doctype-manpage[]
endif::backend-docbook[]
#############################################################################
# XHTML11
ifdef::backend-xhtml11[]
[man-inlinemacro]
<a href="{target}.{0}.html">{target}({0})</a>
[id-inlinemacro]
<a id="{0}" href="#{0}">{0}</a>
[enum-inlinemacro]
<a id="{target}">enum {target}: {0}</a>
[func-inlinemacro]
<a id="{target}">{target}(): {0}</a>
[struct-inlinemacro]
<a id="{target}">struct {target}: {0}</a>
[macro-inlinemacro]
<a id="{target}">struct {target}: {0}</a>
[typedef-inlinemacro]
<a id="{target}">typedef {target}: {0}</a>
[ref-inlinemacro]
<a href="{target}#{0}">{0}</a>
endif::backend-xhtml11[]