jonashub/team-docs
1
0
Fork 0
forked from docs/team-docs
Code Pull requests Activity

asciidoc-macro-update

Browse source
This commit is contained in:
hank L 2023-12-12 18:03:33 +00:00
commit 62481c3d9a
1 changed files with 33 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
modules/ROOT/pages/contributing-docs/asciidoc-markup.adoc
View file

@ -277,6 +277,39 @@ This option is enabled by the `page-pagination` attribute.
You can see a live example on this page.
=== Button and Menu UI macro
To keep consistency in presenting a button, keyboard bindings, or a menu item (path), Button and Menu UI Macros communicate to the reader what actions they need to take.
IMPORTANT: Although this attribute is named experimental, the UI macros are considered a stable feature of the AsciiDoc and used in latest Quick Docs edited.
This option is enabled by the experimental attribute.
[,asciidoc]
----
= Page Title
:experimental:
----
Examples of defining Button UI Macro
[,asciidoc]
----
. Click btn:[Create].
. Choose a passphrase that is strong but also easy to remember in the dialog that is displayed.
. Click btn:[OK] and the key is created.
----
Examples of defining Menu UI Macro
[,asciidoc]
----
To save the file, select menu:File[Save].
Select menu:View[Zoom > Reset] to reset the zoom level to the default setting.
----
== Best practices
A few recommendation when writing a new pages, or editing an existing one.