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

Highlighted text in XML samples #7

Closed
kleihan opened this issue Nov 26, 2020 · 5 comments
Closed

Highlighted text in XML samples #7

kleihan opened this issue Nov 26, 2020 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@kleihan
Copy link
Member

kleihan commented Nov 26, 2020

Section 3.4 (GUI Layout) and 3.5 (Flow Control Rules) highlight key identifiers in the XML samples. This is not possible with markdown and would require a manual editing step everytime the spec is generated by Pandoc. Such highlighting should be avoided in general and replaced with descriptive text or other means.

This change applies to v1.1 and v1.2.

@kleihan kleihan added the documentation Improvements or additions to documentation label Nov 26, 2020
@kleihan
Copy link
Member Author

kleihan commented Nov 26, 2020

Changes made only for v1.2, could also be used for 1.1:

GUI Layout: removed "(Key identifiers have been highlighted.)" as there is a description below the sample saying "Notice how the Parameter/@name attributes match with the Control/@parameterRef attributes."

Flow Control Rules: changed text as follows:

FROM: (Note how the highlighted Control/@id attribute matches the highlighted Edit/@field attribute and how the highlighted enumID attribute matches the highlighted value attribute)

TO: (Note how the Control/@id attribute "c_AlphaMode" matches the Edit/@field attribute "c_AlphaMode" and how the enumID attribute "e_Custom" matches the value attribute "e_Custom")

@gmala
Copy link

gmala commented Dec 7, 2020

I see the change in the GUI Layout text, but do not see the change in the Flow Control Rules text. Could be my document is older than what it shoudl be.

@kleihan
Copy link
Member Author

kleihan commented Dec 7, 2020

@gmala : You only have a v1.1 doc and would need to generate v1.2 from within this repository (with Pandoc and the script FIXatdl.sh). Is it ok to make the changes described above for v1.1? I wanted to wait for your approval before making the change to flow control rules.

@gmala
Copy link

gmala commented Dec 7, 2020 via email

kleihan pushed a commit that referenced this issue Dec 8, 2020
@kleihan
Copy link
Member Author

kleihan commented Dec 8, 2020

Also applied to v1.1

@kleihan kleihan closed this as completed Dec 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants