Browse Source

Reformatted the page to have links in TOC.

mitm 5 years ago
parent
commit
9bddf746f6
1 changed files with 27 additions and 9 deletions
  1. 27 9
      src/docs/asciidoc/wiki/wiki_header.adoc

+ 27 - 9
src/docs/asciidoc/wiki/wiki_header.adoc

@@ -22,15 +22,25 @@ All wiki documents use these header attributes. Optional attributes can be left
 ifdef++::++env-github,env-browser[:outfilesuffix: .adoc]
 ifdef++::++env-github,env-browser[:outfilesuffix: .adoc]
 ----
 ----
 
 
-*pass:[=]* Mandatory. Title of your document.
+== =
 
 
-*pass:[:]author:* Optional. Document author.
+Mandatory. Title of your document.
 
 
-*pass:[:]revnumber:* Optional. Revision number.
+== :author:
 
 
-*pass:[:]revdate:* Optional. Revision Date
+Optional. Document author.
 
 
-*pass:[:]relfileprefix:* Optional. Enter a path to the "`asciidoc`" folder if using cross reference links.
+== :revnumber:
+
+Optional. Revision number.
+
+== :revdate:
+
+Optional. Revision Date
+
+== :relfileprefix:
+
+Optional. Enter a path to the "`asciidoc`" folder if using cross reference links.
 
 
 TIP: Use `Tree View` (kbd:[ctrl]+kbd:[\ ] or `menu:View[Toggle Tree View]`) to locate the "`asciidoc`" folder if using the link:https://atom.io/[Atom editor].
 TIP: Use `Tree View` (kbd:[ctrl]+kbd:[\ ] or `menu:View[Toggle Tree View]`) to locate the "`asciidoc`" folder if using the link:https://atom.io/[Atom editor].
 
 
@@ -40,7 +50,9 @@ In the example below, "`asciidoc`" is two folders above the folder this file is
 :relfileprefix: ../../
 :relfileprefix: ../../
 ```
 ```
 
 
-*pass:[:]imagesdir:* Optional. Enter a path to the "images" folder if using image links.
+== :imagesdir:
+
+Optional. Enter a path to the "images" folder if using image links.
 
 
 TIP: Use `Tree View` (kbd:[ctrl]+kbd:[\ ] or `menu:View[Toggle Tree View]`) to locate the "`images`" folder if using the link:https://atom.io/[Atom editor].
 TIP: Use `Tree View` (kbd:[ctrl]+kbd:[\ ] or `menu:View[Toggle Tree View]`) to locate the "`images`" folder if using the link:https://atom.io/[Atom editor].
 
 
@@ -65,9 +77,13 @@ You can find this same folder information using link:https://github.com/jMonkeyE
 
 
 The "`images`" folder resides in the same folder as the "`asciidoc`" folder so it has the same setting minus the kbd:[/ ] forward slash.
 The "`images`" folder resides in the same folder as the "`asciidoc`" folder so it has the same setting minus the kbd:[/ ] forward slash.
 
 
-*pass:[:]experimental:* Leave this blank. This is the experimental attribute that allows the use of link:http://asciidoctor.org/docs/user-manual/#user-interface-macros[User Interface Macros]. You use these macros for creating keyboard shortcuts, displaying menu selections and UI buttons.
+== :experimental:
+
+Optional. Leave this blank, i.e do not set a value for this attribute if using it. This is the experimental attribute that allows the use of link:http://asciidoctor.org/docs/user-manual/#user-interface-macros[User Interface Macros]. You use these macros for creating keyboard shortcuts, displaying menu selections and UI buttons.
 
 
-*pass:[:]link-javadoc:* Optional. This is the global attribute for the jME javadocs. You set this if you are *overriding* the default setting from the link:https://github.com/jMonkeyEngine/wiki/blob/9d0e4fd07d019c3d41c6b9e64b2a1a5b7e0ed774/build.gradle#L39[build.gradle] file. You can use the default `pass:[{link-javadoc}]` attribute directly in any document you write, as is shown in the following example, without adding anything to the header.
+== :link-javadoc:
+
+Optional. This is the global attribute for the jME javadocs. You set this if you are *overriding* the default setting from the link:https://github.com/jMonkeyEngine/wiki/blob/9d0e4fd07d019c3d41c6b9e64b2a1a5b7e0ed774/build.gradle#L39[build.gradle] file. You can use the default `pass:[{link-javadoc}]` attribute directly in any document you write, as is shown in the following example, without adding anything to the header.
 
 
 ```
 ```
 link:{link-javadoc}/com/jme3/app/state/BaseAppState.html[BaseAppState]
 link:{link-javadoc}/com/jme3/app/state/BaseAppState.html[BaseAppState]
@@ -75,4 +91,6 @@ link:{link-javadoc}/com/jme3/app/state/BaseAppState.html[BaseAppState]
 
 
 If you override the variable in the header of the document, that value will be used instead.
 If you override the variable in the header of the document, that value will be used instead.
 
 
-*ifdef++::++env-github,env-browser[:outfilesuffix: .adoc]* See link:http://asciidoctor.org/docs/user-manual/#navigating-between-source-files[Navigating Between Source Files] in the AsciiDoctor user manual. Leave this as written.
+== ifdef::env-github,env-browser[:outfilesuffix: .adoc]
+
+Mandatory. See link:http://asciidoctor.org/docs/user-manual/#navigating-between-source-files[Navigating Between Source Files] in the AsciiDoctor user manual. Leave this as written.