relaton-cli 1.14.0 → 1.14.1
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 +17 -16
- 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: 2ce962bd33e29dc88c310af3cf05bccd843c57a8b729f1579d3d965cf221ce37
|
4
|
+
data.tar.gz: e3168dee95d3efe4ac61678ec2fa29b8a073d19a44a97958c0043bf3047e43e4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6c46aba4bfd39f2006b69634dad27bc434ef669cfca55f831a2fa75de5b62a50d67a96fb514be124931a8e8fe3004027e506a01efa70aceccee503501f2f910d
|
7
|
+
data.tar.gz: b670592e721a5b98e077dcb49c3f0fa3c22c1984246fea09541c713a2888a283bd88ddc2d26c499398cadc86dc10c294b6ba81814a8286e613065e8133490e56
|
data/docs/README.adoc
CHANGED
@@ -10,7 +10,7 @@ Please refer to https://github.com/relaton/relaton.
|
|
10
10
|
|
11
11
|
== Commands
|
12
12
|
|
13
|
-
Each command has an option `--verbose` (short form is `-v`). Use the option to get warnings in the commands
|
13
|
+
Each command has an option `--verbose` (the short form is `-v`). Use the option to get warnings in the commands output.
|
14
14
|
The following commands are provided.
|
15
15
|
|
16
16
|
=== relaton concatenate
|
@@ -23,7 +23,7 @@ $ relaton concatenate Source-Directory Relaton-Collection-File -t TITLE -g ORGAN
|
|
23
23
|
Iterates through all the Relaton files (YAML and XML) in `Source-Directory`, and concatenates them into a Relaton Collection file. The extension of the Collection file can be set using the `Relaton-Collection-File` file name (i.e, if it uses an extension of `yaml`, a Relaton YAML file will be created; if `rxl`, a Relaton XML file will be created, or via the `-x [ext]` (or `--extension`) option.
|
24
24
|
|
25
25
|
For each Relaton input file in the `Source-Directory`, if a document file with the same base name is identified (i.e. an XML, HTML, PDF or DOC
|
26
|
-
file)
|
26
|
+
file) a link to that file is inserted.
|
27
27
|
|
28
28
|
If the `TITLE` or `ORGANIZATION` options are given, they are added to the `Collection-File` output as the
|
29
29
|
title and author of the `Relaton-Collection-File` document.
|
@@ -47,12 +47,12 @@ $ relaton fetch CODE -t TYPE -f FORMAT -y YEAR -r RETRIES --all-parts --keep-yea
|
|
47
47
|
|
48
48
|
Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
|
49
49
|
|
50
|
-
* `YEAR` is optional
|
51
|
-
* `FORMAT` is optional, and specifies the output format; the
|
52
|
-
* `TYPE` is optional
|
50
|
+
* `YEAR` is optional and specifies the year of publication of the standard.
|
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, BIPM, BSI, CC, CEN, CIE, CN, ECMA, IANA, IEC, IEEE, IETF, IHO, ISO, ITU, NIST, OGC, OMG, UN, W3C`.
|
53
53
|
* `RETRIES` is optional, number of network retries (default 1).
|
54
54
|
* `--all-parts` fetch all parts.
|
55
|
-
* `--keep-year` undated reference should return actual reference with year.
|
55
|
+
* `--keep-year` undated reference should return an actual reference with year.
|
56
56
|
|
57
57
|
=== relaton fetch-data
|
58
58
|
|
@@ -61,25 +61,26 @@ Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
|
|
61
61
|
$ relaton fetch-data DATASET -o DIR -f FORMAT
|
62
62
|
----
|
63
63
|
|
64
|
-
Fetch all the documents from a `DATASET` source and save them to a folder `DIR` in format `FORMAT`.
|
64
|
+
Fetch all the documents from a `DATASET` source and save them to a folder `DIR` in the format `FORMAT`.
|
65
65
|
|
66
|
-
|
66
|
+
The following datasets are available:
|
67
67
|
|
68
68
|
* `nist-tech-pubs` - https://raw.githubusercontent.com/usnistgov/NIST-Tech-Pubs/nist-pages/xml/allrecords.xml
|
69
69
|
* `cie-techstreet` - https://www.techstreet.com/cie/searches/31156444
|
70
70
|
* `calconnect-org` - https://standards.calconnect.org/relaton/index.yaml
|
71
71
|
* `ogc-naming-authority` - https://raw.githubusercontent.com/opengeospatial/NamingAuthority/master/incubation/bibliography/bibliography.json
|
72
|
-
* `ieee-rawbib` - looks for the IEEE dataset in local `./ieee-rawbib` directory. The dataset could be downloaded from https://github.com/ietf-ribose/ieee-rawbib repository
|
72
|
+
* `ieee-rawbib` - looks for the IEEE dataset in the local `./ieee-rawbib` directory. The dataset could be downloaded from https://github.com/ietf-ribose/ieee-rawbib repository
|
73
73
|
* `w3c-rdf` - http://www.w3.org/2002/01/tr-automation/tr.rdf
|
74
74
|
* `w3c-tr-archive` - looks for the W3C archive dataset in local `./w3c-tr-archive` directory. The dataset could be downloaded from https://github.com/relaton/w3c-tr-archive repository
|
75
75
|
* `iana-registries` - https://github.com/ietf-ribose/iana-registries
|
76
|
-
* `status-smg-3GPP` - ftp://www.3gpp.org/Information/Databases/Spec_Status/
|
76
|
+
* `status-smg-3GPP` - updates previously downloaded data if a new archive is available in ftp://www.3gpp.org/Information/Databases/Spec_Status/
|
77
|
+
* `status-smg-3GPP-force` - download data from the latest archive in ftp://www.3gpp.org/Information/Databases/Spec_Status/
|
77
78
|
* `ietf-rfcsubseries` - https://www.rfc-editor.org/rfc-index.xml (`<bcp-entry>`, `<fyi-entry>`, `<std-entry>`)
|
78
|
-
* `ietf-internet-drafts` - looks for the Internet-Drafts dataset in local `./bibxml-ids` directory. The dataset could be downloaded using `rsync -avcizxL rsync.ietf.org::bibxml-ids ./bibxml-ids` command.
|
79
|
+
* `ietf-internet-drafts` - looks for the Internet-Drafts dataset in the local `./bibxml-ids` directory. The dataset could be downloaded using `rsync -avcizxL rsync.ietf.org::bibxml-ids ./bibxml-ids` command.
|
79
80
|
* `ietf-rfc-entries` - https://www.rfc-editor.org/rfc-index.xml (`<rfc-entry>`)
|
80
81
|
* `oasis-open` - https://www.oasis-open.org/standards/
|
81
|
-
* `bipm-data-outcomes` - looks for the BIPM dataset in local `./bipm-data-outcomes` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-data-outcomes repository
|
82
|
-
* `si-brochure` - looks for the SI-Brochure dataset in local `./bipm-si-brocure` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-si-brochure repository
|
82
|
+
* `bipm-data-outcomes` - looks for the BIPM dataset in the local `./bipm-data-outcomes` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-data-outcomes repository
|
83
|
+
* `si-brochure` - looks for the SI-Brochure dataset in the local `./bipm-si-brocure` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-si-brochure repository
|
83
84
|
|
84
85
|
Options:
|
85
86
|
|
@@ -116,7 +117,7 @@ There are two templates necessary:
|
|
116
117
|
|
117
118
|
** Index template (`_index.liquid_`)
|
118
119
|
|
119
|
-
*** The HTML Template file `_index.liquid`
|
120
|
+
*** The HTML Template file `_index.liquid` recognizes the following parameters:
|
120
121
|
*** `css`: where the CSS stylesheet `stylesheet` is injected
|
121
122
|
*** `title`: the Title of the collection, `./relaton-collection/title` in `relaton-xml`
|
122
123
|
*** `author`: the Author of the collection, `./relaton-collection/contributor[role/@type = 'author']/organization/name` in `relaton-xml`
|
@@ -124,7 +125,7 @@ There are two templates necessary:
|
|
124
125
|
|
125
126
|
** Individual bibliographic entries template (`_document.liquid`)
|
126
127
|
|
127
|
-
*** This template
|
128
|
+
*** This template recognizes attributes of a bibliographic entry (`document`) that follow the naming convention of <<relaton-yaml,Relaton YAML>>; e.g. `document.html` is the HTML URI for the document.
|
128
129
|
|
129
130
|
The default stylesheet and templates are given (which also demonstrates the structure) in the `templates` directory.
|
130
131
|
|
@@ -186,7 +187,7 @@ $ relaton yaml2xml YAML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LI
|
|
186
187
|
Convert a Relaton YAML file (`filename.yaml`) into a Relaton XML file (`filename.xml`). If the Relaton YAML file specifies multiple bibliograph items, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton XML files for each entry, stored in that directory. The document identifier is used as the name of each Relaton XML file; the Relaton XML filename is suffixed with `RELATON_EXTENSION` (default `.rxl`) and prefixed with `PREFIX` (default empty). Any libraries that need to be required for the conversion are specified in `LIBRARY` as a space-delimited list.
|
187
188
|
|
188
189
|
[[relaton-yaml]]
|
189
|
-
A Relaton Collection YAML file contains some initial metadata
|
190
|
+
A Relaton Collection YAML file contains some initial metadata and a list of metadata about each bibliographic entry:
|
190
191
|
|
191
192
|
[source,yaml]
|
192
193
|
----
|
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.14.
|
4
|
+
version: 1.14.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ribose Inc.
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-12-
|
11
|
+
date: 2022-12-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: byebug
|