metanorma-taste 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dac3951f0ecd001d25c14c8dd038a0791003678a4aebc43b7219039a6baa9f53
-  data.tar.gz: b29b383bd4b5c87865f34de13e5b62df26e55fc66990141745f3f86ce4a2929f
+  metadata.gz: 8f4a74f3a7d05b348f0321f8b705f4ee3be169f70e3fed955dcb61c668bf4a6a
+  data.tar.gz: aab5942f506ae7ecf610db8ab24290e8867cb8ed889e6e4ea5357f1ff9130a78
 SHA512:
-  metadata.gz: 89c8094961e1a59fd64ea25fca6bdf86243fe8fbac756fda96e3e62828098f5956d37fbe20bc9089787adff3f6d2918f4814c9be17a8bda353c156001bf3a163
-  data.tar.gz: ce5d4346fcd89bda667022ef984d2b93be8c49aeedf7adc4f5447e3f87fb4e5a33f35c12fead17a31da08ecd79fccd33e2a9af0e09282f872d04ace5942e07e4
+  metadata.gz: 57a9509823af08dbabc4266a4c6a54d88c34f9e2b9f5bc4c0f99d47094ce96423e5dbdb7d469e4d5f054d13d37e40b1a3fb228d04fdc8cb6996e950897594b23
+  data.tar.gz: 9e1ac2f9d11c7917e9daa8af65fcb9478ee876b2ebcf25ffc4cbe9e07df45ff5dd1256b370b65068fc2b536150fca1d47389feafbb54583529539c70f202d5a8

data/README.adoc

@@ -183,6 +183,7 @@ currently available:
 |MBx Interoperability Forum
 |`ribose`
 |MBx Interoperability Forum specifications and standards with MBx-IF branding and copyright
+
 |===
 
 
@@ -208,7 +209,10 @@ taste.
 === General
 
 A taste package is a directory structure that contains all the necessary files
-to define a Metanorma taste. It includes configuration files, copyright notices, internationalization dictionaries, and stylesheets if any.
+to define a Metanorma taste.
+
+It includes configuration files, copyright notices, internationalization
+dictionaries, and stylesheets if any.
 
 === Directory structure
 
@@ -313,8 +317,11 @@ doctype_dict:             # Document type translations
   # Add more document type mappings as needed
 ----
 
-Note that any taste-specific doctypes need to have a renderable corresponding entry under
-`doctype_dict`. The same is the case for the native doctypes in the base flavor's i18n.yaml files.
+Every taste-specific doctype is required to have a renderable corresponding
+entry under `doctype_dict`.
+
+The same is the case for the native doctypes in the base flavor's `i18n.yaml`
+files.
 
 .i18n.yaml example from ICC
 [example]
@@ -329,7 +336,10 @@ doctype_dict:
 
 ==== copyright.adoc
 
-Organization-specific copyright, legal, license and feedback text. This file can contain:
+This file supplies taste-specific copyright, legal, license and feedback
+text.
+
+This file can contain:
 
 * Copyright statements with template variables (e.g., `{{ docyear }}`)
 * License information
@@ -354,62 +364,151 @@ The file is in the Metanorma AsciiDoc format, with the following syntax:
 
 Copyright (c) {{ docyear }} Your Organization Name
 
-[Legal text here...]
+[legal text here...]
 
 == feedback-statement
-=== Contact Information
+=== Contact information
 
-[Organization contact details...]
+[organization contact details...]
 ----
 ====
 
-The same file format is used internally for Metanorma flavors, and is documented in
-https://www.metanorma.org/develop/topics/metadata-and-boilerplate/[Metadata and predefined text]
-on the metaorma.org site.
+The same file format is used internally for Metanorma flavors, and is documented
+in
+https://www.metanorma.org/develop/topics/metadata-and-boilerplate/[Metadata and predefined text].
+
+=== Base-override configuration
 
-=== Base-Override configuration
+==== General
 
 The `base-override` section allows customization of document attributes
-supported by the base flavor through two nested categories:
-
-==== Filename Attributes (`filename-attributes`)
-
-These are Metanorma document attributes that contain filenames and file paths:
-
-* `copyright-notice`: Path to boilerplate file containing copyright, license, and legal notices
-* `i18n-dictionary`: Path to internationalization dictionary
-* `publisher-logo`: Path to organization logo file
-* `htmlcoverpage`, `htmlintropage`: HTML output page templates
-* `htmlstylesheet`, `htmlstylesheet-override`: HTML CSS stylesheets
-* `wordcoverpage`, `wordintropage`: Word output page templates  
-* `wordstylesheet`, `wordstylesheet-override`: Word CSS stylesheets
-* `standardstylesheet`, `standardstylesheet-override`: Secondary Word CSS stylesheets
-* `header`: Word output header and footer content
-* `pdf-stylesheet`, `pdf-stylesheet-override`: PDF XSLT stylesheets
-* `customize`: Path to custom metanorma configuration file
-* `coverpage-image`, `backpage-image`: Cover and back page image files
-
-==== Value Attributes (`value-attributes`)
-
-These are Metanorma document attributes that contain values (not filenames):
-
-* `publisher`: Organization name
-* `publisher_abbr`: Organization abbreviation
-* `body-font`, `header-font`, `monospace-font`: Typography settings
-* `fonts`: Comma-delimited list of fonts to retrieve from Fontist
-* `output-extensions`: Comma-delimited list of supported output formats
-* `presentation-metadata-*`: Visual styling attributes for presentation, including:
-  ** `presentation-metadata-color-secondary`: Secondary color for styling
-  ** `presentation-metadata-backcover-text`: Text for document back cover
-  ** `presentation-metadata-ul-label-list`: Unordered list label formatting
-  ** `presentation-metadata-annex-delim`: Annex delimiter formatting
-  ** `presentation-metadata-middle-title`: Middle title formatting
-  ** `presentation-metadata-ol-label-template-alphabet`: Ordered list alphabet template
-  ** `presentation-metadata-ol-label-template-alphabet_upper`: Ordered list uppercase alphabet template
-  ** `presentation-metadata-ol-label-template-roman`: Ordered list roman numeral template
-  ** `presentation-metadata-ol-label-template-roman_upper`: Ordered list uppercase roman numeral template
-  ** `presentation-metadata-ol-label-template-arabic`: Ordered list arabic numeral template
-* Custom organization-specific attributes
+supported by the base flavor through two categories.
+
+The reason for this division is that some attributes contain file paths relative
+to the taste definition, while others contain simple values that are not
+relevant to path resolution.
+
+* Filename attributes are used to point to custom files provided by the taste,
+under the `data/{taste}/` directory.
++
+[example]
+====
+When `:publisher-logo: {logo-file-path}` is defined in the taste's
+`config.yaml`, the actual logo file is expected to be located at
+`data/{taste}/{logo-file-path}`.
+
+When `:publisher-logo: {logo-file-path}` is defined as a document
+attribute in the input document, the logo file is expected to be located
+relative to the input document's location at
+`{input-document-directory}/{logo-file-path}`.
+====
+
+* Value attributes are simple values (strings, numbers, lists) that do not
+involve file paths. These attributes are identical whether defined in the
+taste's `config.yaml` or as document attributes in the input document.
++
+[example]
+====
+`:publisher_abbr: {abbreviation}` is a simple string value and does not
+involve any file path resolution.
+====
+
+
+==== Filename attributes (`filename-attributes`)
+
+These are Metanorma document attributes that take file paths as values.
+
+`copyright-notice`::
+Path to boilerplate file containing copyright, license, and legal notices
+
+`i18n-dictionary`::
+Path to internationalization dictionary
+
+`publisher-logo`::
+Path to organization logo file
+
+`htmlcoverpage`, `htmlintropage`::
+HTML output page templates
+
+`htmlstylesheet`, `htmlstylesheet-override`::
+HTML CSS stylesheets
+
+`wordcoverpage`, `wordintropage`::
+Word output page templates
+
+`wordstylesheet`, `wordstylesheet-override`::
+Word CSS stylesheets
+
+`standardstylesheet`, `standardstylesheet-override`::
+Secondary Word CSS stylesheets
+
+`header`::
+Word output header and footer content
+
+`pdf-stylesheet`, `pdf-stylesheet-override`::
+PDF XSLT stylesheets
+
+`customize`::
+Path to custom metanorma configuration file
+
+`coverpage-image`, `backpage-image`::
+Cover and back page image files
+
+
+==== Value attributes (`value-attributes`)
+
+These are Metanorma document attributes that contain path-independent values.
+
+`publisher`::
+Organization name
+
+`publisher_abbr`::
+Organization abbreviation
+
+`body-font`, `header-font`, `monospace-font`::
+Typography settings
+
+`fonts`::
+Comma-delimited list of fonts to retrieve from Fontist
+
+`output-extensions`::
+Comma-delimited list of supported output formats
+
+`presentation-metadata-*`::
+Visual styling attributes for presentation, including:
+
+`presentation-metadata-color-secondary`:::
+Secondary color for styling
+
+`presentation-metadata-backcover-text`:::
+Text for document back cover
+
+`presentation-metadata-ul-label-list`:::
+Unordered list label formatting
+
+`presentation-metadata-annex-delim`:::
+Annex delimiter formatting
+
+`presentation-metadata-middle-title`:::
+Middle title formatting
+
+`presentation-metadata-ol-label-template-alphabet`:::
+Ordered list alphabet template
+
+`presentation-metadata-ol-label-template-alphabet_upper`:::
+Ordered list uppercase alphabet template
+
+`presentation-metadata-ol-label-template-roman`:::
+Ordered list roman numeral template
+
+`presentation-metadata-ol-label-template-roman_upper`:::
+Ordered list uppercase roman numeral template
+
+`presentation-metadata-ol-label-template-arabic`:::
+Ordered list arabic numeral template
+
+Custom organization-specific attributes::
+These are any additional attributes supported by the base flavor or taste.
 
 The availability of these attributes depends on the base flavor's supported
 document attributes and template system.
@@ -421,14 +520,19 @@ flavor documentation for available attributes.
 
 == Mappings of structures from taste to base flavours
 
-The taste configuration includes various document classifications which need to be
-mapped between values specific to the taste, and corresponding values in the base flavor.
-The document will actually be compiled with the base flavor settings, but it will be
-rendered using the taste's corresponding values. These includes
+The taste configuration includes various document classifications which need to
+be mapped between values specific to the taste, and corresponding values in the
+base flavor.
+
+The document will actually be compiled with the base flavor settings, but it
+will be rendered using the taste's corresponding values.
+
+These include:
 
 * `doctype`: mapping of taste doctypes to native base flavor doctypes
 * `stage`: mapping of taste stages to native base flavor stages
 
+
 == Data model
 
 The metanorma-taste system follows this architecture:
@@ -474,11 +578,19 @@ content for each taste.
 
 === Workflow
 
-. Discovery: On gem load, `TasteRegister` scans `data/` directory for taste configurations
+. Discovery: On gem load, `TasteRegister` scans `data/` directory for taste
+configurations
+
 . Registration: Each valid taste directory is registered with its configuration
-. Access: Users call `TasteRegister.get(:flavor)` to obtain a configured taste instance
-. Processing: The taste instance applies overrides and customizations to document attributes
-. Integration: The customized attributes are used by Metanorma for document processing
+
+. Access: Users call `TasteRegister.get(:flavor)` to obtain a configured taste
+instance
+
+. Processing: The taste instance applies overrides and customizations to
+document attributes
+
+. Integration: The customized attributes are used by Metanorma for document
+processing
 
 
 [[creating-a-taste]]
@@ -493,10 +605,15 @@ configuration directory with the necessary files.
 
 To create a new taste:
 
-. Create directory: Add a new directory under `data/` with your unique taste code
+. Create directory: Add a new directory under `data/` with your unique taste
+code
+
 . Add configuration: Create `config.yaml` with your taste settings
+
 . Add content: Optionally add `copyright.adoc` and `i18n.yaml` files
-. Test: The taste will be automatically discovered and available via the TasteRegister
+
+. Test: The taste will be automatically discovered and available via the
+TasteRegister
 
 Example for a new `acme` taste:
 

data/data/csa/csa.standard.xsl

@@ -608,11 +608,19 @@
 	</xsl:template>
 
 	<xsl:template name="insertHeaderFooter">
+		<xsl:call-template name="insertHeader"/>
+		<xsl:call-template name="insertFooter"/>
+	</xsl:template>
+
+	<xsl:template name="insertHeader">
 		<fo:static-content flow-name="header" role="artifact">
 			<fo:block-container height="2.5mm" background-color="{$color-header-document}">
 				<fo:block font-size="1pt"> </fo:block>
 			</fo:block-container>
 		</fo:static-content>
+	</xsl:template>
+
+	<xsl:template name="insertFooter">
 		<fo:static-content flow-name="footer" role="artifact">
 			<fo:block-container font-family="Azo Sans Lt" font-size="10.1pt" height="100%" display-align="after"> <!-- 11.5pt -->
 				<fo:block padding-bottom="13mm" text-align="right" color="rgb(144, 144, 144)">

data/data/mbxif/config.yaml

@@ -7,7 +7,7 @@ base-override:
     copyright-notice: copyright.adoc
     i18n-dictionary: i18n.yaml
     publisher-logo: mbxif-logos_mbxif.svg
-    pdfstylesheet-override: mbxif.xsl
+    pdf-stylesheet-override: mbxif.xsl
     coverpage-image: mbxif-front-cover.pdf
     backpage-image: mbxif-back-cover.pdf
   value-attributes:

data/data/pdfa/config.yaml

@@ -9,7 +9,7 @@ base-override:
     publisher-logo: pdfa-logo.svg
     htmlcoverpage: htmlcoverpage.html
     htmlstylesheet-override: htmlstylesheet-override.scss
-    pdfstylesheet-override: pdfa.xsl
+    pdf-stylesheet-override: pdfa.xsl
   value-attributes:
     publisher: PDF Association
     publisher_abbr: PDF Association

data/data/swf/config.yaml

@@ -7,7 +7,7 @@ base-override:
     copyright-notice: copyright.adoc
     i18n-dictionary: i18n.yaml
     publisher-logo: swf-logo.svg
-    pdfstylesheet-override: swf.xsl
+    pdf-stylesheet-override: swf.xsl
     coverpage-image: swf-front-cover.pdf
     backpage-image: swf-back-cover.pdf
   value-attributes:

data/lib/metanorma/taste/version.rb

@@ -2,6 +2,6 @@
 
 module Metanorma
   module Taste
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-taste
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-29 00:00:00.000000000 Z
+date: 2025-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model