Browse Source

Added admonition definitions.

mitm 7 years ago
parent
commit
36bb7f1fbf
1 changed files with 12 additions and 1 deletions
  1. 12 1
      src/docs/asciidoc/documentation.adoc

+ 12 - 1
src/docs/asciidoc/documentation.adoc

@@ -11,6 +11,17 @@ This documentation wiki contains installation and configuration guides, jME codi
 
 
 You are also very welcome to fix mistakes or spelling as well as unclear paragraphs using the "`Wiki`" menu on top or the "`Edit`" buttons after each paragraph. You have to be logged in to edit the wiki.
 You are also very welcome to fix mistakes or spelling as well as unclear paragraphs using the "`Wiki`" menu on top or the "`Edit`" buttons after each paragraph. You have to be logged in to edit the wiki.
 
 
+== Admonition Definitions
+
+NOTE: This is a Note Admonition. They are used to give you additionl information about the topic at hand.
+
+TIP: This is a Tip Admonition. They are intended to give you a small but useful piece of practical advice.
+
+IMPORTANT: This is an Important Admonition. This means the information is of great significance or value and should not be ignored.
+
+CAUTION: This is a Caution Admonition. When you see these you should pay particular attention to the information and care should be taken to avoid mistakes.
+
+WARNING: This is a Warning Admonition. The information should be taken very seriously and indicates a possible problem, or other unpleasant situation may arrise if ignored.
 
 
 == Install
 == Install
 
 
@@ -87,7 +98,7 @@ Are you an experienced Java developer who wants to add new features or contribut
 
 
 *  Get inspired by existing <<jme3/contributions#,contributions>>
 *  Get inspired by existing <<jme3/contributions#,contributions>>
 *  link:https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/CONTRIBUTING.md[How to contribute to jMonkeyEngine]
 *  link:https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/CONTRIBUTING.md[How to contribute to jMonkeyEngine]
-*  link:https://github.com/jMonkeyEngine/wiki[Become a Wiki Editor] 
+*  link:https://github.com/jMonkeyEngine/wiki[Become a Wiki Editor]
 *  link:http://hub.jmonkeyengine.org/c/contribution-depot-jme3[Chime in on the Contributors Forum]
 *  link:http://hub.jmonkeyengine.org/c/contribution-depot-jme3[Chime in on the Contributors Forum]
 *  <<jme3/jme3_source_structure#,Learn about the source structure>>
 *  <<jme3/jme3_source_structure#,Learn about the source structure>>
 *  <<sdk#development,Write jMonkeyEngine SDK plugins and visual editors>>
 *  <<sdk#development,Write jMonkeyEngine SDK plugins and visual editors>>