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

Revision history is not being generated #958

Open
anermina opened this issue Jan 11, 2025 · 3 comments
Open

Revision history is not being generated #958

anermina opened this issue Jan 11, 2025 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@anermina
Copy link

The revision history, encoded according to the guidance at https://www.metanorma.org/author/topics/metadata/history/, is not generated in the HTML, DOC, and PDF outputs.

I have also tested the example provided on the website, with the same result.

Here is an example of the .adoc file:

= Test
:docnumber: 1011
:copyright-year: 2010
:language: en
:doctype: report
:edition: 1
:revdate: 2010-09-13
:published-date: 2010-09-13
:technical-committee: XML
:mn-document-class: cc
:mn-output-extensions: xml,html,pdf,rxl,doc
:local-cache-only:
:fullname: Ed
:role: editor

[.preface]
== metanorma-extension

=== document history

[source,yaml]
----
- date:
  - type: published
    value:  2012-04
  edition: 1.0.0
  contributor:
  - person:
      name:
        abbreviation: JMS
        completename: J. Michael Straczynski
  amend:
    - description: Approved edition of S-102
- date:
  - type: updated
    value:  2017-03
  edition: 2.0.0
  contributor:
  - organization:
      name: S-102PT
  amend:
    - description: |
        Updated clause 4.0 and 12.0.

        Populated clause 9.0.
      location:
        - clause=4.0
        - clause=12.0
        - clause=9.0
      classification:
        - tag: severity
          value: major
        - tag: type
          value: editorial
    - description: Deleted contents of Annex B in preparation for updated S-100 Part 10C guidance.
      location:
        - annex=B
----

== section

text...
@opoudjis
Copy link
Contributor

The revision history is processed across all of Metanorma, but it is only rendered in those flavours that we have explicitly defined to deal with it: IHO | NIST | OGC | BSI

We have not defined a rendering for CalConnect, so one is not showing up.

Could we have a fallback rendering across Metanorma, for those flavours where a rendering is not defined? Yes. I think we can just use IHO's, which looks reasonably straightforward. That said, I think it would also be reasonable for the more tightly defined flavours (those aligned to ISO) to ignore it.

@ronaldtse
Copy link
Contributor

I have a proposal for revision history. Why not use lutaml-model to parse it, and you can have it in liquid for free? Then we can provide a template per flavor.

@ronaldtse
Copy link
Contributor

ronaldtse commented Feb 28, 2025

@opoudjis @anermina I have created revix a new gem that handles revision history. We can integrate that with Metanorma in the future:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: 🌋 Urgent
Development

No branches or pull requests

3 participants