This is an automated email from the ASF dual-hosted git repository.
geertjan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-netbeans-website.git
The following commit(s) were added to refs/heads/master by this push:
new ac0449e Added keyboard shortcut usage (#329)
ac0449e is described below
commit ac0449e75e8d8b8c150206998aa0206f1a489d11
Author: Brian Cowell <18186433+cu...@users.noreply.github.com>
AuthorDate: Fri Mar 1 05:49:09 2019 +1100
Added keyboard shortcut usage (#329)
Added how to enable keyboard shortcut graphics using the :experimental:
attribute and the kbd:[] macro
Added an example of asciidoc code to use the kbd:[] macro to produce a nice
visual keyboard combination.
---
.../src/content/kb/docs/contributing.asciidoc | 33 ++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
b/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
index f2f9bbf..c1030ac 100644
--- a/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
+++ b/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
@@ -28,6 +28,7 @@
:toc-title:
:description: Tutorial Contribution Guidelines
:reviewed: 2019-01-25
+:experimental:
The Apache NetBeans Tutorials were included in the third donation from Oracle
to the Apache Software Foundation. Many of these tutorials need to be reviewed.
Everybody can help out in the review process. All you need is a web browser, a
GitHub account and a basic knowledge of link:https://asciidoc.org/[AsciiDoc].
@@ -119,6 +120,8 @@ Immediately after the level 0 title, we add the metadata of
the page, all the "j
:icons: font
:description: NetBeans IDE Java Quick Start Tutorial - Apache NetBeans
:keywords: Apache NetBeans, Tutorials, NetBeans IDE Java Quick Start Tutorial
+:experimental:
+:backslash: \
----
This is a small description of the metadata:
@@ -133,6 +136,7 @@ This is a small description of the metadata:
- `icons` Set to `font` for adding support for FontAwesome icons.
- `description`: set to something that describes the page. This is used for
SEO.
- `keywords`: keywords describing the page. This is used for SEO.
+- `experimental`: enables button, menu paths, keyboard short cut graphics
== The Content
@@ -270,6 +274,35 @@ Then you can reference an icon using the name of the icon
in the asciidoc icon m
for a list of icons see https://fontawesome.com/icons?d=gallery
+=== Keyboard shortcuts
+
+Keyboard short cuts can be displayed in a graphical way using the *kbd:[]*
macro. +
+To enable the use of keyboard shortcut graphics, include the `:experimental:`
in the metadata of the page.
+
+[source, asciidoc]
+----
+:experimental:
+----
+
+_Example Asciidoc text_
+----
+kbd:[Ctrl+Shift+N] - Create a *New Project*
+----
+
+_Produces this result_ +
+kbd:[Ctrl+Shift+N] - Create a *New Project*
+
+There is a trick to using things like a backslash. A backslash must be
followed by a proceeding space.
+
+_Notice the space between the backslash and the closing bracket_ +
+----
+kbd:[Ctrl+\ ]
+----
+
+_Produces this result_
+
+kbd:[Ctrl+\ ]
+
=== New features
If you need to include a new feature in the page then
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@netbeans.apache.org
For additional commands, e-mail: commits-h...@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
