relaton-cli 1.17.0 → 1.17.2
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/docs/README.adoc +63 -58
- data/lib/relaton/cli/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 445fd87d8d97ab7a1f44c2115c40a08d5cad417630b90e2f8ea52d9795b6334a
|
|
4
|
+
data.tar.gz: 213a439433f9074b1f04af53ed2ead9f063cdd8712920255e339a9377e48d9c8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dd47e551bccc5491afd37d5e42ed318f466ee1339b2e6168b845b0e2967707f80c5c827149ce83c23fc273d0196096a4a220c1ddf9af0468abf127f5b679aa46
|
|
7
|
+
data.tar.gz: 2c61f70713c27f724792df2f9a52341e3ba0dae544c4e854aecac0084fe852ce5382f6dfd956fc3c4cca3daa6fe954ce3c3960a3db86fff99cee0c768ba3c227
|
data/docs/README.adoc
CHANGED
|
@@ -49,7 +49,7 @@ Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
|
|
|
49
49
|
|
|
50
50
|
* `YEAR` is optional and specifies the year of publication of the standard.
|
|
51
51
|
* `FORMAT` is optional, and specifies the output format; the recognized values for `FORMAT` are `xml` (default), yaml, `bibtex`.
|
|
52
|
-
* `TYPE` is optional and specifies the standards class library to be used, that the identifier is part of. The recognized values for `TYPE` are `3GPP
|
|
52
|
+
* `TYPE` is optional and specifies the standards class library to be used, that the identifier is part of. The recognized values for `TYPE` are: `3GPP`, `BIPM`, `CCTF`, `CCDS`, `CGPM`, `CIPM`, `JCRB`, `JCGM`, `BSI`, `BS`, `PD`, `CC`, `CCSDS`, `CEN`, `EN`, `ENV`, `CWA`, `HD`, `CR`, `CIE`, `DOI`, `ECMA`, `ETSI`, `CN`, `GB`, `GB/T`, `GB/Z`, `IANA`, `IEC`, `CISPR`, `IEV`, `IEEE`, `ANSI`, `NACE`, `AIEE`, `ASA`, `IRE`, `IETF`, `RFC`, `BCP`, `FYI`, `STD`, `I-D`, `IHO`, `ISBN`, `ISO`, `ISO/IEC`, `ITU`, `JIS`, `TR`, `NIST`, `NBS`, `NISTGCR`, `ITL Bulletin`, `JPCRD`, `NISTIR`, `CSRC`, `FIPS`, `OASIS`, `OGC`, `OMG`, `UN`, `W3C`, `XEP`.
|
|
53
53
|
* `RETRIES` is optional, number of network retries (default 1).
|
|
54
54
|
* `--all-parts` fetch all parts.
|
|
55
55
|
* `--keep-year` undated reference should return an actual reference with year.
|
|
@@ -85,11 +85,12 @@ The following datasets are available:
|
|
|
85
85
|
* `ecma-standards` - https://www.ecma-international.org/publications/standards/
|
|
86
86
|
* `itu-r` - https://extranet.itu.int/brdocsearch
|
|
87
87
|
* `ccsds` - https://public.ccsds.org/Publications/AllPubs.aspx
|
|
88
|
+
* `etsi-csv` - https://www.etsi.org/
|
|
88
89
|
|
|
89
90
|
Options:
|
|
90
91
|
|
|
91
|
-
* `DIR` -
|
|
92
|
-
* `FORMAT` - format in which the documents are saved.
|
|
92
|
+
* `DIR` - folder name to store documents (default `./data`).
|
|
93
|
+
* `FORMAT` - format in which the documents are saved. Possible formats are: `yaml`, `xml`, `bibxml` (default `yaml`).
|
|
93
94
|
|
|
94
95
|
=== relaton extract
|
|
95
96
|
|
|
@@ -261,38 +262,42 @@ Convert a Relaton XML document into YAML, AsciiBib, or BibTex format. Allowed -f
|
|
|
261
262
|
=== relaton version
|
|
262
263
|
----
|
|
263
264
|
$ relaton version
|
|
264
|
-
CLI => 1.
|
|
265
|
-
relaton => 1.
|
|
266
|
-
relaton-bib => 1.
|
|
267
|
-
relaton-iso-bib => 1.
|
|
268
|
-
relaton-gb => 1.
|
|
269
|
-
relaton-iec => 1.
|
|
270
|
-
relaton-ietf => 1.
|
|
271
|
-
relaton-iso => 1.
|
|
272
|
-
relaton-itu => 1.
|
|
273
|
-
relaton-nist => 1.
|
|
274
|
-
relaton-ogc => 1.
|
|
275
|
-
relaton-calconnect => 1.
|
|
276
|
-
relaton-omg => 1.
|
|
277
|
-
relaton-un => 1.
|
|
278
|
-
relaton-w3c => 1.
|
|
279
|
-
relaton-ieee => 1.
|
|
280
|
-
relaton-iho => 1.
|
|
281
|
-
relaton-bipm => 1.
|
|
282
|
-
relaton-ecma => 1.
|
|
283
|
-
relaton-cie => 1.
|
|
284
|
-
relaton-bsi => 1.
|
|
285
|
-
relaton-cen => 1.
|
|
286
|
-
relaton-iana => 1.
|
|
287
|
-
relaton-3gpp => 1.
|
|
288
|
-
relaton-oasis => 1.
|
|
289
|
-
relaton-doi => 1.
|
|
290
|
-
relaton-jis => 1.
|
|
265
|
+
CLI => 1.17.2
|
|
266
|
+
relaton => 1.17.2
|
|
267
|
+
relaton-bib => 1.17.2
|
|
268
|
+
relaton-iso-bib => 1.17.0
|
|
269
|
+
relaton-gb => 1.17.0
|
|
270
|
+
relaton-iec => 1.17.0
|
|
271
|
+
relaton-ietf => 1.17.0
|
|
272
|
+
relaton-iso => 1.17.0
|
|
273
|
+
relaton-itu => 1.17.0
|
|
274
|
+
relaton-nist => 1.17.0
|
|
275
|
+
relaton-ogc => 1.17.1
|
|
276
|
+
relaton-calconnect => 1.17.0
|
|
277
|
+
relaton-omg => 1.17.0
|
|
278
|
+
relaton-un => 1.17.0
|
|
279
|
+
relaton-w3c => 1.17.2
|
|
280
|
+
relaton-ieee => 1.17.0
|
|
281
|
+
relaton-iho => 1.17.0
|
|
282
|
+
relaton-bipm => 1.17.0
|
|
283
|
+
relaton-ecma => 1.17.0
|
|
284
|
+
relaton-cie => 1.17.0
|
|
285
|
+
relaton-bsi => 1.17.0
|
|
286
|
+
relaton-cen => 1.17.0
|
|
287
|
+
relaton-iana => 1.17.0
|
|
288
|
+
relaton-3gpp => 1.17.0
|
|
289
|
+
relaton-oasis => 1.17.0
|
|
290
|
+
relaton-doi => 1.17.0
|
|
291
|
+
relaton-jis => 1.17.0
|
|
292
|
+
relaton-xsf => 1.17.0
|
|
293
|
+
relaton-ccsds => 1.17.0
|
|
294
|
+
relaton-etsi => 1.17.0
|
|
295
|
+
relaton-isbn => 1.17.0
|
|
291
296
|
----
|
|
292
297
|
|
|
293
298
|
=== relaton collection
|
|
294
299
|
|
|
295
|
-
The `relaton collection` is a set of subcommands for
|
|
300
|
+
The `relaton collection` is a set of subcommands for collection manipulations.
|
|
296
301
|
|
|
297
302
|
==== relaton collection create
|
|
298
303
|
|
|
@@ -300,8 +305,8 @@ The `relaton collection` is a set of subcommands for collections manipulations.
|
|
|
300
305
|
$ relaton collection create COLLECTION -d DIRECTORY --author AUTHOR --title TITLE --doctype DOCTYPE
|
|
301
306
|
----
|
|
302
307
|
|
|
303
|
-
Create new empty collection with name `COLLECTION`.
|
|
304
|
-
* `DIRECTORY`
|
|
308
|
+
Create a new empty collection with the name `COLLECTION`.
|
|
309
|
+
* `DIRECTORY` - optional, and specifies a path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
305
310
|
* `AUTHOR`, `TITLE`, and `DOCTYPE` are optional.
|
|
306
311
|
|
|
307
312
|
==== relaton collection info
|
|
@@ -311,7 +316,7 @@ $ relaton collection info COLLECTION -d DIRECTORY
|
|
|
311
316
|
----
|
|
312
317
|
|
|
313
318
|
Show information about `COLLECTION` (number of items, file size of collection, last updated, name, metadata).
|
|
314
|
-
* `DIRECTORY` is optional, and specifies path to a directory with collections.
|
|
319
|
+
* `DIRECTORY` is optional, and specifies the path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
315
320
|
|
|
316
321
|
==== relaton collection list
|
|
317
322
|
|
|
@@ -320,8 +325,8 @@ $ relaton collection list -d DIRECTORY -e
|
|
|
320
325
|
----
|
|
321
326
|
|
|
322
327
|
List all collections.
|
|
323
|
-
* `DIRECTORY`
|
|
324
|
-
* When
|
|
328
|
+
* `DIRECTORY` - optional, and specifies the path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
329
|
+
* When parameter `-e` is defined the id of each entry id will be listed.
|
|
325
330
|
|
|
326
331
|
==== relaton collection get
|
|
327
332
|
|
|
@@ -331,10 +336,10 @@ $ relaton collection get CODE -c COLLECTION -d DIRECTORY -f FORMAT -o FILE
|
|
|
331
336
|
|
|
332
337
|
Get a document matched to `CODE` from `COLLECTION`.
|
|
333
338
|
|
|
334
|
-
* `COLLECTION`
|
|
335
|
-
* `DIRECTORY`
|
|
336
|
-
* `FORMAT`
|
|
337
|
-
* `FILE` is optional. When it's defined then save document with given file name.
|
|
339
|
+
* `COLLECTION` - optional name of a collection. If undefined then fetch the first match across all collections in `DIRECTORY`.
|
|
340
|
+
* `DIRECTORY` - optional, and specifies a path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
341
|
+
* `FORMAT` - optional. If undefined then print a document in a human-readable form. Allowed values are `abb` (AsciiBib) or `xml` (XML).
|
|
342
|
+
* `FILE` is optional. When it's defined then save a document with the given file name. The file's extension defines the format of the file. Possible extensions are `abb` (AsciiBib) or `xml` (XML).
|
|
338
343
|
|
|
339
344
|
==== relaton collection find
|
|
340
345
|
|
|
@@ -344,8 +349,8 @@ $ relaton collection find TEXT -c COLLECTION -d DIRECTORY
|
|
|
344
349
|
|
|
345
350
|
Full-text search through a collection or all collections.
|
|
346
351
|
|
|
347
|
-
* `COLLECTION`
|
|
348
|
-
* `DIRECTORY`
|
|
352
|
+
* `COLLECTION` - optional name of a collection. If undefined then search across all collections.
|
|
353
|
+
* `DIRECTORY` - optional, and specifies a path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
349
354
|
|
|
350
355
|
==== relaton collection fetch
|
|
351
356
|
|
|
@@ -355,10 +360,10 @@ $ relaton collection fetch CODE -t TYPE -y YEAR -c COLLECTION -d DIRECTORY
|
|
|
355
360
|
|
|
356
361
|
Fetch the Relaton XML entry corresponding to the document identifier `CODE` and save it into `COLLECTION`.
|
|
357
362
|
|
|
358
|
-
* `TYPE` specifies the standards class library to be used, that the identifier is part of. The
|
|
363
|
+
* `TYPE` specifies the standards class library to be used, that the identifier is part of. The recognized values for `TYPE` are: `3GPP`, `BIPM`, `CCTF`, `CCDS`, `CGPM`, `CIPM`, `JCRB`, `JCGM`, `BSI`, `BS`, `PD`, `CC`, `CCSDS`, `CEN`, `EN`, `ENV`, `CWA`, `HD`, `CR`, `CIE`, `DOI`, `ECMA`, `ETSI`, `CN`, `GB`, `GB/T`, `GB/Z`, `IANA`, `IEC`, `CISPR`, `IEV`, `IEEE`, `ANSI`, `NACE`, `AIEE`, `ASA`, `IRE`, `IETF`, `RFC`, `BCP`, `FYI`, `STD`, `I-D`, `IHO`, `ISBN`, `ISO`, `ISO/IEC`, `ITU`, `JIS`, `TR`, `NIST`, `NBS`, `NISTGCR`, `ITL Bulletin`, `JPCRD`, `NISTIR`, `CSRC`, `FIPS`, `OASIS`, `OGC`, `OMG`, `UN`, `W3C`, `XEP`.
|
|
359
364
|
* `YEAR` is optional, and specifies the year of publication of the standard.
|
|
360
|
-
* `COLLECTION`
|
|
361
|
-
* `DIRECTORY`
|
|
365
|
+
* `COLLECTION` - a name of a collection.
|
|
366
|
+
* `DIRECTORY` - optional, and specifies a path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
362
367
|
|
|
363
368
|
==== relaton collection export
|
|
364
369
|
|
|
@@ -366,9 +371,9 @@ Fetch the Relaton XML entry corresponding to the document identifier `CODE` and
|
|
|
366
371
|
$ relaton collection export COLLECTION -d DIRECTORY
|
|
367
372
|
----
|
|
368
373
|
|
|
369
|
-
Export `COLLECTION` into XML file.
|
|
374
|
+
Export `COLLECTION` into an XML file.
|
|
370
375
|
|
|
371
|
-
* `DIRECTORY`
|
|
376
|
+
* `DIRECTORY` - optional, and specifies a path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
372
377
|
|
|
373
378
|
==== relaton collection import
|
|
374
379
|
|
|
@@ -378,8 +383,8 @@ $ relaton collection import FILE -c COLLECTION -d DIRECTORY
|
|
|
378
383
|
|
|
379
384
|
Import document or collection from XML `FILE` into `COLLECTION`.
|
|
380
385
|
|
|
381
|
-
* `COLLECTION`
|
|
382
|
-
* `DIRECTORY`
|
|
386
|
+
* `COLLECTION` - optional. If a collection doesn't exist then it will be created.
|
|
387
|
+
* `DIRECTORY` - optional, and specifies a path to a directory with collections. The default value is `$HOME/.relaton/collections`.
|
|
383
388
|
|
|
384
389
|
=== Dadabase manipulation
|
|
385
390
|
|
|
@@ -389,7 +394,7 @@ Import document or collection from XML `FILE` into `COLLECTION`.
|
|
|
389
394
|
$ relaton db create DIR
|
|
390
395
|
----
|
|
391
396
|
|
|
392
|
-
Creates a new database in a directory `DIR` (optional,
|
|
397
|
+
Creates a new database in a directory `DIR` (optional, the default value is `/home/USER/.relaton/dbpath`). In case the target directory exists it will be used as a database.
|
|
393
398
|
|
|
394
399
|
----
|
|
395
400
|
$ relaton db create
|
|
@@ -405,7 +410,7 @@ $ relaton db create cachedb
|
|
|
405
410
|
$ relaton db mv DIR
|
|
406
411
|
----
|
|
407
412
|
|
|
408
|
-
Move database to another place `DIR`.
|
|
413
|
+
Move a database to another place `DIR`.
|
|
409
414
|
|
|
410
415
|
----
|
|
411
416
|
$ relaton db mv cache_dir
|
|
@@ -414,7 +419,7 @@ $ relaton db mv cache_dir
|
|
|
414
419
|
|
|
415
420
|
==== Clear database
|
|
416
421
|
|
|
417
|
-
Delete all entries from a
|
|
422
|
+
Delete all entries from a cache DB.
|
|
418
423
|
|
|
419
424
|
----
|
|
420
425
|
$ relaton db clear
|
|
@@ -426,20 +431,20 @@ $ relaton db clear
|
|
|
426
431
|
$ relaton db fetch -t TYPE -f FORMAT -y YEAR
|
|
427
432
|
----
|
|
428
433
|
|
|
429
|
-
Fetch an entry from a database. See [relaton fetch](#relaton-fetch) for the arguments
|
|
434
|
+
Fetch an entry from a database. See [relaton fetch](#relaton-fetch) for the explanation of the arguments.
|
|
430
435
|
|
|
431
436
|
==== Fetch all
|
|
432
437
|
|
|
433
|
-
Fetch all entries from a
|
|
438
|
+
Fetch all entries from a cache DB.
|
|
434
439
|
|
|
435
440
|
----
|
|
436
441
|
$ relaton db fetch_all TEXT -e EDITION -y YEAR -f FORMAT
|
|
437
442
|
----
|
|
438
443
|
|
|
439
|
-
* `TEXT` (optional) search for a
|
|
440
|
-
* `EDITION` (optional) filter
|
|
444
|
+
* `TEXT` (optional) search for a certain string
|
|
445
|
+
* `EDITION` (optional) filter documents with a certain edition
|
|
441
446
|
* `YEAR` (optional) filter documents by a year
|
|
442
|
-
* `FORMAT` (optional)
|
|
447
|
+
* `FORMAT` (optional) specifies the output format. Recognized values are `xml` (default), yaml, `bibtex`.
|
|
443
448
|
|
|
444
449
|
----
|
|
445
450
|
$ relaton db fetch_all
|
|
@@ -477,7 +482,7 @@ $ relaton db fetch_all -e 8 -y 2018
|
|
|
477
482
|
$ relaton db doctype REF
|
|
478
483
|
----
|
|
479
484
|
|
|
480
|
-
Takes a reference `REF` and
|
|
485
|
+
Takes a reference `REF` and returns a document type.
|
|
481
486
|
|
|
482
487
|
----
|
|
483
488
|
$ relaton db doctype 'CN(GB/T 1.1)'
|
data/lib/relaton/cli/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: relaton-cli
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.17.
|
|
4
|
+
version: 1.17.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ribose Inc.
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-
|
|
11
|
+
date: 2023-12-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: liquid
|