Is your feature request related to a problem? Please describe:
Putting this as a CIMTool issue because we want to at least run the 'final' case though CIMTool expertise to make sure it looks good. We want to have a common approach for the headers/variables in IEC document generation via CIMTool.
Describe the solution you'd like:
Currently, for the UCAiug-CIM repo, we intend to have multiple branches, covering major releases, like CIM101 and/or CIM17, CIM18, and feature branches. We expect to generate IEC documentation in a typical way, with master information like the example for IEC61968-11 (see Additional Context).
This will likely require some further investigation and trial and error to ensure we have the correct:
- Direct/indirect paths
- Any special variables for CIMTool/Builders such as metanorma mode, to render items in a preview
- Sequence of variables for CIMTool, IEC, other documents (as needed)
- Specialized styles/themes
- Generally agreed upon convention for document sections in the includedir (or includesdir)
- Commented out lines to help describe the content
Describe alternatives you've considered:
This is based on Metanorma's iec-rice.adoc model (https://github.com/metanorma/mn-samples-iec/blob/main/sources/iec-rice-en.adoc?plain=1) and the ongoing work for CGMES. It absolutely needs correction but I wanted to provide a starting point for now. We can track changes and improvements.
Additional context:
= Common information model (CIM) extensions for operation support
//==================================================================
// Following is the "header" attributes defined for this asciidoc
//==================================================================
//----- Directory definitions used throughout the doc -----
:plantuml-image-format: svg
:profilesdir: {docdir}/../Profiles
:includedir: {docdir}/Includes
:imagedir: {docdir}/Images
:codedir: {docdir}/Code
//
:metanormamode:
:docnumber: 17301d
:tc-docnumber: 61968
:partnumber: 11
:edition: 4
:revdate: 2016-05-01
:copyright-year: 2016
:language: en
:unchangeddate: 2025
:title-intro-en: INTERNATIONAL ELECTROTECHNICAL COMMISSION
:title-main-en: ENTERPRISE BUSINESS FUNCTION INTERFACES FOR UTILITY OPERATIONS
:title-part-en: Common information model (CIM) extensions for operation support
:doctype: international-standard
:docstage: 1
:docsubstage: 1
:draft:
:status: draft
:technical-committee-number: 57
:technical-committee: Power systems management and associated information exchange
:subcommittee-number: 14
:toc:
:sectnumlevels: 7
:stem:
:xrefstyle: short
:appendix-caption: Annex
:appendix-refsig: Annex
:section-refsig: Clause
:table-caption: Table
:example-caption: Figure
:docfile: template_IEC61968-11.adoc
:imagesdir: images
:mn-document-class: iec
:mn-output-extensions: xml,doc,html,pdf,rxl
:local-cache:
:data-uri-image:
include::Includes/template_IEC61968-11_title.adoc[]
include::Includes/template_IEC61968-11_forward.adoc[]
include::Includes/template_IEC61968-11_introduction.adoc[]
include::Includes/template_IEC61968-11_scope.adoc[]
include::Includes/template_IEC61968-11_normative-references.adoc[]
include::Includes/template_IEC61968-11_terms.adoc[]
include::Includes/template_IEC61968-11_cim-specification.adoc[]
include::Includes/template_IEC61968-11_detailed-model.adoc[]
include::Includes/template_IEC61968-11_top-package-iec61968.adoc[]
include::Includes/template_IEC61968-11_bibliography.adoc[]
Is your feature request related to a problem? Please describe:
Putting this as a CIMTool issue because we want to at least run the 'final' case though CIMTool expertise to make sure it looks good. We want to have a common approach for the headers/variables in IEC document generation via CIMTool.
Describe the solution you'd like:
Currently, for the UCAiug-CIM repo, we intend to have multiple branches, covering major releases, like CIM101 and/or CIM17, CIM18, and feature branches. We expect to generate IEC documentation in a typical way, with master information like the example for IEC61968-11 (see Additional Context).
This will likely require some further investigation and trial and error to ensure we have the correct:
Describe alternatives you've considered:
This is based on Metanorma's iec-rice.adoc model (https://github.com/metanorma/mn-samples-iec/blob/main/sources/iec-rice-en.adoc?plain=1) and the ongoing work for CGMES. It absolutely needs correction but I wanted to provide a starting point for now. We can track changes and improvements.
Additional context:
= Common information model (CIM) extensions for operation support
//==================================================================
// Following is the "header" attributes defined for this asciidoc
//==================================================================
//----- Directory definitions used throughout the doc -----
:plantuml-image-format: svg
:profilesdir: {docdir}/../Profiles
:includedir: {docdir}/Includes
:imagedir: {docdir}/Images
:codedir: {docdir}/Code
//
:metanormamode:
:docnumber: 17301d
:tc-docnumber: 61968
:partnumber: 11
:edition: 4
:revdate: 2016-05-01
:copyright-year: 2016
:language: en
:unchangeddate: 2025
:title-intro-en: INTERNATIONAL ELECTROTECHNICAL COMMISSION
:title-main-en: ENTERPRISE BUSINESS FUNCTION INTERFACES FOR UTILITY OPERATIONS
:title-part-en: Common information model (CIM) extensions for operation support
:doctype: international-standard
:docstage: 1
:docsubstage: 1
:draft:
:status: draft
:technical-committee-number: 57
:technical-committee: Power systems management and associated information exchange
:subcommittee-number: 14
:toc:
:sectnumlevels: 7
:stem:
:xrefstyle: short
:appendix-caption: Annex
:appendix-refsig: Annex
:section-refsig: Clause
:table-caption: Table
:example-caption: Figure
:docfile: template_IEC61968-11.adoc
:imagesdir: images
:mn-document-class: iec
:mn-output-extensions: xml,doc,html,pdf,rxl
:local-cache:
:data-uri-image:
include::Includes/template_IEC61968-11_title.adoc[]
include::Includes/template_IEC61968-11_forward.adoc[]
include::Includes/template_IEC61968-11_introduction.adoc[]
include::Includes/template_IEC61968-11_scope.adoc[]
include::Includes/template_IEC61968-11_normative-references.adoc[]
include::Includes/template_IEC61968-11_terms.adoc[]
include::Includes/template_IEC61968-11_cim-specification.adoc[]
include::Includes/template_IEC61968-11_detailed-model.adoc[]
include::Includes/template_IEC61968-11_top-package-iec61968.adoc[]
include::Includes/template_IEC61968-11_bibliography.adoc[]