[ofbiz-framework] branch trunk updated: Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting

[holivier]

This is an automated email from the ASF dual-hosted git repository.

holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git


The following commit(s) were added to refs/heads/trunk by this push:
     new fa11e7d  Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting
fa11e7d is described below

commit fa11e7ddc7024fea185a84147230fa541b1a2bfe
Author: holivier <[hidden email]>
AuthorDate: Wed Nov 18 17:24:33 2020 +0100

    Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting
---
 docs/asciidoc/documentation_guidelines.adoc | 86 +++++++++++++++--------------
 1 file changed, 46 insertions(+), 40 deletions(-)

diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc
index cc4ce09..61dffe5 100644
--- a/docs/asciidoc/documentation_guidelines.adoc
+++ b/docs/asciidoc/documentation_guidelines.adoc
@@ -363,6 +363,46 @@ This is the text for the simple description headline
 Just a simple block example.
 ====
 
+=== Keyboard shortcuts
+
+You can also define keyboard shortcuts with the `kbd` macro.
+
+ kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE
+
+The result is the following:
+
+kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE
+
+The result will be different depending on the rendering (PDF, HTML).
+
+=== Using inline icons
+
+You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons
+from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets:
+
+* fa - https://fontawesome.com/v4.7.0/icons (default)
+* fas - https://fontawesome.com/icons?d=gallery&s=solid[Font Awesome - Solid]
+* fab - https://fontawesome.com/icons?d=gallery&s=brands[Font Awesome - Brands]
+* far - https://fontawesome.com/icons?d=gallery&s=regular[Font Awesome - Regular]
+* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons]
+* pf - https://paymentfont.com/[Payment font]
+
+The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. +
+when icon is not available in fa icon set but in an other, it's possible to give the correct set.
+
+The generate Document process generate a INFOS message, if icon is available in an other set and it is not given.
+----
+icon:comment[set=far] This is a comment icon
+icon:file[set=far] And a file icon
+icon:battery-full[set=fas] And a battery icon
+----
+
+.The output looks like the following
+[example]
+icon:comment[set=far] This is a comment icon +
+icon:file[set=far] And a file icon +
+icon:battery-full[set=fas] And a battery icon
+
 
 == Code formatting
 
@@ -579,46 +619,6 @@ Result:
 
 This is just a text image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%] to show inline images.
 
-=== Keyboard shortcuts
-
-You can also define keyboard shortcuts with the `kbd` macro.
-
- kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE
-
-The result is the following:
-
-kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE
-
-The result will be different depending on the rendering (PDF, HTML).
-
-=== Using inline icons
-
-You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons
-from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets:
-
-* fa - https://fontawesome.com/v4.7.0/icons (default)
-* fas - https://fontawesome.com/icons?d=gallery&s=solid[Font Awesome - Solid]
-* fab - https://fontawesome.com/icons?d=gallery&s=brands[Font Awesome - Brands]
-* far - https://fontawesome.com/icons?d=gallery&s=regular[Font Awesome - Regular]
-* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons]
-* pf - https://paymentfont.com/[Payment font]
-
-The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. +
-when icon is not available in fa icon set but in an other, it's possible to give the correct set.
-
-The generate Document process generate a INFOS message, if icon is available in an other set and it is not given.
-----
-icon:comment[set=far] This is a comment icon
-icon:file[set=far] And a file icon
-icon:battery-full[set=fas] And a battery icon
-----
-
-.The output looks like the following
-[example]
-icon:comment[set=far] This is a comment icon +
-icon:file[set=far] And a file icon +
-icon:battery-full[set=fas] And a battery icon
-
 
 == How to write a...
 
@@ -654,6 +654,12 @@ This is entry #1 in our example FAQ.
 FAQ entry 2::
 This is entry #2 in our example FAQ.
 
+==== Glossary
+
+There is one Glossary per Component and a General Glossary in user-manual.
+
+For glossary entries ID should be in Uppercase with space replace by "_"
+
 
 == Asciidoc FAQ