metanorma-cli 1.4.18pre → 1.5.1pre

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.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/README.adoc +1 -1
  3. data/docs/usage.adoc +61 -26
  4. data/lib/metanorma/cli/site_generator.rb +1 -0
  5. data/lib/metanorma/cli/version.rb +1 -1
  6. data/metanorma-cli.gemspec +14 -14
  7. metadata +31 -31
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8eb864d5612a326a357c52312047e5d12023b80e3005d766d54778aa5f5cd5aa
4
- data.tar.gz: c3c856e48c5277c6d7e624cc48c0a2907a2093b836424a1d2eebff97e7daab0e
3
+ metadata.gz: 10cc309ff314ca31ff04136b7b9e2a981d781fd60896ccc66761ee8dc06cfb45
4
+ data.tar.gz: a9d4cebc65c9262a26be6e560ffd9b63e52ae28b7b341cf60ddd476c7cc272e9
5
5
  SHA512:
6
- metadata.gz: 37b4a2ecb0b582d28d0330dc0c3011fda684806aaa8b2bb7685a00540c40dba7f76708aea75d1706bdf58738e46f8cf1a73138fcaad38e83966f73dc70e4b2ad
7
- data.tar.gz: 7c37e6be7c420fe45f70fdcd3028d2595cc11145dea5a82c1035fdb09a4c07789c42add84db5821436a3dfffdecd4aa59d94587a234cf7c756af717fd6079c34
6
+ metadata.gz: e7bd2b661690fff1255bb8de6986d1285427a4197d50aca722c5ae09a8a716c6226f67ad6714fbd04f9d35dfa518faaf89caafb3e3b8307fecc03e8a7c1d2f6a
7
+ data.tar.gz: 2126cb2901a0aafc877e532cdf8d499a571b43981e83a220e783622fac450368d1b2a793b417d6ad3ef9290b71a08bcc5b1eec4cfeefa74b01b7759bf405abb5
data/README.adoc CHANGED
@@ -25,7 +25,7 @@ gem install metanorma-cli
25
25
  This will install the `metanorma` executable, which you can use with all
26
26
  officially supported Metanorma flavors (such as ISO, CalConnect, IETF, etc).
27
27
 
28
- However, a number of dependencies (such as Puppeteer and LaTeXML) are not
28
+ However, a number of <<external-dependencies,dependencies>> are not
29
29
  installed with this gem, and have to be installed separately.
30
30
  The process of installing the full suite can be a little more complex.
31
31
 
data/docs/usage.adoc CHANGED
@@ -1,21 +1,75 @@
1
1
  = Using the Metanorma CLI
2
2
 
3
- == Usage sample
3
+ == Usage samples
4
+
5
+ For a single document:
6
+ [source,sh]
7
+ ----
8
+ $ metanorma iso-my-standard-document.adoc
9
+ ----
10
+
11
+ or
4
12
 
5
13
  [source,sh]
6
14
  ----
7
15
  $ metanorma --type iso -x html iso-my-standard-document.adoc
8
16
  ----
9
17
 
18
+ if type and extensions are not defined in adoc header
19
+
10
20
  == Full syntax & options
11
21
 
22
+ General help message can be shown by `metanorma help`
23
+
12
24
  [source,sh]
13
25
  ----
14
- $ metanorma --type <chosen-type> \
15
- [--format input-format] \
16
- [--extensions EXT1,EXT2...] \
17
- iso-my-standard-document.adoc
26
+ Commands:
27
+ metanorma collection FILENAME -w, --output-folder=OUTPUT_FOLDER # Render HTML pages from XML/YAML colection
28
+ metanorma compile FILENAME # Compile to a metanorma document
29
+ metanorma config # Manage configuration file
30
+ metanorma help [COMMAND] # Describe available commands or one specific command
31
+ metanorma list-doctypes # List supported doctypes
32
+ metanorma list-extensions # List supported extensions
33
+ metanorma new NAME -d, --doctype=DOCTYPE -t, --type=TYPE # Create new Metanorma document
34
+ metanorma site # Manage site for metanorma collections
35
+ metanorma template-repo # Manage metanorma templates repository
36
+ metanorma version # Version of the code
37
+
38
+ Options:
39
+ -s, [--no-progress], [--no-no-progress] # Don't show progress for long running tasks (like download)
40
+ # Default: true
41
+ ----
42
+
43
+ Also you can get a help message for a specific command for example `metanorma help compile`:
44
+
45
+ [source,sh]
18
46
  ----
47
+ Usage:
48
+ metanorma compile FILENAME
49
+
50
+ Options:
51
+ -t, [--type=TYPE] # Type of standard to generate
52
+ -x, [--extensions=EXTENSIONS] # Type of extension to generate per type
53
+ -f, [--format=FORMAT] # Format of source file: eg. asciidoc
54
+ # Default: asciidoc
55
+ -r, [--require=REQUIRE] # Require LIBRARY prior to execution
56
+ -w, [--wrapper], [--no-wrapper] # Create wrapper folder for HTML output
57
+ -a, [--asciimath], [--no-asciimath] # Keep Asciimath in XML output instead of converting it to MathM
58
+ -d, [--datauriimage], [--no-datauriimage] # Encode HTML output images as data URIs
59
+ -R, [--relaton=RELATON] # Export Relaton XML for document to nominated filename
60
+ -e, [--extract=EXTRACT] # Export sourcecode fragments from this document to nominated directory
61
+ -v, [--version=VERSION] # Print version of code (accompanied with -t)
62
+ -o, [--output-dir=OUTPUT_DIR] # Directory to save compiled files
63
+ [--agree-to-terms], [--no-agree-to-terms] # Agree / Disagree with all third-party licensing terms presented (WARNING: do know what you are agreeing with!)
64
+ [--no-install-fonts], [--no-no-install-fonts] # Skip the font installation process
65
+ [--continue-without-fonts], [--no-continue-without-fonts] # Continue processing even when fonts are missing
66
+ -s, [--no-progress], [--no-no-progress] # Don't show progress for long running tasks (like download)
67
+ # Default: true
68
+
69
+ Compile to a metanorma document
70
+ ----
71
+
72
+ A bit more details on options:
19
73
 
20
74
  `type`:: (mandatory, specified via `--type` or `-t`) takes one of the following types:
21
75
  `rfc2`, `rfc3`, `iso`, `gb`, `csd`, `csand`, `m3d`, `rsd`. Each of these corresponds to a
@@ -28,6 +82,8 @@ what has been defined for each standard type. All standards can generate Metanor
28
82
  and at least one of HTML (`html`), DOC (`doc`), PDF (`pdf`). Some standards generate alternative
29
83
  HTML renderings (e.g. `html_alt` for ISO).
30
84
 
85
+ Actual list of supported `types` and `extension`s you can get with `metanorma list-doctypes`
86
+
31
87
  `wrapper`:: create a separate folder for each instance of HTML output generated; the folder is named
32
88
  the same as the output file, without the `.html` suffix. Used to make distribution of HTML outputs
33
89
  more straightforward.
@@ -47,24 +103,3 @@ $ metanorma -t mpfd mpfd-bpn.adoc
47
103
  $ metanorma -t mpfd -r metanorma-mpfd mpfd-bpn.adoc
48
104
  ----
49
105
 
50
- == Command-line help
51
-
52
- [source,sh]
53
- ----
54
- $ metanorma help
55
- Commands:
56
- metanorma collection FILENAME -w, --output-folder=OUTPUT_FOLDER # Render HTML pages from XML/YAML colection
57
- metanorma compile FILENAME # Compile to a metanorma document
58
- metanorma config # Manage configuration file
59
- metanorma help [COMMAND] # Describe available commands or one specific command
60
- metanorma list-doctypes # List supported doctypes
61
- metanorma list-extensions # List supported extensions
62
- metanorma new NAME -d, --doctype=DOCTYPE -t, --type=TYPE # Create new Metanorma document
63
- metanorma site # Manage site for metanorma collections
64
- metanorma template-repo # Manage metanorma templates repository
65
- metanorma version # Version of the code
66
-
67
- Options:
68
- -s, [--no-progress], [--no-no-progress] # Don't show progress for long running tasks (like download)
69
- # Default: true
70
- ----
data/lib/metanorma/cli/site_generator.rb CHANGED
@@ -78,6 +78,7 @@ module Metanorma
78
78
  format: :asciidoc, output_dir: build_asset_output_directory(source)
79
79
  )
80
80
 
81
+ options[:baseassetpath] = Pathname.new(source.to_s).dirname.to_s
81
82
  Metanorma::Cli::Compiler.compile(source.to_s, options)
82
83
  end
83
84
 
data/lib/metanorma/cli/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Metanorma
2
2
  module Cli
3
- VERSION = "1.4.18pre".freeze
3
+ VERSION = "1.5.1pre".freeze
4
4
  end
5
5
  end
data/metanorma-cli.gemspec CHANGED
@@ -36,27 +36,27 @@ Gem::Specification.new do |spec|
36
36
  spec.add_development_dependency "rubocop", "~> 1.5.2"
37
37
  spec.add_development_dependency "sassc"
38
38
 
39
- spec.add_runtime_dependency "metanorma-ietf", "~> 2.4.0"
40
- spec.add_runtime_dependency "metanorma-iso", "~> 1.9.0"
39
+ spec.add_runtime_dependency "metanorma-ietf", "~> 2.5.0"
40
+ spec.add_runtime_dependency "metanorma-iso", "~> 1.10.0"
41
41
  spec.add_runtime_dependency "thor", "~> 1.0"
42
42
  # spec.add_runtime_dependency "metanorma-gb", "~> 1.5.0"
43
- spec.add_runtime_dependency "metanorma-cc", "~> 1.7.0"
44
- spec.add_runtime_dependency "metanorma-csa", "~> 1.8.0"
45
- spec.add_runtime_dependency "metanorma-iec", "~> 1.3.0"
43
+ spec.add_runtime_dependency "metanorma-cc", "~> 1.8.0"
44
+ spec.add_runtime_dependency "metanorma-csa", "~> 1.9.0"
45
+ spec.add_runtime_dependency "metanorma-iec", "~> 1.4.0"
46
46
  # spec.add_runtime_dependency 'metanorma-ribose', "~> 1.6.0"
47
- spec.add_runtime_dependency "metanorma-bipm", "~> 1.1.5"
48
- spec.add_runtime_dependency "metanorma-generic", "~> 1.10.2"
49
- spec.add_runtime_dependency "metanorma-m3aawg", "~> 1.7.0"
50
- spec.add_runtime_dependency "metanorma-standoc", "~> 1.10.0"
47
+ spec.add_runtime_dependency "metanorma-bipm", "~> 1.2.0"
48
+ spec.add_runtime_dependency "metanorma-generic", "~> 1.11.0"
49
+ spec.add_runtime_dependency "metanorma-m3aawg", "~> 1.8.0"
50
+ spec.add_runtime_dependency "metanorma-standoc", "~> 1.11.0"
51
51
  # spec.add_runtime_dependency 'metanorma-mpfa', "~> 0.5.0"
52
52
  spec.add_runtime_dependency "git", "~> 1.5"
53
53
  spec.add_runtime_dependency "isodoc", ">= 1.7.0"
54
- spec.add_runtime_dependency "metanorma", "~> 1.3.0"
55
- spec.add_runtime_dependency "metanorma-iho", "~> 0.3.0"
56
- spec.add_runtime_dependency "metanorma-itu", "~> 1.3.0"
54
+ spec.add_runtime_dependency "metanorma", "~> 1.4.0"
55
+ spec.add_runtime_dependency "metanorma-iho", "~> 0.4.0"
56
+ spec.add_runtime_dependency "metanorma-itu", "~> 1.4.0"
57
57
  # spec.add_runtime_dependency "metanorma-nist", "~> 1.3.0"
58
- spec.add_runtime_dependency "metanorma-ogc", "~> 1.4.0"
59
- spec.add_runtime_dependency "metanorma-un", "~> 0.6.0"
58
+ spec.add_runtime_dependency "metanorma-ogc", "~> 1.5.0"
59
+ spec.add_runtime_dependency "metanorma-un", "~> 0.7.0"
60
60
  spec.add_runtime_dependency "relaton-cli", ">= 0.8.2"
61
61
 
62
62
  spec.add_runtime_dependency "socksify"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: metanorma-cli
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.18pre
4
+ version: 1.5.1pre
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ribose Inc.
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-10-11 00:00:00.000000000 Z
11
+ date: 2021-11-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: byebug
@@ -170,28 +170,28 @@ dependencies:
170
170
  requirements:
171
171
  - - "~>"
172
172
  - !ruby/object:Gem::Version
173
- version: 2.4.0
173
+ version: 2.5.0
174
174
  type: :runtime
175
175
  prerelease: false
176
176
  version_requirements: !ruby/object:Gem::Requirement
177
177
  requirements:
178
178
  - - "~>"
179
179
  - !ruby/object:Gem::Version
180
- version: 2.4.0
180
+ version: 2.5.0
181
181
  - !ruby/object:Gem::Dependency
182
182
  name: metanorma-iso
183
183
  requirement: !ruby/object:Gem::Requirement
184
184
  requirements:
185
185
  - - "~>"
186
186
  - !ruby/object:Gem::Version
187
- version: 1.9.0
187
+ version: 1.10.0
188
188
  type: :runtime
189
189
  prerelease: false
190
190
  version_requirements: !ruby/object:Gem::Requirement
191
191
  requirements:
192
192
  - - "~>"
193
193
  - !ruby/object:Gem::Version
194
- version: 1.9.0
194
+ version: 1.10.0
195
195
  - !ruby/object:Gem::Dependency
196
196
  name: thor
197
197
  requirement: !ruby/object:Gem::Requirement
@@ -212,98 +212,98 @@ dependencies:
212
212
  requirements:
213
213
  - - "~>"
214
214
  - !ruby/object:Gem::Version
215
- version: 1.7.0
215
+ version: 1.8.0
216
216
  type: :runtime
217
217
  prerelease: false
218
218
  version_requirements: !ruby/object:Gem::Requirement
219
219
  requirements:
220
220
  - - "~>"
221
221
  - !ruby/object:Gem::Version
222
- version: 1.7.0
222
+ version: 1.8.0
223
223
  - !ruby/object:Gem::Dependency
224
224
  name: metanorma-csa
225
225
  requirement: !ruby/object:Gem::Requirement
226
226
  requirements:
227
227
  - - "~>"
228
228
  - !ruby/object:Gem::Version
229
- version: 1.8.0
229
+ version: 1.9.0
230
230
  type: :runtime
231
231
  prerelease: false
232
232
  version_requirements: !ruby/object:Gem::Requirement
233
233
  requirements:
234
234
  - - "~>"
235
235
  - !ruby/object:Gem::Version
236
- version: 1.8.0
236
+ version: 1.9.0
237
237
  - !ruby/object:Gem::Dependency
238
238
  name: metanorma-iec
239
239
  requirement: !ruby/object:Gem::Requirement
240
240
  requirements:
241
241
  - - "~>"
242
242
  - !ruby/object:Gem::Version
243
- version: 1.3.0
243
+ version: 1.4.0
244
244
  type: :runtime
245
245
  prerelease: false
246
246
  version_requirements: !ruby/object:Gem::Requirement
247
247
  requirements:
248
248
  - - "~>"
249
249
  - !ruby/object:Gem::Version
250
- version: 1.3.0
250
+ version: 1.4.0
251
251
  - !ruby/object:Gem::Dependency
252
252
  name: metanorma-bipm
253
253
  requirement: !ruby/object:Gem::Requirement
254
254
  requirements:
255
255
  - - "~>"
256
256
  - !ruby/object:Gem::Version
257
- version: 1.1.5
257
+ version: 1.2.0
258
258
  type: :runtime
259
259
  prerelease: false
260
260
  version_requirements: !ruby/object:Gem::Requirement
261
261
  requirements:
262
262
  - - "~>"
263
263
  - !ruby/object:Gem::Version
264
- version: 1.1.5
264
+ version: 1.2.0
265
265
  - !ruby/object:Gem::Dependency
266
266
  name: metanorma-generic
267
267
  requirement: !ruby/object:Gem::Requirement
268
268
  requirements:
269
269
  - - "~>"
270
270
  - !ruby/object:Gem::Version
271
- version: 1.10.2
271
+ version: 1.11.0
272
272
  type: :runtime
273
273
  prerelease: false
274
274
  version_requirements: !ruby/object:Gem::Requirement
275
275
  requirements:
276
276
  - - "~>"
277
277
  - !ruby/object:Gem::Version
278
- version: 1.10.2
278
+ version: 1.11.0
279
279
  - !ruby/object:Gem::Dependency
280
280
  name: metanorma-m3aawg
281
281
  requirement: !ruby/object:Gem::Requirement
282
282
  requirements:
283
283
  - - "~>"
284
284
  - !ruby/object:Gem::Version
285
- version: 1.7.0
285
+ version: 1.8.0
286
286
  type: :runtime
287
287
  prerelease: false
288
288
  version_requirements: !ruby/object:Gem::Requirement
289
289
  requirements:
290
290
  - - "~>"
291
291
  - !ruby/object:Gem::Version
292
- version: 1.7.0
292
+ version: 1.8.0
293
293
  - !ruby/object:Gem::Dependency
294
294
  name: metanorma-standoc
295
295
  requirement: !ruby/object:Gem::Requirement
296
296
  requirements:
297
297
  - - "~>"
298
298
  - !ruby/object:Gem::Version
299
- version: 1.10.0
299
+ version: 1.11.0
300
300
  type: :runtime
301
301
  prerelease: false
302
302
  version_requirements: !ruby/object:Gem::Requirement
303
303
  requirements:
304
304
  - - "~>"
305
305
  - !ruby/object:Gem::Version
306
- version: 1.10.0
306
+ version: 1.11.0
307
307
  - !ruby/object:Gem::Dependency
308
308
  name: git
309
309
  requirement: !ruby/object:Gem::Requirement
@@ -338,70 +338,70 @@ dependencies:
338
338
  requirements:
339
339
  - - "~>"
340
340
  - !ruby/object:Gem::Version
341
- version: 1.3.0
341
+ version: 1.4.0
342
342
  type: :runtime
343
343
  prerelease: false
344
344
  version_requirements: !ruby/object:Gem::Requirement
345
345
  requirements:
346
346
  - - "~>"
347
347
  - !ruby/object:Gem::Version
348
- version: 1.3.0
348
+ version: 1.4.0
349
349
  - !ruby/object:Gem::Dependency
350
350
  name: metanorma-iho
351
351
  requirement: !ruby/object:Gem::Requirement
352
352
  requirements:
353
353
  - - "~>"
354
354
  - !ruby/object:Gem::Version
355
- version: 0.3.0
355
+ version: 0.4.0
356
356
  type: :runtime
357
357
  prerelease: false
358
358
  version_requirements: !ruby/object:Gem::Requirement
359
359
  requirements:
360
360
  - - "~>"
361
361
  - !ruby/object:Gem::Version
362
- version: 0.3.0
362
+ version: 0.4.0
363
363
  - !ruby/object:Gem::Dependency
364
364
  name: metanorma-itu
365
365
  requirement: !ruby/object:Gem::Requirement
366
366
  requirements:
367
367
  - - "~>"
368
368
  - !ruby/object:Gem::Version
369
- version: 1.3.0
369
+ version: 1.4.0
370
370
  type: :runtime
371
371
  prerelease: false
372
372
  version_requirements: !ruby/object:Gem::Requirement
373
373
  requirements:
374
374
  - - "~>"
375
375
  - !ruby/object:Gem::Version
376
- version: 1.3.0
376
+ version: 1.4.0
377
377
  - !ruby/object:Gem::Dependency
378
378
  name: metanorma-ogc
379
379
  requirement: !ruby/object:Gem::Requirement
380
380
  requirements:
381
381
  - - "~>"
382
382
  - !ruby/object:Gem::Version
383
- version: 1.4.0
383
+ version: 1.5.0
384
384
  type: :runtime
385
385
  prerelease: false
386
386
  version_requirements: !ruby/object:Gem::Requirement
387
387
  requirements:
388
388
  - - "~>"
389
389
  - !ruby/object:Gem::Version
390
- version: 1.4.0
390
+ version: 1.5.0
391
391
  - !ruby/object:Gem::Dependency
392
392
  name: metanorma-un
393
393
  requirement: !ruby/object:Gem::Requirement
394
394
  requirements:
395
395
  - - "~>"
396
396
  - !ruby/object:Gem::Version
397
- version: 0.6.0
397
+ version: 0.7.0
398
398
  type: :runtime
399
399
  prerelease: false
400
400
  version_requirements: !ruby/object:Gem::Requirement
401
401
  requirements:
402
402
  - - "~>"
403
403
  - !ruby/object:Gem::Version
404
- version: 0.6.0
404
+ version: 0.7.0
405
405
  - !ruby/object:Gem::Dependency
406
406
  name: relaton-cli
407
407
  requirement: !ruby/object:Gem::Requirement
@@ -513,7 +513,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
513
513
  - !ruby/object:Gem::Version
514
514
  version: 1.3.1
515
515
  requirements: []
516
- rubygems_version: 3.1.4
516
+ rubygems_version: 3.2.22
517
517
  signing_key:
518
518
  specification_version: 4
519
519
  summary: Metanorma is the standard of standards; the metanorma gem allows you to create