metanorma-m3d 1.0.9 → 1.0.10

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: e56ff0f758437606bfe1cd38596fa6d53e827e00b1c1c74d9b394a897a0709da
4
- data.tar.gz: 75b1c8474c4031c75ee5c85539c285e5cb291bd7122f55b45aa3cb8eb272087c
3
+ metadata.gz: eea55d65f6aa596e1a3dc63aec7f0096a50d4992e8fba2837885e8dd08d1c572
4
+ data.tar.gz: 9cc10f954832573d6ccb424d5223319d5faf1f1e01e807b2125c46eebb6a75f7
5
5
  SHA512:
6
- metadata.gz: 7d9d0fb6708b39019c1688f1db57607b15e26eb30ddc61c3721983cb4c2b48f5e034b56447d123ce48bbec4c4320baa7820c8dd018dec81faa6350c62c08b14a
7
- data.tar.gz: 758cd891a9273629b2b681791ab6a41e0bd54bf35b1784ee2b31395c297ff0150cbe97e7b74f2ff64316c9e501b6462413b9b67c7e16ea5a15a1e47786479460
6
+ metadata.gz: aa0dfeaf79115cec35344aec9cd3ce72e6391cf2ad83a1301e5186b5feb8766b76202bf2587190f5c7c65f08dee7ef9eaf089678f494870863c0349d6c704f0c
7
+ data.tar.gz: fb1ad009eb9102b5c8ea2f90000e43b3b7849396a64652da45728640b60face4baeae887a022cbefbccf1df17883211cf97b9ae891d1bcccfb0fb162c5578711
data/README.adoc CHANGED
@@ -99,19 +99,17 @@ DocBook document authoring tool). Asciidoctor has built-in capability to output
99
99
  Text, DocBook and HTML; so it can be used to preview the file as it is being
100
100
  authored.
101
101
 
102
- Note that in order to generate HTML preview output close to what is intended
103
- in the M3D standard, the Asciidoc
104
- document includes a fair amount of formatting instructions (e.g. disabling
105
- section numbering where appropriate, the titling of Appendixes as Annexes), as
106
- well as M3D boilerplate text, and predefined section headers (sections are
107
- recognised by fixed titles such as `Normative References`). Authoring M3D
108
- standards in this fashion assumes that users will be populating an Asciidoc
109
- template, and not removing needed formatting instructions.
102
+ Generating documents via a document model substantially automated formatting
103
+ associated with the document, including automating numbering of headings, figures,
104
+ tables etc, and automatically generating references and citations.
110
105
 
111
106
  == Document Attributes
112
107
 
108
+ === Common attributes
109
+
113
110
  The gem relies on Asciidoctor document attributes to provide necessary
114
- metadata about the document. These include:
111
+ metadata about the document. The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
112
+ gem documents the Asciidoctor document attributes common to all metanorma gems. These include:
115
113
 
116
114
  `:edition:`:: The document edition
117
115
 
@@ -147,7 +145,11 @@ report:: report
147
145
  The attribute `:draft:`, if present, includes review notes in the XML output;
148
146
  these are otherwise suppressed.
149
147
 
150
- == AsciiM3D features not also present in AsciiISO
148
+ == Asciidoctor features specific to CSAND
149
+
150
+ The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
151
+ gem documents the customisations of Asciidoctor markup common to all metanorma gems.
152
+ The following markup is specific to this gem:
151
153
 
152
154
  * `+[keyword]#...#+`: encodes keywords, such as "MUST", "MUST NOT". (Encoded as
153
155
  `<span class="keyword">...</span>`.
@@ -744,6 +744,9 @@
744
744
  </define>
745
745
  <define name="preface">
746
746
  <element name="preface">
747
+ <optional>
748
+ <ref name="preface_abstract"/>
749
+ </optional>
747
750
  <ref name="foreword"/>
748
751
  <optional>
749
752
  <ref name="introduction"/>
@@ -811,6 +814,11 @@
811
814
  </optional>
812
815
  </element>
813
816
  </define>
817
+ <define name="preface_abstract">
818
+ <element name="abstract">
819
+ <ref name="Basic-Section"/>
820
+ </element>
821
+ </define>
814
822
  <define name="foreword">
815
823
  <element name="foreword">
816
824
  <ref name="Basic-Section"/>
@@ -51,10 +51,10 @@
51
51
  </div>
52
52
 
53
53
  <div class="coverpage-stage-block" >
54
- <span class="coverpage-maturity" id="{{ status | replace: ' ', '-' | downcase }}">{{ status }}</span>
54
+ <span class="coverpage-maturity" id="{{ status | replace: ' ', '-' | downcase }}">{% if unpublished %}{{ status }}{% endif %}</span>
55
55
  </div>
56
56
 
57
- {% if status != "Published" and status != "Withdrawn" %}
57
+ {% if unpublished %}
58
58
  <div class="coverpage-warning">
59
59
  <span class="title">Warning for Drafts</span>
60
60
 
@@ -22,12 +22,13 @@ margin-left:4.25pt;margin-right:4.25pt'>
22
22
 
23
23
  <p class="MsoNormal" align="center" style='text-align:center;border:none;
24
24
  mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:1.0pt 4.0pt 1.0pt 4.0pt'><span
25
- lang="EN-GB" style='font-size:40.0pt'>{{ stageabbr }} stage<o:p></o:p></span></p>
25
+ lang="EN-GB" style='font-size:40.0pt'>{% if unpublished %}{{ status }}{% endif %}<o:p></o:p></span></p>
26
26
 
27
27
  </div>
28
28
 
29
29
  <p class="MsoNormal" style='margin-bottom:6.0pt'><span lang="EN-GB"><o:p>&nbsp;</o:p></span></p>
30
30
 
31
+ {% if unpublished %}
31
32
  <div style='mso-element:para-border-div;border:solid windowtext 1.0pt;
32
33
  mso-border-alt:solid windowtext .5pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
33
34
  margin-left:4.25pt;margin-right:4.25pt'>
@@ -35,24 +36,18 @@ margin-left:4.25pt;margin-right:4.25pt'>
35
36
  <p class="MsoNormal" align="center" style='margin-bottom:6.0pt;text-align:center;
36
37
  border:none;mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:
37
38
  1.0pt 4.0pt 1.0pt 4.0pt'><b style='mso-bidi-font-weight:normal'><span
38
- lang="EN-GB" style='font-size:10.0pt;mso-bidi-font-size:11.0pt'>Warning for WDs
39
- and CDs<o:p></o:p></span></b></p>
39
+ lang="EN-GB" style='font-size:10.0pt;mso-bidi-font-size:11.0pt'>Warning for Drafts<o:p></o:p></span></b></p>
40
40
 
41
41
  <p class="MsoNormal" style='margin-bottom:6.0pt;border:none;mso-border-alt:solid windowtext .5pt;
42
42
  padding:0cm;mso-padding-alt:1.0pt 4.0pt 1.0pt 4.0pt'><span lang="EN-GB"
43
- style='font-size:10.0pt;mso-bidi-font-size:11.0pt;mso-bidi-font-weight:bold'>This
44
- document is not an ISO International Standard. It is distributed for review and
45
- comment. It is subject to change without notice and may not be referred to as
46
- an International Standard.<o:p></o:p></span></p>
47
-
48
- <p class="MsoNormal" style='border:none;mso-border-alt:solid windowtext .5pt;
49
- padding:0cm;mso-padding-alt:1.0pt 4.0pt 1.0pt 4.0pt'><span lang="EN-GB"
50
- style='font-size:10.0pt;mso-bidi-font-size:11.0pt;mso-bidi-font-weight:bold'>Recipients
51
- of this draft are invited to submit, with their comments, notification of any
52
- relevant patent rights of which they are aware and to provide supporting
53
- documentation.</span><span lang="EN-GB" style='font-size:10.0pt;mso-bidi-font-size:
54
- 11.0pt'><o:p></o:p></span></p>
43
+ style='font-size:10.0pt;mso-bidi-font-size:11.0pt;mso-bidi-font-weight:bold'>This document is not an M3AAWG Standard. It is distributed for review and
44
+ comment, and is subject to change without notice and may not be referred to as
45
+ a Standard. Recipients of this draft are invited to submit, with their
46
+ comments, notification of any relevant patent rights of which they are aware
47
+ and to provide supporting documentation.
48
+ <o:p></o:p></span></p>
55
49
 
56
50
  </div>
51
+ {% endif %}
57
52
 
58
53
 
@@ -84,11 +84,6 @@ module IsoDoc
84
84
  def html_toc(docxml)
85
85
  docxml
86
86
  end
87
-
88
- def info(isoxml, out)
89
- @meta.url isoxml, out
90
- super
91
- end
92
87
  end
93
88
  end
94
89
  end
@@ -84,11 +84,6 @@ module IsoDoc
84
84
  def html_toc(docxml)
85
85
  docxml
86
86
  end
87
-
88
- def info(isoxml, out)
89
- @meta.url isoxml, out
90
- super
91
- end
92
87
  end
93
88
  end
94
89
  end
@@ -60,11 +60,6 @@ module IsoDoc
60
60
  main = isoxml&.at(ns("//title[@language='en']"))&.text
61
61
  set_metadata(:doctitle, main)
62
62
  end
63
-
64
- def info(isoxml, out)
65
- @meta.url isoxml, out
66
- super
67
- end
68
63
  end
69
64
  end
70
65
  end
@@ -40,6 +40,10 @@ module IsoDoc
40
40
  end
41
41
  end
42
42
 
43
+ def unpublished(status)
44
+ %w(published withdrawn).include? status.downcase
45
+ end
46
+
43
47
  def version(isoxml, _out)
44
48
  super
45
49
  revdate = get[:revdate]
@@ -66,11 +70,6 @@ module IsoDoc
66
70
  return isodate unless m && m[:yr] && m[:mo]
67
71
  return "#{MONTHS[m[:mo].to_sym]} #{m[:yr]}"
68
72
  end
69
-
70
- def url(isoxml, _out)
71
- url = isoxml.at(ns("//bibdata/source"))
72
- set(:url, url.text) if url
73
- end
74
73
  end
75
74
  end
76
75
  end
@@ -1,5 +1,5 @@
1
1
  module Metanorma
2
2
  module M3d
3
- VERSION = "1.0.9"
3
+ VERSION = "1.0.10"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: metanorma-m3d
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.9
4
+ version: 1.0.10
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ribose Inc.
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-11-19 00:00:00.000000000 Z
11
+ date: 2018-11-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: asciidoctor