Documentation: Chapter numbers #133
Milestone
Comments
jmaerki
added a commit
to jmaerki/OJP
that referenced
this issue
Mar 17, 2021
sgrossberndt
pushed a commit
that referenced
this issue
Aug 25, 2021
As explained in detail in docs/README.md the rendering of the documentation tables has received a complete overhaul by @jmaerki removing the interim asciidoc step and fixing the known rendering issues. * Mandatory elements in bold (#136) Improve code reuse. * Table for single element types. (#140) * Better build-up of tables to avoid asciidoc syntax problems. (#137) * Enumerations list their possible values. (#134) Fixed a problem with automatic table headers. Fixed a problem with nested structures and table building. * Fixed filename in documentation. (#139) * Typo: Removed trailing dot from element name. (#139) * Full cross-references for all locally defined elements. (#139) * Mandatory elements in bold also on first column. (#136) * Improved anchor and links for schema's h2. (#139) * Enabled section/chapter numbering. (#133) * Unified depth handling. Properly document attributes. * Fixed bad selection for generating text. * Additional column for choices (a-z) as in previous Word-based documentation. (#143) * Separate stylesheet for checking XML Schema conventions or mistakes in the OJP Schemas. (#153) * Just drop the current version * Rewrite of the documentation generation: new stylesheets generate an intermediate XML files and from that directly an HTML file without going through asciidoc.css. ojp-to-asciidoc.xsl is not basically obsolete and can be deleted when all issues are resolved. Refs now resolve their type information. (#138) * Added documentation for the generation process. Cleanup for the stylesheets. Deprecated the old ojp-to-asciidoc.xsl. * Ignore generated intermediate file. * Added link to deployed HTML file on GitHub Pages. * Removed project-specific link again. * Added substitutionGroup attribute handling. * Added some color to check-ojp-schemas.sh. Set exit code based on check results. Integrate into travis CI. (#153) * Typo. (#154) * Added missing options for resolved groups. (#165) * Removed obsolete stylesheet. (#154) * More cleanup according to feedback. (#154)
sgrossberndt
pushed a commit
that referenced
this issue
Aug 25, 2021
As explained in detail in docs/README.md the rendering of the documentation tables has received a complete overhaul by @jmaerki removing the interim asciidoc step and fixing the known rendering issues. * Mandatory elements in bold (#136) Improve code reuse. * Table for single element types. (#140) * Better build-up of tables to avoid asciidoc syntax problems. (#137) * Enumerations list their possible values. (#134) Fixed a problem with automatic table headers. Fixed a problem with nested structures and table building. * Fixed filename in documentation. (#139) * Typo: Removed trailing dot from element name. (#139) * Full cross-references for all locally defined elements. (#139) * Mandatory elements in bold also on first column. (#136) * Improved anchor and links for schema's h2. (#139) * Enabled section/chapter numbering. (#133) * Unified depth handling. Properly document attributes. * Fixed bad selection for generating text. * Additional column for choices (a-z) as in previous Word-based documentation. (#143) * Separate stylesheet for checking XML Schema conventions or mistakes in the OJP Schemas. (#153) * Just drop the current version * Rewrite of the documentation generation: new stylesheets generate an intermediate XML files and from that directly an HTML file without going through asciidoc.css. ojp-to-asciidoc.xsl is not basically obsolete and can be deleted when all issues are resolved. Refs now resolve their type information. (#138) * Added documentation for the generation process. Cleanup for the stylesheets. Deprecated the old ojp-to-asciidoc.xsl. * Ignore generated intermediate file. * Added link to deployed HTML file on GitHub Pages. * Removed project-specific link again. * Added substitutionGroup attribute handling. * Added some color to check-ojp-schemas.sh. Set exit code based on check results. Integrate into travis CI. (#153) * Typo. (#154) * Added missing options for resolved groups. (#165) * Removed obsolete stylesheet. (#154) * More cleanup according to feedback. (#154)
|
Solved with #154 |
|
Removed documentation label - completed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I think, chapter numbers for each described type or top level element could be helpful concerning readability. Scanning through the content list and through the document would be easier.
The text was updated successfully, but these errors were encountered: