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

Create a new builder to generate profile documentation as an RTF file #27

Closed
admin-cimug opened this issue Aug 18, 2022 · 1 comment
Closed
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@admin-cimug
Copy link
Member

Currently CIMTool has an html.xsl builder that auto-generates HTML documentation corresponding to a profile. The effort required for the Part 3 through Part 9 teams to create tables in Word that properly reflect the classes/attributes in a profile is fairly time intensive. A request has been made for an equivalent builder to generate documentation for the profile in RTF format. The following is required:

  • Concrete Types, Abstract Types, Compound Types, Enumeration Types, and Simple Types should all be generated in a standalone RTF file.
  • The generated RTF should have bookmarks assigned to all classes with appropriate hyperlinks from the Type column in the tables to the corresponding Type definition in the document. This will allow for easy navigation between references within the documentation and will be especially useful for large profiles.
  • There should be 2 versions of the RTF generator. One that generates a full standalone file (i.e. rtf-profile-full.xsl) and another providing an "abbreviated" RTF file (i.e. rtf-profile-abbr.xsl) that contains only the Concrete Types and Abstract Types. This variant of the XSL transform builder will be used to copy/paste into IEC standards publications with the intent to have distinct and separate sections later in the document that contains Compound Types, Enumeration Types, and Simple Types "common" across all profiles in the IEC publication.
@admin-cimug admin-cimug self-assigned this Aug 18, 2022
@admin-cimug admin-cimug added this to the release-1.10.0.RC4 milestone Aug 18, 2022
@admin-cimug admin-cimug added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 18, 2022
@admin-cimug admin-cimug changed the title Create a new builder to generate profile documentation in RTF format Create a new builder to generate profile documentation as an RTF file Aug 18, 2022
@admin-cimug admin-cimug modified the milestones: release-1.10.0.RC4, release-1.10.0 Aug 25, 2022
@admin-cimug
Copy link
Member Author

admin-cimug commented Aug 31, 2022

Note: The abbreviated documentation builder (rtf-profile-abbr.xsl) was paused and not included in the work done for this issue. This will only be picked up if the members of the WG14 Part teams determine it is needed. If so issue #29 would also need to be reopened and the work done in parallel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant