|
|
@@ -2,16 +2,15 @@ image:https://travis-ci.org/jMonkeyEngine/wiki.svg?branch=master["Build Status",
|
|
|
|
|
|
= jMonkeyEngine Documentation
|
|
|
|
|
|
-WARNING: The project is an experimental WIP for the documentation of jME3
|
|
|
-
|
|
|
see http://jmonkeyengine.github.io/wiki/documentation
|
|
|
|
|
|
The project to store, edit, and generate the documentation of http://jmonkeyengine.org[jMonkeyEngine].
|
|
|
|
|
|
The documentation (<<src/docs/asciidoc>>) is editable :
|
|
|
|
|
|
-* online via github (Edit button + PR)
|
|
|
-* offline, after local `git clone` + ....
|
|
|
+* online via github (Edit button located at top of the Wiki page + Pull Request)
|
|
|
+* offline with Netbeans after local `git clone` + open
|
|
|
+* offline with Atom editor, see <<wiki/atom_editor#,Atom Editor Setup for Wiki Editing>>
|
|
|
|
|
|
The syntax is asciidoc :
|
|
|
|
|
|
@@ -21,16 +20,50 @@ The syntax is asciidoc :
|
|
|
|
|
|
== Contribute
|
|
|
|
|
|
-TODO
|
|
|
+There are a few simple rules to follow when contributing.
|
|
|
+
|
|
|
+. When adding documents, make sure to always complete the header of your document first.
|
|
|
+** see <<wiki/wiki_header#,Anatomy of a Wiki Header>>
|
|
|
+. When linking to other Wiki pages, always use an "`Internal Cross Reference`" with the format,
|
|
|
+** ++<<path-to-wikipage#,custom label text>>++ +
|
|
|
+The `#` sign substitutes for `.adoc`.
|
|
|
++
|
|
|
+The path should be relative to the `asciidoc` folder.
|
|
|
++
|
|
|
+For example: `++<<jme3/requirements#,Software and hardware requirements>>++` +
|
|
|
+links to the `requirements.adoc` page, which lives in a sub-folder of `asciidoc` named `jme3`.
|
|
|
+. When linking to images stored in the wiki repository, always use an image prefix in front of the file name and square brackets after it with the format,
|
|
|
+** Image on its own line - `image::path-to-image.jpg[image alt text,width=" ",height=" ", align=" "]`
|
|
|
++
|
|
|
+For example: `++image::jme3/beginner/beginner-assets-models.png[beginner-assets-models.png,320,250,align="center"]++`
|
|
|
++
|
|
|
+* This image is on its own line.
|
|
|
+* Is stored in the `jme3/beginner` folder which lives in the `images` folder.
|
|
|
+* Is named `beginner-assets-models.png`.
|
|
|
+* Has a `alt text` name of `beginner-assets-models.png`.
|
|
|
+* Has a width of 320.
|
|
|
+* Has a height of 250.
|
|
|
+* Is aligned in the center of the page.
|
|
|
+** If you want to include an image inline, use the `image:` prefix instead (notice there is only one colon):
|
|
|
++
|
|
|
+See link:http://asciidoctor.org/docs/user-manual/#images[http://asciidoctor.org/docs/user-manual/#images] for in depth instructions.
|
|
|
|
|
|
-== Build
|
|
|
|
|
|
-Convert the AsciiDoc to HTML5 by invoking the 'asciidoctor' goal:
|
|
|
|
|
|
- $ ./gradlew asciidoctor
|
|
|
|
|
|
+== Build
|
|
|
+
|
|
|
+* In Netbeans, convert the AsciiDoc to HTML5 by invoking the 'asciidoctor' goal:
|
|
|
++
|
|
|
+[source]
|
|
|
+----
|
|
|
+ $ ./gradlew asciidoctor
|
|
|
+----
|
|
|
++
|
|
|
Open the file _build/asciidoc/html5/index.html_ in your browser to see the generated HTML file.
|
|
|
|
|
|
+* In Atom, you see real time changes when using the `AsciiDoc Preview` (kbd:[ctrl+shift+A] or `menu:Packages[AsciiDoc Preview>Toggle Preview]`). No build is required.
|
|
|
+
|
|
|
== TODO
|
|
|
|
|
|
- [x] configure travis build
|
|
|
@@ -43,11 +76,11 @@ Open the file _build/asciidoc/html5/index.html_ in your browser to see the gene
|
|
|
- [ ] add a navigation bar or a menu (?)
|
|
|
- [ ] customize html layout (header, footer, css)
|
|
|
- [x] transfer ownership to jMonkeyEngine org
|
|
|
-- [ ] complete Doc, how to contribute,...
|
|
|
-- [ ] accept PR
|
|
|
+- [x] complete Doc, how to contribute,...
|
|
|
+- [ ] accept Pull Request
|
|
|
- [ ] write a post about the migration (the tools, why asciidoc, vs alternatives, how ...)
|
|
|
- [ ] generate sitemap
|
|
|
-- [ ] add search box
|
|
|
+- [x] add search box
|
|
|
- [ ] add google analytics (?)
|
|
|
- [ ] support emoji
|
|
|
- [ ] support iframe block
|
mitm001