Browse Source

[PATCH] Documentation: Add asciidoc.conf file and gitlink: macro

Introduce an asciidoc.conf file with the purpose of adding a gitlink:
macro which will improve the manpage output.

Original cogito patch by Jonas Fonseca <fonseca@diku.dk>;
asciidoc.conf from that patch was further enhanced to use the proper
DocBook tag <citerefentry> for references to man pages.

Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Sergey Vlasov 20 years ago committed by Junio C Hamano
parent
commit
d1c2e113c5
  1. 4
      Documentation/Makefile
  2. 21
      Documentation/asciidoc.conf

4
Documentation/Makefile

@ -57,13 +57,13 @@ clean: @@ -57,13 +57,13 @@ clean:
rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html

%.html : %.txt
asciidoc -b xhtml11 -d manpage $<
asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<

%.1 %.7 : %.xml
xmlto man $<

%.xml : %.txt
asciidoc -b docbook -d manpage $<
asciidoc -b docbook -d manpage -f asciidoc.conf $<

git.html: git.txt ../README


21
Documentation/asciidoc.conf

@ -0,0 +1,21 @@ @@ -0,0 +1,21 @@
## gitlink: macro
#
# Usage: gitlink:command[manpage-section]
#
# Note, {0} is the manpage section, while {target} is the command.
#
# Show GIT link as: <command>(<section>); if section is defined, else just show
# the command.

ifdef::backend-docbook[]
[gitlink-inlinemacro]
{0%{target}}
{0#<citerefentry>}
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
{0#</citerefentry>}
endif::backend-docbook[]

ifdef::backend-xhtml11[]
[gitlink-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>
endif::backend-xhtml11[]
Loading…
Cancel
Save