diff options
author | Martin Ågren <martin.agren@gmail.com> | 2019-09-22 13:57:58 +0200 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-09-28 17:37:56 +0900 |
commit | dba3734103e781bcf8c43db9c23acca4568521ae (patch) | |
tree | df31bb9514924c4a5d674ea7d8976d256dc9a014 /Documentation/technical | |
parent | user-manual.txt: change header notation (diff) | |
download | tgif-dba3734103e781bcf8c43db9c23acca4568521ae.tar.xz |
asciidoctor-extensions.rb: handle "book" doctype in linkgit
user-manual.txt is the only file we process using the "book" doctype.
When we use AsciiDoc, user-manual.conf ensures that the linkgit macro
expands into something like
<ulink url="git-foo.html">git-foo(1)</ulink>
in user-manual.xml, which we then process into a clickable link, both in
user-manual.html and user-manual.pdf. With Asciidoctor,
user-manual.conf is ignored (this is expected) and our
Asciidoctor-specific implementation of linkgit kicks in:
<citerefentry>
<refentrytitle>git-foo</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
This eventually renders as "git-foo(1)", which is not bad, but it
doesn't turn into a link.
Teach our Asciidoctor-specific implementation of the linkgit macro that
if the doctype is "book", we should emit <ulink .../> just like we do
with AsciiDoc. While we're doing this, future-proof by supporting a
"prefix". The implementation in user-manual.conf doesn't support this,
and we don't need this for now because user-manual.txt is the only file
we process this way (and it's immediately in Documentation/).
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical')
0 files changed, 0 insertions, 0 deletions