Module: Asciidoctor::Standoc::Section

Included in:
Converter
Defined in:
lib/asciidoctor/standoc/section.rb

Constant Summary collapse

SYMBOLS_TITLES = 
["symbols and abbreviated terms", "symbols",
"abbreviated terms"].freeze

Instance Method Summary collapse

Instance Method Details

#abstract_parse(attrs, xml, node) ⇒ Object 



109
110
111
112
113
 
# File 'lib/asciidoctor/standoc/section.rb', line 109

def abstract_parse(attrs, xml, node)
  xml.abstract **attr_code(attrs) do |xml_section|
    xml_section << node.content
  end
end

#annex_parse(attrs, xml, node) ⇒ Object 



126
127
128
129
130
131
132
133
 
# File 'lib/asciidoctor/standoc/section.rb', line 126

def annex_parse(attrs, xml, node)
  attrs["inline-header".to_sym] = node.option? "inline-header"
  set_obligation(attrs, node)
  xml.annex **attr_code(attrs) do |xml_section|
    xml_section.title { |name| name << node.title }
    xml_section << node.content
  end
end

#bibliography_parse(attrs, xml, node) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/asciidoctor/standoc/section.rb', line 135

def bibliography_parse(attrs, xml, node)
  node.attr("style") == "bibliography" or
    warn "Section not marked up as [bibliography]!"
  @biblio = true
  xml.references **attr_code(attrs) do |xml_section|
    title = node.level == 1 ? "Bibliography" : node.title
    xml_section.title { |t| t << title }
    xml_section << node.content
  end
  @biblio = false
end

#clause_parse(attrs, xml, node) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/asciidoctor/standoc/section.rb', line 115

def clause_parse(attrs, xml, node)
  attrs["inline-header".to_sym] = node.option? "inline-header"
  attrs[:bibitem] = true if node.option? "bibitem"
  attrs[:level] = node.attr("level")
  set_obligation(attrs, node)
  xml.send "clause", **attr_code(attrs) do |xml_section|
    xml_section.title { |n| n << node.title } unless node.title.nil?
    xml_section << node.content
  end
end

#in_biblio? ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/asciidoctor/standoc/section.rb', line 11

def in_biblio?
  @biblio
end

#in_norm_ref? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/asciidoctor/standoc/section.rb', line 19

def in_norm_ref?
  @norm_ref
end

#in_terms? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/asciidoctor/standoc/section.rb', line 15

def in_terms?
  @term_def
end

#introduction_parse(attrs, xml, node) ⇒ Object 



224
225
226
227
228
229
230
 
# File 'lib/asciidoctor/standoc/section.rb', line 224

def introduction_parse(attrs, xml, node)
  xml.introduction **attr_code(attrs) do |xml_section|
    xml_section.title { |t| t << "Introduction" }
    content = node.content
    xml_section << content
  end
end

#nonterm_symbols_parse(attrs, xml, node) ⇒ Object 



147
148
149
150
151
 
# File 'lib/asciidoctor/standoc/section.rb', line 147

def nonterm_symbols_parse(attrs, xml, node)
  @definitions = false
  clause_parse(attrs, xml, node)
  @definitions = true
end

#nonterm_term_def_subclause_parse(attrs, xml, node) ⇒ Object 



170
171
172
173
174
 
# File 'lib/asciidoctor/standoc/section.rb', line 170

def nonterm_term_def_subclause_parse(attrs, xml, node)
  @term_def = false
  clause_parse(attrs, xml, node)
  @term_def = true
end

#norm_ref_parse(attrs, xml, node) ⇒ Object 



215
216
217
218
219
220
221
222
 
# File 'lib/asciidoctor/standoc/section.rb', line 215

def norm_ref_parse(attrs, xml, node)
  @norm_ref = true
  xml.references **attr_code(attrs) do |xml_section|
    xml_section.title { |t| t << "Normative References" }
    xml_section << node.content
  end
  @norm_ref = false
end

#preamble(node) ⇒ Object 



99
100
101
102
103
104
105
106
107
 
# File 'lib/asciidoctor/standoc/section.rb', line 99

def preamble(node)
  noko do |xml|
    xml.foreword do |xml_abstract|
      xml_abstract.title { |t| t << (node.blocks[0].title || "Foreword") }
      content = node.content
      xml_abstract << content
    end
  end.join("\n")
end

#section(node) ⇒ Object 



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
 
# File 'lib/asciidoctor/standoc/section.rb', line 59

def section(node)
  a = section_attributes(node)
  noko do |xml|
    case sectiontype(node)
    when "introduction" then introduction_parse(a, xml, node)
    when "normative references" then norm_ref_parse(a, xml, node)
    when "terms and definitions"
      @term_def = true
      term_def_parse(a, xml, node, true)
      @term_def = false
    when "symbols and abbreviated terms"
      symbols_parse(a, xml, node)
    when "bibliography" then bibliography_parse(a, xml, node)
    else
      if @term_def then term_def_subclause_parse(a, xml, node)
      elsif @definitions then symbols_parse(a, xml, node)
      elsif @biblio then bibliography_parse(a, xml, node)
      elsif node.attr("style") == "bibliography"
        bibliography_parse(a, xml, node)
      elsif node.attr("style") == "abstract" 
        abstract_parse(a, xml, node)
      elsif node.attr("style") == "appendix" && node.level == 1
        annex_parse(a, xml, node)
      else
        clause_parse(a, xml, node)
      end
    end
  end.join("\n")
end

#section_attributes(node) ⇒ Object 



53
54
55
56
57
 
# File 'lib/asciidoctor/standoc/section.rb', line 53

def section_attributes(node)
  { id: Utils::anchor_or_uuid(node),
    language: node.attributes["language"],
    script: node.attributes["script"] }
end

#sectiontype(node, level = true) ⇒ Object 



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

def sectiontype(node, level = true)
  ret = node&.attr("heading")&.downcase ||
    node.title.gsub(/<[^>]+>/, "").downcase
  ret1 = sectiontype_streamline(ret)
  return ret1 if "symbols and abbreviated terms" == ret1
  return nil unless !level || node.level == 1
  return nil if @seen_headers.include? ret
  @seen_headers << ret
  ret1
end

#sectiontype_streamline(ret) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/asciidoctor/standoc/section.rb', line 34

def sectiontype_streamline(ret)
  case ret
  when "terms and definitions",
    "terms, definitions, symbols and abbreviated terms",
    "terms, definitions, symbols and abbreviations",
    "terms, definitions and symbols",
    "terms, definitions and abbreviations",
    "terms, definitions and abbreviated terms"
    "terms and definitions"
  when "symbols and abbreviated terms",
    "symbols",
    "abbreviated terms",
    "abbreviations"
    "symbols and abbreviated terms"
  else
    ret
  end
end

#set_obligation(attrs, node) ⇒ Object 



89
90
91
92
93
94
95
96
97
 
# File 'lib/asciidoctor/standoc/section.rb', line 89

def set_obligation(attrs, node)
  attrs[:obligation] = if node.attributes.has_key?("obligation")
                         node.attr("obligation")
                       elsif node.parent.attributes.has_key?("obligation")
                         node.parent.attr("obligation")
                       else
                         "normative"
                       end
end

#symbols_parse(attr, xml, node) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/asciidoctor/standoc/section.rb', line 153

def symbols_parse(attr, xml, node)
  node.role == "nonterm" and return nonterm_symbols_parse(attr, xml, node)
  xml.definitions **attr_code(attr) do |xml_section|
    xml_section.title { |t| t << node.title }
    defs = @definitions
    termdefs = @term_def
    @definitions = true
    @term_def = false
    xml_section << node.content
    @definitions = defs
    @term_def = termdefs
  end
end

#term_def_parse(attrs, xml, node, toplevel) ⇒ Object 



205
206
207
208
209
210
211
212
213
 
# File 'lib/asciidoctor/standoc/section.rb', line 205

def term_def_parse(attrs, xml, node, toplevel)
  xml.terms **attr_code(attrs) do |section|
    section.title { |t| t << term_def_title(toplevel, node) }
    (s = node.attr("source")) && s.split(/,/).each do |s1|
      section.termdocsource(nil, **attr_code(bibitemid: s1))
    end
    section << node.content
  end
end

#term_def_subclause_parse(attrs, xml, node) ⇒ Object

subclause contains subclauses



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

def term_def_subclause_parse(attrs, xml, node)
  node.role == "nonterm" ||
    sectiontype(node, false) == "terms and definitions" and
    return nonterm_term_def_subclause_parse(attrs, xml, node)
  return symbols_parse(attrs, xml, node) if @definitions
  sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
  sub.empty? || (return term_def_parse(attrs, xml, node, false))
  sectiontype(node, false) == "symbols and abbreviated terms" and
    (return symbols_parse(attrs, xml, node))
  term_def_subclause_parse1(attrs, xml, node)
end

#term_def_subclause_parse1(attrs, xml, node) ⇒ Object 



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

def term_def_subclause_parse1(attrs, xml, node)
  xml.term **attr_code(attrs) do |xml_section|
    xml_section.preferred { |name| name << node.title }
    xml_section << node.content
  end
end

#term_def_title(toplevel, node) ⇒ Object 



196
197
198
199
200
201
202
203
 
# File 'lib/asciidoctor/standoc/section.rb', line 196

def term_def_title(toplevel, node)
  return node.title unless toplevel
  sub = node.find_by(context: :section) do |s|
    SYMBOLS_TITLES.include? s.title.downcase
  end
  return "Terms and definitions" if sub.empty?
  "Terms, definitions, symbols and abbreviated terms"
end