java
/
jMonkeyEngine-wiki
mirror of https://github.com/jMonkeyEngine/wiki.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462
							<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Anatomy of a Wiki Header :: jMonkeyEngine Docs</title>
    <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs/wiki/wiki_header.html">
    <meta name="generator" content="Antora 2.3.3">
    <link rel="stylesheet" href="../../_/css/site.css">
<meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
<meta property="og:description" content="Anatomy of a Wiki Header">
<meta property="og:title" content="jMonkeyEngine Docs">
<link rel="stylesheet" href="../../_/css/site-extra.css">
<link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
  </head>
  <body class="article">
<header class="header">
  <nav class="navbar">
    <div class="navbar-brand">
      <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
        <img alt="" src="../../_/img/jMonkeyDocLogo.png" height="32" type="image/x-icon">
      </a>
      <div class="navbar-item hide-for-print">
        <input type="text" placeholder="Search docs..." id="search-input"/>
      </div>
      <button class="navbar-burger" data-target="topbar-nav">
        <span></span>
        <span></span>
        <span></span>
      </button>
    </div>
    <div id="topbar-nav" class="navbar-menu">
      <div class="navbar-end">
        <div class="navbar-item theme-switch-wrapper">
          <label class="theme-switch" for="checkbox">
            <input type="checkbox" id="checkbox" />
            <div class="slider round"></div>
          </label>
        </div>
        <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
      </div>
    </div>
  </nav>
</header>
<div class="body">
<div class="nav-container" data-component="docs" data-version="master">
  <aside class="nav">
    <div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
  <nav class="nav-menu">
    <h3 class="title"><a href="../documentation.html">Docs</a></h3>
<ul class="nav-list">
  <li class="nav-item" data-depth="0">
<ul class="nav-list">
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="../documentation.html">Getting Started</a>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
  </li>
  <li class="nav-item" data-depth="1">
    <button class="nav-item-toggle"></button>
    <a class="nav-link" href="../jme3.html">jMonkeyEngine 3</a>
<ul class="nav-list">
  <li class="nav-item" data-depth="2">
    <button class="nav-item-toggle"></button>
    <span class="nav-text">Beginner Tutorials</span>
<ul class="nav-list">
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_node.html">Hello Node</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_asset.html">Hello Asset</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_input_system.html">Hello Input System</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_material.html">Hello Material</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_animation.html">Hello Animation</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_picking.html">Hello Picking</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_collision.html">Hello Collision</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_terrain.html">Hello Terrain</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_audio.html">Hello Audio</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_effects.html">Hello Effects</a>
  </li>
  <li class="nav-item" data-depth="3">
    <a class="nav-link" href="../jme3/beginner/hello_physics.html">Hello Physics</a>
  </li>
</ul>
  </li>
  <li class="nav-item" data-depth="2">
    <button class="nav-item-toggle"></button>
    <span class="nav-text">Intermediate Tutorials</span>
<ul class="nav-list">
  <li class="nav-item" data-depth="3">
    <button class="nav-item-toggle"></button>
    <span class="nav-text">Concepts</span>
<ul class="nav-list">
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/intermediate/best_practices.html">Best Practices</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/intermediate/simpleapplication.html">Simple Application</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/features.html">Features</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/intermediate/optimization.html">Optimization</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/faq.html">FAQ</a>
  </li>
</ul>
  </li>
  <li class="nav-item" data-depth="3">
    <button class="nav-item-toggle"></button>
    <span class="nav-text">Math Concepts</span>
<ul class="nav-list">
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/math_for_dummies.html">Math For Dummies</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/intermediate/math.html">Math</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/math.html">More Math</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/rotate.html">Rotate</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/math_video_tutorials.html">Math Video Tutorials</a>
  </li>
</ul>
  </li>
  <li class="nav-item" data-depth="3">
    <button class="nav-item-toggle"></button>
    <span class="nav-text">3D Graphics Concepts</span>
<ul class="nav-list">
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/scenegraph_for_dummies.html">Scenegraph for Dummies</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/beginner/hellovector.html">Hello Vector</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/terminology.html">Terminology</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/intermediate/transparency_sorting.html">Transparency and Sorting</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/external/blender.html">Importing from Blender</a>
  </li>
  <li class="nav-item" data-depth="4">
    <a class="nav-link" href="../jme3/external/3dsmax.html">Importing from 3DS Max</a>
  </li>
</ul>
  </li>
</ul>
  </li>
</ul>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="../logo.html">Logo Usage</a>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="../bsd_license.html">License</a>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="../github_tips.html">Github Tips</a>
  </li>
</ul>
  </li>
  <li class="nav-item" data-depth="0">
    <button class="nav-item-toggle"></button>
    <span class="nav-text">SDK</span>
<ul class="nav-list">
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="../sdk.html">jMonkeyEngine SDK</a>
  </li>
</ul>
  </li>
</ul>
  </nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
  <div class="context">
    <span class="title">Docs</span>
    <span class="version">master</span>
  </div>
  <ul class="components">
    <li class="component is-current">
      <span class="title">Docs</span>
      <ul class="versions">
        <li class="version is-current is-latest">
          <a href="../documentation.html">master</a>
        </li>
      </ul>
    </li>
    <li class="component">
      <span class="title">Wiki UI</span>
      <ul class="versions">
        <li class="version is-latest">
          <a href="../../wiki-ui/index.html">master</a>
        </li>
      </ul>
    </li>
  </ul>
</div>
    </div>
  </aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<nav class="breadcrumbs" aria-label="breadcrumbs">
  <ul>
    <li><a href="../documentation.html">Docs</a></li>
    <li><a href="wiki_header.html">Anatomy of a Wiki Header</a></li>
  </ul>
</nav>
  <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs/modules/ROOT/pages/wiki/wiki_header.adoc">Edit this Page</a></div>
  </div>
  <div class="content">
<article class="doc">
<h1 class="page">Anatomy of a Wiki Header</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>All wiki documents use these header attributes. Optional attributes can be left blank following the <kbd>:</kbd> colon symbol.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>= Enter Document Title Here
:author:
:revnumber:
:revdate:
:relfileprefix: ../../
:imagesdir: ../..
:experimental:
:link-javadoc: https://javadoc.jmonkeyengine.org
:stylesheet: twemoji-awesome.css
ifdef::env-github,env-browser[:outfilesuffix: .adoc]</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id=""><a class="anchor" href="#"></a>=</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Mandatory. Title of your document.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="author"><a class="anchor" href="#author"></a>:author:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Optional. Document author.</p>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>Optional Author and Revision information immediately follows the header title.</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="revnumber"><a class="anchor" href="#revnumber"></a>:revnumber:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Optional. Revision number.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="revdate"><a class="anchor" href="#revdate"></a>:revdate:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Optional. Revision Date</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="relfileprefix"><a class="anchor" href="#relfileprefix"></a>:relfileprefix:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Optional. Enter a path to the &#8220;asciidoc&#8221; folder if using cross reference links.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Use <code>Tree View</code> (<kbd>ctrl</kbd>+<kbd>\</kbd> or <code><span class="menuseq"><b class="menu">View</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Toggle Tree View</b></span></code>) to locate the &#8220;asciidoc&#8221; folder if using the <a href="https://atom.io/">Atom editor</a>.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>In the example below, &#8220;asciidoc&#8221; is two folders above the folder this file is located in.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>:relfileprefix: ../../</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="imagesdir"><a class="anchor" href="#imagesdir"></a>:imagesdir:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Optional. Enter a path to the "images" folder if using image links.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Use <code>Tree View</code> (<kbd>ctrl</kbd>+<kbd>\</kbd> or <code><span class="menuseq"><b class="menu">View</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Toggle Tree View</b></span></code>) to locate the &#8220;images&#8221; folder if using the <a href="https://atom.io/">Atom editor</a>.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>In the example below, &#8220;images&#8221; is two folders above the folder this file is located in. Note the missing <kbd>/</kbd> forward slash.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>:imagesdir: ../..</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="paragraph">
<p>A simple way to determine the location of the "asciidoc" and "images" folder in the Atom editor is first save the file to its new location, then in <code>Tree View</code> (<kbd>ctrl</kbd>+<kbd>\</kbd> or <code><span class="menuseq"><b class="menu">View</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Toggle Tree View</b></span></code>), <b class="button">RMB</b> select the saved file and select <b class="button">Copy Project Path</b>.</p>
</div>
<div class="paragraph">
<p>Temporarily paste this into your document to see where the &#8220;asciidoc&#8221; folder is located.</p>
</div>
<div class="paragraph">
<p>For example: <code>src\docs\asciidoc\jme3\advanced\3d_models.adoc</code></p>
</div>
<div class="paragraph">
<p>In this example, "asciidoc" is located two folders above the "advanced" folder <code>3d_models.adoc</code> resides in.</p>
</div>
<div class="paragraph">
<p>You can find this same folder information using <a href="https://github.com/jMonkeyEngine/wiki/blob/master/src/docs/asciidoc/jme3/advanced/3d_models.adoc">GitHub</a>.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The &#8220;images&#8221; folder resides in the same folder as the &#8220;asciidoc&#8221; folder so it has the same setting minus the <kbd>/</kbd> forward slash.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="experimental"><a class="anchor" href="#experimental"></a>:experimental:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>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 <a href="http://asciidoctor.org/docs/user-manual/#user-interface-macros">User Interface Macros</a>. You use these macros for creating keyboard shortcuts, displaying menu selections and UI buttons.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="link-javadoc"><a class="anchor" href="#link-javadoc"></a>:link-javadoc:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Optional. This is the global attribute for the jME javadocs. You set this if you are <strong>overriding</strong> the default setting from the <a href="https://github.com/jMonkeyEngine/wiki/blob/9d0e4fd07d019c3d41c6b9e64b2a1a5b7e0ed774/build.gradle#L39">build.gradle</a> file. You can use the default <code>{link-javadoc}</code> attribute directly in any document you write, as is shown in the following example, without adding anything to the header.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>link:{link-javadoc}/com/jme3/app/state/BaseAppState.html[BaseAppState]</code></pre>
</div>
</div>
<div class="paragraph">
<p>If you override the variable in the header of the document, that value will be used instead.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="stylesheet-twemoji-awesome-css"><a class="anchor" href="#stylesheet-twemoji-awesome-css"></a>:stylesheet: twemoji-awesome.css</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Optional. Adding this attribute will allow the use of emoji in the document.</p>
</div>
<div class="paragraph">
<p>See: <a href="emoji.html" class="page">Emoji Cheat Sheet</a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="ifdefenv-githubenv-browseroutfilesuffix-adoc"><a class="anchor" href="#ifdefenv-githubenv-browseroutfilesuffix-adoc"></a>ifdef::env-github,env-browser[:outfilesuffix: .adoc]</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Mandatory. See <a href="http://asciidoctor.org/docs/user-manual/#navigating-between-source-files">Navigating Between Source Files</a> in the AsciiDoctor user manual. Leave this as written.</p>
</div>
</div>
</div>
</article>
<aside class="toc sidebar" data-title="Contents" data-levels="2">
  <div class="toc-menu"></div>
</aside>
  </div>
</main>
</div>
<footer class="footer">
  <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
</footer>
<script src="../../_/js/site.js"></script>
<script async src="../../_/js/vendor/highlight.js"></script>
  </body>
</html>