relaton-bib 1.4.0 → 2.1.7

data/README.adoc

@@ -1,14 +1,12 @@
-= RelatonBib
+= Relaton::Bib
 
 image:https://img.shields.io/gem/v/relaton-bib.svg["Gem Version", link="https://rubygems.org/gems/relaton-bib"]
-image:https://github.com/relaton/relaton-bib/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-bib/actions?workflow=macos"]
-image:https://github.com/relaton/relaton-bib/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/relaton/relaton-bib/actions?workflow=windows"]
-image:https://github.com/relaton/relaton-bib/workflows/ubuntu/badge.svg["Build Status (Ubuntu)", link="https://github.com/relaton/relaton-bib/actions?workflow=ubuntu"]
+image:https://github.com/relaton/relaton-bib/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/relaton-bib/actions?workflow=rake"]
 image:https://codeclimate.com/github/relaton/relaton-bib/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/relaton-bib"]
 image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-bib.svg["Pull Requests", link="https://github.com/relaton/relaton-bib/pulls"]
 image:https://img.shields.io/github/commits-since/relaton/relaton-bib/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-bib/releases"]
 
-RlatonBib is a Ruby gem that implements the https://github.com/metanorma/relaton-models#bibliography-uml-models[BibliographicItem model].
+Relaton::Bib is a Ruby gem that implements the https://github.com/metanorma/relaton-models#bibliography-uml-models[BibliographicItem model].
 
 == Installation
 
@@ -29,254 +27,93 @@ Or install it yourself as:
 
 == Usage
 
+[source,ruby]
+----
+require 'relaton/bib'
+=> true
+----
+
 === Create bibliographic item
 
 [source,ruby]
 ----
-item = RelatonBib::BibliographicItem.new(
-  id: "ISOTC211", fetched: Date.today.to_s,
-  title: [
-    { type: "main", content: "Geographic information", language: "en", script: "Latn" },
-    {
-      content: "Information géographique", language: "fr", script: "Latn"
-    },
-  ],
-  type: "standard",
-  docid: [
-    RelatonBib::DocumentIdentifier.new(id: "TC211", type: "ISO"),
-    RelatonBib::DocumentIdentifier.new(id: "ISBN", type: "isbn"),
-    RelatonBib::DocumentIdentifier.new(id: "LCCN", type: "lccn"),
-    RelatonBib::DocumentIdentifier.new(id: "ISSN", type: "issn"),
-  ],
-  docnumber: "123456",
-  edition: "1", language: %w[en fr], script: ["Latn"],
-  version: RelatonBib::BibliographicItem::Version.new("2019-04-01", ["draft"]),
-  biblionote: [
-    RelatonBib::BiblioNote.new(content: "note"),
-    RelatonBib::BiblioNote.new(content: "An note", type: "annote"),
-    RelatonBib::BiblioNote.new(content: "How published", type: "howpublished"),
-    RelatonBib::BiblioNote.new(content: "Comment", type: "comment"),
-    RelatonBib::BiblioNote.new(content: "Table Of Contents", type: "tableOfContents"),
-  ],
-  docstatus: RelatonBib::DocumentStatus.new(
-    stage: "stage", substage: "substage", iteration: "final",
-  ),
-  date: [
-    { type: "issued", on: "2014" },
-    { type: "published", on: "2014-04" },
-    { type: "accessed", on: "2015-05-20" },
-  ],
-  abstract: [
-    { content: "ISO 19115-1:2014 defines the schema required for ...",
-      language: "en", script: "Latn", format: "text/plain" },
-    { content: "L'ISO 19115-1:2014 définit le schéma requis pour ...",
-      language: "fr", script: "Latn", format: "text/plain" },
-  ],
-  contributor: [
-    {
-      entity: {
-        name: "International Organization for Standardization",
-        url: "www.iso.org", abbreviation: "ISO", subdivision: "division",
-      },
-      role: [{ type: "publisher", description: ["Publisher role"] }],
-    },
-    {
-      entity: RelatonBib::Person.new(
-        name: RelatonBib::FullName.new(
-          completename: RelatonBib::LocalizedString.new("A. Bierman", "en"),
-        ),
-        affiliation: [RelatonBib::Affiliation.new(
-          organization: RelatonBib::Organization.new(
-            name: "IETF",
-            abbreviation: RelatonBib::LocalizedString.new("IETF"),
-            identifier: [RelatonBib::OrgIdentifier.new("uri", "www.ietf.org")],
-          )
-        )],
-        contact: [
-          RelatonBib::Address.new(
-            street: ["Street"], city: "City", postcode: "123456",
-            country: "Country", state: "State"
-          ),
-          RelatonBib::Contact.new(type: "phone", value: "223322"),
-        ]
-      ),
-      role: [type: "author"],
-    },
-    RelatonBib::ContributionInfo.new(
-      entity: RelatonBib::Organization.new(
-        name: "IETF",
-        abbreviation: "IETF",
-        identifier: [RelatonBib::OrgIdentifier.new("uri", "www.ietf.org")],
-      ),
-      role: [type: "publisher"],
-    ),
-    {
-      entity: RelatonBib::Person.new(
-        name: RelatonBib::FullName.new(
-          initial: [RelatonBib::LocalizedString.new("A.", "en")],
-          surname: RelatonBib::LocalizedString.new("Bierman", "en"),
-          forename: [RelatonBib::LocalizedString.new("Forename", "en")],
-          addition: [RelatonBib::LocalizedString.new("Addition", "en")],
-          prefix: [RelatonBib::LocalizedString.new("Prefix", "en")],
-        ),
-        affiliation: [RelatonBib::Affiliation.new(
-          organization: RelatonBib::Organization.new(name: "IETF", abbreviation: "IETF"),
-          description: [RelatonBib::LocalizedString.new("Description", "en")]
-        )],
-        contact: [
-          RelatonBib::Address.new(
-            street: ["Street"], city: "City", postcode: "123456",
-            country: "Country", state: "State"
-          ),
-          RelatonBib::Contact.new(type: "phone", value: "223322"),
-        ],
-        identifier: [RelatonBib::PersonIdentifier.new("uri", "www.person.com")],
-      ),
-      role: [type: "author"],
-    },
-    { entity: { name: "Institution" }, role: [type: "sponsor"] }
-  ],
-  copyright: [{
-      owner: [{
-          name: "International Organization for Standardization",
-          abbreviation: "ISO", url: "www.iso.org"
-        }],
-      from: "2014", to: "2020" 
-  }],
-  link: [
-    { type: "src", content: "https://www.iso.org/standard/53798.html" },
-    { type: "obp",
-      content: "https://www.iso.org/obp/ui/#!iso:std:53798:en" },
-    { type: "rss", content: "https://www.iso.org/contents/data/standard"\
-      "/05/37/53798.detail.rss" },
-    { type: "doi", content: "http://standrd.org/doi-123" },
-    { type: "file", content: "file://path/file" },
-  ],
-  relation: [
-    {
-      type: "updates",
-      bibitem: RelatonBib::BibliographicItem.new(
-        formattedref: RelatonBib::FormattedRef.new(content: "ISO 19115:2003"),
-      ),
-      locality: [
-        RelatonBib::LocalityStack.new([
-          RelatonBib::Locality.new("volume", "1"),
-          RelatonBib::Locality.new("section", "2"),
-        ]),
-      ],
-      source_locality: [
-        RelatonBib::SourceLocalityStack.new([
-          RelatonBib::SourceLocality.new("chapter", "4"),
-        ]),
-      ],
-    },
-    {
-      type: "updates",
-      bibitem: RelatonBib::BibliographicItem.new(
-        type: "standard",
-        formattedref: RelatonBib::FormattedRef.new(content: "ISO 19115:2003/Cor 1:2006"),
-      ),
-    },
-    {
-      type: "partOf",
-      bibitem: RelatonBib::BibliographicItem.new(
-        title: [RelatonBib::TypedTitleString.new(type: "main", content: "Book title")],
-      ),
-    },
-  ],
-  series: [
-    RelatonBib::Series.new(
-      type: "main",
-      title: RelatonBib::TypedTitleString.new(
-        type: "original", content: "ISO/IEC FDIS 10118-3", language: "en",
-        script: "Latn", format: "text/plain",
-      ),
-      place: "Serie's place",
-      organization: "Serie's organization",
-      abbreviation: RelatonBib::LocalizedString.new("ABVR"),
-      from: "2009-02-01",
-      to: "2010-12-20",
-      number: "serie1234",
-      partnumber: "part5678",
-    ),
-    RelatonBib::Series.new(
-      type: "alt",
-      formattedref: RelatonBib::FormattedRef.new(
-        content: "serieref", language: "en", script: "Latn",
-      ),
-    ),
-    RelatonBib::Series.new(
-      type: "journal", title: RelatonBib::TypedTitleString.new(content: "Journal"), number: "7"
-    ),
-    RelatonBib::Series.new(title: RelatonBib::TypedTitleString.new(content: "Series")),
-  ],
-  medium: RelatonBib::Medium.new(
-    form: "medium form", size: "medium size", scale: "medium scale",
-  ),
-  place: [
-    "bib place",
-    RelatonBib::Place.new(name: "Geneva", uri: "geneva.place", region: "Switzelznd")
-  ],
-  extent: [
-    RelatonBib::BibItemLocality.new("section", "Reference from", "Reference to"),
-    RelatonBib::BibItemLocality.new("chapter", "4"),
-    RelatonBib::BibItemLocality.new("page", "10", "20"),
-    RelatonBib::BibItemLocality.new("volume", "1"),
-  ],
-  accesslocation: ["accesslocation1", "accesslocation2"],
-  classification: [
-    RelatonBib::Classification.new(type: "type", value: "value"),
-    RelatonBib::Classification.new(type: "keyword", value: "Keywords"),
-    RelatonBib::Classification.new(type: "mendeley", value: "Mendeley Tags"),
-  ],
-  validity: RelatonBib::Validity.new(
-    begins: Time.new(2010, 10, 10, 12, 21),
-    ends: Time.new(2011, 2, 3, 18,30),
-    revision: Time.new(2011, 3, 4, 9, 0),
-  )
-)
-
-=> #<RelatonBib::BibliographicItem:0x007fc8b6c796c0
- @abstract=
-  [#<RelatonBib::FormattedString:0x007fc8b6c726b8 @content="ISO 19115-1:2014 defines the schema required for ...", @format="text/plain", @language=["en"], @script=["Latn"]>,
-----
-
-=== BibliographicItem Typed Title Strings
+yaml = File.read 'spec/fixtures/item.yaml'
+ => "id: ISO1231994\ntype: standard\nschema_version: 1.0.0\nfetched: \"2022-05-02\"\nformattedref: ISO 123:1994\ntitle..."
+
+item = Relaton::Bib::Item.from_yaml yaml
+ => #<Relaton::Bib::ItemData:0x000000012838bfc0 ...
+----
+
+=== Title
 
 [source,ruby]
 ----
 item.title
-=> [#<RelatonBib::TypedTitleString:0x007fa49a360290
-  @title=#<RelatonBib::FormattedString:0x007fa49a360088 @content="Geographic information", @format=nil, @language=["en"], @script=["Latn"]>,
-  @type="main">,
- #<RelatonBib::TypedTitleString:0x007fa49a35bf38
-  @title=#<RelatonBib::FormattedString:0x007fa49a35bdd0 @content="Information géographique", @format=nil, @language=["fr"], @script=["Latn"]>,
+ => [#<Relaton::Bib::Title:0x00000001270a6810
+  @content="Geographic information -- Metadata",
+  @format=nil,
+  @language="en",
+  @locale="en-US",
+  @script="Latn",
+  @type=nil>,
+ #<Relaton::Bib::Title:0x00000001270a5cd0
+  @content="Information géographique -- Métadonnées",
+  @format=nil,
+  @language="fr",
+  @locale="fr-FR",
+  @script="Latn",
   @type=nil>]
 
-item.title lang: "fr"
-=> [#<RelatonBib::TypedTitleString:0x007fa49a35bf38
-  @title=#<RelatonBib::FormattedString:0x007fa49a35bdd0 @content="Information géographique", @format=nil, @language=["fr"], @script=["Latn"]>,
+item.title "fr"
+ => [#<Relaton::Bib::Title:0x00000001270a5cd0
+  @content="Information géographique -- Métadonnées",
+  @format=nil,
+  @language="fr",
+  @locale="fr-FR",
+  @script="Latn",
   @type=nil>]
 ----
 
-=== BibliographicItem Formatted Strings
+=== Abstract
 
 [source,ruby]
 ----
 item.abstract
-=> [#<RelatonBib::FormattedString:0x007fc8b6c726b8 @content="ISO 19115-1:2014 defines the schema required for ...", @format="text/plain", @language=["en"], @script=["Latn"]>,
- #<RelatonBib::FormattedString:0x007fc8b6c725f0 @content="L'ISO 19115-1:2014 définit le schéma requis pour ...", @format="text/plain", @language=["fr"], @script=["Latn"]>]
-
-item.abstract(lang: "en").to_s
-=> "ISO 19115-1:2014 defines the schema required for ..."
+ => [#<Relaton::Bib::LocalizedMarkedUpString:0x0000000126c05748
+  @content="This is an abstract. <em>This is emphasized</em>",
+  @language="en",
+  @locale="en-US",
+  @script="Latn">]
+
+item.abstract("en")
+ => [#<Relaton::Bib::LocalizedMarkedUpString:0x0000000126c05748
+  @content="This is an abstract. <em>This is emphasized</em>",
+  @language="en",
+  @locale="en-US",
+  @script="Latn">]
 ----
 
-=== BibliographicItem references
+=== Document identifier
 
 [source,ruby]
 ----
-item.shortref item.docidentifier.first
-=> "TC211:2014"
+item.docidentifier
+ => [#<Relaton::Bib::Docidentifier:0x00000001270a4b00
+  @content="ISO 123:1994",
+  @language="en",
+  @locale="en-US",
+  @primary=true,
+  @scope="global",
+  @script="Latn",
+  @type="ISO">,
+ #<Relaton::Bib::Docidentifier:0x00000001270a46a0
+  @content="10.1007/978-3-319-99155-2_1",
+  @language=nil,
+  @locale=nil,
+  @primary=nil,
+  @scope=nil,
+  @script=nil,
+  @type="DOI">]
 ----
 
 === XML serialization
@@ -284,114 +121,116 @@ item.shortref item.docidentifier.first
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="ISO/TC211" type="standard">
-      <fetched>2019-04-30</fetched>
-      <title type="main" language="en" script="Latn">Geographic information</title>
-      <title language="fr" script="Latn">Information géographique</title>
+=> "<bibitem id="ISO1231994" type="standard" schema-version="1.0.0">
+      <fetched>2022-05-02</fetched>
+      <formattedref>ISO 123:1994</formattedref>
+      <title language="en" locale="en-US" script="Latn">Geographic information -- Metadata</title>
+      <title language="fr" locale="fr-FR" script="Latn">Information géographique -- Métadonnées</title>
+      <uri type="src">https://www.iso.org/standard/22722.html</uri>
+      <uri type="doi">10.1007/978-3-319-99155-2_1</uri>
       ...
     </bibitem>"
 ----
 
-Default root element is `bibitem`. With argument `bibdata: true` the XML wrapped with `bibdata` element.
+The default root element is `bibitem`. With argument `bibdata: true` the XML wrapped with `bibdata` element.
 
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata type="standard">
-      <fetched>2019-04-30</fetched>
-      <title type="main" language="en" script="Latn">Geographic information</title>
+=> "<bibdata type="standard" schema-version="1.0.0">
+      <fetched>2022-05-02</fetched>
+      <formattedref>ISO 123:1994</formattedref>
+      <title language="en" locale="en-US" script="Latn">Geographic information -- Metadata</title>
       ...
+      <ext schema-version="1.0.0">
+        <doctype abbreviation="std">Standard</doctype>
+        <subdoctype>Technical Report</subdoctype>
+        ...
+      </ext>
     </bibdata>"
 ----
 
-==== Date format
-
-By default date elements are formatted as year (yyyy). Option `:date_format` allows to output date elements in `:short` (yyyy-mm) and `:full` (yyyy-mm-dd) additiona formats.
+==== Adding notes
 
 [source,ruby]
 ----
-item.to_xml date_format: :short
-=> "<bibitem id="ISO/TC211" type="standard">
-      <fetched>2019-04-30</fetched>
-      <title type="main" language="en" script="Latn">Geographic information</title>
-      ...
-      <date type="issued">
-        <on>2014-01</on>
-      </date>
-      <date type="published">
-        <on>2014-04</on>
-      </date>
-      <date type="accessed">
-        <on>2015-05</on>
-      </date>
-      ...
-    </bibitem>"
-
-item.to_xml date_format: :full
-=> "<bibitem id="ISO/TC211" type="standard">
+item.to_xml note: [{ content: "Note", type: "note" }]
+=> "<bibitem id="ISO1231994" type="standard" schema-version="1.0.0">
       ...
-      <date type="issued">
-        <on>2014-01-01</on>
-      </date>
-      <date type="published">
-        <on>2014-04-01</on>
-      </date>
-      <date type="accessed">
-        <on>2015-05-20</on>
-      </date>
+      <note type="note">Note</note>
       ...
     </bibitem>"
 ----
 
-==== Adding notes
+=== Create bibliographic item form YAML
 
 [source,ruby]
 ----
-item.to_xml note: [{ text: "Note", type: "note" }]
-=>"<bibitem id="ISO19115-1-2014">
-  ...
-  <note format="text/plain" type="note">Note</note>
-  ...
-</bibitem>"
+yaml = File.read 'spec/fixtures/item.yaml'
+ => "id: ISO1231994\ntype: standard\nschema_version: 1.0.0\nfetched: \"2022-05-02\"\nformattedref: ISO 123:1994\ntitle..."
+
+Relaton::Bib::Item.from_yaml yaml
+ => #<Relaton::Bib::ItemData:0x000000011dc9e118 ...
 ----
 
-=== Create bibliographic item form YAML
+=== Create bibliographic item from RFC XML
 
 [source,ruby]
 ----
-hash = YAML.load_file 'spec/examples/bib_item.yml'
-=> {"id"=>"ISO/TC211",
-...
+xml = File.read 'spec/fixtures/rfc.xml'
+ => "<reference anchor=\"RFC1\" target=\"10.17487/RFC0001\">\n  <front>\n    <title>Title RFC1</title>\n    <seriesInf..."
 
-bib_hash = RelatonBib::HashConverter.hash_to_bib hash
-=> {:id=>"ISO/TC211",
-...
+Relaton::Bib::Converter::BibXml.to_item xml
+ => #<Relaton::Bib::ItemData:0x000000011dc9fc98 ...
+----
 
-RelatonBib::BibliographicItem.new bib_hash
-=> #<RelatonBib::BibliographicItem:0x007ff1524f8c88
-...
+=== Create bibliographic item from XML
+[source,ruby]
 ----
+xml = File.read 'spec/fixtures/bibitem.xml'
+=> "<bibitem id=\"ISO1231994\" type=\"standard\" schema-version=\"1.0.0\">\n  <fetched>2022-05-02</fetched>\n  <forma..."
 
-=== Export bibliographic item to Hash
+item = Relaton::Bib::Bibitem.from_xml xml
+ => #<Relaton::Bib::ItemData:0x000000011d4b7580 ...
+
+xml = File.read 'spec/fixtures/bibdata.xml'
+item = Relaton::Bib::Bibdata.from_xml xml
+ => #<Relaton::Bib::ItemData:0x000000011d4daa08 ...
+----
+
+=== Create bibliographic item from BibTeX (@TODO: add support for BibTeX)
 
 [source,ruby]
 ----
-item.to_hash
-=> {"id"=>"ISOTC211",
- "title"=>
-  [{"type"=>"main", "content"=>"Geographic information", "language"=>"en", "script"=>"Latn", "format"=>"text/plain"},
-   {"content"=>"Information géographique", "language"=>"fr", "script"=>"Latn", "format"=>"text/plain"}],
+Relaton::Bib::BibtexParser.from_bibtex File.read('spec/fixtures/techreport.bib')
+=> {"ISOTC211"=>
+  #<Relaton::Bib::Item:0x007fedee0a2ab0
   ...
 ----
 
-=== Create bibliographic item from BibTeX
+=== Export bibliographic item to YAML
 
 [source,ruby]
 ----
-RelatonBib::BibtexParser.from_bibtex File.read('spec/examples/techreport.bib')
-=> {"ISOTC211"=>
-  #<RelatonBib::BibliographicItem:0x007fedee0a2ab0
-  ...
+item.to_yaml
+---
+type: standard
+schema_version: 1.0.0
+fetched: '2022-05-02'
+formattedref: ISO 123:1994
+...
+----
+
+=== Export bibliographic item to Hash
+
+[source,ruby]
+----
+item.to_h
+=> {"id"=>"ISO1231994",
+ "type"=>"standard",
+ "schema_version"=>"...",
+ "title"=>[...],
+ ...}
 ----
 
 === Export bibliographic item to BibTeX
@@ -399,29 +238,106 @@ RelatonBib::BibtexParser.from_bibtex File.read('spec/examples/techreport.bib')
 [source,ruby]
 ----
 item.to_bibtex
-@misc{ISOTC211,
-  tile = {Geographic information},
-  edition = {1},
-  author = {Bierman, A. and Bierman, Forename},
-  ...
+@misc{doe1994a,
+  title = {Geographic information -- Metadata},
+  author = {Doe, John},
+  edition = {First edition},
+  publisher = {International Organization for Standardization},
+  year = {1994},
+  month = {jan},
+  address = {Geneva, Switzerland, Geneva, Geneva},
+  pages = {1--10},
+  keywords = {information},
+  timestamp = {2022-05-02},
+  url = {https://www.iso.org/standard/22722.html},
+  doi = {10.1007/978-3-319-99155-2_1},
+  month_numeric = {1}
+}
 ----
 
-=== Exporting bibliographic item to AsciiBib
+=== Export bibliographic item to Citeproc (@TODO: add support for Citeproc)
+
+[source,ruby]
+----
+item.to_citeproc
+=> [{"title"=>"Geographic information",
+     "edition"=>"Edition 1",
+     "author"=>[{"family"=>"Bierman", "given"=>"A."}, {"family"=>"Bierman", "given"=>"Arnold"}, {"family"=>"Bierman", "given"=>"Arnold B"}],
+     "publisher"=>"Institute of Electrical and Electronics Engineers",
+     "publisher-place"=>"bib place",
+     ...
+----
+
+=== Exporting bibliographic item to AsciiBib (@TODO: add support for AsciiBib)
 
 [source,ruby]
 ----
 item.to_asciibib
-[%bibitem]
-== {blank}
-id:: ISOTC211
-fetched:: 2020-08-19
-title::
-title.type:: title-main
-title.conten:: Geographic information
-title.format:: text/plain
-...
+=> [%bibitem]
+   == {blank}
+   id:: ISOTC211
+   fetched:: 2022-05-02
+   title::
+   title.type:: title-main
+   title.content:: Geographic information
+   title.format:: text/plain
+   ...
 ----
 
+=== Export bibliographic item to RFC XML
+
+[source,ruby]
+----
+item.to_rfcxml
+<reference anchor="ISO 123:1994" target="https://www.iso.org/standard/22722.html">
+  <front>
+    <title>Geographic information -- Metadata</title>
+    <seriesInfo name="DOI" value="10.1007/978-3-319-99155-2_1"/>
+    <seriesInfo name="ISO 123" value="1"/>
+    <author initials="J.D." surname="Doe" fullname="Prof. John Doe PhD">
+      <organization>International Organization for Standardization</organization>
+      <address>
+        <postal>
+          <street>1, rue de Varembé</street>
+          <city>Geneva</city>
+          <code>1211</code>
+          <country>Switzerland</country>
+          <postalLine>1, rue de Varembé,&lt;br/&gt;Geneva, Switzerland, 1211</postalLine>
+        </postal>
+        <phone>+41 22 749 01 11</phone>
+        <email>jdoe@email.org</email>
+        <uri>https://orcid.org/0000-0002-1825-0097</uri>
+      </address>
+    </author>
+    <author>
+      <organization abbrev="ISO">International Organization for Standardization</organization>
+      <address>
+        <postal>
+          <street>1, rue de Varembé</street>
+          <city>Geneva</city>
+          <code>1211</code>
+          <country>Switzerland</country>
+          <postalLine>1, rue de Varembé,&lt;br/&gt;Geneva, Switzerland, 1211</postalLine>
+        </postal>
+        <phone>+41 22 749 01 11</phone>
+        <email>office@iso.org</email>
+        <uri>https://www.iso.org</uri>
+      </address>
+    </author>
+    <date day="01" month="January" year="1994"></date>
+    <workgroup>Geographic information</workgroup>
+    <keyword>information</keyword>
+    <abstract>
+      <t>This is an abstract. &lt;em&gt;This is emphasized&lt;/em&gt;</t>
+    </abstract>
+  </front>
+</reference>
+----
+
+=== Logging
+
+RelatonBib uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -435,4 +351,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/metano
 == License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "relaton_bib"
+require "relaton/bib"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.