Skip to content
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

Add support for "brochure" document type's independently published appendices #5

Closed
ronaldtse opened this issue Sep 19, 2020 · 27 comments
Assignees
Labels
enhancement New feature or request

Comments

@ronaldtse
Copy link
Contributor

Appendix 4 of the SI brochure is published within the SI brochure, and also published separately.

Independent document:
https://www.bipm.org/utils/common/pdf/si-brochure/SI-Brochure-9-App4-EN.pdf
Screen Shot 2020-09-19 at 6 25 07 PM

Within SI brochure (page 202 to 210):
https://www.bipm.org/utils/common/pdf/si-brochure/SI-Brochure-9.pdf
Screen Shot 2020-09-19 at 6 24 32 PM

The document sources are provided in https://github.com/metanorma/bipm-si-brochure/tree/master/sources as
sib-a4-en.adoc and
sib-a4-fr.adoc.

@ronaldtse ronaldtse added the enhancement New feature or request label Sep 19, 2020
@ronaldtse ronaldtse added this to Needs triage in Nick Nicholas via automation Sep 21, 2020
@ronaldtse ronaldtse moved this from Needs triage to High priority in Nick Nicholas Sep 21, 2020
@ronaldtse
Copy link
Contributor Author

Mockup of an independent Appendix.
Screen Shot 2020-09-21 at 11 00 34 AM

@ronaldtse ronaldtse moved this from High priority to Current in Nick Nicholas Sep 21, 2020
@opoudjis
Copy link
Contributor

opoudjis commented Sep 25, 2020

This will end up similar to what was done with ITU, with annextitle and annexid:

  • The document has the same title as the main document
    • Although because of poor consistency, the separate publication actually treats the title of the main document as "SI Brochure" instead.
  • The document has a distinct appendix-title
  • The document also has a distinct appendix identifier. In ITU, that is treated as part of the structured identifier, along with the part number.

opoudjis added a commit to metanorma/metanorma-model-iso that referenced this issue Sep 25, 2020
opoudjis added a commit to metanorma/metanorma-model-bipm that referenced this issue Sep 25, 2020
@opoudjis
Copy link
Contributor

However, I am NOT treating this as a separate document type: I have no reason to think other document types might not also publish their appendixes separately. Instead, separate appendix publications shall be detected by the presence of an appendix ID in the structured identifier, but they shall otherwise have the same document type as their parent.

opoudjis added a commit that referenced this issue Sep 25, 2020
opoudjis added a commit that referenced this issue Sep 25, 2020
opoudjis added a commit that referenced this issue Sep 25, 2020
@ronaldtse
Copy link
Contributor Author

ronaldtse commented Sep 28, 2020

separate appendix publications shall be detected by the presence of an appendix ID in the structured identifier, but they shall otherwise have the same document type as their parent

Agree. Renamed title.

@ronaldtse ronaldtse changed the title Add support for document type "appendix" Add support for "brochure" document type's independently published appendices Sep 28, 2020
@opoudjis opoudjis moved this from Current to On hold in Nick Nicholas Sep 28, 2020
@opoudjis
Copy link
Contributor

opoudjis commented Oct 6, 2020

@Intelligent2013 As with the other BIPM issues I've worked on, this is on hold for me, pending input from you.

@Intelligent2013 Intelligent2013 added this to To do in Alexander Dyuzhev via automation Oct 6, 2020
@Intelligent2013
Copy link
Contributor

@opoudjis
BIPM XSLT will process xml to produce PDF in such manner:

  1. If input xml contains structuredidentifier/appendix, then bipm brochure xslt will be produce PDF with appendices only as independent document with design from SI-Brochure-9-App4-EN.pdf. One xml -> one pdf.
  2. To pass appendix xml(s) into bipm brochure xslt to produce brochure together with appendices, I'll use the parameter --param appendicesXMLs for mn2pdf, for example:
java -jar mn2pdf.jar --xml-file collection.presentation.xml  --xsl-file bipm.brochure.presentation.xsl  -o out.pdf  --param appendicesXMLs="sib-a4-fr.presentation.xml,sib-a4-en.presentation.xml"

@Intelligent2013
Copy link
Contributor

Here is resulted PDFs for independently published appendices:
sib-a4-fr.presentation.pdf
sib-a4-en.presentation.pdf

@opoudjis in source XML this data are absent:
изображение

to produce a cover page. Could you add it please? (I've hardcoded it in xslt temporarely)

@Intelligent2013
Copy link
Contributor

I think no need to add a parameter appendicesXMLs processing into mn2pdf (to pass appendix xml(s) into bipm brochure xslt to produce a brochure together with appendices), because source XML contains appendix yet.

@ronaldtse
Copy link
Contributor Author

@Intelligent2013 this is the latest design from our designer. Could you help update the PDF styling for appendices? Thanks!

SI Appendix_v2.pdf

@Intelligent2013
Copy link
Contributor

this is the latest design from our designer. Could you help update the PDF styling for appendices? Thanks!

@ronaldtse I've confused a bit, looks like SI Appendix_v2.pdf is MEP document. But Appendix 4 is "brochure" document type.
Should I use one design from 'SI Appendix_v2.pdf' for both independently appendices types "brochure" and "mise-en-pratique"?

@opoudjis
Copy link
Contributor

opoudjis commented Oct 12, 2020

@Intelligent2013

To pass appendix xml(s) into bipm brochure xslt to produce brochure together with appendices, I'll use the parameter --param appendicesXMLs for mn2pdf, for example:

OK, but I am generating the appendixes XML as part of the brochure already, through AsciiDoc includes. So I do not need to invoke --param appendicesXMLs , do I? If the XML you have been getting is working, then I do not need to change anything.

@Intelligent2013
Copy link
Contributor

OK, but I am generating the appendixes XML as part of the brochure already, through Asciidoctor includes. So I do not need to invoke --param appendicesXMLs , do I? If the XML you have been getting is working, then I do not need to change anything.

@opoudjis Actually I've refused my proposal (#5 (comment)), so you do not need to change anything.

@opoudjis
Copy link
Contributor

In that case nothing further for me to do that I can see, and I am unassigning myself from this ticket.

@opoudjis
Copy link
Contributor

opoudjis commented Oct 15, 2020

"1". I've manually added 2 into source XML, because design PDF has this number, but xml source doesn't.

Changed source: we're using :appendix-id: not :appendix:

"2". Titles hard-coded in xlst, no such data in source xml.

The documents currently think the title of the parent document is "SI Brochure"/"Brochure sur le SI", because that's what the mockup said. "This should be supplied in the source XML (the source asciidoc)"? You should be telling me to beforehand.

Changed in source.

  1. You want bilingual committee names now? Again: You should be telling me to beforehand.

Implementing bilingual committee names. @Intelligent2013 I will be using the variant tag to do so:

<committee acronym="CCTF><variant language="fr">Comité consultatif du temps et des fréquences</variant><variant language="en">Consultative Committee for Time and Frequency</variant></committee>

@opoudjis
Copy link
Contributor

Need to add lang and script to metadata vector, in order to pick variants in Liquid metadata vector matching current language

opoudjis added a commit to metanorma/isodoc that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-generic that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/isodoc that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-csa that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-cc that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-gb that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-iec that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-iho that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-itu that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-m3aawg that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-iso that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-mpfa that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-ogc that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-ribose that referenced this issue Oct 15, 2020
opoudjis added a commit to metanorma/metanorma-un that referenced this issue Oct 15, 2020
opoudjis added a commit that referenced this issue Oct 15, 2020
@opoudjis opoudjis moved this from Current to On hold in Nick Nicholas Oct 15, 2020
@opoudjis
Copy link
Contributor

Am compiling and sending updated files to @Intelligent2013

Intelligent2013 added a commit to metanorma/mn-native-pdf that referenced this issue Oct 15, 2020
@ronaldtse
Copy link
Contributor Author

BIPM feedback provided in #32 and #33

@ronaldtse
Copy link
Contributor Author

@opoudjis please close this if these document types are already properly implemented in gem. The remaining work are tweaks/bug fixes.

@ronaldtse
Copy link
Contributor Author

Closing this since the documents are properly generated (pending #32 and #33)

Nick Nicholas automation moved this from On hold to Closed Oct 23, 2020
Alexander Dyuzhev automation moved this from To do to Done Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Nick Nicholas
  
Closed
Development

No branches or pull requests

3 participants