Skip to content

Commit 41ca070

Browse files
add writing convention code section (wip)
1 parent 591c747 commit 41ca070

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

en/modules/ROOT/pages/contributing.adoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,58 @@ The content is written using the https://asciidoc.org/[AsciiDoc] markup language
2929
3030
To learn the basics and advanced features of this language, visit the https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc documentation website].
3131
====
32+
33+
== Writing conventions
34+
35+
=== VI names
36+
37+
Use https://docs.asciidoctor.org/asciidoc/latest/text/bold/[bold] style to write VI names.
38+
39+
.VI names
40+
[source#vi-names]
41+
[source]
42+
----
43+
Start with placing the *Initialize.vi*, and the *Close.vi* on a new Block Diagram.
44+
----
45+
46+
The <<vi-names>> is rendered below.
47+
48+
====
49+
Start with placing the *Initialize.vi*, and the *Close.vi* on a new Block Diagram.
50+
====
51+
52+
=== Menu item path
53+
54+
Use the https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/#menu-macro-syntax[Menu macro] to display how to select an item in a menu.
55+
56+
.Menu item path
57+
[source#menu-item-path]
58+
[source]
59+
----
60+
Open the start-up menu and click on menu:Other[Visit LabVIEW Community Training on GitHub].
61+
Go to the LabVIEW menu menu:Tools[Advanced > Masscompile].
62+
----
63+
64+
The <<menu-item-path>> is rendered below.
65+
66+
====
67+
Open the start-up menu and click on menu:Other[Visit LabVIEW Community Training on GitHub]. +
68+
Go to the LabVIEW menu menu:Tools[Advanced > Masscompile].
69+
====
70+
71+
=== Keyboard shortcut
72+
73+
Use the https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/#button-macro-syntax[button macro] syntax to display keystroks used for keyboard shortcuts.
74+
75+
.Keyboard Shortcut
76+
[source#kbd-shortcut]
77+
[source]
78+
----
79+
Press kbd:[Ctrl-H] to bring up the context help window.
80+
----
81+
82+
The <<kbd-shortcut>> is rendered below.
83+
84+
====
85+
Press kbd:[Ctrl-H] to bring up the context help window.
86+
====

0 commit comments

Comments
 (0)