浏览代码

fix headers

mitm001 5 年之前
父节点
当前提交
b955e5a1ce

+ 1 - 1
docs/modules/ROOT/pages/documentation.adoc

@@ -81,7 +81,7 @@ a| <<sdk#,jMonkeyEngine SDK Documentation and Video Tutorials>>
 a| link:{link-javadoc}[Full API JavaDoc]
 
 a| <<jme3#documentation-for-intermediate-users,jME3 intermediate articles>>
-a| <<sdk/comic#,jMonkeyEngine SDK - the Comic :-)>>
+a| xref:sdk:comic.adoc[jMonkeyEngine SDK - the Comic :-)]
 a| <<jme3/external/blender#,Blender Modeling Guide>>
 
 a| <<jme3#documentation-for-advanced-users,jME3 advanced documentation>>

+ 9 - 12
docs/modules/sdk/pages/comic.adoc

@@ -1,24 +1,21 @@
 = jMonkeyEngine -- The Comic Book
-:author: 
-:revnumber: 
-:revdate: 2016/03/17 20:48
+:author:
+:revnumber:
+:revdate: 2020/04/11
 :keywords: documentation, tool, sdk
-:relfileprefix: ../
-:imagesdir: ..
-ifdef::env-github,env-browser[:outfilesuffix: .adoc]
 
 
-“Every good open-source project publishes documentation in comic book format. – zathras
+"`Every`" good open-source project publishes documentation in comic book format. – zathras
 
-image:sdk/jmonkeyplatform-docu-1.png[jmonkeyplatform-docu-1.png,width="",height=""]
+image:jmonkeyplatform-docu-1.png[jmonkeyplatform-docu-1.png,width="",height=""]
 
-image:sdk/jmonkeyplatform-docu-2.png[jmonkeyplatform-docu-2.png,width="",height=""]
+image:jmonkeyplatform-docu-2.png[jmonkeyplatform-docu-2.png,width="",height=""]
 
-image:sdk/jmonkeyplatform-docu-3.png[jmonkeyplatform-docu-3.png,width="",height=""]
+image:jmonkeyplatform-docu-3.png[jmonkeyplatform-docu-3.png,width="",height=""]
 
-image:sdk/jmonkeyplatform-docu-4.png[jmonkeyplatform-docu-4.png,width="",height=""]
+image:jmonkeyplatform-docu-4.png[jmonkeyplatform-docu-4.png,width="",height=""]
 
-image:sdk/jmonkeyplatform-docu-5.png[jmonkeyplatform-docu-5.png,width="",height=""]
+image:jmonkeyplatform-docu-5.png[jmonkeyplatform-docu-5.png,width="",height=""]
 '''
 
 See also: <<sdk#,Main SDK Documentation Page>>, <<jme3#,Main Engine Documentation Page>>

+ 15 - 19
docs/modules/tutorials/pages/beginner/what_s_an_ide.adoc

@@ -1,20 +1,16 @@
 = What's an IDE?
-:author:
-:revnumber:
-:revdate: 2020/07/06
-:relfileprefix: ../
-:imagesdir: ..
-ifdef::env-github,env-browser[:outfilesuffix: .adoc]
+:revnumber: 2.0
+:revdate: 2020/07/11
 
 *  IDE stands for Integrated Development Environment. It's a software tool for developers.
 *  NetBeans IDE, Eclipse, IntelliJ are examples of development environments (=IDEs) for developers who are writing Java applications.
 *  Java is a programming language.
-**  “Java Beans is just a funny way of naming a certain type of data object that you can write in Java. +
+**  "`Java Beans`" is just a funny way of naming a certain type of data object that you can write in Java. +
 (Java = coffee… coffee beans, get it? No, developers aren’t very funny.) +
 _Java Beans have nothing to do with this topic or NetBeans!_
 
 *  jMonkeyEngine is a game engine written in Java. You use it by putting a JAR library on the class path, and calling its +++<abbr title="Application Programming Interface">API</abbr>+++ from your Java code.
-*  The jMonkeyEngine <<sdk#,SDK>> (Software Development Kit) is a customized NetBeans IDE that has special tools that help you develop 3D Java games.
+*  The jMonkeyEngine xref:sdk.adoc[SDK] (Software Development Kit) is a customized NetBeans IDE that has special tools that help you develop 3D Java games.
 
 
 [IMPORTANT]
@@ -24,7 +20,7 @@ The writing of the game (the actual game development) is still up to you, the pe
 
 
 
-image::sdk/jme3-jmonkeyplatform.png[jme3-jmonkeyplatform.png,width="640",height="400",align="center"]
+image::jme3-jmonkeyplatform.png[jme3-jmonkeyplatform.png,width="640",height="400",align="center"]
 
 
 
@@ -32,12 +28,12 @@ image::sdk/jme3-jmonkeyplatform.png[jme3-jmonkeyplatform.png,width="640",height=
 
 Let's say you have no IDE. The typical stuff that you need for game development is:
 
-.  Install the Java SDK (“JDK 6) from Sun/Oracle.
+.  Install the Java SDK ("`JDK 6`") from Sun/Oracle.
 **  The JDK includes essential development tools, such as the Java compiler (`javac`) and Java runtime (`java`).
 
 .  Install the jMonkeyEngine JAR libraries.
 **  These libraries include the special classes that you need for game development.
-**  As with all Java applications, you put JAR libraries on the classpath. (`java -cp bla.jar;foo.jar myapp`…)
+**  As with all Java applications, you put JAR libraries on the classpath. (`java -cp bla.jar;foo.jar myapp`…)
 
 .  Get a text editor to write .java and .xml files.
 .  Get a 3D model editor to preview 3D models and arrange them in scenes.
@@ -65,17 +61,17 @@ Some people got annoyed by these maintenance tasks, and that's why they invented
 An IDE is a source code editor that developers use to write applications and manage projects. It replaces the text editor – and all the switching between browser and terminal and text editors.
 The essential word here is *integrated*: An IDE integrates all development tools (listed above) in one window.
 
-*  There are New Project and New File menu items that create directories and packages. It creates a professional Ant script. It manages the classpath for you. These formerly manual tasks are always the same for you – now they are automated in the “Project window.
-*  The “Editor window lets you edit Java and XML files. (more details below)
-*  You can drag and drop commonly used code snippets from a “Palette window into your Java files.
-*  A “Navigator window gives you a quick overview of long Java classes, and lets you jump to methods and fields.
+*  There are New Project and New File menu items that create directories and packages. It creates a professional Ant script. It manages the classpath for you. These formerly manual tasks are always the same for you – now they are automated in the "`Project`" window.
+*  The "`Editor`" window lets you edit Java and XML files. (more details below)
+*  You can drag and drop commonly used code snippets from a "`Palette`" window into your Java files.
+*  A "`Navigator`" window gives you a quick overview of long Java classes, and lets you jump to methods and fields.
 *  The Build button starts the JDK6 compiler (`ant` and `javac`), the Clean button runs `ant clean`, the Run button runs the application (`ant run` and `java`) – all these tasks are now once-click actions in a toolbar or context menu.
-*  After building and running, the IDE opens the “Application window. This window is what end-users of your applications will see. Here you can test your gameplay.
+*  After building and running, the IDE opens the "`Application`" window. This window is what end-users of your applications will see. Here you can test your gameplay.
 
 *The Editor* is the heart of the IDE, and it has tons of great additional capabilties:
 
 *  The IDE tries to compile in the background what you write in the Editor. If you made a horrible, but obvious, mistake (forgot semicolon, mixed up data types, made a typo in a method call…) it tells you so immediately through warning colors and icons. This is called syntactic and semantic code highlighting.
-**  You still get Terminal output for errors and warnings (in the “Output window inside the IDE), but this way you erradicate tiny typos and compiletime errors immediately, and you can focus on serious runtime errors in the Output window.
+**  You still get Terminal output for errors and warnings (in the "`Output`" window inside the IDE), but this way you erradicate tiny typos and compiletime errors immediately, and you can focus on serious runtime errors in the Output window.
 
 *  The number of commands in the Java +++<abbr title="Application Programming Interface">API</abbr>+++ is limited. So while you type a method or class name, there is only a limited number of things it can be. If you temporarily forgot what a method was called, the Editor pops up a list of options (plus javadoc comments), and you can simply select it.
 *  Similarly, every class and method only has a limited number of arguments. Again, the IDE pops up a list of expected arguments, so you don't need to search for them in the javadoc.
@@ -92,10 +88,10 @@ The jMonkeyEngine SDK is the same as NetBeans IDE, plus
 *  And more…
 
 
-image::sdk/jmonkeyplatform-docu-1.png[jmonkeyplatform-docu-1.png,width="",height="",align="center"]
+image::jmonkeyplatform-docu-1.png[jmonkeyplatform-docu-1.png,width="",height="",align="center"]
 
 
 You see how such a unique IDE can speed up your development process drastically, it's worth giving it a try!
 
 *  link:http://www.youtube.com/watch?v=cTErYjsJ_Yk[Video: jMonkeyEngine3 - Intro]
-*  <<comic#,jMonkeyEngine SDK - the Comic>>
+*  xref:comic.adoc[jMonkeyEngine SDK - the Comic]