git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
blob 42133ee6c36421b4fe40c077c460e7f81823764d 3054 bytes (raw)
name: Documentation/asciidoctor-extensions.rb 	 # note: path name is non-authoritative(*)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
require 'asciidoctor'
require 'asciidoctor/extensions'
require 'asciidoctor/converter/manpage'

module Asciidoctor
  class Converter::ManPageConverter
    alias orig_convert_inline_anchor convert_inline_anchor
    def convert_inline_anchor(node)
      case node.type
      when :xref
        return node.text if node.text
        refid = node.attributes['refid']
        'the section called “%s”' % refid.gsub('_', ' ')
      when :link
        return node.target if node.text == node.target
        doc = node.document

        footnote = doc.footnotes.find { |e| e.id == node.target }
        if !footnote
          footnote_text = "%s\n\e.RS\n\e\\%%%s\n\e.RE" % [node.text, node.target]
          index = doc.counter('footnote-number')
          footnote = Document::Footnote.new(index, node.target, footnote_text)
          doc.register(:footnotes, footnote)
        end

        "\e\\fB%s\e\\fR[%d]" % [node.text, footnote.index]
      else
        orig_convert_inline_anchor(node)
      end
    end
  end
end

module Git
  module Documentation
    class LinkGitProcessor < Asciidoctor::Extensions::InlineMacroProcessor
      use_dsl

      named :chrome

      def process(parent, target, attrs)
        prefix = parent.document.attr('git-relative-html-prefix')
        if parent.document.doctype == 'book'
          "<ulink url=\"#{prefix}#{target}.html\">" \
          "#{target}(#{attrs[1]})</ulink>"
        elsif parent.document.basebackend? 'html'
          %(<a href="#{prefix}#{target}.html">#{target}(#{attrs[1]})</a>)
        elsif parent.document.basebackend? 'manpage'
          "\e\\fB%s\e\\fR(%s)" % [target, attrs[1]]
        elsif parent.document.basebackend? 'docbook'
          "<citerefentry>\n" \
            "<refentrytitle>#{target}</refentrytitle>" \
            "<manvolnum>#{attrs[1]}</manvolnum>\n" \
          "</citerefentry>"
        end
      end
    end

    class DocumentPostProcessor < Asciidoctor::Extensions::Postprocessor
      def process document, output
        if document.basebackend? 'docbook'
          mansource = document.attributes['mansource']
          manversion = document.attributes['manversion']
          manmanual = document.attributes['manmanual']
          new_tags = "" \
            "<refmiscinfo class=\"source\">#{mansource}</refmiscinfo>\n" \
            "<refmiscinfo class=\"version\">#{manversion}</refmiscinfo>\n" \
            "<refmiscinfo class=\"manual\">#{manmanual}</refmiscinfo>\n"
          output = output.sub(/<\/refmeta>/, new_tags + "</refmeta>")
        end
        output
      end
    end
  end
end

Asciidoctor::Extensions.register do
  # Override attributes for man pages.
  # https://github.com/asciidoctor/asciidoctor/issues/4059
  tree_processor do
    process do |document|
      if document.backend == 'manpage'
        document.attributes.merge!({ 'litdd' => '\--', 'plus' => '+' })
      end
      document
    end
  end

  inline_macro Git::Documentation::LinkGitProcessor, :linkgit
  postprocessor Git::Documentation::DocumentPostProcessor
end

debug log:

solving 42133ee6c3 ...
found 42133ee6c3 in https://public-inbox.org/git/20210514121435.504423-10-felipe.contreras@gmail.com/
found b2bbb318ad in https://public-inbox.org/git/20210514121435.504423-9-felipe.contreras@gmail.com/
found 11937c2c1d in https://public-inbox.org/git/20210514121435.504423-8-felipe.contreras@gmail.com/
found ad68f7b0bb in https://public-inbox.org/git/20210514121435.504423-6-felipe.contreras@gmail.com/
found d906a00803 in https://80x24.org/mirrors/git.git
preparing index
index prepared:
100644 d906a008039cf56c757ddb6bff9f0e1d9d7bfdc9	Documentation/asciidoctor-extensions.rb

applying [1/4] https://public-inbox.org/git/20210514121435.504423-6-felipe.contreras@gmail.com/
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index d906a00803..ad68f7b0bb 100644


applying [2/4] https://public-inbox.org/git/20210514121435.504423-8-felipe.contreras@gmail.com/
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index ad68f7b0bb..11937c2c1d 100644


applying [3/4] https://public-inbox.org/git/20210514121435.504423-9-felipe.contreras@gmail.com/
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index 11937c2c1d..b2bbb318ad 100644


applying [4/4] https://public-inbox.org/git/20210514121435.504423-10-felipe.contreras@gmail.com/
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index b2bbb318ad..42133ee6c3 100644

Checking patch Documentation/asciidoctor-extensions.rb...
Applied patch Documentation/asciidoctor-extensions.rb cleanly.
Checking patch Documentation/asciidoctor-extensions.rb...
Applied patch Documentation/asciidoctor-extensions.rb cleanly.
Checking patch Documentation/asciidoctor-extensions.rb...
Applied patch Documentation/asciidoctor-extensions.rb cleanly.
Checking patch Documentation/asciidoctor-extensions.rb...
Applied patch Documentation/asciidoctor-extensions.rb cleanly.

index at:
100644 42133ee6c36421b4fe40c077c460e7f81823764d	Documentation/asciidoctor-extensions.rb

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).