From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Sat, 11 Oct 2014 23:37:36 +0000 (+0000)
Subject: Documentation: implement linkgit macro for Asciidoctor
X-Git-Tag: v2.2.0-rc0~14^2~2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=773ee47c2b9c691d9758b2bea6cac10e3f0c4e12;p=thirdparty%2Fgit.git

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>
---

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