Skip to content

Configurable, uniquely-classed caption delimiters #838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
opoudjis merged 2 commits into from
Aug 11, 2026
Merged

Configurable, uniquely-classed caption delimiters #838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
997f41d
Configurable, uniquely-classed caption delimiters
opoudjis Aug 10, 2026
9f45f64
Update spec fixtures for fmt-clause-delim terminal delimiter class
opoudjis Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion lib/isodoc/function/section_titles.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
module IsoDoc
module Function
module Section
# Optional per-caption-type delimiter override from i18n: a
# +<type>_delimiter+ key, falling back to a shared +caption_delimiter+
# key, falling back to the hardcoded default. Uses +@i18n.get+ (hash
# lookup, nil for absent keys) rather than +@i18n.<key>+ (which is only
# defined for present keys). The keys are absent from the base i18n YAML,
# so default behaviour is unchanged unless a flavour or document sets them.
def i18n_delim(type, default)
@i18n&.get&.dig("#{type}_delimiter") ||
@i18n&.get&.dig("caption_delimiter") || default
end

def clausedelim
"."
i18n_delim("clause", ".")
end

def clausedelimspace(_node, out)
Expand Down
2 changes: 1 addition & 1 deletion lib/isodoc/presentation_function/annex.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def annex_delim_override(elem)
end

def annex_delim(_elem)
"<br/><br/>"
i18n_delim("annex", "<br/><br/>")
end
end
end
12 changes: 7 additions & 5 deletions lib/isodoc/presentation_function/block.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,16 @@ def example1(elem)
n = @xrefs.get[elem["id"]] || @xrefs.get[elem["original-id"]]
lbl = labelled_autonum(@i18n.example, elem["id"] || elem["original-id"],
n&.dig(:label))
prefix_name(elem, { caption: block_delim }, lbl, "name")
prefix_name(elem, { caption: i18n_delim("example", block_delim) }, lbl,
"name")
end

def note(docxml)
docxml.xpath(ns("//note")).each { |f| note1(f) }
end

def note_delim(_elem)
"<tab/>"
i18n_delim("note", "<tab/>")
end

def note1(elem)
Expand Down Expand Up @@ -88,7 +89,8 @@ def admonition1(elem)

def admonition_options(elem)
options = { label: admonition_delim(elem) }
elem["type"] == "box" and options = { caption: block_delim }
elem["type"] == "box" and
options = { caption: i18n_delim("admonition", block_delim) }
options
end

Expand Down Expand Up @@ -119,7 +121,7 @@ def admonition_icon(elem)

def admonition_delim(elem)
if elem["type"] == "box"
block_delim
i18n_delim("admonition", block_delim)
else
""
end
Expand Down Expand Up @@ -157,7 +159,7 @@ def table_css(elem)
end

def table_delim
block_delim
i18n_delim("table", block_delim)
end

def table_long_strings_cleanup(docxml)
Expand Down
5 changes: 2 additions & 3 deletions lib/isodoc/presentation_function/image.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,11 @@ def svg_extract(elem)
end

def subfigure_delim
""
# "<span class='fmt-label-delim'>)</span>"
i18n_delim("subfigure", "")
end

def figure_delim(_elem)
block_delim
i18n_delim("figure", block_delim)
end

def figure_name(elem)
Expand Down
2 changes: 1 addition & 1 deletion lib/isodoc/presentation_function/section.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def numbered_clause_invalid_context?(elem)
def clausedelim
ret = super
(ret && !ret.empty?) or return ret
"<span class='fmt-autonum-delim'>#{ret}</span>"
"<span class='fmt-clause-delim'>#{ret}</span>"
end

def clause1(elem)
Expand Down
3 changes: 2 additions & 1 deletion lib/isodoc/presentation_function/sourcecode.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ def source_label(elem)
lbl = @xrefs.anchor(elem["id"], :label, false)
s = labelled_autonum(lower2cap(@i18n.figure), elem["id"], lbl)&.strip
end
prefix_name(elem, { caption: block_delim }, s, "name")
prefix_name(elem, { caption: i18n_delim("sourcecode", block_delim) }, s,
"name")
end
end
end
2 changes: 1 addition & 1 deletion lib/isodoc/presentation_function/terms.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def termnote(docxml)
end

def termnote_delim(_elem, lbl)
l10n(": ", { prev: lbl })
l10n(i18n_delim("termnote", ": "), { prev: lbl })
end

def termnote1(elem)
Expand Down
24 changes: 12 additions & 12 deletions spec/isodoc/amend_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
<fmt-title depth="1" id="_">
<span class="fmt-caption-label">
<semx element="autonum" source="A">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand Down Expand Up @@ -278,7 +278,7 @@
OUTPUT
html = <<~OUTPUT
<div id="A">
<h1>1.\u00a0 Change Clause</h1>
<h1>1<span class="fmt-clause-delim">.</span>\u00a0 Change Clause</h1>
<p id="C">
<i>
This table contains information on polygon cells which are not
Expand Down Expand Up @@ -444,7 +444,7 @@
<fmt-title depth="1" id="_">
<span class="fmt-caption-label">
<semx element="autonum" source="A">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand Down Expand Up @@ -553,7 +553,7 @@
<p depth="1" type="floating-title">
<span class="fmt-caption-label">
<semx element="autonum" source="_">3.1.2.14</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand Down Expand Up @@ -620,7 +620,7 @@
<p depth="1" type="floating-title">
<span class="fmt-caption-label">
<semx element="autonum" source="xxx">3.1.2.15</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -638,7 +638,7 @@
<semx element="autonum" source="xxx">3.1.2.15</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="xxy">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand Down Expand Up @@ -734,7 +734,7 @@
INPUT
html = <<~OUTPUT
<div id="A">
<h1>1.\u00a0 Change Clause</h1>
<h1>1<span class="fmt-clause-delim">.</span>\u00a0 Change Clause</h1>
<p id="_">Add the following terminological entries after 3.1.2.13:</p>
<div class="Quote AmendNewcontent">
<div id="F" class="example">
Expand All @@ -744,7 +744,7 @@
</div>
<div class="Quote AmendNewcontent" id="_">
<p class="h1">
3.1.2.14.\u00a0
3.1.2.14<span class="fmt-clause-delim">.</span>\u00a0
<br/>
canonical form
</p>
Expand All @@ -771,10 +771,10 @@
</table>
</div>
<div class="Quote AmendNewcontent" id="xxx">
<p class="h1">3.1.2.15.\u00a0 container</p>
<p class="h1">3.1.2.15<span class="fmt-clause-delim">.</span>\u00a0 container</p>
<p>This is a container of a subclause.</p>
<div class="Quote AmendNewcontent" id="xxy">
<p class="h2">3.1.2.15.1.\u00a0 non-canonical form</p>
<p class="h2">3.1.2.15.1<span class="fmt-clause-delim">.</span>\u00a0 non-canonical form</p>
<p id="_">
date and time expression where all its time scale components are
<i>unnormalised</i>
Expand Down Expand Up @@ -924,7 +924,7 @@
<p depth="1" type="floating-title">
<span class="fmt-caption-label">
<semx element="autonum" source="xxx">3.1.2.15</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -942,7 +942,7 @@
<semx element="autonum" source="xxx">3.1.2.15</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="xxy">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand Down
28 changes: 14 additions & 14 deletions spec/isodoc/blocks_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,7 @@
<fmt-title depth="1" id="_">
<span class="fmt-caption-label">
<semx element="autonum" source="clause1">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -955,7 +955,7 @@
<semx element="autonum" source="clause1">1</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="clause1A">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -977,7 +977,7 @@
<semx element="autonum" source="clause1A">1</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="clause1Aa">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -1002,7 +1002,7 @@
<semx element="autonum" source="clause1A">1</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="clause1Ab">2</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -1026,7 +1026,7 @@
<semx element="autonum" source="clause1">1</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="clause1B">2</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -1048,7 +1048,7 @@
<semx element="autonum" source="clause1B">2</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="clause1Ba">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -1071,7 +1071,7 @@
<fmt-title depth="1" id="_">
<span class="fmt-caption-label">
<semx element="autonum" source="clause2">2</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand Down Expand Up @@ -1300,25 +1300,25 @@
#{HTML_HDR}
<p class='zzSTDTitle1'>Document title</p>
<div id='clause1'>
<h1>1.&nbsp; Clause 1</h1>
<h1>1<span class="fmt-clause-delim">.</span>&nbsp; Clause 1</h1>
<div id='clause1A'>
<h2>1.1.&nbsp; Clause 1A</h2>
<h2>1.1<span class="fmt-clause-delim">.</span>&nbsp; Clause 1A</h2>
<div id='clause1Aa'>
<h3>1.1.1.&nbsp; Clause 1Aa</h3>
<h3>1.1.1<span class="fmt-clause-delim">.</span>&nbsp; Clause 1Aa</h3>
</div>
<div id='clause1Ab'>
<h3>1.1.2.&nbsp; Clause 1Ab</h3>
<h3>1.1.2<span class="fmt-clause-delim">.</span>&nbsp; Clause 1Ab</h3>
</div>
</div>
<div id='clause1B'>
<h2>1.2.&nbsp; Clause 1B</h2>
<h2>1.2<span class="fmt-clause-delim">.</span>&nbsp; Clause 1B</h2>
<div id='clause1Ba'>
<h3>1.2.1.&nbsp; Clause 1Ba</h3>
<h3>1.2.1<span class="fmt-clause-delim">.</span>&nbsp; Clause 1Ba</h3>
</div>
</div>
</div>
<div id='clause2'>
<h1>2.&nbsp; Clause 2</h1>
<h1>2<span class="fmt-clause-delim">.</span>&nbsp; Clause 2</h1>
<p id='A'>And introducing: </p>
<div class='toc'>
<div class="ul_wrap">
Expand Down
4 changes: 2 additions & 2 deletions spec/isodoc/concept_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1045,7 +1045,7 @@
<fmt-title depth="1" id="_">
<span class="fmt-caption-label">
<semx element="autonum" source="terms_and_definitions">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand All @@ -1062,7 +1062,7 @@
<semx element="autonum" source="terms_and_definitions">1</semx>
<span class="fmt-autonum-delim">.</span>
<semx element="autonum" source="paddy1">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
</fmt-name>
<fmt-xref-label>
Expand Down
4 changes: 2 additions & 2 deletions spec/isodoc/eref_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@
</p>
</div>
<div>
<h1>1.\u00a0 Normative References</h1>
<h1>1<span class="fmt-clause-delim">.</span>\u00a0 Normative References</h1>
<p id="ISO712" class="NormRef">ISO\u00a0712,
<i>Cereals and cereal products</i>
</p>
Expand Down Expand Up @@ -451,7 +451,7 @@
</p>
</div>
<div>
<h1>1.\u00a0 Normative References</h1>
<h1>1<span class="fmt-clause-delim">.</span>\u00a0 Normative References</h1>
<p id="ISO712" class="NormRef">
1, ALUFFI, Paolo, David ANDERSON, Milena HERING, Mircea MUSTAŢĂ and Sam PAYNE (eds.).
<i>Facets of Algebraic Geometry: A Collection in Honor of William Fulton's 80th Birthday</i>
Expand Down
6 changes: 3 additions & 3 deletions spec/isodoc/figures_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@
<fmt-title depth="1" id="_30">
<span class="fmt-caption-label">
<semx element="autonum" source="_normative_references">1</semx>
<span class="fmt-autonum-delim">.</span>
<span class="fmt-clause-delim">.</span>
</span>
<span class="fmt-caption-delim">
<tab/>
Expand Down Expand Up @@ -406,7 +406,7 @@
</figure>
</div>
<div>
<h1>1.  Normative References</h1>
<h1>1<span class="fmt-clause-delim">.</span>  Normative References</h1>
<p id="ISO712" class="NormRef">ISO 712, International Organization for Standardization. <i>Cereals and cereal products</i>.</p>
</div>
<br/>
Expand Down Expand Up @@ -546,7 +546,7 @@
</p>
<div class="WordSection3">
<div>
<h1>1.<span style="mso-tab-count:1">\u00a0 </span>Normative References</h1>
<h1>1<span class="fmt-clause-delim">.</span><span style="mso-tab-count:1">\u00a0 </span>Normative References</h1>
<p id="ISO712" class="NormRef">
ISO\u00a0712, International Organization for Standardization.
<i>Cereals and cereal products</i>
Expand Down
Loading
Loading