metanorma-iso 2.8.5 → 2.8.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/isodoc/iso/html/style-human.css +1 -1
- data/lib/isodoc/iso/html/style-iso.css +1 -1
- data/lib/isodoc/iso/iso.amendment.xsl +74 -17
- data/lib/isodoc/iso/iso.international-standard.xsl +74 -17
- data/lib/metanorma/iso/basicdoc.rng +861 -481
- data/lib/metanorma/iso/biblio-standoc.rng +87 -20
- data/lib/metanorma/iso/biblio.rng +882 -325
- data/lib/metanorma/iso/front_contributor.rb +10 -6
- data/lib/metanorma/iso/isodoc.rng +1031 -915
- data/lib/metanorma/iso/reqt.rng +94 -75
- data/lib/metanorma/iso/validate.rb +43 -15
- data/lib/metanorma/iso/validate_section.rb +1 -0
- data/lib/metanorma/iso/version.rb +1 -1
- metadata +2 -2
data/lib/metanorma/iso/reqt.rng
CHANGED
|
@@ -1,20 +1,27 @@
|
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
-
<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
|
|
2
|
+
<grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
|
|
3
3
|
<!--
|
|
4
4
|
Presupposes isodoc.rnc, is included in it
|
|
5
5
|
include "isodoc.rnc" { }
|
|
6
|
+
|
|
7
|
+
This is the Metanorma default provisions model; it is overridden by other provisions models,
|
|
8
|
+
such as Modspec
|
|
6
9
|
-->
|
|
7
10
|
<define name="requirement">
|
|
11
|
+
<a:documentation>Specification of an attribute of a subject that is required.
|
|
12
|
+
NOTE: A requirement can contain other requirements</a:documentation>
|
|
8
13
|
<element name="requirement">
|
|
9
14
|
<ref name="RequirementType"/>
|
|
10
15
|
</element>
|
|
11
16
|
</define>
|
|
12
17
|
<define name="recommendation">
|
|
18
|
+
<a:documentation>Specification of an attribute of a subject that is recommended</a:documentation>
|
|
13
19
|
<element name="recommendation">
|
|
14
20
|
<ref name="RequirementType"/>
|
|
15
21
|
</element>
|
|
16
22
|
</define>
|
|
17
23
|
<define name="permission">
|
|
24
|
+
<a:documentation>Specification of an attribute of a subject that is permitted</a:documentation>
|
|
18
25
|
<element name="permission">
|
|
19
26
|
<ref name="RequirementType"/>
|
|
20
27
|
</element>
|
|
@@ -22,83 +29,101 @@
|
|
|
22
29
|
<define name="RequirementType">
|
|
23
30
|
<optional>
|
|
24
31
|
<attribute name="obligation">
|
|
25
|
-
<
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
<optional>
|
|
29
|
-
<attribute name="unnumbered">
|
|
30
|
-
<data type="boolean"/>
|
|
31
|
-
</attribute>
|
|
32
|
-
</optional>
|
|
33
|
-
<optional>
|
|
34
|
-
<attribute name="number"/>
|
|
35
|
-
</optional>
|
|
36
|
-
<optional>
|
|
37
|
-
<attribute name="subsequence"/>
|
|
38
|
-
</optional>
|
|
39
|
-
<optional>
|
|
40
|
-
<attribute name="keep-with-next">
|
|
41
|
-
<data type="boolean"/>
|
|
42
|
-
</attribute>
|
|
43
|
-
</optional>
|
|
44
|
-
<optional>
|
|
45
|
-
<attribute name="keep-lines-together">
|
|
46
|
-
<data type="boolean"/>
|
|
32
|
+
<a:documentation>An attribute that may be used to override the obligation represented in
|
|
33
|
+
the tag name of the top level containers</a:documentation>
|
|
34
|
+
<ref name="ReqtObligationType"/>
|
|
47
35
|
</attribute>
|
|
48
36
|
</optional>
|
|
49
37
|
<attribute name="id">
|
|
50
38
|
<data type="ID"/>
|
|
51
39
|
</attribute>
|
|
40
|
+
<ref name="NumberingAttributes"/>
|
|
41
|
+
<ref name="BlockAttributes"/>
|
|
52
42
|
<optional>
|
|
53
|
-
<attribute name="filename"
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
<attribute name="model"/>
|
|
57
|
-
</optional>
|
|
58
|
-
<optional>
|
|
59
|
-
<attribute name="type"/>
|
|
43
|
+
<attribute name="filename">
|
|
44
|
+
<a:documentation>File name of the requirement model when exported</a:documentation>
|
|
45
|
+
</attribute>
|
|
60
46
|
</optional>
|
|
61
47
|
<optional>
|
|
62
|
-
<attribute name="
|
|
48
|
+
<attribute name="model">
|
|
49
|
+
<a:documentation>Model of requirements realised by this requirement, e.g. "ogc" for Modspec</a:documentation>
|
|
50
|
+
</attribute>
|
|
63
51
|
</optional>
|
|
64
52
|
<optional>
|
|
65
|
-
<attribute name="
|
|
66
|
-
<
|
|
53
|
+
<attribute name="type">
|
|
54
|
+
<a:documentation>Type of requirement; does not override labelling, unlike `class`</a:documentation>
|
|
67
55
|
</attribute>
|
|
68
56
|
</optional>
|
|
69
57
|
<optional>
|
|
70
|
-
<attribute name="class"
|
|
58
|
+
<attribute name="class">
|
|
59
|
+
<a:documentation>Class of provision, used to sequence and label that class separately.
|
|
60
|
+
By default, provisions are sequenced and labelled as requirements, recommendations, or
|
|
61
|
+
permissions, by obligation; the class overrides that</a:documentation>
|
|
62
|
+
</attribute>
|
|
71
63
|
</optional>
|
|
72
64
|
<optional>
|
|
73
|
-
<ref name="reqtitle"
|
|
65
|
+
<ref name="reqtitle">
|
|
66
|
+
<a:documentation>Human-readable title of the requirement</a:documentation>
|
|
67
|
+
</ref>
|
|
74
68
|
</optional>
|
|
75
69
|
<optional>
|
|
76
|
-
<ref name="
|
|
70
|
+
<ref name="reqtlabel">
|
|
71
|
+
<a:documentation>Formal identifier with which the requirement is referenced</a:documentation>
|
|
72
|
+
</ref>
|
|
77
73
|
</optional>
|
|
78
74
|
<zeroOrMore>
|
|
79
|
-
<ref name="subject"
|
|
75
|
+
<ref name="subject">
|
|
76
|
+
<a:documentation>The party subject to the obligation stated in the requirement</a:documentation>
|
|
77
|
+
</ref>
|
|
80
78
|
</zeroOrMore>
|
|
81
79
|
<zeroOrMore>
|
|
82
|
-
<ref name="reqinherit"
|
|
80
|
+
<ref name="reqinherit">
|
|
81
|
+
<a:documentation>Reference to the identifier of another requirement, of which this requirement
|
|
82
|
+
is a subclass, and from which it inherits attributes</a:documentation>
|
|
83
|
+
</ref>
|
|
83
84
|
</zeroOrMore>
|
|
84
85
|
<zeroOrMore>
|
|
85
|
-
<ref name="classification"
|
|
86
|
+
<ref name="classification">
|
|
87
|
+
<a:documentation>Key/Value pairs of metadata used to describe the requirement.
|
|
88
|
+
A key can be associated with multiple values</a:documentation>
|
|
89
|
+
</ref>
|
|
86
90
|
</zeroOrMore>
|
|
87
91
|
<zeroOrMore>
|
|
88
92
|
<choice>
|
|
89
|
-
<ref name="measurementtarget"
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
<ref name="
|
|
93
|
-
|
|
94
|
-
|
|
93
|
+
<ref name="measurementtarget">
|
|
94
|
+
<a:documentation>Quantitative statement of metrics that the requirement realises</a:documentation>
|
|
95
|
+
</ref>
|
|
96
|
+
<ref name="specification">
|
|
97
|
+
<a:documentation>Formal specification of the requirement. Expected to be machine-readable</a:documentation>
|
|
98
|
+
</ref>
|
|
99
|
+
<ref name="verification">
|
|
100
|
+
<a:documentation>Processes or code used to verify that the requirement is being complied
|
|
101
|
+
with. Can be a test (including test code), or a compliance statement</a:documentation>
|
|
102
|
+
</ref>
|
|
103
|
+
<ref name="import">
|
|
104
|
+
<a:documentation>A reference to source code or a statement of prerequisites which is defined elsewhere</a:documentation>
|
|
105
|
+
</ref>
|
|
106
|
+
<ref name="description">
|
|
107
|
+
<a:documentation>Descriptive statement of the content of the requirement. Is expected to
|
|
108
|
+
be human-readable, and to contain formatting markup following Metanorma
|
|
109
|
+
conventions. Is expected to be discursive, and be resumed after
|
|
110
|
+
interruption by other sub-containers</a:documentation>
|
|
111
|
+
</ref>
|
|
112
|
+
<ref name="component">
|
|
113
|
+
<a:documentation>Provisions nested within this provision, which cannot be referenced autonomously and have
|
|
114
|
+
subclasses specific to the parent provision. Not expressed with provision metadata</a:documentation>
|
|
115
|
+
</ref>
|
|
95
116
|
</choice>
|
|
96
117
|
</zeroOrMore>
|
|
97
118
|
<optional>
|
|
98
|
-
<ref name="reqt_references"
|
|
119
|
+
<ref name="reqt_references">
|
|
120
|
+
<a:documentation>A list of references for the requirement, following the Relaton model</a:documentation>
|
|
121
|
+
</ref>
|
|
99
122
|
</optional>
|
|
100
123
|
<zeroOrMore>
|
|
101
124
|
<choice>
|
|
125
|
+
<a:documentation>Provisions nested within this provision, which are self-standing and do not have
|
|
126
|
+
subclasses specific to the parent provision</a:documentation>
|
|
102
127
|
<ref name="requirement"/>
|
|
103
128
|
<ref name="recommendation"/>
|
|
104
129
|
<ref name="permission"/>
|
|
@@ -107,10 +132,10 @@
|
|
|
107
132
|
</define>
|
|
108
133
|
<define name="reqtitle">
|
|
109
134
|
<element name="title">
|
|
110
|
-
<ref name="
|
|
135
|
+
<ref name="LocalizedMarkedUpString"/>
|
|
111
136
|
</element>
|
|
112
137
|
</define>
|
|
113
|
-
<define name="
|
|
138
|
+
<define name="reqtlabel">
|
|
114
139
|
<element name="identifier">
|
|
115
140
|
<oneOrMore>
|
|
116
141
|
<ref name="TextElement"/>
|
|
@@ -158,7 +183,9 @@
|
|
|
158
183
|
</define>
|
|
159
184
|
<define name="component">
|
|
160
185
|
<element name="component">
|
|
161
|
-
<attribute name="class"
|
|
186
|
+
<attribute name="class">
|
|
187
|
+
<a:documentation>Class of component</a:documentation>
|
|
188
|
+
</attribute>
|
|
162
189
|
<ref name="RequirementSubpart"/>
|
|
163
190
|
</element>
|
|
164
191
|
</define>
|
|
@@ -170,44 +197,36 @@
|
|
|
170
197
|
</element>
|
|
171
198
|
</define>
|
|
172
199
|
<define name="RequirementSubpart">
|
|
173
|
-
<
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
200
|
+
<a:documentation>A subcontainer can be either machine-readable or human-readable, or a
|
|
201
|
+
mixture of the two.
|
|
202
|
+
A machine-readable component can be included as source code with
|
|
203
|
+
nomination of the language</a:documentation>
|
|
204
|
+
<optional>
|
|
205
|
+
<attribute name="type">
|
|
206
|
+
<a:documentation>Type of sub-container.
|
|
207
|
+
For example a `verification[@type = "unit-test"]` contains a unit test of a single
|
|
208
|
+
feature, and is to be treated differently from
|
|
209
|
+
`verification[@type = "comprehensive"]`, which represents a comprehensive test suite</a:documentation>
|
|
179
210
|
</attribute>
|
|
180
211
|
</optional>
|
|
181
212
|
<optional>
|
|
182
|
-
<attribute name="
|
|
183
|
-
<
|
|
184
|
-
|
|
185
|
-
</optional>
|
|
186
|
-
<optional>
|
|
187
|
-
<attribute name="keep-lines-together">
|
|
213
|
+
<attribute name="exclude">
|
|
214
|
+
<a:documentation>Indicates that the current sub-container is only intended to be
|
|
215
|
+
machine-readable, and is not to be rendered as document output</a:documentation>
|
|
188
216
|
<data type="boolean"/>
|
|
189
217
|
</attribute>
|
|
190
218
|
</optional>
|
|
191
|
-
<
|
|
192
|
-
<attribute name="tag"/>
|
|
193
|
-
</optional>
|
|
194
|
-
<optional>
|
|
195
|
-
<attribute name="multilingual-rendering">
|
|
196
|
-
<ref name="MultilingualRenderingType"/>
|
|
197
|
-
</attribute>
|
|
198
|
-
</optional>
|
|
219
|
+
<ref name="BlockAttributes"/>
|
|
199
220
|
<oneOrMore>
|
|
200
221
|
<choice>
|
|
222
|
+
<a:documentation>Content of subpart: blocks, rather than provisions</a:documentation>
|
|
201
223
|
<ref name="BasicBlock"/>
|
|
202
224
|
<ref name="component"/>
|
|
203
225
|
</choice>
|
|
204
226
|
</oneOrMore>
|
|
205
227
|
</define>
|
|
206
|
-
<define name="
|
|
207
|
-
<
|
|
208
|
-
|
|
209
|
-
<value>recommendation</value>
|
|
210
|
-
<value>permission</value>
|
|
211
|
-
</choice>
|
|
228
|
+
<define name="ReqtObligationType">
|
|
229
|
+
<a:documentation>Values are "requirement", "recommendation", "permission"; multiple values can be comma-delimited</a:documentation>
|
|
230
|
+
<text/>
|
|
212
231
|
</define>
|
|
213
232
|
</grammar>
|
|
@@ -49,8 +49,7 @@ module Metanorma
|
|
|
49
49
|
@lang == "en" or return
|
|
50
50
|
root.xpath("//eref").each do |t|
|
|
51
51
|
prec = t.at("./preceding-sibling::text()[last()]")
|
|
52
|
-
|
|
53
|
-
|
|
52
|
+
!prec.nil? && /\b(see|refer to)\p{Zs}*\Z/mi.match(prec) or next
|
|
54
53
|
unless target = root.at("//*[@id = '#{t['bibitemid']}']")
|
|
55
54
|
@log.add("Bibliography", t,
|
|
56
55
|
"'#{t} is not pointing to a real reference")
|
|
@@ -103,6 +102,27 @@ module Metanorma
|
|
|
103
102
|
"(#{xref['target']})")
|
|
104
103
|
end
|
|
105
104
|
|
|
105
|
+
# require that all assets of a particular type be cross-referenced
|
|
106
|
+
# within the document
|
|
107
|
+
def xrefs_mandate_validate(xmldoc)
|
|
108
|
+
xrefs_mandate_validate1(xmldoc, "//annex", "Annex")
|
|
109
|
+
xrefs_mandate_validate1(xmldoc, "//table", "Table")
|
|
110
|
+
xrefs_mandate_validate1(xmldoc, "//figure", "Figure")
|
|
111
|
+
xrefs_mandate_validate1(xmldoc, "//formula", "Formula")
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
def xrefs_mandate_validate1(xmldoc, xpath, name)
|
|
115
|
+
exc = %w(table note example figure).map { |x| "//#{x}#{xpath}" }
|
|
116
|
+
.join(" | ")
|
|
117
|
+
(xmldoc.xpath(xpath) - xmldoc.xpath(exc)).each do |x|
|
|
118
|
+
x["unnumbered"] == "true" and next
|
|
119
|
+
@doc_xrefs[x["id"]] or
|
|
120
|
+
@log.add("Style", x, "#{name} #{x['id']} has not been " \
|
|
121
|
+
"cross-referenced within document",
|
|
122
|
+
severity: xpath == "//formula" ? 2 : 1)
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
|
|
106
126
|
# ISO/IEC DIR 2, 16.5.6
|
|
107
127
|
def termdef_style(xmldoc)
|
|
108
128
|
xmldoc.xpath("//term").each do |t|
|
|
@@ -139,21 +159,30 @@ module Metanorma
|
|
|
139
159
|
|
|
140
160
|
def content_validate(doc)
|
|
141
161
|
super
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
termdef_style(
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
162
|
+
root = doc.root
|
|
163
|
+
title_validate(root)
|
|
164
|
+
isosubgroup_validate(root)
|
|
165
|
+
termdef_style(root)
|
|
166
|
+
iso_xref_validate(root)
|
|
167
|
+
bibdata_validate(root)
|
|
168
|
+
bibitem_validate(root)
|
|
169
|
+
figure_validate(root)
|
|
170
|
+
list_validate(doc)
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
def list_validate(doc)
|
|
153
174
|
listcount_validate(doc)
|
|
154
175
|
list_punctuation(doc)
|
|
155
176
|
end
|
|
156
177
|
|
|
178
|
+
def iso_xref_validate(doc)
|
|
179
|
+
see_xrefs_validate(doc)
|
|
180
|
+
term_xrefs_validate(doc)
|
|
181
|
+
xrefs_mandate_validate(doc)
|
|
182
|
+
see_erefs_validate(doc)
|
|
183
|
+
locality_erefs_validate(doc)
|
|
184
|
+
end
|
|
185
|
+
|
|
157
186
|
def bibitem_validate(xmldoc)
|
|
158
187
|
xmldoc.xpath("//bibitem[date/on = '–']").each do |b|
|
|
159
188
|
b.at("./note[@type = 'Unpublished-Status']") or
|
|
@@ -168,8 +197,7 @@ module Metanorma
|
|
|
168
197
|
schema = case @doctype
|
|
169
198
|
when "amendment", "technical-corrigendum" # @amd
|
|
170
199
|
"isostandard-amd.rng"
|
|
171
|
-
else
|
|
172
|
-
"isostandard-compile.rng"
|
|
200
|
+
else "isostandard-compile.rng"
|
|
173
201
|
end
|
|
174
202
|
schema_validate(formattedstr_strip(doc.dup),
|
|
175
203
|
File.join(File.dirname(__FILE__), schema))
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: metanorma-iso
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.8.
|
|
4
|
+
version: 2.8.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ribose Inc.
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-09-
|
|
11
|
+
date: 2024-09-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: metanorma-standoc
|