New documentation rendering #154
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Improve code reuse.
Fixed a problem with automatic table headers. Fixed a problem with nested structures and table building.
Properly document attributes.
…n the OJP Schemas. (VDVde#153)
|
Could you update to the latest state here please? |
sgrossberndt
requested changes
May 6, 2021
…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. (VDVde#138)
Cleanup for the stylesheets. Deprecated the old ojp-to-asciidoc.xsl.
Set exit code based on check results. Integrate into travis CI. (VDVde#153)
This was referenced May 31, 2021
|
I think I'm finally done with pretty much all open issues. |
|
Hello @jmaerki, please rebase this pull request so we can merge it. |
|
I'm not a daily Git user and have never worked with rebase and do not yet know exactly how that works. I currently lack the time to educate myself on it in order not to mess up. So I've done what I could and just merged the latest changes on changes_for_v1.1 to the doc_issues branch. I hope this is enough. In case it is not, I've added write access to @sgrossberndt to my repo in the hopes that this helps. Otherwise, please allow a few more days so I can make time to educate myself on "rebase". |
sgrossberndt
requested changes
Aug 2, 2021
|
Hi @jmaerki , could you please update this pull request? |
|
Done. Sorry for the delay. Busy times. |
sgrossberndt
approved these changes
Aug 23, 2021
skinkie
approved these changes
Aug 25, 2021
|
Rendering can be seen here: https://jmaerki.github.io/OJP/generated/OJP.html#PointOfInterestRefStructure |
sgrossberndt
pushed a commit
that referenced
this pull request
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)
This was referenced Apr 25, 2022
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As per the last telco, I present my first merge request for documentation changes on the 1.1 branch. This work is still ongoing.