summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar brian m. carlson <sandals@crustytoothpaste.net>2014-10-11 23:37:36 +0000
committerLibravatar Junio C Hamano <gitster@pobox.com>2014-10-15 13:44:08 -0700
commit773ee47c2b9c691d9758b2bea6cac10e3f0c4e12 (patch)
tree126030621266bb8a8bd45a50859e7c14b818ed93 /Documentation
parentDocumentation: move some AsciiDoc parameters into variables (diff)
downloadtgif-773ee47c2b9c691d9758b2bea6cac10e3f0c4e12.tar.xz
Documentation: implement linkgit macro for Asciidoctor
AsciiDoc uses a configuration file to implement macros like linkgit, while Asciidoctor uses Ruby extensions. Implement a Ruby extension that implements the linkgit macro for Asciidoctor in the same way that asciidoc.conf does for AsciiDoc. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/extensions.rb39
1 files changed, 39 insertions, 0 deletions
diff --git a/Documentation/extensions.rb b/Documentation/extensions.rb
new file mode 100644
index 0000000000..c33a50dce5
--- /dev/null
+++ b/Documentation/extensions.rb
@@ -0,0 +1,39 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+module Git
+ module Documentation
+ class LinkGitProcessor < Asciidoctor::Extensions::InlineMacroProcessor
+ use_dsl
+
+ named :chrome
+
+ def process(parent, target, attrs)
+ if parent.document.basebackend? 'html'
+ generate_html(parent, target, attrs)
+ elsif parent.document.basebackend? 'docbook'
+ generate_docbook(parent, target, attrs)
+ end
+ end
+
+ private
+
+ def generate_html(parent, target, attrs)
+ section = attrs.has_key?(1) ? "(#{attrs[1]})" : ''
+ prefix = parent.document.attr('git-relative-html-prefix') || ''
+ %(<a href="#{prefix}#{target}.html">#{target}#{section}</a>\n)
+ end
+
+ def generate_docbook(parent, target, attrs)
+ %(<citerefentry>
+<refentrytitle>#{target}</refentrytitle><manvolnum>#{attrs[1]}</manvolnum>
+</citerefentry>
+)
+ end
+ end
+ end
+end
+
+Asciidoctor::Extensions.register do
+ inline_macro Git::Documentation::LinkGitProcessor, :linkgit
+end