README.adoc in relaton-ieee-1.13.1 vs README.adoc in relaton-ieee-1.14.0

- old
+ new

@@ -28,116 +28,57 @@ [source,ruby] ---- require 'relaton_ieee' => true -hits = RelatonIeee::IeeeBibliography.search("IEEE 528-2019") -=> <RelatonIeee::HitCollection:0x007f84c0085308 @ref=IEEE 528-2019 @fetched=false> - -item = hits[0].fetch - => #<RelatonIeee::IeeeBibliographicItem:0x007f84bf839c30 - ... +item = RelatonIeee::IeeeBibliography.search("IEEE 528-2019") +=> #<RelatonIeee::IeeeBibliographicItem:0x00007fe12ebc8cb8 +... ---- === XML serialization [source,ruby] ---- item.to_xml - => "<bibitem id="IEEE528-2019"> - <fetched>2020-06-01</fetched> - <title type="main" format="text/plain" language="en" script="Latn">IEEE 528-2019 - IEEE Standard for Inertial Sensor Terminology</title> - <uri type="src">https://standards.ieee.org/content/ieee-standards/en/standard/528-2019.html</uri> - <docidentifier type="IEEE">IEEE 528-2019</docidentifier> - <date type="issued"> - <on>2019</on> - </date> - <date type="published"> - <on>2019</on> - </date> - <contributor> - <role type="author"/> - <person> - <name> - <completename>Ashley Moran</completename> - </name> - </person> - </contributor> - <language>en</language> - <script>Latn</script> - <abstract format="text/plain" language="en" script="Latn">Terms and definitions relating to inertial sensors are presented in this standard. Usage as understood by the inertial sensor community is given preference over general technical usage of the terms herein. The criterion for inclusion of a term and its definition in this standard is usefulness as related to inertial sensor technology.</abstract> - <status> - <stage>Active</stage> - </status> + => "<bibitem id="IEEE528-2019" type="standard" schema-version="v1.2.1"> + <fetched>2022-12-03</fetched> + <title type="main" format="text/plain">IEEE Standard for Inertial Sensor Terminology</title> + <uri type="src">https://ieeexplore.ieee.org/document/8863799</uri> + <docidentifier type="IEEE" primary="true">IEEE 528-2019</docidentifier> + ... </bibitem>" ---- -With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavour `ext` element. +With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavor `ext` element. [source,ruby] ---- item.to_xml bibdata: true - => "<bibdata> - <fetched>2020-06-01</fetched> - <title type="main" format="text/plain" language="en" script="Latn">IEEE 528-2019 - IEEE Standard for Inertial Sensor Terminology</title> - <uri type="src">https://standards.ieee.org/content/ieee-standards/en/standard/528-2019.html</uri> - <docidentifier type="IEEE">IEEE 528-2019</docidentifier> - <date type="issued"> - <on>2019</on> - </date> - <date type="published"> - <on>2019</on> - </date> - <contributor> - <role type="author"/> - <person> - <name> - <completename>Ashley Moran</completename> - </name> - </person> - </contributor> - <language>en</language> - <script>Latn</script> - <abstract format="text/plain" language="en" script="Latn">Terms and definitions relating to inertial sensors are presented in this standard. Usage as understood by the inertial sensor community is given preference over general technical usage of the terms herein. The criterion for inclusion of a term and its definition in this standard is usefulness as related to inertial sensor technology.</abstract> - <status> - <stage>Active</stage> - </status> - <ext> - <committee type="standard"> - <name>AES/GA - Gyro Accelerometer Panel</name> - </committee> - <committee type="working"> - <name>SENSR_WG - Sensors Working Group</name> - <chair>Harry Davis</chair> - </committee> - <committee type="society"> - <name>IEEE Aerospace and Electronic Systems Society</name> - </committee> +=> "<bibdata type="standard" schema-version="v1.2.1"> + <fetched>2022-12-03</fetched> + <title type="main" format="text/plain">IEEE Standard for Inertial Sensor Terminology</title> + <uri type="src">https://ieeexplore.ieee.org/document/8863799</uri> + <docidentifier type="IEEE" primary="true">IEEE 528-2019</docidentifier> + ... + <ext schema-version="v1.0.0"> + <editorialgroup> + <committee>Gyro Accelerometer Panel of the IEEE Aerospace and Electronic Systems Society</committee> + </editorialgroup> + ... </ext> </bibdata>" ---- === Get document by reference [source,ruby] ---- RelatonIeee::IeeeBibliography.get("IEEE 528-2019") [relaton-ieee] ("IEEE 528-2019") fetching... -[relaton-ieee] ("IEEE 528-2019") found 528-2019 +[relaton-ieee] ("IEEE 528-2019") found IEEE 528-2019 => #<RelatonIeee::IeeeBibliographicItem:0x007fceb52a6e40 ... - - RelatonIeee::IeeeBibliography.get("IEEE 528", "2019") -[relaton-ieee] ("IEEE 528") fetching... -[relaton-ieee] ("IEEE 528") found 528-2019 - => #<RelatonIeee::IeeeBibliographicItem:0x007fceb54af7f0 - ... - - RelatonIeee::IeeeBibliography.get("IEEE 528") -[relaton-ieee] ("IEEE 528") fetching... -[relaton-ieee] ("IEEE 528") found 528-2019 -=> #<RelatonIeee::IeeeBibliographicItem:0x007fceb512c510 -... ---- === Typed links Each IEEE document has `src` type link. @@ -158,26 +99,26 @@ === Create bibliographic item from YAML [source,ruby] ---- hash = YAML.load_file 'spec/fixtures/ieee_528_2019.yaml' - => {"id"=>"528-2019", "title"=>{ + => {"id"=>"IEEE528-2019", ... RelatonIeee::IeeeBibliographicItem.from_hash hash => #<RelatonIeee::IeeeBibliographicItem:0x007fce940b3eb0 ... ---- === Fetch data -There is an IEEE dataset https://github.com/relaton/ieee-rawbib which can be converted into BibXML/BibYAML formats. The dataset needs to be placed into local directiory. +There is an IEEE dataset https://github.com/relaton/ieee-rawbib which can be converted into BibXML/BibYAML formats. The dataset needs to be placed into the local directory. -The method `RelatonIeee::DataFetcher.fetch(output: "data", format: "yaml")` converts all the documents from the local `ieee-rawbib` directory and save them to the `./data` folder in YAML format. +The method `RelatonIeee::DataFetcher.fetch(output: "data", format: "yaml")` converts all the documents from the local `ieee-rawbib` directory and saves them to the `./data` folder in YAML format. Arguments: - `output` - folder to save documents (default './data'). -- `format` - format in which the documents are saved. Possimle formats are: `yaml`, `xml` (default `yaml`). +- `format` - the format in which the documents are saved. Possible formats are: `yaml`, `xml` (default `yaml`). [source,ruby] ---- RelatonIeee::DataFetcher.fetch Started at: 2021-09-24 17:55:07 +0200