relaton-render 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 900cfb8e591fbbd83ee48c2dfa762a317a15c590fb89844b3ce7a759125d4f94
-  data.tar.gz: 29c15ba8cfe1e2dcfafc8d6a4d9985ed298c4515d4c734e3505dfcca9cb11189
+  metadata.gz: 077a906da97ebd8417a856d6c5b73ae81cd3c5457ba8383094e752fd5c585bc0
+  data.tar.gz: 85c8446d1a644ba1b4cd28cfae099dddaa31867a376a9e484d387387ac7d0c7c
 SHA512:
-  metadata.gz: ebd7be4d34144997dcee8593266b75eefca1781341b4f081df290a9df64cbb7d665985c1bd0807c1036b190f68d6877b2bf822281bdc6e7c3a332fce349ac612
-  data.tar.gz: 8392d3b4d8c836b74cbf7a05435f55b274f24ae1004b247151481a34d86c104818926f3452c68f776a0adb521e9404b908f0d0fde25494014958bfd2c28005ac
+  metadata.gz: 3fb5003aaefb0915a9eebd6d021bdd20e92dcf2c2eb015aea68c102928f1b8702841624d356d14dc00912752df3a50f7e98222d2e9a84cda819d1ed755610aad
+  data.tar.gz: 5cd715d1b65f71d1e4126b8443dbcb99a4bf078145cd3bfaa9e9fff5c67bac96b9d6b9e97e55b995c6f63764997f1e703bc65e366fde5b1d2c376f4e7af384bf

data/README.adoc

@@ -1,8 +1,8 @@
 = Relaton Render
 
-image:https://img.shields.io/gem/v/iso690render.svg["Gem Version", link="https://rubygems.org/gems/iso690render"]
-image:https://github.com/metanorma/iso690render/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/iso690render/actions?workflow=rake"]
-image:https://codeclimate.com/github/metanorma/iso690render/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/iso690render"]
+image:https://img.shields.io/gem/v/relaton-render.svg["Gem Version", link="https://rubygems.org/gems/relaton-render"]
+image:https://github.com/metanorma/relaton-render/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/relaton-render/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/relaton-render/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/relaton-render"]
 
 Gem that takes a https://github.com/relaton/relaton[Relaton] bibliographic description and 
 a configuration, and generates a https://www.metanorma.org[Metanorma] XML rendering of that description.
@@ -16,6 +16,8 @@ input = "<bibitem type='...'>....</bibitem>"
 Relaton::Render::General.new(template: ..., nametemplate: ..., seriestemplate: ..., language: "en", script: "Latn").render(input)
 ----
 
+The gem processes either Relaton XML, or native Relaton classes.
+
 The gem is intended to be inherited from by Metanorma flavours, which may specialise it with their own
 code. The templates are however intended to determine much of the rendering.
 
@@ -32,6 +34,7 @@ The parameters are:
 `seriestemplate`:: template for rendering series
 `journaltemplate`:: template for rendering journals in article citations
 `extenttemplate`:: templates for rendering extents
+`sizetemplate`:: templates for rendering sizes
 `edition_number`:: override formatting of edition number
 `edition`:: override formatting of edition 
 `date`:: default date format (from Twitter CLDR)
@@ -120,6 +123,10 @@ drawn from the bibliographic item:
 
 Many fields are populated either by the description of the bibliographic item itself, or by the description of the item containing it (the _host_ item: `./relation[@type = 'includedIn']/bibitem`). For example, in a paper included in an edited volume, the edition will typically be given for the editor volume, rather than for the paper. Those fields are indicated by "Can come from host" in the table.
 
+The Liquid templates use the filters defined in Liquid, such as `upcase`. We have defined some custom filters:
+
+* `capitalize_first` capitalises only the first word in a string, and does not lowercase other words in the string. So "third edition" becomes "Third edition", but "3. Aufl." does not become "3. aufl."
+
 The Liquid template surrounds each field by preceding and following punctuation.
 
 * Fields are space-delimited. So `<em>{{ title }}</em> [{{medium}}]` are two separate fields.
@@ -152,7 +159,7 @@ draws on the following fields drawn from the bibliographic item:
 |===
 | Field  | Relaton XPath | Multiple | Note
 
-| surname[0] | ./contributor[1]/person/name/surname \| ./contributor[1]/person/name/completename \| ./contributor[1]/organization/name | | i.e. surname is the name default
+| surname[0] | ./contributor[1]/person/name/surname \| ./contributor[1]/person/name/completename | | i.e. surname is the name default
 | surname[1] | ./contributor[2]/name/surname | |
 | surname[2] | ./contributor[3]/name/surname | |
 | initials[0] | ./contributor[1]/name/initial | | If not supplied, the first letter of each given name is used instead
@@ -161,6 +168,8 @@ draws on the following fields drawn from the bibliographic item:
 | given[1] |  ./contributor[2]/name/forename[1] | |
 | middle[0] | ./contributor[1]/name/forename[not(first())] | Y |
 | middle[1] | ./contributor[2]/name/forename[not(first())] | Y |
+| nonpersonal[0] |./contributor[1]/organization/name | Y |
+| nonpersonal[1] |./contributor[2]/organization/name | Y |
 |===
 
 There are at least three distinct `nametemplate` instances that need to be provided, one for a single contributor (`one:`), one for two contributors (`two:`), one for three or more (`more:`), and optionally one for "et al." (`etal:`). The number of contributors for which "et al." starts being used is indicated by `etal_count`.
@@ -168,10 +177,10 @@ There are at least three distinct `nametemplate` instances that need to be provi
 For example:
 ....
 {
-  one: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}",
-  two: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }} &amp; {{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }}",
-  more: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}, {{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }} &amp; {{ given[2] }} {{ middle[2] | slice : 0 }} {{ surname[2] }}",
-  etal: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}, {{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }} <em>et al.</em>",
+  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 %} &amp; {% 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 %} &amp; {% 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 %} <em>et al.</em>",
   etal_count: 6
 }
 ....
@@ -209,7 +218,7 @@ A common template that drops those labels is:
 
 === Extent template
 
-The extent of a reference can be expressed differently depending on the type of bibliographic item. For example, the extent of a book is its page count, and is typically expressed as something like _59 pp._ On the other hand, the extent of an article is expressed as _pp. 9–20_, or just _9–20_. 
+The extent of a bibliographic item may be expressed differently depending on the type of bibliographic item. For 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_. 
 
 To capture this, a separate template is supplied under `extenttemplate` for each bibliographic item type. For those types where none is supplied, the template given for `misc` is used as the default. 
 
@@ -217,25 +226,61 @@ The template draws on the defined types of locality of extents; the most common
 
 ....
 {
-  book: "{{ volume }}_{{ label['extent']['volume'] }}, {{ page }}_{{ label['extent']['page'] }}"
-  inbook: "{{ volume }}: {{ page }}"
-  misc: "{{ label['extent']['volume'] }}_{{ volume }}, {{ label['extent']['page'] }}_{{ page }}"
+  article: "{{ volume_raw }}: {{ page_raw }}"
+  misc: "{{ volume }}, {{ page }}"
+}
+....
+
+The internationalisation files define a singular and a plural version of the locality types, under `labels['extent']`.
+
+* The plural label is always used if the extent is a range (with a `<from>` and `<to>`). 
+* The singular label is used if the extent is not a range (_pp. 2–4_ vs. _p. 3_).
+* The internationalisation 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 `第%页`.) 
+* The number of the volume or page, without accompanying labels, is given in `volume_raw` and `page_raw`.
+
+=== Size template
+
+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), whereas the extent is how much of the host item the item covers (e.g. which pages of the book are in the current chapter.) 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._.
+
+To capture this, a separate template is supplied under `sizetemplate` for each bibliographic item type. Again, for those types where none is supplied, the template given for `misc` is used as the default.
+
+The template draws on the defined types of locality of extents; the following are currently recognised:
+
+|===
+| Field  | Relaton XPath | Note
+
+| volume  | ./medium/size[@type = 'volume'] | With internationalisation of label
+| volume_raw  | ./medium/size[@type = 'volume'] |
+| page  | ./medium/size[@type = 'page'] | With internationalisation of label
+| page_raw  | ./medium/size[@type = 'page'] |
+| data  | ./medium/size[@type = 'data'] | Unit of size is included in value
+| duration  | ./medium/size[@type = 'time'] | Expressed in ISO 8601 duration
+|===
+
+
+Locality types are the fields used in the Liquid templates; for example:
+
+....
+{
+  dataset: "{{ data }}"
+  misc: "{{ volume }}, {{ page }}, {{ data }}, {{ duration }}"
 }
 ....
 
-The internationalisation files define a singular and a plural version of the locality types, under `labels['extent']`
+The internationalisation files define a singular and a plural version of the locality types, under `labels['size']`.
 
-* The plural is always used if the extent is a range (with a `<from>` and `<to>`). 
-* In a host type of bibliographic item, the extent is singular only if the value is `1`, else it is plural (_1 p._, _2 pp._)
-* In an included item (`inbook`, `incollection`, `inproceedings`, `article`, or any item with an `includedIn` relation), 
-the singular is used if the extent is not a range (_pp. 2–4_ vs. _p. 3_)..
+* The plural label is always used if the extent is a range (with a `<from>` and `<to>`).
+* The label is singular only if the value is `1`, else it is plural (_1 p._, _2 pp._)
+* Again, the internationalisation 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 spans of the same type are joined by `+`; e.g. _xlii + 76 pp._.
 
 === Other
 
 In addition, the configuration includes different configuration options for rendering:
 
 The internationalisation file sets the following variables, which can be overridden in configuration parameters:
-`edition_number`:: has following values corresponding to the rule-based number rules defined in https://github.com/twitter/twitter-cldr-rb[Twitter CLDR]
-for a language. For example, English _4th_ is defined as `["OrdinalRules", "digits-ordinal"]`, because under twitter-cldr, `4th` is generated as `4.localize(:en).to_rbnf_s("OrdinalRules", "digits-ordinal")`.
+`edition_number`:: has following values corresponding to the rule-based number rules defined in https://github.com/twitter/twitter-cldr-rb[Twitter CLDR]. 
+for a language. For example, English _4th_ is defined as `["OrdinalRules", "digits-ordinal"]`, because under twitter-cldr, `4th` is generated as `4.localize(:en).to_rbnf_s("OrdinalRules", "digits-ordinal")`. If missing, the raw number is given.
 `edition`:: is the localised expression for edition, with the edition number given as %. So _4th ed.` is generated with `edition` as `% ed.`.
 `date`:: date format default, taken from https://github.com/twitter/twitter-cldr-rb[Twitter CLDR]: `to_full_s`, `to_long_s`, `to_medium_s`, `to_short_s`, or one of the `to_additional_s` formats. One value is given for each of "month_year", "day_month_year", and "date_time"; e.g. `{ month_year: to_long_s, day_month_year: to_long_s, date_time: to_long_s }`.

data/lib/isodoc/i18n.rb

@@ -2,7 +2,7 @@ require "yaml"
 require "isodoc-i18n"
 
 module IsoDoc
-  class I18n
+  class RelatonRenderI18n < I18n
     def load_yaml1(lang, script)
       case lang
       when "en", "fr", "ru", "de", "es", "ar"
@@ -11,8 +11,7 @@ module IsoDoc
         if script == "Hans" then load_yaml2("zh-Hans")
         else load_yaml2("en")
         end
-      else
-        load_yaml2("en")
+      else load_yaml2("en")
       end
     end
 
@@ -20,5 +19,15 @@ module IsoDoc
       YAML.load_file(File.join(File.dirname(__FILE__),
                                "../isodoc-yaml/i18n-#{str}.yaml"))
     end
+
+    # force bidi for all i18n strings in Arabic,
+    # because of the potential for script mixing
+    def cleanup_entities(hash, is_xml: true)
+      ret = super
+      if @lang == "ar" && /%/.match?(ret)
+        ret = "&#x61c;#{ret}&#x61c;"
+      end
+      ret
+    end
   end
 end

data/lib/isodoc-yaml/i18n-ar.yaml

@@ -1,2 +1,31 @@
 in:  في
 at: في
+and: و
+updated: محدث
+viewed: ينظر
+version: الإصدار
+date:
+  month_year: yMMMM
+  day_month_year: to_long_s
+  date_time: to_long_s
+edition_number: ["OrdinalRules", "digits-ordinal"]
+edition: "الطبعة؜ %؜"
+draft: "مشروع؜ %؜"
+editor:
+  sg: محرر
+  pl: محرران
+extent:
+  page:
+    sg: "% ص"
+    pl: "% ص"
+  volume:
+    sg: "% المجلد"
+    pl: "% المجلدين"
+size:
+  page:
+    sg: "ص؜ %"
+    pl: "ص؜ %"
+  volume:
+    sg: "المجلد %"
+    pl: "المجلدين %"
+

data/lib/isodoc-yaml/i18n-de.yaml

@@ -1,2 +1,29 @@
 in: in
 at: bei
+and: und
+updated: aktualisiert
+viewed: angesehen
+version: Version
+date:
+  month_year: yMMMM
+  day_month_year: to_long_s
+  date_time: to_long_s
+draft: "Entwurf %"
+edition: "% Aufl."
+editor:
+  sg: Hrsg.
+  pl: Hrsg.
+extent:
+  page:
+    sg: "S. %"
+    pl: "S. %"
+  volume:
+    sg: "Bd. %"
+    pl: "Bde. %"
+size:
+  page:
+    sg: "% S."
+    pl: "% S."
+  volume:
+    sg: "% Bd."
+    pl: "% Bde."

data/lib/isodoc-yaml/i18n-en.yaml

@@ -5,18 +5,27 @@ updated: updated
 viewed: viewed
 version: version
 date:
-  month_year: to_long_s
+  month_year: yMMMM
   day_month_year: to_long_s
   date_time: to_long_s
 edition_number: ["OrdinalRules", "digits-ordinal"]
 edition: "% edition"
+draft: "draft %"
 editor:
   sg: ed.
   pl: eds.
 extent:
   page:
-    sg: p.
-    pl: pp.
+    sg: "p. %"
+    pl: "pp. %"
   volume:
-    sg: vol.
-    pl: vols.
+    sg: "vol. %"
+    pl: "vols. %"
+size:
+  page:
+    sg: "% p."
+    pl: "% pp."
+  volume:
+    sg: "% vol."
+    pl: "% vols."
+

data/lib/isodoc-yaml/i18n-es.yaml

@@ -1,2 +1,30 @@
 in: en
 at: en
+and: y
+updated: actualizado
+viewed: visto
+version: versión
+date:
+  month_year: yMMMM
+  day_month_year: to_long_s
+  date_time: to_long_s
+edition_number: ["OrdinalRules", "digits-ordinal-feminine"]
+edition: "% ed."
+draft: "borrador %"
+editor:
+  sg: ed.
+  pl: eds.
+extent:
+  page:
+    sg: "pág. %"
+    pl: "págs. %"
+  volume:
+    sg: "vol. %"
+    pl: "vols. %"
+size:
+  page:
+    sg: "% pág."
+    pl: "% págs."
+  volume:
+    sg: "% vol."
+    pl: "% vols."

data/lib/isodoc-yaml/i18n-fr.yaml

@@ -1,2 +1,30 @@
 in: dans
 at: à
+and: et
+updated: mise à jour
+viewed: vu
+version: version
+date:
+  month_year: yMMMM
+  day_month_year: to_long_s
+  date_time: to_long_s
+edition_number: ["OrdinalRules", "digits-ordinal-feminine"]
+edition: "% édition"
+draft: "brouillon %"
+editor:
+  sg: éd.
+  pl: éd.
+extent:
+  page:
+    sg: "p. %"
+    pl: "p. %"
+  volume:
+    sg: "vol. %"
+    pl: "vol. %"
+size:
+  page:
+    sg: "% p."
+    pl: "% p."
+  volume:
+    sg: "% vol."
+    pl: "% vol."

data/lib/isodoc-yaml/i18n-ru.yaml

@@ -5,19 +5,27 @@ updated: обновлен
 viewed: просмотрено
 version: версия
 date:
-  month_year: to_long_s
+  month_year: yMMMM
   day_month_year: to_long_s
   date_time: to_long_s
 edition_number: ["SpelloutRules", "spellout-ordinal-neuter"]
 edition: "% издание"
+draft: "проект %"
 editor:
   sg: изд.
   pl: изд.
 extent:
   page:
-    sg: стр.
-    pl: стр.
+    sg: "стр. %"
+    pl: "стр. %"
   volume:
-    sg: т.
-    pl: тт.
+    sg: "т. %"
+    pl: "тт. %"
+size:
+  page:
+    sg: "% стр."
+    pl: "% стр."
+  volume:
+    sg: "% т."
+    pl: "% тт."
 

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -1,2 +1,30 @@
 in: 在
 at: 在
+and: 和
+updated: 更新
+viewed: 看过
+version: 版本
+date:
+  month_year: yMMMM
+  day_month_year: to_long_s
+  date_time: to_long_s
+edition_number: ["OrdinalRules", "digits-ordinal"]
+edition: "第%版"
+draft: "草案%"
+editor:
+  sg: 编辑
+  pl: 编辑
+extent:
+  page:
+    sg: "第%页"
+    pl: "第%页"
+  volume:
+    sg: "第%卷"
+    pl: "第%卷"
+size:
+  page:
+    sg: "%页"
+    pl: "%页"
+  volume:
+    sg: "%卷"
+    pl: "%卷"

data/lib/relaton/render/fields/date.rb

@@ -0,0 +1,45 @@
+module Relaton
+  module Render
+    class Date
+      def initialize(date, options)
+        @date = date
+        @r = options[:renderer]
+      end
+
+      def render
+        return @date if @date.nil? || /^\d+$/.match?(@date)
+
+        render1(granularity)
+      end
+
+      def render1(format)
+        datef = dateparse(format, @r.lang.to_sym)
+        case @r.date[format]
+        when "to_full_s", "to_long_s", "to_medium_s", "to_short_s"
+          datef.send @r.date[format]
+        else
+          datef.to_additional_s(@r.date[format])
+        end
+      end
+
+      def granularity
+        case @date
+        when /^\d+-\d+$/ then "month_year"
+        when /^\d+-\d+-\d+$/ then "day_month_year"
+        else "date_time"
+        end
+      end
+
+      def dateparse(format, lang)
+        case format
+        when "date_time"
+          DateTime.parse(@date).localize(lang, timezone: "Zulu")
+        when "day_month_year"
+          DateTime.parse(@date).localize(lang, timezone: "Zulu").to_date
+        when "month_year"
+          DateTime.parse("#{@date}-01").localize(lang, timezone: "Zulu").to_date
+        end
+      end
+    end
+  end
+end