README.adoc in relaton-ietf-1.9.2 vs README.adoc in relaton-ietf-1.9.3

- old
+ new

@@ -131,9 +131,44 @@ RelatonIetf::IetfBibliographicItem.from_hash hash => #<RelatonIetf::IetfBibliographicItem:0x007f9a929dde40 ... ---- +=== Fetch data + +There is a IETF datasets what can be converted into RelatonXML/BibXML/BibYAML formats: + +- `ietf-rfcsubseries` - https://www.rfc-editor.org/rfc-index.xml (`<bcp-entry>`, `<fyi-entry>`, `<std-entry>`) +- `ietf-internet-drafts` - https://www.ietf.org/lib/dt/sprint/bibxml-ids.tgz +- `ietf-rfc-entries` - https://www.rfc-editor.org/rfc-index.xml (`<rfc-entry>`) + +The method `RelatonIetf::DataFetcher.fetch(source, output: "data", format: "yaml")` converts all the documents from the dataset and save them to the `./data` folder in YAML format. + +Arguments: + +- `source` - dataset name (`ietf-rfcsubseries` or `ietf-internet-drafts`) +- `output` - folder to save documents (default './data'). +- `format` - format in which the documents are saved. Possimle formats are: `yaml`, `xml`, `bibxml` (default `yaml`). + +For `ietf-rfcsubseries` dataset only special XML format is supported: + +[sourse.xml] +---- +<referencegroup anchor="BCP14" target="https://www.rfc-editor.org/info/bcp14"> + <xi:include href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.2119.xml" /> + <xi:include href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.8174.xml" /> +</referencegroup> +---- + +[source,ruby] +---- +RelatonIetf::DataFetcher.fetch "ietf-internet-drafts" +Started at: 2021-12-17 10:23:20 +0100 +Stopped at: 2021-12-17 10:29:19 +0100 +Done in: 360 sec. +=> nil +---- + == Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-ietf. == License