-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CLI should allow building collection #205
Comments
Agreed. I would further add that the collection YAML (si-brochure-bilingual.yml) and the site YAML (collection.yml) MUST be kept separate: it would be a mistake to bind them tightly. The file name of the collection YAML should be one of the entries in the site YAML. |
Here's an example from bipm-si-brochure. In si-brochure-bilingual.yml, you can see a number of options have been moved from the command line into an option in this YAML. ---
metanorma:
source:
files:
...
- sources/si-brochure-en.adoc
- sources/si-brochure-fr.adoc
# The Collection
- sources/si-brochure-bilingual.yml
collection:
organization: "BIPM - Bureau International des Poids et Mesures"
name: "SI Brochure edition 9, semantic encoded version" directives:
- documents-inline
bibdata:
title:
- language: en
content: The International System of Units (SI)
- language: fr
content: Le Système international d’unités (SI)
type: collection
docid:
type: bipm
id: sibrochure
edition: 9
date:
- type: updated
value: 2019-05-20
copyright:
owner:
name: Bureau International des Poids et Mesures
abbreviation: BIPM
from: 2019
# TODO, was CLI option, not yet supported
output_dir: bilingual-brochure
# TODO, was CLI option, not yet supported
formats:
- xml
- html
- presentation
- pdf
manifest:
level: brochure
title: Brochure/Brochure
# TODO, not yet supported
# Option 1, specify built files
# Option 2, specify source if not built
documents: # was `docref`
- source: si-brochure-fr.adoc
identifier: si-brochure-fr
# was `fileref`
rendered: site/documents/si-brochure-fr.xml
- identifier: si-brochure-en
source: si-brochure-en.adoc
rendered: site/documents/si-brochure-en.xml
# TODO, was CLI option, not yet supported
cover: collection_cover.html
prefatory-content:
|
final-content:
| Desired compile command:
|
Here's the relevant PR metanorma/bipm-si-brochure#86 that we want to make working. |
@ronaldtse: I think this was resolved by #260, can we close this one or is there anything else? |
ping @ronaldtse, @opoudjis ⬆️ |
@abunashir have you updated metanorma/bipm-si-brochure#86 to use the new functionality? |
Yes, I've updated the supported attributes here - metanorma/bipm-si-brochure@5b6d657, so it's there from the cli side. For the changes on the core attributes we still need to do that to the metnorma itself. I can do that, but is there any concern renaming those attributes in metanorma @opoudjis? |
Thank you @abunashir ! We want to implement the changes to the inclusion attributes too: Can you please help implement them in metanorma-cli? Thanks! |
@abunashir I've tried this locally and there are several problems. I will list out the problems individually. |
In the CLI implementation today we cannot build a metanorma collection.
This is how we do it now:
The second line builds a metanorma collection using the config file
si-brochure-bilingual.yml
.I believe we can integrate this command into the configuration file for
site generate
. We might even want to clarify the roles of the commands:compile
,collection
andsite
so they have different functions.Ping @abunashir and @CAMOBAP for thoughts.
The text was updated successfully, but these errors were encountered: