Create a conventions document so we are clear on what to bold, italicize etc.

[fancynancy63]

So when Sam and I taught onsite, I added certain conventions for the documents. For instance the names of VI's were bold. We just need to decide what we want to do. So for now, I will add those conventions to this description:

1. All "instructions" have a number
2. The names of VIs are bold

[unifab]

@fancynancy63

Did you see how the VI names look once they are rendered? What do you think? Is that difference enough?

[fancynancy63]

I am not seeing any difference in the final rendering with the CSS. Also there are some font or size issues on instructions LabVIEWCommunityTraining/cti-documentation#1 and LabVIEWCommunityTraining/cti-documentation#2. I'll go check on that later this weekend. Have a great evening!

[OlivierJourdan]

Here are some conventions the asccidoc syntax offers we should follow:

• use Menu macro each time we describe where to find an item in a menu like here.

Before

Syntax change

After

• use Keyboard macro for keayboard shorcuts

Example

• use monospace formatting to lightly highlight a word.

Example

[OlivierJourdan]

I'd suggest listing conventions/guidelines on this page --> https://labviewcommunitytraining.github.io/cti-documentation/en/cti-doc/latest/contributing.html

[unifab]

I agree with the suggestion of putting the conventions on the Contributing HTML... I will let @fancynancy63 take care of that if she agrees.

@OlivierJourdan,
The images you put for the macros are from the GCentral page that we don't have access to, I am wondering if you intended a different picture for that example

[OlivierJourdan]

@OlivierJourdan, The images you put for the macros are from the GCentral page that we don't have access to, I am wondering if you intended a different picture for that example

I think there is a misunderstanding here. The image I used to demo the Macro's use highlights the text rendering.
Is this screenshot clearer (or did I misunderstand your message 😅)?

[unifab]

This is clearer to me, thank you!

[OlivierJourdan]

For the record, I've started a new section to list the writing convention on this page --> https://labviewcommunitytraining.github.io/www/en/contributing.html#writing-conventions