Skip to content

Commit

Permalink
Documentation: implement linkgit macro for Asciidoctor
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
brian m. carlson authored and Junio C Hamano committed Oct 15, 2014
1 parent 7d61547 commit 773ee47
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions Documentation/extensions.rb
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 773ee47

Please sign in to comment.