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.

Sign up for GitHub

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

Jump to bottom

Documentation malformed NumberOfResults / BaseTripPolicy #165

Closed
skinkie opened this issue Jun 24, 2021 · 5 comments
Closed

Documentation malformed NumberOfResults / BaseTripPolicy #165

skinkie opened this issue Jun 24, 2021 · 5 comments

Comments

@skinkie
Copy link
Contributor

skinkie commented Jun 24, 2021

image
jmaerki added a commit to jmaerki/OJP that referenced this issue Jun 25, 2021
@jmaerki
Added missing options for resolved groups. (VDVde#165)
78ebc1a
@jmaerki
Copy link
Contributor

jmaerki commented Jun 25, 2021

Thanks, should be fixed now.

@schlpbch
Copy link

schlpbch commented Jun 25, 2021 •
edited
Loading

image

This suggests that PointOfInterestRef is of type PointOfInterestRef which would be an infinite loop.

@jmaerki
Copy link
Contributor

jmaerki commented Jun 25, 2021

Yes, that's a consequence of the documentation rules where I remove the "Structure" Suffix. How would you expect this to be resolved? I can't just remove the "Ref" at the end because that would create another conflict between "PointOfInterestRef", "PointOfInterestRefStructure" and "PointOfInterest". Same for "TopographicPlace*". The only way out is to remove the rule that removes the "Structure" Suffix.

@skinkie skinkie mentioned this issue Aug 25, 2021
Closed
@sgrossberndt
Copy link
Contributor

In order not to bloat the table we will keep the removal of the "Type" and "Structure" suffix. It is documented as well in the word file:

In order to save space, data types have been truncated. So endings like “Structure” and “Type” are not written out. Instead of “InternationalTextStructure” the data type will be indicated as “InternationalText”.

sgrossberndt pushed a commit that referenced this issue Aug 25, 2021
@jmaerki
New documentation rendering (#154)
adbe375 
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
@jmaerki @sgrossberndt
New documentation rendering (#154)
46d8783 
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)
@trurlurl
Copy link
Contributor

trurlurl commented Oct 2, 2022

Removed documentation label as the documentation-related work has been done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@skinkie @jmaerki @sgrossberndt @schlpbch @trurlurl