diff --git a/.gitignore b/.gitignore index 2342764..c4b9cf8 100644 --- a/.gitignore +++ b/.gitignore @@ -16,5 +16,7 @@ node_modules public/logos/.vitepress/ TODO* .vscode +.opencode +.openpackage site.zip *.bak diff --git a/.lycheeignore b/.lycheeignore index 172d34c..c690c1a 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -13,3 +13,7 @@ https://linguistics.stackexchange.com/.* https://www.ifla.org/.* http://id.loc.gov/.* https://hdl.handle.net/.* +https://www.ieee.org/.* +https://ecma-international.org/.* +https://doi.org/10.24035/ijit.14.2018.001 +http://dx.doi.org/10.3334/ORNLDAAC/1321 diff --git a/.vitepress/config.ts b/.vitepress/config.ts index c8b2b3d..78ccdec 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -94,6 +94,7 @@ export default defineConfig({ text: 'Identification & Access', items: [ { text: 'Bibitem Types', link: '/model/bibtype' }, + { text: 'Specific Categories', link: '/model/specific-cats' }, { text: 'Identifiers', link: '/model/identifiers' }, { text: 'Location', link: '/model/location' }, { text: 'Additional Info', link: '/model/additional-info' }, diff --git a/404.html b/404.html deleted file mode 100644 index c472b4e..0000000 --- a/404.html +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default ---- - - - -
-

404

- -

Page not found :(

-

The requested page could not be found.

-
diff --git a/Gemfile b/Gemfile deleted file mode 100644 index b794a35..0000000 --- a/Gemfile +++ /dev/null @@ -1,16 +0,0 @@ -source "https://rubygems.org" - -gem "jekyll", "~> 4.3" - -# If you have any plugins, put them here! -group :jekyll_plugins do - gem "jekyll-theme-rop" -end - -# Windows does not include zoneinfo files, so bundle the tzinfo-data gem -gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] - -# Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.0" if Gem.win_platform? - -gem "webrick", "~> 1.7" diff --git a/Makefile b/Makefile deleted file mode 100644 index 75b0ac5..0000000 --- a/Makefile +++ /dev/null @@ -1,18 +0,0 @@ -SHELL := /bin/bash - -all: _site - -clean: - bundle exec jekyll clean - rm -rf _site _software/*/.git _software/*/docs _software/*/_*_repo _specs/relaton-model-diagrams parent-hub - -bundle: - bundle - -_site: - bundle exec jekyll build --trace - -serve: - bundle exec jekyll serve --trace - -.PHONY: bundle all open serve clean diff --git a/Rakefile b/Rakefile deleted file mode 100644 index f474433..0000000 --- a/Rakefile +++ /dev/null @@ -1,86 +0,0 @@ -require 'html-proofer' - -$sourceDir = "./source" -$outputDir = "./_site" -$testOpts = { - allow_hash_href: true, - assume_extension: true -} - -hostname = ENV['SITE_HOSTNAME'] -region = ENV['SITE_REGION'] - -task :default => ["serve:development"] - -desc "cleans the output directory" -task :clean do - sh "jekyll clean" -end - -namespace :deploy do - - desc "upload to S3" - task :s3upload => [] do - bucket = `aws s3api list-buckets --query "Buckets[?contains(Name, '#{hostname}')] | [0].Name" | jq -r '.'` - - p "Uploading to #{bucket} in #{region}" - - htmls = File.join("**", "*.html") - - # Remove extension from HTML files - Dir.glob(htmls, base: "_site") do |filename| - # Skip index.html - next if filename == "index.html" - - filename_noext = filename.sub('.html', '') - p "Will move #{filename} to #{filename_noext}" - FileUtils.mv(filename, filename_noext) - end - - p "Will upload non-HTML files" - sh %{ - aws s3 sync _site/ s3://#{bucket} --region #{region} --delete \ - --size-only --exclude "*" --include "*.*" - } - - p "Will upload HTML files" - sh %{ - aws s3 sync _site/ s3://#{bucket} --region #{region} --delete \ - --content-type "text/html; charset=utf-8" --exclude "*.*" - } - end -end - -namespace :build do - - desc "build development site" - task :development => [:clean] do - sh "jekyll build --drafts" - end - - desc "build production site" - task :production => [:clean] do - sh "JEKYLL_ENV=production jekyll build --config=_config.yml" - end -end - -namespace :serve do - - desc "serve development site" - task :development => [:clean] do - sh "jekyll serve --drafts" - end - - desc "serve production site" - task :production => [:clean] do - sh "JEKYLL_ENV=production jekyll serve --config=_config.yml" - end -end - -namespace :test do - - desc "test production build" - task :production => ["build:production"] do - HTMLProofer.check_directory($outputDir, $testOpts).run - end -end diff --git a/_asciibib_docs/nested.adoc b/_asciibib_docs/nested.adoc deleted file mode 100644 index 3efea4b..0000000 --- a/_asciibib_docs/nested.adoc +++ /dev/null @@ -1,394 +0,0 @@ ---- -title: AsciiBib -- Nested definition list syntax -description: Defining AsciiBib using nested lists -layout: asciibib-docs - -external_links: - - url: https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc ---- - -[[nested-syntax]] -== Purpose - -This AsciiBib syntax utilizes a definition list of element name and element contents, -with nested definition lists for nested structures. - -If a nested definition is given for an element, the element itself has a -blank definition. - -=== Basic attributes - -As with the link:/specs/relaton-yaml[Relaton YAML representation], -if an element in Relaton XML has attributes, -the content of the element is represented in YAML with a `content` key: - -[source,xml] ----- -Geographic information ----- - -[source,asciidoc] ----- -title:: -type::: main -content::: Geographic information ----- - - -=== Element arrays - -Similar to the link:/specs/relaton-yaml[Relaton YAML representation], -repeating elements in an object can be realised as ordered or unordered lists. - -[source,asciidoc] ----- -language:: -. en -. fr ----- - -EXAMPLE: - -[source,asciidoc] ----- -[[ISO-19115-1]] -[%bibitem] -== {blank} -docid:: -type::: ISO -id::: 19115-1 -language:: -. en -. fr ----- - -AsciiBib also supports representing repeating elements -by repeating the key for that entry. This will almost always be more -straightforward to use in AsciiDoc: - -[source,asciidoc] ----- -language:: en -language:: fr ----- - -EXAMPLE: - -[source,asciidoc] ----- -[[ISO-19115-1]] -[%bibitem] -== {blank} -docid:: -type::: ISO -id::: 19115-1 -language:: en -language:: fr ----- - -=== Hierarchical attributes - -Each Relaton entry in a bibliography is represented in Metanorma AsciiDoc -through a subclause with option attribute `[%bibitem]`. Any title given to the -subclause is treated as the title for the bibliographic entry, with language `en`, -script `Latn`, format `text/plain`, and type `main`. - -So the following is a very simple reference in Metanorma AsciiDoc: - -[source,asciidoc] ----- -[%bibitem] -== {blank} -id:: iso19115-3 -docid:: -type::: ISO -id::: 19115-3 -docid:: -type::: ISO -id::: TC211 -type:: standard ----- - - -=== Empty title - -A title in the heading will be automatically treated as the English title with type `main`. - -In the case where the bibliographic item is non-English, or not a `main` title (e.g. it only has an abbreviated or subtitle), -you should encode the title using attributes. - -Here, the subclause title should be left as `{blank}`, and the desired title should be given in the -content body: - -[source,asciidoc] ----- -[%bibitem] -== {blank} -id:: iso19115-3 -title:: -language::: fr -script::: Latn -format::: text/plain -type::: main -content::: Information géographique ----- - -Note the use of `content` as a key to represent the contents under the `title` tag. - - -=== Anchors - -The anchor crossreference for the bibliographic entry may be encoded as either the -`id` entry in the definition list, or as the normal AsciiDoc anchor on the -subclause, which takes priority: - -[source,asciidoc] ----- -[[ISO-19115-3]] -[%bibitem] -== {blank} -docid:: -type::: ISO -id::: 19115-3 -type:: standard ----- - - - -[[nesting-limitations]] -=== Nesting limitations and workarounds - -AsciiBib relies on basic AsciiDoc syntax, and is therefore subject -to its limitations. - -AsciiDoc does not recognise definition lists more than four levels -deep. If deeper nesting is needed, you will need to attach a new definition -list with a list continuation, with the definition list depth reset back to one: - -[source,asciidoc] ----- -[[ISO-19115-3]] -[%bibitem] -== {blank} -docid:: -type::: ISO -id::: 19115-3 -type:: standard -contributor:: -role::: author -person::: -name:::: -+ --- -completename:: -language::: en -content::: Fred --- ----- - -(This is very awkward, and link:/asciibib/path[AsciiBib path syntax] provides a workaround.) - - -The most heavily nested parts of a Relaton entry are the contributors, -series, and relations. - -Each of these can be marked up as subclauses within the entry, with the clause -titles `contributor`, `series`, and `relation`. Each subclause contains -a new definition list, with its definition list reset to zero depth; -the subclauses can be repeated for multiple instances of the same subentity. - -=== Metanorma-specific information - -In Metanorma, -AsciiBib citations can be combined with other AsciiDoc citations in the -same Metanorma document. However, AsciiDoc citations *MUST* precede AsciiBib citations. - -Each AsciiBib citations constitutes a subclause of its own, -and Metanorma will (unsuccessfully) attempt to incorporate any trailing material -in the subclause, including AsciiDoc citations, into the current AsciiBib -citation. - -The following is Metanorma AsciiDoc markup corresponding to the YAML -given in link:/specs/relaton-yaml[Relaton YAML representation]: - - -[source,asciidoc] ----- -[[ISO-19115-3]] -[%bibitem] -== {blank} -title:: -type::: main -content::: Geographic information -title:: -type::: subtitle -content::: Metadata -title:: -type::: parttitle -content::: Part 3: XML schema implementation for fundamental concepts -type:: standard -docid:: -type::: ISO -id::: 19115-3 -edition:: 1 -language:: en -script:: Latn -version:: -revision_date::: 2019-04-01 -draft::: draft -biblionote:: -type::: bibnote -content::: -+ --- -Paper format is not available for this standard. Only PDF. --- -docstatus:: -stage::: 90 -substage::: 90.92 -iteration::: iteration -date:: -type::: issued -value::: 2016 -date:: -type::: published -from::: 2016-06 -to::: 2016-08 -date:: -type::: accessed -value::: 2015-05-20 -abstract:: -content::: -+ --- -ISO/TS 19115-3:2016 defines an integrated XML implementation of ISO 19115‑1, ISO 19115‑2, and concepts from ISO/TS 19139 by defining the following artefacts ... --- -copyright:: -owner::: -name:::: International Organization for Standardization -abbreviation:::: ISO -url:::: www.iso.org -from::: 2016 -to::: 2020 -link:: -type::: src -content::: https://www.iso.org/standard/32579.html -link:: -type::: obp -content::: https://www.iso.org/obp/ui/#iso:std:iso:ts:19115:-3:ed-1:v1:en - - -=== Contributor - -organization:: -name::: International Organization for Standardization -url::: www.iso.org -abbreviation::: ISO -role:: -type::: publisher -description::: Publisher role - -=== Contributor -person:: -name::: -completename:::: -+ --- -content:: A. Bierman -language:: en --- -affiliation::: -organization:::: -+ --- -name:: ISO -abbreviation:: ISO -identifier:: -type::: uri -id::: www.iso.org --- -description:::: Affiliation description -contact::: -street:::: 8 Street St -city:::: City -postcode:::: 123456 -country:::: Country -state:::: State -contact::: -type:::: phone -value:::: +1 800-000-0000 -role:: author - -=== Contributor -organization:: -name::: IETF -abbreviation::: IETF -identifier::: -type:::: uri -id:::: www.ietf.org -role:: publisher - -=== Contributor -person:: -name::: -language:::: en -initial:::: A. -surname:::: Bierman -affiliation::: -+ --- -organization:: -name::: IETF -abbreviation::: IETF -description:: -content::: Affiliation description -language::: en -script::: Latn --- -identifier::: -type:::: uri -id:::: www.person.com -role:: author - -=== Relation -type:: updates -bibitem:: -formattedref::: ISO 19115:2003 -bib_locality::: -type:::: page -reference_from:::: 7 -reference_to:::: 10 - -=== Relation -type:: updates -bibitem:: -type::: standard -formattedref::: ISO 19115:2003/Cor 1:2006 - -=== Series -type:: main -title:: -type::: original -content::: ISO/IEC FDIS 10118-3 -language::: en -script::: Latn -format::: text/plain -place:: Serie's place -organization:: Serie's organization -abbreviation:: -content::: ABVR -language::: en -script::: Latn -from:: 2009-02-01 -to:: 2010-12-20 -number:: serie1234 -partnumber:: part5678 - -=== Series -type:: alt -formattedref:: -content::: serieref -language::: en -script::: Latn ----- - diff --git a/_asciibib_docs/path.adoc b/_asciibib_docs/path.adoc deleted file mode 100644 index 5214d48..0000000 --- a/_asciibib_docs/path.adoc +++ /dev/null @@ -1,287 +0,0 @@ ---- -title: AsciiBib -- Path style definition lists -description: Defining AsciiBib using definition list paths -layout: asciibib-docs - -external_links: - - url: https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc ---- - -[[JSONPath]] -== Purpose - -The AsciiBib "`path-style definition list`" syntax allows you to -represent: - -* the nested structure of Relaton records in a simple, one-level definition list; and -* to use the key for each key-value pair to represent the hierarchical nesting of entries, -as a dot-delimited path of keys. - -This is similar to how JSON data is often accessed. - -This syntax utilizes the structure of link:/specs/relaton-yaml[Relaton YAML representation]. - -NOTE: The link:/asciibib/path[AsciiBib nested list syntax] requires -frequent breakouts into open blocks, to deal with limitations of AsciiDoc. - - - -=== Basic entry - -[source,asciidoc] ----- -[%bibitem] -== {blank} -id:: iso19115 -docid.type:: ISO -docid.id:: 19115-1 ----- - -Is equivalent to the link:/asciibib/path[AsciiBib nested list syntax] of: - -[source,asciidoc] ----- -[%bibitem] -== {blank} -id:: iso19115 -docid:: - type::: ISO - id::: 19115-1 ----- - - -=== Element arrays - -Whenever part of the key is repeated between entries, the entries are assumed to attach to the same parent. If an array of objects is needed, a blank entry is required for the key of each repeating element. - -For example, - -[source,asciidoc] ----- -[%bibitem] -== {blank} -id:: iso19115 -docid:: -docid.type:: ISO -docid.id:: 19115-1 -docid:: -docid.type:: ISO -docid.id:: TC211 ----- - -Is equivalent to the link:/asciibib[AsciiBib nested list syntax] of: - -[source,asciidoc] ----- -[%bibitem] -== {blank} -id:: iso19115 -docid:: - type::: ISO - id::: 19115-1 -docid:: - type::: ISO - id::: TC211 ----- - -Embedded elements can also repeat. - -[source,asciidoc] ----- -[%bibitem] -... -contributor.person.contact:: -contributor.person.contact.phone:: 223322 -contributor.person.contact.type:: mobile -contributor.person.contact:: -contributor.person.contact.phone:: 332233 -contributor.person.contact.type:: work ----- - -Is equivalent to the link:/asciibib[AsciiBib nested list syntax] of: - -[source,asciidoc] ----- -[%bibitem] -... -=== Contributor -person:: - contact::: - phone:::: 223322 - type:::: mobile - contact::: - phone:::: 332233 - type:::: work ----- - - -=== Metanorma-specific information - -The following is Metanorma AsciiDoc markup corresponding to the YAML -given above, using path style syntax instead of nested definition list syntax: - -[source,asciidoc] ----- -[[ISO-19115-1]] -[%bibitem] -== {blank} -id:: ISO/TC211 -fetched:: 2019-06-30 -title:: -title.type:: main -title.content:: Geographic information -title:: -title.type:: subtitle -title.content:: Metadata -title:: -title.type:: parttitle -title.content:: Part 1: Fundamentals -title.language:: en -title.script:: Latn -title.format:: text/plain -type:: standard -docid.type:: ISO -docid.id:: ISO19115-1 -docnumber:: 19115-1 -edition.content:: 1 -language:: en -language:: fr -script:: Latn -version.revision_date:: 2019-04-01 -version.draft:: draft -biblionote.type:: bibnote -biblionote.content:: -+ --- -Paper format is not available for this standard. Only PDF and EPUB. --- -docstatus.stage:: 90 -docstatus.substage:: 90.93 -docstatus.iteration:: iteration -date:: -date.type:: issued -date.value:: 2014 -date:: -date.type:: published -date.from:: 2014-04 -date.to:: 2014-05 -date:: -date.type:: accessed -date.value:: 2015-05-20 -abstract:: -abstract.content:: -+ --- -ISO 19115-1:2014 defines the schema required for describing geographic information and services by means of metadata. It provides information ... --- -abstract:: -abstract.content:: -+ --- -L'ISO 19115-1:2014 définit le schéma requis pour décrire des informations géographiques et des services au moyen de métadonnées. Elle fournit des informations ... --- -abstract.language:: fr -abstract.script:: Latn -abstract.format:: text/plain -copyright.owner.name:: International Organization for Standardization -copyright.owner.abbreviation:: ISO -copyright.owner.url:: www.iso.org -copyright.from:: 2014 -copyright.to:: 2020 -link:: -link.type:: src -link.content:: https://www.iso.org/standard/53798.html -link:: -link.type:: obp -link.content:: https://www.iso.org/obp/ui/#!iso:std:53798:en -link:: -link.type:: rss -link.content:: https://www.iso.org/contents/data/standard/05/37/53798.detail.rss -medium:: -medium.form:: medium form -medium.size:: medium size -medium.scale:: medium scale -place:: bib place -extent.locality.type:: section -extent.locality.reference_from:: 7 -accesslocation:: accesslocation1 -accesslocation:: accesslocation2 -classification.type:: type -classification.value:: value -validity.begins:: 2010-10-10 12:21 -validity.ends:: 2011-02-03 18:30 -contributor:: -contributor.organization.name:: International Organization for Standardization -contributor.organization.url:: www.iso.org -contributor.organization.abbreviation:: ISO -contributor.organization.subdivision:: division -contributor.role.type:: publisher -contributor.role.description:: Publisher role -contributor:: -contributor.person.name.completename.content:: A. Bierman -contributor.person.name.completename.language:: en -contributor.person.affiliation.organization.name:: IETF -contributor.person.affiliation.organization.abbreviation:: IETF -contributor.person.affiliation.organization.identifier.type:: uri -contributor.person.affiliation.organization.identifier.id:: www.ietf.org -contributor.person.affiliation.description:: Affiliation description -contributor.person.address.street:: 8 Street St -contributor.person.address.city:: City -contributor.person.address.postcode:: 123456 -contributor.person.address.country:: Country -contributor.person.address.state:: State -contributor.person.contact.phone:: 223322 -contributor.person.contact.type:: mobile -contributor.role:: author -contributor:: -contributor.organization.name:: IETF -contributor.organization.abbreviation:: IETF -contributor.organization.identifier.type:: uri -contributor.organization.identifier.id:: www.ietf.org -contributor.role:: publisher -contributor:: -contributor.person.name.language:: en -contributor.person.name.initial:: A. -contributor.person.name.surname:: Bierman -contributor.person.affiliation.organization.name:: IETF -contributor.person.affiliation.organization.abbreviation:: IETF -contributor.person.affiliation.description.content:: Affiliation description -contributor.person.affiliation.description.language:: en -contributor.person.affiliation.description.script:: Latn -contributor.person.identifier.type:: uri -contributor.person.identifier.id:: www.person.com -contributor.role:: author -relation:: -relation.type:: updates -relation.bibitem.formattedref:: ISO 19115:2003 -relation.bibitem.bib_locality.type:: page -relation.bibitem.bib_locality.reference_from:: 7 -relation.bibitem.bib_locality.reference_to:: 10 -relation:: -relation.type:: updates -relation.bibitem.type:: standard -relation.bibitem.formattedref:: ISO 19115:2003/Cor 1:2006 -series:: -series.type:: main -series.title.type:: original -series.title.content:: ISO/IEC FDIS 10118-3 -series.title.language:: en -series.title.script:: Latn -series.title.format:: text/plain -series.place:: Serie's place -series.organization:: Serie's organization -series.abbreviation.content:: ABVR -series.abbreviation.language:: en -series.abbreviation.script:: Latn -series.from:: 2009-02-01 -series.to:: 2010-12-20 -series.number:: serie1234 -series.partnumber:: part5678 -series:: -series.type:: alt -series.formattedref.content:: serieref -series.formattedref.language:: en -series.formattedref.script:: Latn -keyword:: Keyword -keyword:: Key Word ----- diff --git a/_cite_docs/3gpp.adoc b/_cite_docs/3gpp.adoc deleted file mode 100644 index 5324322..0000000 --- a/_cite_docs/3gpp.adoc +++ /dev/null @@ -1,255 +0,0 @@ ---- -title: Citation guide for 3GPP standards -flavor: 3GPP -description: Cite 3GPP standards -layout: cite-docs ---- - -== General - -To cite a 3GPP standard in your document, use document identifiers as citation -keys. - -3GPP identifiers start with the `3GPP` prefix. - - -== Document types - -=== Technical Report - -`TR` - -[example] -`3GPP TR 01.00:R98/7.1.0` - -=== Technical Specification - -`TS` - -[example] -`3GPP TS 01.01:Ph1/3.0.0` - - -== Specification number - -* `00` - General information - -[example] -`3GPP TR 00.01U:UMTS/3.0.0` - -* `01` - Requirements - -[example] -`3GPP TR 01.00:Ph2/0.0.0` - -* `02` - Service aspects (stage 1) - -[example] -`3GPP TR 02.08:Ph1/0.1.0` - -* `03` - Technical realization (stage 2) - -[example] -`3GPP TR 03.01U:UMTS/0.8.0` - -* `04` - Signalling protocols (stage 3) - user equipment to network - -[example] -`3GPP TS 04.01:Ph1/3.0.1` - -* `05` - GSM radio aspects - -[example] -`3GPP TR 05.01U:UMTS/2.0.0` - -* `06` - CODECs - -[example] -`3GPP TR 06.01U:UMTS/3.0.0` - -* `07` - Data - -[example] -`3GPP TS 07.01:Ph1/3.2.0` - -* `08` - Signalling protocols (stage 3) - (RSS-CN) - -[example] -`3GPP TS 08.01:Ph1/3.0.1` - -* `09` - Signalling protocols (stage 3) - (infra-fixed-network) - -[example] -`3GPP TR 09.01:Ph1/3.0.1` - -* `10` - Programme management - -[example] -`3GPP TR 10.01:R97/0.0.2` - -* `11` - Subscriber Identity Module - -[example] -`3GPP TR 11.15:R97/1.0.0` - -* `12` - OAM&P and Charging - -[example] -`3GPP TR 12.01U:UMTS/3.0.0` - -* `13` - Access requirements and test specifications - -[example] -`3GPP TS 13.01:Ph2/4.0.0` - -* `21` - Requirements - -[example] -`3GPP TR 12.01U:UMTS/3.0.0` - -* `22` - Service aspects - -[example] -`3GPP TR 22.07U:UMTS/3.0.0` - -* `23` - Technical realization - -[example] -`3GPP TR 23.039:R99/1.0.0` - -* `24` - Signalling protocols (stage 3) - user equipment to network - -[example] -`3GPP TR 24.801:Rel-8/0.0.0` - -* `25` - UTRA radio aspects - -[example] -`3GPP TR 25.700:Rel-12/0.0.1` - -* `26` - CODECs - -[example] -`3GPP TR 26.078:Rel-4/4.0.0` - -* `27` - Data - -[example] -`3GPP TR 27.00U:UMTS/1.2.1` - -* `28` - Signalling protocols (stage 3) - (RSS-CN) and OAM&P and Charging (overflow from 32-range) - -[example] -`3GPP TR 28.800:Rel-14/0.0.0` - -* `29` - Signalling protocols (stage 3) - (infra-fixed-network) - -[example] -`3GPP TR 29.800:Rel-7/0.1.0` - -* `30` - Programme management - -[example] -`3GPP TR 30.00U:UMTS/3.0.0` - -* `31` - Subscriber Identity Module (SIM/USIM), IC Cards. Test specs. - -[example] -`3GPP TR 31.801:Rel-15/1.0.0` - -* `32` - OAM&P and Charging - -[example] -`3GPP TR 32.01U:UMTS/1.0.0` - -* `33` - Security aspects - -[example] -`3GPP TR 33.20U:UMTS/3.0.0` - -* `34` - UE and (U)SIM test specifications - -[example] -`3GPP TR 34.901:R99/2.0.0` - -* `35` - Security algorithms - -[example] -`3GPP TR 35.909:Rel-4/4.0.0` - -* `36` - LTE (Evolved UTRA) and LTE-Advanced radio aspects - -[example] -`3GPP TR 36.276:Rel-16/0.0.1` - -* `37` - Multiple radio access technology aspects - -[example] -`3GPP TR 37.716-00-00:Rel-16/0.0.1` - -* `38` - Radio technology beyond LTE - -[example] -`3GPP TR 38.716-01-01:Rel-16/0.0.1` - -* `41` - Requirements - -[example] -`3GPP TR 41.031:Rel-4/4.0.0` - -* `42` - Service aspects (stage 1) - -[example] -`3GPP TS 42.009:Rel-4/4.0.0` - -* `43` - Technical realization (stage 2) - -[example] -`3GPP TS 43.005:Rel-8/8.0.0` - -* `44` - Signalling protocols (user equipment to network) - -[example] -`3GPP TS 44.001:Rel-4/4.0.0` - -* `45` - GSM radio aspects - -[example] -`3GPP TS 45.001:Rel-4/4.0.0` - -* `46` - CODECs - -[example] -`3GPP TS 46.001:Rel-4/4.0.0` - -* `47` - Data - -* `48` - Signalling protocols (RSS-CN) - -[example] -`3GPP TS 48.008:Rel-4/4.6.0` - -* `49` - Signalling protocols (infra-fixed-network) - -[example] -`3GPP TR 49.001:Rel-4/4.0.0` - -* `50` - Programme management - -[example] -`3GPP TR 50.059:Rel-4/4.0.0` - -* `51` - Subscriber Identity Module - -[example] -`3GPP TS 51.011:Rel-4/4.0.0` - -* `52` - O&M - -[example] -`3GPP TS 52.008:Rel-6/0.1.2` - -* `55` - Security algorithms - -[example] -`3GPP TR 55.919:R99/3.0.0` diff --git a/_cite_docs/bipm.adoc b/_cite_docs/bipm.adoc deleted file mode 100644 index a991311..0000000 --- a/_cite_docs/bipm.adoc +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: Citation guide for BIPM resources -flavor: BIPM -description: Cite BIPM Metrologia, SI Brochure, and Outcomes -layout: cite-docs ---- - -== SI Brochure - -* The International System of Units (SI) - -[example] -`BIPM SI Brochure` - -* Historical notes on the development of the International System of Units - -[example] -`BIPM SI Brochure, Appendix 4` - -== Metrologia - -Use the following format to cite Metrologia articles: - -`BIPM Metrologia {JOURNAL} {VOLUME} {ISSUE}` - -- `{JOURNAL}` - journal number, optional -- `{VOLUME}` - volume number, optional -- `{ISSUE}` - issue number, optional - -Examples: - -[example] ----- -BIPM Metrologia -BIPM Metrologia 15 -BIPM Metrologia 55 5 ----- - -== Outcomes - -=== Basic pattern - -[example] ----- -Long: -{group name} -- {type} {number} ({year}) -{group name} {type} {number} ({year}) -{group name} {type} {year}-{zero_leading_number} - -Short: -{group name} -- {type-abbrev} {number} ({year}, {lang}) -{group name} {type-abbrev} {number} ({year}, {lang}) ----- - -- `group name` - a name of the group, required. A full list of group names is available https://github.com/metanorma/bipm-editor-guides/blob/main/sources/bipm-references-en.adoc#appendix-a-bipm-groups-and-codes[here]. - -- `type` - type of document, required. A list of types is: Resolution (Résolution), Recommendation (Recommandation), Decision (Décision), Meeting (Réunion), Declaration (Déclaration). - -- `type-abbrev` - abbreviation of the type, required. A list of abbreviations: RES (Resolution), REC (Recommendation), DECN (Decision). - -- `number` - number of the document, optional. Can be with part, e.g. `1-2`. - -- `zero_leading_number` - number of the document with a leading zero, required. Can be used when a document has a 1 or 2 digits number. It's `00` for documents without a number. - -- `year` - year of the document, optional. - -- `lang` - language of the document, optional. Can be `EN` or `FR`. - -=== Special case pattern - -The basic pattern works fine for all, except for these 2 cases: - -- Decisions of the CIPM (since 2012) -- Recommendations/Resolutions/Decisions of the JCRB - -Where the committee name is part of the outcome identifier. - -Special cases: - -[example] ----- -Decision CIPM/111-10 (2022) / Décision CIPM/111-10 (2022) -Recommendation JCRB/43-1 (2021) / Recommandation JCRB/43-1 (2021) ----- - -=== Single language version (English) - -`type` can be: - -- Resolution (RES) -- Recommendation (REC) -- Decision (DECN) -- Statement (DECL) - -e.g. - -[example] ----- -CCTF -- Recommendation 2 (1970) -CCTF -- REC 2 (1970, EN) ----- - -Special cases: - -[example] ----- -Decision CIPM/111-10 (2022) -CIPM DECN CIPM/111-10 (2022, EN) -Recommendation JCRB/43-1 (2021) -JCRB REC JCRB/43-1 (2021, EN) ----- - -=== Single language version (French) - -`type` can be: - -- Résolution (RES) -- Recommandation (REC) -- Décision (DECN) -- Déclaration (DECL) - -e.g. - -[example] ----- -CCTF -- Recommandation 2 (1970) -CCTF -- REC 2 (1970, FR) ----- - -Special cases: - -[example] ----- -Décision CIPM/111-10 (2022) -CIPM DECN CIPM/111-10 (2022, FR) -Recommandation JCRB/43-1 (2021) -JCRB REC JCRB/43-1 (2021, FR) ----- - -=== Dual language version (language independent version) - -`type` can be in their respective languages or the following abbreviations: - -- RES -- REC -- DECN -- DECL - -[example] ----- -CCTF -- Recommandation 2 (1970) / Recommendation 2 (1970) -CCTF REC 2 (1970) ----- - -Special cases: - -[example] ----- -Decision CIPM/110-10 (2022) / Décision CIPM/111-10 (2022) -CIPM DECN CIPM/110-10 (2022) -Recommendation JCRB/43-1 (2021) / Recommandation JCRB/43-1 (2021) -JCRB REC JCRB/43-1 (2021) ----- diff --git a/_cite_docs/bsi.adoc b/_cite_docs/bsi.adoc deleted file mode 100644 index fd7d7e5..0000000 --- a/_cite_docs/bsi.adoc +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Citation guide for BSI resources -flavor: British Standards Institution (BSI) -description: Cite British Standards Institution (BSI) documents -layout: cite-docs ---- - -== British Standards - -=== General - -[source] ----- -BS {number} ----- - -=== Adoptions - -BS EN - -[example] -`BS EN 13445-3:2021` - -BS ISO, BS IEC - -[example] ----- -BS ISO 10976:2023 - TC -BS IEC 63190:2023 ----- - -BS EN ISO, BS EN IEC, BS EN ISO/IEC - -[example] ----- -BS EN ISO 16315:2016 -BS EN IEC 60904-2:2023 - TC -BS EN ISO/IEC 80079-34:2020 - TC ----- - - -== Published Documents - -=== General - -[source] ----- -PD {number} ----- - -=== Adoptions - -* PD CEN TR - -[example] -`PD CEN/TR 17994:2023` - -* PD IEC TR - -[example] -`PD IEC TR 63434:2023` - -* PD ISO PAS, PD ISO TR - -[example] ----- -PD ISO/PAS 11585:2023 -PD ISO/TR 18588:2023 ----- - -== Publicly Available Specifications - -PAS - -[example] -`PAS 2030:2023` - -== Flex - -[example] -`BSI Flex 1903 v1.0:2023-08` - -== Amendments - -[example] -`BS 7273-4:2015+A1:2021` - -== Expert Commentary - -[example] -`BS EN ISO 13485:2016+A11:2021 EC` diff --git a/_cite_docs/calconnect.adoc b/_cite_docs/calconnect.adoc deleted file mode 100644 index 4d5ee21..0000000 --- a/_cite_docs/calconnect.adoc +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Citation guide for CalConnect standards -flavor: CalConnect -description: Cite CalConnect standards -layout: cite-docs ---- - -CalConnect standards are available at https://standards.calconnect.org. - -== Prefix - -The Relaton CalConnect plugin accepts the prefix `CC`: - -[example] -`CC 18012:2018` - -== Copublishers - -* `IETF` - Internet Engineering Task Force - -[example] -`CC/IETF 6321:2009` - -* `ISO` - International Organization for Standardization - -[example] -`CC/ISO/AWI 34300` - -== Types - -* `A`, `Adm` - Administrative - -[example] ----- -CC/A 1602:2016 -CC/Adm 0401:2004 ----- - -* `DIR` - Directory - -[example] -`CC/DIR 10001:2019` - -* `R` - Report - -[example] -`CC/R 0510:2005` - -* `Adv` - Advisory - -[example] -`CC/Adv 0514:2005` - -* `S` - Specification - -[example] -`CC/S 0505:2005` - -* Without any of the above types - standard - -[example] -`CC 18012:2018` - -== Stages - -* `WD` - Working Draft - -[example] -`CC/WD 19160-6:2019` - -* `FDS` - Final Draft Standard - -[example] -`CC/FDS 10010:2019` - -* `CD` - Committee Draft - -[example] -`CC/CD 51003:2018` diff --git a/_cite_docs/ccsds.adoc b/_cite_docs/ccsds.adoc deleted file mode 100644 index 7f2fc68..0000000 --- a/_cite_docs/ccsds.adoc +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Citation guide for CCSDS standards -flavor: CCSDS -description: Cite CCSDS standards -layout: cite-docs ---- - -CCSDS standards are available at https://public.ccsds.org/Publications/AllPubs.aspx[CCSDS]. - -== Prefix - -The prefix for CCSDS standards is `CCSDS` - -[example] -`CCSDS 100.0-G-1` - -== Books - -* `B` - Blue. Recommended Standards - -[example] -`CCSDS 101.0-B-1` - -* `M` - Magenta. Recommended Practices - -[example] -`CCSDS 131.4-M-1` - -* `G` - Green. Information Reports - -[example] -`CCSDS 100.0-G-1` - -* `O` - Orange. Experimental - -[example] -`CCSDS 131.1-O-1` - -* `Y` - Yellow. Record - -[example] -`CCSDS 313.0-Y-1` - -* `S` - Silver. Historical. Obsolete documents. Any of above mentioned document types can be obsoleted - -[example] ----- -CCSDS 100.0-G-1-S -CCSDS 101.0-B-1-S ----- diff --git a/_cite_docs/cen.adoc b/_cite_docs/cen.adoc deleted file mode 100644 index 4bfadbd..0000000 --- a/_cite_docs/cen.adoc +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Citation guide for CEN and EN standards -flavor: CEN/CENELEC -description: Cite CEN and EN standards -layout: cite-docs ---- - -== Prefixes - -* `CEN` - European Committee for Standardization - -[example] -`CEN/TR 15214-1:2006` - -* `EN` - European Standard - -[example] -`EN 2100:1992` - -* `ENV` - European Prestandard - -[example] -`ENV 1613:1995` - -* `CWA` - CEN Workshop Agreement - -[example] -`CWA 14050-21:2000` - -* `HD` - Harmonization Document - -[example] -`HD 1215-2:1988` - -* `CR` - CEN Report - -[example] -`CR 12101-5:2000` - -== Copublishers - -* `ISO` - International Organization for Standardization - -[example] -`EN ISO 1833-10:2019` - -* `IEC` - International Electrotechnical Commission - -[example] ----- -EN IEC 60076-22-8:2021 -EN ISO/IEC 10373:1995 ----- - -* `ISP` - International Standard Profiles - -[example] -`EN ISP 10607-1:1993` - -== Types - -* `TR` - Technical Report - -[example] -`CEN/TR 15214-1:2006` - -* `TS` - Technical Specification - -[example] ----- -CEN/TS 12007-6:2021 -CEN ISO/TS 12180-1:2007 ----- diff --git a/_cite_docs/cie.adoc b/_cite_docs/cie.adoc deleted file mode 100644 index dd19599..0000000 --- a/_cite_docs/cie.adoc +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Citation guide for CIE standards -flavor: CIE -description: Cite CIE standards -layout: cite-docs ---- - -== Prefix - -The prefix for the CIE standards is `CIE`. - -== Copublishers - -`ISO` - International Organization for Standardization - -[example] -`CIE ISO 11664-5:2016` diff --git a/_cite_docs/doi.adoc b/_cite_docs/doi.adoc deleted file mode 100644 index cd852f9..0000000 --- a/_cite_docs/doi.adoc +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Citation guide for Digital Object Identifiers (DOI) -flavor: Digital Object Identifiers (DOI) -description: Cite standard metadata from CrossRef.org using DOI identifiers -layout: cite-docs ---- - -To cite a standard use DOI (Digital Object Identifier) prefixed with "doi:". Fot -example, to cite "10.6028/nist.ir.8245" use: - -[example] ----- -doi:10.6028/nist.ir.8245 ----- - -To collect metadata the relaton-doi gem makes a few requests to the CrossRef API. It may take a few seconds to get the metadata. diff --git a/_cite_docs/ecma.adoc b/_cite_docs/ecma.adoc deleted file mode 100644 index f927bc7..0000000 --- a/_cite_docs/ecma.adoc +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Citation guide for Ecma standards and publications -flavor: Ecma International -description: Cite Ecma standards and publications -layout: cite-docs ---- - -Ecma publishes the following types of content that can be cited: - -* Standards -* Technical Reports -* Mementos - -== Standards - -Format: `ECMA-` - -[example] -`ECMA-262` is the standard for the "ECMAScript language specification". - -== Technical Reports - -Format: `ECMA TR/` - -[example] -`ECMA TR/104` is the technical report for the "ECMAScript test suite". - -== Mementos - -Format: `ECMA MEM/` - -[example] -`ECMA MEM/2023` is the memento for the "Memento 2023". diff --git a/_cite_docs/gb.adoc b/_cite_docs/gb.adoc deleted file mode 100644 index ce1960f..0000000 --- a/_cite_docs/gb.adoc +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Citation guide for Chinese standards -flavor: Chinese standards (GB etc.) -description: Cite Chinese National, Regional, Local and Industry standards -layout: cite-docs ---- - -* `GB` is the prefix for Chinese standards - -[example] -`GB 2024-2016` - -* `GB/T` is the prefix for Chinese recommended standards - -[example] -`GB/T 32843-2016` diff --git a/_cite_docs/iana.adoc b/_cite_docs/iana.adoc deleted file mode 100644 index a6eb0c5..0000000 --- a/_cite_docs/iana.adoc +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Citation guide for IANA resources -flavor: IANA -description: Cite IANA registries and registry entries -layout: cite-docs ---- - -To cite an IANA document, use the `IANA` prefix and the document identifier: - -[example] ----- -IANA alto-protocol/address-types -IANA babel -IANA c-dns/c-dns-address-event-types -IANA dhcpv6-parameters/dhcpv6-options-attribute ----- diff --git a/_cite_docs/iec.adoc b/_cite_docs/iec.adoc deleted file mode 100644 index 6f8b019..0000000 --- a/_cite_docs/iec.adoc +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Citation guide for IEC publications -flavor: IEC -description: Cite IEC standards -layout: cite-docs ---- - -== Prefixes - -* `IEC` - International Electrotechnical Commission - -[example] -`IEC 31010:2019` - -* `CISPR` - International Special Committee on Radio Interference - -[example] -`CISPR 1:1961` - -== Types - -* `TS` - Technical Specification - -[example] -`IEC TS 60514:1975` - -* `TR` - Technical Report - -[example] ----- -CISPR TR 16-3:2010 -IEC TR 60787:2007 ----- - -* `PAS` - Publicly Available Specification - -[example] -`IEC PAS 60027-6:2004` - -* Withouth type - International Standard - -[example] -`IEC 31010:2019` - -== Parts - -Some standards are published in parts. To cite a specific part of a standard, use an ID with `part`. For example, to cite part 1 of `IEC 61326` use: - -[example] -`IEC 61326-1` - -The `all parts` option is supported for IEC standards. For example, to cite all parts of `IEC 61326` use: - -[example] -`IEC 61326 (all parts)` - -== Year - -The year is optional. If not provided, the current year will be used. For example, to cite `IEC 61332` from 1995 use: - -[example] -`IEC 61332:1995` - -To cite `IEC 61332` from the current (2016) year use: - -[example] -`IEC 61332` diff --git a/_cite_docs/ieee.adoc b/_cite_docs/ieee.adoc deleted file mode 100644 index 7c40316..0000000 --- a/_cite_docs/ieee.adoc +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Citation guide for IEEE Standards Association standards and publications -flavor: IEEE-SA -description: Cite IEEE-SA standards and publications -layout: cite-docs ---- - -== Prefixes - -* `IEEE` - IEEE standards - -[example] -`IEEE 1-1969` - -* `ANSI/IEEE` - IEEE standards - -[example] -`ANSI/IEEE C57.110-1986` - -* `ANSI` - American National Standard - -[example] -`ANSI N42.4-1971` - -* `AIEE` - American Institute of Electrical Engineers - -[example] -`AIEE 955-1962` - -* `ASA` - American Standards Association - -[example] -`ASA C16.31-1959` - -* `IRE` - Institute of Radio Engineers - -[example] -`IRE 7.S2-1962` - -== Copublishers - -* `ASTM` - American Society for Testing and Materials - -[example] -`IEEE/ASTM PSI 10/D-2-2015` - -* `CSA` - Canadian Standards Association - -[example] -`IEEE/CSA P844.1/293.1/D-2-2016-09` - -* `EIA` - Electronic Industries Alliance - -[example] -`IEEE/EIA 12207.0-1996` - -* `IEC` - International Electrotechnical Commission - -[example] -`IEEE/IEC P60076.57-129_FDIS-2017-07` - -* `ISO` - International Organization for Standardization - -[example] -`IEEE/ISO/IEC 8802.1Q/Amd1-2020` - -* `NACE` - National Association of Corrosion Engineers - -[example] ----- -NACE SP0215-2015 -NACE/IEEE P1835/D-1a-2011 ----- - -== Status - -* `CD` - Committee Draft - -[example] ----- -IEEE CD P16085-2018-02 -IEEE CD2 P15026.4-2018-02 ----- - -* `DIS` - Draft International Standard - -[example] -`IEEE DIS P15026™-2015` - -* `FCD` - Final Committee Draft - -[example] -`IEEE FCD P15026.3-2010-12` - -* `FDIS` - Final Draft International Standard - -[example] -`IEEE FDIS P15026.2-2010-08` diff --git a/_cite_docs/ietf.adoc b/_cite_docs/ietf.adoc deleted file mode 100644 index 83d5838..0000000 --- a/_cite_docs/ietf.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Citation guide for IETF publications -flavor: IETF -description: Cite IETF RFCs, BCPs and Internet-Drafts -layout: cite-docs ---- - -== RFC: Request for Comments - -`RFC` - -[example] -`RFC 1` - -== BCP: Best Current Practice - -`BCP` - -[example] -`BCP 3` - -== FYI: For Your Information - -`FYI` - -[example] -`FYI 2` - -== STD: Internet Standard - -`STD` - -[example] -`STD 3` - - -== Internet-Draft - -`I-D` - -[example] -`I-D draft-abarth-cake-01` - - -== Additional information - -The additional `IETF` prefix can be used to cite IETF documents: - -[example] ----- -IETF RFC 1 -IETF BCP 3 -IETF FYI 2 -IETF STD 3 -IETF I-D draft-abarth-cake-01 ----- diff --git a/_cite_docs/iho.adoc b/_cite_docs/iho.adoc deleted file mode 100644 index f4062c5..0000000 --- a/_cite_docs/iho.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Citation guide for IHO publications -flavor: IHO -description: Cite IHO standards -layout: cite-docs ---- - -== Prefix - -The prefix `IHO` identifies it as an IHO document. - -[example] -`IHO B-4` - -== Edition - -Some IHO standards have multiple editions: - -[example] -[source] ----- -IHO S-100 1.0.0 -IHO S-100 2.0.0 ----- - - -== Volume - -Some IHO standards have multiple volumes: - -[example] -[source] ----- -IHO P-1/21 -IHO P-1/22 ----- - -== Annex - -[example] -[source] ----- -IHO S-65AnnexA 1.0.0 ----- diff --git a/_cite_docs/isbn.adoc b/_cite_docs/isbn.adoc deleted file mode 100644 index fb41780..0000000 --- a/_cite_docs/isbn.adoc +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Citation guide for ISBN publications -flavor: ISBN -description: Cite ISBN publications -layout: cite-docs ---- - -== Prefix - -The prefix for ISBN publications is `ISBN` - -[example] -`ISBN 978-0-12-064481-0` - -== Number format - -ISBN number can be ISBN-10 or ISBN-13. Hyphens are optional. - -[example] -[sources] ----- -ISBN 978-0-12-064481-0 -ISBN 9780120644810 -ISBN 0120644819 ----- diff --git a/_cite_docs/iso.adoc b/_cite_docs/iso.adoc deleted file mode 100644 index 9388960..0000000 --- a/_cite_docs/iso.adoc +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Citation guide for ISO publications -flavor: ISO -description: Cite ISO standards -layout: cite-docs ---- - - -== General - -To cite an ISO Standard, you can use identifiers as the citation key. - -The identifiers start with the publisher abbreviation `ISO`: - -[example] -[source] ----- -ISO 690:2010 ----- - -== Dated and undated references - -If you need to cite a specific year of an ISO Standard, use identifiers with the year: - ----- -ISO 690-2:1997 ----- - -Without the year, the latest version of the standard will be cited. - -== Co-published standards - -Co-publishers, such as `ISO/IEC`, `ISO/IEEE`, etc., are supported: - ----- -ISO/IEC 27001:2013 -ISO/IEEE 11073-20702:2018 ----- - -== Stages - -Document stage can be used in identifiers published by ISO, such as `ISO/WD`, or in the case of ISO/IEC, `ISO/IEC WD`: - ----- -ISO/WD 9139 -ISO/IEC WD 29128-3 ----- - -== Types - -Document types can be used in identifiers published by ISO, such as `ISO/TR`, or in the case of ISO/IEC, `ISO/IEC TR`: - ----- -ISO/TR 20123:2023 -ISO/IEC TR 7052:2023 ----- - -Document types can also be used in identifiers along with the stage, such as `ISO/WD TR` and `ISO/IEC WD TR`: - ----- -ISO/WD TR 19626-3 -ISO/IEC WD TR 20000-17 ----- - - -== Amendments and corrigenda - -The identifier can include a year and amendment/corrigendum. - ----- -ISO 690:2010/Amd 1:2018 -ISO/IEC 23003-1:2007/Amd 1:2008/Cor 3:2015 ----- - - -== Parts - -Some ISO Standards can have multiple parts. To cite a certain part of an ISO -Standard, use an identifier with a part number: - ----- -ISO 690-2:1997 ----- - -To cite all parts of the ISO Standard, use an identifier without part and year, -and add the `(all parts)` option to it: - ----- -ISO 690 (all parts) ----- - diff --git a/_cite_docs/itu.adoc b/_cite_docs/itu.adoc deleted file mode 100644 index 16f4c0d..0000000 --- a/_cite_docs/itu.adoc +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Citation guide for ITU publications -flavor: ITU -description: Cite ITU standards -layout: cite-docs ---- - -== ITU-T - -Prefix: `ITU-T` for ITU-T Standardization Sector Recommendations. - -[example] -`ITU-T L.163` - - -== ITU-R - -Prefix: `ITU-R` for ITU-R Radiocommunication Sector Recommendations. - -[example] -`ITU-R 01-201` - - -Prefix: `ITU-R RR` for ITU-R Radio Regulations. - -[example] -`ITU-R RR (2020)` - -== ITU-D - -Prefix: `ITU-D` for ITU-D Development Sector Recommendations. - diff --git a/_cite_docs/jis.adoc b/_cite_docs/jis.adoc deleted file mode 100644 index 027865b..0000000 --- a/_cite_docs/jis.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Citation guide for JIS publications -flavor: JIS -description: Cite JIS standards -layout: cite-docs ---- - -== Prefix - -The prefix for JIS publications is `JIS` - -[example] -`JIS X 0208:1997` - -== Dated and undated references - -The edition year is optional. If not specified, an undated citation will be -created with all its editions embedded within. - -[example] -`JIS X 0208` - -== Part - -In case of multi-part standards, the part number is specified after the number of the standard: - -[example] -`JIS B 0060-1:2015` - -To cite all parts of a standard, adding space and `(all parts)` option after the number of the standard: - -[example] -[source] ----- -JIS B 0060 (all parts) -JIS B 0060 (規格群) ----- diff --git a/_cite_docs/nist.adoc b/_cite_docs/nist.adoc deleted file mode 100644 index a9062c3..0000000 --- a/_cite_docs/nist.adoc +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Citation guide for NIST publications -flavor: NIST -description: Cite NIST standards -layout: cite-docs ---- - -== Prefixes - -`NBS`:: NBS Publications - -[example] -`NBS BH 1` - -`NIST`:: NIST Publication - -[example] -`NIST SP 800-162` - -`FIPS`:: Federal Information Processing Standards - -[example] -`FIPS 102` - - -== Types - -`SP`:: Special Publication - -[example] -`NIST SP 800-162` - -`GCR`:: General Construction Report - -[example] -`NIST GCR 01-820` - -`IR`:: Internal Report - -[example] -`NISTIR 8200:2018` - -[example] -`NIST IR 8200:2018` - -`CSWP`:: Cybersecurity White Paper - -[example] -`NIST CSWP 1` diff --git a/_cite_docs/oasis.adoc b/_cite_docs/oasis.adoc deleted file mode 100644 index 67f01cc..0000000 --- a/_cite_docs/oasis.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Citation guide for OASIS publications -flavor: OASIS -description: Cite OASIS standards -layout: cite-docs ---- - -OASIS standards are available in the -https://www.relaton.org/relaton-data-oasis/[OASIS Standards index]. - -Prefix for all OASIS standards is `OASIS`. - -[example] -`OASIS AkomaNtosoCore-v1.0-Pt1-Vocabulary` diff --git a/_cite_docs/ogc.adoc b/_cite_docs/ogc.adoc deleted file mode 100644 index a043978..0000000 --- a/_cite_docs/ogc.adoc +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Citation guide for OGC publications -flavor: OGC -description: Cite OGC standards -layout: cite-docs ---- - -== Prefix - -The prefix for OGC standards is `OGC`: - -[example] -`OGC 23-025` - - -== Edition - -The edition is the revision number `rNN` of the standard: - -[example] ----- -OGC 20-072r5 -OGC 21-056r11 ----- diff --git a/_cite_docs/omg.adoc b/_cite_docs/omg.adoc deleted file mode 100644 index 048f7dd..0000000 --- a/_cite_docs/omg.adoc +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Citation guide for OMG publications -flavor: OMG -description: Cite OMG standards -layout: cite-docs ---- - -== Prefix - -The prefix for OMG standards is `OMG`: - -[example] -`OMG AMI4CCM` - -== Version - -Version can be specified in the end of the citation: - -[example] ----- -OMG AMI4CCM 1.0 -OMG AMI4CCM 1.1 -OMG API4KP 1.0 beta 2 ----- - -Without version, the latest version is assumed. diff --git a/_cite_docs/plateau.adoc b/_cite_docs/plateau.adoc deleted file mode 100644 index f2a0caf..0000000 --- a/_cite_docs/plateau.adoc +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: Citation guide for MLIT Project PLATEAU publications -flavor: MLIT Project PLATEAU -description: Cite MLIT Project PLATAEU publications -layout: cite-docs ---- - -== Introduction - -https://www.mlit.go.jp/plateau/[PLATEAU] by https://www.mlit.go.jp[MLIT] is a -project of the -https://www.mlit.go.jp[Ministry of Land, Infrastructure and Transportation of Japan]. - -The project aims to develop a platform for the creation and sharing of digital -geospatial information. The project is a collaboration between industry, -academia, and government. - -== Relaton components - -* https://github.com/relaton/relaton-model-plateau/[Information models] -* https://github.com/relaton/relaton-data-plateau[Relaton data] -* https://github.com/relaton/relaton-plateau[Relaton implementation] - - -== Prefix - -The prefix for Plateau publications is `PLATEAU`. - - -== Document types - -=== General - -Citing a document without an edition number indicates it is an undated -citation. In an undated citation, all known editions are provided in the -bibliographic item under `relations`. - - -=== Handbook - -Project PLATEAU Handbooks are available at: - -* https://www.mlit.go.jp/plateau/libraries/handbooks/ - -The pattern to cite in Relaton is: - -[source] ----- -PLATEAU Handbook #{number} {#{edition}} ----- - -Where, - -`number`:: handbook number. - -`edition`:: (optional) edition number. - -.Citing the PLATEAU Handbook #01 (undated) -[example] -==== -[source] ----- -PLATEAU Handbook #01 ----- -==== - -.Citing the PLATEAU Handbook #01 edition 4 -[example] -==== -[source] ----- -PLATEAU Handbook #01 4.0 ----- -==== - -Some editions are meant for a particular audience. - -For example, Handbook #11 has these editions: - -* `1.0(民間活用編)` -* `1.0(公共活用編)` - -In such cases, the edition number includes the audience type. - -[example] -==== ----- -PLATEAU Handbook #11 1.0(公共活用編) ----- -==== - -[example] -==== ----- -PLATEAU Handbook #11 1.0(民間活用編) ----- -==== - - -=== Handbook annexes - -The citation method is identical to that of Handbooks. - -The only difference is that their number appears in a pattern like -`#{handbook-number}-#{annex-number}`. - -.Citing the PLATEAU Handbook #03 Annex 1 (undated) -[example] -==== -[source] ----- -PLATEAU Handbook #03-1 ----- -==== - -.Citing the PLATEAU Handbook #03 Annex 1 edition 2 -[example] -==== -[source] ----- -PLATEAU Handbook #03-1 2.0 ----- -==== - - -=== Technical Report - -Project PLATEAU Technical Reports are available at: - -* https://www.mlit.go.jp/plateau/libraries/technical-reports/ - -The pattern to cite in Relaton is: - -[source] ----- -PLATEAU Technical Report #{number} {#{edition}} ----- - -Where, - -`number`:: Technical Report number - -`edition`:: (optional) edition number. - -NOTE: All Technical Reports so far are all of edition 1.0. - - -.Citing the PLATEAU Technical Report #56 (undated) -[example] -==== -[source] ----- -PLATEAU Technical Report #56 ----- -==== - -.Citing the PLATEAU Handbook #56 edition 1 -[example] -==== -[source] ----- -PLATEAU Technical Report #56 1.0 ----- -==== diff --git a/_cite_docs/un.adoc b/_cite_docs/un.adoc deleted file mode 100644 index cad959d..0000000 --- a/_cite_docs/un.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Citation guide for UN publications -flavor: UN -description: Cite UN standards -layout: cite-docs ---- - -To cite a UN document use references prefixed with `UN`: - -[example] ----- -UN TRADE/CEFACT/2004/32 -UN TRADE/WP.4/1068 ----- diff --git a/_cite_docs/w3c.adoc b/_cite_docs/w3c.adoc deleted file mode 100644 index 1b8e470..0000000 --- a/_cite_docs/w3c.adoc +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: Citation guide for W3C publications -flavor: W3C -description: Cite W3C standards -layout: cite-docs ---- - -The W3C references have following format: - -`W3C --/` - -* `STAGE` - stage of standard (REC, CR, etc.). Optional. -* `TYPE` - type of standard (NOTE, TR). Optional. -* `CODE` - code of standard (e.g. html, css, etc.). Mandatory. -* `YEAR` - year of publication. Optional. -* `DATE` - date of publication. Optional. -* `SUFF` - suffix of standard (e.g. fonts, 01, ReportOutcomes etc.). Optional. - -Cases: - -* `W3C ` - returns a document with the last document as relation -* `W3C -` - returns a document with the last dated document for the year as a relation -* `W3C -` - returns the last dated document for the year with specified type or stage -* `W3C --` - returns dated document - -== Stages - -* `WD` - Working Draft -* `CRD` - Candidate Recommendation Draft -* `CR` - Candidate Recommendation -* `PR` - Proposed Recommendation -* `PER` - Proposed Edited Recommendation -* `REC` - Recommendation -* `SPSD` - Superseded Recommendation -* `OBSL` - Obsolete Recommendation - -[example] ----- -W3C WD css3-namespace -W3C CRD css-images-3 -W3C CR css-box-3 -W3C PR did-core -W3C PER SMIL2 -W3C REC did-core -W3C SPSD MathML2 -W3C OBSL P3P ----- - -== Type - -`NOTE` - W3C Note - -[example] -`W3C NOTE photo-rdf` - -== Year - -Year is a part of the standard code. If year is specified but date is not, the latest version of the standard is assumed. - -* `W3C css-2018` - returns document with the last dated document for the year as a relation -* `W3C NOTE-css-2018` - returns the last dated document for the year with specified type or stage -* `W3C NOTE-css-2010-20110512` - returns dated document - -== Dates - -* `MMDD` - month and day -* `YYMMDD` - year and month -* `YYYYMMDD` - year, month and day - -[example] ----- -W3C NOTE voice-0128 -W3C NOTE cgm-970618 -W3C REC html32-19970114 ----- - -Withouth date the latest version of the standard is assumed. - -[example] -`W3C css` - -== Suffix - -[example] ----- -W3C WCA-terms/01 -W3C 9605-Indexing-Workshop/ReportOutcomes -W3C REC CSS2/fonts ----- diff --git a/_cite_docs/xsf.adoc b/_cite_docs/xsf.adoc deleted file mode 100644 index 29c34e8..0000000 --- a/_cite_docs/xsf.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Citation guide for XSF publications -flavor: XSF -description: Cite XSF standards -layout: cite-docs ---- - -To cite XSF standards use the `XEP` prefix: - -[example] -`XEP 0001` diff --git a/_config.yml b/_config.yml deleted file mode 100644 index 44e0921..0000000 --- a/_config.yml +++ /dev/null @@ -1,304 +0,0 @@ -title: Relaton -description: Interoperable data models for citations -# The above two are used by jekyll-seo-tag for things such as -# `` and `<meta>` tags, as well as elsewhere by the theme. - -permalink: /blog/:year-:month-:day-:title/ - -url: https://www.relaton.org -github_repo_url: https://github.com/relaton/relaton.github.io -github_repo_branch: main -permalink: /blog/:year-:month-:day-:title/ - -algolia_search: - api_key: '31ca4bad475130bdaee582a0b9f40806' - index_name: 'metanorma' - -tagline: >- - Interoperable data model for citations - based on ISO 690 - -landing_priority: [custom_intro, blog, specs, software] - -theme: jekyll-theme-rop - -relaton: - - supported_bibliographies: - - id: iso - label: ISO - citation_guide: true - gem: relaton-iso - sources: - - { url: "https://www.iso.org", label: "International Organization for Standardization" } - - id: iec - label: IEC - citation_guide: true - gem: relaton-iec - sources: - - { url: "https://www.iec.ch", label: "International Electrotechnical Commission" } - - id: itu - label: ITU-T & ITU-R - citation_guide: true - gem: relaton-itu - sources: - - { url: "https://www.itu.int", label: "International Telecommunication Union" } - - id: ietf - label: RFC & I-D (IETF) - citation_guide: true - gem: relaton-ietf - sources: - - { url: "https://bib.ietf.org", label: "Internet Engineering Task Force" } - - id: ieee - label: IEEE - citation_guide: true - gem: relaton-ieee - sources: - - { url: "https://standards.ieee.org", label: "IEEE Standards Association" } - - id: nist - label: NIST - citation_guide: true - gem: relaton-nist - sources: - - { url: "https://www.nist.gov", label: "National Institute of Standards and Technology" } - - id: bipm - label: BIPM - citation_guide: true - gem: relaton-bipm - sources: - - { url: "https://www.bipm.org", label: "International Bureau of Weights and Measures" } - - id: 3gpp - label: 3GPP - citation_guide: true - gem: relaton-3gpp - sources: - - { url: "https://www.3gpp.org", label: "3rd Generation Partnership Project" } - - id: ogc - label: OGC - citation_guide: true - gem: relaton-ogc - sources: - - { url: "https://www.ogc.org", label: "Open Geospatial Consortium" } - - id: iev - label: IEC Electropedia (IEV) - citation_guide: false - gem: relaton-iev - sources: - - { url: "https://www.electropedia.org", label: "IEC Electropedia" } - - id: oasis - label: OASIS - citation_guide: true - gem: relaton-oasis - sources: - - { url: "https://www.oasis-open.org/standards/", label: "OASIS OPEN"} - - id: cie - label: CIE - citation_guide: true - gem: relaton-cie - sources: - - { url: "https://cie.co.at", label: "International Commission on Illumination" } - - id: w3c - label: W3C - citation_guide: true - gem: relaton-w3c - sources: - - { url: "https://www.w3.org", label: "World Wide Web Consortium" } - - id: ecma - label: Ecma - citation_guide: true - gem: relaton-ecma - sources: - - { url: "https://www.ecma-international.org", label: "Ecma International" } - - id: iho - label: IHO - gem: relaton-iho - citation_guide: true - sources: - - { url: "https://www.iho.int", label: "International Hydrographic Organization" } - - id: omg - label: OMG - citation_guide: true - gem: relaton-omg - sources: - - { url: "https://www.omg.org", label: "Object Management Group" } - - id: un - label: UN Docs - citation_guide: true - gem: relaton-un - sources: - - { url: "https://documents.un.org", label: "UN Official Document System" } - - id: cen - label: EN (CEN/CENELEC) - citation_guide: true - gem: relaton-cen - sources: - - { url: "https://standards.cen.eu", label: "CEN/CENELEC" } - - id: bsi - label: BS, PAS (BSI) - citation_guide: true - gem: relaton-bsi - sources: - - { url: "https://www.bsigroup.com", label: "British Standards Institution" } - - id: jis - label: JIS (JSA) - citation_guide: true - gem: relaton-jis - sources: - - { url: "https://webdesk.jsa.or.jp", label: "Japanese Standards Association" } - - id: gb - label: GB - citation_guide: true - gem: relaton-gb - sources: - - { label: "Chinese National Standards" } - - id: calconnect - label: CalConnect - citation_guide: true - gem: relaton-calconnect - sources: - - { url: "https://www.calconnect.org", label: "CalConnect" } - - id: ccsds - label: CCSDS - citation_guide: true - gem: relaton-ccsds - sources: - - { url: "https://public.ccsds.org", label: "Consultative Committee for Space Data Systems" } - - id: iana - label: IANA - citation_guide: true - gem: relaton-iana - sources: - - { url: "https://www.iana.org", label: "Internet Assigned Numbers Authority" } - - id: xsf - label: XSF - citation_guide: true - gem: relaton-xsf - sources: - - { url: "https://xmpp.org/extensions/", label: "XMPP Standards Foundation" } - - id: doi - label: DOI - citation_guide: true - gem: relaton-doi - sources: - - { url: "https://www.crossref.org/documentation/retrieve-metadata/rest-api/", label: "Digital Object Identifier" } - - id: isbn - label: ISBN - citation_guide: true - gem: relaton-isbn - sources: - - { url: "http://openlibrary.org", label: "Open Library" } - - id: plateau - label: MLIT PLATEAU - citation_guide: true - gem: relaton-plateau - sources: - - { url: "https://www.mlit.go.jp/plateau/", label: "Handbooks" } - -author: - name: Ribose Inc. - url: https://www.ribose.com - -authors: - - name: Ribose Inc. - email: open.source@ribose.com - -contact_email: open.source@ribose.com - -parent_hub: - git_repo_url: https://github.com/riboseinc/open.ribose.com - git_repo_branch: main - home_url: https://open.ribose.com/ - -includes_dir: '.' - -social: - links: - - https://twitter.com/RiboseUS - - https://github.com/relaton/relaton - -legal: - name: Ribose Group Inc. - tos_link: https://www.ribose.com/tos - privacy_policy_link: https://www.ribose.com/privacy - -home_calls_to_action: - - { url: "/blog/", title: "Blog" } - - { url: "/software/relaton/docs/README/", title: "Using the gem" } - #- { url: "/software/relaton-cli/docs/README/", title: "Using the CLI" } - -collections: - projects: - output: false - software: - output: true - permalink: /software/:path/ - specs: - output: true - permalink: /specs/:path/ - posts: - output: true - permalink: /blog/:year-:month-:day-:title/ - pages: - output: true - permalink: /:name/ - cite_docs: - output: true - permalink: /guides/:path/ - asciibib_docs: - output: true - permalink: /asciibib/:path/ - model_docs: - output: true - permalink: /model/:path/ - - -defaults: - # Theme defaults. - # MUST be duplicated from theme’s _config.yml - # (does not get inherited, unlike the collections hash) - - scope: - path: "" - values: - layout: default - - scope: - path: _posts - type: posts - values: - layout: post - - scope: - path: _software - type: software - values: - layout: product - - scope: - path: _specs - type: specs - values: - layout: spec - -plugins: - - jekyll-theme-rop - -tag_namespaces: - software: - writtenin: "Written in" - bindingsfor: "Bindings for" - user: "Target user" - interface: "Interface" - specs: - audience: "Audience" - completion_status: "Status" - -include: - - "index.adoc" - - "404.html" - -exclude: - - .git - - .lycheeignore - - "*/.git" - - Gemfile* - - Makefile - - Rakefile - - README.adoc - - vendor # for deployment diff --git a/_layouts/asciibib-docs.html b/_layouts/asciibib-docs.html deleted file mode 100644 index a70d27a..0000000 --- a/_layouts/asciibib-docs.html +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: docs-base -html-class: docs-page -docs_title: AsciiBib - -navigation: - base_url: /asciibib - items: - - - title: Nested definition lists - path: /nested/ - - title: Path-style definition lists - path: /path/ ---- - -{{ content }} diff --git a/_layouts/cite-docs.html b/_layouts/cite-docs.html deleted file mode 100644 index 39677ef..0000000 --- a/_layouts/cite-docs.html +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: docs-base -html-class: docs-page -docs_title: Citation guides - -navigation: - base_url: /guides - items: - - - title: 3GPP - path: /3gpp/ - - title: BIPM - path: /bipm/ - - title: British Standards Institution (BSI) - path: /bsi/ - - title: CCSDS - path: /ccsds/ - - title: CEN/CENELEC - path: /cen/ - - title: CIE - path: /cie/ - - title: CalConnect - path: /calconnect/ - - title: Chinese standards (GB) - path: /gb/ - - title: Digital Object Identifiers (DOI) - path: /doi/ - - title: Ecma International - path: /ecma/ - - title: IANA - path: /iana/ - - title: IEC - path: /iec/ - - title: IEEE Standards Association - path: /ieee/ - - title: IETF - path: /ietf/ - - title: IHO - path: /iho/ - - title: ISBN identifiers - path: /isbn/ - - title: ISO - path: /iso/ - - title: ITU - path: /itu/ - - title: JIS - path: /jis/ - - title: NIST - path: /nist/ - - title: OASIS - path: /oasis/ - - title: OGC - path: /ogc/ - - title: OMG - path: /omg/ - - title: UN - path: /un/ - - title: W3C - path: /w3c/ - - title: XSF - path: /xsf/ - - title: MLIT PLATEAU - path: /plateau/ ---- - -{{ content }} diff --git a/_layouts/model-docs.html b/_layouts/model-docs.html deleted file mode 100644 index 6e3f4a2..0000000 --- a/_layouts/model-docs.html +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: docs-base -html-class: docs-page -docs_title: Information models - -navigation: - base_url: /model - items: - - - title: Additional Information - path: /additional-info/ - - title: Bibitem Type - path: /bibtype/ - - title: Citation Model - path: /citation/ - - title: Creator - path: /creator/ - - title: Edition - path: /edition/ - - title: Identifiers - path: /identifiers/ - - title: Locations - path: /location/ - - title: Medium - path: /medium/ - - title: Numeration and Pagination - path: /numeration/ - - title: Production - path: /production/ - - title: Relations - path: /relations/ - - title: Series - path: /series/ - - title: Specific categories - path: /specific-cats/ - - title: Title - path: /title/ ---- - -{{ content }} diff --git a/_model_docs/additional-info.adoc b/_model_docs/additional-info.adoc deleted file mode 100644 index 4515355..0000000 --- a/_model_docs/additional-info.adoc +++ /dev/null @@ -1,224 +0,0 @@ ---- -title: Additional Information -description: Additional information in Relaton -layout: model-docs ---- - -[[additional-info]] -== Additional general information - -=== Classification - -* Source: ISO 690, 4.11 -* Serialisation: `bibitem/classification` - -==== -Giesler, Patricia. _Canada Remembers the Korean War_. Dewey 971.06 GIE 2003. -ISBN 0662674979. Charlottetown, P.E.I. : Veterans Affairs Canada. 2003. - -[source,xml] --- -<bibitem type="book"> - <title>Canada Remembers the Korean War - 0662674979 - 2003 - - - - - Giesler - Patricia - - - - - - - Veterans Affairs Canada - - - Charlottetown, P.E.I. - 971.06 GIE 2003 - --- - -==== - -=== Keywords - -* Source: N/A -* Serialisation: `bibitem/keyword` - -==== -[source,xml] --- -Homo sapiens - - - Homo sapiens - - Q15978631 - Homo sapiens - - - NHMSYS0000376773 - - - - - Hominidae - Homininae - Hominini - Hominina - Homo - Homo sapiens - Homo_sapiens - --- -==== - -=== Price and availability - -* Source: ISO 690, 4.11 -* Serialisation: `bibitem/price`, `bibitem/note` - - -Price is marked up as a distinct element, which contains the currency code, represented in ISO 4217. -The price should be treated as nominal, rather than capturing all possible pricings at a given time. - -Availability information for a bibliographic item is treated -as a note. This also applies to the availability of an online resource, -and any access limitations, but not to licensing, which is encoded separately. - -==== -_Pluralism in the Soviet Union: Essays in Honour of H. Gordon Skilling_. -Edited by Susan Gross Solomon. New York: St. Martin's Press, 1983. xiii, 179 pp. -$27.50. Available on request to the author. - -[source,xml] --- - - Pluralism in the Soviet Union: Essays in Honour of H. Gordon Skilling - 1983 - - - - - Solonom - Susan - Gross - - - - - - - St Martin's Press - - - Available on request to the author - New York - 27.50 - - xiii - - - 179 - - --- -==== - -=== License - -* Source: ISO 690, 4.11 -* Serialisation: `bibitem/license`, `bibitem/copyright`. - -Where available, URIs should be used to identify licenses unambiguously. -If a URI is not available, a commonly accepted abbreviation or short name of -the license should be used. - -.Indicating the BSD 2-clause license -==== -[source,xml] --- -BSD-2 --- -==== - -.Indicating the Creative Commons 2.0 license -==== -[source,xml] --- -https://creativecommons.org/licenses/by/2.0/ --- -==== - -Copyright is privileged with a separate element, incorporating copyright date -and owner, and scope. Scope is only used when multiple copyright statements apply to the -same document, indicating the scope of each copyright statement. It is preferable -if possible to use only one copyright statement per bibitem, and allot the other -copyright statements to distinct related bibitems (even if the scope involved is -as part of the publication, such as a chapter.) - -.Copyright to a person -==== -[source,xml] --- - - 1999 - Jack Frost - --- -==== - -.Multiple copyright statements -==== -[source,xml] --- - - 1999 - Jack Frost - Original work - - - 2002 - Johannes Raureif - Translation into German - --- -==== - -.A copyright statement within a document relation -==== -[source,xml] --- - - ... - - 1999 - Jack Frost - - ... - - - ... - - 2002 - Johannes Raureif - - ... - - - --- -==== - -=== Provenance and Authenticity - -* Source: ISO 690, 4.11 -* Serialisation: `bibitem/note` - -Notes on bibliographical provenance, and checksums for digital resources, -are both given as bibliographic notes. - diff --git a/_model_docs/bibtype.adoc b/_model_docs/bibtype.adoc deleted file mode 100644 index 00b7b71..0000000 --- a/_model_docs/bibtype.adoc +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: Bibitem Type -description: Categories of information resource in Relaton -layout: model-docs ---- - -== Categories of information resource - -* Source: ISO 690, Clause 5 -* Serialisation: `bibitem@type`, `BibItemType` - -While ISO 690 does not prescribe a list of possible bibliographic types, -there are categories specific to particular information resource categories -(ISO 690, Clause 5), -as well as rendering rules specific to information resource categories (e.g. -ISO 690, 5.5: series title appears before item title for -broadcasts). - -For that reason, bibliographic items should indicate what bibliographic type -they belong to. - -NOTE: The list of bibliographic types is a union of the types listed in ISO 690 -and BibTeX. Master's Thesis and PhD Thesis from BibTeX are subsumed under `thesis`. - -The supported types are: - -* `article` -* `book` -* `booklet` -* `manual` -* `proceedings` -* `presentation` -* `thesis` -* `techreport` -* `standard` -* `map` -* `electronic resource` -* `audiovisual` -* `film` -* `video` -* `broadcast` -* `software` -* `graphic_work` -* `music` -* `patent` -* `inbook` -* `incollection` -* `inproceedings` -* `journal` -* `website` -* `webresource` -* `dataset` -* `archival` -* `social_media` -* `alert` -* `message` -* `conversation` -* `misc` -* `unpublished` -* `collection` - -The list maintains a distinction between the following resources, all of which -are necessarily included in another resource: - -`inbook`:: A typically untitled part of a book. May be a chapter (or section, -etc.) and/or a range of pages. -`incollection`:: A part of a book having its own title. -`inproceedings`:: An article in a conference proceedings. -`article`:: An article from a journal or magazine. - -NOTE: The above distinction aligns with BibTeX usage. - -The overloaded type "`electronic resource`" should be avoided where possible, -particularly if the resource corresponds closely to a paper bibliographic type, -such as `book` or `article`. - -The following types have been added, as specialisations of "`electronic -resource`" with no print or physical counterpart: - -`dataset`:: -an electronic dataset, a collection of data that is not meant to be human-readable, -and which is typically only machine readable. - -`webresource`:: -a human-readable or consumable web resource, -a single item accessible online via a web browser, -which is not composed of components all of which can be accessed in the same -way. Includes media files, as well as individual web pages. - -`website`:: -a collection of web resources, presented under the same URL domain and by the same -(individual or corporate authorship). - -`social_media`:: -one or more resources within a collection that is typically collectively authored by member users. -Includes blog posts, forum posts, social media posts, tweets. Is usually a webresource, -but not always (e.g. blogs on WeChat are only accessible within the WeChat app.) - -`software`:: -computer executable code, not itself human-readable text (though it may generate such text). - - -The following types have been added, as specialisations of "electronic resource" with -a physical but not a print counterpart: - -`alert`:: -a single communication intended for multiple persons, and publicly accessible. May be -electronic (e.g. Facebook status update) or voice (e.g. evacuation alert), but is typically not print. - -`message`:: -a single communication intended for a restricted number of authorised persons (typically one). -May be electronic (e.g. Twitter direct message, email) or voice (e.g. a remark made to someone, -typically cited as "personal communication"). - -`conversation`:: -an exchange of messages between two or more persons. May be electronic (e.g. web chat) -or voice (e.g. phone call). - -`collection`:: -a grouping of multiple bibliographic resources (other than a website), which -themselves are presumed to be classified as belonging to bibliographic types. - -Bibliographic types can overlap. A bibliographic item may be considered to -belonging to more than one bibliographic type. - -[example] -Social media can be treated as `webresource`, and `webresource`s are electronic -resources. A Facebook status update can be treated as an `alert`, or as -`social_media`. - -However each bibliographic type is associated with a particular set of conventions -around citation, so classifying an item as belonging to a given bibliographic type determines how it will -be cited. - -Following the classification of citations in ISO 690, `social_media` takes priority over other -types where it is applicable, particularly for publicly visible communications (such as status updates). - diff --git a/_model_docs/citation.adoc b/_model_docs/citation.adoc deleted file mode 100644 index 01e9a7d..0000000 --- a/_model_docs/citation.adoc +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Relaton citation model -description: Citation model for Relaton -layout: model-docs ---- - -== Relaton citation model - -A citation in Relaton consists of the following components: - -* An identifier `bibitemid` for the cited source. This identifier corresponds to -the identifier (`id`) of a Relaton record describing the cited source. - -* An optional date, in ISO 8601 format. This date is not intended for -disambiguation, since `bibitemid` already identifies the source unambiguously; -it is added for ease of processing, in case author-date citations cannot -straightforwardly extract the date from the bibliographic source. - -* A specification of the locality or localities in the source being cited. - -A locality is a hierarchical specification of a location in a source. It is specified as a sequence -of named components of the source, each hierarchically refining its predecessor, from greater to smaller: - -* `type` is the component of the source being specified; in the Relaton grammar, there is a sequence of -predefined types, and a user-specified type can be added with the prefix `locality:`. The predefined types are: - -** `whole` (i.e. entire document) -** `section` -** `clause` -** `part` -** `paragraph` -** `chapter` -** `page` -** `table` -** `annex` -** `figure` -** `note` -** `list` -** `example` -** `volume` -** `issue` -** `time` -** `anchor` (for HTML pages) - -* `referenceFrom` specifies the instance of the source component being cited; or, if a range of components is being -cited, the beginning of the range. - -* `referenceTo` specified the end of the range, if a range of components is being cited. A range is only expected as the last (most granular) element in a hierarchical sequence of components. - -So for example, the hierarchical specification "Part IV, Chapter 3, Paragraphs 22-24" is cited as: - -[source,xml] ----- -IV -3 - - 22 - 22 - ----- - -NOTE: if the type of the component is `whole`, no `referenceFrom` or `referenceTo` is given. - -=== Discontinuous citations - -If two localities occurs in sequence, and have the same type, then they are interpreted as being a discontinuous reference. So "`pp. 32, 57, 99`" can be specified as: - -[source,xml] ----- -32 -57 -99 ----- - -Alternatively, a sequence of discontinuous references can be specified through the `localityStack` element. -Each `localityStack` consists of a hierarchical sequence of `locality` elements, as above; a sequence of -`locality` elements can thus be treated as a single `localityStack`, with the `localityStack` wrapper left out. - -So for example, the hierarchical specification "`Part IV, Chapter 3, Paragraphs 22-24; Part VII, Chapter 2, Paragraph 130`" is cited as: - -[source,xml] ----- - - IV - 3 - - 22 - 22 - - - - VII - 2 - 130 - ----- - - diff --git a/_model_docs/creator.adoc b/_model_docs/creator.adoc deleted file mode 100644 index 2dff202..0000000 --- a/_model_docs/creator.adoc +++ /dev/null @@ -1,690 +0,0 @@ ---- -title: Creator -description: Categories of creator in Relaton -layout: model-docs ---- - -== Creator - -=== General - -* Source: ISO 690, 4.1 -* Serialisation: `bibitem/contributor`, `Person, Organization, Affiliation` - -ISO 690, 4.1 classifies the various possible roles a creator can have -with regard to a resource into broad categories in order of priority, -with more refined classifications typically named for the creator. - -These classifications are retained in the Relaton model: - -`bibitem/contributor/role@type`:: -Provides the broad category of role -(author, performer, compiler, adaptor, publisher, distributor), -with some further refinements to deal with the range of roles in other standards, -and roles whose status is intermediate between those categories (e.g. translator). -The content of this element is optional, and contains a more specific expression -of the creator role. - -`bibitem/contributor/role/description`:: -Contains one or more specific descriptions of the role of the contributor. -The description can be strictly a noun, e.g. "librettist", or it can be a -phrase, corresponding to how it will be rendered in a citation ("libretto by"); -the choice is at the discretion of the bibliographer, and is determined by how -the citation is expected to be rendered (as rendering systems are unlikely to be -sophisticated enough to convert the one into the other.) - - -=== Role - -The Relaton model further refines the ISO 690 model of roles, based on analysis -of the 270 creator roles encoded in the -https://www.loc.gov/marc/bibliographic/[MARC bibliographic standard]. - -The Relaton listing of roles is as follows: - -`author`:: creates a Work (ISO 690: "a) creator of work") -+ --- -Creator of the intellectual content described by the bibliographic item. -Includes both the major intellectual contributors to intellectual -content, and subsidiary contributors. - -Includes: _composer, librettist, mapping agency, surveyor, -cartographer, system designer of software, patentee, -patent applicant, artist, photographer, draughtsman, graphic -designer, inventor._ - -In the case of documents arising from legal cases, the involved participants -involved are considered creators, e.g. _applicants, complainants, defendants, -judges_. --- - -`editor`::: finalises a Work. "finalises" is a subclass of "creates" (ISO 690: "c) reviser of work") -+ --- -Party imposing structure on the intellectual content of the bibliographic item. -Is someone finalising a work (i.e. its intellectual content), which has been -created or initiated by others. - -Includes: _compiler, corrector, curator, editor, moderator, proofreader, reviser_. --- - -`adapter`::: creates a Derived-Work, a Work derived from the initial Work -(ISO 690: "d) creator of derivative work") -+ --- -Party converting the intellectual content of the bibliographic item into -a different medium or form. - -Includes: _abridger, annotator, adapter, commentator, reviewer; -photographer of another creator's work, copyist, arranger_. --- - -`realizer`:: creates an Expression of a Work (ISO 690: "b) expresser of created work") -+ --- -Realises the intellectual content of the bibliographic item. -Contributes to the work being realised in a particular intellectual or -artistic form, but is distinct from a mass-produced physical presentation -of that form (a manifestation). - -Includes: _animator, art director, film director, cinematographer, engineer, -music copyist, musical director, recordist, stage manager, videographer; -analyst, court reporter, markup editor, programmer, scribe_. - -A large number of visual artists, such as engravers, etchers, and illustrators, -can be modelled as creators, realisers, or adapters, depending on whether -they are creating work they have conceived of themselves (_author_), -carrying out a creator's artistic vision and following their drafts (_realizer_), -or copying an artistic work that has already been fully realised in a different -medium (_adapter_). In the bibliographic description of visual works, -_realizer_ is the usual role involved. --- - -`translator`::: creates an Expression of a Work in a novel language -+ --- -Party converting the intellectual content of the bibliographic item into -a different language. Is given a separate role from _realizer_ because of the -prominence given to translators in bibliographic description. --- - -`performer`::: creates an Expression as a novel performance (time-bound realisation of Work), specific to performing arts -+ --- -Indicates the performers realising the work in a time-bound event. If performers are indicated for -an artistic work, a distinction is made between the performers ("front of stage"), -and the _realizers_, the other contributors working towards realising the performance -in a planning or coordinating role ("backstage"). - -Includes: _actor, conductor, dancer, musician, narrator, performer, singer_. --- - -`publisher`:: creates a Manifestation of an Expression, a distinct presentation (ISO 690: "e) publisher of manifestation") -+ --- -Party responsible for the bibliographic item becoming publicly available. -Covers all parties involved in creating and producing a manifestation -(physical presentation) of the work. - -Includes: _bookbinder, manufacturer, online information provider, publisher, -printer, production company_. --- - -`distributor`:: gives out Items of a Manifestation to an audience (ISO 690: "f) distributor of manifestation") -+ --- -Party arranging for the bibliographic item to become publicly accessible. -Covers all parties involved in making a manifestation available, and -providing manifestation Items to owners. - -Includes: _auctioneer, bookseller, online host, provider, -repository, vendor_. --- - -`authorizer`::: authorises the Work, lends it authority -+ --- -Party which lends its authority to the bibliographic item, and vouches for its -quality and accuracy. -Covers most cases of corporate authorship: the organisation lends its -authority to works that individual authors create, whether as work for hire, -or under the auspices of the organisation. - -Includes: _copyright holder, degree supervisor, issuing body, jurisdiction, -laboratory, licensor, monitor, scholarly society, scientific advisor, software company, -standards body_. --- - -`enabler`::: supports, enables, facilitates a Work, an Expression, or a -Manifestation. -+ --- -Party involved in supporting, enabling, or facilitating the production of a -bibliographic item, without contributing directly to its intellectual content, -realisation, or presentation. - -This includes funders and sponsors. - -Includes: _donor, host institution, licensee, patron, producer, sponsor_. --- - -`owner`:: receives Items of a Manifestation -+ --- -Party who is in physical possession of a bibliographic item. - -Includes: _autographer, collector, depositor, lender, owner_. --- - - -`subject`:: referenced in a Work. -+ --- -Party who is referenced in a bibliographic item. Is not properly a contributor of -intellectual content, but is included because of edge cases in some contributor -models. - -Includes: _addressee, cited, dedicatee, depicted, honoree, subject_. --- - -[NOTE] --- -The above description uses the older FRBR distinction between: - -* Works (a family of content identified as the same), -* Expressions (versions of the content of a Work, including revisions and performers), -* Manifestations (presentations of an Expression), -* Items (instances of a Manifestation). - -Later bibliographic models such as BIBFRAME conflate Expressions and -Manifestations, as the distinction can be difficult to make, but it is useful in -defining publishers abstractly. --- - - -[[creator-selection]] -=== Selection - -Whether subsidiary creators should be included in a bibliographic item, and -which creators should be included, is at the discretion of the bibliographer. - -Exceptionally, "translator" is differentiated from the other "adaptor" roles, -because it is so different from other adaptor roles such -as "engraver" or "photographer". - - -=== Derivative works - -For derivative works, the creator and title of the original resource can be -mentioned as a bibliographic note (`bibitem/note`). -However, best practice is to treat the original resource as a distinct related -bibliographic item, related through the -`derivedFrom` relation (See link:/model/relations[Document Relations]). - -Likewise, different originators of different editions should be modelled by -modelling the editions as distinct related items, each with its own distinct -editor as contributor. (For example, the later edition given as the main item, -and the earlier edition related through a "updatedBy" relation.) - -NOTE: Although both "composer" and "librettist" are included as authors under -ISO 690, 4.1, -the two roles are clearly differentiated in ISO 690, 5.7, with the -"composer" given priority over the "librettist". - -NOTE: Inventor and patentee are atypical of the "performer" roles, -and could arguably be regarded as author roles instead. - -=== Sponsoring organisations - -Sponsoring organisations are conventionally included as distributors, -following practice in ISO 690. - -Note that in this model, sponsors are no longer conflated with distributors, and SDOs are differentiated from publishers; -they are often but not always the same organisation in the case of standards. - -=== Examples - -==== -Ramsey, J. K., & McGrew, W. C. (2005). Object play in great apes: Studies in nature and captivity. -In A. D. Pellegrini & P. K. Smith (Eds.), _The nature of play: Great apes and humans_ -(pp. 89-112). New York, NY: Guilford Press. - -[source,xml] --- - - Object play in great apes: Studies in nature and captivity - 2005 - - - - - Ramsey - J. K. - - - - - - - - McGrew - W. C. - - - - - - The nature of play: Great apes and humans - - - - - Pellegrini - A. D. - - - - - - - - Smith - P. K. - - - - - - - Guilford Press - - - New York, NY - - - - 89 - 112 - - --- -==== - -==== -Demosthenes. _Speeches 50-59_. Translated from the Greek by -Victor BERS. Austin: University of Texas Press, 2003. - -[source,xml] --- - - Speeches 50-59 - 2003 - - - - - Demosthenes - - - - - - - - Bers - Victor - - - - - - - University of Texas Press - - - en - - - Speeches 50-59 - grc - - - Austin - --- -==== - -==== -ROGET, Peter Mark. _Roget's Thesaurus_. Revised by -Susan M. LLOYD. Burnt Mill, Harlow, Essex: Longman Group Limited, 1982 [1852]. - -[source,xml] --- - - Roget's Thesaurus - 1852 - 1982 - 1982 - - - - - Roget - Peter - Mark - - - - - revised - - - Lloyd - Susan - M. - - - - - - - Longman Group Limited - - - Burnt Mill, Harlow, Essex - --- -==== - -==== -WINSBACHER KNABENCHOR. All' Lust und Freud'. Frankfurt: Bellaphon, 1983. - -[source,xml] --- - - All' Lust und Freud' - 1983 - - - - Winsbacher Knabenchor - - - - composer - Gastoldi, Giovanni Giacomo - - - composer - Isaak, Heinrich - - - composer - Othmayr, Caspar - - - composer - Demantius, Christoph - - - - - Bellaphon - - - - audio disc - - Frankfurt - --- -==== - -=== Personal names - -Names may be modelled either broken up into their constituent components -(prefix, forename, initials, surname, addition), or as a complete name string. -The latter is useful if -(contrary to the recommendation of ISO 690, 4.1) -language-specific conventions for ordering of name components are to be -observed; e.g. "`James CLARK, John COWAN, MURATA Makoto`". - -If there are multiple contributors named in a role, all contributors are -expected to be represented in the bibliographic entry. -This reflects practice in electronic bibliographic tools, and renderers -may choose to truncate contributors with "`et al.`" beyond a certain cutoff point. -If this information is not available, a dummy contributor can be -named with "`et al.`" as their `completename`, but this is not preferred. - -The `formatted-initials` component is used if all forenames are replaced by initials. -If only the middle name is replaced by an initial, it is still treated as a -forename. - -Forenames are given an `initial` attribute if initials are to be assembled on a more granular basis. - -==== -BACH, J.S. - -[source,xml] --- - - - Bach - J. S. - - --- -==== - -==== -PICASSO, Pablo - -[source,xml] --- - - - Picasso - Pablo - - --- -==== - -==== -KING, Martin Luther, Jr., Rev. - -[source,xml] --- - - - Dr. - King - Martin - Luther - Jr. - Rev. - - --- -==== - -==== -KING, Martin Luther, Jr. - -[source,xml] --- - - - KING, Martin Luther, Jr. - - --- -==== - -==== -STEWART, John H. - -[source,xml] --- - - - Stewart - John - H. - - --- -==== - -[[organisation]] -=== Organisations - -The model caters for both full names and abbreviations of organisations. -Subordinate body names are modelled separately from the parent body name; the -choice of whether -to model parent + subordinate or a single name depends on the degree of -independence of the subordinate body, as outlined in ISO 690, 4.1. - -==== -St. Thomas University [Florida]. - -[source,xml] --- - - St. Thomas University [Florida] - --- -==== - -==== -St. Thomas University [New Brunswick]. - -[source,xml] --- - - St. Thomas University [New Brunswick] - --- -==== - -==== -ACADEMY OF ATHENS. Research Centre for Modern Greek Dialects. - -[source,xml] --- - - Academy of Athens - Research Centre for Modern Greek Dialects - --- -==== - -[[variantnames]] -=== Pseudonyms and Variant Names - -Variant names, and assumed names, can both be modelled -as notes on names. However, for greater clarity, and for modelling -of the internal structure of the variant or assumed name, -a variant name can be modelled, with the same level of detail -as default names. The type of variant, or relation between the name -and variant, needs to be made explicit in that case. -For example `pseudonym`/`pseudonymOf` for literary pseudonyms, -or `username`/`usernameOf` for social media usernames. - -Variant names can be applied to personal names, -organization names, and organization subdivision names. - -==== -TWAIN, Mark [pseud. of Samuel Langhorne CLEMENS] - -[source,xml] --- - - Twain - Mark - pseud. of Samuel Langhorne CLEMENS - --- - -[source,xml] --- - - Twain - Mark - - Clemens - Samuel - Langhorne - - - Τουαίην - Μαρκ - - --- -==== - -=== Anonymous and Varii - -Descriptors of authors, such as "`Anon`" or "`Various Authors`", should be given -as `completename` elements. - -The model does not standardise the designations of authors. As with pseudonyms, -the real name of the creator if known can be modelled as a note, or as a name -variant. - -==== -Anon. _Sir Gawain and the Green Knight_. Edited by R. A. WALDRON. Evanston: -Northwestern University Press, 1970. - -[source,xml] --- - - Sir Gawain and the Green Knight - 1970 - - - Anon - - - - R. A. WALDRON - - - - - Northwestern University Press - - - Evanston - --- -==== - -==== -Anon [Thomas Robert MALTHUS]. _An Essay on the Principle of Population_. 1st edition. -London: J. Johnson, 1798. - -[source,xml] --- - - An Essay on the Principle of Population - 1798 - - - Anon - - Thomas Robert MALTHUS - - - - - J. Johnson - - 1st edition - London - --- -==== - diff --git a/_model_docs/edition.adoc b/_model_docs/edition.adoc deleted file mode 100644 index 9cc97cf..0000000 --- a/_model_docs/edition.adoc +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: Edition -description: Categories of editions in Relaton -layout: model-docs ---- - -[[edition]] -== Edition - -* Source: ISO 690, 4.5 -* Serialisation: `bibitem/edition, bibitem/version, bibitem/date` - -Editions are modelled as free text, given the variety of ways they can be represented. -For that reason, the full word "edition" needs to appear after any ordinal. -The optional `number` attribute can be used to provide a numeric equivalent. - -As described in link:/model/production[Date Types], -dates when a resource was last accessed are modelled as `date[@type = "accessed"]`; -dates when a resource was last updated are modelled as `date[@type = "updated"]`. - -The `version` element can be used to give more detailed information about resource versions, -including version numbers (drafts) and version dates (which are differentiated from -`date`, since they are often used as version identifiers). - -==== -Anon [Thomas Robert MALTHUS]. _An Essay on the Principle of Population_. 1st edition. -London: J. Johnson, 1798. - -[source,xml] --- - - An Essay on the Principle of Population - 1798 - - - Anon - Thomas Robert MALTHUS - - - - J. Johnson - - 1st edition - London - --- -==== - -==== -SKOUSEN, Mark. _The Structure of Production_. New revised edition. -New York: New York University Press, 2015. - -[source,xml] --- - - The Structure of Production - 2015 - - - - - Skousen - Mark - - - - - - New York University Press - - New revised edition - New York - --- -==== - -==== -When did the sounds of 'w' and 'v' change in High German? -_Stack Exchange: Linguistics Beta_. -Updated 8 May 2017 [viewed 10 May 2018]. -Available from: https://linguistics.stackexchange.com/questions/22872/when-did-the-sounds-of-w-and-v-change-in-high-german - -[source,xml] --- - - When did the sounds of 'w' and 'v' change in High German? - https://linguistics.stackexchange.com/questions/22872/when-did-the-sounds-of-w-and-v-change-in-high-german - 2017-05-08 - 2018-05-10 - - - Stack Exchange: Linguistics Beta - - - --- -==== - -==== -MOZILLA FOUNDATION. Mozilla Firefox version 60.4.0 ESR [computer program]. Available from: https://www.mozilla.org/. [viewed 2019-01-11]. - -[source,xml] --- - - Mozilla Firefox - https://www.mozilla.org/ - 2019-01-11 - - - - Mozilla Foundation - - - - 60.4.0 ESR - - - computer program - - --- -==== - - - diff --git a/_model_docs/identifiers.adoc b/_model_docs/identifiers.adoc deleted file mode 100644 index 7b6ca2d..0000000 --- a/_model_docs/identifiers.adoc +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Identifiers -description: Identifiers in Relaton -layout: model-docs ---- - -[[identifiers]] -== Identifiers - -* Source: ISO 690, 4.9 -* Serialisation: `bibitem/docidentifier` - - -ISO 690, 4.9 argues that unique international standard identifiers -must be included in the bibliography. In practice, identifiers are included -at the discretion of the bibliographer: they are routinely included in -bibliographic databases, but seldom in references within documents. - -The namespace of an identifier is indicated through its type attribute. -The scope of an identifier is introduced to disambiguate the identifier -referent, when it is not obvious. So it is introduced where an identifier identifies -only a component of the item (e.g. a document included in the item), -or a superset of the item (e.g. a series). It can also be used if the -identifier identifies a specific instantiation of the document as an entity; -in terms of the link:https://www.ifla.org/publications/functional-requirements-for-bibliographic-records[Functional Requirements for Bibliographic Records], for example, -an identifier may identify a work, an expression of the work (e.g. an edition), -a manifestation of the work (e.g. a format), or an item of the manifestation -(e.g. a single physical copy). - -Neither the type nor the scope of the identifier have an associated controlled -vocabulary, and one is unlikely to be derived. Identifier type should -follow established practice in the domain; most well-known identifiers -have a widely used short name or abbreviation. - -Invalid or cancelled identifiers should be so identified through the -identifier scope: the cancellation of the identifier does not impact -its namespace, but its connnection to a referent. - -Standards body identifiers for standards (ISO 690, 5.9) -may be modelled as series numbers or as identifiers (link:/model/series[Series]). -We recommend that the canonical identifier issued for a standard by a -standards body be encoded as an identifier; other identifiers assigned -to the same document may be better identified with a series title, as a -named and numbered grouping of documents. - -Identifiers can be expressed as HTTP URIs may be so expressed, without -changing the identifier type. A DOI for example may be expressed as either -the DOI proper, or as a doi.org URI. - -==== -_International Journal of Islamic Thought_. e-ISSN 2289-6023. -ISSN 2232-1314. - -[source,xml] --- - - International Journal of Islamic Thought - 2289-6023 - 2232-1314 - --- -==== - -==== -Ahmed al-Kindi & Anke Iman Bouzenita. 2018. -The notion of _Sunna_: An eclectic reading in the Ibadhi legacy. -_International Journal of Islamic Thought_ 14:1-21. -https://doi.org/10.24035/ijit.14.2018.001. - -[source,xml] --- - -International Journal of Islamic Thought -10.24035/ijit -https://doi.org/10.24035/ijit.14.2018.001 - --- -==== - diff --git a/_model_docs/location.adoc b/_model_docs/location.adoc deleted file mode 100644 index 0459640..0000000 --- a/_model_docs/location.adoc +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: Locations -description: Access locations and online locations in Relaton -layout: model-docs ---- - -[[location]] -== Location - -* Source: ISO 690, 4.10, ISO 690, 5.10 -* Serialisation: `bibitem/accessLocation`, `bibitem/uri` - -Unpublished items with a limited number of copies that are held at a repository -should be referenced through `bibitem/accessLocation`, -which gives the repository that the cited copy is held in, and the -locator used by the repository. -The repository and locator are not differentiated, and are treated as a single -string. The `bibitem/accessLocation` element is also used for online locations -of digital resources, where a single URL (`bibitem/uri`) is not sufficient, -and either a navigation path, or an in-document object identifier is used. - -An archival URI can be differentiated from an original URI for a resource, -through using "archival" as the `uri/@type`. Alternatively, the archival copy -and the original copy may be treated as related items (through an "instanceOf" -relation), although that is typically not necessary. - -Persistent identifiers and other identifiers expressed as actionable URIs -should still be represented as `bibitem/docidentifier` rather than `bibitem/uri`, -so long as they are managed in a distinct namespace. That applies to such -identifiers as DOI, ARK, Handle, ISSN, etc. - -==== -P.Vind.Tand.25a = HGV P.Vindob. Tandem 25 a = Trismegistos 26540. At: P.Vindob.Gr. Inv. Nr. 12424 + 24718 + 28384. - -(Highly abbreviated format, using conventions familiar to papyrologists) - -[source,xml] --- - - [Untitled] - http://papyri.info/hgv/26540/ - http://aquila.zaw.uni-heidelberg.de/hgv/26540 - https://www.trismegistos.org/text/26540 - P.Vind.Tand.25a - P.Vindob. Tandem 25 a - 26540 - P.Vindob.Gr. Inv. Nr. 12424 + 24718 + 28384. - --- - -(More elaborated form) -[source,xml] --- - - [Untitled] - http://papyri.info/hgv/26540/ - http://aquila.zaw.uni-heidelberg.de/hgv/26540 - https://www.trismegistos.org/text/26540 - P.Vind.Tand.25a - P.Vindob. Tandem 25 a - 26540 - - - Fünfunddreißig Wiener Papyri (P. Vindob. Tandem) - 1976 - - - Pieter Johannes Sijpesteijn - - - - Klaas Anthony Worp - - - - Terra - - - Studia Amstelodamensia ad epigraphicam, ius antiquum et papyrologicam pertinentia - 6 - - - - - 25a - - National Library of Vienna. P.Vindob.Gr. Inv. Nr. 12424 + 24718 + 28384. - --- -==== - -// TODO: The document relation is actually "publishedIn", but I think that's overkill. - - -==== -Australian Government Bureau of Meteorology. _Latest Weather Observations for Dumont D'Urville_. http://www.bom.gov.au. Path: Antarctica: Antarctic Observations: Latest observations: Dumont D'Urville: JavaScript Object Notation format (JSON) in row-major order. Viewed 2018-03-10. - -[source,xml] --- - - Latest Weather Observations for Dumont D'Urville - http://www.bom.gov.au/fwo/IDT60803/IDT60803.89642.json - 2018-03-10 - - - - Australian Government - Bureau of Meteorology - - - http://www.bom.gov.au. Path: Antarctica: Antarctic Observations: Latest observations: Dumont D'Urville: JavaScript Object Notation format (JSON) in row-major order - --- -==== - -==== -British Library Web site February 1997 [online]. archive.org [distributor]. Available from: https://web.archive.org/web/19970218190613/http://www.bl.uk/. [archived 1997-02-18] [viewed 2019-02-28]. - -[source,xml] --- - - British Library Web site February 1997 - 1997-02-18 - 2019-02-28 - http://www.bl.uk/ - https://web.archive.org/web/19970218190613/http://www.bl.uk/ - - - - British Library - - - - - - archive.org - - - --- - -[source,xml] --- - - British Library Web site February 1997 - http://www.bl.uk/ - - - - British Library - - - - - https://web.archive.org/web/19970218190613/http://www.bl.uk/ - 1997-02-18 - 2019-02-28 - - web archive - - archive.org - - - - - --- - -==== - diff --git a/_model_docs/medium.adoc b/_model_docs/medium.adoc deleted file mode 100644 index da01750..0000000 --- a/_model_docs/medium.adoc +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: Medium -description: Categories of medium in Relaton -layout: model-docs ---- - -[[medium]] -== Medium - -* Source: ISO 690, 4.4, ISO 690, 5.4 -* Serialisation: `bibitem/medium` - -ISO 690 differentiates between the content type of the item, -the media type (which includes file format for electronic media), -the carrier type, the size of the item (which can include duration, -and electronic file size, as well as physical medium size), and -for maps, the scale of the item. These are all -modelled as elements of the item medium; the media type or file format -is modelled as `medium/form`. - -There is no fixed vocabulary modelled for any of the elements of `medium` -(although ISO 690 suggests closed Resource Description and Access (RDA) -vocabularies for `medium/content` and `medium/carrier`, and IANA Media Type -is best practice for `medium/form` for electronic resources. As ISO 690 -allows, there may be instances where the medium descriptions need to be -discursive. - -ISO 690 suggests specifying detailed information about the type of electronic -information resource (e.g. "`statistical dataset`"), which cannot be represented -in the type of bibliographic item (`bibitem/@type`), and is likely to be to specific -for the RDA triple of content, carrier and form. The `medium/genre` element is intended -to convey this kind of information, and can be used more generally as a well-recognised -subclass of bibliographic type or content. - -Information about alternate formats should be modelled as related bibliographic -items (through the "instance" document relation), each with their own medium information. - -The size and scale of the item (`medium/size`, `medium/scale`) -usually contains numerical information, but is modelled as a string, -given the complications of how size and scale can be described, particularly for -cartographic material. - -==== -Sigur Rós. -Untitled [Vaka]. In: _( )_ [compact disc]. Track 1. -Mosfellsbær: Sundlaugin, 2002. - -[source,xml] --- - - Untitled - Vaka - 2002 - - composer - Sigur Rós - - -
compact disc
-
- - - ( ) - - composer - Sigur Rós - - - - Sundlaugin - - Mosfellsbær, Iceland - - - - 1 - -
--- -==== - -==== -Easterbrook, Don J. _Geologic Map of Western Whatcom County, Washington_. -Map. 1:62,500. col. 68 x 69 cm. fold. in envelope 30 x 24 cm. -Miscellaneous Investigations Series, map 1-854-B. Reston, VA: U.S. Geological Survey, 1976. - -[source,xml] --- - - Geologic Map of Western Whatcom County, Washington - 1976 - - - Easterbrook, Don J. - - - - U.S. Geological Survey - - -
map
- col. 68 x 69 cm. fold. in envelope 30 x 24 cm. - 1:62500 -
- - Miscellaneous Investigations Series - map 1-854-B - - Reston, VA -
--- -==== - -==== -GATES, B. [BillGates]. (2013, February 26). -#Polio is 99% eradicated. Join me & @FCBarcelona as we work to finish the job and #EndPolio. -[Tweet]. Available from: https://twitter.com/BillGates/status/306195345845665792. -[viewed 2016-07-06T12:30:15+02:00]. See also VIDEO: http://b-gat.es/X75Lvy. - -[source,xml] --- - - #Polio is 99% eradicated. Join me & @FCBarcelona as we work to finish the job and #EndPolio - 2013-02-26 - 2016-07-06T12:30:15+02:00 - - - - - Gates - B. - - - BillGates - - - - https://twitter.com/BillGates/status/306195345845665792 - -
Twitter
- tweet -
- - - http://b-gat.es/X75Lvy - - -
--- -==== - diff --git a/_model_docs/numeration.adoc b/_model_docs/numeration.adoc deleted file mode 100644 index f492379..0000000 --- a/_model_docs/numeration.adoc +++ /dev/null @@ -1,316 +0,0 @@ ---- -title: Numeration and Pagination -description: Numeration and pagination in Relaton -layout: model-docs ---- - -[[numeration]] -== Numeration and pagination - -* Source: ISO 690, 4.7 -* Serialisation: `bibitem/extent`, `bibitem/size` - -The bibliographic `size` of an item is the measure of how large it is, in terms -of measurements related to content (volumes, pages, data size, duration). It is -distinct from the physical size of the time as an object (e.g. height and breadth of a book, -page size such as octavo), which is captured under `bibitem/medium/size`. - -The measures included in the bibliographic size are presented as a sequence of types -and values, which add up to give the size of the item: `bibitem/size/value/@type` and -`bibitem/size/value`. For example, a book with two page numerations is described -by giving both: "`lxii + 490 pages`". This would be presented as: - -[source,xml] --- - - lxii - 490 - --- - -Likewise, the convention of listing plates separately from pages (unnumbered pages, -of different, glossier material, used for full-page illustrations) would be indicated as: - -[source,xml] --- - - 114 - 3 - --- - -corresponding to "`114pp + 3 plates`". - -==== -_Pluralism in the Soviet Union: Essays in Honour of H. Gordon Skilling_. Edited by Susan Gross Solomon. New York: St. Martin's Press, 1983. xiii, 179 pp. $27.50. - -[source,xml] --- - - Pluralism in the Soviet Union: Essays in Honour of H. Gordon Skilling - 1983 - - - - - Solonom - Susan - Gross - - - - - - - St Martin's Press - - - $27.50 - New York - - Nevada Bureau of Mines and Geology Bulletin - 88 - - - xiii - 179 - - --- -==== - -==== -John H. Stewart, Edwin H. McKee, and Harold K. Stager. -_Geology and mineral deposits of Lander County, Nevada_. -Nevada Bureau of Mines and Geology Bulletin 88. 1977. -Reno: University of Nevada. [114 pp, 3 plates] - -[source,xml] --- - - Geology and mineral deposits of Lander County, Nevada - 1977 - - - - - Stewart - John - H. - - - - - - - - McKee - Edwin - H. - - - - - - - - Stager - Harold - K. - - - - - - - University of Nevada - - - Reno - - Nevada Bureau of Mines and Geology Bulletin - 88 - - - 114 - 3 - - --- -==== - - -The bibliographic size of an item is differentiated from its `extent`, the range of -bibliographic size components it occupies within an item. Extent is typically a -characteristic of contained items (link:/model/relations#host-item["host item"]), -e.g. a page range within a monograph or a journal for a journal article or book chapter -(so "`pp. 25-45`"). - -Components of an item are modelled under the `bibitem/extent` element as -one or more "localities"; these consist of a locality type -(`bibitem/extent@type`), a locality value (`bibitem/extent/referenceFrom`), -and optionally a locality range endpoint (`bibitem/extent/referenceTo`). -The locality type is a superset of the types of bibliographic size: an extent -typically involves volumes, pages, or timestamps, but can also extent to other -subdivisions of text, such as figures or appendices. - -If a locality is labelled conventionally with a range, but is in fact a single -item (as often occurs with volumes and issues; e.g. issue 18–19 is in fact a -single issue), the label should be associated with -`bibitem/extent/referenceFrom` rather than being treated as a true range. -However the rendering of the item will typically not be any different. - -A part of a contained item may be cited, and thus may have an extent applying to -the contained item as well as the host item. This has posed difficulty for -some citation schemes (e.g. citing a page within a journal article, which itself -covers a page range: "`Dedes, D. 1993. Ποίηματα του Μαυλανά Ρουμή [Poems by -Mevlana Rumi]. _Ta Istorika_ 10.18-19: 3-22. pp. 7-19`".) However, the model -copes with this by separating the extent of a citation (link:/model/citation[Citation Model]) -from the extent of a bibliograhic item, and the extent of a contained item -from the extent of a host item. In this instance, "`pp. 7-19`" would be treated -normally as part of the citation, not part of the bibliographic item. - -A hierarchical locality is expressed by repeating the extent element -with the different applicable locality types; these should be given in -hierarchical order. (So, for example, "`chapter 4, table 9`".) - -Discontinuous ranges are modelled by repeating the extent element for the same locality type. - -Extent includes the volume and issues of a journal, if the -item is an article in the journal. - -==== -Dedes, D. 1993. Ποίηματα του Μαυλανά Ρουμή [Poems by Mevlana Rumi]. _Ta Istorika_ 10.18-19: 3-22. - -[source,xml] --- - - Poems by Mevlana Rumi - Ποίηματα του Μαυλανά Ρουμή - 1993 - - - - - Dedes - Dimitrios - - - - - Ta Istorika - - - 10 - - - 18–19 - - - 3 - 22 - - --- -==== - -==== -Ramsey, J. K., & McGrew, W. C. (2005). Object play in great apes: Studies in nature and captivity. -In A. D. Pellegrini & P. K. Smith (Eds.), _The nature of play: Great apes and humans_ -(pp. 89-112). [308pp]. New York, NY: Guilford Press. - -[source,xml] --- - - Object play in great apes: Studies in nature and captivity - 2005 - - - - - Ramsey - J. K. - - - - - - - - McGrew - W. C. - - - - - - The nature of play: Great apes and humans - - - - - Pellegrini - A. D. - - - - - - - - Smith - P. K. - - - - - - - Guilford Press - - - New York, NY - - 308 - - - - - 89 - 112 - - --- -==== - -==== -Brown, P. L. (1999, September 5). Tiffany glass and other tales from the crypt. -_The New York Times_, pp. 1, 5. - -[source,xml] --- - - Tiffany glass and other tales from the crypt - 1999-09-05 - - - - - Brown - P. L. - - - - - The New York Times - - - 1 - - - 5 - - --- -==== - diff --git a/_model_docs/production.adoc b/_model_docs/production.adoc deleted file mode 100644 index 426db51..0000000 --- a/_model_docs/production.adoc +++ /dev/null @@ -1,335 +0,0 @@ ---- -title: Production -description: Categories of place and date of publication and publisher in Relaton -layout: model-docs ---- - -[[production]] -== Production - -=== General - -* Source: ISO 690, 4.6 -* Serialisation: `bibitem/place, bibitem/contributor[role@type = "publisher"], bibitem/date` - - -=== Place - -Strictly speaking the place of production -is an attribute of the publisher, and it can in fact be modelled as -`bibitem/contributor[role@type = "publisher"]/organization/address/city`. - -However, it is modelled as a top-level attribute of the bibliographic item -to allow the place to be extracted by consumers of the serialisation more readily, -to allow multiple locations to be associated with the publisher, and to allow -only one of the places of the publisher to be associated with the production of the item. - -A URI in a geographical registry may optionally be given as `place/@uri`. -A region within which the place is located may be given as `place/@region`, -for disambiguation purposes; using a ISO 3166 code for a country or subnational -region is recommended. - -==== -SANGSTER, R. B. _Roman Jakobson and beyond_. Berlin, New York & The Hague: Mouton, 1984. - -[source,xml] ----- - - Roman Jakobson and beyond - 1984 - - - - - Sangster - R. B. - - - - - - - Mouton - - - Berlin - New York - The Hague - ----- -==== - -==== -London (Ontario) - -[source,xml] ----- -London (Ontario) ----- -==== - -=== Publisher - -The publisher is a subclass of creator (link:/model/creator[Creator]). - -ISO 690, 4.1 differentiates between -"`publisher, online information provider, production company`" and -"`distributor, online host`". - -Of the classes of creator that can be used as the publisher, -"`publisher or production company`" and "`printer or manufacturer`" have -`bibitem/contributor/role@type = "publisher"`; -"`distributor or issuing body`" and "`sponsoring body`" have -`bibitem/contributor/role@type = "distributor"`. - -ISO 690, 4.6 allows that distributors, issuers and sponsors -can be named in addition to publishers. - -Any restrictions on access to a resource imposed by an online host -(e.g. geographical restrictions) should be indicated in `bibitem/note`. - -[[date]] -=== Date - -For a point date, only `date/on` is populated. For a date range, `date/from` -and `date/to` are populated. If the range is ongoing, -the `date/to` element is left out. - -The date for `date/on`, `date/from` and `date/to` is by default given as a -Gregorian date/time, following the conventions -of ISO 8601; in an XML serialisation, they would be expected to follow -the XML Schema `xs:datetime` representation (https://www.w3.org/TR/xmlschema-2/[see here]). - -However bibliographic -dates often contain information that cannot be restricted to an ISO 8601 date -(dates in other calendars, date corrections; other subdivisions of the year; -approximate date or no date.) - -For that reason, the -model allows dates to be expressed in text instead of as an ISO 8601 date -(`date/on@text`, `date/from@text`, `date/to@text`), or as well as an ISO 8601 -date if a Gregorian date is still applicable. - -If the textual value of a date is a date range, and ISO 8601 -dates are still to be provided for the start and end of the date range, then -the textual value is repeated for `date/from@text` and `date/to@text`. - -Date corrections may also involve indications of provenance. - -The date of copyright is associated expressly with the copyright holder, in -`bibitem/copyright/date/from`. Unlike other bibliographic dates, the copyright -date can only have a year value. - -==== -ROGET, Peter Mark. _Roget's Thesaurus_. Revised by -Susan M. LLOYD. Burnt Mill, Harlow, Essex: Longman Group Limited, 1982 [1852]. - -[source,xml] ----- - - Roget's Thesaurus - 1852 - 1982 - 1982 - - - - - Roget - Peter - Mark - - - - - revised - - - Lloyd - Susan - M. - - - - - - - Longman Group Limited - - - Burnt Mill, Harlow, Essex - ----- -==== - -==== -2018-05-09, 21:33:28 - -[source,xml] ----- - - 2018-05-09T21:33:28 - ----- -==== - -==== -Islamic calendar 1439 [2017–2018] - -[source,xml] ----- - - 2017 - 2018 - ----- -==== - -==== -1959 [i.e. 1995] - -[source,xml] ----- - - 1959 - - - 1995 - ----- -==== - -==== -Michaelmas term (Oxford), 2002 - -[source,xml] ----- - - 2002-10-91 - 2002-12-17 - ----- -==== - -==== -1650? - -[source,xml] ----- - - 1650 - ----- -==== - -==== -{blank}[no date] - -[source,xml] ----- - ----- -==== - -==== -1951 copied 1957 - -[source,xml] ----- - - 1951 - - - 1957 - ----- -==== - -==== -1951- - -[source,xml] ----- - - 1951 - ----- -==== - -==== -© ISO, 2018 - -[source,xml] ----- - - 1951 - ISO - ----- -==== - - -[[datetypes]] -==== Bibliographic date types - -Dates are associated with specific phases of the production of a bibliographic -item, and those phases are named through `date@type`. - -===== Common dates - -The default type used in bibliography -is the date of publication (`date[@type = "published"]`), but the "`created`", -"`updated`", "`unchanged`", and "`copied`" dates in particular -are often given where they differ from the date of publication. - -The date of transmission is used instead of the date of publication -for a broadcast. - -created:: Date a resource was created. (If there have been multiple versions or editions, this -date applies to the first version.) -published:: Date a resource was published (distributed by the publisher). -accessed:: Date a resource was last accessed by the bibliographer; routinely used -for online publications. (Unlike in ISO 690, no distinction is made between -"viewed" and "accessed" based on whether the resource is human-readable or -machine-readable.) -updated:: Date a resource was updated and republished. Used for new versions and editions. -corrected:: Date a resource was corrected and republished. Used for new versions of documents, -in cases where the correction is not considered to amount to a new edition of the document. -(This is a subjective distinction made by the publisher.) -unchanged:: Date a resource was reprinted, i.e. republished without any changes. -circulated:: Date a draft version of a resource was circulated. Drafts by definition -are not published, so `circulated` is used instead of `published` for draft resources. -(For standards, this is associated with the latest transition to -a formally defined preparation stage, such as Working Draft or Committee Draft.) -transmitted:: Date a resource was broadcast. -copied:: Date a resource was physically copied, or recreated without any substantial -change in content (allowing for change in medium). -adapted:: Date a resource was adapted for a new purpose or audience, with some change -in content (includes translation). -announced:: Date that the existence of the resource was made public knowledge; -applies whether the resource has already been created or not, and whether it is to be -published or not. - -The date of publication is taken to be the date when the current version of the resource -was published, unless a separate "`unchanged`", "`updated`" or "`copied`" date is given; -in that case, the date of publication is assumed to be the date of initial publication. - -The date of creation is taken to apply to the work instantiated by the resource, -rather than to a specific format or edition. The latter are represented by the date -of adaptation and of update, respectively. - - -===== Dates pertaining to standards - -The repertoire of date types is expanded to deal with the particular requirements -of standards shown below. - -implemented:: Date a standard takes effect, becomes active. -obsoleted:: Date a standard becomes no longer in effect, was revoked. -confirmed:: Date a standard is renewed to take effect by an issuing authority. -issued:: Date a standard is authorised for publication. -vote-started:: Date the vote for a draft of the standard started. -vote-ended:: Date the vote for a draft of the standard ended. -stable_until:: The document is guaranteed not to be changed or updated until this date. - - diff --git a/_model_docs/relations.adoc b/_model_docs/relations.adoc deleted file mode 100644 index c4edc08..0000000 --- a/_model_docs/relations.adoc +++ /dev/null @@ -1,813 +0,0 @@ ---- -title: Relations -description: Categories of document relations in Relaton -layout: model-docs ---- - -[[docrelations]] -== Document relations - -=== General - -* Source: ISO 690, 4.3 -* Serialisation: `bibitem/relation` - -The model allows specifying relations between bibliographic items, -with one related item embedded within the other. - -=== Relation types - -`bibitem/relation/@type` gives the base class of the relation -between two bibliographic items. - -The base class of relation types is taken from ISO 690 and -https://www.ifla.org/publications/functional-requirements-for-bibliographic-records[Functional Requirements for Bibliographic Records] (FRBR), -and represents generic bibliographical requirements, particularly -inclusion in a host item (<>: `includedIn`, `includes`) -and translation (<>: `translatedFrom`, `hasTranslation`). - -The class of relation types have been expanded substantially to deal with the -requirements of standards documents. - -In addition, the class has also been designed for extensibility: -refinements to the base class can be expressed through -`bibitem/relation/description`, with the understanding that the -relation described in that element is a subset of the relation -named in `bibitem/relation/@type`. - -Relations can be modelled in a hierarchical fashion, and we attempt -to do so in the following; but relations are kept in `@type`, rather -than moved to `description`, if they are commonplace. - -The modelling of relation types draws on the four basic classes of -bibliographic entity modelled in FRBR: - -Work:: a distinct intellectual or artistic creation - -Expression:: a realisation of a Work (e.g. edition, adaptation) - -Manifestation:: the physical embodiment of an Expression (e.g. -print run; audio vs online vs print) - -Item:: a single exemplar of a Manifestation - -All relations in the following are given with their inverse in -italics and brackets, unless the relation is symmetric. - -==== Part-Whole relations - -includes:: document A includes document B, through a well-defined -relation outlined in <>, and with distinct metadata -(including authorship) and bibliographic record (e.g. Chapter in -Edited Work, Illustration in Book). (_includedIn_) -+ -NOTE: In general, text-based resources have components that can be considered a -different kind of resource (`includes`); components of non-textual resources are -considered to be of the same type as their host (`hasPart`). - -hasPart:: document A includes document B, with no distinct metadata -(other than extent) or bibliographic record, and all items in -document B share the same authorship or corporate authorship (e.g. -Chapter, Section, Part, Volume, Issue, Track) (_partOf_) - -merges:: document A is the result of merging earlier documents B1, B2, B3... -(_mergedInto_) - -splits:: document A1, A2, A3... is split off from earlier documents -B (_splitInto_) - -==== FRBR Level relations - -In the following, document A is typically an Expression, since -expressions are typically what get their own bibliographic entry in -catalogues and databases. - -Relations in the following are subclassed: this is indicated by -indentation. - -instanceOf:: document B is an instance of document A (e.g. an -edition, a format, a single copy: agnostic as to whether B is an -Expression, Manifestation, or Item). (_hasInstance_) -+ --- -Instances are often used in the Relaton modelling of standards, since -concrete documents (FRBR Expressions) are often lumped together -as more abstract entities (typically FRBR Works), particularly for -the purposes of citation. - -Different editions of a standard are often lumped together as a single Work; the -different editions of a standard are then modelled as instances of the undated -standard. Similarly, translations of a standard are often lumped together as a -single Work; the distinct language versions are then modelled as instances of -the same, language-independent standard. - -NOTE: This is a generalized relation of the more specific relations -`exemplarOf`, `manifestationOf`, and `expressionOf`. --- - -exemplarOf:: document B is an Item of document A: document B is a -single physical instance of document A. (_hasExemplar_) - - -manifestationOf:: document B is a Manifestation of document A: -document B is an embodiment in a particular medium of the content of document A. -(_hasManifestation_) -+ -NOTE: This is a generalized relation of the more specific relations -`reproductionOf` and `reprintOf`. - -reproductionOf::: document B is a Manifestation of the same -Expression as document A (reproduction): document B presents the same content as -document A, and document B has been created to reproduce document A faithfully. - (_hasReproduction_) -+ -NOTE: This is a generalized relation of the more specific relation `reprintOf`. - -reprintOf:::: document B is a reproduction of document A, involving -a new publisher or distributor and mass dissemination, and no -overriding concern with reproducing the source manifestation -precisely (not necessarily restricted to print media) (_hasReprint_) - -expressionOf:: document B is an Expression of document A: document B -is a particular realisation of the intellectual or artistic content of the -bibliographic item, which is more generically referred to as document A. -(_hasExpression_) -+ -NOTE: This is a generalized relation of the more specific relations -`translatedFrom`, `arrangementOf`, `abridgementOf`, and `annotationOf`. - -translatedFrom::: document B is an Expression of document A in a -different language than the source Expression of A (translation). -This includes dubbed and subtitled versions of a film. -(_hasTranslation_) - -arrangementOf::: document B is an arrangement Expression of document A. Document -B has the same intellectual or artistic content as document A, and document B -has been created to realise that content through different resources than -document A. (_hasArrangement_) -+ -`arrangementOf` is typically understood to involve the realisation of a musical -work with different instruments or voices than the original. This includes -adding parts or an accompaniment. - -abridgementOf::: document B is an abridged Expression of document A. Document B -presents a subset of the intellectual or artistic content of document A, but is -still intended as a complete work, presenting a shortened version of the source -Expression of A. (_hasAbridgement_) - -annotationOf::: document B is an annotated Expression of document A. -Document B incorporates part or all of document A, and which -enhances document A with explanatory commentary not present in the source -Expression of A (annotation). (_hasAnnotation_) - -===== Revision relations - -FRBR uses Revision to refer to the updating of the content of a -source Expression to form a new Expression, in ways that do not -involve changing language (translation), resources/instrumentation -(arrangement), or extent (abridgement, annotation). So a Revision -updates the content of an Expression, but is not a new Abridgement, -Translation, Arrangement, or Annotation; an Abridgement, -Translation, Arrangement, or Annotation can be based on a specific -Revision; and an Abridgement, Translation, Arrangement, or -Annotation can have multiple Revisions of their own. - -Revision includes not only an author updating the content of their -own work, but a third party updating that content, often after the -author has deceased (indicated bibliographically as "Revised by") It -also includes a scholar reconstructing the author's text on the -basis of available evidence, including previous editions where -available (indicated bibliographically as "Edited by"; hence we can -distinguish Cox's, Edmond's, Lobel & Page's and Voigt's editions of -Sappho, all done in the 20th century). Annotation is most commonly -seen in the context of such scholarly editions, so `annotationOf` -should be reserved for cases where the Expression does not provide -its own version of the textual content of the Work it is annotating. -This is somewhat rare, and FRBR does not model annotations as -distinct from revisions. - -draftOf:: document B is a draft (unpublished version) or revision of document A. -It may also be the first, unpublished expression of document A. Document A may -be a Work or an Expression (e.g. a draft may be specific to an edition or -translation). Document A may or may not be published. (_hasDraft_) - -predecessorDraftOf::: document B is an immediate predecessor draft (unpublished -version) to document A, where the content of document B was modified to create -document A. -(_hasPredecessorDraft_) - -successorDraftOf::: document B is an immediate successor draft (unpublished -version) to document A, where the content of document A was modified to create -document B. (_hasSuccessorDraft_) - -editionOf:: document B is a published revision of document A, or the first -published Expression of document A. Document A is a Work, or else document A is -an Expression with the same language, instrumentation, and substantially the -same extent as B (i.e. translations, arrangements, abridgements, annotations can -have editions; editions cannot have editions). (_hasEdition_) - -updates::: document B is an edition of the same Work as document A, -and is subsequent to document A; A is an Expression. -Unlike the `obsoletes` relation, -the document B may still remain valid after the document A appears. -(However by default in the standards world, it does not.) (_updatedBy_) - -obsoletes::: document A supersedes document B, being applicable or -valid in more or newer domains than document B. (The two documents -are not necessarily Expressions of the same Work.) (_obsoletedBy_) - -NOTE: Documents often have notions of corrections and other minor -adjustments to content, which are not modelled bibliographically as -distinct editions. This distinction or lack of distinction is -captured in Relaton through the `edition` element; the `hasEdition` -relation still applies to such minor variants of the text, whether -they are considered distinct editions or not. - -==== Derived relations - -In the following, the two related items belong to distinct works, -but the creation of document B is determined in some way by document A. - -derivedFrom:: document A is derived from document B, depending on it -for at least some of its content; includes -classes not otherwise specified, such as parodies (_derives_) - -describes::: document A is a description of document B (_describedBy_). -+ -NOTE: This is a generalized relation of the more specific relation `catalogues`. - -catalogues:::: document A is a catalogue including a description of -document B, expected to be a bibliographic record (_cataloguedBy_) - -hasSuccessor::: document A is succeeded by document B in a sequence. -Document A has ceased fulfilling some function, and document B has assumed that -function in its stead. Typically applies when document A is a periodical publication -which has ceased publication, and document B is a new periodical publication, -designated as the continuation of document A (i.e. continuation of journal). (_successorOf_) - -adaptedFrom::: document A is a reworking of document B to make it -suitable for a different audience -(FRBR Adaptation: includes paraphrase, free translation, musical variations) -or medium (FRBR Transformation: includes dramatisation, novelisation, versification, -screenplay). In music, an adaptation changes the musical content, whereas an arrangement -changes the instrumental and vocal resources of the work. (_hasAdaptation_) - -adoptedFrom::: document A is adopted in response to document B. -Document B has its content derived from document A, and has been adopted in -response to it by a distinct authorising body. (_adoptedAs_) -+ -NOTE: Typically document B is a national standard body's counterpart to an -international standard. In this case document A and document B have potentially -the same content, but have distinct institutional authorship and application. -+ -NOTE: This kind of appropriation of text is not characteristic of literary works. -+ -NOTE: This is a generalized relation of the more specific relations `identical`, -`equivalent`, and `nonequivalent`. - -identical:::: document A is adopted from document B, is equivalent to it in -force and scope, and is identical to it in content. - -equivalent:::: document A is adopted from document B, and is equivalent to it in -force and scope, but has not undergone significant textual change. - -nonequivalent:::: document A is adopted from document B, but is not equivalent -to it in force and scope. - -reviewOf::: document A is a evaluation of document B. (_hasReview_) - -commentaryOf::: document A is a commentary on document B, but does -not include substantial text from document B, unlike `annotationOf`, -and so cannot be read independently of document B. -(This distinction is a judgement call.) (_hasCommentary_) - -The distinction between distinct works and expressions of the same -work is subtle, and can vary culturally. Its major consequence is -whether the creator of the derived work is considered a secondary -author, and the derived work is still attributed to the original -author (in which case it is an Expression), or a primary author, -supplanting the original author (in which case it is a new Work). -The differentiation made in FRBR (3.2.1) is: - -____ -For the purposes of this study variant texts incorporating revisions -or updates to an earlier text are viewed simply as expressions of -the same work (i.e., the variant texts are not viewed as separate -works). Similarly, abridgements or enlargements of an existing text, -or the addition of parts or an accompaniment to a musical -composition are considered to be different expressions of the same -work. Translations from one language to another, musical -transcriptions and arrangements, and dubbed or subtitled versions of -a film are also considered simply as different expressions of the -same original work. - -By contrast, when the modification of a work involves a significant -degree of independent intellectual or artistic effort, the result is -viewed, for the purpose of this study, as a new work. Thus -paraphrases, rewritings, adaptations for children, parodies, musical -variations on a theme and free transcriptions of a musical -composition are considered to represent new works. Similarly, -adaptations of a work from one literary or art form to another -(e.g., dramatizations, adaptations from one medium of the graphic -arts to another, etc.) are considered to represent new works. -Abstracts, digests and summaries are also considered to represent -new works. -____ - -==== Other relations - -related:: document A is related to document B in an otherwise -unspecified fashion. - -complementOf:: document A is a complement or supplement of document B -(e.g. concordance, teacher's guide, gloss, addendum, appendix, -libretto, incidental music), and provides additional -or contextual information to help understand the document. (_hasComplement_). - -cites:: document A references document B (_isCitedIn_) - -==== Refinements - -The following relations are treated as refinements, and are expressed in -`bibitem/relation/description`, not `bibitem/relation/type`. - -The refinements a relation type can undergo are open-ended, and this list may be -expanded in the future to encourage interoperability. - -updates:: - -corrects::: document A updates document B, and the change does not -affect the intended meaning (_correctedBy_) - -amends::: document A updates document B, and the change is a minor -change to the intended meaning (_amendedBy_) - -revises::: document A updates document B, and the change is a major -change to the intended meaning (_revisedBy_) - -reproductionOf:: - -facsimile::: document A is a reproduction of two-dimensional -document B (e.g. book, manuscript), which prioritises visual -accuracy. - -replica::: document A is a reproduction of three-dimensional or -pictorial document B (e.g. sculpture, oil painting), which -prioritises visual and tactile accuracy. - - -==== Comparison with other bibliographic relations lists - -The Relaton relations are compared with those in - -* https://www.ifla.org/publications/functional-requirements-for-bibliographic-records[FRBR] -* http://id.loc.gov/ontologies/bibframe-category.html[BIBFRAME] -* https://www.dublincore.org/specifications/bibo/bibo/bibo.rdf.xml[BIBO], and -* https://www.dublincore.org/specifications/dublin-core/dcmi-terms/[Dublin Core]. - -(The directionality of corresponding relations is ignored.) - -.Comparing Relaton bibliographic relations with other related schemes -[options=header] -|=== -|Relaton |FRBR |BIBFRAME |BIBO |Dublin Core - -|includes |hasPart (independent) |*partOf, hasSeries, hasSubseries* | |hasPart -|hasPart |hasPart (dependent) |partOf | |hasPart -|splits |is a reconfiguration of (Item only) |*splitInto, separatedFrom* | | -|merges |is a reconfiguration of (Item only) |*mergerOf, absorbed* | | -|instanceOf | | | | -|exemplarOf |is exemplified by |itemOf | | -|manifestationOf |is embodied in |instanceOf | |hasFormat -|reproductionOf |*is a reproduction of, is an alternate to* |reproductionOf |reproducedIn | -|reprintOf |is a reproduction of | | | -|expressionOf |is realised through |expressionOf | |hasVersion -|expressionOf (as generalization) | | |*transcriptOf* | -|translatedFrom |is a translation of |translationOf |translationOf | -|arrangementOf |is an arrangement of | | | -|abridgementOf |is an abridgement of | | | -|annotationOf | | | | -|draftOf |is a revision of | | | -|editionOf |is a revision of | | | -|updates |is a revision of | | | -|derivedFrom | |*derivativeOf, originalVersion* | |source -|derivedFrom (as generalization) |*is a summary of, is an imitation of* | | | -|describedBy | | |annotates |*description, abstract, tableOfContents* -|hasSuccessor |is a successor to |*precededBy, continues, continuesInPart* | | -|adaptedFrom |*is an adaptation of, is a transformation of* | | | -|adoptedFrom | | | | -|reviewOf | | |reviewOf | -|commentaryOf | | | | -|related | |relatedTo | |relation -|related (as generalization) | |*dataSource* | |*conformsTo* -|complementOf |*complements, supplements* |*accompanies, supplementTo, indexOf, findingAidOf* | |requires -|supersedes | |replacementOf |*affirmedBy (legal), reversedBy (legal), subsequentLegalDecision (legal)* |replaces -|cites | |references |cites |references - -|=== - -NOTE: *Bolded* entries indicate non-identical matches where the -meaning of mapped values differ. Some may represent one-to-many or -partial matches. - -=== Localities - -The relation between two bibliographic items may not apply to either -the first ("source") item, or the second ("target") item, in their -entirety. For that reason, the relation may also specify one more -more localities in the target item (`localityStack`), and one or -more localities in the source item (`sourceLocalityStack`), as -constraining the relation. - -For example, the following expresses that Chapter 3 of the first -edition of _Telescopy_ has been superseded by Chapters 4 and 7 of -the second edition. - -[source,xml] ----- - - Telescopy - 1 - - - Telescopy - 2 - - - - 3 - - - - - 4 - - - 7 - - - - ----- - - -[[host-item]] -=== Host item - -Of the bibliographic types identified in <>, -`incollection`, `inproceedings`, and `inbook` are all inherently -related to a host item. Other types also potentially involve -relations with host items; for example, the relation between a -record track and a record, or a broadcast segment and a broadcast -show. The relation between host item and contained item is modelled -through `includedIn` or `partOf`, depending on whether all included -items share authorship or corporate authorship. - -The relation between any two items optionally includes a locality -element, which indicates which part of the first item is related to -the second. (For example, which part of the first item is superseded -by the second.) The locality in the relation element can be used -with "includedIn" relations, to indicate the extent of the contained -item within the host item; but for consistency, it is preferable to -use the `extent` element in the contained item, which has the same -meaning. - -The expected relations between host and contained items are as follows: - -|=== -|Host |Contained |Relation - -|book, booklet, manual, techreport -|incollection (if has its own title—autonomous item) -|includedIn - -|book, booklet, manual, techreport -|inbook (if it does not have its own title, e.g. numbered chapter, page span) -|partOf - -|journal -|article -|includedIn - -|proceedings, conference -|inproceedings -|includedIn - -|thesis, standard, patent -|inbook -|partOf - -|map -|map -|partOf (atlas) or includedIn (collection) - -|electronic resource -|electronic resource -|partOf (multipart work) or includedIn (collection) - -|broadcast -|broadcast (treated as same corporate author) -|partOf - -|music -|music (typically involves same author) -|partOf - -|graphic work -|graphic work -|partOf (multipart work) or includedIn (collection) - -|film -|film (typically involves same author) -|partOf - -|video -|video (typically involves same author) -|partOf - -|=== - -In general: text-based resources have components that can be -considered a different kind of resource; components of non-textual -resources are considered to be of the same type as their host. - - -==== -Ramsey, J. K., & McGrew, W. C. (2005). Object play in great apes: Studies in nature and captivity. -In A. D. Pellegrini & P. K. Smith (Eds.), _The nature of play: Great apes and humans_ -(pp. 89-112). New York, NY: Guilford Press. - -[source,xml] --- - - Object play in great apes: Studies in nature and captivity - 2005 - - - - - Ramsey - J. K. - - - - - - - - McGrew - W. C. - - - - - - The nature of play: Great apes and humans - - - - - Pellegrini - A. D. - - - - - - - - Smith - P. K. - - - - - - - Guilford Press - - - New York, NY - - - - 89 - 112 - - --- -==== - -==== -Sigur Rós. -Untitled [Vaka]. In: _( )_ [compact disc]. Track 1. -Mosfellsbær: Sundlaugin, 2002. - -[source,xml] --- - - Untitled - Vaka - 2002 - - composer - Sigur Rós - - -
compact disc
-
- - - ( ) - - composer - Sigur Rós - - - - Sundlaugin - - Mosfellsbær, Iceland - - - - 1 - -
--- -==== - -[[translation]] -=== Translation - -Translations are items derived from an item in a different language. -Typically in bibliographies, the details of the source item are not -provided for a translation, outside of the original author, and -possibly the date of publication and the source language title of -the original title. - -If the information about the source item is limited to these, no -relation need be invoked in the title: - -* the source title can be modelled as an original title variant -(<>); - -* the author differentiated from the translator as creators -(<>); and - -* the date of authorship differentiated from the date of translation -(<>: `date[@type="created"]` vs `date[@type="adapted"]`). - -However, if any further details of the source item need to be -provided (e.g. source language: ISO 690, 4.11), they should -be modelled through an overt relation between the source item -and the translation. - -==== -PRUS, Bolesław. 1912 [1895–1896]. _La Faraono_ [Faraon]. Translated -by Kabe (pseud. of Kazimierz BEIN). 2nd revised edition. -Paris: Hachette. - -Single work representation: -[source,xml] --- - - La Faraono - Faraon - 18951896 - 1907 - 1912 - - - - - Prus - Bolesław - - - - - - - - Kabe - pseud. of Kazimierz Bein - - - - - - - Hachette - - - 2nd revised edition - eo - Paris - --- - -Related work representation: -[source,xml] --- - - La Faraono - 1907 - 1912 - - - - - Prus - Bolesław - - - - - - - - Kabe - pseud. of Kazimierz Bein - - - - - - - Hachette - - - 2nd revised edition - eo - - Faraon - 18941895 - 18951896 - - - - - Prus - Bolesław - - - - - - - Tygodnik Ilustrowany - - - pl - Warsaw - - Paris - --- -==== - -==== -Demosthenes. _Speeches 50-59_. Translated from the Greek by -Victor BERS. Austin: University of Texas Press, 2003. - -[source,xml] --- - - Speeches 50-59 - 2003 - - - - - Demosthenes - - - - - - - - Bers - Victor - - - - - - - University of Texas Press - - - en - - - Speeches 50-59 - grc - - - Austin - --- -==== - diff --git a/_model_docs/series.adoc b/_model_docs/series.adoc deleted file mode 100644 index 791317e..0000000 --- a/_model_docs/series.adoc +++ /dev/null @@ -1,169 +0,0 @@ ---- -title: Series -description: Series in Relaton -layout: model-docs ---- - -[[series]] -== Series title and number - -=== General - -* Source: ISO 690, 4.8, ISO 690, 5.2 -* Serialisation: `bibitem/series` - - -=== Journals - -Articles have their journal title modelled as the series title of the article item. -However, the journal volume and issue should be modelled as part of the article -item extent (link:/model/numeration[Numeration]), rather than as part of the series (ISO 690, 4.7). - -=== Standards - -Standards body identifiers for standards (ISO 690, 5.9) are modelled as series numbers. - -==== -ISO 690, _Information and documentation -- Guidelines for bibliographic references and citations to information resources_. - -[source,xml] --- - - Information and documentation -- Guidelines for bibliographic references and citations to information resources - - - - International Organization for Standardization - - - - ISO - 690 - - --- -==== - -=== Archival materials - -The collection or fonds of archival material is modelled as a series. - -=== Qualifiers - -Organization and Place of Publication can be added to series titles for disambiguation. -Organization in this instance is only modelled as a strings, rather than as a detailed -object (cf. link:/model/creator#organisation[Organisation]). The `formattedTitle` element is used to enforce the formatting -of the series title and its qualifiers. - -==== -_Life_. MDPI. + -_Life_ (Basel). (https://en.wikipedia.org/wiki/Life_(journal)) - -[source,xml] --- - - Life - Basel - MDPI - _Life_ (Basel) - --- -==== - -==== -_Life_. (New York). (https://en.wikipedia.org/wiki/Life_(magazine)) - -[source,xml] --- - - Life - New York - --- -==== - -=== Earlier and later titles - -The current title of a series is given with `series@type` as "main" (which is the default); -alternate titles, including -historical titles, are given with `series@type` as "alt". Different time spans for historical -titles are given with `series/dateFrom` and `series/dateTo`. - -==== -_New Scientist_. 1956-1971. + -_New Scientist and Science Journal. Jan 21, 1971-Sept 30, 1971. + -_New Scientist_. 1971-. - -[source,xml] --- - - New Scientist - 1956 - 1956 - - - New Scientist and Science Journal - 1971-01-21 - 1971-09-30 - - - New Scientist - 1971-09-30 - --- -==== - -=== Series runs - -If a series restarts numbering its volumes, that is typically indicated in citations -by giving an ordinal number for the series run, given after the series name: -1st series, 2nd series, 3rd series. -More commonly, there are only two series runs for a series, and the second run is -indicated as "`new series`", or the abbreviation "`n.s.`". - -* _Vizantiiskii Vremmenik_ (St Petersburg/Petrograd/Leningrad, 1894-1928) and -_Vizantiiskii Vremmenik_ (Moscow, 1947-) have the same name, and volume numbering -for the Moscow journal restarted at 1; the first two -volumes of the new series run were numbered 1/26 and 2/27, to continue the first series. -While citations could differentiate the two by city, usual practice is to insert -"`n.s.`" after the journal title for the second series. - -* The _Journal of the Royal Anthropological Institute_ was originally published -as _Man_, from 1901-1965. The journal restarted numbering at 1 from 1966-1996 -without changing name, and explicitly designating itself as a "`new series`". -Unlike _Vizantiiskii Vremmenik_, both series were published in London, so -place of publication cannot differentiate between them. While the organization did -change name between the two runs (from "`Anthropological Institute of Great Britain and Ireland`" to -"`Royal Anthropological Institute of Great Britain and Ireland`"), the change is slight; -and the series run is preferred to differentiate the two runs. - -==== -\J. A. Barnes. 1966. Durkheim's Division of Labour in Society. _Man_ (n.s.) 1(2): 158-175. - -[source,xml] ----- - - Durkheim's Division of Labour in Society - 1966 - - - - - Barnes - J. A. - - - - - Man - 1 - 2 - new series - - - 158 - 175 - - ----- -==== diff --git a/_model_docs/title.adoc b/_model_docs/title.adoc deleted file mode 100644 index 4645746..0000000 --- a/_model_docs/title.adoc +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: Title -description: Categories of title in Relaton -layout: model-docs ---- - -[[title]] -== Title - -=== General - -* Source: ISO 690, 4.2 -* Serialisation: `bibitem/title` - -[[alt-title]] -=== Alternative titles - -A resource can have multiple titles, including alternative titles -and subtitles. Titles are -classified through `title@type`; the grammar is open-ended as to title types, -but we recommend using "`alternative`", "`subtitle`", -"`unofficial`" (i.e. -a title that has become prevalent but has never been the official/intended title -of the resource), -"`original`" (including the source language title of a translated resource), -and "`main`" (for the proper title or titles of the resource). If a title type is -not given, it is assumed to be a main title. - -"`Untitled`" can be treated as a main title. - -==== -Lemuel Gulliver [pseud. of Jonathan Swift]. -_Travels into Several Remote Nations of the World. In Four Parts_ -[Gulliver's Travels]. London: Benj. Motte, 1798. - -[source,xml] --- - - Travels into Several Remote Nations of the World. In Four Parts - Gulliver's Travels - 17261727 - - - Lemuel Gulliver - pseud. of Jonathan Swift - - - - Benj. Motte - - London - --- -==== - -==== -Sun Tzu. -_The Art of War_ [孫子兵法]. Translated by Samuel B. Griffith. -Oxford: Oxford University Press, 1963. - -[source,xml] --- - - 孫子兵法 - The Art of War - 1963 - - - Sun Tzu - - - - Samuel B. Griffith - - - - Oxford University Press - - Oxford - --- -==== - -==== -Sigur Rós. -Untitled [Vaka]. In: _( )_ [compact disc]. Track 1. -Mosfellsbær: Sundlaugin, 2002. - -[source,xml] --- - - Untitled - Vaka - 2002 - - composer - Sigur Rós - - -
compact disc
-
- - - ( ) - - composer - Sigur Rós - - - - Sundlaugin - - Mosfellsbær, Iceland - - - - 1 - -
--- -==== - diff --git a/_pages/api.html b/_pages/api.html deleted file mode 100644 index c9d57a1..0000000 --- a/_pages/api.html +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Try the Relaton API -description: Try the Relaton API -layout: post -extra_scripts: - - src: /assets/js/relaton_api.js ---- -
-
- - - -
-
- - -
-
- Options - - - - -
-

-  
-
-

\ No newline at end of file
diff --git a/_pages/asciibib.adoc b/_pages/asciibib.adoc
deleted file mode 100644
index c6bb211..0000000
--- a/_pages/asciibib.adoc
+++ /dev/null
@@ -1,336 +0,0 @@
----
-title: AsciiBib
-description: Defining bibliographic items using structured syntax in ASCII
-layout: asciibib-docs
-external_links:
-  - url: https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc
----
-
-AsciiBib provides an AsciiDoc-like syntax for entering a Relaton
-bibliographic entry based on the Relaton data model
-(similarly, to link:/specs/relaton-yaml[Relaton YAML representation]).
-
-There are two syntaxes for entering AsciiBib bibliographic entries:
-
-* link:/asciibib/nested/[AsciiBib nested definition lists (syntax)]
-* link:/asciibib/path/[AsciiBib path-style definition lists (syntax)]
-
-AsciiBib is very useful when needing to define bibliographic items
-inside an AsciiDoc structure, such as within Metanorma AsciiDoc.
-
-NOTE: Metanorma uses AsciiBib syntax.
-For those looking to enter bibliographic items in Metanorma,
-this is the article you want to read.
-
-The following structure is in place for encoding `bibitem` as AsciiBib objects.
-The structure has not yet been generalised to `bibdata/ext`, the
-flavour-specific extensions of Relaton.
-
-NOTE: Relaton AsciiBib can be used to represent bibliographic entries in Metanorma.
-
-If an element in Relaton XML has attributes, the content of the element is represented in AsciiBib
-with a `content` key:
-
-[source,xml]
-----
-Geographic information
-----
-
-[source]
-----
-title.type:: main
-title.content:: Geographic information
-----
-
-Any elements with a cardinality of many can be represented as arrays. In case elements in array
-have multiple attributes they are prepended with empty name of element. For example,
-a Relaton can have multiple titles, and multiple languages:
-
-[source]
-----
-title::
-title.type:: main
-title.content:: Geographic information
-title.language:: en
-title::
-title.type:: main
-title.content:: Information géographique
-title.language:: fr
-language:: en
-language:: fr
-----
-
-The structure below is given in AsciiBib format:
-[source]
-----
-[%bibitem]
-== {blank}
-id:: ISOTC211
-fetched:: 2020-11-16
-title::
-title.type:: title-main
-title.content:: Geographic information
-title.format:: text/plain
-title::
-title.type:: main
-title.content:: Geographic information
-title.format:: text/plain
-title::
-title.content:: Information géographique
-title.language:: fr
-title.script:: Latn
-title.format:: text/plain
-type:: standard
-docid::
-docid.type:: ISO
-docid.id:: TC211
-docid::
-docid.type:: isbn
-docid.id:: ISBN
-docid::
-docid.type:: lccn
-docid.id:: LCCN
-docid::
-docid.type:: issn
-docid.scope:: series
-docid.id:: ISSN
-docid::
-docid.type:: URN
-docid.id:: urn:iso:std:iso:123:stage-90.93:ed-3:en,fr
-docid:: XYZ
-docnumber:: 123456
-edition:: 1
-language:: en
-language:: fr
-script:: Latn
-version.revision_date:: 2019-04-01
-version.draft:: draft
-biblionote:: note
-biblionote::
-biblionote.type:: annote
-biblionote.content:: An note
-biblionote::
-biblionote.type:: howpublished
-biblionote.content:: How published
-biblionote::
-biblionote.type:: comment
-biblionote.content:: Comment
-biblionote::
-biblionote.type:: tableOfContents
-biblionote.content:: Table Of Contents
-docstatus.stage:: 30
-docstatus.substage:: substage
-docstatus.iteration:: final
-date::
-date.type:: issued
-date.on:: 2014
-date::
-date.type:: published
-date.on:: 2014-04
-date::
-date.type:: accessed
-date.on:: 2015-05-20
-abstract::
-abstract.content:: ISO 19115-1:2014 defines the schema required for ...
-abstract.language:: en
-abstract.script:: Latn
-abstract.format:: text/plain
-abstract::
-abstract.content:: L'ISO 19115-1:2014 définit le schéma requis pour ...
-abstract.language:: fr
-abstract.script:: Latn
-abstract.format:: text/plain
-copyright.owner.name:: International Organization for Standardization
-copyright.owner.abbreviation:: ISO
-copyright.owner.url:: www.iso.org
-copyright.role.type:: publisher
-copyright.from:: 2014
-copyright.to:: 2020
-copyright.scope:: Scope
-link::
-link.type:: src
-link.content:: https://www.iso.org/standard/53798.html
-link::
-link.type:: obp
-link.content:: https://www.iso.org/obp/ui/#!iso:std:53798:en
-link::
-link.type:: rss
-link.content:: https://www.iso.org/contents/data/standard/05/37/53798.detail.rss
-link::
-link.type:: doi
-link.content:: https://doi.org/10.6028/NIST.HB.105-3-1997
-link::
-link.type:: file
-link.content:: file://path/file
-medium.form:: medium form
-medium.size:: medium size
-medium.scale:: medium scale
-place::
-place.name:: bib place
-place::
-place.city:: Geneva
-place.region:: Switzelznd
-extent::
-extent.loclaity.type:: section
-extent.loclaity.reference_from:: Reference from
-extent.loclaity.reference_to:: Reference to
-extent::
-extent.loclaity.type:: chapter
-extent.loclaity.reference_from:: 4
-extent::
-extent.loclaity.type:: page
-extent.loclaity.reference_from:: 10
-extent.loclaity.reference_to:: 20
-extent::
-extent.loclaity.type:: volume
-extent.loclaity.reference_from:: 1
-accesslocation:: accesslocation1
-accesslocation:: accesslocation2
-classification::
-classification.type:: type
-classification.value:: value
-classification::
-classification.type:: keyword
-classification.value:: Keywords
-classification::
-classification.type:: mendeley
-classification.value:: Mendeley Tags
-validity.begins:: 2010-10-10 12:21
-validity.ends:: 2011-02-03 18:30
-validity.revision:: 2011-03-04 09:00
-contributor::
-contributor.organization.name:: International Organization for Standardization
-contributor.organization.abbreviation:: ISO
-contributor.organization.subdivision:: division
-contributor.organization.url:: www.iso.org
-contributor.role.description:: Publisher role
-contributor.role.type:: publisher
-contributor::
-contributor.person.name.completename.content:: A. Bierman
-contributor.person.name.completename.language:: en
-contributor.person.affiliation.organization.name:: IETF
-contributor.person.affiliation.organization.abbreviation:: IETF
-contributor.person.affiliation.organization.identifier.type:: uri
-contributor.person.affiliation.organization.identifier.value:: www.ietf.org
-contributor.person.address.street:: Street
-contributor.person.address.city:: City
-contributor.person.address.state:: State
-contributor.person.address.country:: Country
-contributor.person.address.postcode:: 123456
-contributor.person.contact.phone:: 223322
-contributor.person.contact.type:: mobile
-contributor.role.type:: author
-contributor::
-contributor.organization.name:: IETF
-contributor.organization.abbreviation:: IETF
-contributor.organization.identifier.type:: uri
-contributor.organization.identifier.value:: www.ietf.org
-contributor::
-contributor.role.description:: Publisher description
-contributor.role.type:: publisher
-contributor::
-contributor.role.description:: Editor description
-contributor.role.type:: editor
-contributor::
-contributor.person.name.forename.content:: Forename
-contributor.person.name.forename.language:: en
-contributor.person.name.formatted_initials.content:: A.
-contributor.person.name.formatted_initials.language:: en
-contributor.person.name.surname.content:: Bierman
-contributor.person.name.surname.language:: en
-contributor.person.name.addition.content:: Addition
-contributor.person.name.addition.language:: en
-contributor.person.name.prefix.content:: Prefix
-contributor.person.name.prefix.language:: en
-contributor.person.affiliation.description.content:: Description
-contributor.person.affiliation.description.language:: en
-contributor.person.affiliation.organization.name:: IETF
-contributor.person.affiliation.organization.abbreviation:: IETF
-contributor.person.type:: uri
-contributor.person.value:: www.person.com
-contributor.person.address.street:: Street
-contributor.person.address.city:: City
-contributor.person.address.state:: State
-contributor.person.address.country:: Country
-contributor.person.address.postcode:: 123456
-contributor.person.contact.phone:: 223322
-contributor.person.contact.type:: mobile
-contributor.role.type:: author
-contributor::
-contributor.organization.name:: Institution
-contributor.role.description:: sponsor
-contributor.role.type:: distributor
-relation::
-relation.type:: updates
-relation.bibitem.formattedref:: ISO 19115:2003
-relation::
-relation.type:: obsoletes
-relation.desctiption.content:: supersedes
-relation.desctiption.format:: text/plain
-relation.bibitem.type:: standard
-relation.bibitem.formattedref:: ISO 19115:2003/Cor 1:2006
-relation::
-relation.type:: partOf
-relation.bibitem.title.type:: main
-relation.bibitem.title.content:: Book title
-relation.bibitem.title.format:: text/plain
-series::
-series.type:: main
-series.title.type:: original
-series.title.content:: ISO/IEC FDIS 10118-3
-series.title.language:: en
-series.title.script:: Latn
-series.title.format:: text/plain
-series.place:: Serie's place
-series.organization:: Serie's organization
-series.abbreviation:: ABVR
-series.from:: 2009-02-01
-series.to:: 2010-12-20
-series.number:: serie1234
-series.partnumber:: part5678
-series::
-series.type:: alt
-series.formattedref.content:: serieref
-series.formattedref.language:: en
-series.formattedref.script:: Latn
-series.formattedref.format:: text/plain
-series::
-series.type:: journal
-series.title.content:: Journal
-series.title.format:: text/plain
-series.number:: 7
-series::
-series.title.variant::
-series.title.variant.content:: Series
-series.title.variant.language:: en
-series.title.variant.script:: Latn
-series.title.variant::
-series.title.variant.content:: Séries
-series.title.variant.language:: fr
-series.title.variant.script:: Latn
-series.title.format:: text/plain
-doctype:: document
-keyword:: Keyword
-keyword:: Key Word
-editorialgroup.technical_committee.content:: Editorial group
-editorialgroup.technical_committee.number:: 1
-editorialgroup.technical_committee.type:: Type
-ics.code:: 01
-ics.text:: First
-structured_identifier::
-structured_identifier.docnumber:: 123
-structured_identifier.agency:: agency 1
-structured_identifier.agency:: agency 2
-structured_identifier.type:: type 1
-structured_identifier.class:: class 1
-structured_identifier.partnumber:: 4
-structured_identifier.edition:: 1
-structured_identifier.version:: 2
-structured_identifier.supplementtype:: type 2
-structured_identifier.supplementnumber:: 5
-structured_identifier.language:: en
-structured_identifier.year:: 2020
-structured_identifier::
-structured_identifier.docnumber:: 456
-structured_identifier.agency:: agency 3
-----
diff --git a/_pages/blog.html b/_pages/blog.html
deleted file mode 100644
index 0b60b09..0000000
--- a/_pages/blog.html
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Blog
-description: Updates on Relaton development
-layout: blog-index
-hero_include: index-page-hero.html
----
diff --git a/_pages/guides.adoc b/_pages/guides.adoc
deleted file mode 100644
index 5ce7eae..0000000
--- a/_pages/guides.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: Cite publications from supported organizations
-description: Citation guides for Relaton-supported organizations
-layout: cite-docs
----
-:page-liquid:
-
-{% assign guides = site.cite_docs | sort: "flavor" %}
-{% for item in guides %}
-link:{{ item.url }}[*{{ item.flavor }}*]:: {{ item.title }}
-
-{% endfor %}
diff --git a/_pages/model.adoc b/_pages/model.adoc
deleted file mode 100644
index df55e65..0000000
--- a/_pages/model.adoc
+++ /dev/null
@@ -1,28 +0,0 @@
----
-title: Relaton information models
-description: Specifications of the Relaton bibliographic and citation data models.
-layout: model-docs
-external_links:
-  - url: https://github.com/relaton/relaton-models
----
-:page-liquid:
-
-These bibliographic models are developed to consolidate and standardize
-the data models used for bibliographic and citation purposes.
-
-The Relaton information models are defined on GitHub:
-
-* https://github.com/relaton/relaton-models
-
-
-These models are meant to be fully compatible with the latest edition of
-https://www.iso.org/standard/72642.html[ISO 690:2021] and ISO TC
-46’s (and SC 4, SC 9) work on bibliography.
-
-{% assign model_type = site.model_docs | sort %}
-
-{% for item in model_type %}
-link:{{ item.url }}[*{{ item.title }}*]:: {{ item.description }}
-
-{% endfor %}
-
diff --git a/_pages/software.html b/_pages/software.html
deleted file mode 100644
index 34891a5..0000000
--- a/_pages/software.html
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Software
-description: Software of Relaton
-layout: software-index
-hero_include: index-page-hero.html
----
diff --git a/_pages/specs.html b/_pages/specs.html
deleted file mode 100644
index 86ca80c..0000000
--- a/_pages/specs.html
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Specifications
-description: Specifications of Relaton
-layout: spec-index
-hero_include: index-page-hero.html
----
diff --git a/_posts/2022-12-28-relaton-doi.adoc b/_posts/2022-12-28-relaton-doi.adoc
deleted file mode 100644
index 5a35c62..0000000
--- a/_posts/2022-12-28-relaton-doi.adoc
+++ /dev/null
@@ -1,379 +0,0 @@
----
-layout: post
-title: Support for DOI bibliographic information auto-fetch through CrossRef
-date: 2022-12-28
-categories: relaton
-authors:
-  -
-    name: Nick Nicholas
-    email: nick.nicholas@ribose.com
-    social_links:
-      - https://github.com/opoudjis
-  -
-    name: Andrei Kislichenko
-    email: andrew2net@gmail.com
-    social_links:
-      - https://github.com/andrew2net
-
-excerpt: >-
-  Relaton now supports auto-fetching Crossref bibliographic information via DOI
-  identifiers.
----
-
-== Introduction
-
-=== Digital Object Identifier and the DOI system
-
-Since 1997, the https://www.doi.org[Digital Object Identifier (DOI)] service has
-been part of the essential infrastructure of digital publishing, registering and
-managing a unique identifier (DOI identifier) for all publications.
-
-The DOI identifier scheme was ratified as an ISO standard as ISO 26324
-(https://www.iso.org/standard/43506.html[ISO 26324:2012],
-https://www.iso.org/standard/81599.html[ISO 26324:2022]), with the
-actual implementation managed by the DOI Foundation, which delegates
-registration matters to DOI registration agencies. DOI identifiers are lodged
-with a DOI registration agency.
-
-As publishers and agencies have embraced the DOI, these identifiers have become
-ubiquitous, and have been adopted not only for most new publications, whether
-electronic or hardcopy, but increasingly for past publications as well,
-especially as those publications are reissued online.
-
-One of the main advantages to a widely used identifier for publications is that
-value-added services can use that identifier to provide information about the
-publication.
-
-=== Crossref
-
-Among a wide range of online services that operate on the DOI identifier,
-https://www.crossref.org[Crossref] is of particular interest in the data it
-collects and offers in the topic of bibliography.
-
-Crossref, now a DOI registration agency, was originally established by a
-consortium of member publishers intended to facilitate stable cross-references
-(hence, "cross-ref") and citations across academic journal articles.
-
-Therefore it is in the interests of Crossref, not only to register DOIs
-for publications, and use them in online publication, but also to associate
-those DOIs with bibliographic information that can be used in citations.
-
-As a result, Crossref has one of the largest online bibliographic databases in
-existence, counting more than 141 million records today.
-
-NOTE: It is worth noting that out of the millions of DOI identifiers,
-*still only a fraction* of them have bibliographic information on Crossref. So
-if Crossref doesn't return information for a particular DOI identifier, don't
-fret.
-
-=== Crossref bibliographic API
-
-Crossref has made this database publicly available
-in recent years through an
-https://www.crossref.org/documentation/retrieve-metadata/rest-api/[API],
-and is committed to making citation information openly available.
-
-The Crossref API data is natively in a Crossref JSON Schema, but it can readily
-be exported into popular bibliographic export formats.
-
-In fact, a search on the Crossref home page for DOI `10.1515/9783110889406.257`
-returns
-https://search.crossref.org/?from_ui=yes&q=10.1515/9783110889406.257[on its landing page]
-links not only to the
-https://api.crossref.org/v1/works/10.1515/9783110889406.257[Native Crossref JSON record]
-and the
-https://www.degruyter.com/document/doi/10.1515/9783110889406.257/html[URI of the associated resource],
-but also exports of the JSON record (via Javascript, as "Cite"), both
-machine-readable (BibTeX, RIS), and as human-readable renderings (APA, Harvard,
-MLA, Vancouver, Chicago).
-
-
-== Relaton integration with Crossref
-
-Relaton-DOI (the https://github.com/relaton/relaton-doi/[relaton-doi] gem)
-integrates the Crossref bibliographic database through the Crossref API, and
-Crossref bibliographic records are now available to the Relaton ecosystem.
-
-In the following examples, we show the method of access to a Crossref
-bibliographic record given its DOI identifier, and how to use it in your chosen
-environment.
-
-We also outline some of the enhancements we have brought to Crossref data, and
-some of the caveats to bear in mind while using it.
-
-
-== Fetching Crossref data from Relaton CLI
-
-Like all Relaton gems, a reference can be fetched from `relaton-doi` through the
-https://github.com/relaton/relaton-cli/[Relaton CLI].
-
-.Install Relaton-DOI at the command line
-[source,console]
-----
-$ gem install relaton-cli
-----
-
-.Fetching bibliographic data using a DOI identifier in Relaton XML format
-[source,console]
-----
-$ relaton fetch doi:10.1515/9783110889406.257
-# returns record for 10.1515/9783110889406.257 in Relaton XML
-----
-
-.Fetching bibliographic data using a DOI identifier in Relaton YAML format
-[source,console]
-----
-$ relaton fetch doi:10.1515/9783110889406.257 -f yaml
-# returns record for 10.1515/9783110889406.257 in Relaton YAML
-----
-
-.Fetching bibliographic data using a DOI identifier in BibTeX format
-[source,console]
-----
-$ relaton fetch doi:10.1515/9783110889406.257 -f bibtex
-# returns record for 10.1515/9783110889406.257 in Bibtex
-----
-
-As with any command line tool, the output of these commands can be redirected to
-a text file and stored.
-
-The command line tool consumes identifiers from a range of sources, and it
-requires `doi:` to be prefixed to each DOI, so they can be recognized as such.
-
-So, if you wish to build up a BibTeX database of bibliographic entries given some DOIs, you
-might write a shell script to loop through the DOIs, and write each BibTeX object fetched into a file,
-like this:
-
-.bash script using Relaton to fetch Crossref data using DOI identifiers into a BibTeX file
-[source,sh]
-----
-#!/bin/bash
-StringVal="10.1515/9783110889406.257 10.6028/nist.ir.8245 doi:10.1215/9781478007609-047"
-echo "" > my.bibtex
-for doi in $StringVal; do
-  relaton fetch doi:$doi -f bibtex >> my.bibtex
-done
-----
-
-== Ruby
-
-The `relaton-doi` gem can be used natively in your Ruby code, although this
-presupposes that you are already coding within the relaton Ruby ecosystem.
-
-The received objects will be native Relaton objects, which will eventually need
-to be exported to XML, YAML, or BibTeX.
-
-.Ruby code that fetches Relaton bibliographic objects using DOI identifiers
-[source,ruby]
-----
-> require 'relaton_doi'
-=> true
-
-# get NIST standard
-> RelatonDoi::Crossref.get "doi:10.6028/nist.ir.8245"
-[relaton-doi] ["doi:10.6028/nist.ir.8245"] fetching...
-[relaton-doi] ["doi:10.6028/nist.ir.8245"] found 10.6028/nist.ir.8245
-=> #-
-  With the adoption of the latest NIST PubID 1.0 scheme, the NIST Library has
-  decided to retroactively apply the scheme to CyberSecurity White Papers
-  published by the CSRC. This post provides a mapping from the old CSWP PubIDs
-  to the newly assigned PubIDs.
----
-= NIST CyberSecurity White Paper PubID scheme change and mapping
-
-== General
-
-NIST has now officially adopted the
-https://www.nist.gov/system/files/documents/2022/04/01/PubID_Syntax_NIST_TechPubs.pdf[NIST PubID 1.0 scheme],
-which describes a clever publication identifier across all NIST Technical Publications.
-
-More background information on the NIST PubID can be found on this
-https://www.metanorma.org/posts/2022-01-09-nist-pubid[Metanorma blog post].
-
-NIST Cyber Security White Papers (CSWP) are cybersecurity-related documents that
-represent latest research or a consensus-based expert topic. A number of
-important publications, such as the NIST Cyber Security Framework,
-the NIST Privacy Framework, are all published as CSWPs.
-
-In the past, CSWP PubIDs utilize the date string `ddmmyyyy` as their unique
-identifier. This usage is also reflect in the PubID 1.0 document itself.
-
-Very recently, the NIST Research Library decided that CSWPs are to be
-represented with a sequential number for each publication, possibly in response
-to some CSWPs having been published on the same date.
-
-.Previous NIST CSWP PubID scheme conflicted when publication dates are identical
-[example]
-The "NIST Privacy Framework" (old PubID "NIST CSWP 01162020") and
-"Case Studies in Cyber Supply Chain Risk Management: Observations from Industry"
-(old PubID "NIST CSWP 02042020-2") were both published on the same day, leading
-to a non-unique PubID.
-
-As a result, the old CSWP PubIDs have been replaced with a new assignment.
-Since the assignment was a manual one, an old-to-new mapping becomes necessary.
-
-.NIST Cyber Security Framework 1.0 was `NIST CSWP 02122014` now `NIST CSWP 4`
-[example]
-The NIST Cyber Security Framework 1.0 originally had the PubID "NIST CSWP 02122014",
-and is now been assigned "NIST CSWP 4".
-
-.NIST Privacy Framework was `NIST CSWP 01162020` now `NIST CSWP 10`
-[example]
-The NIST Privacy Framework originally had the PubID "NIST CSWP 01162020",
-and is now been assigned "NIST CSWP 10".
-
-== CSWP PubID mapping: old to new
-
-Relaton users who have been citing or referencing CSWPs using the previous
-CSWP PubID syntax will somewhat be in confusion when learning about the change
-of their CSWP's PubID -- how will I know what the new CSWP PubID is, since
-the IDs are sequentially assigned manually?
-
-Here comes the rescue!
-
-https://www.nist.gov/people/james-foti[James Foti] of the NIST ITL Cyber
-Security Division is one of the authors of the NIST PubID 1.0 scheme.
-He has graciously provided a mapping table for those who have cited the old
-CSWP PubIDs to the new CSWP PubIDs.
-
-When using the latest versions of Relaton, please utilize the new PubID to
-refer to CSWP documents.
-
-Thank you Jim!
-
-[cols="2a,a,a,a,3a,5a",options="header"]
-|===
-| PubID (old PubID) | Stage | Status | Date | New DOI (old DOI) | Title
-
-| NIST CSWP 1
-
-was: _NIST CSWP 02122014_
-| Final
-| Published
-| 2/12/2014
-| https://doi.org/10.6028/NIST.CSWP.1
-
-was: _https://doi.org/10.6028/NIST.CSWP.02122014_
-| Framework for Improving Critical Infrastructure Cybersecurity, Version 1.0
-
-| NIST CSWP 2
-
-was: _NIST CSWP 02192014_
-| Final
-| Published
-| 2/19/2014
-| https://doi.org/10.6028/NIST.CSWP.2
-
-was: _https://doi.org/10.6028/NIST.CSWP.02192014_
-| Summary of NIST SP 800-53, Revision 4: Security and Privacy Controls for Federal Information Systems and Organizations
-
-| NIST CSWP 3
-
-was: _NIST CSWP 06032014_
-| Final
-| Withdrawn
-| 6/3/2014
-| https://doi.org/10.6028/NIST.CSWP.3
-
-was: _https://doi.org/10.6028/NIST.CSWP.06032014_
-| Supplemental Guidance on Ongoing Authorization: Transitioning to Near Real-Time Risk Management
-
-| NIST CSWP 4
-
-was: _NIST CSWP 04212016_
-| Final
-| Published
-| 4/21/2016
-| https://doi.org/10.6028/NIST.CSWP.4
-
-was: _https://doi.org/10.6028/NIST.CSWP.04212016_
-| Best Practices for Privileged User PIV Authentication
-
-| NIST CSWP 5
-
-was: _NIST CSWP 01262018_
-| Final
-| Published
-| 1/26/2018
-| https://doi.org/10.6028/NIST.CSWP.5
-
-was: _https://doi.org/10.6028/NIST.CSWP.01262018_
-| Security Considerations for Code Signing
-
-| NIST CSWP 6
-
-was: _NIST CSWP 04162018_
-| Final
-| Published
-| 4/16/2018
-| https://doi.org/10.6028/NIST.CSWP.6
-
-was: _https://doi.org/10.6028/NIST.CSWP.04162018_
-| Framework for Improving Critical Infrastructure Cybersecurity, Version 1.1
-
-| NIST CSWP 7
-
-was: _NIST CSWP 09102018_
-| Final
-| Published
-| 9/10/2018
-| https://doi.org/10.6028/NIST.CSWP.7
-
-was: _https://doi.org/10.6028/NIST.CSWP.09102018_
-| Transitioning to the Security Content Automation Protocol (SCAP) Version 2
-
-| NIST CSWP 8
-
-was: _NIST CSWP 04222019_
-| Final
-| Published
-| 4/22/2019
-| https://doi.org/10.6028/NIST.CSWP.8
-
-was: _https://doi.org/10.6028/NIST.CSWP.04222019_
-| BowTie - A deep learning feedforward neural network for sentiment analysis
-
-| NIST CSWP 9 ipd
-
-was: _NIST CSWP 07092019-draft_
-| IPD
-| Withdrawn
-| 7/9/2019
-| https://doi.org/10.6028/NIST.CSWP.9.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.07092019-draft_
-| A Taxonomic Approach to Understanding Emerging Blockchain Identity Management Systems
-
-| NIST CSWP 9
-
-was: _NIST CSWP 01142020_
-| Final
-| Published
-| 1/14/2020
-| https://doi.org/10.6028/NIST.CSWP.9
-
-was: _https://doi.org/10.6028/NIST.CSWP.01142020_
-| A Taxonomic Approach to Understanding Emerging Blockchain Identity Management Systems
-
-| NIST CSWP 10
-
-was: _NIST CSWP 01162020_
-| Final
-| Published
-| 1/16/2020
-| https://doi.org/10.6028/NIST.CSWP.10
-
-was: _https://doi.org/10.6028/NIST.CSWP.01162020_
-| NIST Privacy Framework: A Tool for Improving Privacy Through Enterprise Risk Management, Version 1.0
-
-| NIST CSWP 11
-
-was: _NIST CSWP 02042020-1_
-| Final
-| Published
-| 2/4/2020
-| https://doi.org/10.6028/NIST.CSWP.11
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042020-1_
-| Case Studies in Cyber Supply Chain Risk Management: Summary of Findings and Recommendations
-
-| NIST CSWP 11A
-
-was: _NIST CSWP 02042020-2_
-| Final
-| Published
-| 2/4/2020
-| https://doi.org/10.6028/NIST.CSWP.11A
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042020-2_
-| Case Studies in Cyber Supply Chain Risk Management: Anonymous Consumer Electronics Company
-
-| NIST CSWP 11B
-
-was: _NIST CSWP 02042020-3_
-| Final
-| Published
-| 2/4/2020
-| https://doi.org/10.6028/NIST.CSWP.11B
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042020-3_
-| Case Studies in Cyber Supply Chain Risk Management: Anonymous Consumer Goods Company
-
-| NIST CSWP 11C
-
-was: _NIST CSWP 02042020-4_
-| Final
-| Published
-| 2/4/2020
-| https://doi.org/10.6028/NIST.CSWP.11C
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042020-4_
-| Case Studies in Cyber Supply Chain Risk Management: Anonymous Renewable Energy Company
-
-| NIST CSWP 11D
-
-was: _NIST CSWP 02042020-5_
-| Final
-| Published
-| 2/4/2020
-| https://doi.org/10.6028/NIST.CSWP.11D
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042020-5_
-| Case Studies in Cyber Supply Chain Risk Management: Mayo Clinic
-
-| NIST CSWP 11E
-
-was: _NIST CSWP 02042020-6_
-| Final
-| Published
-| 2/4/2020
-| https://doi.org/10.6028/NIST.CSWP.11E
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042020-6_
-| Case Studies in Cyber Supply Chain Risk Management: Palo Alto Networks, Inc.
-
-| NIST CSWP 11F
-
-was: _NIST CSWP 02042020-7_
-| Final
-| Published
-| 2/4/2020
-| https://doi.org/10.6028/NIST.CSWP.11F
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042020-7_
-| Case Studies in Cyber Supply Chain Risk Management: Seagate Technology
-
-| NIST CSWP 12 ipd
-
-was: _NIST CSWP 04012020-draft_
-| IPD
-| Withdrawn
-| 4/1/2020
-| https://doi.org/10.6028/NIST.CSWP.12.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.04012020-draft_
-| Methodology for Characterizing Network Behavior of Internet of Things Devices
-
-| NIST CSWP 13
-
-was: _NIST CSWP 04232020_
-| Final
-| Withdrawn
-| 4/23/2020
-| https://doi.org/10.6028/NIST.CSWP.13
-
-was: _https://doi.org/10.6028/NIST.CSWP.04232020_
-| Mitigating the Risk of Software Vulnerabilities by Adopting a Secure Software Development Framework (SSDF)
-
-| NIST CSWP 14 ipd
-
-was: _NIST CSWP 04282020-draft_
-| IPD
-| Withdrawn
-| 4/28/2020
-| https://doi.org/10.6028/NIST.CSWP.14.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.04282020-draft_
-| Hardware-Enabled Security for Server Platforms: Enabling a Layered Approach to Platform Security for Cloud and Edge Computing Use Cases
-
-| NIST CSWP 15 ipd
-
-was: _NIST CSWP 05262020-draft_
-| IPD
-| Withdrawn
-| 5/26/2020
-| https://doi.org/10.6028/NIST.CSWP.15.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.05262020-draft_
-| Getting Ready for Post-Quantum Cryptography: Explore Challenges Associated with Adoption and Use of Post-Quantum Cryptographic Algorithms
-
-| NIST CSWP 16 ipd
-
-was: _NIST CSWP 09082020-draft_
-| IPD
-| Published
-| 9/8/2020
-| https://doi.org/10.6028/NIST.CSWP.16.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.09082020-draft_
-| Trusted Internet of Things (IoT) Device Network-Layer Onboarding and Lifecycle Management
-
-| NIST CSWP 17 ipd
-
-was: _NIST CSWP 10012020-draft_
-| IPD
-| Published
-| 10/1/2020
-| https://doi.org/10.6028/NIST.CSWP.17.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.10012020-draft_
-| Securing Data Integrity Against Ransomware Attacks: Using the NIST Cybersecurity Framework and NIST Cybersecurity Practice Guides
-
-| NIST CSWP 15
-
-was: _NIST CSWP 04282021_
-| Final
-| Published
-| 4/28/2021
-| https://doi.org/10.6028/NIST.CSWP.15
-
-was: _https://doi.org/10.6028/NIST.CSWP.04282021_
-| Getting Ready for Post-Quantum Cryptography: Exploring Challenges Associated with Adopting and Using Post-Quantum Cryptographic Algorithms
-
-| NIST CSWP 18 ipd
-
-was: _NIST CSWP 05142021-draft_
-| IPD
-| Published
-| 5/14/2021
-| https://doi.org/10.6028/NIST.CSWP.18.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.05142021-draft_
-| Establishing Confidence in IoT Device Security: How do we get there?
-
-| NIST CSWP 19 ipd
-
-was: _NIST CSWP 06222021-draft_
-| IPD
-| Published
-| 6/22/2021
-| https://doi.org/10.6028/NIST.CSWP.19.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.06222021-draft_
-| Combinatorial Coverage Difference Measurement
-
-| NIST CSWP 20 ipd
-
-was: _NIST CSWP 08042021-draft_
-| IPD
-| Published
-| 8/4/2021
-| https://doi.org/10.6028/NIST.CSWP.20.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.08042021-draft_
-| Planning for a Zero Trust Architecture: A Starting Guide for Administrators
-
-| NIST CSWP 21
-
-was: _NIST CSWP 09292021_
-| Final
-| Published
-| 9/29/2021
-| https://doi.org/10.6028/NIST.CSWP.21
-
-was: _https://doi.org/10.6028/NIST.CSWP.09292021_
-| Benefits of an Updated Mapping between the NIST Cybersecurity Framework and the NERC Critical Infrastructure Protection Standards
-
-| NIST CSWP 22 ipd
-
-was: _NIST CSWP 12062021-draft_
-| IPD
-| Published
-| 12/6/2021
-| https://doi.org/10.6028/NIST.CSWP.22.ipd
-
-was: _https://doi.org/10.6028/NIST.CSWP.12062021-draft_
-| Combination Frequency Differencing
-
-| NIST CSWP 23
-
-was: _NIST CSWP 02042022-1_
-| Final
-| Published
-| 2/4/2022
-| https://doi.org/10.6028/NIST.CSWP.23
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042022-1_
-| Recommended Criteria for Cybersecurity Labeling of Consumer Software
-
-| NIST CSWP 24
-
-was: _NIST CSWP 02042022-2_
-| Final
-| Published
-| 2/4/2022
-| https://doi.org/10.6028/NIST.CSWP.24
-
-was: _https://doi.org/10.6028/NIST.CSWP.02042022-2_
-| Recommended Criteria for Cybersecurity Labeling for Consumer Internet of Things (IoT) Products
-
-|===
-
-== Conclusion
-
-The recent change in NIST CSWP PubID references highlights the strong need
-in PubID stability, and the importance of getting PubIDs defined correctly
-early on.
-
-Changing the PubID scheme at the authoritative source is never an easy task and
-similarly creates challenges for users.
-
-It is important for the organization that changes PubIDs to provide some
-mapping from the old PubID to the new PubID so that users can understand how
-the references changed.
-
diff --git a/_posts/2024-01-19-relaton-isbn.adoc b/_posts/2024-01-19-relaton-isbn.adoc
deleted file mode 100644
index 281dcc7..0000000
--- a/_posts/2024-01-19-relaton-isbn.adoc
+++ /dev/null
@@ -1,494 +0,0 @@
----
-layout: post
-title: Support for ISBN bibliographic information auto-fetch through the OpenLibrary
-date: 2024-01-19
-categories: relaton
-authors:
-  -
-    name: Ronald Tse
-    email: ronald.tse@ribose.com
-    social_links:
-      - https://github.com/ronaldtse
-  -
-    name: Andrei Kislichenko
-    email: andrew2net@gmail.com
-    social_links:
-      - https://github.com/andrew2net
-
-excerpt: >-
-  Relaton now supports auto-fetching OpenLibrary bibliographic information via
-  ISBN-10 and ISBN-13.
----
-
-== Introduction
-
-=== The International Standard Book Number (ISBN)
-
-The International Standard Book Number (ISBN) is the ubiquitous identifier used
-to uniquely identify books and other monographic publications. It provides a
-standardized way to reference and catalog books, making it easier to manage and
-track publications across the publishing industry.
-
-Since its launch in 1972, the ISBN has been an essential part of the
-publishing industry, providing a unique identifier for books and other
-monographic publications. Initially a 10-digit number, it was expanded to 13
-digits in 2005.
-
-ISBNs are essential for the book trade, libraries, and bibliographic services.
-They provide a unique identifier for each edition and format of a book,
-simplifying inventory management, sales tracking, and cataloging processes.
-
-Each ISBN uniquely identifies a specific edition and format of a book, making it
-invaluable for inventory management, sales tracking, and bibliographic
-record-keeping.
-
-The purpose of this International Standard is to coordinate and standardize the
-use of book numbers internationally. An International Standard Book Number
-(ISBN) identifies one title, or edition of a title, from one specific publisher,
-ensuring it is unique to that title or edition.
-
-
-=== A brief history of ISBN
-
-ISBN is an adoption of the British Standard Book Numbering (SBN) system, a
-9-digit system originally developed by the bookseller WHSmith. The SBN system
-was first introduced in the United Kingdom in 1967, then adopted and extended by
-ISO/TC 46 for the international community.
-
-The initial ISBN standard was approved in September 1971 by ISO members
-and published the year after, as *ISO 2108:1972*.
-
-.ISBN edition 1 (1972) to edition 5 (2017)
-[cols="a,a",options="header"]
-|===
-| ISO 2108:1972 (1st edition) | ISO 2108:2017 (5th edition)
-
-|
-image::/assets/blog/2024-01-19/iso-2108-1972-cover.png[]
-|
-image::/assets/blog/2024-01-19/iso-2108-2017-cover.png[]
-
-|===
-
-The standard was later revised as:
-
-* https://www.iso.org/standard/6897.html[ISO 2108:1978] (2nd edition);
-* https://www.iso.org/standard/6898.html[ISO 2108:1992] (3rd edition);
-* https://www.iso.org/standard/36563.html[ISO 2108:2005] (4th edition);
-* https://www.iso.org/standard/65483.html[ISO 2108:2017] (5th edition).
-
-In 2005, the number of digits was increased to 13. In the words of the standard,
-this was done to "increase substantially the numbering capacity of the global
-ISBN system and to harmonise the format of the ISBN with the EAN-UCC product
-code system."
-
-Therefore there are currently 2 types of ISBN codes:
-
-* ISBN with 10-digits, now commonly referred as "ISBN-10";
-* ISBN with 13-digits, now commonly referred as "ISBN-13".
-
-
-=== The ISBN system
-
-The ISBN system is managed by the
-https://www.isbn-international.org[International ISBN Agency]. The agency is
-appointed as the Registration Authority for this ISO standard to coordinate and
-supervise worldwide use of the ISBN system.
-
-The International ISBN Agency plays a crucial role in the global book industry
-by registering additional National ISBN agencies. These national agencies, in
-turn, facilitate the registration of books within their respective countries or
-regions, ensuring a standardized system for book identification worldwide.
-
-
-
-=== Structure of the ISBN code
-
-This is best described by the original ISO 2108:1972 standard:
-
-____
-When an international standard book number is either written or printed it shall
-be preceded by the letters ISBN, and each part shall be separated by a space or
-a hyphen as in the following examples:
-
-* ISBN 0 571 08989 5
-
-* ISBN 90-7000-234-5
-____
-
-NOTE: These digits are the arabic numerals 0 to 9; in the case of the check
-digit only, an X can sometimes occur.
-
-An ISBN (ISBN 10 code) consists of ten digits made up of the following parts:
-
-group identifier:: The group number is assigned by the International ISBN Agency
-for a group of publishers.
-(i.e. national, geographical, language or other convenient group)
-"It will vary in length from group to group according to the title output of the
-group concerned." (ISO 2108:1972, 2.1)
-
-publisher identifier::
-"The publisher identifier will be allocated internally within the group, by the
-agency appointed for this purpose. It will vary in length from publisher to
-publisher according to the title output of the publisher concerned."
-(ISO 2108:1972, 2.2)
-
-title identifier::
-"The length of the title identifier will be determined by the length of the
-group and publisher identifiers which precede it."
-(ISO 2108:1972, 2.3)
-
-check digit::
-"The check digit is calculated on a modulus 11 with weights 10-2, using X in
-lieu of 10 where 10 would occur as a check digit."
-(ISO 2108:1972, 2.4)
-
-
-The title identifier is the only part of the ISBN that is variable in length,
-depending on the length of the group and publisher identifiers.
-
-The assigners of identifiers are as follows:
-
-* The group identifier is assigned by the International ISBN Agency.
-* The publisher identifier is assigned by the regional ISBN agency.
-* The title identifier is assigned by the publisher.
-
-The 13-digit ISBN is made up of the same parts except that the group identifier
-can be longer. The check digit is calculated differently, and the ISBN-13 is the
-same as the EAN-13 barcode.
-
-
-=== OpenLibrary: A Digital Library Initiative
-
-https://openlibrary.org[OpenLibrary] is a project of the
-https://archive.org[Internet Archive], aiming to create "one web page for every
-book ever published."
-
-The International ISBN Agency is only concerned with assigning group identifiers,
-and does not keep a global database of ISBNs. There are various commercial
-databases that provide ISBN lookup services, but these are all proprietary and
-are only accessible behind paywalls.
-
-OpenLibrary, on the other hand, is an open, editable library catalog that
-provides free access to millions of book records, including many full-text
-books.
-
-OpenLibrary maintains a vast database of bibliographic information, indexed by
-ISBN among other identifiers, and provides an open API for retrieval of
-bibliographic information. This makes it an excellent resource for retrieving
-book metadata programmatically.
-
-NOTE: Keep in mind that OpenLibrary is a community-driven project. While it
-already provides millions of ISBN records, it does not contain the full set
-of metadata of all books and monographs issued with an ISBN identifier.
-We encourage anyone who discovers missing or incorrect data to contribute to
-the OpenLibrary project by adding or correcting the metadata.
-
-=== Difference between OpenLibrary and Crossref
-
-https://crossref.org[Crossref] is a paywalled "for-profit service" run by a
-non-profit organization,
-which provides a slow bibliographic endpoint to encourage users to pay for their
-faster API.
-
-On the other hand, OpenLibrary is completely open and free, with an excellent
-data API that is not limited or restricted.
-
-We commend the OpenLibrary for democratizing bibliographic information access,
-and would strongly recommend usage of and contribution to the OpenLibrary over
-Crossref.
-
-We find that bibliographic information from OpenLibrary often
-exceeds in quality with compared to the same from Crossref.
-
-* This stems from the fact that OpenLibrary is a community-driven project, and
-the data is often curated by volunteers who are passionate about books and
-libraries.
-
-* Crossref on the other hand takes whatever publishers dump into it, and often
-the metadata is incomplete or incorrect.
-
-
-=== Relaton and ISBN Support
-
-Relaton, an interoperable data model for citations based on ISO 690, has now
-expanded its capabilities to include ISBN lookup through OpenLibrary. This
-integration allows users to easily retrieve bibliographic information for books
-using their ISBN.
-
-The new functionality is implemented in the
-https://github.com/relaton/relaton-isbn[relaton-isbn] gem. This addition to
-the Relaton ecosystem further enhances its ability to provide comprehensive
-bibliographic data across various identification systems.
-
-Relaton supports retrieval of both ISBN-10 and ISBN-13 from OpenLibrary.
-
-
-== Using Relaton for ISBN Lookups
-
-=== Installation and setup
-
-To use Relaton's ISBN lookup functionality, you'll need to install the Relaton
-CLI.
-
-This can be done using the following command:
-
-[source,console]
-----
-$ gem install relaton-cli
-----
-
-=== Fetching bibliographic data
-
-Once installed, you can use the Relaton CLI to fetch bibliographic data for
-books using their ISBN.
-
-[source,console]
-----
-$ relaton fetch isbn:{ISBN}
-----
-
-This will return the bibliographic record in Relaton XML format by default. You
-can specify other output formats using the `-f` flag, such as YAML or BibTeX.
-
-=== Example: Looking up "Snow Crash"
-
-We use Neal Stephenson's seminal cyberpunk novel "Snow Crash" as an example.
-This book, first published in 1992, is often credited with popularizing the
-concept of the Metaverse.
-
-The ISBN-13 for a popular paperback edition of "Snow Crash" is 978-0553380958.
-
-Here's how we can fetch its bibliographic data using Relaton:
-
-[source,console]
-----
-$ relaton fetch isbn:9780553380958 -f yaml
-----
-
-This command will return the bibliographic information in YAML format.
-
-Here's what the output might look like:
-
-[source,yaml]
-----
----
-schema-version: v1.2.9
-id: '9780553380958'
-title:
-- content: Snow crash
-  format: text/plain
-  type: main
-link:
-- content: http://openlibrary.org/books/OL18141225M/Snow_crash
-  type: src
-docid:
-- id: '9780553380958'
-  type: ISBN
-  primary: true
-date:
-- type: published
-  value: '2000'
-contributor:
-- person:
-    name:
-      completename:
-        content: Neal Stephenson
-  role:
-  - type: author
-- person:
-    name:
-      completename:
-        content: Juanma Barranquero
-  role:
-  - type: author
-- organization:
-    name:
-    - content: Bantam Books
-  role:
-  - type: publisher
-revdate: '2000'
-place:
-- city: New York
-----
-
-This YAML output provides a wealth of information about the book, including its
-title, author, publisher, publication date, and more. All of this data is
-structured according to the Relaton bibliographic data model, making it easy to
-integrate with other Relaton-compatible systems.
-
-
-
-== Beyond basic lookups
-
-While simple ISBN lookups are straightforward, Relaton's capabilities extend
-beyond this.
-
-=== Batch processing
-
-You can create scripts to process multiple ISBNs in batch. For example:
-
-.bash script using Relaton to fetch OpenLibrary data using ISBNs into a BibTeX file
-[source,sh]
-----
-#!/bin/bash
-ISBNs="9780553380958 9780307887436 9780062190376"
-echo "" > sci_fi_books.bibtex
-for isbn in $ISBNs; do
-  relaton fetch isbn:$isbn -f bibtex >> sci_fi_books.bibtex
-done
-----
-
-This script would create a BibTeX file containing entries for "Snow Crash" and two other science fiction novels.
-
-=== Integration with Ruby Code
-
-For developers working within the Ruby ecosystem, the `relaton-isbn` gem can be used directly in Ruby code:
-
-.Ruby code that fetches Relaton bibliographic objects using ISBN identifiers
-[source,ruby]
-----
-require 'relaton_isbn'
-
-isbn = "9780553380958"
-item = RelatonIsbn::IsbnBibliography.get("isbn:#{isbn}")
-puts item.to_yaml
-----
-
-This allows for more complex processing and integration with other Ruby-based
-systems.
-
-
-
-== Enhancements and caveats
-
-=== Challenges with OpenLibrary data
-
-OpenLibrary is a valuable resource for bibliographic information, offering a
-vast collection of book data that is openly accessible. It provides unique
-identifiers for books and aims to create "one web page for every book ever
-published."
-
-However, using OpenLibrary data comes with its own set of challenges:
-
-* Data quality varies significantly across entries;
-* Metadata is not consistently normalized;
-* Book information can be incomplete or outdated;
-* Duplicate entries for the same book are common;
-* User-contributed data may introduce errors.
-
-These issues arise from OpenLibrary's collaborative nature, where data is
-contributed by various users and sources without rigorous standardization.
-
-We recommend using OpenLibrary as a starting point for gathering book
-information, but users should be prepared to verify and supplement the data from
-other sources.
-
-== Specific examples of OpenLibrary data challenges
-
-=== Conflicted entries on a unique ISBN number
-
-Given that the OpenLibrary is contributor focused, there are occasionally
-issues with conflicting entries for the same ISBN.
-
-.Different Snow Crash entries with the same ISBN
-[example]
-====
-The ISBN-10 `0553380958` for "Snow Crash" links to two entries:
-
-[cols="a,a",options="header"]
-|===
-h| https://openlibrary.org/books/OL18141225M/Snow_crash[Entry 1]: Bantam trade reissue, May 2000
-h| https://openlibrary.org/books/OL23230597M/Snow_crash[Entry 2]: Bantam Spectra trade paperback reissue/September 2008
-
-|
-image::/assets/blog/2024-01-19/snow-crash-1.png[]
-|
-image::/assets/blog/2024-01-19/snow-crash-2.png[]
-
-|===
-
-====
-
-This can lead to confusion when trying to retrieve accurate bibliographic data.
-
-
-=== Conflated author names
-
-Some author names are actually combinations of multiple names.
-
-.Author names not properly normalized
-[example]
-====
-This entry for
-https://openlibrary.org/works/OL31707543W/Beowulf_and_the_Finnesburg_Fragment[Beowulf and the Finnesburg Fragment]
-lists a single author as "John R. Clark; Wrenn, C. L.; Tolkien, J. R. R. Hall".
-
-However, this single author entry contains 3 creators's names rolled into one.
-====
-
-
-=== Incomplete publication information
-
-Some entries lack complete publication details, such as:
-
-* Missing publisher
-* Incomplete publication date (only year, no month or day)
-* Missing publication place
-* Incomplete edition information
-
-For these entries, when you notice any missing or incorrect bibliographic data,
-we encourage you to directly contribute to OpenLibrary to improve the quality of
-the data.
-
-At least you have a direct avenue to fix the item for your usage and benefit
-others who may encounter the same issue!
-
-
-=== Duplicate entries
-
-OpenLibrary often has multiple entries for the same book, especially for works
-with many editions.
-
-These duplicates may contain conflicting information. For example, "1984" by
-George Orwell might have several entries with different publication years,
-ISBNs, and even slight variations in the title.
-
-
-=== Missing or incorrect cover images
-
-While OpenLibrary aims to provide cover images, many entries lack them or have
-incorrect images associated.
-
-That said, if you are concerned only about bibliographic citations, then this
-isn't a problem.
-
-
-
-== Working with OpenLibrary data
-
-Despite these challenges, OpenLibrary remains a valuable resource.
-
-To make the most of it:
-
-. Double-check the rendered bibliographic information to ensure completeness of
-data;
-. Be prepared to fill in gaps in information manually (if you use Metanorma, use
-citation spans);
-. Contribute corrections back to OpenLibrary when errors are found;
-
-By understanding these limitations and taking appropriate measures, you can
-effectively utilize the ISBN fetch functionality from OpenLibrary's extensive
-publications database.
-
-
-== Conclusion
-
-The addition of ISBN support to Relaton through OpenLibrary integration
-represents a significant enhancement to the Relaton ecosystem. It provides
-researchers, librarians, and developers with a powerful tool for retrieving
-standardized bibliographic data for books.
-
-We encourage users to explore this new functionality, contribute to its
-development, and provide feedback to help improve this valuable resource for the
-broader community of bibliographic data users.
diff --git a/_sass/relaton.scss b/_sass/relaton.scss
deleted file mode 100644
index ef0b655..0000000
--- a/_sass/relaton.scss
+++ /dev/null
@@ -1,315 +0,0 @@
-.site-logo {
-  svg {
-    path {
-      fill: white;
-    }
-  }
-}
-
-.hero .illustration {
-  svg path {
-    fill: white;
-  }
-}
-
-.main-section {
-  > .title {
-    font-weight: 500;
-  }
-}
-
-// TODO: These should be generalized to open project site level
-main .body {
-  .imageblock .content img {
-    max-width: 100%;
-  }
-}
-
-.learn-more {
-  font-weight: bold;
-}
-
-body.overview,
-body.getting-started {
-  section.documentation {
-    margin-bottom: 100px;
-  }
-}
-
-body.overview section.documentation {
-  ul.feature-list {
-    display: flex;
-    flex-flow: column nowrap;
-
-    li.feature p {
-      padding-bottom: 1em;
-    }
-
-    @media screen and (min-width: $bigscreen-breakpoint) {
-      flex-flow: row wrap;
-      li {
-        flex-basis: 50%;
-        flex: 1 1 auto;
-      }
-    }
-  }
-  .cta .button {
-    @include cta-button(transparent, $primary-dark-color);
-    border-radius: 25px;
-    border: 1px solid $primary-color;
-  }
-}
-
-.web-build-ui {
-  &.conditional {
-    opacity: 0;
-    position: absolute;
-    top: 1em;
-    right: 1em;
-    bottom: 1em;
-    left: 1em;
-    z-index: 10;
-
-    transform: translateY(-100%);
-    transition: transform .5s linear, opacity .2s linear;
-    background: white;
-  }
-  &.conditional.shown {
-    opacity: 1;
-    transform: translateY(0);
-  }
-}
-
-.software {
-  body > .underlay > header > .top-menu > & {
-    display: none;
-  }
-}
-
-.site--project.layout--home {
-  > .underlay.header {
-    color: white;
-
-    > .hero > .text {
-      > .title {
-        font-weight: 500;
-        @media screen and (min-width: $bigscreen-breakpoint) {
-          margin-right: 100px;
-        }
-      }
-      > .cta {
-        .button {
-          border-radius: 25px;
-          padding-left: 32px;
-          padding-right: 32px;
-
-          &:first-child {
-            &, &:link, &:visited {
-              color: white;
-              background-color: $accent-color;
-            }
-          }
-        }
-      }
-    }
-  }
-
-  > main > .underlay > .software,
-  > main > .featured-posts,
-  > main > .underlay > .specs {
-    > .title {
-      align-self: flex-start;
-    }
-  }
-
-  > main .flavors {
-    margin-bottom: 1em;
-    color: white;
-
-    @media screen and (min-width: $bigscreen-breakpoint) {
-      padding-right: 10vw;
-    }
-
-    h2 {
-      font-weight: 500;
-    }
-
-    &.with-switcher {
-      section h3 {
-        display: none;
-      }
-    }
-
-    .items {
-      display: flex;
-      flex-wrap: wrap;
-      margin: -0.5em;
-      align-items: stretch;
-
-      > a:link, > a:visited {
-        color: $primary-color;
-      }
-
-      > * {
-        display: flex;
-        flex-flow: column nowrap;
-        justify-content: center;
-
-        margin: 0.5em;
-        max-width: 20em;
-
-        border-radius: .5em;
-        box-shadow: 0 9px 20px rgba(black, 0.1);
-        background-image: linear-gradient(25deg, rgb(255, 215, 127), rgb(255, 243, 163));
-
-        &.experimental {
-          position: relative;
-          overflow: hidden;
-
-          &:after {
-            content: "Beta";
-            position: absolute;
-            right: 0;
-            top: 0;
-            left: 0;
-            bottom: 0;
-
-            transform: rotate(-1deg);
-            background: linear-gradient(rgb(255, 215, 127) 0px, rgb(255, 215, 127) 13px, rgba(black, 0.2) 14px, rgba(black, 0.2) 80%, rgb(255, 215, 127) 81%, rgb(255, 215, 127) 100%);
-
-            font-size: 10px;
-            font-weight: bold;
-            letter-spacing: .04em;
-            padding-left: 1em;
-          }
-        }
-
-        > article {
-          padding: 1em 1.5em;
-        }
-
-        header {
-          font-size: 140%;
-          font-weight: 700;
-        }
-
-        p {
-          margin: .25em 0 0 0;
-        }
-      }
-    }
-  }
-  > main > .specs > .items .item header > .title {
-    font-weight: 500;
-  }
-}
-
-body > .underlay > header {
-  align-items: center;
-
-  .site-logo {
-    margin-right: 40px;
-
-    svg {
-      height: 48px;
-      margin-right: -4px;
-    }
-    .title {
-      position: relative;
-      top: 4px;
-    }
-  }
-  > .top-menu {
-    font-size: 16px;
-
-    a {
-      &:link, &:visited, &:hover {
-        color: white;
-      }
-    }
-
-    > :not(.search-widget) {
-      font-weight: 700;
-      border-radius: 16px;
-      padding-left: 8px;
-      padding-right: 8px;
-      margin-right: 2px;
-    }
-    input[type=search] {
-      padding-left: 18px;
-      padding-right: 18px;
-    }
-    > .active {
-      &:link, &:hover, &:visited {
-        background-color: white;
-        color: $primary-color;
-      }
-    }
-  }
-}
-
-/* Style the samples page */
-.layout--sample-index > main {
-  > .items {
-    @extend .index-item-grid;
-
-    .item {
-      @extend .item-card;
-      @include hoverable-card(2px, 10px, rgba(desaturate($primary-color, 50), 0.08));
-
-      padding: 30px 32px;
-      text-align: left;
-      margin-bottom: 20px;
-
-      header > .title {
-        margin: 0;
-        font-size: 20px;
-      }
-      .body {
-        font-size: 16px;
-      }
-    }
-  }
-}
-.layout--sample-index > main {
-  padding-bottom: 100px;
-}
-.layout--spec-sample > main {
-  padding-bottom: 100px;
-
-  > .documentation:only-child {
-    @include docs-page($primary-dark-color);
-  }
-}
-
-.row {
-  align-items: center;
-  border-bottom: $light-gray-color 1px solid;
-  display: flex;
-  flex-flow: row wrap;
-  min-height: 4em;
-
-  > .col1 {
-    flex: 1 12em;
-  }
-
-  > .col2 {
-    flex: 3 12em;
-    margin: 0;
-  }
-}
-
-.row > .col1 {
-  h3 {
-    margin: 0.2em 0;
-  }
-}
-
-article .sectionbody {
-  a,
-  a:link,
-  a:visited {
-    color: $article-link-color;
-    text-decoration: underline;
-  }
-}
diff --git a/_software/relaton-3gpp.adoc b/_software/relaton-3gpp.adoc
deleted file mode 100644
index 3e73edd..0000000
--- a/_software/relaton-3gpp.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: Relaton3gpp
-description: Ruby gem that retrieves 3GPP Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-3gpp
-
-external_links:
-  - url: https://github.com/relaton/relaton-3gpp
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:3GPP"]
----
diff --git a/_software/relaton-3gpp/assets/symbol.svg b/_software/relaton-3gpp/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-3gpp/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-bib.adoc b/_software/relaton-bib.adoc
deleted file mode 100644
index 4bfe264..0000000
--- a/_software/relaton-bib.adoc
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: RelatonBib
-description: Ruby gem that implements the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-bib
-
-external_links:
-  - url: https://github.com/relaton/relaton-bib
-
-tags: ["writtenin:Ruby"]
----
diff --git a/_software/relaton-bib/assets/symbol.svg b/_software/relaton-bib/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-bib/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-bipm.adoc b/_software/relaton-bipm.adoc
deleted file mode 100644
index a137bc9..0000000
--- a/_software/relaton-bipm.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonBipm
-description: Ruby gem that retrieves BIPM Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-bipm
-
-external_links:
-  - url: https://github.com/relaton/relaton-bipm
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:BIPM"]
----
diff --git a/_software/relaton-bipm/assets/symbol.svg b/_software/relaton-bipm/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-bipm/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-bsi.adoc b/_software/relaton-bsi.adoc
deleted file mode 100644
index 0a4ed9e..0000000
--- a/_software/relaton-bsi.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonBsi
-description: Ruby gem that retrieves BSI Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-bsi
-
-external_links:
-  - url: https://github.com/relaton/relaton-bsi
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:BSI"]
----
diff --git a/_software/relaton-bsi/assets/symbol.svg b/_software/relaton-bsi/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-bsi/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-calconnect.adoc b/_software/relaton-calconnect.adoc
deleted file mode 100644
index 5da50cd..0000000
--- a/_software/relaton-calconnect.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonCalConnect
-description: Retrieves CalConnect Standards for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-calconnect
-
-external_links:
-  - url: https://github.com/relaton/relaton-calconnect
-
-tags: ["writtenin:Ruby", "user:CalConnect"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of CalConnect Standards from https://www.calconnect.org
-and access that metadata through the `BibliographicItem` object.
diff --git a/_software/relaton-calconnect/assets/symbol.svg b/_software/relaton-calconnect/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-calconnect/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-ccsds.adoc b/_software/relaton-ccsds.adoc
deleted file mode 100644
index d78dc66..0000000
--- a/_software/relaton-ccsds.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonCCSDS
-description: Retrieves CCSDS Standards for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-ccsds
-
-external_links:
-  - url: https://github.com/relaton/relaton-ccsds
-
-tags: ["writtenin:Ruby", "user:CCSDS"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of CCSDS Standards from https://ccsds.org
-and access that metadata through the `BibliographicItem` object.
diff --git a/_software/relaton-ccsds/assets/symbol.svg b/_software/relaton-ccsds/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-ccsds/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-cen.adoc b/_software/relaton-cen.adoc
deleted file mode 100644
index 1dec96c..0000000
--- a/_software/relaton-cen.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonCen
-description: Ruby gem that retrieves CEN Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-cen
-
-external_links:
-  - url: https://github.com/relaton/relaton-cen
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:CEN"]
----
diff --git a/_software/relaton-cen/assets/symbol.svg b/_software/relaton-cen/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-cen/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-cie.adoc b/_software/relaton-cie.adoc
deleted file mode 100644
index 31ac33a..0000000
--- a/_software/relaton-cie.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonCie
-description: Ruby gem that retrieves CIE Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-cie
-
-external_links:
-  - url: https://github.com/relaton/relaton-cie
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:CIE"]
----
diff --git a/_software/relaton-cie/assets/symbol.svg b/_software/relaton-cie/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-cie/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-cli.adoc b/_software/relaton-cli.adoc
deleted file mode 100644
index 59426e4..0000000
--- a/_software/relaton-cli.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
----
-title: Relaton CLI
-description: Command-line tools for building Relaton sources.
-repo_url: https://github.com/relaton/relaton-cli
-
-external_links:
-  - url: https://github.com/relaton/relaton-cli
-
-docs:
-  git_repo_url: https://github.com/relaton/relaton-cli
-  git_repo_subtree: docs
-
-tags: ["writtenin:Ruby", "interface:CLI"]
-feature_with_priority: 1
----
-
-The command-line tool for using Relaton.
diff --git a/_software/relaton-cli/assets/symbol.svg b/_software/relaton-cli/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-cli/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-doi.adoc b/_software/relaton-doi.adoc
deleted file mode 100644
index dd45dc0..0000000
--- a/_software/relaton-doi.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonDOI
-description: Retrieves DOI Standards for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-doi
-
-external_links:
-  - url: https://github.com/relaton/relaton-doi
-
-tags: ["writtenin:Ruby", "user:DOI"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of DOI Standards from https://www.crossref.org/documentation/retrieve-metadata/rest-api/
-and access that metadata through the `BibliographicItem` object.
diff --git a/_software/relaton-doi/assets/symbol.svg b/_software/relaton-doi/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-doi/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-ecma.adoc b/_software/relaton-ecma.adoc
deleted file mode 100644
index 79742b9..0000000
--- a/_software/relaton-ecma.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonEcma
-description: Ruby gem that retrieves ECMA Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-ecma
-
-external_links:
-  - url: https://github.com/relaton/relaton-ecma
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:ECMA"]
----
diff --git a/_software/relaton-ecma/assets/symbol.svg b/_software/relaton-ecma/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-ecma/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-gb.adoc b/_software/relaton-gb.adoc
deleted file mode 100644
index 7045a59..0000000
--- a/_software/relaton-gb.adoc
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: RelatonGb
-description: Ruby gem that searches and fetches Chinese GB standards.
-repo_url: https://github.com/relaton/relaton-gb
-
-external_links:
-  - url: https://github.com/relaton/relaton-gb
-
-tags: ["writtenin:Ruby"]
----
diff --git a/_software/relaton-gb/assets/symbol.svg b/_software/relaton-gb/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-gb/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-iana.adoc b/_software/relaton-iana.adoc
deleted file mode 100644
index 6764a23..0000000
--- a/_software/relaton-iana.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonIana
-description: Ruby gem that retrieves IANA Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-iana
-
-external_links:
-  - url: https://github.com/relaton/relaton-iana
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:IANA"]
----
diff --git a/_software/relaton-iana/assets/symbol.svg b/_software/relaton-iana/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-iana/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-iec.adoc b/_software/relaton-iec.adoc
deleted file mode 100644
index ee14c3f..0000000
--- a/_software/relaton-iec.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonIecBib
-description: Ruby gem that retrieves IEC/CIE Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-iec
-
-external_links:
-  - url: https://github.com/relaton/relaton-iec
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:IEC"]
----
diff --git a/_software/relaton-iec/assets/symbol.svg b/_software/relaton-iec/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-iec/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-ieee.adoc b/_software/relaton-ieee.adoc
deleted file mode 100644
index 7a626ad..0000000
--- a/_software/relaton-ieee.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonIeee
-description: Ruby gem that retrieves IEEE Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-ieee
-
-external_links:
-  - url: https://github.com/relaton/relaton-ieee
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:IEEE"]
----
diff --git a/_software/relaton-ieee/assets/symbol.svg b/_software/relaton-ieee/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-ieee/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-ietf.adoc b/_software/relaton-ietf.adoc
deleted file mode 100644
index 90eb7b5..0000000
--- a/_software/relaton-ietf.adoc
+++ /dev/null
@@ -1,14 +0,0 @@
----
-title: RelatonIetf
-description: Ruby gem that retrieves IETF RFC standards
-repo_url: https://github.com/relaton/relaton-ietf
-
-external_links:
-  - url: https://github.com/relaton/relaton-ietf
-
-docs:
-  git_repo_url: https://github.com/relaton/relaton-cli
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:IETF"]
----
diff --git a/_software/relaton-ietf/assets/symbol.svg b/_software/relaton-ietf/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-ietf/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-iev.adoc b/_software/relaton-iev.adoc
deleted file mode 100644
index 1b1c249..0000000
--- a/_software/relaton-iev.adoc
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: RelatonIev
-description: Ruby gem that refactors IEV references.
-repo_url: https://github.com/relaton/relaton-iev
-
-external_links:
-  - url: https://github.com/relaton/relaton-iev
-
-tags: ["writtenin:Ruby"]
-feature_with_priority: 3
----
diff --git a/_software/relaton-iev/assets/symbol.svg b/_software/relaton-iev/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-iev/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-iho.adoc b/_software/relaton-iho.adoc
deleted file mode 100644
index ed539ba..0000000
--- a/_software/relaton-iho.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonIHO
-description: Retrieves IHO Standards for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-iho
-
-external_links:
-  - url: https://github.com/relaton/relaton-iho
-
-tags: ["writtenin:Ruby", "user:IHO"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of IHO Standards from https://www.iho.int
-and access that metadata through the `BibliographicItem` object.
diff --git a/_software/relaton-iho/assets/symbol.svg b/_software/relaton-iho/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-iho/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-isbn b/_software/relaton-isbn
deleted file mode 160000
index dbe100c..0000000
--- a/_software/relaton-isbn
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit dbe100cf15876d68547e7f6a7234730f99c46348
diff --git a/_software/relaton-isbn.adoc b/_software/relaton-isbn.adoc
deleted file mode 100644
index 13edaec..0000000
--- a/_software/relaton-isbn.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonIsbn
-description: Retrieves ISBN publications for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-isbn
-
-external_links:
-  - url: https://github.com/relaton/relaton-isbn
-
-tags: ["writtenin:Ruby", "user:ISBN"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of ISBN publications from http://openlibrary.org
-and access that metadata through the `BibliographicItem` object.
diff --git a/_software/relaton-iso-bib.adoc b/_software/relaton-iso-bib.adoc
deleted file mode 100644
index 0f74647..0000000
--- a/_software/relaton-iso-bib.adoc
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: RelatonIsoBib
-description: Ruby gem that implements the IsoBibliographicItem model.
-repo_url: https://github.com/relaton/relaton-iso-bib
-
-external_links:
-  - url: https://github.com/relaton/relaton-iso-bib
-
-tags: ["writtenin:Ruby"]
----
diff --git a/_software/relaton-iso-bib/assets/symbol.svg b/_software/relaton-iso-bib/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-iso-bib/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-iso.adoc b/_software/relaton-iso.adoc
deleted file mode 100644
index e17667a..0000000
--- a/_software/relaton-iso.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonIso
-description: Retrieves ISO Standards for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-iso
-
-external_links:
-  - url: https://github.com/relaton/relaton-iso
-
-tags: ["writtenin:Ruby", "user:ISO"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of ISO Standards from https://www.iso.org
-and access that metadata through the `IsoBibliographicItem` object.
diff --git a/_software/relaton-iso/assets/symbol.svg b/_software/relaton-iso/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-iso/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-itu.adoc b/_software/relaton-itu.adoc
deleted file mode 100644
index d76d119..0000000
--- a/_software/relaton-itu.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonItu
-description: Ruby gem that retrieves ITU standards.
-repo_url: https://github.com/relaton/relaton-itu
-
-external_links:
-  - url: https://github.com/relaton/relaton-itu
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:ITU"]
----
diff --git a/_software/relaton-itu/assets/symbol.svg b/_software/relaton-itu/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-itu/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-jis.adoc b/_software/relaton-jis.adoc
deleted file mode 100644
index bae4dc8..0000000
--- a/_software/relaton-jis.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonJIS
-description: Retrieves JIS Standards for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-jis
-
-external_links:
-  - url: https://github.com/relaton/relaton-jis
-
-tags: ["writtenin:Ruby", "user:JIS"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of JIS Standards from https://webdesk.jsa.or.jp
-and access that metadata through the `BibliographicItem` object.
diff --git a/_software/relaton-jis/assets/symbol.svg b/_software/relaton-jis/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-jis/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-nist.adoc b/_software/relaton-nist.adoc
deleted file mode 100644
index 88ff0a1..0000000
--- a/_software/relaton-nist.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonNist
-description: Ruby gem that retrieves NIST standards.
-repo_url: https://github.com/relaton/relaton-nist
-
-external_links:
-  - url: https://github.com/relaton/relaton-nist
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:NIST"]
----
diff --git a/_software/relaton-nist/assets/symbol.svg b/_software/relaton-nist/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-nist/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-oasis.adoc b/_software/relaton-oasis.adoc
deleted file mode 100644
index 9116ee0..0000000
--- a/_software/relaton-oasis.adoc
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: RelatonOasis
-description: Ruby gem that searches and fetches OASIS OPEN standards.
-repo_url: https://github.com/relaton/relaton-oasis
-
-external_links:
-  - url: https://github.com/relaton/relaton-oasis
-
-tags: ["writtenin:Ruby", "user:OASIS"]
----
diff --git a/_software/relaton-oasis/assets/symbol.svg b/_software/relaton-oasis/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-oasis/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-ogc.adoc b/_software/relaton-ogc.adoc
deleted file mode 100644
index f6abcf9..0000000
--- a/_software/relaton-ogc.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonOgc
-description: Ruby gem that retrieves OGC Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-ogc
-
-external_links:
-  - url: https://github.com/relaton/relaton-ogc
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:OGC"]
----
diff --git a/_software/relaton-ogc/assets/symbol.svg b/_software/relaton-ogc/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-ogc/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-omg.adoc b/_software/relaton-omg.adoc
deleted file mode 100644
index da28731..0000000
--- a/_software/relaton-omg.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonOmg
-description: Ruby gem that retrieves OMG Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-omg
-
-external_links:
-  - url: https://github.com/relaton/relaton-omg
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:OMG"]
----
diff --git a/_software/relaton-omg/assets/symbol.svg b/_software/relaton-omg/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-omg/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-plateau b/_software/relaton-plateau
deleted file mode 160000
index 303420c..0000000
--- a/_software/relaton-plateau
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 303420cb088e012fd99539ac506ccf842cd8dfc0
diff --git a/_software/relaton-plateau.adoc b/_software/relaton-plateau.adoc
deleted file mode 100644
index ffe1578..0000000
--- a/_software/relaton-plateau.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: Relaton::Plateau
-description: Retrieves MLIT PLATEAU publications for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-plateau
-
-external_links:
-  - url: https://github.com/relaton/relaton-plateau
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:PLATEAU"]
----
diff --git a/_software/relaton-un.adoc b/_software/relaton-un.adoc
deleted file mode 100644
index 56ed76b..0000000
--- a/_software/relaton-un.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonUn
-description: Ruby gem that retrieves UN Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-un
-
-external_links:
-  - url: https://github.com/relaton/relaton-un
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:UN"]
----
diff --git a/_software/relaton-un/assets/symbol.svg b/_software/relaton-un/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-un/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-w3c.adoc b/_software/relaton-w3c.adoc
deleted file mode 100644
index 6819504..0000000
--- a/_software/relaton-w3c.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: RelatonW3c
-description: Ruby gem that retrieves W3C Standards for bibliographic use.
-repo_url: https://github.com/relaton/relaton-w3c
-
-external_links:
-  - url: https://github.com/relaton/relaton-w3c
-
-docs:
-  git_repo_subtree: .
-
-tags: ["writtenin:Ruby", "user:W3C"]
----
diff --git a/_software/relaton-w3c/assets/symbol.svg b/_software/relaton-w3c/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-w3c/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton-xsf.adoc b/_software/relaton-xsf.adoc
deleted file mode 100644
index 5a5910b..0000000
--- a/_software/relaton-xsf.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: RelatonXSF
-description: Retrieves IHO Standards for bibliographic use using the BibliographicItem model.
-repo_url: https://github.com/relaton/relaton-xsf
-
-external_links:
-  - url: https://github.com/relaton/relaton-xsf
-
-tags: ["writtenin:Ruby", "user:XSF"]
-
-feature_with_priority: 2
----
-
-You can use it to retrieve metadata of XSF Standards from https://xmpp.org/extensions/
-and access that metadata through the `BibliographicItem` object.
diff --git a/_software/relaton-xsf/assets/symbol.svg b/_software/relaton-xsf/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton-xsf/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_software/relaton.adoc b/_software/relaton.adoc
deleted file mode 100644
index 391280a..0000000
--- a/_software/relaton.adoc
+++ /dev/null
@@ -1,21 +0,0 @@
----
-title: Relaton
-description: Gem for importing and caching bibliographic references to technical standards.
-
-repo_url: https://github.com/metanorma/relaton
-
-external_links:
-  - url: https://github.com/metanorma/relaton
-
-docs:
-  git_repo_url: https://github.com/metanorma/relaton
-  git_repo_subtree: docs
-
-tags: ["writtenin:Ruby"]
----
-
-The Relaton gem obtains authoritative bibliographic entries for technical standards
-from online sources and expresses them in a consistent format,
-which can be used in document authoring.
-
-It is the underlying bibliographic tool for the link:https://www.metanorma.com/[Metanorma] toolset.
diff --git a/_software/relaton/assets/symbol.svg b/_software/relaton/assets/symbol.svg
deleted file mode 100644
index f78f589..0000000
--- a/_software/relaton/assets/symbol.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/_specs/relaton-cli.adoc b/_specs/relaton-cli.adoc
deleted file mode 100644
index 70d7ca8..0000000
--- a/_specs/relaton-cli.adoc
+++ /dev/null
@@ -1,499 +0,0 @@
----
-title: Relaton CLI
-description: Relaton Command-line Interface
-
-feature_with_priority: 1
-
-external_links:
-  - url: https://github.com/relaton/relaton-cli/blob/master/docs/README.adoc
----
-= Relaton Command-line Interface (CLI)
-
-The `relaton` command-line interface (CLI) provides a set of commands for
-working with Relaton files.
-
-The commands are designed to be used in a Unix-like environment.
-
-The `relaton` command is installed as a Ruby gem. To install the gem, run:
-
-[source,console]
-----
-$ gem install relaton-cli
-----
-
-The `relaton help` command provides a list of available commands.
-
-[source,console]
-----
-$ relaton help
-relaton help
-Commands:
-  relaton collection SUBCOMMAND                                         # Collection manipulations
-  relaton concatenate SOURCE-DIR COLLECTION-FILE                        # Concatenate entries in DIRECTORY (containing Relaton-XML or YAML) into a Relaton Collection
-  relaton convert XML -f, --format=FORMAT                               # Convert Relaton XML document
-  relaton db SUBCOMMAND                                                 # Cache DB manipulation
-  relaton extract Metanorma-XML-File / Directory Relaton-XML-Directory  # Extract Relaton XML from Metanorma XML file / directory
-  relaton fetch CODE                                                    # Fetch Relaton XML for Standard identifier CODE
-  relaton fetch-data SOURCE                                             # Fetch all the documents from a source
-  relaton help [COMMAND]                                                # Describe available commands or one specific command
-  relaton split Relaton-Collection-File Relaton-XML-Directory           # Split a Relaton Collection into multiple files
-  relaton version                                                       # Show Relaton version
-  relaton xml2html RELATON-INDEX-XML                                    # Convert Relaton Collection XML into HTML
-  relaton xml2yaml XML                                                  # Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files)
-  relaton yaml2html RELATON-INDEX-YAML                                  # Concatenate Relaton Collection YAML into HTML
-  relaton yaml2xml YAML                                                 # Convert Relaton YAML into Relaton Collection XML or separate files
-
-Options:
-  -v, [--verbose], [--no-verbose], [--skip-verbose]  # Output warnings
-----
-
-
-== Command listing
-
-The following commands are provided.
-
-* <>: Collection manipulations.
-* <>: Concatenate entries in a directory (containing Relaton-XML or YAML) into a Relaton Collection.
-* <>: Convert Relaton XML document.
-* <>: Cache DB manipulation.
-* <>: Extract Relaton XML from Metanorma XML file / directory.
-* <>: Fetch Relaton XML for Standard identifier CODE.
-* <>: Fetch all the documents from a source.
-* <>: Show Relaton version.
-* <>: Convert Relaton Collection XML into HTML.
-* <>: Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files).
-* <>: Concatenate Relaton Collection YAML into HTML.
-* <>: Convert Relaton YAML into Relaton Collection XML or separate files.
-
-[[relaton-collection]]
-== relaton collection
-
-The `relaton collection` command provides a set of subcommands for working with Relaton collections.
-
-[source,console]
-----
-$ relaton collection help
-relaton help collection
-Commands:
-  relaton collection create COLLECTION                                       # Create collection
-  relaton collection export COLLECTION                                       # Export collection into XML file
-  relaton collection fetch CODE -c, --collection=COLLECTION -t, --type=TYPE  # Fetch a document and store it into a collection
-  relaton collection find TEXT                                               # Full-text search
-  relaton collection get CODE                                                # Fetch document from collection by ID
-  relaton collection help [COMMAND]                                          # Describe subcommands or one specific subcommand
-  relaton collection import FILE -c, --collection=COLLECTION                 # Import document or collection from an XML file into another collection
-  relaton collection info COLLECTION                                         # View collection information
-  relaton collection list                                                    # List collections
-
-Options:
-  -v, [--verbose], [--no-verbose], [--skip-verbose]  # Output warnings
-----
-
-The following subcommands are provided.
-
-* `relaton collection create COLLECTION`: Create a new collection.
-* `relaton collection export COLLECTION`: Export a collection into an XML file.
-* `relaton collection fetch CODE`: Fetch a document by document identifier and store it in a collection.
-* `relaton collection find TEXT`: Full-text search.
-* `relaton collection get CODE`: Fetch a document from a collection by document identifier.
-* `relaton collection import FILE`: Import a document or collection from an XML file into another collection.
-* `relaton collection info COLLECTION`: View information about a collection.
-* `relaton collection list`: List collections.
-
-=== relaton collection create
-
-Creates a new collection with the name `COLLECTION_NAME`.
-
-[source,console]
-----
-$ relaton collection create COLLECTION_NAME
-----
-
-[example]
-====
-[source,console]
-----
-$ relaton collection create my_bib
-$ relaton collection list
-my_bib
-----
-====
-
-=== relaton collection export
-
-Exports the collection `COLLECTION_NAME` into an XML file.
-
-[source,console]
-----
-$ relaton collection export COLLECTION_NAME
-----
-
-[example]
-====
-[source,console]
-----
-$ relaton collection export my_bib
-$ cat my_bib.xml
-
-----
-====
-
-=== relaton collection fetch
-
-Fetches a document by document identifier `CODE` and stores it in the collection
-`COLLECTION_NAME`.
-
-The `type` argument is necessary.
-
-[source,console]
-----
-$ relaton collection fetch CODE -c COLLECTION_NAME -t TYPE
-----
-
-[example]
-====
-[source,console]
-----
-$ relaton collection fetch "ISO 8601-1:2019" -c my_bib -t category_one
-$ relaton collection list
-my_bib
-$ relaton collection get "ISO 8601-1:2019" -c my_bib
-Document identifier: ISO 8601-1:2019
-Title: Date and time
-Status: #
-Date published: 2019-02
-$ relaton collection export my_bib
-$ cat my_bib.xml
-
-  
-    ISO 8601-1:2019
-    Date and time — Representations for information interchange
-    
-      2019-12-15
-    
-    
-      
-      
-        International Organization for Standardization
-      
-    
-  
-
-----
-====
-
-
-=== relaton collection find
-
-Performs a full-text search for `TEXT` in the collection.
-
-[source,console]
-----
-$ relaton collection find TEXT
-----
-
-=== relaton collection get
-
-Fetches a document by document identifier `CODE` from the collection `COLLECTION_NAME`.
-
-[source,console]
-----
-$ relaton collection get CODE -c COLLECTION_NAME
-----
-
-=== relaton collection import
-
-Imports a document or collection from an XML file into another collection.
-
-[source,console]
-----
-$ relaton collection import FILE -c COLLECTION_NAME
-----
-
-=== relaton collection info
-
-Displays information about the collection `COLLECTION_NAME`.
-
-[source,console]
-----
-$ relaton collection info COLLECTION_NAME
-----
-
-[example]
-====
-[source,console]
-----
-relaton collection info my_bib
-Collection: my_bib
-Last updated: 2025-01-28 14:11:07 +0800
-File size: 6729
-2024-10-31
-2019-02
-Number of items: 1
-Author:
-Title:
-----
-====
-
-=== relaton collection list
-
-Lists all collections.
-
-[source,console]
-----
-$ relaton collection list
-----
-
-[example]
-====
-[source,console]
-----
-$ relaton collection list
-my_bib
-----
-====
-
-
-
-[[relaton-concatenate]]
-== relaton concatenate
-
-[source,console]
-----
-$ relaton concatenate Source-Directory Relaton-Collection-File -t TITLE -g ORGANIZATION
-----
-
-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.
-
-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
-file), a link to that file is inserted.
-
-If the `TITLE` or `ORGANIZATION` options are given, they are added to the `Collection-File` output as the
-title and author of the `Relaton-Collection-File` document.
-
-
-[[relaton-convert]]
-== relaton convert
-
-Converts a Relaton XML file into a different format. The `FORMAT` argument
-specifies the format to which the file is to be converted. The supported formats
-are `yaml` and `rxl`.
-
-[source,console]
-----
-$ relaton convert Relaton-XML-File -f FORMAT
-----
-
-== relaton split
-
-Splits a `Relaton-Collection-File` into multiple files in the `Relaton-File-Directory`, and it also
-suports an additional `-x` or `--extension` options to use different extension.
-
-[source,console]
-----
-$ relaton split Relaton-Collection-File Relaton-File-Directory -x rxl
-----
-
-== relaton fetch
-
-Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
-
-[source,console]
-----
-$ relaton fetch CODE -t TYPE -y YEAR
-----
-
-`CODE`::
-starts with one of the recognized prefixes. Prefix specifies the type of the
-document and the standard class library. The following prefixes are recognized:
-
-`CN`::: Chinese GB standards
-`IEC`::: International Electrotechnical Commission
-`RFC`::: Internet Engineering Task Force (IETF)
-`ISO`::: International Organization for Standardization
-`ITU`::: International Telecommunication Union
-`NIST`::: National Institute of Standards and Technology
-`OGC`::: Open Geospatial Consortium
-`CC`::: Calendaring and Scheduling Consortium
-`OMG`::: Object Management Group
-`UN`::: United Nations
-`W3C`::: World Wide Web Consortium
-`IEEE`::: Institute of Electrical and Electronics Engineers
-`IHO`::: International Hydrographic Organization
-`BIPM`::: Bureau International des Poids et Mesures
-`ECMA`::: European Computer Manufacturers Association
-`CIE`::: International Commission on Illumination
-`BSI`, `BS`, `PD`::: British Standards Institution
-`CEN`::: European Committee for Standardization
-
-`YEAR`:: optional. Specifies the year of publication of the standard.
-
-`TYPE`:: optional. Specifies the standards class library to be used, that the
-identifier is part of. The recognized values for `TYPE` are: `BIPM`, `BSI`, `CC`
-(CalConnect), `CEN`, `CIE`, `CN` (Chinese GB standards), `ECMA`, `IEC`, `IEEE`,
-`IETF`, `IHO`, `ISO`, `ITU`, `NIST`, `OGC`, `OMG`, `UN`, `W3C`.
-
-== relaton fetch-data
-
-Fetch all the documents from a source.
-
-[source,console]
-
-== relaton extract
-
-[source,console]
-----
-$ relaton extract Metanorma-XML-Directory Relaton-XML-Directory -x EXTENSION
-----
-
-Iterate through all the Metanorma XML files in `Metanorma-XML-Directory`, and extract the `bibdata`
-element from each. Save the `bibdata` element for each file to `Relaton-XML-Directory`, as the Relaton XML
-description for that file. If a document identifier is present in `bibdata`, it is used as the name of the
-file; otherwise, the original file name is used. The filename is suffixed with `EXTENSION`; by default,
-`.rxl` is used.
-
-[[relaton-xml2html]]
-== relaton xml2html
-
-[source,console]
-----
-$ relaton xml2html  [] []
-----
-
-Render a Relaton Collection XML as an HTML file. Used to generate an HTML index of standards.
-
-* `relaton-xml` is the Relaton Collection XML file.
-* `stylesheet` is the CSS stylesheet to be used to style the output. For the CSS styling of each bibliographic element, see below.
-* `html-template-dir` is a directory containing HTML Liquid Template files into which the bibliographic entries are to be inserted.
-There are two templates necessary:
-
-** Index template (`_index.liquid_`)
-
-*** The HTML Template file `_index.liquid` recognises the following parameters:
-*** `css`: where the CSS stylesheet `stylesheet` is injected
-*** `title`: the Title of the collection, `./relaton-collection/title` in `relaton-xml`
-*** `author`: the Author of the collection, `./relaton-collection/contributor[role/@type = 'author']/organization/name` in `relaton-xml`
-*** `content`: the list of resources generated by the script
-
-** Individual bibliographic entries template (`_document.liquid`)
-
-*** This template recognises attributes of a bibliographic entry (`document`) which follow the naming convention of <>; e.g. `document.html` is the HTML URI for the document.
-
-The default stylesheet and templates are given (which also demonstrates the structure) in the `templates` directory.
-
-Sample HTML output for a bibliographic entry:
-
-[source,html]
-----
-
-
-
-

- CC/R 3101 -

-
-
-
report
-
-
- -
-
cancelled
-
-
2019-10-17
-
-
-
- -
-
-
- HTML -
-
- PDF -
-
- Word -
-
- XML -
-
-
----- - -== relaton yaml2xml - -Convert a Relaton YAML file (`filename.yaml`) into a Relaton XML file (`filename.xml`). - -[source,console] ----- -$ relaton yaml2xml YAML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY ----- - -If the Relaton YAML file specifies multiple bibliographic 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. - -[[relaton-yaml]] -A Relaton Collection YAML file contains some initial metadata, and a list of metadata about each bibliographic entry: - -[source,yaml] ----- -root: - author: The Calendaring and Scheduling Consortium - title: CalConnect Standards Registry - items: - - technical_committee: PUBLISH - docid: - type: CC - id: CC 36000 - type: standard - title: - type: main - content: Standardization documents -- Vocabulary - docstatus: - stage: proposal - date: - type: issued - value: 2018-10-25 - - technical_committee: DATETIME - docid: - type: CC - id: CC 34000 - type: standard - title: - type: main - content: Date and time -- Concepts and vocabulary - docstatus: - stage: proposal - date: - type: issued - value: 2018-10-25 ----- - -A Relaton YAML file describing an individual bibliographic entry is limited to metadata specific to that entry. Flavor gems have additional fields. The link:https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc#yaml[Relaton YAML] illustrates the common fields supported by all flavor gems. - -== relaton xml2yaml - -Convert a Relaton XML file (`filename.xml` or `filename.rxl`) into a Relaton YAML file (`filename.yaml`). If the Relaton XML file is a collection, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton YAML 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 `.yaml`) 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. - -[source,console] ----- -$ relaton xml2yaml XML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY ----- - -== relaton yaml2html - -Render a Relaton YAML file (`filename.yaml`) as an HTML file. The `stylesheet` and `liquid-template-dir` directories are as for <>. - -[source,console] ----- -$ relaton yaml2html YAML [] [] ----- - diff --git a/_specs/relaton-model-diagrams.adoc b/_specs/relaton-model-diagrams.adoc deleted file mode 100644 index ebbf8ca..0000000 --- a/_specs/relaton-model-diagrams.adoc +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Relaton model diagrams -description: Diagrams for the Relaton bibliographic data models. - -external_links: - - url: https://github.com/relaton/relaton-models - -feature_with_priority: 5 - -spec_source: - git_repo_url: https://github.com/relaton/relaton-models - git_repo_subtree: images - git_repo_branch: main - build: - engine: png_diagram_page - -navigation: - items: - - title: "Bibliographic item" - path: RelBib_BibliographicItem/ - description: "" - - title: "Bibliographic item type" - path: RelBib_BibItemType/ - description: "" - ignore_missing: yes - - title: "Citation" - path: RelBib_Citation/ - description: "" - ignore_missing: yes - - title: "Contribution" - path: RelBib_Contribution/ - description: "" - ignore_missing: yes - - title: "Contributor" - path: RelBib_Contributor/ - description: "" - ignore_missing: yes - - title: "Date" - path: RelBib_Date/ - description: "" - ignore_missing: yes - - title: "Document relations" - path: RelBib_DocumentRelation/ - description: "" - ignore_missing: yes - - title: "Series" - path: RelBib_Series/ - description: "" - ignore_missing: yes - - title: "Data types" - path: RelBib_DataTypes/ - description: "" - ignore_missing: yes - - title: "Collection" - path: RelBib_Collection/ - description: "" - ignore_missing: yes - - title: "Keyword" - path: RelBib_Keyword/ - description: "" - ignore_missing: yes ---- - -These UML diagrams provide a bird's eye view on the organization -between the Relaton bibliographic and citation models. - -For details on usage, please refer to the link:/models[model specifications]. diff --git a/_specs/relaton-render.adoc b/_specs/relaton-render.adoc deleted file mode 100644 index 30ad92d..0000000 --- a/_specs/relaton-render.adoc +++ /dev/null @@ -1,3938 +0,0 @@ ---- -title: Relaton Render -description: Define and use bibliographic reference styles in Relaton. - -feature_with_priority: 8 - -external_links: - - url: https://github.com/relaton/relaton-render ---- -= Relaton Render - -== Introduction - -Relaton Render (`relaton-render`) is a Ruby gem that transforms Relaton objects -(which represent bibliographic items) into string reference renderings. - -Relaton Render allows you to: - -* define bibliographic reference styles -* render bibliographic and citation references using an existing bibliographic reference style -* localize bibliographic reference styles in multiple languages - -NOTE: Formatted references are embedded within Metanorma documents as `` elements. - -=== Purpose - -Relaton objects represent bibliographic items in a structured format. In order -to render these items in a human-readable format, a rendering process is needed -to convert the structured data into a formatted reference. - -There exists many types of bibliographic citation formats, each with its own -rules and conventions. - -Given that the Relaton models implement the defined bibliographic models of the -ISO 690 standard, Relaton Render is naturally able to render -bibliographic items according to the ISO 690 bibliographic styles, as well as -bibliographic styles that follow the bibliographic style definition framework described in ISO 690. - -NOTE: Most well-defined citation styles, such as APA and MLA, can be defined -within the meta-bibliographic framework of ISO 690. - -Relaton Render goes beyond commonly used citation rendering libraries and -citation specification languages, such as CSL (Citation Style Language), -CSL-derivatives like CSL-JSON, or Zotero, in that they are unable to handle the -comprehensive data elements and metadata supported by ISO 690. - -The ISO 690 is superior in expressibility to typical styles with some key -differences: - -* ISO 690 uses a data model that is a strict superset of typical citation -languages, including: - -** richness in representable data elements -** types of citable information resources - -* ISO 690 citation references are expressive yet consistent: - -** applies deterministic citation rules for every type of supported information -resource - -** provides the ability to round-trip human-readable citations into their -machine-readable counterparts in a lossless manner. - -NOTE: https://www.metanorma.org[Metanorma] is a standards publication system -that embeds Relaton data inside its documents to serve as both metadata and -references. Relaton Render provides Metanorma with the ability to render these -references in a human-readable format in the Metanorma presentation XML layer -under `bibitem/formattedref`, and can contain formatting (e.g. `` for -italics, `` for boldface.) See <>. - - -=== Data flow - -Here's how Relaton Render works: - -[source] ----- - ┌────────────────┐ - │ │ - ┌──────────────────────► │ - Relaton representation │ │ Parse │ - of bibiliography in XML │ │ │ - │ │ │ - │ │ └─────────┬──────┘ - │ │ Individual │ - │ │ record in │Extracted bibliographic - │ │ native Relaton │fields - │ Iterate │ object format ┌─────────▼──────┐ - ┌───────▼─────────┐ individual ┌─────┼─────────┐ │ │ - │ │ bibliographic│ │ │ │ -Disambiguate citations │ │ records │ │ <- i18n │ Field │ <- i18n -(author-date letters: "1980a") │ Citation ┼───────────────► General │ config(s) │ │ config(s) - │ │ │ │ │ │ -Select template and i18n config │ ◄───────────────┼ │ └─────────┬──────┘ -for each citation └───────┬─────────┘ └───────▲─────┬─┘ │ - │ Single bibiliographic │ │ │Formatted fields -Generate different │ citation │ │ Liquid template(s) │in an object structure -citation types │ │ │ for each field and │ -(author-date, full, short) │ │ │ full cite ┌────────▼───────┐ - │ │ └───────────────► │ - │ │ │ │ - ▼ │ │ Template │ - └─────────────────────┼ │ - Hash: biblio entry id Formatted string │ │ - to: citation type └────────────────┘ - to: citation string ---- - - -=== Bibliographic style - -A bibliographic style defines how citation and reference information should be -formatted when displayed in a document. - -[example] -==== -The ISO 690 default style renders these information resource types as follows: - -* Books: "Smith, J.; Jones, M. _Introduction to Programming_. Academic Press, 2023." -* Magazine articles: "Johnson, R.; Williams, K. Analysis of Modern Protocols. _Journal of Computing_ 15(2): 45-67, 2023." -==== - -[example] -==== -The APA style renders these information resource types as follows: - -* Books: "Smith, J., & Jones, M. (2023). _Introduction to Programming_. Academic Press." -* Magazine articles: "Johnson, R., & Williams, K. (2023). Analysis of Modern Protocols. _Journal of Computing_, 15(2), 45-67." -==== - -In Relaton, a style is implemented as a set of rendering templates that define -how different types of bibliographic resources should be formatted, -and how fields within that resource should be formatted. - -A style is realized in Relaton Render using a YAML configuration file that -specifies the template for each bibliographic resource type. The templates -define the exact formatting for different types of bibliographic resources (like -books, articles, standards, etc.). - -Each information resource template is implemented as a Liquid template that uses -data fields provided by the Relaton bibliographic object to render the formatted -reference. - -[source] ----- - Bibliographic Style (YAML) - | - | -╔═══════════════════════════════════════════════════════╗ -║ Liquid Templates | ║ -║ | ║ -║ +---------------+---------------+ ║ -║ | | | ║ -║ Monograph Series Events ║ -║ | | ║ -║ +--------+--------+ | ║ -║ | | | | ║ -║ Book Manual Standard | ║ -║ Template Template Template | ║ -║ | ║ -║ +-------+-------+ ║ -║ | | ║ -║ Journal Newspaper ║ -║ Template Template ║ -╚═══════════════════════════════════════════════════════╝ ----- - -In addition, several fields within the bibliographic object are given a separate -template for rendering: there is a template for names (governing the rendering of -one, two, three, or more authors, and the conditions for "et al." citation); -author citation (governing the use of surnames in author-date citation); -extents of citation (volume, issue, and page number); size of citation -(number of volumes, number of pages); full citations (such as will appear in -a bibliography); short citations (truncated versions of a citation that will appear -in-line in a document); and other citation formats (e.g. author-date). - - -=== Functionality - -The bibliographic style used is configured by a set of YAML templates, which is -documented here. - -Relaton-Render incorporates internationalization, and localises strings as appropriate. - -[example] -==== -Relaton Render applies language-specific formatting, for example: - -* Edition ordinals (e.g., "1st", "2nd", "3rd" in English) -* Standard abbreviations (e.g., "Ed.", "Vol.", "pp.") -* Common terms (e.g., "accessed", "viewed") -* Grammatical inflections (e.g., "Ed." vs "Eds." for singular/plural) - -All formatting is done according to the target language's conventions. -==== - -Relaton Render provides default internationalization YAML files and -bibiliographic reference format YAML files. Users can override these templates -with their own custom configurations. For instance, different Metanorma flavours -provide their own YAML templates to overrides. - -Relaton-Render also supports author-date citation, and it generates any necessary disambiguation -letters on dates (e.g. _Jones 1996a_ and _Jones 1996b_.) - -In advanced functionality, Relaton Render can provide multiple internationalisation -configurations and YAML templates, to be selected between according to criteria -specific to a single citation. The main use of this (as implemented in the Plateau flavour -of Metanorma) is to differentiate between how Japanese citations and Western-language -citations are rendered (e.g. distinct punctuation). - -== YAML bibliographic configuration - -=== General - -A YAML configuration file defines the templates for a bibliographic style. The YAML configuration -file for an instance of Relaton Render is defined in the `read_config` method of `Relaton::Render::General`, -which in Metanorma is set for each flavor gem; if it is not, a default configuration is inherited from the -`relaton-render` gem. - -Calling `Relaton::Render::General.new` with the parameter `config` lets the user pass the filename of a second -YAML file, which is merged with the default template from `read_config`: this allows the user to selectively -overwrite fiels in the configuration. - -Every key in the YAML file points to a specific Liquid template that is used (or re-used) -within the bibliographic style. The syntax of Liquid used by Relaton Render is defined under <>. - -If you are creating a new bibliographic style, you may wish to define new -templates by providing all the necessary keys in the YAML file. If a key is not -provided, the same key from the default template (ISO 690) will be used. - -There are several categories of keys to be defined in the YAML file: - -* Language and script -* Component templates -* Information resource type templates -* Information resource collection templates - -Syntax: - -[source,yaml] ----- -# Language and script of this style <1> -language: # ... -script: # ... - -# Component templates <2> -nametemplate: # ... -authorcitetemplate: # ... -extenttemplate: # ... -sizetemplate: # ... - -# Citation templates <3> -citetemplate: - author_date: # ... - author: # ... - title: # ... - short: - book: # ... - standard: # ... - -# Information resource type templates <4> -template: # ... - book: # ... - standard: # ... - ... - -# Information resource collection templates <5> -seriestemplate: # ... -journaltemplate: # ... ----- -<1> Language and script code of this bibliographic style. -<2> Templates for formatting contributor names, extent, and size information. -<3> Templates for formatting different citation types -<4> Main templates for different types of bibliographic items. -<5> Templates for formatting series and journal information. - -Specifically: - -`language`:: Language code for localization -`script`:: Script code for text rendering - -`nametemplate`:: Template for formatting contributor names in full bibliographic entries -`authorcitetemplate`:: Template for formatting contributor names in citations -`extenttemplate`:: Template for formatting extent information (e.g., pages, volumes) -`sizetemplate`:: Template for formatting size information - -`citetemplate`:: Template for different formats for citing bibliographic items -`short`::: Template for truncated formats for citing different types of bibliographic items - -`template`:: Main templates for different types of bibliographic items -(full citation, used in bibliography) - -`seriestemplate`:: Template for formatting series information -`journaltemplate`:: Template for formatting journal series information - -Each of these keys will be described in detail below. - - -=== Localization expressions - -==== General - -Localization formats are used to define how different elements of a citation are -formatted in different languages. - -[cols="1,1,1",options="header"] -|=== -|Key |Mandatory |See section - -|`language` |Yes |<> -|`script` |Yes |<> -|`edition_number` |No |<> -|`edition` |No |<> -|`date` |No |<> -|`labels` |No |<> - -|=== - -NOTE: The non-mandatory fields are already set by the default -internationalization files, and they are overridden using YAML keys. - - -==== Fields - -[[language-and-script]] -===== Language and script - -The `language` and `script` keys define the language and script code for the -bibliographic style. - -These keys are mandatory. - -Syntax: - -[source,yaml] ----- -language: {language-code} <1> -script: {script-code} <2> ----- -<1> Language code for localization -<2> Script code for text rendering - -Where: - -`language`:: Language code for localization from ISO 639 (ISO 639-2{B}, ISO 639-3, ISO 639-5). -`script`:: Script code for text rendering from ISO 15924. - -[example] -==== -[source,yaml] ----- -language: en -script: Latn ----- -==== - - -[[edition-number-format]] -===== Edition number format - -The `edition_number` key defines the template for rendering ordinal edition numbers. - -This key is optional. If missing, the raw number is given. - -Syntax: - -[source,yaml] ----- -edition_number: {ordinal-rule} <1> ----- -<1> Ordinal rule from Twitter CLDR for rendering ordinal numbers - -Where: - -`ordinal-rule`:: Rule-based number format from -https://github.com/twitter/twitter-cldr-rb[Twitter CLDR] for the target language - -[example] -==== -The following example shows how to define the ordinal rule for English. - -[source,yaml] ----- -edition_number: ["OrdinalRules", "digits-ordinal"] ----- - -For English, this generates "4th" from the number 4 using -the Twitter CLDR method of: - -[source,ruby] ----- -4.localize(:en).to_rbnf_s("OrdinalRules", "digits-ordinal") ----- -==== - - -[[edition-number-expression]] -===== Edition number expression - -The `edition` key defines the localized expression template for editions. - -This key is optional. If missing, the default setting is applied for that language, -as defined in the current Metanorma flavour. - -Syntax: - -[source,yaml] ----- -edition: {template} <1> ----- -<1> Template with % placeholder for edition number - -Where: - -`template`:: String template containing % where the edition number should be inserted - -[example] -==== -[source,yaml] ----- -edition: "% ed." ----- - -With `edition` set to `4` (representing the "4th edition"), this renders as "4th ed." -The configuration of `edition_number` determines the rendering of `4` as `4th`. -==== - - -//// - -THIS IS HALLUCINATED, AND DOES NOT EXIST IN RELATON-RENDER. - -[.date-formats]] -===== Date formats - -The `date` key defines the default date format and additional date format -variations. - -This key is optional. If missing, the default setting is applied for that -language. - -The contents of the `date` key is identical to that of <>. - -Syntax: - -[source,yaml] ----- -date: - default: {format} <1> - month_year: {format} <2> - day_month_year: {format} <3> - date_time: {format} <4> ----- -<1> Default date format -<2> Format for month and year -<3> Format for day, month and year -<4> Format for date and time - -Where: - -`format`:: See <> - -[example] -==== -[source,yaml] ----- -date: - default: to_long_s - month_year: to_long_s - day_month_year: to_long_s - date_time: to_long_s ----- -==== -//// - -[[nametemplate]] -=== Reference contributor name templates (`nametemplate`) - -==== General - -The top-level `nametemplate` key defines how contributor names are formatted in -full reference entries. - -Three distinct keys need to be provided: one for a single contributor (`one:`), -one for two contributors (`two:`), one for three or more (`more:`). - -Optionally one for "et al." (`etal:`). The number of contributors for which "et -al." starts being used is indicated by `etal_count`. - -These are the acceptable keys under `nametemplate`: - -`one`:: Template for formatting a single contributor name - -`two`:: Template for formatting two contributor names - -`more`:: Template for formatting contributor names from `2..m` (where `m` can be -a fixed number) - -`etal`:: (optional) Template for formatting more contributor names from a fixed -`m..n`, corresponding to usage of "et al.". (where `m` is a fixed number) - -`etal_count`:: (optional, when `etal` is set) The number limit of contributors -`m` when the `etal` template is used over the `more` template. - -Each sub-key should contain a Liquid template that formats the contributor names -according to the bibliographic style. - -Syntax: - -[source,yaml] ----- -nametemplate: - one: # ... - two: # ... - more: # ... - etal: # (optional) - etal_count: # (optional) - etal_display: # (optional) ----- - -[example] -==== -[source,yaml] ----- -nametemplate: - one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}{% endif %}" - two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}{% endif %} & {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }}{% endif %}" - more: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}{% endif %}, {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }}{% endif %} & {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{ given[2] }} {{ middle[2] | slice : 0 }} {{ surname[2] }}{% endif %}" - etal: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}{% endif %}, {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }}{% endif %} et al." - etal_count: 6 ----- -==== - - -[[nametemplate-fields]] -==== Fields - -The following fields are available for use in the `nametemplate`. - -===== Person contributor surnames - -Field:: `surname[0]` -Description:: Surname of the first person contributor, or complete name if -surname is not provided. (default for name) -Model path:: `1` -Value type:: String -+ -[example] -==== -`"Jones"` -==== - -Field:: `surname[1]` -Description:: Surname of the second person contributor -Model path:: `1` -Value type:: String -+ -[example] -==== -`"Smith"` -==== - -Field:: `surname[2]` -Description:: Surname of the third person contributor. -Model path:: `1` -Value type:: String -+ -[example] -==== -`"Johnson"` -==== - -Exceptionally, in `more`, the last surname subscript given corresponds to the final -surname, and entry for the preceding surname is repeated. So if `more` contains -`surname[0]`, `surname[1]` and `surname[2]`, `surname[1]` indicates how all surnames -are to be rendered between the first and the last surname, and `surname[2]` -indicates how the last surname is to be rendered. If 10 surnames are given (and the -`etal` template does not apply), then `surname[1]` applies to the first through ninth -surname, and `surname[2]` to the tenth surname. - -The same indexing conventions apply to all other name components under `nametemplate`. - -===== Person contributor initials - -The `formatted-initials` field is presumed to contain full stops, and so do the -surrogates of that field realized by using individual forenames' `initial` -attributes, or the forename initials. - -Initials are presumed to be delimited by a full stop followed by space or an alphabetic character. - -If the full stops are to be stripped, as is often required by bibliographic -styles, such processing needs to be done within the template through Liquid -value manipulation. - -Bibliographic styles also govern whether initials are separated by space. -Relaton Render treats the "full stop", not "space", as the delimiter between -initials. - -[example] -==== -"_D. X._" is two initials, as is "_D.X._". - -But "_M.-J._" is a single initial, and so is "_de S._" -==== - - -Field:: `initials[0]` -Description:: Formatted initials of the first person contributor. If not supplied, the first letter of each given name is used instead. -Model path:: `1` -Value type:: String[] - -[example] -==== -`["J","A"]` -==== - -Field:: `initials[1]` -Description:: Formatted initials of the second person contributor -Model path:: `1` -Value type:: String - -[example] -==== -`["M","L"]` -==== - -===== Person contributor forenames - -Field:: `given[0]` -Description:: First forename of the first person contributor. If not supplied, initials are used instead. -Model path:: `1` -Value type:: String -+ -[example] -==== -`"John"` -==== - -Field:: `given[1]` -Description:: First forename of the second person contributor. If not supplied, initials are used instead. -Model path:: `contributor[1].name.forename[0]` -Value type:: String - -[example] -==== -`"Mary"` -==== - -Field:: `middle[0]` -Description:: Forenames of the first person contributor except the first forename -Model path:: `1` -Value type:: String[] - -[example] -==== -`["Clarence", "Peter"]` -==== - -Field:: `middle[1]` -Description:: Forenames of the second person contributor except the first forename -Model path:: `1` -Value type:: String[] - -[example] -==== -`["Louise", "Helen"]` -==== - -===== Corporate/organizational contributor names - -Field:: `nonpersonal[0]` -Description:: Name of the first corporate/organizational contributor -Model path:: `1` -Value type:: String[] -+ -[example] -==== -`"Acme Inc."` -==== - -Field:: `nonpersonal[1]` -Description:: Name of the second corporate/organizational contributor -Model path:: `1` -Value type:: String[] -+ -[example] -==== -`"United Nations"` -==== - - -==== Single contributor name - -The sub-key `one` defines how a single contributor name is formatted. - -Only the following fields are available for use in the `one` sub-key: - -[cols="1a,1a,2a,2a",options="header"] -|=== -| Field | Cardinality | Description | Example value - -| `nonpersonal` | 0..1 (when `surname[0]` is not provided) | Corporate/organizational authors | `["World Health Organization"]` -| `surname` | 0..1 (when `nonpersonal[0]` is not provided) | Author family name | `["Smith"]` -| `given` | 0..1 | Full given name | `["John"]` -| `initials` | 0..1 | Initial array | `[["J","A"]]` -| `middle` | 0..1 | Middle name | `["Alexander"]` - -|=== - - -Syntax: - -[source,yaml] ----- -nametemplate: - one: >- - ... ----- - -[example] -==== -This example shows how a single contributor name is formatted in Liquid -with whitespaces trimmed. - -[source,yaml] ----- -nametemplate: - one: >- - {%- if nonpersonal[0] -%} - {{ nonpersonal[0] }} - {%- else -%} - {{surname[0] | upcase }} ,_ - {%- if given[0] -%} - {{given[0]}} {{middle[0]}} - {%- else -%} - {{initials[0] | join: ' '}}. - {%- endif -%} - {%- endif -%} ----- - -Possible sample outputs of this template would be: - -* "World Health Organization" if the contributor is a corporate author (`nonpersonal[0]` is provided) -* "Smith, John Alexander" if the contributor is an individual author with given names provided (`given[0]`, `middle[0]` are provided) -* "Smith, J. A." if the contributor is an individual author with only initials (`given[0]` not provided) -==== - -==== Two contributor names - -The sub-key `two` defines how two contributor names are formatted. - -The following fields are available for use in the `two` sub-key: - -[cols="1a,1a,2a,2a",options="header"] -|=== -| Field | Cardinality | Description | Example value - -| `nonpersonal` | 0 or 2 (when `surname[0]` is not provided) | Corporate/organizational authors | `["World Health Organization", "United Nations"]` -| `surname` | 0 or 2 (when `nonpersonal[0]` is not provided) | Author family name | `["Smith", "Jones"]` -| `given` | 0..2 | Full given name | `["John", "Mary"]` -| `initials` | 0..2 | Initial array | `[["J","A"], ["M","L"]]` -| `middle` | 0..2 | Middle name | `["Alexander", "Louise"]` - -|=== - -Syntax: - -[source,yaml] ----- -nametemplate: - two: >- - ... ----- - -[example] -==== -This example shows how two contributor names are formatted in Liquid -with whitespaces trimmed. - -[source,yaml] ----- -nametemplate: - two: >- - {%- if nonpersonal[0] -%} - {{ nonpersonal[0] }} - {%- else -%} - {{surname[0] | upcase }} ,_ - {%- if given[0] -%} - {{given[0]}} {{middle[0]}} - {%- else -%} - {{initials[0] | join: ' '}}. - {%- endif -%} - {%- endif -%} - {{ labels['author_and'] }} - {%- if nonpersonal[1] -%} - {{ nonpersonal[1] }} - {%- else -%} - {%- if given[1] -%} - {{given[1]}} {{middle[1]}} - {%- else -%} - {{initials[1] | join: ' '}}. - {%- endif -%} - {%- endif -%} ----- - -Possible sample outputs of this template would be: - -* "World Health Organization and United Nations" if the contributors are corporate authors (`nonpersonal[0]`, `nonpersonal[1]` are provided) -* "Smith, John Alexander and Jones, Mary Louise" if the contributors are individual authors with given names provided (`given[0]`, `middle[0]`, `given[1]`, `middle[1]` are provided) -* "Smith, J. A. and Jones, M. L." if the contributors are individual authors with only initials (`given[0]`, `given[1]` not provided) -* "Smith, J. A. and United Nations" if the first contributor is an individual author and the second is a corporate author (`given[0]` not provided, `nonpersonal[1]` is provided) -* "World Health Organization and Jones, M. L." if the first contributor is a corporate author and the second is an individual author (`nonpersonal[0] is provided, `given[1]` not provided) -==== - -==== More than two contributor names - -The sub-key `more` defines how more than two contributor names are formatted. - -The template for the `(name)[0]` entries is repeated for all additional authors -above 2 and before the final author. - -The following fields are available for use in the `more` sub-key: - -[cols="1a,1a,2a,2a",options="header"] -|=== -| Field | Cardinality | Description | Example value - -| `nonpersonal` | 0..n (when `surname[0]` is not provided) | Corporate/organizational authors | `["World Health Organization", "United Nations", "European Union"]` -| `surname` | 0..n (when `nonpersonal[0]` is not provided) | Author family name | `["Smith", "Jones", "Brown"]` -| `given` | 0..n | Full given name | `["John", "Mary", "David"]` -| `initials` | 0..n | Initial array | `[["J","A"], ["M","L"], ["D","P"]]` -| `middle` | 0..n | Middle name | `["Alexander", "Louise", "Peter"]` - -|=== - -Syntax: - -[source,yaml] ----- -nametemplate: - more: >- - ... ----- - -[example] -==== -This example shows how more than two contributor names are formatted in Liquid -with whitespaces trimmed. - -[source,yaml] ----- -nametemplate: - more: >- - {%- if nonpersonal[0] -%} - {{ nonpersonal[0] }} - {%- else -%} - {{surname[0] | upcase }} ,_ - {%- if given[0] -%} - {{given[0]}} {{middle[0]}} - {%- else -%} - {{initials[0] | join: ' '}}. - {%- endif -%} - {%- endif -%} - , {{ labels['author_and'] }} - {%- if nonpersonal[1] -%} - {{ nonpersonal[1] }} - {%- else -%} - {%- if given[1] -%} - {{given[1]}} {{middle[1]}} - {%- else -%} - {{initials[1] | join: ' '}}. - {%- endif -%} - {%- endif -%} - , {{ labels['author_and'] }} - {%- if nonpersonal[2] -%} - {{ nonpersonal[2] }} - {%- else -%} - {%- if given[2] -%} - {{given[2]}} {{middle[2]}} - {%- else -%} - {{initials[2] | join: ' '}}. - {%- endif -%} - {%- endif -%} ----- - -Possible sample outputs of this template would be: - -* "World Health Organization, United Nations, and European Union" if the contributors are corporate authors (`nonpersonal[0]`, `nonpersonal[1]`, `nonpersonal[2]` are provided) -* "Smith, John Alexander, Jones, Mary Louise, Jónson, Helmut, Frederikssohn, Helga, and Brown, David Peter" if the contributors are individual authors with given names provided (`given[0]`, `middle[0]`, `given[1]`, `middle[1]`, `given[2]`, `middle[2]` are provided). Note that in this case, five names have been given: the second through fourth name are rendered using `given[1]`, `middle[1]`, `surname[1]`, and the fifth name is rendered using `given[2]`, `middle[2]`, `surname[2]`. -* "Smith, J. A., Jones, M. L., and Brown, D. P." if the contributors are individual authors with only initials (`given[0]`, `given[1]`, `given[2]` not provided) -* "Smith, J. A., United Nations, and European Union" if the first two contributors are individual authors and the third is a corporate author (`given[0]`, `given[1]` not provided, `nonpersonal[2]` is provided) -* "World Health Organization, Jones, M. L., and Brown, D. P." if the first contributor is a corporate author and the second and third are individual authors (`nonpersonal[0]` is provided, `given[1]`, `given[2]` not provided) -==== - - -==== "Et al" template - -The _et al._ template is an optional template for condensing more than `m` -contributor names into a rendered string. - -Usage of the `etal` template is optional. - -The behavior of _et al._ can be specified using these additional keys: - -`etal_count`:: the number of authors to trigger _et al._ in bibliographic -rendering. - -`etal_display`:: (optional) how many authors to show if using _et al._ in -bibliography. If no value is provided, it is the same as `etal_count`. - -Syntax: - -[source,yaml] ----- -nametemplate: - etal: >- - ... - etal_count: ... # mandatory when using etal - etal_display: ... # optional when using etal ----- - -.Sample template for `etal` -[example] -==== ----- -nametemplate: - etal: >- - {%- if nonpersonal[0] -%} - {{ nonpersonal[0] }} - {%- else -%} - {{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }} - {%- endif -%}, - {%- if nonpersonal[1] -%} - {{ nonpersonal[1] }} - {%- else -%} - {{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }} - {%- endif -%} - et al. - etal_count: 6 ----- - -This template will render the first two authors, followed by _et al._ if there -are more than 6 authors. Such as: - -* "Smith, J. A., Jones, M. L., et al." if there are more than 6 authors -* "Acme Inc., United Nations, et al." if there are more than 6 corporate authors -==== - -[example] -==== -The Chicago Manual of Style behavior of: - -____ -For more than ten authors (not shown here), list the first seven in the reference list, followed by et al. -____ - -is realized with `etal_count: 10`, `etal_display: 7`. -==== - - -[[authorcitetemplate]] -=== Citation contributor name templates (`authorcitetemplate`) - -==== General - -The top-level `authorcitetemplate` key defines how author names are formatted in -citations, which are typically simpler than full reference entries. - -[example] -==== -Author-date citations can look like "(Smith 2020)". -==== - -This is a subclass of the `nametemplate` (<>), configured for -rendering author names for author-date citations. - -NOTE: Citation names are often shorter than full reference entries, often -showing only surnames. `authorcitetemplate` thus arranges surnames, whereas -`nametemplate` arranges full names. - -Three distinct keys need to be provided: one for a single contributor (`one:`), -one for two contributors (`two:`), one for three or more (`more:`). -Optionally an additional key is also provided for "et al." (`etal:`). The number of contributors for which "et -al." starts being used is indicated by `etal_count`. - -These are the acceptable keys under `authorcitetemplate`: - -`one`:: Template for formatting a single contributor name - -`two`:: Template for formatting two contributor names - -`more`:: Template for formatting contributor names from `2..m` (where `m` can be -a fixed number) - -`etal`:: (optional) Template for formatting more contributor names from a fixed -`m..n`, corresponding to usage of "et al.". (where `m` is a fixed number) - -`etal_count`:: (optional, when `etal` is set) The number limit of contributors -`m` when the `etal` template is used over the `more` template. - -NOTE: The behaviour of _et al._ in `authorcitetemplate` is specified the same -way as for `nametemplate`. - -Each sub-key should contain a Liquid template that formats the contributor names -according to the bibliographic style. - -Syntax: - -[source,yaml] ----- -authorcitetemplate: - one: # ... - two: # ... - more: # ... - etal: # (optional) - etal_count: # (optional) - etal_display: # (optional) ----- - -[example] -==== -[source,yaml] ----- -authorcitetemplate: - one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }}{% endif %}" - two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }}{% endif %} {{ labels['author_and'] }} {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1] }}{% endif %}" - more: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }}{% endif %}, {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1] }}{% endif %} {{ labels['author_and'] }} {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{surname[2] }}{% endif %}" ----- -==== - -[[authorcitetemplate-fields]] -==== Fields - -The fields available for use in the `authorcitetemplate` context is identical -to those for `nametemplate`. See <> for details. - - -==== Single author name - -The sub-key `one` defines how a single author name is formatted in citations. - -Only the following fields are available for use in the `one` sub-key: - -[cols="1a,1a,2a,2a",options="header"] -|=== -| Field | Cardinality | Description | Example value - -| `nonpersonal` | 0..1 (when `surname[0]` is not provided) | Corporate/organizational authors | `["World Health Organization"]` -| `surname` | 0..1 (when `nonpersonal[0]` is not provided) | Author family name | `["Smith"]` -| `given` | 0..1 | Full given name | `["John"]` -| `initials` | 0..1 | Initial array | `[["J","A"]]` -| `middle` | 0..1 | Middle name | `["Alexander"]` - -|=== - -Syntax: - -[source,yaml] ----- -authorcitetemplate: - one: >- - ... ----- - -[example] -==== -This example shows how a single author name is formatted in Liquid -with whitespaces trimmed. - -[source,yaml] ----- -authorcitetemplate: - one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{ surname[0] }}{% endif %}" ----- - -Possible sample outputs of this template would be: - -* "World Health Organization" if the author is a corporate author (`nonpersonal[0]` is provided) -* "Smith" if the author is an individual author (`surname[0]` is provided) -==== - -==== Two author names - -The sub-key `two` defines how two author names are formatted in citations. - -The following fields are available for use in the `two` sub-key: - -[cols="1a,1a,2a,2a",options="header"] -|=== -| Field | Cardinality | Description | Example value - -| `nonpersonal` | 0 or 2 (when `surname[0]` is not provided) | Corporate/organizational authors | `["World Health Organization", "United Nations"]` -| `surname` | 0 or 2 (when `nonpersonal[0]` is not provided) | Author family name | `["Smith", "Jones"]` -| `given` | 0..2 | Full given name | `["John", "Mary"]` -| `initials` | 0..2 | Initial array | `[["J","A"], ["M","L"]]` -| `middle` | 0..2 | Middle name | `["Alexander", "Louise"]` - -|=== - -Syntax: - -[source,yaml] ----- -authorcitetemplate: - two: >- - ... ----- - -[example] -==== -This example shows how two author names are formatted in Liquid with whitespaces trimmed. - -[source,yaml] ----- -authorcitetemplate: - two: >- - {%- if nonpersonal[0] -%} - {{ nonpersonal[0] }} - {%- else -%} - {{ surname[0] }} - {%- endif -%} - {{ labels['author_and'] }} - {%- if nonpersonal[1] -%} - {{ nonpersonal[1] }} - {%- else -%} - {{ surname[1] }} - {%- endif -%} ----- - -Possible sample outputs of this template would be: - -* "World Health Organization and United Nations" if the authors are corporate authors (`nonpersonal[0]`, `nonpersonal[1]` are provided) -* "Smith and Jones" if the authors are individual authors (`surname[0]`, `surname[1]` are provided) -==== - -==== More than two author names - -The sub-key `more` defines how more than two author names are formatted in citations. - -The following fields are available for use in the `more` sub-key: - -[cols="1a,1a,2a,2a",options="header"] -|=== -| Field | Cardinality | Description | Example value - -| `nonpersonal` | 0..n (when `surname[0]` is not provided) | Corporate/organizational authors | `["World Health Organization", "United Nations", "European Union"]` -| `surname` | 0..n (when `nonpersonal[0]` is not provided) | Author family name | `["Smith", "Jones", "Brown"]` -| `given` | 0..n | Full given name | `["John", "Mary", "David"]` -| `initials` | 0..n | Initial array | `[["J","A"], ["M","L"], ["D","P"]]` -| `middle` | 0..n | Middle name | `["Alexander", "Louise", "Peter"]` - -|=== - -As with `nametemplate`, if more than three names are provided to `authorcitetemplate`, `[0]` references -the initial name, `[2]` refers to the final name, and `[1]` refers to the names in between. If more than two names -are given in the template, the second last name is the name repeated. - -Syntax: - -[source,yaml] ----- -authorcitetemplate: - more: >- - ... ----- - -[example] -==== -This example shows how more than two author names are formatted in Liquid with whitespaces trimmed. - -[source,yaml] ----- -authorcitetemplate: - more: >- - {%- if nonpersonal[0] -%} - {{ nonpersonal[0] }} - {%- else -%} - {{surname[0] }} - {%- endif -%}, - {%- if nonpersonal[1] -%} - {{ nonpersonal[1] }} - {%- else -%} - {{surname[1] }} - {%- endif -%} - {{ labels['author_and'] }} - {%- if nonpersonal[2] -%} - {{ nonpersonal[2] }} - {%- else -%} - {{surname[2] }} - {%- endif -%} ----- - -Possible sample outputs of this template would be: - -* "World Health Organization, United Nations, and European Union" if the authors are corporate authors (`nonpersonal[0]`, `nonpersonal[1]`, `nonpersonal[2]` are provided) -* "Smith, Jones, Jackson, and Brown" if the authors are individual authors (`surname[0]`, `surname[1]`, `surname[2]` are provided; `surname[1]` is repeated for -Jones and Jackson) -==== - -==== "Et al" template - -The _et al._ template is an optional template for condensing more than `m` -contributor names into a rendered string when used in citations. - -Usage of the `etal` template is optional. - -The behavior of _et al._ can be specified using these additional keys: - -`etal_count`:: the number of authors to trigger _et al._ in citation rendering. - -`etal_display`:: (optional) how many authors to show if using _et al._ in -citations. If no value is provided, it is the same as `etal_count`. - -Syntax: - -[source,yaml] ----- -authorcitetemplate: - etal: >- - ... - etal_count: ... # mandatory when using etal - etal_display: ... # optional when using etal ----- - -.Sample template for `etal` -[example] -==== ----- -authorcitetemplate: - etal: >- - {%- if nonpersonal[0] -%} - {{ nonpersonal[0] }} - {%- else -%} - {{ surname[0] }} - {%- endif -%}, - {%- if nonpersonal[1] -%} - {{ nonpersonal[1] }} - {%- else -%} - {{ surname[1] }} - {%- endif -%} - et al. - etal_count: 3 ----- - -This template will render the first two authors, followed by _et al._ if there -are more than 3 authors. Such as: - -* "Smith, Jones, et al." if there are more than 3 authors -* "Acme Inc., United Nations, et al." if there are more than 3 corporate authors -==== - -[example] -==== -The APA Style behavior of: - -____ -For a work with three or more authors, include only the first author's name plus "et al." in every citation. -____ - -is realized with `etal_count: 3`, `etal_display: 1`. -==== - -=== Information resource template re-use - -A template keyed to an information resource (`extenttemplate`, `sizetemplate`, -`citetemplate.short`, `template`) can be re-used by other information resource types by specifying the -name of the template as a string. - -This is useful for cases where multiple information resource types share the -same formatting rules. - -Syntax: - -[source,yaml] ----- -template: - book: # ... - booklet: book <1> - # ... ----- -<1> The `booklet` information resource type uses the same template as `book`. - -[example] -==== -[source,yaml] ----- -template: - book: # ... - booklet: book - misc: # ... - map: misc - audiovisual: misc ----- -==== - - -[[extenttemplate]] -=== Extent templates (`extenttemplate`) - -==== General - -The extent templates defines how extent information (pages, volumes) is -formatted for different types of information resources. - -The extent templates key `extenttemplate` accepts a separate template -for each bibliographic item type, with the type name as the key. - -All supported information resource types can have their own extent template, as -different types of bibliographic items may have different ways of expressing -extent. - -[example] -==== -The extent of a book chapter may be expressed as _pp. 9–20_, while the extent of -an article may be expressed as just _9–20_. -==== - -For those information resource types where no specific template is supplied, the -template given for `misc` is used as the default. - -Syntax: - -[source,yaml] ----- -extenttemplate: - article: # (optional) <1> - book: # (optional) - misc: # (required) <2> ----- -<1> Extent templates for all information resource types are optional. -<2> The `misc` extent template is mandatory. - -The template draws on the defined types of locality of extents; the most common -of these is `volume`, `issue` (within volume; "number" for journals), and -`page`. Locality types are the fields used in the Liquid templates. - -[example] -==== ----- -extenttemplate: - article: "{{ volume_raw }}|({{ issue_raw }}) : {{ page_raw }}" - misc: "{{ volume }}, {{ page }}" ----- -==== - -The number of the volume, issue/number, or page, without accompanying labels, is given in `volume_raw`, `issue_raw`, and `page_raw`. -So `{{volume}}` is by default defined to include the locality type label _Vol._ (or its internationalised equivalent); -`volume_raw` contains just the number. As explained in <>, `|` in the example is an instruction not to insert -space between the volume number and the parenthesis befor the issue number. - -The internationalization files define a singular and a plural version of the -locality types, under `labels['extent']`. - -.Extent internationalisation for English -==== -[source,yaml] ----- -extent: - page: - sg: "p. %" - pl: "pp. %" ----- -==== - -* The plural label is always used if the extent is a range (with a `` and ``). -* The singular label is used if the extent is not a range (_pp. 2–4_ vs. _p. 3_). -* The internationalization files include a slot where the number or number range is inserted, indicated by `%`, since this varies by language. (For instance, English has `pp. %`, whereas Chinese has `第%页`.) - -.Default setting for English extent templates for ISO 690 -[example] -==== -[source,yaml] ----- -extenttemplate: - book: "{{ volume }}, {{ page }}" - booklet: book - proceedings: book - journal: book - standard: book - techreport: book - inbook: "{{ volume }}: {{ page }}" - article: "{{ volume }} {{issue}} , {{ page }}, {{ duration }}" - misc: "{{ volume }} {{issue}} , {{ page }}, {{ duration }}" ----- -==== - -[[extent-locality-fields]] -==== Fields for locality objects - -===== General - -The extent is made up of a single locality object, conjointed locality objects, -or a locality stack (a hierarchical structure of localities). - -Each locality indication is represented as a Relaton Locality object. - -The fields available in extent templates come from the Relaton bibliographic -object's `locality` attribute, which contains a list of `Locality` objects. Each -locality object provides fields that can be used in the templates. - -All Locality fields are available in `{name}` and `{name}_raw` format: - -`{name}`:: provides the original value applied with a localized label for the extent type (e.g. _Vol._ for volume in English, -_vol._ in French, _т._ in Russian). -+ -[example] -==== -`volume` is the string `"Vol. 3"`. -==== - -`{name}_raw`:: provides only the original value. -+ -[example] -==== -`volume_raw` is the numeric value `3`. -==== - -//// -I have not at this time defined any i18n past volume, issue, page -//// - -[cols="1,1,1",options="header"] -|=== -| Field | Model path | See section - -| `chapter` | `extent.locality[type='chapter']` | <> -| `duration` | `extent.locality[type='time']` | <> -| `issue` | `extent.locality[type='issue']` | <> -| `page` | `extent.locality[type='page']` | <> -| `paragraph` | `extent.locality[type='paragraph']` | <> -| `volume` | `extent.locality[type='volume']` | <> - -|=== - -NOTE: The `{name}_raw` fields are omitted from the table above for convenience. - -NOTE: The fields are identical to the supported types of the `Locality` object. - -[example] -==== -[source,yaml] ----- -extenttemplate: - article: "{{ volume_raw }}|({{ issue_raw }}) : {{ page_raw }}" - misc: "{{ volume }}, {{ page }}" ----- -==== - -===== Chapter - -Field:: `chapter` -Description:: Chapter number -Model path:: `extent.locality[type='chapter']` -Value type:: String - -[example] -==== -`"Chapter 3"` -==== - -Field:: `chapter_raw` -Description:: Raw chapter number without label -Model path:: `extent.locality[type='chapter']` -Value type:: String - -[example] -==== -`3` -==== - - -====== Issue - -Field:: `issue` -Description:: Issue or number within volume -Model path:: `extent.locality[type='issue']` -Value type:: String - -[example] -==== -`"Issue 4"` -==== - -Field:: `issue_raw` -Description:: Raw issue number without label -Model path:: `extent.locality[type='issue']` -Value type:: String - -[example] -==== -`4` -==== - -===== Paragraph - -Field:: `paragraph` -Description:: Paragraph number -Model path:: `extent.locality[type='paragraph']` -Value type:: String - -[example] -==== -`"Para 12"` -==== - -Field:: `paragraph_raw` -Description:: Raw paragraph number without label -Model path:: `extent.locality[type='paragraph']` -Value type:: String - -[example] -==== -`12` -==== - -===== Page - -Field:: `page` -Description:: Page number or range with label -Model path:: `extent.locality[type='page']` -Value type:: String - -[example] -==== -`"pp. 45-67"` -==== - -Field:: `page_raw` -Description:: Raw page number or range without label -Model path:: `extent.locality[type='page']` -Value type:: String - -[example] -==== -`"45-67"` -==== - -===== Volume - -Field:: `volume` -Description:: Volume number -Model path:: `extent.locality[type='volume']` -Value type:: String - -[example] -==== -`"Vol. 3"` -==== - -Field:: `volume_raw` -Description:: Volume number -Model path:: `extent.locality[type='volume']` -Value type:: String - -[example] -==== -`3` -==== - - - - - - -=== Size template (`sizetemplate`) - -==== General - -The size template defines how size information (number of pages, volumes) is -formatted for different types of information resources. - -The size of a bibliographic item is distinct from the extent: - -* the size is how large the item is (e.g. "how many pages are in the book?") - -* the extent is how much of the host item the item covers (e.g. "which pages of -the book are in the current chapter?") - -Extent is required in almost all bibliographic styles, for items that do not -take up the full extent of a resource (e.g. journal articles); sizes are required -in bibliographic styles less commonly. - -They can be displayed quite differently from extent. For example, while extent -pages is given in English as _pp. 9–20_ or _p. 3_, size pages is given as _3 -pp._. - -For those types where none is supplied, the template given for `misc` is used as -the default. - -[[size-locality-fields]] -==== Fields for locality objects - -===== General - -Similar to <>, the "size" of an information resource is -made up of one or more locality indications, with each locality indication -represented as a Relaton Locality object. - -The template draws on the defined types of locality of extents, which are each -represented by a Relaton Locality object. Each locality object provides fields -that can be used in the templates. - -All Locality fields are available in `{name}` and `{name}_raw` format, -see <> for details. - - -[cols="1,1,1",options="header"] -|=== -| Field | Model path | See section - -| `data` | `medium.size[type='data']` | <> -| `duration` | `medium.size[type='time']` | <> -| `volume` | `medium.size[type='volume']` | <> -| `issue` | `medium.size[type='issue']` | <> -| `page` | `medium.size[type='page']` | <> - -|=== - -NOTE: The `{name}_raw` fields are omitted from the table above for convenience. - -[example] -==== -[source,yaml] ----- -sizetemplate: - dataset: "{{ data }}" - electronic resource: dataset - webresource: dataset - misc: "{{ volume }}, {{ issue }}, {{ page }}, {{ data }}, {{ duration }}" ----- -==== - - -For internationalization of labels, the following rules apply: - -* Pluralization: - -** A singular and a plural version of the locality types, under `labels['size']` -are defined in the internationalization files. - -** If the extent is a range, the plural label is used (with a `from` and `to`). - -** The label is singular only if the value is `1`, else it is plural (_1 p._, _2 pp._) - -* Number ranges: - -** The internationalization files include a slot where the number or number range -is inserted, since this varies by language. - -** The number of volumes or pages, without accompanying labels, is given in `volume_raw` and `page_raw`. - -* Multiple localities of the same type are joined by the `+` symbol. -+ -==== -The extent of a chapter in a book may be expressed as _Vol. 3, pp. 9–20_, while the size of a book may be expressed as -_3 vols._, or as _xlii + 76 pp._, which differentiates two paginations (preface, and main body of text). -==== - -[example] -==== -[source,yaml] ----- -size: - page: - sg: "% p." - pl: "% pp." - volume: - sg: "% vol." - pl: "% vols." - issue: - sg: "% no." - pl: "% nos." ----- -==== - - -[[field-size-data]] -===== Data size - -Field:: `data` -Description:: The size of data, with unit included in value -Model path:: `medium.size[type='data']` -Value type:: String - -[example] -==== -`"3.2 GB"` -==== - -Field:: `data_raw` -Description:: The size of data, without unit -Model path:: `medium.size[type='data']` -Value type:: String - -[example] -==== -`"3.2"` -==== - - -[[field-size-duration]] -===== Duration - -Field:: `duration` -Description:: The time duration expressed in ISO 8601-1 format -Model path:: `medium.size[type='time']` -Value type:: String - -[example] -==== -`"PT2H30M"` (2 hours 30 minutes) -==== - - -[[field-size-volume]] -====== Volume - -Field:: `volume` -Description:: The number of volumes, formatted with internationalized label -Model path:: `medium.size[type='volume']` -Value type:: String - -[example] -==== -`"3 vols."` -==== - -Field:: `volume_raw` -Description:: The number of volumes, without label -Model path:: `medium.size[type='volume']` -Value type:: String - -[example] -==== -`"3"` -==== - - -[[field-size-issue]] -===== Issue - -Field:: `issue` -Description:: The number of issues, formatted with internationalized label -Model path:: `medium.size[type='issue']` -Value type:: String - -[example] -==== -`"12 nos."` -==== - -Field:: `issue_raw` -Description:: The number of issues, without label -Model path:: `medium.size[type='issue']` -Value type:: String - -[example] -==== -`"12"` -==== - - -[[field-size-page]] -===== Page - -Field:: `page` -Description:: The number of pages, formatted with internationalized label -Model path:: `medium.size[type='page']` -Value type:: String - -[example] -==== -`"456 pp."` -==== - -Field:: `page_raw` -Description:: The number of pages, without label -Model path:: `medium.size[type='page']` -Value type:: String - -[example] -==== -`"456"` -==== - - -=== Information resource templates (`template`) - -==== Data fields - -Data fields for bibliographic entries are exposed in a template definition context, which accesses data -elements from the Relaton bibliographic object being rendered. - -Each `template` points to a string value in the -https://shopify.github.io/liquid/[Liquid language] syntax. - -The following fields are exposed to the Liquid context from the Relaton -bibliographic item, via preprocessing done in the Parse, Extract, and Fields classes -of Relaton-Render. - -NOTE: A Liquid "context" is the evaluation environment of a Liquid template. -The fields below are exposed directly at their attributable names in the template -as Liquid variables. For example, the value of the Liquid variable `title` -will be extracted from the Relaton object's `title` attribute, but with some preprocessing -- -including extracting the main title of a resource as opposed to other titles (such as the introductory -component of a title); the `authoritative_identifier` extracts a subset of the `docidentifier` -attributes from the Relaton object, prioritising the identifiers appropriate to display as primary -in a bibliography; `creatornames` uses the results of passing the `contributor` attributes from the -Relaton object through the `nametemplate` template. - - -[cols="1,1,1,1,1",options="header"] -|=== -| Field | Model path | Multiple | Host | See section - -| `title` | `title` | No | No | <> -| `edition` | `edition` | No | Yes | <> -| `edition_raw` | `edition` | No | Yes | <> -| `edition_num` | `edition[number]` | No | Yes | <> -| `medium` | `medium` | No | Yes | <> -| `place_raw` | `place` | No | Yes | <> -| `place` | `place` | No | Yes | <> -| `publisher` | `contributor[role.type='publisher'].organization.name` | No | Yes | <> -| `distributor` | `contributor[role.type='distributor'].organization.name` | No | Yes | <> -| `authorizer` | `contributor[role.type='authorizer'].organization.name` or `contributor[role.type='publisher'].organization.name` | No | Yes | <> -| `authoritative_identifier` | `docidentifier[type!='metanorma' && type!='ordinal' && type!='ISBN' && type!='ISSN' && type!='DOI']` | Yes | No | <> -| `other_identifier` | `docidentifier[type='ISBN' or type='ISSN' or type='DOI']` | Yes | No | <> -| `doi` | `docidentifier[type='DOI']` | Yes | No | <> -| `status_raw` | `status` | No | No | <> -| `status` | `status` | No | No | <> -| `uri` | `uri[type='citation' or type='uri' or type='src' or exists]` | No | No | <> -| `access_location` | `accessLocation` | No | Yes | <> -| `extent` | `extent` | Yes | No | <> -| `creatornames` | `contributor[role.type='author' or role.type='performer' or role.type='adapter' or role.type='translator' or role.type='editor' or role.type='distributor' or role.type='authorizer']` | Yes | No | <> -| `authorcite` | `contributor[role.type='author' or role.type='performer' or role.type='adapter' or role.type='translator' or role.type='editor' or role.type='distributor' or role.type='authorizer']` | Yes | No | <> -| `role` | `contributor[role.description or role.type]` | No | No | <> -| `date` | `date[type='published' or type='issued' or type='circulated']` | No | Yes | <> -| `disambiguated_date` | `date[type='published' or type='issued' or type='circulated']` | No | Yes | <> -| `date_updated` | `date[type='updated']` | No | Yes | <> -| `date_accessed` | `date[type='accessed']` | No | Yes | <> - -| `host_creatornames` | `relation[type='includedIn']` or `bibitem.contributor[role.type='author']` | No | Yes | <> - -| `host_title` | `relation[type='includedIn']` or `bibitem.title` | Yes | Yes | <> -| `host_role` | `relation[type='includedIn']` or `bibitem.contributor[role.description]` | No | Yes | <> -| `type` | `type` | No | No | <> -| `home_standard` | N/A | No | No | <> - -| `series` | `series[type='main' or !type or exists]` | No | Yes | <> -| `labels` | N/A` | No | No | <> -|=== - - -NOTE: The table indicates the source of the field values using the -https://github.com/lutaml/lutaml-path[LutaML Instance Path syntax] as applied to -the Relaton BibliographicItem object. - -NOTE: The "Host" column indicates if the field content may come from the "host -item". In citing an information resource located within a host item, it is -common to render elements from the host item in addition to elements from the item itself. Hence a -number of fields can be populated either by the bibliographic item itself, or by -the host item containing it. For example, in a paper included in an edited -volume, the `edition` field will be given for the edited volume, rather than for -the paper. - -NOTE: The "host item" is located at path `relation[type='includedIn'].bibitem`. - - -[[field-title]] -===== Title field - -Value type:: String. - -Description:: The primary title of the bibliographic item. -If multiple titles exist, prioritizes titles matching the document language, -and the `main` title type as opposed to other title types. - -[[field-edition]] -===== Edition field - -Value type:: Numeric or String. - -Description:: -The edition number or text. -+ -If a numeric value is provided in the Relaton object, the value is the -internationalized rendering of ordinal `"nth edition"`, as set in -`edition_numbering`. (e.g., "2nd edition"). -+ -Otherwise, the raw textual content is given. - - -[[field-edition_raw]] -===== Edition raw field - -Value type:: String. - -Description:: -The raw edition text. - - -[[field-edition_num]] -===== Edition number field - -Value type:: Numeric. - -Description:: -The edition number. - - -[[field-medium]] -===== Medium field - -Value type:: String. - -Description:: -The medium or format of the item. - -[[field-place-raw]] -===== Place raw field - -Value type:: Array of string. - -Description:: -Array of components of a place of publication. -So if the source record differentiates city, region, and country of publication, -the raw place is an array of those strings. - -[[field-place]] -===== Place field - -Value type:: String. - -Description:: -The place of publication. if the raw place is an array of place components, -these are concatenated in a format appropriate to the language, by default using commas. - -[[field-publisher]] -===== Publisher field - -Value type:: String. - -Description:: -The name of the publishing organization. - -[[field-distributor]] -===== Distributor field - -Value type:: String. - -Description:: -The name of the distributing organization. - -[[field-authorizer]] -===== Authorizer field - -Value type:: String. - -Description:: -The authorizing organization, falling back to publisher if no explicit authorizer exists. - -[[field-authoritative-identifier]] -===== Authoritative identifier field - -Value type:: String. - -Description:: -Primary document identifiers excluding Metanorma, ordinal, ISBN, ISSN, DOI, URN, and iso-reference types. - -[[field-other-identifier]] -===== Other identifier field - -Value type:: String[]. - -Description:: -Secondary identifiers including ISBN, ISSN and DOI. By default prefixed with type and colon. - - -[[field-doi]] -===== DOI field - -Value type:: String[]. - -Description:: -The DOI identifier without the `doi:` prefix. - -[[field-status-raw]] -===== Status raw field - -Value type:: String. - -Description:: -The status or stage of the document, as encoded in Relaton. - -[[field-status]] -===== Status field - -Value type:: String. - -Description:: -The status or stage of the document. Rendering varies by document type. -+ -NOTE: In Metanorma, the "status" field is typically rendered differently for -different flavors, and is subject to internationalisation (so it can be translated -to different languages). - - -[[field-uri]] -===== URI field - -Value type:: String. - -Description:: -Citation or source URI, excluding DOI (as a DOI is rarely the source of a resource). -+ -Prioritizes language match if multiple URIs exist. - -[[field-access-location]] -===== Access location field - -Value type:: String. - -Description:: -Physical or electronic location where the item can be accessed. - -[[field-extent]] -===== Extent field - -Value type:: String. - -Description:: -The extent of the item (e.g., pages, volumes). Renders with standard abbreviations, as -formatted according to the <> template. -+ -NOTE: This encompasses `pp`, `vols`, `-` (en-dash ranges), and supports multiple locations. - -[[field-creatornames]] -===== Creator names field - -Value type:: String. - -Description:: -Creator names formatted according to the <> template. -+ -Includes authors, performers, adapters, translators, editors, distributors and authorizers. - - -[[field-authorcite]] -===== Author citation field - -Value type:: String. - -Description:: -Creator names formatted according to the <> template for author-date citations. - -[[field-role]] -===== Role field - -Value type:: String. - -Description:: -The role description or type of the contributors. By default, this is not populated for -`author` (which is assumed as a role), only for `editor`, `translator`, etc. - -[[field-date]] -===== Date field - -Value type:: String. - -Description:: -The publication or circulation date. By default truncated to year only. - -[[field-disambiguated-date]] -===== Disambiguated date field - -Value type:: String. - -Description:: -The publication or circulation date, with a disambiguating letter added to it in case two or more references -have the same author(s). This is the date value used for author-date citations; it is also used in the bibliographic -entries of any resources that we know will be cited as author-date. - -It is common for SDOs to cite standards and technical notes by document identifier, but monographs and articles -by author date. In that case, the bibliography template should use `{{ date }}` for the latter, and `{{ disambiguated_date }}` -for the former: it would be confusing for a standard to be dated in the bibliography as "1973a", when it will never be cited -by author-date. If no bibliographic types will be cited in the SDO by author-date, then `{{ disambiguated_date }}` will -not be used in the templates. - -[[field-date-updated]] -===== Date updated field - -Value type:: String. - -Description:: -The date the item was last updated. - -[[field-date-accessed]] -===== Date accessed field - -Value type:: String. - -Description:: -The date the item was accessed. Not added by default if not explicitly supplied. - - -[[field-host_creatornames]] -===== Host item creator names - -Value type:: String. - -Description:: -Creator names of the "host item" of the bibliographic item. -+ -Format follows that of "creatornames" (<>). - - -[[field-host_title]] -===== Host item creator names - -Value type:: String. - -Description:: -Title of the "host item" of the bibliographic item. -+ -Format follows that of "title" (<>). - -[[field-host_role]] -===== Host item role - -Value type:: String. - -Description:: -Role of the "host item" of the bibliographic item. -+ -Format follows that of "role" (<>). - - -[[field-type]] -===== Type - -Value type:: String. - -Description:: -Type of the bibliographic item. - - -[[field-home_standard]] -===== Home standard indicator - -Value type:: Boolean. - -Description:: -Indicates whether the document represented by the current bibliographic item -is considered a "home standard" in the document that is citing it. -+ -A "home standard" is a document that is published by the same organization or a -closely affiliated organization that is publishing the document containing it. -Citations of such standards are typically much more succinct than for other -standards, because of assumed knowledge; they are often limited to authoritative -identifier and title. -+ -NOTE: This field is only relevant for usage of Relaton Render inside Metanorma. -+ -NOTE: In some standards bodies, citations of standards from the same -organization or affiliates may omit the publisher's identifier prefix in -publication identifiers. For example, when cited in a NIST document, documents -with a full publication identifier of "NIST SP 800-53r5" or "NIST FIPS 100" will -be cited as "SP 800-53r5" and "FIPS 100" respectively. - - - -[[field-series]] -===== Series field - -Value type:: String. - -Description:: -Series information formatted according to the <> or <> -(depending on whether the bibliographic item is a journal article or journal, -or a different bibliographic type).. - - -==== Information resource types - -Each type of information resource has a corresponding template that defines how -the citation is formatted. There is one template provided for each of the -bibliographic types recognised by Relaton (`bibitem.type`), and a default -template. - -The default `misc` template is used when no specific template is provided for a -particular type. It is mandatory to provide a `misc` template. - -Relaton Render is developed to support the ISO 690 citation system, which -defines a set of information resource types and a language for creating citation -styles. - -Relaton Render supports most information resource types defined by ISO 690, -though not all. - -.Information resource types supported by Relaton Render -[cols="2,1,1,1",options="header"] -|=== -|Information resource type |Code |ISO 690 support |Relaton Render support - -|Article |`article` |Yes |Yes -|Book |`book` |Yes |Yes -|Booklet |`booklet` |Yes |Yes -|Manual |`manual` |Yes |Yes -|Proceedings |`proceedings` |Yes |Yes -|Presentation |`presentation` |Yes |Yes -|Thesis |`thesis` |Yes |Yes -|Technical report |`techreport` |Yes |Yes -|Standard |`standard` |Yes |Yes -|Unpublished work |`unpublished` |Yes |Yes -|Electronic resource |`electronic_resource` |Yes |Yes -|Book part |`inbook` |Yes |Yes -|Collection part |`incollection` |Yes |Yes -|Proceedings part |`inproceedings` |Yes |Yes -|Journal |`journal` |Yes |Yes -|Website |`website` |Yes |Yes -|Web resource |`webresource` |Yes |Yes -|Dataset |`dataset` |Yes |Yes -|Miscellaneous |`misc` |Yes |Yes -|Map |`map` |Yes |No -|Audiovisual |`audiovisual` |Yes |No -|Film |`film` |Yes |No -|Video |`video` |Yes |No -|Broadcast |`broadcast` |Yes |No -|Software |`software` |Yes |No -|Graphic work |`graphic_work` |Yes |No -|Music |`music` |Yes |No -|Performance |`performance` |Yes |No -|Patent |`patent` |Yes |No -|Archival material |`archival` |Yes |No -|Social media |`social_media` |Yes |No -|Alert |`alert` |Yes |No -|Message |`message` |Yes |No -|Conversation |`conversation` |Yes |No -|Collection |`collection` |Yes |No - -|=== - -NOTE: In the Metanorma usage of Relaton Render, not all information resource -types are used, but there are exemplars for all of these given on this site, -following the human-readable style used in ISO 690. These can be overridden by -supplying corresponding paramerers in the call to initialize `Relaton::Render`. - - -=== General - -The main templates for different types of bibliographic items, defining the complete citation format. - -Example: -[source,yaml] ----- -template: - book: "{{ creatornames }} ({{role}}) $$$ {{labels['punct']['open-title']}}{{ title }}{{labels['punct']['close-title']}} [{{medium}}] $$$ {{ edition | capitalize_first }}" - article: "{{ creatornames }} ({{role}}) $$$ {{labels['punct']['open-secondary-title']}}{{ title }}{{labels['punct']['close-secondary-title']}}$$$ {{ series }} [{{medium}}]$$$ {{ extent }} ----- - - -=== Composite information resource templates - -[[seriestemplate]] -=== Series template (`seriestemplate`) - -==== General - -A series is a monograph series, a collection of information resources published -in a sequence under the same title. Series information is commonly included in -bibliographic references to both provide context and allow location of the item -being cited. - -The `seriestemplate` defines how series information is formatted in -bibliographic references, including series titles, abbreviations and numbering. - -Syntax: - -[source,yaml] ----- -seriestemplate: >- - ... ----- - -.Sample template for a series citation style -[example] -==== -[source,yaml] ----- -seriestemplate: >- - {% if series_formatted %} - {{ series_formatted }} - {% else %} - {% if series_abbr %} - {{ series_abbr }} - {% else %} - {{ series_title }} - {% endif %} - ({{ series_run }}) - {{ series_num }}|({{ series_partnumber }}) - {% endif %} ----- -==== - -[[seriestemplate-fields]] -==== Fields - -The following fields are available for use in the `seriestemplate` (and -`journaltemplate`). - -[cols="1,1,1,1,1",options="header"] -|=== -| Field | Model path | Multiple | Host | See section - -| `series_title` -| `series[type='main' or !type or exists].title` -| No -| Yes -| <> - -| `series_abbr` -| `series[type='main' or !type or exists].abbreviation` -| No -| Yes -| <> - -| `series_num` -| `series[type='main' or !type or exists].number` -| No -| Yes -| <> - -| `series_partnumber` -| `series[type='main' or !type or exists].partnumber` -| No -| Yes -| <> - -| `series_run` -| `series[type='main' or !type or exists].run` -| No -| Yes -| <> - -| `series_place` -| `series[type='main' or !type or exists].place` -| No -| Yes -| <> - -| `series_organization` -| `series[type='main' or !type or exists].organization` -| No -| Yes -| <> - -| `series_dates` -| `series[type='main' or !type or exists].from` `series[type='main' or !type or exists].to` -| No -| Yes -| <> - -|=== - -The following fields are available for use in the `seriestemplate`: - -[[field-series-title]] -===== Series title - -Field:: `series_title` -Description:: Full title of the series -Model path:: `series[type='main' or !type or exists].title` -Value type:: String - -[example] -==== -`"Studies in Post-Modernism"` -==== - -[[field-series-abbr]] -===== Series abbreviation - -Field:: `series_abbr` -Description:: Abbreviated series title -Model path:: `series[type='main' or !type or exists].abbreviation` -Value type:: String - -[example] -==== -`"SPM"` -==== - -[[field-series-num]] -===== Series number - -Field:: `series_num` -Description:: Series number or volume -Model path:: `series[type='main' or !type or exists].number` -Value type:: String - -[example] -==== -`"30"` -==== - -[[field-series-partnumber]] -===== Series part number - -Field:: `series_partnumber` -Description:: Part or issue number within the series -Model path:: `series[type='main' or !type or exists].partnumber` -Value type:: String - -[example] -==== -`"4"` -==== - -[[field-series-run]] -===== Series run - -Field:: `series_run` -Description:: Series run indicator (e.g. "3rd series") -Model path:: `series[type='main' or !type or exists].run` -Value type:: String - -[example] -==== -`"3rd series"` -==== - -[[field-series-place]] -===== Series place - -Field:: `series_place` -Description:: Place of publication for series -Model path:: `series[type='main' or !type or exists].place` -Value type:: String - -[example] -==== -`"London"` -==== - -[[field-series-organization]] -===== Series organization - -Field:: `series_organization` -Description:: Organization responsible for series -Model path:: `series[type='main' or !type or exists].organization` -Value type:: String - -[example] -==== -`"Institute of Modern Studies"` -==== - -[[field-series-dates]] -===== Series dates - -Field:: `series_dates` -Description:: Start and end dates of series run -Model path:: `series[type='main' or !type or exists].from` `series[type='main' or !type or exists].to` -Value type:: String - -[example] -==== -`"2010-2020"` -==== - - -=== Journal template (`journaltemplate`) - -==== General - -The `journaltemplate` defines how journal series information like volume and -issue numbers is formatted in a bibliographic style. - -Syntax: - -[source,yaml] ----- -seriestemplate: >- - ... ----- - -.Sample template for a journal citation style -[example] -==== -[source,yaml] ----- -journaltemplate: >- - - {%- if series_abbr -%} - {{ series_abbr }} - {%- else -%} - {{ series_title }} - {%- endif -%} - - ({{ series_run }}) - {{ labels['volume'] }}_{{ series_num }} - {{ labels['part'] }}_{{ series_partnumber }} ----- - -Renders as: -____ -_Journal Title_ (Series Run) Vol. 123 Part 4 -____ -==== - - -The template uses the same fields as `seriestemplate` but requires special -handling of formatting, particularly italicization of journal titles. - -While similar to `seriestemplate`, journals are typically formatted differently -from monograph series due to established citation conventions. - - -.Common bibliographic rendering of a journal that omits explicit labels -[example] -==== -[source,liquid] ----- - - {%- if series_abbr -%} - {{ series_abbr }} - {%- else -%} - {{ series_title }} - {%- endif -%} - -{{ series_num }}|({{ series_partnumber }}) ----- - -Renders as: -____ -_J. Am. Chem. Soc._ 103(1) -____ -==== - - -.ISO 690 rendering of a journal that provides explicit labels for volume and part -[example] -==== -The recommended practice in ISO 690:2021 is to give explicit volume labels. - -[source,liquid] ----- - - {%- if series_abbr -%} - {{ series_abbr }} - {%- else -%} - {{ series_title }} - {%- endif -%} - -{{ labels['volume'] }}_{{series_num}} -{{ labels['part'] }}_{{series_partnumber}} ----- - -Renders as: -____ -_J. Am. Chem. Soc._ Vol. 103 Part 1 -____ -==== - - -==== Fields - -The template uses the same fields as <>. -Please refer to that section for details on the fields available for use in the -`journaltemplate`. - - -=== Citation templates (`citetemplate`) - -==== General - -Different bibliographic styles have different ways of referencing a document from the -bibliography. Relaton Render provides a set of citations for each defined citation style, -to meet this requirement. - -The different citation types defined by default for Relaton Render are listed below. - -==== Author-date citations - -Author-date citations use the combination of author surname(s) (as processed in <>) -and date (year) of publication, to identify a reference. - -Two or more citations that are ambiguous because -they have the same author and date (year) are disambiguated by appending a letter to the year. -The citation templates include this disambiguating letter on the year where applicable. -In order to ensure that the disambiguating letter is included, use the field -`disambiguated_date` instead of the original `date` field. - -Author-date citations are often used parenthetically and discursively; the following are all -legal ways of providing an author-date citation: - -==== -This claim is ludicrous (Smith 1980a). - -Smith (1980a) makes a ludicrous claim. - -Smith unfortunately made a ludicrous claim (1980a). - -See Smith (1980a, 1980b). -==== - -The following variants of author-date citation styling are currently supported by Relaton Render: - -`author_date`:: author then date, with no punctuation -`author_date_br`:: author, followed by date in parentheses -`author`:: author in isolation -`date`:: date in isolation - -These are by default encoded as: - -[soruce,asciidoc] ----- -citetemplate: - author_date: "{{ author }} {{ disambiguated_date}}" - author_date_br: "{{ author }} ({{ disambiguated_date}})" - author: "{{ author }}" - date: "{{ disambiguated_date }}" ----- - -In Metanorma, the foregoing example would be encoded as follows: - -[source,asciidoc] ----- -This claim is ludicrous (<>). - -<> makes a ludicrous claim. - -<> unfortunately made a ludicrous claim <>. - -See Smith (<>, <>). ----- - -Some citation styles have conventions to combine multiple author-date citations -(e.g. "Smith 1980a" + "Smith 1980b" + "Smith 1990" + "Jones 1991" can be rendered as -"(Smith 1980a, 1980b, 1990; Jones 1991)". Neither Metanorma nor Relaton Render does not -currently support such combinations, and if it is supported in the future, it will likely be -the responsibility of Metanorma, as a document renderer. - -[[reference-tag]] -==== Identifier citations - -The norm for standards (which are the primary type of resource cited in Metanorma, for which -Relaton Render has been developed) is the document identifier. Different standards organisations -have different conventions for rendering the document identifier, including the option of switching -instead to an ordinal number of reference. - -In order to support this kind of referencing, the `reference_tag` style presents the reference tag -of the resource: these are the contents of the -`biblio-tag` element of Relaton, which is the initial identifier given in a bibliography; this -could be a document identifier (e.g. `ISO 643`), an ordinal number (e.g. `[33]`), or a mnemonic -identifier (e.g. `[Relatn]`). - -==== Title citations - -`title`:: Title of resource (rendered the same way as in the full citation record: <>) -`title_reference_tag`:: Title of resource, followed by the reference tag of the source (<>) - -==== Full citation - -The `full` citation format replicates the full bibliographic record citation (as generated by -`template`). However, whereas the bibliographic record citation can conclude in a bibliographic terminator -(<>), such as a period, the full citation is used inside of running text, and does not. - -==== Short citation - -The `short` citation format is a truncated version of the full citation, intended expressly for use -in running text. In contemporary practice, this is restricted to the humanities, particulary in footnoted -citations; but there is some use of it in ISO standards (for sources of terms). - -The short citation format template is defined like the full citation template, with a different template -for each bibliographic type. - -[example] -.Short citation vs full citation -==== -[source,yaml] ----- -citetemplate: - short: - book: "{{ creatornames }} ({{role}}) $$$ {{labels['punct']['open-title']}}{{ title }}{{labels['punct']['close-title']}} $$$ {{ edition | capitalize_first }}$$$ ({{ series }}$$$|) {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%}: {{publisher}}$$$ {{date}}$$$" -template: - book: "{{ creatornames }} ({{role}}) $$$ {{labels['punct']['open-title']}}{{ title }}{{labels['punct']['close-title']}} [{{medium}}] $$$ {{ edition | capitalize_first }}$$$ ({{ series }}$$$|) {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%}: {{publisher}}$$$ {{date}}$$$ {{ labels['updated'] | capitalize }}:_{{date_updated}}$$$ {{ authoritative_identifier | join: '$$$ ' }}$$$ {{ other_identifier | join: '$$$ ' }}$$$ {{size}}$$$" ----- -==== - -[[liquid]] -== Working with Liquid in Relaton Render templates - -=== General - -The Liquid templating language (https://shopify.github.io/liquid/[]) is extensively used -in Metanorma, and is the templating language used by Relaton Render to generate citation strings -based on parsed Relaton fields. There has been some enhancement of Liquid templating rules -to meet Relaton Render requirements. - -=== Liquid filters - -==== General - -The Relaton Render Liquid templates allows usage of common filters defined in -Liquid, including `upcase`. - -In the Relaton Render templates context, the following additional filters are -also available. - -==== Capitalize first (`capitalize_first`) - -`capitalize_first` capitalises only the first word in a string, and does not -lowercase other words in the string. If any of the text in a string contains XML -tags (including ``, which instructs internationalisation to ignore the current -span, as well as Metanorma XML formatting directives like `` for italics), -the filter ignores those tags. - -[example] -==== -`{{ "third edition" | capitalize_first }}` becomes "Third edition", but -`{{ "3. Aufl." | capitalize_first }}` does not become "3. aufl." -==== - -==== Selective Upcase (`selective_upcase`) - -Capitalise any content in the string not surrounded by `+++`. This is to ensure -that creator names are capitalised without also capitalising any connectives like -"and" or "et al." Again, any XML tags in the string are ignored. - -[example] -==== -`{{ "Black and Decker" | selective_upcase }}` becomes "BLACK AND DECKER", -but `{{ "Black +++and+++ Decker" | selective_upcase }}` becomes -"BLACK and DECKER" -==== - -==== Selective Tag (`selective_tag`) - -Tag any content in the string not surrounded by `+++` with the supplied tag -(assuming a single tag). This is to ensure -that creator names are marked up (smallcaps, italics, etc), without also capitalising -any connectives like "and" or "et al." - -[example] -==== -`{{ "Black and Decker" | selective_tag: "" }}` becomes `Black and Decker`, -but `{{ "Black +++and+++ Decker" | selective_tag: "" }}` becomes -`Black and Decker` -==== - -=== Template processing rules - -==== General - -Relaton Render uses additional template processing rules that are addition to -normal Liquid syntax in order to facilitate bibliographic rendering. - -A Relaton Render template is a string that contains: - -* plain text, which is rendered as is; -* content fields, which are rendered using corresponding values from the Relaton -bibliographic object. - - -==== Plain text - -Plain text, including textual characters and punctuation, is rendered as is. - -Plain text is is space-delimited, it is inserted regardless of preceding -content. - - -==== Content fields - -===== General - -A content field is defined as a string that contains a single Liquid rendering -expression (`{{ }}`), flanked by characters, but without any white space -characters in text (unless explicitly indicated). - -White space characters within Liquid syntax are excluded from delimitation rules. -i.e. space within Liquid delimiters, such as `{% %}` and `{{ }}`, is ignored. - -[example] -==== -`Vol.` is not a content field. - -`Vol. {{ volume }}` is treated as a single content field. -==== - -Within a template, content fields are delimited by white space characters. -This is important for applying rules around deleting empty content fields (<>). - -[example] -==== -`{{ title }} [{{medium}}]` is treated as two separate content fields. -==== - -When multiple content fields are rendered, they are joined by a single white -space character. - -[example] -==== -`{{ title }} [{{medium}}]` renders as for instance, "Title [Book]". -==== - -[example] -==== -In the expression `({{date}}) .`, the full stop is rendered regardless of -whether or not the `date` is present. - -On the other hand, in the expression of `{{date}}.`, if `date` is empty, the -full stop will not be rendered (<>). -==== - -Space characters between punctuation and before punctuation is automatically -removed. - -[example] -==== -The expression `({{date}}) .` can be rendered as "(2021)." -==== - -Space characters within fields are globally converted to underscores. For that -reason, any filter operations in Liquid need to refer to underscore instead of -space. - -[example] -==== -[source,liquid] ----- -{{ creatornames }} ({{date}}) . {{ title }} [{{medium}}] ,_{{ edition }}_{{ labels['edition'] }} . ----- - -Can be rendered as: - -* "Smith, J. A. (2021). _Studies in Biology_ 1st ed." -==== - - - -===== Attaching content with white spaces to a content field - -To attach content with white space to a content field, use an underscore (`_`). -An underscore is treated as space, attaching any immediately congruent text -to the preceding or following Liquid expression. - -[example] -==== -The expression `,_{{ edition }}_{{ labels['edition'] }}` is treated as a single -content field. - -An example rendering of the content field could be: "1st ed." -==== - -To render the underscore character itself, it must be escaped by a backslash (`\`). - -[example] -==== -The content field expression of `` will lead to a -rendering of ``. -==== - - -===== Joining content fields without spaces - -By default, content fields are joined by a single white space character. - -To join content fields without spaces, use the `|` character between -the content fields. - -[example] -==== -`{{ title }}{{ medium }}` are two content fields that will be rendered with no -space separation. -==== - -[[empty-fields-omitted] -===== Empty content fields are omitted - -If the Liquid rendering expression in a content field gives an empty result, the -content field is considered "empty" and the whole content field is omitted from -the rendered output. - -This means that the surrounding text and punctuation in the content field -(text characters adjacent to the empty Liquid expression) are also omitted. -This allows not only fields, but punctuation and text associated with a field, -to be treated as optional. - -[example] -==== -The `[{{medium}}]` content field contains a Liquid expression -`{{medium}}` and enclosing square brackets. If the value of `medium` is empty, -both the brackets and the Liquid expression will not be rendered. -==== - -[example] -==== -In the expression `,_{{ edition }}_{{ labels['edition'] }}`, if `edition` is -missing, the entire content field is not rendered. - -This means that not only the internal Liquid expression not being rendered, but -the preceding "comma, space" is omitted as well as the following edition label. -i.e. it renders "1st ed.", but will not render " ed.". -==== - -[[field-labels]] -== Localization labels from internationlization files - -Relaton Render accepts a set of language-specific labels for -internationalization of commonly used word labels in citation formats. - -These labels are defined in the internationalization files passed to the initialisation -of Relaton Render, and exposed to the -rendering template context inside the `labels` field as a map -to support the implementation of localized citation formats. - -[example] -==== -The text labels of "edition", "In", "At", "Vol", are commonly used in citation -formats in different languages. -==== - -Value type: map. - -Relaton Render can be configured to use more than one internationalization file; -the choice of internationalization configuration to apply to a citation -can be set in code, and can extend to a specific template or field. - - -The following keys are given in the respective languages. - -[example] -==== -[source,yaml] ----- -in: in -at: at -and: and -author_and: and -updated: updated -viewed: viewed -version: version -also_pub_as: "Also published as: " -no_date: n.d. -no_place: n.p. -date_formats: - month_year: yMMMM - day_month_year: to_long_s - date_time: to_long_s -ordinal_keys: [] -OrdinalRules: digits-ordinal -edition: edition -edition_ordinal: "{{ var1 | ordinal_num: '', '' }} edition" -draft: "draft %" -editor: - sg: ed. - pl: eds. -punct: - open-title: - close-title: - open-secondary-title: - close-secondary-title: -stage: - valid: Valid - withdrawn: Withdrawn -extent: - page: - sg: "p. %" - pl: "pp. %" - volume: - sg: "vol. %" - pl: "vols. %" - issue: - sg: "no. %" - pl: "nos. %" -size: - page: - sg: "% p." - pl: "% pp." - volume: - sg: "% vol." - pl: "% vols." - issue: - sg: "% no." - pl: "% nos." ----- -==== - -=== Fields - -==== Document localization labels (`in`, `at`) - -`in`:: Used for showing containment relationships in series and journal references. -+ -[example] -==== -[source,yaml] ----- -in: in ----- -==== -+ -[example] -==== -[source,liquid] ----- -{{ labels['in'] | capitalize }}: {{ host_creatornames }} {{ labels['qq-open'] }}{{host_title}}{{ labels['qq-close'] }} ----- - -Renders as: - -* "In: Smith, J. A. _Studies in Biology_" -==== - -`at`:: Used to indicate location of an information resource, whether physical or electronic. -+ -[example] -==== -[source,yaml] ----- -at: at ----- -==== -+ -[example] -==== -[source,liquid] ----- -{{ labels['at'] | capitalize }}:_{{ access_location }} ----- - -Renders as: - -* "At: https://example.com" -* "At: Harvard Archives" -==== - -==== Conjunction labels (`and`, `author_and`) - -`and`:: Used to join multiple localities or elements in a citation. -+ -[example] -==== -[source,yaml] ----- -and: and ----- -==== -+ -[example] -==== -[source,liquid] ----- -{{ page }} {{ labels['and'] }} {{ volume }} ----- - -Renders as: - -* "pp. 23-45 and Vol. 2" -==== - -`author_and`:: Used specifically for joining author names in the contributors list. -+ -[example] -==== -[source,yaml] ----- -author_and: and ----- -==== -+ -[example] -==== -[source,liquid] ----- -{{ surname[0] }}, {{ given[0] }} {{ labels['author_and'] }} {{ surname[1] }}, {{ given[1] }} ----- - -Renders as: - -* "Smith, John and Jones, Mary" -==== - -==== Date labels (`updated`, `viewed`, `no_date`) - -`updated`:: Indicates when an information resource was last updated. -+ -[example] -==== -[source,yaml] ----- -updated: updated ----- -==== -+ -[example] -==== -[source,liquid] ----- -{{ labels['updated'] | capitalize }}:_{{ date_updated }} ----- - -Renders as: - -* "Updated: 2023-06-01" -==== - -`viewed`:: Shows when an online resource was last accessed. -+ -[example] -==== -[source,yaml] ----- -viewed: viewed ----- -==== -+ -[example] -==== -[source,liquid] ----- -[{{ labels['viewed'] }}:_{{ date_accessed }}] ----- - -Renders as: - -* "[Viewed: 2023-07-15]" -==== - -`no_date`:: Used when no date is available. -+ -[example] -==== -[source,yaml] ----- -no_date: n.d. ----- -==== -+ -[example] -==== -[source,liquid] ----- -{% if date %}{{ date }}{% else %}{{ labels['no_date'] }}{% endif %} ----- - -Renders as: - -* "[n.d.]" -==== - -==== Location labels (`no_place`) - -`no_place`:: Used when no place of publication is available. - -[example] -==== -[source,yaml] ----- -no_place: n.p. ----- -==== - -[example] -==== -[source,liquid] ----- -{% if place %}{{ place }}{% else %}{{ labels['no_place'] }}{% endif %} ----- - -Renders as: - -* "[n.p.]" -==== - -==== Version labels (`version`) - -`version`:: Used for indicating version numbers, particularly in software citations. - -[example] -==== -[source,yaml] ----- -version: version ----- -==== - -[example] -==== -[source,liquid] ----- -{{ labels['version'] | capitalize }}_{{ edition_raw }} ----- - -Renders as: - -* "Version 2.1" -==== - -==== Publication labels (`also_pub_as`) - -`also_pub_as`:: Used to indicate alternative publications of the same work. - -[example] -==== -[source,yaml] ----- -also_pub_as: "Also published as: " ----- -==== - -[example] -==== -[source,liquid] ----- -{{ labels['also_pub_as'] }}{{ host_title }} ----- - -Renders as: - -* "Also published as: Conference proceedings" -==== - -==== Editorial labels (`editor`, `edition`) - -`editor`:: Provides singular and plural forms for editor attribution. -+ --- -The following sub-keys are supported: - -`sg`:: Singular form of editor label (e.g., "ed.") -`pl`:: Plural form of editor label (e.g., "eds.") --- -+ -[example] -==== -[source,yaml] ----- -editor: - sg: ed. - pl: eds. ----- -==== -+ -[example] -==== -[source,liquid] ----- -{% if contributors.size == 1 %} - {{ surname[0] }}, {{ given[0] }} ({{ labels['editor'].sg }}) -{% else %} - {{ surname[0] }}, {{ given[0] }} {{ labels['author_and'] }} {{ surname[1] }}, {{ given[1] }} ({{ labels['editor'].pl }}) -{% endif %} ----- - -Renders as: - -* "Smith, J. (ed.)" -* "Smith, J. and Jones, M. (eds.)" -==== - -`edition`:: Used for edition statements. -+ -[example] -==== -[source,yaml] ----- -edition: edition ----- -==== -+ -[example] -==== -[source,liquid] ----- -{{ labels['edition'] | upcase }} {{ edition_num }} ----- - -Renders as: - -* "Edition 2" -==== - -`edition_ordinal`:: Used in code for ordinal edition statements, in order to define how -`edition` is rendered. -+ -[example] -==== -[source,yaml] ----- -edition_ordinal: "{{ var1 | ordinal_num: '', '' }} edition" ----- - -This is defined with inflection categories in the `isodoc-i18n` gem (gender and case); -these are not applicable in English, hence `'', ''`. -==== - -`edition_cardinal`:: Used in code for cardinal edition statements, in order to define how -`edition` is rendered.. -+ -[example] -==== -[source,yaml] ----- -"Edition {{ var1 }}" ----- -==== - -==== Draft label (`draft`) - -`draft`:: Used for draft version statements. - -[example] -==== -[source,yaml] ----- -draft: "draft %" ----- -==== - -[example] -==== -[source,liquid] ----- -{{ labels['draft'] | replace: '%', '3' }} ----- - -Renders as: - -* "draft 3" -==== - -==== Status labels (`stage`) - -`stage`:: Provides status indicators for documents. -The sub-keys of this indcator are specific to how SDOs define status indicators, -and are specific to the host organisation's stylesheet; they typically include -values such as `valid`, `published`, `draft`, and `withdrawn`. - -[example] -==== -[source,yaml] ----- -stage: - valid: Valid - withdrawn: Withdrawn ----- -==== - -[example] -==== -[source,liquid] ----- -Status: {{ labels['stage'].valid }} -Status: {{ labels['stage'].withdrawn }} ----- - -Renders as: - -* "Status: Valid" -* "Status: Withdrawn" -==== - -==== Extent and size labels (`extent`, `size`) - -`extent`:: Provides formatted labels for extent indicators. -The following sub-keys are supported: - -`page`::: -`sg`:::: Format for single page (e.g., "p. %") -`pl`:::: Format for multiple pages (e.g., "pp. %") - -`volume`::: -`sg`:::: Format for single volume (e.g., "vol. %") -`pl`:::: Format for multiple volumes (e.g., "vols. %") - -`issue`::: -`sg`:::: Format for single issue (e.g., "no. %") -`pl`:::: Format for multiple issues (e.g., "nos. %") - -[example] -==== -[source,yaml] ----- -extent: - page: - sg: "p. %" - pl: "pp. %" - volume: - sg: "vol. %" - pl: "vols. %" - issue: - sg: "no. %" - pl: "nos. %" ----- -==== - -[example] -==== -[source,liquid] ----- -{% assign pg = labels['extent'].page %} -{% if page_raw contains '-' %}{{ pg.pl | replace: '%', page_raw }}{% else %}{{ pg.sg | replace: '%', page_raw }}{% endif %} ----- - -Renders as: - -* "p. 45" -* "pp. 23-45" -* "vol. 3" -==== - -NOTE: Explicit templating rules such as the foregoing are not usually necessary, as Relaton Render code -determines whether to apply the singular or the plural suffix to `page_raw`, generating the formatted field `page` within `extent`. -So the foregoing is equivalent to the page component of `extent`, as processed by `extenttemplate`. - -`size`:: Provides formatted labels for size indicators. -The following sub-keys are supported: - -`page`::: -`sg`:::: Format for single page (e.g., "% p.") -`pl`:::: Format for multiple pages (e.g., "% pp.") - -`volume`::: -`sg`:::: Format for single volume (e.g., "% vol.") -`pl`:::: Format for multiple volumes (e.g., "% vols.") - -`issue`::: -`sg`:::: Format for single issue (e.g., "% no.") -`pl`:::: Format for multiple issues (e.g., "% nos.") - -[example] -==== -[source,yaml] ----- -size: - page: - sg: "% p." - pl: "% pp." - volume: - sg: "% vol." - pl: "% vols." - issue: - sg: "% no." - pl: "% nos." ----- -==== - -[example] -==== -[source,liquid] ----- -{% assign pg = labels['size'].page %} -{% if page contains '-' or page > 1 %}{{ page }}{{ pg.pl }}{% else %}{{ page }}{{ pg.sg }}{% endif %} ----- - -Renders as: - -* "234 pp." -* "2 vols." -==== - - -NOTE: Explicit templating rules such as the foregoing are not usually necessary, as Relaton Render code -determines whether to apply the singular or the plural suffix to `page_raw`, generating the formatted field `page` within `size`. -So the foregoing is equivalent to the page component of `size`, as processed by `sizetemplate`. - -==== Punctuation - -Puncutation marks are defined in the `isodoc` gem for the various languages supported by Metanorma. -They can be invoked through `labels["punct"][...]` in templates. They are also used to transform -instances of punctuation in a template to the target language indicated for the document (or citation); -the content of Relaton fields inserted into the templates is almost always excluded from such transformation. - -.Punctuation for English -==== -[source,yaml] ----- -punct: - colon: ":" - comma: "," - enum-comma: "," - semicolon: ";" - period: "." - close-paren: ")" - open-paren: "(" - close-bracket: "]" - open-bracket: "[" - question-mark: "?" - exclamation-mark: "!" - emphasis-mark: "" - em-dash: — - en-dash: – - number-en-dash: – - open-quote: '“' - close-quote: '”' - open-nested-quote: '‘' - close-nested-quote: '’' - ellipse: … ----- -==== - -.Punctuation for Simplified Chinese -==== -[source,yaml] ----- -punct: - colon: ":" - comma: "," - enum-comma: "、" - semicolon: ";" - period: "。" - close-paren: ")" - open-paren: "(" - close-bracket: "]" - open-bracket: "[" - question-mark: "?" - exclamation-mark: "!" - emphasis-mark: • - em-dash: ⸺ - en-dash: "–" - number-en-dash: "〜" - open-quote: "“" - close-quote: "”" - open-nested-quote: "’" - close-nested-quote: "’" - ellipse: ⋯⋯ ----- -==== - -===== Title marks - -Titles of resources can be delimited with punctuation or formatting markup. -This can be configured in the punctuation markup. - -A distinction is made between primary titles (`open-title`, `close-title`), -and secondary titles (e.g. chapters in books, articles in journals: -`open-secondary-title`, `close-secondary-title`). - -.Title marks for English -==== -[source,yaml] ----- -punct: - open-title: - close-title: - open-secondary-title: - close-secondary-title: ----- -==== - -.Title marks for Traditional Chinese -==== -[source,yaml] ----- -punct: - open-title: 《 - close-title: 》 - open-secondary-title: 〈 - close-secondary-title: 〉 ----- -==== - -==== -When invoked with a book chapter template, - -[source,yaml] ----- -template: - inbook: "{{ creatornames }} ({{role}}) $$$ {{labels['punct']['open-secondary-title']}}{{ title }}{{labels['punct']['close-secondary-title']}} $$$ {{ labels['in'] | capitalize }}: {{ host_creatornames}} ({{ host_role}}) : {{labels['punct']['open-title']}}{{host_title}}{{labels['punct']['close-title']}} [{{medium}}] $$$ {{ edition | capitalize_first }}$$$ ({{ series }}$$$|) {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%}: {{publisher}}$$$ {{date}}$$$ {{size}}$$$ {{extent}}$$$ {{ labels['updated'] | capitalize }}:_{{date_updated}}$$$ {{ authoritative_identifier | join: '$$$ ' }}$$$ {{ other_identifier | join: '$$$ ' }}$$$ {{ uri }}$$$ {{ labels['at'] | capitalize}}:_{{ access_location }}$$$ [{{ labels['viewed'] }}:_{{date_accessed}}]$$$" ----- - -these templates will give the chapter title with no markup and the book title in italics for English: - -____ -Smith, J. Introduction. In: Smith, J. (ed.): _Citation practices worldwide_. -____ - -In Traditional Chinese, they will give the chapter title with single guilllemets, and the book title with double guillemets: - -____ -Smith, J. 〈Introduction〉 在: Smith, J. (编): 《Citation practices worldwide》 -____ - -==== - -[cols="2,1,2,2",options="header"] -|=== -|Script name |ISO 15924 code | `qq-open`, `qq-close` | `q-open`, `q-close` - -|Latin |`Latn` |``, `` | _None_ -|Cyrillic |`Cyrl` |``, `` | _None_ -|Traditional Chinese |`Hant` |`《`, `》` |`〈`, `〉` -|Simplified Chinese |`Hans` |`「`, `」` |`『`, `』` -|Japanese |`Jpan` |`「`, `」` |`『`, `』` -|Korean |`Kore` |`“`, `”` |`‘`, `’` - -|=== - -NOTE: The `` formatting in Relaton Render comes from BasicText (Metanorma) -XML tags. - -If these are used, they need not to be space-delimited from what they quote. - -==== - -[[bibliographic-terminator]] -===== Bibliographic terminator - -A bibliographic citation may terminate in sentence-like punctuation according to the bibliographic -style, if the style treats the bibliographic entry like a sentence. This is configured as the punctuation -mark `biblio-terminator`. The terminator if present is used for bibliographic entries, returned under the key -`formattedref`; it is not used for the inline citations given under `citation.full` and `citation.short`. - -.Terminate all bibliographic entries with period -==== -[source,yaml] ----- -punct: - biblio-terminator: . ----- -==== - -.Do not terminate any bibliographic entries with punctuation -==== -[source,yaml] ----- -punct: - biblio-terminator: "" ----- -==== - -NOTE: In the case of the BIPM flavour of Metanorma, whether to use a terminator on a reference -depends on whether it is a home standard or not. - - -[[bibliographic-field-delimiter]] -===== Bibliographic field delimiter - -Groupings of bibliographic fields are typically delimited by punctuation. It is important to ensure -that the delimiter can be customised to a given language's expectation, such as -period (in Latin script practice) or ideographic space (in CJK practice). It is also important to ensure -that a delimiter between fields is not conflated with a bibliographic terminator. - -==== -If the two last fields in a citation are date and URL, and the URL is not provided, the citation -will conclude with the date. A delimiter should appear between date and URL; it should not appear if -the URL is omitted, and the final punctuation to appear in a citation should be determined by -`biblio-terminator` alone. -==== - -For that reason, such groupings of bibliographic fields are indicated by `$$$` in templates, and the value -to substitute those instances of `$$$` with is given in `biblio-field-delimiter`. - -.Default bibliographic field delimiter for Latin script -==== -[source,yaml] ----- -punct: - biblio-terminator: "" - biblio-field-delimiter: ". " ----- - -Given that value, the template - -[source,yaml] ----- -{{ creatornames }} $$$ {{ title }} $$$ {{ date }} $$$ {{ uri }} ----- - -will be rendered as follows, for a citation with no URI: - -____ -Smith, J. Citation practices worldwide. 1990 -____ - -==== - -Note that no final period appears: `biblio-terminator` is empty, `$$$` appears between fields, -and `{{ date }}` is the final non-empty field. - -With the default setting of `biblio-field-delimiter`, space appears automatically after any -punctuation. There are contexts in which such space needs to be suppressed, if punctuation already -appears in the template; this is done by the `|` symbol in the template: - -.Suppress space after bibliographic field delimiter -==== -[source,yaml] ----- -{{ creatornames }} $$$ {{ title }} $$$ ({{ series }}$$$|) {{ date }} ----- - -This allows the series to be followed by a non-spacing field delimiter: - -Smith, J. Citation practices worldwide. (Bibliography 101.) 1990 -==== - - -==== Ordinal labels (`ordinal_keys`, `OrdinalRules`) - -`ordinal_keys`:: A list of keys that are used to determine which inflectional categories -are to be applied to ordinal numbers. - -`OrdinalRules`:: A string that defines the rules for rendering ordinal numbers. - -[example] -.Ordinal labels for Spanish -==== -[source,yaml] ----- -ordinal_keys: [gender] -OrdinalRules: - m: digits-ordinal-masculine - f: digits-ordinal-feminine ----- - -The Spanish configuration indicates that gender is required to generate ordinal numbers -correctly, and that the `digits-ordinal-masculine` rule from https://github.com/twitter/twitter-cldr-rb[Twitter CLDR] -is to be applied to masculine nouns, and `digits-ordinal-feminine` to feminine nouns. This is applied -to editions in turn through the configuration rule - -[source,yaml] ----- -edition_ordinal: "{{ var1 | ordinal_num: 'edition', '' }} ed."` ----- - -i.e. look up the gender of 'edition' in Spanish, as given in - - -[source,yaml] ----- -edition: edición -inflection: - edición: - grammar: - gender: f ----- - -and use it to generate the feminine ordinal number required for `edition`. -All this is configuration for how `edition` is generated in code; the templates themselves -only use `{{ edition }}`. -==== - -[example] -.Ordinal labels for English -==== -[source,yaml] ----- -ordinal_keys: [] -OrdinalRules: digits-ordinal ----- - -As English is not as richly inflected, no ordinal keys need be given; it is sufficent -to give the `OrdinalRules` rule `digits-ordinal`, which generates `1st`, `2nd`, `3rd` etc., -or alternatively `spellout-ordinal`, which generates `first`, `second`, `third` etc. - -==== - -//// - -AGAIN, THIS HAS NOT YET BEEN IMPLEMENTED, AND DOCUMENTATION SHOULD IN NO WISE BE AHEAD -OF IMPLEMENTATION, THAT IS INTENTIONALLY MISLEADING USERS - -[[date-format-labels]] -==== Date format labels (`date_formats`) - -`date_formats`:: A map of date formats used in the citation style. - -Syntax: - -[source,yaml] ----- -date: - default: {format} <1> - month_year: {format} <2> - day_month_year: {format} <3> - date_time: {format} <4> ----- -<1> Default date format -<2> Format for month and year -<3> Format for day, month and year -<4> Format for date and time - -Where: - -`format`:: One of the date format values as listed below. - -`to_full_s`::: Full date format with day, month, and year -`to_long_s`::: Long format with month and year -`to_medium_s`::: Medium format with month and day -`to_short_s`::: Short format with month and day -`{valid-format-string}`::: Custom date format string - -[example] -==== -[source,yaml] ----- -date_formats: - month_year: yMMMM - day_month_year: to_long_s - date_time: to_long_s ----- -==== - -[example] -==== -[source,liquid] ----- -{{ date }} ----- - -This renders the `date` field according to the date format defined in the -`date_formats` map, for instance: - -* "June 2023" -* "June 1, 2023" -* "June 1, 2023 12:00:00" -==== -//// - -[[ formatting ]] -== Formatting - -The default inline formatting language of Relaton is Metanorma XML, and the default -inline formatting language of Relaton Render is also Metanorma XML. This can be seen -in the foregoing examples: italicised titles in templates are marked up as -`{{ title }}`, and the formatting contained within titles is expected to also -be in Metanorma XML, e.g. `A supply of H2O`. - -Relaton Render does not add formatting to variables on its own: any formatting of text -resides in either the templates (including name templates), or the source XML values. -That means that it is possible to use a different markup language, by providing your -own templates; but in that case, any Metanorma XML formatting markup inside the Relaton XML -source will also need to be transformed. (This is done e.g. in `metanorma-ietf`, -which generates citation in IETF RFC XML.) - -So for example the following Metanorma XML-based template uses ``: - -[example] -==== -[source,liquid] ----- -{{ creatornames }} ({{date}}) . {{ title }} [{{medium}}] ,_{{ edition }}_{{ labels['edition'] }} . ----- - -For Markdown you would instead specify the template as: - -[example] -==== -[source,liquid] ----- -{{ creatornames }} ({{date}}) . \_{{ title }}\_ [{{medium}}] ,_{{ edition }}_{{ labels['edition'] }} . ----- - -(Recall that `_` has to be escaped in order to be interpreted as an underscore instead of a non-breaking space.) - -You will however need to add filters or preprocessing, to convert any Metanorma markup in source fields to Markdown, -e.g. converting the title from `A supply of H2O` to `A supply of H~2~O` - - -== Information resource templates - -Relaton Render uses a set of templates to define the citation format for -different types of information resources. - -Each template is defined as a string that contains Liquid rendering expressions -and plain text, which are rendered as is or replaced with corresponding values -from the Relaton bibliographic object. - -Syntax: - -[source,yaml] ----- -template: - article: # ... <1> - book: # ... - misc: # (required) <2> ----- -<1> The template for an information resource type. -<2> The template for a miscellaneous information resource. This is used -as the default template for all information resources that do not have a -specific template defined. - -[example] -==== -[source,yaml] ----- -template: - book: "{{ creatornames }} ({{role}}) . {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} [{{medium}}] . {{ edition | capitalize_first }}. ({{ series }}.) {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%}: {{publisher}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]. {{size}}. {{extent}}." - # TODO: omitted: author ids, subsidiary titles, subsidiary creators, rights metadata, distributor, item attributes, relationships - booklet: book - manual: book - proceedings: book - inbook: "{{ creatornames }} ({{role}}) . {{labels['q-open']}}{{ title }}{{labels['q-close']}} . {{ labels['in'] | capitalize }}: {{ host_creatornames}} ({{ host_role}}) : {{labels['qq-open']}}{{host_title}}{{labels['qq-close']}} [{{medium}}] . {{ edition | capitalize_first }}. ({{ series }}.) {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%}: {{publisher}}. {{date}}. {{size}}. {{extent}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]." - inproceedings: inbook - incollection: inbook - # TODO: omitted: author ids, additional info for component part, subsidiary titles of host resource, rights metadata, distributor, relationships - journal: "{{labels['qq-open']}}{{ title}}{{labels['qq-close']}} [{{medium}}] . {{ edition | capitalize_first }}. {{place}}: {{publisher}}. {{date}}. {{size}}. {{extent}}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]." - # TODO subsidiary titles, rights metadata, item attributes, relationships - article: "{{ creatornames }} ({{role}}) . {{labels['q-open']}}{{ title }}{{labels['q-close']}}. {{ series }} [{{medium}}] . {{ edition | capitalize_first }}. {{size}}. {{ extent }}. {{place}}: {{publisher}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]." - # TODO: omitted: author ids, subsidiary titles, rights metadata, distributor, item attributes, relationships; newspapers - software: "{{ creatornames }} ({{ role}}) . {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} . {{ labels['version'] | capitalize }}_{{ edition_raw }}. {{medium | capitalize}}. {{place}}: {{publisher}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. {{size}}. {{ extent}}. [{{ labels['viewed'] }}:_{{date_accessed}}]. " - # TODO: omitted: author ids, subsidiary titles, subsidiary creators, copyright, license, distributor, system requirements, relationships - electronic resource: software - standard: "{{ creatornames }} ({{ role}}) . {{ authoritative_identifier | join: '|' }}: {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} . {{ medium | capitalize }}. {{ edition | capitalize_first }}. {{ place }}: {{ publisher }}. {{date}}. {{size}}. {{ extent }}. {{ other_identifier | join: '. ' }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]." - # TODO: omitted: author ids, subsidiary titles, rights metadata, distributor, persistent identifier, item attributes, relationships - techreport: standard - dataset: "{{ creatornames }} ({{ role }}) . {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} . {{ labels['version'] | capitalize }}_{{ edition_raw }}. {{medium | capitalize }}. {{ labels['in'] | capitalize }}:_{{series}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. {{ size }}. {{ extent}}. [{{ labels['viewed'] }}:_{{date_accessed}}]. " - # TODO: omitted: author ids, system requirements, host archive, copyright, license, data source, distributor, usage instructions, relationships, provenance - website: "{{ creatornames }} ({{ role }}) . {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} . {{ labels['version'] | capitalize }}_{{ edition_raw }}. {{medium | capitalize }}. {{ place }}: {{ publisher }}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. [{{ labels['viewed'] }}:_{{date_accessed}}]. " - # TODO: omitted: author ids, page title, system requirements, subsidiary creator, rights metadata, distributor, persistent identifier, archive location, archive date and time, relationships - webresource: website - # TODO: component part - unpublished: "{{ creatornames }} ({{ role }}) . {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} . {{ medium | capitalize }}. {{ date }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. [{{ labels['viewed'] }}:_{{date_accessed}}]." - # TODO: omitted: author ids, subsidiary titles, subsidiary creators, host archive, item attributes, relationships - presentation: unpublished - thesis: "{{ creatornames }} ({{ role }}) . {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} . {{ medium | capitalize }}. {{ place }}: {{ publisher }}. {{ date }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. {{ authoritative_identifier | join: '. ' }}. {{ other_identifier | join: '. ' }}. {{ uri }}. [{{ labels['viewed'] }}:_{{date_accessed}}]." - misc: "{{ creatornames }} ({{ role }}) . {{labels['qq-open']}}{{ title }}{{labels['qq-close']}} . {{ date }}. {{ uri }}." - # following are # unsupported types: - map: misc - audiovisual: misc - film: misc - video: misc - broadcast: misc - graphic_work: misc - music: misc - performance: misc - patent: misc - archival: misc - social_media: misc - alert: misc - message: misc - conversation: misc - internal: misc ----- -==== diff --git a/_specs/relaton-ruby.adoc b/_specs/relaton-ruby.adoc deleted file mode 100644 index 71a6901..0000000 --- a/_specs/relaton-ruby.adoc +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: Relaton on Ruby -description: Ruby library for importing and caching bibliographic references. - -feature_with_priority: 2 - -external_links: - - url: https://github.com/relaton/relaton/tree/master/docs ---- -== Scope - -The Relaton Ruby gem obtains authoritative bibliographic entries for technical standards from online sources, and expresses them in a consistent format, which can be used in document authoring. (It is the underlying bibliographic tool for the https://github.com/metanorma/metanorma[Metanorma] toolset.) - -The gem also caches entries it has retrieved, so that subsequent iterations do not need to go back online to retrieve the same entries. The gem uses two caches: a global cache (for all bibliographic entries retrieved by the user), and a local cache (intended to store references specific to the current document being processed.) - -Entries are retrieved and stored in the https://github.com/relaton/relaton-models[Relaton bibliographic model], which is an expression of ISO 690. The subset of the model used and serialised for Relaton is defined in the https://github.com/relaton/relaton-bib[relaton-bib] and https://github.com/relaton/relaton-iso-bib[relaton-iso-bib] gems. - -Entries are serialised to and from an internal data model, and multiple formats are intended to be supported. Currently only https://github.com/relaton/relaton-models/blob/master/grammars/biblio.rnc[Relaton XML] is supported. - -Relaton imports bibliographic entries from: - -* ISO through the iso.org website, via the https://github.com/relaton/relaton-iso[relaton-iso] gem -* IEC through the iec.ch website, via the https://github.com/relaton/relaton-iec[relaton-iec] gem -* GB (Chinese national standards) through the GB websites, via the https://github.com/relaton/relaton-gb[relaton-gb] gem -* IETF standards (Internet Drafts, RFC) through the http://xml2rfc.tools.ietf.org website, via the https://github.com/relaton/relaton-ietf[relaton-ietf] gem -* NIST standards through the nist.gov website, via the https://github.com/relaton/relaton-nist[relaotn-nist] gem - -The identifiers for which bibliographic entries are to be retrieved need to indicate which standards body they belong to. To do so, this gem adopts the convention of bracketing identifiers, and preceding them with a code that indicates the standards body: - -* If the standards body is the national standards body, the wrapper uses the ISO country code. So `CN(GM/T 0009-2012)` is Chinese sector standard GM/T 0009-2012. -* Otherwise, the wrappers uses the agreed abbreviation of the standards body. So `IETF(I-D.ribose-asciirfc-08)` identifies `I-D.ribose-asciirfc` as an Internet Engineering Task Force identifier. -* Some prefixes to identifiers indicate the standards body they belong to unambiguously; e.g. `ISO` followed by slash or space. The scope wrapper is not required for those prefixes: `ISO(ISO 639-1)` can be recognised as just `ISO 639-1`. - -The gem can be extended to use other standards-specific gems. Standards-specific gems like isobib register themselves against Relaton using `Relaton::Registry.instance.register`, which takes as an argument a subclass of `Relaton::Processor` defined in the gem; see isobib/lib/relaton for an example. The processor within the standards-specific gem needs to define - -* `@short`, the name of the gem -* `@prefix`, the regex which scopes the identifier, and constrains it to belong to a particular standards class. -* `@defaultprefix`, the identifier prefixes which can be recognised without a scope wrapper. -* `@idtype`, the type assigned to document identifiers for the standard class. -* `get(code, date, opts)`, which takes a standards code, a year, and a hash of options, and returns an iso-bib-item bibliographic entry -** `date == nil`: an ISO reference is treated as a generic reference to the latest available version of the reference. The latest -version retrieved has its date of publicatipn stripped. The dated reference is retained as an `instanceOf` relation to the reference. -e.g. `get("ISO 19115-1", nil)` is transformed from a reference to `ISO 19115-1:2014` (the latest available online) to an undated reference -to `ISO 19115-1`. -** `opts[:keep_date] == true`: undoes the behaviour of `date == nil`: the most recent dated instance of the reference is retrieved. -e.g. `get("ISO 19115-1", nil, keep_date: true)` returns a reference to `ISO 19115-1:2014` -** `opts[:all_parts] == true`: an ISO reference for a specific document part is transformed into a reference to all parts of the document -(which does not have a distinct web page). The reference to the specific document part is retained as a `partOf` relation to the reference. -e.g. `get("ISO 19115-1", "2014", all_parts: true)` is transformed into a reference to `ISO 19115 (all parts)`. - -== Behaviours - -* If an entry is defined in both the local and the global cache, the local cache entry is used. -* If an ISO entry has no date, the latest version available for the entry is retrieved. -* If a cached ISO entry has no date, and was last retrieved more than 60 days ago, the gem fetches it again, in case there is a newer edition of the standard available. -* Entries are always saved to the cache with a scope-wrapped identifier; e.g. under `ISO(ISO 639-1)`, and not `ISO 639-1`. -* Note that the gem does not currently support the totality of the Relaton model; it will only support the information available in the source websites. We do not expect to support cartographic information, for example. -* Document identifiers are returned with a scope indication (`@idtype`); for example, `RFC 8000`. It is up to the client whether to render this with the scope indication (_IETF RFC 8000_) or without (_RFC 8000_). - -== Usage - -[source,ruby] ----- -require "relaton" -=> true - -# Do not cache any entries retrieved -db = Relaton::Db.new(nil, nil) -[relaton] Info: detecting backends: -[relaton] processor "relaton_iec" registered -[relaton] processor "relaton_iso" registered -[relaton] processor "relaton_ietf" registered -[relaton] processor "relaton_gb" registered -[relaton] processor "relaton_nist" registered -=> # # # nil - -x = db.fetch("ISO 19011") -fetching ISO 19011... -=> # # # ["Chinese Standard", "GB/T 1.1"] - -x.to_xml -=> "...." - -db.to_xml -=> "...." - -x.to_xml -=> "..." - -x.to_xml -=> "..." - -db.load_entry("ISO(ISO 19011)") -=> "..." - -db.save_entry("ISO(ISO 19011)", nil) -=> nil - -db.load_entry("ISO(ISO 19011)") -=> nil ----- diff --git a/_specs/relaton-yaml.adoc b/_specs/relaton-yaml.adoc deleted file mode 100644 index daf3885..0000000 --- a/_specs/relaton-yaml.adoc +++ /dev/null @@ -1,346 +0,0 @@ ---- -title: Relaton YAML -description: Structure for encoding `bibitem` as YAML objects. - -feature_with_priority: 6 - -external_links: - - url: https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc ---- - -The following structure is in place for encoding `bibitem` as YAML objects. The structure has not yet been generalised to `bibdata/ext`, the flavour-specific extensions of Relaton. - -NOTE: Relaton YAML can be used to represent bibliographic entries in Metanorma. - -If an element in Relaton XML has attributes, the content of the element is represented in YAML -with a `content` key: - -[source,xml] ----- -Geographic information ----- - -[source,yaml] ----- -title: - type: main - content: Geographic information ----- - -Any elements with a cardinality of many can be represented as arrays, but -they can also be populated by a hash or single element. For example, -a Relaton title can have multiple titles, and multiple scripts; so -the following are equivalent: - -[source,yaml] ----- -# Array of hashes -title: - - type: main - content: Geographic information - - type: title-part - content: Part 1 - -# Single Hash -title: - type: main - content: Geographic information - -# Array of strings -language: - - en - - fr - -# Single string -language: en ----- - -In YAML, `on` is a reserved word, and thus cannot be used as a key. -`value` is used as a synonym for `on` in dates. - -The structure below is given in YAML format: - -[source,yaml] ----- -# bibliographic item anchor, used to crossreference within document -id: ISO/TC211 -# date record was created -fetched: '2019-06-30' -# titles are an array, with a mandatory type and content, and optional format, language and script -title: - - type: main - content: Geographic information - - type: subtitle - content: Geographic information subtitle - language: en - script: Latn - format: text/plain -# type of document -type: standard -# document identifiers are an array, with a mandatory type and id component -docid: - type: ISO - id: TC211 -# document number -docnumber: '211' -# edition -edition: '1' -# language is an array -language: - - en - - fr -# script is an array -script: - Latn -# version contains revision date and draft (as array) -version: - revision_date: '2019-04-01' - draft: draft -# note is an array of type and content -biblionote: - type: bibnote - content: > - Mark set a major league - home run record in 1998. -# document status has stage, and optional substage and iteration -docstatus: - stage: - value: '30' - abbreviation: CD - substage: - value: '00' - iteration: final -# date is an array, with mandatory type, and either an "on" value or a "from" and optional "to" value -date: - - type: issued - value: '2014' - - type: published - from: '2014-04' - to: '2014-05' - - type: accessed - value: '2015-05-20' -# abstract is an array, with content, and optional language, script, format -abstract: - - content: > - ISO 19115-1:2014 defines the schema required for ... - - content: > - L'ISO 19115-1:2014 définit le schéma requis pour ... - language: fr - script: Latn - format: text/plain -# contributors are an array of entity/role pairs, where entity is either person or organization. -# The role is an array of type and description; it can be a an array of just string, which are treated -# as the type. -# Organisations have attributes name, url, abbreviation, subdivision, contacts, identifiers, logo. -# Persons have attributes name, affiliation, contacts -# Person names have attributes abbreviation, surname, completename, initials, forename, additions, prefixes. -# Initials, forename, additions, prefixes are arrays. -# Name field values are either strings, or hashes, with content and language and script attributes. -# The language and script attribute can also be given on the name. -# Contacts are an array, containing either addresses, or other fields. -# Addresses are identified as hashes containing a city attribute; they can also contain a street -# (which is an array), a postcode, a state, and a country. The other contact fields -# are phones, emails, uris; they can contain a type. -# Affiliations are an array, and they contains an organization, and an optional description. -# The affiliation description can be a single string, or a hash of content, language, script, and format. -contributor: - - organization: - name: International Organization for Standardization - url: www.iso.org - abbreviation: ISO - subdivision: division - logo: - image: - id: logo1 - src: logo1.png - mimetype: image/png - filename: logo1.png - height: "100%" - width: "200" - alt: Logo 1 - title: "Logo #1" - longdesc: Logo number 1 - role: - type: publisher - description: Publisher role - - person: - name: - completename: - content: A. Bierman - language: en - affiliation: - - organization: - name: IETF - abbreviation: IETF - identifier: - - type: uri - id: www.ietf.org - description: Affiliation description - contact: - - address: - street: - - 8 Street St - city: City - postcode: '123456' - country: Country - state: State - - phone: '223322' - type: mobile - role: author - - organization: - name: IETF - abbreviation: IETF - identifier: - - type: uri - id: www.ietf.org - role: - publisher - - person: - name: - abbreviation: AB - language: en - initial: - - A. - surname: Bierman - affiliation: - - organization: - name: IETF - abbreviation: IETF - description: - content: Affiliation description - language: en - script: Latn - identifier: - - type: uri - id: www.person.com - role: - author -# copyright consists of an owner (a hash containing the fields of an organisation), -# a "from" date, and an optional "to" date -copyright: - owner: - name: International Organization for Standardization - abbreviation: ISO - url: www.iso.org - from: '2014' - to: '2020' -# link is an array of URIs, with a type and content -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 -# relations are an array of type, bibitem, locality, source_locality, and description. -# bibitem contains any of the attributes of a bibliographic item. -# locality is an array of locality_stack which is an array of hash of type, -# reference_from, and optionally reference_to -# source_locality is an array of source_locality_stack which is similar to locality_stack -# description is optional and contains content and optional format, language, ans script. -relation: - - type: updates - bibitem: - formattedref: ISO 19115:2003 - locality: - locality_stack: - type: page - reference_from: '7' - reference_to: '10' - source_locality: - source_locality_stack: - - type: volume - reference_from: '1' - - type: chapter - reference_from: '2' - - type: updates - bibitem: - type: standard - formattedref: - content: ISO 19115:2003/Cor 1:2006 - format: text/plain - description: - content: supersedes - format: text/plain - - type: partOf - bibitem: - title: - type: main - content: Book title - format: text/plain -# series are an array, containing a title, a type, a formattedref, a place, -# an organization (string), an abbreviation, a from, a to, a number, and a partnumber. -# The title is mandatory, and all other fields are optional. -# The series title, like the titles of bibliographic items, contains a type, -# content, and optional language, script, and format attributes. -# The abbreviation and formattedref are either a string, -# or a hash containing content, language, and script. -series: - - type: main - title: - type: original - content: ISO/IEC FDIS 10118-3 - language: en - script: Latn - format: text/plain - place: Serie's place - organization: Serie's organization - abbreviation: - content: ABVR - language: en - script: Latn - from: '2009-02-01' - to: '2010-12-20' - number: serie1234 - partnumber: part5678 - - title: - - content: Series - language: en - script: Latn - - content: Séries - language: fr - script: Latn - format: text/plain -# medium contains a form, a size, and a scale -medium: - form: medium form - size: medium size - scale: medium scale -# place is an array of strings or hashes. Can have name or city, region and country. -# Name or city is mandatory, region and country are optional. -# String and hash with name are equivalent. -place: - - bib place - - city: Geneva - region: - - name: Region - country: - - iso: CH - name: Switzelznd - recommended: true -# extent is an array, localities are an array of locality_stack -extent: - locality: - type: section - reference_from: '7' - reference_to: '10' -# accesslocation is an array of strings -accesslocation: - - accesslocation1 - - accesslocation2 -# classification is an array of type and value -classification: - type: type - value: value -# validity contains a begins date, an ends date, and a revision date -validity: - begins: '2010-10-10 12:21' - ends: '2011-02-03 18:30' - revision: '2011-03-04 09:00' -# keyword is an array of strings or hashes of content, language, script, and format -keyword: - - Keyword - - Key Word -# license is a string -license: License ----- diff --git a/assets/blog/2024-01-19/iso-2108-1972-cover.png b/assets/blog/2024-01-19/iso-2108-1972-cover.png deleted file mode 100644 index b3caeca..0000000 Binary files a/assets/blog/2024-01-19/iso-2108-1972-cover.png and /dev/null differ diff --git a/assets/blog/2024-01-19/iso-2108-2017-cover.png b/assets/blog/2024-01-19/iso-2108-2017-cover.png deleted file mode 100644 index 3968d69..0000000 Binary files a/assets/blog/2024-01-19/iso-2108-2017-cover.png and /dev/null differ diff --git a/assets/blog/2024-01-19/snow-crash-1.png b/assets/blog/2024-01-19/snow-crash-1.png deleted file mode 100644 index 9b9854c..0000000 Binary files a/assets/blog/2024-01-19/snow-crash-1.png and /dev/null differ diff --git a/assets/blog/2024-01-19/snow-crash-2.png b/assets/blog/2024-01-19/snow-crash-2.png deleted file mode 100644 index 83774d7..0000000 Binary files a/assets/blog/2024-01-19/snow-crash-2.png and /dev/null differ diff --git a/assets/css/style.scss b/assets/css/style.scss deleted file mode 100644 index 3da315e..0000000 --- a/assets/css/style.scss +++ /dev/null @@ -1,18 +0,0 @@ ---- ---- -@import url('https://fonts.googleapis.com/css?family=Quicksand:400,500,700'); - -$font-family: Quicksand, Verdana, sans-serif; -$hero-title-font-weight: 500; - -$primary-color: #1f6cf1; -$accent-color: #21c197; -$warning-color: #ec5402; -$important-color: #ffd902; -$light-gray-color: #64788b; -$article-link-color: #1f6cf1; - -$main-background: linear-gradient(135deg, $primary-color 0%, $accent-color 100%); - -@import 'jekyll-theme-rop'; -@import 'relaton'; diff --git a/assets/js/relaton_api.js b/assets/js/relaton_api.js deleted file mode 100644 index be77066..0000000 --- a/assets/js/relaton_api.js +++ /dev/null @@ -1,65 +0,0 @@ -const ready = ()=> { - const form = document.getElementById("api_document_form"); - const btn = document.getElementById("api_document_submit"); - const ref = document.getElementById('api_reference'); - const refMsg = document.getElementById("api_ref_msg"); - const year = document.getElementById("api_year"); - const allParts = document.getElementById("api_option_all_parts"); - const keepYear = document.getElementById("api_option_keep_year"); - const url = document.getElementById("api_url"); - const req = new XMLHttpRequest(); - const res = document.getElementById("api_document_result"); - - const inputsBlock = (block) => { - ref.disabled = block; - year.disabled = block; - allParts.disabled = block; - keepYear.disabled = block; - btn.disabled = block; - } - - const reqListener = (e)=> { - if (req.readyState === 4) { - res.textContent = req.responseText; - inputsBlock(false); - } - } - - req.onreadystatechange = reqListener; - - const update_url = (ev)=> { - url.textContent = "https://api.relaton.org/api/v1/document?code=" + ref.value; - if (year.value.trim() !== "") { - url.textContent += "&year=" + year.value; - } - if (allParts.checked) { - url.textContent += "&all_parts=true" - } - if (keepYear.checked) { - url.textContent += "&keep_year=true" - } - url.textContent = encodeURI(url.textContent); - } - - const submit = (el)=> { - el.preventDefault(); - if (ref.value.trim() === "") { - ref.focus(); - refMsg.style.display = "block"; - } else { - inputsBlock(true); - res.textContent = "Awaiting for results..." - req.open("GET", url.textContent); - req.send(); - } - } - - ref.addEventListener("keyup", update_url); - ref.addEventListener("focusout", (ev)=> {if (ref.value.trim() === "") { refMsg.style.display = "block"}}); - year.addEventListener("keyup", update_url); - allParts.addEventListener("change", update_url); - keepYear.addEventListener("change", update_url); - form.addEventListener("submit", submit); -}; - -document.addEventListener('DOMContentLoaded', ready, false); \ No newline at end of file diff --git a/assets/symbol.svg b/assets/symbol.svg deleted file mode 100644 index f3edbad..0000000 --- a/assets/symbol.svg +++ /dev/null @@ -1,34 +0,0 @@ - - - - - diff --git a/assets/tagline.svg b/assets/tagline.svg deleted file mode 100644 index 6aec635..0000000 --- a/assets/tagline.svg +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/_model_docs/specific-cats.adoc b/model/specific-cats.md similarity index 78% rename from _model_docs/specific-cats.adoc rename to model/specific-cats.md index 0eba762..9745d63 100644 --- a/_model_docs/specific-cats.adoc +++ b/model/specific-cats.md @@ -1,25 +1,25 @@ --- title: Specific categories description: Conventions specific to bibliographic categories in Relaton -layout: model-docs + --- -[[specific-categories]] -== Specific categories of information resource +## Specific categories of information resource {#specific-categories} -=== Electronic information resources +### Electronic information resources * Source: ISO 690, 5.3 -System requirements are modelled as a note, prefixed with "`System requirements`:". +System requirements are modelled as a note, prefixed with "System requirements":. -NOTE: Detailed system requirements are -less commonly expressed now for software than they were in the 1990s and 2000s. +::: tip NOTE +Detailed system requirements are less commonly expressed now for software than they were in the 1990s and 2000s. +::: URLs should not be broken at the end of a line: that is a rendering requirement, not an information modelling requirement. -As discussed in link:/model/bibtype[Categories of information resource], +As discussed in [Categories of information resource](/model/bibtype), where possible, a more specific category should be used than "electronic resource", which is properly a description of a medium and not a resource type; monographs and @@ -28,17 +28,16 @@ journals are now routinely published online. The specific type of electronic resource, if not covered by `bibitem/@type` (e.g. "book", "dataset"), should be given as `medium/genre`. -.Examples of citing an electronic information resource -==== -Ubisoft. _Far Cry 5_ [computer game]. 2018. Viewed: 2018-05-10. -System requirements: CPU: Intel Core i5-2400 | AMD FX-6300 @ 3.5 GHz or better -(minimum); Intel Core i7-4770 @ 3.4 GHz | AMD Ryzen 5 1600 @ 3.2 GHz or equivalent (recommended). -RAM: 8 GB. OS: Windows 7 SP1, Windows 8.1, Windows 10 (64-bit versions only). -VIDEO CARD: NVIDIA GeForce GTX 670 | AMD R9 270 (2GB VRAM with Shader Model 5.0 or better) (minimum); -NVIDIA GeForce GTX 970 or AMD R9 290X (4GB VRAM with Shader Model 5.0 or better) (recommended). +**Examples of citing an electronic information resource** + +> Ubisoft. *Far Cry 5* [computer game]. 2018. Viewed: 2018-05-10. +> System requirements: CPU: Intel Core i5-2400 | AMD FX-6300 @ 3.5 GHz or better +> (minimum); Intel Core i7-4770 @ 3.4 GHz | AMD Ryzen 5 1600 @ 3.2 GHz or equivalent (recommended). +> RAM: 8 GB. OS: Windows 7 SP1, Windows 8.1, Windows 10 (64-bit versions only). +> VIDEO CARD: NVIDIA GeForce GTX 670 | AMD R9 270 (2GB VRAM with Shader Model 5.0 or better) (minimum); +> NVIDIA GeForce GTX 970 or AMD R9 290X (4GB VRAM with Shader Model 5.0 or better) (recommended). -[source,xml] --- +```xml Far Cry 5 2018 @@ -64,28 +63,23 @@ RAM: 8 GB. OS: Windows 7 SP1, Windows 8.1, Windows 10 (64-bit versions only). VIDEO CARD: NVIDIA GeForce GTX 670 | AMD R9 270 (2GB VRAM with Shader Model 5.0 or better) (minimum); NVIDIA GeForce GTX 970 or AMD R9 290X (4GB VRAM with Shader Model 5.0 or better) (recommended). --- -==== +``` -=== Cartographic material +### Cartographic material * Source: ISO 690, 5.4 - The projection, prime meridian, orientation, and reference systems (such as grids and navigational lattices) are given as notes. The spectral characteristics of the sensor, details of the satellite systems, and the amount of cloud cover are also given as notes. Details of the creator's role are given in `bibitem/contributor/role`. +> Berner, L.T., P.S.A. Beck, M.M. Loranty, H.D. Alexander, M.C. Mack, and S.J. Goetz. +> *Siberian Boreal Forest Aboveground Biomass and Fire Scar Maps, Russia, 1969-2007*. +> ORNL DAAC, Oak Ridge, Tennessee, USA. 2016. http://dx.doi.org/10.3334/ORNLDAAC/1321 -==== -Berner, L.T., P.S.A. Beck, M.M. Loranty, H.D. Alexander, M.C. Mack, and S.J. Goetz. -_Siberian Boreal Forest Aboveground Biomass and Fire Scar Maps, Russia, 1969-2007_. -ORNL DAAC, Oak Ridge, Tennessee, USA. 2016. http://dx.doi.org/10.3334/ORNLDAAC/1321 - -[source,xml] --- +```xml Siberian Boreal Forest Aboveground Biomass and Fire Scar Maps, Russia, 1969-2007 2016 @@ -134,36 +128,31 @@ Biomass Mapping: WorldView-1 (WV-1), Landsat 5 TM Fire Scar Mapping: Landsat 7 ETM+, Landsat 5 TM, Landsat 1–3 MSS Oak Ridge, Tennessee, USA --- -==== +``` - -=== Films, videos and broadcasts +### Films, videos and broadcasts * Source: ISO 690, 5.5 - If a single contributor is to be singled out as the creator of a resource, they -are assigned the `bibitem/contributor/role@type` of "`author`". +are assigned the `bibitem/contributor/role@type` of "author". Otherwise, if the resource is treated as a collaborative effort, the various contributors should -be listed with `bibitem/contributor/role@type` of "`performer`", with their +be listed with `bibitem/contributor/role@type` of "performer", with their contributions differentiated in the `bibitem/contributor/role`. Programmes within a series have the series modelled as a `bibitem/series`. The title of the series is modelled as `bibitem/series/title`, and the title of the episode as `bibitem/title`. The transmitting organisation and channel -are modelled as a contributor of type "`distributor`". +are modelled as a contributor of type "distributor". If an audiovisual resource is a contained item, the `bibitem/extent` gives its location within the host item; this is typically a timestamp for visual material, and a timestamp or a track for audio material. -==== -_The Death of Stalin_. Directed by Armando Iannucci. 2017. +> *The Death of Stalin*. Directed by Armando Iannucci. 2017. -[source,xml] --- +```xml The Death of Stalin 2017 @@ -177,14 +166,11 @@ _The Death of Stalin_. Directed by Armando Iannucci. 2017. --- -==== +``` -==== -Armando Iannucci. _The Death of Stalin_. 2017. +> Armando Iannucci. *The Death of Stalin*. 2017. -[source,xml] --- +```xml The Death of Stalin 2017 @@ -198,15 +184,12 @@ Armando Iannucci. _The Death of Stalin_. 2017. --- -==== +``` -==== -_Columbo_, Season 7, Episode 5. The Conspirators. Teleplay by Howard Berk. -NBC. 1978-05-13. +> *Columbo*, Season 7, Episode 5. The Conspirators. Teleplay by Howard Berk. +> NBC. 1978-05-13. -[source,xml] --- +```xml The Conspirators 1978-05-13 @@ -231,23 +214,19 @@ NBC. 1978-05-13. Episode 5 --- -==== +``` -=== Graphic Works +### Graphic Works * Source: ISO 690, 5.6 - The fuller description of a contributors role under `bibitem/contributor/role` -allows for Latin role descriptions such as _pinxit_ and _sculpsit_. +allows for Latin role descriptions such as *pinxit* and *sculpsit*. -==== -_[Tent of Darius]_ C. Le Brun pinxit. S. Gribelin sculpsit. -[painting]. 1702. At: Musée du Louvre, Inv. 2896. +> *[Tent of Darius]* C. Le Brun pinxit. S. Gribelin sculpsit. +> [painting]. 1702. At: Musee du Louvre, Inv. 2896. -[source,xml] --- +```xml [Tent of Darius] 1702 @@ -262,12 +241,11 @@ _[Tent of Darius]_ C. Le Brun pinxit. S. Gribelin sculpsit.
painting
- Musée du Louvre, Inv. 2896. + Musee du Louvre, Inv. 2896.
--- -==== +``` -=== Music +### Music * Source: ISO 690, 5.7 * Serialisation: `bibitem/contributor/role` @@ -276,7 +254,7 @@ Librettists and composers are both contributors of role type "author"; the role of composer and librettist needs to be differentiated in the contributor role for proper rendering. -The type "`music`" covers both music scores and music recordings, as is done +The type "music" covers both music scores and music recordings, as is done in ISO 690. The two are differentiated in `medium`; following the practice in ISO 690, `medium/content` "notated music" is used for music scores, while `medium/carrier` is used for recordings @@ -286,13 +264,10 @@ score is not published), this is not good practice, for the same reason that particular editions are required for citation of textual works. -==== -ADAMS, John Coolidge. _Nixon in China_. Libretto by Alice GOODMAN. 2004 [1987]. -Vocal score. New York: Boosey & Hawkes. - +> ADAMS, John Coolidge. *Nixon in China*. Libretto by Alice GOODMAN. 2004 [1987]. +> Vocal score. New York: Boosey & Hawkes. -[source,xml] --- +```xml Nixon in China 1987 @@ -315,16 +290,13 @@ Vocal score. New York: Boosey & Hawkes. New York --- -==== +``` -==== -ADAMS, John Coolidge. _Nixon in China_. Libretto by Alice GOODMAN. 2009. -Marin Alsop (Conductor). Colorado Symphony Orchestra. [Audio CD]. -3 CDs. Naxos. +> ADAMS, John Coolidge. *Nixon in China*. Libretto by Alice GOODMAN. 2009. +> Marin Alsop (Conductor). Colorado Symphony Orchestra. [Audio CD]. +> 3 CDs. Naxos. -[source,xml] --- +```xml Nixon in China 1987 @@ -357,26 +329,20 @@ Marin Alsop (Conductor). Colorado Symphony Orchestra. [Audio CD]. 3 --- - -==== +``` - -=== Patents +### Patents * Source: ISO 690, 5.8 Patents are encoded similarly to contributions within a serial (ISO 690, 5.2), with the series designation for the patent preceded by the country name or code. The date of application -is encoded as a date of type "`issued`". - +is encoded as a date of type "issued". -==== -Green, Martin Andrew. _Artificial amorphous semiconductors and applications to solar cells_. Australia, [Patent] application number 2005238988. Appl: 2005-04-29. +> Green, Martin Andrew. *Artificial amorphous semiconductors and applications to solar cells*. Australia, [Patent] application number 2005238988. Appl: 2005-04-29. -[source,xml] --- +```xml Artificial amorphous semiconductors and applications to solar cells 2005-04-29 @@ -393,12 +359,11 @@ Green, Martin Andrew. _Artificial amorphous semiconductors and applications to s 2005238988 --- -==== +``` -=== Archival materials +### Archival materials -* Source: ISO 690, 5.10 +* Source: ISO 690, 5.10 The fonds or collection of an archival item is modelled as a series. The box and folder number is encoded as an access location. The reference code @@ -406,11 +371,9 @@ is encoded as an identifier. The archive is encoded as a contributor of type "distributor" (since the archive makes the resource available, even if to a restricted public). -==== -HICKS, H. D. _Correspondence from Henry Davies Hicks to the Annapolis County electorate_. [1956-10-24]. MS-2-511, Box 15, Folder 9. Henry Davies Hicks fonds. At: Dalhousie University Archives, Halifax, Nova Scotia, Canada. +> HICKS, H. D. *Correspondence from Henry Davies Hicks to the Annapolis County electorate*. [1956-10-24]. MS-2-511, Box 15, Folder 9. Henry Davies Hicks fonds. At: Dalhousie University Archives, Halifax, Nova Scotia, Canada. -[source,xml] --- +```xml Correspondence from Henry Davies Hicks to the Annapolis County electorate MS-2-511 @@ -438,12 +401,11 @@ HICKS, H. D. _Correspondence from Henry Davies Hicks to the Annapolis County ele Box 15, Folder 9 --- -==== +``` -=== Datasets +### Datasets -* Source: ISO 690, 5.11 +* Source: ISO 690, 5.11 The organisation publishing or producing the dataset is modelled as a publisher; the organisation hosting the dataset in a repository is modelled as a distributor. @@ -452,13 +414,11 @@ Timestamps are modelled as extents; queries wherever possible should be entered Where that is not possible, the description of the necessary query to access the required data subset should be presented as an `accessLocation`. -==== -MILBERGER, S. (2002). _Evaluation of violence against women with physical disabilities in Michigan, 2000–2001_ (ICPSR version) [dataset] [data in several file formats and codebook/questionnaire in PDF]. Detroit: Wayne State University [producer]. Ann Arbor, MI: Inter-university Consortium for Political and Social Research [distributor +> MILBERGER, S. (2002). *Evaluation of violence against women with physical disabilities in Michigan, 2000-2001* (ICPSR version) [dataset] [data in several file formats and codebook/questionnaire in PDF]. Detroit: Wayne State University [producer]. Ann Arbor, MI: Inter-university Consortium for Political and Social Research [distributor -[source,xml] --- +```xml - Evaluation of violence against women with physical disabilities in Michigan, 2000–2001 + Evaluation of violence against women with physical disabilities in Michigan, 2000-2001 2002 @@ -493,14 +453,11 @@ MILBERGER, S. (2002). _Evaluation of violence against women with physical disabi data in several file formats and codebook/questionnaire in PDF --- -==== +``` -==== -LEUPRECHT [et al.]. tas_CNRM-CERFACS-CNRM-CM5_RCP4.5_r1i1p1_CLMcom-CCLM4-8-17, [dataset]. Version 2. [Subset used: January to June 2014]. Vienna, Austria. CCCA Data Centre [distributor], 2016. Available from: https://hdl.handle.net/20.500.11756/93887ecf. [accessed 2017-06-28]. +> LEUPRECHT [et al.]. tas_CNRM-CERFACS-CNRM-CM5_RCP4.5_r1i1p1_CLMcom-CCLM4-8-17, [dataset]. Version 2. [Subset used: January to June 2014]. Vienna, Austria. CCCA Data Centre [distributor], 2016. Available from: https://hdl.handle.net/20.500.11756/93887ecf. [accessed 2017-06-28]. -[source,xml] --- +```xml tas_CNRM-CERFACS-CNRM-CM5_RCP4.5_r1i1p1_CLMcom-CCLM4-8-17 https://hdl.handle.net/20.500.11756/93887ecf @@ -535,12 +492,11 @@ LEUPRECHT [et al.]. tas_CNRM-CERFACS-CNRM-CM5_RCP4.5_r1i1p1_CLMcom-CCLM4-8-17, [ June 2014 --- -==== +``` -=== Social Media +### Social Media -* Source: ISO 690, 5.12 +* Source: ISO 690, 5.12 Social media items are typically items of `bibitem/@type` `webresource`, although they may not always have an associated exposed URI (particularly @@ -552,7 +508,7 @@ between individuals, and are cited as personal communications. A person's real name may be related to the online identity assumed by the author of the item, if both are known. The online identity is treated as a -pseudonym of the real life identity, and is serialised in the same way (link:/model/creator#variantnames[variantnames]). +pseudonym of the real life identity, and is serialised in the same way ([variant names](/model/contributor#variantnames)). The particular form of social media communication (e.g. blog post, forum post, tweet, message) should be given through `medium/genre`. @@ -561,13 +517,9 @@ to how the content is to be accessed by an intermediary app. (For example, a twe is not just accessed by a web browser, as a web resource; it is accessed and rendered by a web browser in the context of Twitter.) +> GATES, B. [BillGates]. (2013, February 26). #Polio is 99% eradicated. Join me & @FCBarcelona as we work to finish the job and #EndPolio. [Tweet]. Available from: https://twitter.com/BillGates/status/306195345845665792. [viewed 2016-07-06T12:30:15+02:00]. See also VIDEO: http://b-gat.es/X75Lvy. - -==== -GATES, B. [BillGates]. (2013, February 26). #Polio is 99% eradicated. Join me & @FCBarcelona as we work to finish the job and #EndPolio. [Tweet]. Available from: https://twitter.com/BillGates/status/306195345845665792. [viewed 2016-07-06T12:30:15+02:00]. See also VIDEO: http://b-gat.es/X75Lvy. - -[source,xml] --- +```xml #Polio is 99% eradicated. Join me & @FCBarcelona as we work to finish the job and #EndPolio 2013-02-26 @@ -595,7 +547,4 @@ GATES, B. [BillGates]. (2013, February 26). #Polio is 99% eradicated. Join me &
--- -==== - - +```