Module: Asciidoctor::Standoc::Front

Included in:
Converter
Defined in:
lib/asciidoctor/standoc/front.rb,
lib/asciidoctor/standoc/front_contributor.rb

Instance Method Summary collapse

Instance Method Details

#committee_component(compname, node, out) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 11

def committee_component(compname, node, out)
  out.send compname.gsub(/-/, "_"), node.attr(compname),
    **attr_code(number: node.attr("#{compname}-number"),
                type: node.attr("#{compname}-type"))
  i = 2
  while node.attr(compname+"_#{i}") do
    out.send compname.gsub(/-/, "_"), node.attr(compname+"_#{i}"),
      **attr_code(number: node.attr("#{compname}-number_#{i}"),
                  type: node.attr("#{compname}-type_#{i}"))
    i += 1
  end
end

#csv_split(s, delim = ",") ⇒ Object

, “ => ,” : CSV definition does not deal with space followed by quote at start of field



49
50
51
52
53
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 49

def csv_split(s, delim = ",")
  CSV.parse_line(s&.gsub(/, "(?!")/, ',"'),
                 liberal_parsing: true,
                 col_sep: delim)&.compact&.map { |x| x.strip }
end

#datetypes ⇒ Object 



67
68
69
70
71
72
 
# File 'lib/asciidoctor/standoc/front.rb', line 67

def datetypes
  %w{ published accessed created implemented obsoleted
      confirmed updated issued circulated unchanged received 
      vote-started vote-ended
  }
end

#default_publisher ⇒ Object 



129
130
131
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 129

def default_publisher
  nil
end

#metadata(node, xml) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/asciidoctor/standoc/front.rb', line 137

def metadata(node, xml)
  title node, xml
  metadata_source(node, xml)
  metadata_id(node, xml)
  metadata_date(node, xml)
  metadata_author(node, xml)
  metadata_publisher(node, xml)
  metadata_version(node, xml)
  metadata_note(node, xml)
  metadata_language(node, xml)
  metadata_script(node, xml)
  metadata_status(node, xml)
  metadata_copyright(node, xml)
  metadata_relations(node, xml)
  metadata_series(node, xml)
  metadata_keywords(node, xml)
  xml.ext do |ext|
    metadata_ext(node, xml)
  end
end

#metadata_author(node, xml) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 55

def metadata_author(node, xml)
  csv_split(node.attr("publisher") || default_publisher || "")&.
    each do |p|
    xml.contributor do |c|
      c.role **{ type: "author" }
      c.organization do |a|
        organization(a, p, node, !node.attr("publisher"))  
      end
    end
  end
  personal_author(node, xml)
end

#metadata_committee(node, xml) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/asciidoctor/standoc/front.rb', line 36

def metadata_committee(node, xml)
  return unless node.attr("technical-committee")
  xml.editorialgroup do |a|
    committee_component("technical-committee", node, a)
  end
end

#metadata_copyright(node, xml) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 149

def metadata_copyright(node, xml)
  pub = node.attr("copyright-holder") || node.attr("publisher")
  csv_split(pub || default_publisher || "-")&.each do |p|
    xml.copyright do |c|
      c.from (node.attr("copyright-year") || Date.today.year)
      p.match(/[A-Za-z]/).nil? or c.owner do |owner|
        owner.organization do |a|
          organization(a, p, node, !pub)
        end
      end
    end
  end
end

#metadata_date(node, xml) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/asciidoctor/standoc/front.rb', line 74

def metadata_date(node, xml)
  datetypes.each { |t| metadata_date1(node, xml, t) }
  node.attributes.keys.each do |a|
    next unless a == "date" || /^date_\d+$/.match(a)
    type, date = node.attr(a).split(/ /, 2)
    type or next
    xml.date **{ type: type } do |d|
      d.on date
    end
  end
end

#metadata_date1(node, xml, type) ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/asciidoctor/standoc/front.rb', line 60

def metadata_date1(node, xml, type)
  date = node.attr("#{type}-date")
  date and xml.date **{ type: type } do |d|
    d.on date
  end
end

#metadata_doctype(node, xml) ⇒ Object 



164
165
166
 
# File 'lib/asciidoctor/standoc/front.rb', line 164

def metadata_doctype(node, xml)
  xml.doctype doctype(node)
end

#metadata_ext(node, ext) ⇒ Object 



158
159
160
161
162
 
# File 'lib/asciidoctor/standoc/front.rb', line 158

def metadata_ext(node, ext)
  metadata_doctype(node, ext)
  metadata_committee(node, ext)
  metadata_ics(node, ext)
end

#metadata_getrelation(node, xml, type, desc = nil) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/asciidoctor/standoc/front.rb', line 116

def metadata_getrelation(node, xml, type, desc = nil)
  docs = node.attr(desc || type) || return
  HTMLEntities.new.decode(docs).split(/;\s*/).each do |d|
    id = d.split(/,\s*/)
    xml.relation **{ type: relation_normalise(type) } do |r|
      desc.nil? or r.description relation_normalise(desc)
      fetch_ref(r, d, nil, {}) or r.bibitem do |b|
        b.title id[1] ? id[1] : "--"
        b.docidentifier id[0]
      end
    end
  end
end

#metadata_ics(node, xml) ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/asciidoctor/standoc/front.rb', line 43

def metadata_ics(node, xml)
  ics = node.attr("library-ics")
  ics && ics.split(/,\s*/).each do |i|
    xml.ics { |ics| ics.code i }
  end
end

#metadata_id(node, xml) ⇒ Object 



11
12
13
14
15
16
17
18
 
# File 'lib/asciidoctor/standoc/front.rb', line 11

def metadata_id(node, xml)
  part, subpart = node&.attr("partnumber")&.split(/-/)
  id = node.attr("docnumber") || ""
  id += "-#{part}" if part
  id += "-#{subpart}" if subpart
  xml.docidentifier id
  xml.docnumber node.attr("docnumber")
end

#metadata_keywords(node, xml) ⇒ Object 



130
131
132
133
134
135
 
# File 'lib/asciidoctor/standoc/front.rb', line 130

def metadata_keywords(node, xml)
  return unless node.attr("keywords")
  node.attr("keywords").split(/,[ ]*/).each do |kw|
    xml.keyword kw
  end
end

#metadata_language(node, xml) ⇒ Object 



86
87
88
 
# File 'lib/asciidoctor/standoc/front.rb', line 86

def metadata_language(node, xml)
  xml.language (node.attr("language") || "en")
end

#metadata_note(node, xml) ⇒ Object 



168
169
 
# File 'lib/asciidoctor/standoc/front.rb', line 168

def metadata_note(node, xml)
end

#metadata_publisher(node, xml) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 137

def metadata_publisher(node, xml)
  publishers = node.attr("publisher") || default_publisher || return
  csv_split(publishers)&.each do |p|
    xml.contributor do |c|
      c.role **{ type: "publisher" }
      c.organization do |a|
        organization(a, p, node, !node.attr("publisher"))
      end
    end
  end
end

#metadata_relations(node, xml) ⇒ Object 



102
103
104
105
106
107
108
109
 
# File 'lib/asciidoctor/standoc/front.rb', line 102

def metadata_relations(node, xml)
  relaton_relations.each do |t|
    metadata_getrelation(node, xml, t)
  end
  relaton_relation_descriptions.each do |k, v|
    metadata_getrelation(node, xml, v, k)
  end
end

#metadata_script(node, xml) ⇒ Object 



90
91
92
 
# File 'lib/asciidoctor/standoc/front.rb', line 90

def metadata_script(node, xml)
  xml.script (node.attr("script") || "Latn")
end

#metadata_series(node, xml) ⇒ Object 



171
172
 
# File 'lib/asciidoctor/standoc/front.rb', line 171

def metadata_series(node, xml)
end

#metadata_source(node, xml) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/asciidoctor/standoc/front.rb', line 50

def metadata_source(node, xml)
  node.attr("uri") && xml.uri(node.attr("uri"))
  node.attr("xml-uri") && xml.uri(node.attr("xml-uri"), type: "xml")
  node.attr("html-uri") && xml.uri(node.attr("html-uri"), type: "html")
  node.attr("pdf-uri") && xml.uri(node.attr("pdf-uri"), type: "pdf")
  node.attr("doc-uri") && xml.uri(node.attr("doc-uri"), type: "doc")
  node.attr("relaton-uri") && xml.uri(node.attr("relaton-uri"),
                                      type: "relaton")
end

#metadata_status(node, xml) ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/asciidoctor/standoc/front.rb', line 28

def metadata_status(node, xml)
  xml.status do |s|
    s.stage (node.attr("status") || node.attr("docstage") || "published")
    node.attr("docsubstage") and s.substage node.attr("docsubstage")
    node.attr("iteration") and s.iteration node.attr("iteration")
  end
end

#metadata_version(node, xml) ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/asciidoctor/standoc/front.rb', line 20

def metadata_version(node, xml)
  xml.edition node.attr("edition") if node.attr("edition")
  xml.version do |v|
    v.revision_date node.attr("revdate") if node.attr("revdate")
    v.draft node.attr("draft") if node.attr("draft")
  end
end

#org_abbrev ⇒ Object 



133
134
135
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 133

def org_abbrev
  { }
end

#org_address(node, p) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 35

def org_address(node, p)
  node.attr("pub-address") and p.address do |ad|
    ad.formattedAddress do |f|
      f << node.attr("pub-address").gsub(/ \+\n/, "<br/>")
    end
  end
  node.attr("pub-phone") and p.phone node.attr("pub-phone")
  node.attr("pub-fax") and p.phone node.attr("pub-fax"), **{type: "fax"}
  node.attr("pub-email") and p.email node.attr("pub-email")
  node.attr("pub-uri") and p.uri node.attr("pub-uri")
end

#organization(org, orgname, node = nil, default_org = nil) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 24

def organization(org, orgname, node = nil, default_org = nil)
  abbrevs = org_abbrev
  n = abbrevs.invert[orgname] and orgname = n
  org.name orgname
  default_org and a = node.attr("subdivision") and org.subdivision a
  abbr = org_abbrev[orgname]
  default_org && b = node.attr("subdivision-abbr") and abbr = b
  abbr and org.abbreviation abbr
  default_org and org_address(node, org)
end

#person_affiliation(node, xml, suffix, p) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 114

def person_affiliation(node, xml, suffix, p)
  node.attr("affiliation#{suffix}") and p.affiliation do |a|
    a.organization do |o|
      o.name node.attr("affiliation#{suffix}")
      abbr = node.attr("affiliation_abbrev#{suffix}") and
        o.abbreviation abbr
      node.attr("address#{suffix}") and o.address do |ad|
        ad.formattedAddress do |f|
          f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
        end
      end
    end
  end
end

#person_name(node, xml, suffix, p) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 102

def person_name(node, xml, suffix, p)
  p.name do |n|
    if node.attr("fullname#{suffix}")
      n.completename node.attr("fullname#{suffix}")
    else
      n.forename node.attr("givenname#{suffix}")
      n.initial node.attr("initials#{suffix}")
      n.surname node.attr("surname#{suffix}")
    end
  end
end

#personal_author(node, xml) ⇒ Object 



68
69
70
71
72
73
74
75
76
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 68

def personal_author(node, xml)
  (node.attr("fullname") || node.attr("surname")) and
    personal_author1(node, xml, "")
  i = 2
  while node.attr("fullname_#{i}") || node.attr("surname_#{i}")
    personal_author1(node, xml, "_#{i}")
    i += 1
  end
end

#personal_author1(node, xml, suffix) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 91

def personal_author1(node, xml, suffix)
  xml.contributor do |c|
    personal_role(node, c, suffix)
    c.person do |p|
      person_name(node, xml, suffix, p)
      person_affiliation(node, xml, suffix, p)
      personal_contact(node, suffix, p)
    end
  end
end

#personal_contact(node, suffix, p) ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 82

def personal_contact(node, suffix, p)
  node.attr("phone#{suffix}") and p.phone node.attr("phone#{suffix}")
  node.attr("fax#{suffix}") and
    p.phone node.attr("fax#{suffix}"), **{type: "fax"}
  node.attr("email#{suffix}") and p.email node.attr("email#{suffix}")
  node.attr("contributor-uri#{suffix}") and
    p.uri node.attr("contributor-uri#{suffix}")
end

#personal_role(node, c, suffix) ⇒ Object 



78
79
80
 
# File 'lib/asciidoctor/standoc/front_contributor.rb', line 78

def personal_role(node, c, suffix)
  c.role **{ type: node.attr("role#{suffix}")&.downcase || "author" }
end

#relation_normalise(type) ⇒ Object 



111
112
113
114
 
# File 'lib/asciidoctor/standoc/front.rb', line 111

def relation_normalise(type)
  type.sub(/-by$/, "By").sub(/-of$/, "Of").sub(/-from$/, "From").
    sub(/-in$/, "In")
end

#relaton_relation_descriptions ⇒ Object 



98
99
100
 
# File 'lib/asciidoctor/standoc/front.rb', line 98

def relaton_relation_descriptions
  {}
end

#relaton_relations ⇒ Object 



94
95
96
 
# File 'lib/asciidoctor/standoc/front.rb', line 94

def relaton_relations
  %w(part-of translated-from)
end

#title(node, xml) ⇒ Object 



174
175
176
177
 
# File 'lib/asciidoctor/standoc/front.rb', line 174

def title(node, xml)
  title_english(node, xml)
  title_otherlangs(node, xml)
end

#title_english(node, xml) ⇒ Object 



179
180
181
182
183
184
185
186
187
 
# File 'lib/asciidoctor/standoc/front.rb', line 179

def title_english(node, xml)
  ["en"].each do |lang|
    at = { language: lang, format: "text/plain" }
    xml.title **attr_code(at) do |t|
      t << (Utils::asciidoc_sub(node.attr("title") ||
                                node.attr("title-en")) || node.title)
    end
  end
end

#title_otherlangs(node, xml) ⇒ Object 



189
190
191
192
193
194
195
 
# File 'lib/asciidoctor/standoc/front.rb', line 189

def title_otherlangs(node, xml)
  node.attributes.each do |k, v|
    next unless /^title-(?<titlelang>.+)$/ =~ k
    next if titlelang == "en"
    xml.title v, { language: titlelang, format: "text/plain" }
  end
end