Jelajahi Sumber

change links to xrefs

mitm001 5 tahun lalu
induk
melakukan
b4d8025293
1 mengubah file dengan 27 tambahan dan 31 penghapusan
  1. 27 31
      docs/modules/ROOT/pages/documentation.adoc

+ 27 - 31
docs/modules/ROOT/pages/documentation.adoc

@@ -1,8 +1,6 @@
 = jMonkeyEngine Documentation
-:author:
-:revnumber:
-:revdate: 2016/03/17 20:48
-:experimental:
+:revnumber: 2.0
+:revdate: 2020/07/12
 :keywords: documentation, sdk, install
 
 
@@ -10,7 +8,7 @@ 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 "`Edit this Page`" link. You have to be logged into GitHub to edit the wiki. You can learn more about editing and contributing under the <<Contribute,Contribute>> heading.
 
-TIP: This is an Admonition. You will see many of these scattered throughout the Wiki. See the <<wiki/admonitions#,Admonition Definitions>> for the meaning of this and all the other Admonitions.
+TIP: This is an Admonition. You will see many of these scattered throughout the Wiki. See the xref:wiki:admonitions.adoc[Admonition Definitions] for the meaning of this and all the other Admonitions.
 
 == Forum
 
@@ -22,7 +20,7 @@ The link:http://hub.jmonkeyengine.org/[forum] is your first stop when reporting
 
 == Install
 
-*Before installing, check the <<bsd_license#,license>>, <<jme3/features#,features>>, and <<jme3/requirements#,requirements>>.* Then choose one of these options:
+Before installing, check the xref:bsd_license.adoc[license], xref:jme3/features.adoc[features], and xref:jme3/requirements.adoc[requirements]. Then choose one of these options:
 [cols="4", options="header"]
 |===
 
@@ -48,18 +46,18 @@ a| Sources
 
 a| Learn more here…
 a|
-* <<sdk#,Using the SDK>>
-* <<sdk/project_creation#,Project Creation>>
+* xref:sdk:sdk.adoc[Using the SDK]
+* xref:sdk:project_creation.adoc[Project Creation]
 a|
-* <<jme3/maven#,Setting up jME3 with Maven and Gradle compatible IDEs>>
-* <<jme3/setting_up_netbeans_and_jme3#,Setting up JME3 in the NetBeans IDE>>
-* <<jme3/setting_up_jme3_in_eclipse#,Setting up JME3 in the Eclipse IDE>>
+* xref:jme3/maven.adoc[Setting up jME3 with Maven and Gradle compatible IDEs]
+* xref:jme3/setting_up_netbeans_and_jme3.adoc[Setting up JME3 in the NetBeans IDE]
+* xref:jme3/setting_up_jme3_in_eclipse.adoc[Setting up JME3 in the Eclipse IDE]
 a|
-* <<jme3/build_from_sources#,Building JME3 from the Sources>>
-* <<jme3/build_jme3_sources_with_netbeans#,Building JME3 from the sources with NetBeans>>
-* <<jme3/simpleapplication_from_the_commandline#,Setting up JME3 on the commandline>>
+* xref:jme3/build_from_sources.adoc[Building JME3 from the Sources]
+* xref:jme3/build_jme3_sources_with_netbeans.adoc[Building JME3 from the sources with NetBeans]
+* xref:jme3/simpleapplication_from_the_commandline.adoc[Setting up JME3 on the commandline]
 
-4+^a| <<jme3/jme3_source_structure#,Learn about the source structure>>
+4+^a| xref:jme3/jme3_source_structure.adoc[Learn about the source structure]
 
 |===
 
@@ -68,7 +66,7 @@ pass:[*] The SDK creates Ant-based projects that any Java IDE can import. We rec
 
 == Create
 
-After downloading and installing, <<jme3#,bookmark the jME Documentation page>> and start writing your first game!
+After downloading and installing, xref:documentation.adoc[bookmark this page], and start writing your first game!
 [cols="3", options="header"]
 |===
 
@@ -76,17 +74,17 @@ a| Tutorials
 a| jMonkeyEngine SDK
 a| Other Documentation
 
-a| <<jme3#tutorials-for-beginners,jME3 beginner tutorials>>
-a| <<sdk#,jMonkeyEngine SDK Documentation and Video Tutorials>>
+a| xref:tutorials:beginner/beginner.adoc[jME3 beginner tutorials]
+a| xref:sdk:sdk.adoc[jMonkeyEngine SDK Documentation and Video Tutorials]
 a| link:{link-javadoc}[Full API JavaDoc]
 
-a| <<jme3#documentation-for-intermediate-users,jME3 intermediate articles>>
+a| <<jme3.adoc#documentation-for-intermediate-users,jME3 intermediate articles>>
 a| xref:sdk:comic.adoc[jMonkeyEngine SDK - the Comic :-)]
-a| <<jme3/external/blender#,Blender Modeling Guide>>
+a| xref:jme3/external/blender.adoc[Blender Modeling Guide]
 
-a| <<jme3#documentation-for-advanced-users,jME3 advanced documentation>>
+a| <<jme3.adoc#documentation-for-advanced-users,jME3 advanced documentation>>
 <a|
-a| <<jme3/faq#,Answers to Frequently Asked Questions>>
+a| xref:jme3/faq.adoc[Answers to Frequently Asked Questions]
 
 |===
 
@@ -95,26 +93,24 @@ a| <<jme3/faq#,Answers to Frequently Asked Questions>>
 
 Are you an experienced Java developer who wants to add new features or contribute patches to the jME3 project?
 
-*  Get inspired by existing <<jme3/contributions#,contributions>>
+*  Get inspired by existing xref:target-page-filename.adoc[jme3/contributions]
 *  link:https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/CONTRIBUTING.md[How to contribute to jMonkeyEngine]
 *  link:https://github.com/jMonkeyEngine/wiki#jmonkeyengine-documentation[Become a Wiki Editor]
 *  link:http://hub.jmonkeyengine.org/c/contribution-depot-jme3[Chime in on the Contributors Forum]
-*  <<sdk#development,Write jMonkeyEngine SDK plugins and visual editors>>
-*  <<report_bugs#,Report bugs and submit patches>>
+*  xref:sdk:development.adoc[Write jMonkeyEngine SDK plugins and visual editors]
+*  xref:report_bugs.adoc[Report bugs and submit patches]
 * link:https://jmonkeystore.com/[Find assets on the community supported jMonkeyStore]
+* link:https://hub.jmonkeyengine.org/c/documentation-jme3/24[Report unclear or missing documentation]
 
 == Contact
 
-You are welcome to contribute and inquire about the project: Please contact the link:https://hub.jmonkeyengine.org/badges/103/core-developer[developers] or ask on the link:http://hub.jmonkeyengine.org/[forums].
+You are welcome to contribute and inquire about the project: Please contact the link:https://hub.jmonkeyengine.org/badges/103/core-developer[developers] or ask on the link:https://hub.jmonkeyengine.org[forums].
 
 *  link:https://hub.jmonkeyengine.org/badges/103/core-developer[Contact the jME team]
-**  <<team#,[Core team - Who are we?]>>
-
-*  <<report_bugs#,Report a bug>>
-*  link:http://hub.jmonkeyengine.org/c/documentation-jme3[Report unclear or missing documentation]
+**  xref:team.adoc[Core team - Who are we?]
 
 == Languages
 
-The team is looking for other monkeys that would be interested in a wiki translation of [insert your favorite language here]. If you're interested in hosting translations see <<wiki/wiki_translation.adoc#,Wiki Translation Repositories>>.
+The team is looking for other monkeys that would be interested in a wiki translation of [insert your favorite language here]. If you're interested in hosting translations see xref:wiki:wiki_translation.adoc[Wiki Translation Repositories].
 
 link:http://www.jmecn.net/wiki/[简体中文]