metanorma-acme 1.1.2 → 1.1.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 177e238609000a23b8f8ec319af912ab4b6055d098fdbdb6ffd5847c23cd7ed7
4
- data.tar.gz: 2c814dcc6f3921878c5393be7029420d017283fde3fd6b712d0e9fae64aef8ea
3
+ metadata.gz: 5bde92b346782d8be6dff51c3a11bb980748573f95a499e3e7c9bed495825cd8
4
+ data.tar.gz: 7ccbf6dc1d106ca80d9f033b567566fcdbf073380cabe94912b21ffc6f41c5d4
5
5
  SHA512:
6
- metadata.gz: a6a590fb5332fcf3c06699d7fa3a59792e2f4d19fa7f2450e61e077461debb3f4dc0a7dff8e35c5564e8a4e8bd8c2e8ab9f3b53a18db6d0b9fd7f6095cf24516
7
- data.tar.gz: 67050d480c80f186728882e4402af0edef1e73ab268ab32d9c3d63b47fa1c06aecd438b581344a98617586d1fa114cf469625b098afc96834883545f0fb1e5cb
6
+ metadata.gz: fa1304ef753a691270404be9510515886b70886d2d4eaf20cb21c306dfff8be30c386f3b9d82783ccbf8b8402997a0ae648f5061985bc854b743596c7da17a4a
7
+ data.tar.gz: d57119dd6d4241560f583d83e63e5119e025a66b1a765c1bd2db907c8cee1bfdaec909ae986f09a47f6fb001e47572313d624379151d309ab3b5bcaecf6da2cb
data/README.adoc CHANGED
@@ -1,8 +1,8 @@
1
1
  = metanorma-acme: Asciidoctor processor for a (fictitious) Acme Corporation
2
2
 
3
3
  image:https://img.shields.io/gem/v/metanorma-acme.svg["Gem Version", link="https://rubygems.org/gems/metanorma-acme"]
4
- image:https://img.shields.io/travis/riboseinc/metanorma-acme/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma-acme"]
5
- image:https://codeclimate.com/github/riboseinc/metanorma-acme/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma-acme"]
4
+ image:https://img.shields.io/travis/metanorma/metanorma-acme/master.svg["Build Status", link="https://travis-ci.org/metanorma/metanorma-acme"]
5
+ image:https://codeclimate.com/github/metanorma/metanorma-acme/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-acme"]
6
6
 
7
7
  WARNING: This gem is still under development.
8
8
 
@@ -11,9 +11,9 @@ WARNING: This gem is still under development.
11
11
  This gem processes http://asciidoctor.org/[Asciidoctor] documents following
12
12
  a template for generating Acme documents.
13
13
 
14
- The gem currently inherits from the https://github.com/riboseinc/metanorma-standoc
14
+ The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
15
15
  gem, and aligns closely to it. Refer to the ISO gem documentation
16
- for guidance, including https://github.com/riboseinc/metanorma-iso/wiki/Guidance-for-authoring
16
+ for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance-for-authoring
17
17
 
18
18
  The following outputs are generated.
19
19
 
@@ -55,13 +55,13 @@ $ asciidoctor -b acme -r 'metanorma-acme' a.adoc
55
55
 
56
56
  === Installation
57
57
 
58
- If you are using a Mac, the https://github.com/riboseinc/metanorma-macos-setup
58
+ If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup
59
59
  repository has instructions on setting up your machine to run Metanorma
60
60
  scripts such as this one. You need only run the following in a Terminal console:
61
61
 
62
62
  [source,console]
63
63
  ----
64
- $ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
64
+ $ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
65
65
  $ gem install metanorma-acme
66
66
  $ gem install metanorma-cli
67
67
  ----
@@ -71,7 +71,7 @@ $ gem install metanorma-cli
71
71
  === Document model
72
72
 
73
73
  The Acme Document model used by this gem is an instance of the
74
- https://github.com/riboseinc/isodoc-models[StandardDocument model].
74
+ https://github.com/metanorma/metanorma-model-standoc[StandardDocument model].
75
75
 
76
76
  The Metanorma XML format intends to introduce rigor into the Acme
77
77
  standards authoring process, and is prescribed in a separate document.
@@ -97,7 +97,7 @@ hored.
97
97
  === Common attributes
98
98
 
99
99
  The gem relies on Asciidoctor document attributes to provide necessary
100
- metadata about the document. The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
100
+ metadata about the document. The https://github.com/metanorma/metanorma-standoc[metanorma-standoc]
101
101
  gem documents the Asciidoctor document attributes common to all metanorma gems. These include:
102
102
 
103
103
  `:edition:`:: The document edition
@@ -128,14 +128,14 @@ report:: report
128
128
  `:technical-committee:`:: The name of the relevant M3D technical committee
129
129
  (mandatory)
130
130
 
131
- `:language:` :: The language of the document (only `en` for now) (mandatory)
131
+ `:language:` :: The language of the document (only `en` for now)
132
132
 
133
133
  The attribute `:draft:`, if present, includes review notes in the XML output;
134
134
  these are otherwise suppressed.
135
135
 
136
136
  == Asciidoctor features specific to Acme
137
137
 
138
- The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
138
+ The https://github.com/metanorma/metanorma-standoc[metanorma-standoc]
139
139
  gem documents the customisations of Asciidoctor markup common to all metanorma gems.
140
140
  The following markup is specific to this gem:
141
141
 
@@ -156,9 +156,9 @@
156
156
  <zeroOrMore>
157
157
  <ref name="contact"/>
158
158
  </zeroOrMore>
159
- <optional>
159
+ <zeroOrMore>
160
160
  <ref name="uri"/>
161
- </optional>
161
+ </zeroOrMore>
162
162
  </element>
163
163
  </define>
164
164
  <define name="fullname">
@@ -246,9 +246,9 @@
246
246
  <optional>
247
247
  <ref name="abbreviation"/>
248
248
  </optional>
249
- <optional>
249
+ <zeroOrMore>
250
250
  <ref name="uri"/>
251
- </optional>
251
+ </zeroOrMore>
252
252
  <zeroOrMore>
253
253
  <ref name="org-identifier"/>
254
254
  </zeroOrMore>
@@ -469,12 +469,13 @@
469
469
  <value>film</value>
470
470
  <value>video</value>
471
471
  <value>broadcast</value>
472
- <value>graphic work</value>
472
+ <value>graphic_work</value>
473
473
  <value>music</value>
474
474
  <value>patent</value>
475
475
  <value>inbook</value>
476
476
  <value>incollection</value>
477
477
  <value>inproceedings</value>
478
+ <value>journal</value>
478
479
  </choice>
479
480
  </define>
480
481
  <define name="BibliographicItem">
@@ -739,39 +740,44 @@
739
740
  <element name="series">
740
741
  <optional>
741
742
  <attribute name="type">
742
- <choice>
743
- <value>main</value>
744
- <value>alt</value>
745
- </choice>
743
+ <ref name="SeriesType"/>
746
744
  </attribute>
747
745
  </optional>
748
746
  <choice>
749
- <ref name="btitle"/>
750
747
  <ref name="formattedref"/>
748
+ <group>
749
+ <ref name="btitle"/>
750
+ <optional>
751
+ <ref name="bplace"/>
752
+ </optional>
753
+ <optional>
754
+ <ref name="seriesorganization"/>
755
+ </optional>
756
+ <optional>
757
+ <ref name="abbreviation"/>
758
+ </optional>
759
+ <optional>
760
+ <ref name="seriesfrom"/>
761
+ </optional>
762
+ <optional>
763
+ <ref name="seriesto"/>
764
+ </optional>
765
+ <optional>
766
+ <ref name="seriesnumber"/>
767
+ </optional>
768
+ <optional>
769
+ <ref name="seriespartnumber"/>
770
+ </optional>
771
+ </group>
751
772
  </choice>
752
- <optional>
753
- <ref name="bplace"/>
754
- </optional>
755
- <optional>
756
- <ref name="seriesorganization"/>
757
- </optional>
758
- <optional>
759
- <ref name="abbreviation"/>
760
- </optional>
761
- <optional>
762
- <ref name="seriesfrom"/>
763
- </optional>
764
- <optional>
765
- <ref name="seriesto"/>
766
- </optional>
767
- <optional>
768
- <ref name="seriesnumber"/>
769
- </optional>
770
- <optional>
771
- <ref name="seriespartnumber"/>
772
- </optional>
773
773
  </element>
774
774
  </define>
775
+ <define name="SeriesType">
776
+ <choice>
777
+ <value>main</value>
778
+ <value>alt</value>
779
+ </choice>
780
+ </define>
775
781
  <define name="seriesorganization">
776
782
  <element name="organization">
777
783
  <text/>
@@ -849,6 +855,7 @@
849
855
  <value>includes</value>
850
856
  <value>instance</value>
851
857
  <value>partOf</value>
858
+ <value>hasDraft</value>
852
859
  </choice>
853
860
  </attribute>
854
861
  <element name="bibitem">
@@ -861,9 +868,6 @@
861
868
  </define>
862
869
  <define name="version">
863
870
  <element name="version">
864
- <optional>
865
- <ref name="vedition"/>
866
- </optional>
867
871
  <optional>
868
872
  <ref name="revision-date"/>
869
873
  </optional>
@@ -90,7 +90,7 @@ module Asciidoctor
90
90
  result << "</acme-standard>"
91
91
  result = textcleanup(result)
92
92
  ret1 = cleanup(Nokogiri::XML(result))
93
- validate(ret1)
93
+ validate(ret1) unless @novalid
94
94
  ret1.root.add_namespace(nil, Metanorma::Acme::DOCUMENT_NAMESPACE)
95
95
  ret1
96
96
  end
@@ -18,6 +18,7 @@
18
18
  of this.
19
19
  -->
20
20
  <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
21
+ <include href="reqt.rng"/>
21
22
  <include href="biblio.rng">
22
23
  <define name="status">
23
24
  <element name="status">
@@ -0,0 +1,157 @@
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">
3
+ <!--
4
+ Presupposes isodoc.rnc, is included in it
5
+ include "isodoc.rnc" { }
6
+ -->
7
+ <define name="requirement">
8
+ <element name="requirement">
9
+ <ref name="RequirementType"/>
10
+ </element>
11
+ </define>
12
+ <define name="recommendation">
13
+ <element name="recommendation">
14
+ <ref name="RequirementType"/>
15
+ </element>
16
+ </define>
17
+ <define name="permission">
18
+ <element name="permission">
19
+ <ref name="RequirementType"/>
20
+ </element>
21
+ </define>
22
+ <define name="RequirementType">
23
+ <optional>
24
+ <attribute name="obligation">
25
+ <ref name="ObligationType"/>
26
+ </attribute>
27
+ </optional>
28
+ <attribute name="id">
29
+ <data type="ID"/>
30
+ </attribute>
31
+ <optional>
32
+ <attribute name="filename"/>
33
+ </optional>
34
+ <optional>
35
+ <ref name="reqtitle"/>
36
+ </optional>
37
+ <optional>
38
+ <ref name="label"/>
39
+ </optional>
40
+ <optional>
41
+ <ref name="subject"/>
42
+ </optional>
43
+ <optional>
44
+ <ref name="reqinherit"/>
45
+ </optional>
46
+ <zeroOrMore>
47
+ <ref name="classification"/>
48
+ </zeroOrMore>
49
+ <zeroOrMore>
50
+ <choice>
51
+ <ref name="measurementtarget"/>
52
+ <ref name="specification"/>
53
+ <ref name="verification"/>
54
+ <ref name="import"/>
55
+ <ref name="description"/>
56
+ </choice>
57
+ </zeroOrMore>
58
+ <optional>
59
+ <ref name="reqt_references"/>
60
+ </optional>
61
+ <zeroOrMore>
62
+ <choice>
63
+ <ref name="requirement"/>
64
+ <ref name="recommendation"/>
65
+ <ref name="permission"/>
66
+ </choice>
67
+ </zeroOrMore>
68
+ </define>
69
+ <define name="reqtitle">
70
+ <element name="title">
71
+ <ref name="FormattedString"/>
72
+ </element>
73
+ </define>
74
+ <define name="label">
75
+ <element name="label">
76
+ <text/>
77
+ </element>
78
+ </define>
79
+ <define name="subject">
80
+ <element name="subject">
81
+ <text/>
82
+ </element>
83
+ </define>
84
+ <define name="reqinherit">
85
+ <element name="subject">
86
+ <text/>
87
+ </element>
88
+ </define>
89
+ <define name="measurementtarget">
90
+ <element name="measurement-target">
91
+ <ref name="RequirementSubpart"/>
92
+ </element>
93
+ </define>
94
+ <define name="specification">
95
+ <element name="specification">
96
+ <ref name="RequirementSubpart"/>
97
+ </element>
98
+ </define>
99
+ <define name="verification">
100
+ <element name="verification">
101
+ <ref name="RequirementSubpart"/>
102
+ </element>
103
+ </define>
104
+ <define name="import">
105
+ <element name="import">
106
+ <ref name="RequirementSubpart"/>
107
+ </element>
108
+ </define>
109
+ <define name="description">
110
+ <element name="description">
111
+ <ref name="RequirementSubpart"/>
112
+ </element>
113
+ </define>
114
+ <define name="reqt_references">
115
+ <element name="references">
116
+ <oneOrMore>
117
+ <ref name="bibitem"/>
118
+ </oneOrMore>
119
+ </element>
120
+ </define>
121
+ <define name="RequirementSubpart">
122
+ <optional>
123
+ <attribute name="type"/>
124
+ </optional>
125
+ <optional>
126
+ <attribute name="exclude">
127
+ <data type="boolean"/>
128
+ </attribute>
129
+ </optional>
130
+ <oneOrMore>
131
+ <ref name="BasicBlock"/>
132
+ </oneOrMore>
133
+ </define>
134
+ <define name="ObligationType">
135
+ <choice>
136
+ <value>requirement</value>
137
+ <value>recommendation</value>
138
+ <value>permission</value>
139
+ </choice>
140
+ </define>
141
+ <define name="classification">
142
+ <element name="classification">
143
+ <ref name="classification_tag"/>
144
+ <ref name="classification_value"/>
145
+ </element>
146
+ </define>
147
+ <define name="classification_tag">
148
+ <element name="tag">
149
+ <text/>
150
+ </element>
151
+ </define>
152
+ <define name="classification_value">
153
+ <element name="value">
154
+ <text/>
155
+ </element>
156
+ </define>
157
+ </grammar>
@@ -1,5 +1,5 @@
1
1
  module Metanorma
2
2
  module Acme
3
- VERSION = "1.1.2"
3
+ VERSION = "1.1.3"
4
4
  end
5
5
  end
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
15
15
  This gem is meant to be customised for any downstream use.
16
16
  DESCRIPTION
17
17
 
18
- spec.homepage = "https://github.com/riboseinc/metanorma-acme"
18
+ spec.homepage = "https://github.com/metanorma/metanorma-acme"
19
19
  spec.license = "BSD-2-Clause"
20
20
 
21
21
  spec.files = `git ls-files -z`.split("\x0").reject do |f|
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: metanorma-acme
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.2
4
+ version: 1.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ribose Inc.
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2019-02-25 00:00:00.000000000 Z
11
+ date: 2019-03-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: asciidoctor
@@ -278,6 +278,7 @@ files:
278
278
  - lib/asciidoctor/acme/converter.rb
279
279
  - lib/asciidoctor/acme/isodoc.rng
280
280
  - lib/asciidoctor/acme/isostandard.rng
281
+ - lib/asciidoctor/acme/reqt.rng
281
282
  - lib/isodoc/acme.rb
282
283
  - lib/isodoc/acme/html/acme.scss
283
284
  - lib/isodoc/acme/html/header.html
@@ -299,7 +300,7 @@ files:
299
300
  - lib/metanorma/acme/processor.rb
300
301
  - lib/metanorma/acme/version.rb
301
302
  - metanorma-acme.gemspec
302
- homepage: https://github.com/riboseinc/metanorma-acme
303
+ homepage: https://github.com/metanorma/metanorma-acme
303
304
  licenses:
304
305
  - BSD-2-Clause
305
306
  metadata: {}