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

Replace XSD screenshots with code listings #569

Open
t-sommer opened this Issue Apr 15, 2019 · 2 comments

Comments

Projects
None yet
2 participants
@t-sommer
Copy link
Collaborator

t-sommer commented Apr 15, 2019

The screenshots of the XSD schema elements are out-of-sync with the changed schema files.
They could be replaced with XML examples that can be validated during CI.

For example

Boolean_Schema_large

could be replaced with

<Boolean name="bool_in"
  valueReference="8" 
  declaredType="switchState"
  start="false"/>

This would also save a lot of space (compared to the current PNGs), improve the rendering on small screens and provide valid (copy & paste friendly) examples.

@t-sommer t-sommer added this to the v3.0 milestone Apr 15, 2019

@chrbertsch

This comment has been minimized.

Copy link
Collaborator

chrbertsch commented Apr 15, 2019

I have always seen these pictures as part of the normative specification.
So how can they be replaced by an example?
Will then the XSD pert describing e.g. the attributes of the boolean variable be included in the specification? But this is not so well readable as the generated pictures.

@t-sommer

This comment has been minimized.

Copy link
Collaborator Author

t-sommer commented Apr 15, 2019

Technically they are normative (not in square brackets). If we keep them, someone needs to update the screenshots.

Another possibility would be to rebuild them as ASCII-art. Something like

+ Boolean
  + declaredType (normalizedString)
  + start (boolean)

For the complex types this would be quite an effort though...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.