search

FIXTradingCommunity / fixatdl-specification

Specification and schemas for FIXatdl
Other
2 stars 1 forks source link

Highlighted text in XML samples #7

Closed kleihan closed 3 years ago

kleihan commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

@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 commented 3 years ago

I was able to go through the issues in Git. (Just goes to show how often I’ve been logging in). Please make the changes if you can. I know these things can be rather tedious so thank you for your thorough review of the document.

-Greg

From: Hanno Klein notifications@github.com Sent: Monday, December 7, 2020 11:01 AM To: FIXTradingCommunity/fixatdl-specification fixatdl-specification@noreply.github.com Cc: Greg Malatestinic gmala@jandj.com; Mention mention@noreply.github.com Subject: Re: [FIXTradingCommunity/fixatdl-specification] Highlighted text in XML samples (#7)

@gmalahttps://github.com/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.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/FIXTradingCommunity/fixatdl-specification/issues/7#issuecomment-740009480, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AFAXRQSQMV64PHOZ7KFAG3LSTT3Z5ANCNFSM4UDOGV2A.

kleihan commented 3 years ago

Also applied to v1.1