search

VDVde / OJP

Open API for distributed journey planning. CEN/TS 17118:2017.
https://www.vdv.de/open-journey-planner.aspx
22 stars 12 forks source link

Resolve the infinite loop in the documentation #172

Closed skinkie closed 1 year ago

skinkie commented 3 years ago

As brought up in #165 by @schlpbch. Not a show stopper, but we may think about a solution about it.

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

@jmaerki replied:

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.

ue71603 commented 2 years ago

The answer of Jeremias is there. The linking in HTML is correct, but in prose strange. He suggests that we change our decision to remove the "structure" suffix in the second column. @sgrossberndt @skinkie Can you think what we should do?

ue71603 commented 2 years ago

Stefan: Having name+structure as anchor tag, but not on screen.

ue71603 commented 2 years ago

In principle same solution as in: https://github.com/VDVde/OJP/issues/189

ue71603 commented 2 years ago

We keep (currently) to the agreed Siri - "standard" the + says it is a structure.

ue71603 commented 2 years ago

Add titel tag linked that contains the name with Structure still there.

sgrossberndt commented 2 years ago

For table definition see https://www.vdv.de/431-2sdes-v-1-3.pdfx "3 Notation of XML elements and structures" "3.1.4 Data type"

sgrossberndt commented 2 years ago

Looks good. Will add a pull request.

sgrossberndt commented 2 years ago

As the change is within your own repository and not available as a branch in OJP it seems I cannot create a pull request from it honoring your work, @jmaerki.

ue71603 commented 2 years ago

Can't we grab it from his branch. Stephan will do it (one line)

sgrossberndt commented 1 year ago

Merged in https://github.com/VDVde/OJP/pull/233