git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: git@vger.kernel.org
Subject: [PATCH 4/4] Documentation: implement linkgit macro for Asciidoctor
Date: Sat, 11 Oct 2014 23:37:36 +0000	[thread overview]
Message-ID: <1413070656-241955-5-git-send-email-sandals@crustytoothpaste.net> (raw)
In-Reply-To: <1413070656-241955-1-git-send-email-sandals@crustytoothpaste.net>

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>
---
 Documentation/extensions.rb | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/extensions.rb

diff --git a/Documentation/extensions.rb b/Documentation/extensions.rb
new file mode 100644
index 0000000..c33a50d
--- /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
-- 
2.1.1

  parent reply	other threads:[~2014-10-11 23:37 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-10-11 23:37 [PATCH 0/4] Allow building Git with Asciidoctor brian m. carlson
2014-10-11 23:37 ` [PATCH 1/4] Documentation: adjust document title underlining brian m. carlson
2014-10-13 20:35   ` Junio C Hamano
2014-10-11 23:37 ` [PATCH 2/4] Documentation: fix mismatched delimiters in git-imap-send brian m. carlson
2014-10-11 23:37 ` [PATCH 3/4] Documentation: move some AsciiDoc parameters into variables brian m. carlson
2014-10-15 20:43   ` Junio C Hamano
2014-10-16  1:52     ` brian m. carlson
2014-10-11 23:37 ` brian m. carlson [this message]
2014-10-13 20:41 ` [PATCH 0/4] Allow building Git with Asciidoctor Junio C Hamano
2014-10-14  0:34   ` brian m. carlson
2014-10-14 10:07     ` Jakub Narębski
2014-10-14 11:26       ` brian m. carlson
2014-10-14  9:51 ` Jeff King
2014-10-14 17:08   ` Junio C Hamano
2014-10-15  1:17     ` brian m. carlson
2014-10-15 17:43       ` Junio C Hamano
2014-10-15 11:24   ` Thomas Braun
2014-10-15 23:52     ` brian m. carlson
2014-10-16 22:53 ` Philip Oakley

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1413070656-241955-5-git-send-email-sandals@crustytoothpaste.net \
    --to=sandals@crustytoothpaste.net \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).