Module: IsoDoc::XrefGen::Anchor

Includes:: Util

Included in:: IsoDoc::Xref

Defined in:: lib/isodoc/xref/xref_anchor.rb

Defined Under Namespace

Constant Summary

Constants included from Util

Util::CHILD_SECTIONS, Util::FIRST_LVL_REQ, Util::FIRST_LVL_REQ_RULE, Util::REQ_CHILDREN, Util::SECTIONS_XPATH, Util::SUBCLAUSES

Instance Method Summary collapse

#anchor_struct(lbl, node, elem_name, type, opt = {}) ⇒ Object
def anchor_struct(lbl, container, elem, type, unnumb = false).
#anchor_struct_label(lbl, node, elem) ⇒ Object
#anchor_struct_value(lbl, elem) ⇒ Object
#anchor_struct_xref(lbl, node, elem) ⇒ Object
#asset_title(node) ⇒ Object
Caption of a numbered asset (its , or a modspec requirement's ), semx-wrapped, so that xrefstyle=full can render "Table 3, caption" the way clauses render "Clause 6, Title".</div> </li> <li class="public "> <a href="#get_anchors-instance_method" title="#get_anchors (instance method)">#get_anchors ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#initialize-instance_method" title="#initialize (instance method)">#initialize ⇒ Object </a> <div class='inline'></div> </li> </ul> <h3 class="inherited">Methods included from <a href="Util.html" title="IsoDoc::XrefGen::Util (module)">Util</a></h3> <a href="Util.html#blank%3F-instance_method" title="IsoDoc::XrefGen::Util#blank? (method)">#blank?</a>, <a href="Util.html#child_asset_path-instance_method" title="IsoDoc::XrefGen::Util#child_asset_path (method)">#child_asset_path</a>, <a href="Util.html#child_sections-instance_method" title="IsoDoc::XrefGen::Util#child_sections (method)">#child_sections</a>, <a href="Util.html#delim_wrap-instance_method" title="IsoDoc::XrefGen::Util#delim_wrap (method)">#delim_wrap</a>, <a href="Util.html#first_lvl_req-instance_method" title="IsoDoc::XrefGen::Util#first_lvl_req (method)">#first_lvl_req</a>, <a href="Util.html#hier_separator-instance_method" title="IsoDoc::XrefGen::Util#hier_separator (method)">#hier_separator</a>, <a href="Util.html#hierfigsep-instance_method" title="IsoDoc::XrefGen::Util#hierfigsep (method)">#hierfigsep</a>, <a href="Util.html#hierreqtsep-instance_method" title="IsoDoc::XrefGen::Util#hierreqtsep (method)">#hierreqtsep</a>, <a href="Util.html#hiersemx-instance_method" title="IsoDoc::XrefGen::Util#hiersemx (method)">#hiersemx</a>, <a href="Util.html#hiersep-instance_method" title="IsoDoc::XrefGen::Util#hiersep (method)">#hiersep</a>, <a href="Util.html#increment_label-instance_method" title="IsoDoc::XrefGen::Util#increment_label (method)">#increment_label</a>, <a href="Util.html#labelled_autonum-instance_method" title="IsoDoc::XrefGen::Util#labelled_autonum (method)">#labelled_autonum</a>, <a href="Util.html#noblank-instance_method" title="IsoDoc::XrefGen::Util#noblank (method)">#noblank</a>, <a href="Util.html#nodeSet-instance_method" title="IsoDoc::XrefGen::Util#nodeSet (method)">#nodeSet</a>, <a href="Util.html#req_children-instance_method" title="IsoDoc::XrefGen::Util#req_children (method)">#req_children</a>, <a href="Util.html#sections_xpath-instance_method" title="IsoDoc::XrefGen::Util#sections_xpath (method)">#sections_xpath</a>, <a href="Util.html#semx-instance_method" title="IsoDoc::XrefGen::Util#semx (method)">#semx</a>, <a href="Util.html#stripsemx-instance_method" title="IsoDoc::XrefGen::Util#stripsemx (method)">#stripsemx</a>, <a href="Util.html#subclauses-instance_method" title="IsoDoc::XrefGen::Util#subclauses (method)">#subclauses</a>, <a href="Util.html#subfigure_delim-instance_method" title="IsoDoc::XrefGen::Util#subfigure_delim (method)">#subfigure_delim</a>, <a href="Util.html#subfigure_separator-instance_method" title="IsoDoc::XrefGen::Util#subfigure_separator (method)">#subfigure_separator</a>, <a href="Util.html#subreqt_separator-instance_method" title="IsoDoc::XrefGen::Util#subreqt_separator (method)">#subreqt_separator</a> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="anchor_struct-instance_method"> #anchor_struct(lbl, node, elem_name, type, opt = {}) ⇒ <tt><a href="../../Object.html" title="Object (class)">Object</a></tt> </h3><div class="docstring"> <div class="discussion"> def anchor_struct(lbl, container, elem, type, unnumb = false) </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 64 65 66 67 68 69 70 71 72 73 74 75</pre> </td> <td> <pre class="code"># File 'lib/isodoc/xref/xref_anchor.rb', line 64 def anchor_struct(lbl, node, elem_name, type, opt = {}) ret = { type: type, elem: elem_name, label: nil } opt[:unnumb] != "true" and ret[:label] = anchor_struct_label(lbl, node, elem_name) ret[:xref] = anchor_struct_xref(opt[:unnumb] == "true" ? "(??)" : lbl, node, elem_name) ret[:container] = @klass.get_clause_id(node) if opt[:container] ret[:value] = stripsemx(lbl) t = asset_title(node) and ret[:title] = t ret end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="anchor_struct_label-instance_method"> #anchor_struct_label(lbl, node, elem) ⇒ <tt><a href="../../Object.html" title="Object (class)">Object</a></tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 33 34 35 36 37 38 39 40 41 42</pre> </td> <td> <pre class="code"># File 'lib/isodoc/xref/xref_anchor.rb', line 33 def anchor_struct_label(lbl, node, elem) case elem when @labels["appendix"] s = "<semx element='autonum' source='#{node['id'] || node[:id]}'>" \ "#{lbl}</semx>" "#{elem} #{s}" else anchor_struct_value(lbl, elem) end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="anchor_struct_value-instance_method"> #anchor_struct_value(lbl, elem) ⇒ <tt><a href="../../Object.html" title="Object (class)">Object</a></tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 52 53 54 55 56 57 58 59 60 61</pre> </td> <td> <pre class="code"># File 'lib/isodoc/xref/xref_anchor.rb', line 52 def anchor_struct_value(lbl, elem) case elem # TODO hardcoded ( ) ? when @labels["formula"], @labels["inequality"] then <<~SPAN.strip #{delim_wrap('(')}#{lbl}#{delim_wrap(')')} SPAN else lbl.to_s end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="anchor_struct_xref-instance_method"> #anchor_struct_xref(lbl, node, elem) ⇒ <tt><a href="../../Object.html" title="Object (class)">Object</a></tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 44 45 46 47 48 49 50</pre> </td> <td> <pre class="code"># File 'lib/isodoc/xref/xref_anchor.rb', line 44 def anchor_struct_xref(lbl, node, elem) unless lbl.blank? lbl = semx(node, lbl) s = " #{anchor_struct_value(lbl, elem)}" end "#{elem}#{s}".gsub(/ $/, "") end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="asset_title-instance_method"> #asset_title(node) ⇒ <tt><a href="../../Object.html" title="Object (class)">Object</a></tt> </h3><div class="docstring"> <div class="discussion"> Caption of a numbered asset (its <name>, or a modspec requirement's <title>), semx-wrapped, so that xrefstyle=full can render "Table 3, caption" the way clauses render "Clause 6, Title". Returns nil when the asset has no caption, so anchor_xref_full falls back to short. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 81 82 83 84</pre> </td> <td> <pre class="code"># File 'lib/isodoc/xref/xref_anchor.rb', line 81 def asset_title(node) n = node.at(ns("./name")) || node.at(ns("./title")) or return nil semx(node, n.children.to_xml, n.name) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="get_anchors-instance_method"> #get_anchors ⇒ <tt><a href="../../Object.html" title="Object (class)">Object</a></tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 29 30 31</pre> </td> <td> <pre class="code"># File 'lib/isodoc/xref/xref_anchor.rb', line 29 def get_anchors @anchors end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="initialize-instance_method"> #initialize ⇒ <tt><a href="../../Object.html" title="Object (class)">Object</a></tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 25 26 27</pre> </td> <td> <pre class="code"># File 'lib/isodoc/xref/xref_anchor.rb', line 25 def initialize @anchors = {} end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Mon Aug 3 10:43:31 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.2). </div> </div> </body> </html>