java
/
jMonkeyEngine-wiki
zrcadlo https://github.com/jMonkeyEngine/wiki.git


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738394041424344
							<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="Asciidoctor 1.5.4"><meta name="author" content="mitm"><title>Anatomy of a Wiki Header</title><link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css">
<link rel="stylesheet" href="./coderay-asciidoctor.css"><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="/home/travis/build/jMonkeyEngine/wiki/build/asciidoc/html5/wiki/twemoji-awesome.css"></head><body class="article toc2 toc-left"><div id="header"><div id="toolbar"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/src/docs/asciidoc/wiki/wiki_header.adoc"><i class="fa fa-pencil-square" aria-hidden="true"></i></a><a href="https://github.com/jMonkeyEngine/wiki/new/master/src/docs/asciidoc/wiki/"><i class="fa fa-plus-square" aria-hidden="true"></i></a><input dir="auto" style="position: relative; vertical-align: top;" spellcheck="false" autocomplete="off" class="searchbox__input aa-input" id="doc-search" name="search" placeholder="Search in the doc" required="required" type="search"></div><h1>Anatomy of a Wiki Header</h1><div class="details"><span class="author" id="author">mitm</span><br><span id="revnumber">version ,</span> <span id="revdate">2017-09-08T23:24:11.262Z</span></div><div id="toc" class="toc2"><div id="toctitle">Table of Contents</div><ul class="sectlevel1"><li><a href="#">=</a></li><li><a href="#author">:author:</a></li><li><a href="#revnumber">:revnumber:</a></li><li><a href="#revdate">:revdate:</a></li><li><a href="#relfileprefix">:relfileprefix:</a></li><li><a href="#imagesdir">:imagesdir:</a></li><li><a href="#experimental">:experimental:</a></li><li><a href="#link-javadoc">:link-javadoc:</a></li><li><a href="#stylesheet-twemoji-awesome-css">:stylesheet: twemoji-awesome.css</a></li><li><a href="#ifdef-env-github-env-browser-outfilesuffix-adoc">ifdef::env-github,env-browser[:outfilesuffix: .adoc]</a></li></ul></div></div><div id="content"><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="CodeRay 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="">=</h2><div class="sectionbody"><div class="paragraph"><p>Mandatory. Title of your document.</p></div></div></div>
<div class="sect1"><h2 id="author">: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">:revnumber:</h2><div class="sectionbody"><div class="paragraph"><p>Optional. Revision number.</p></div></div></div>
<div class="sect1"><h2 id="revdate">:revdate:</h2><div class="sectionbody"><div class="paragraph"><p>Optional. Revision Date</p></div></div></div>
<div class="sect1"><h2 id="relfileprefix">: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"><span class="menu">View</span>&#160;&#9656; <span class="menuitem">Toggle Tree View</span></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="CodeRay highlight"><code>:relfileprefix: ../../</code></pre></div></div></div></div>
<div class="sect1"><h2 id="imagesdir">: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"><span class="menu">View</span>&#160;&#9656; <span class="menuitem">Toggle Tree View</span></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="CodeRay 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"><span class="menu">View</span>&#160;&#9656; <span class="menuitem">Toggle Tree View</span></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">: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">: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="CodeRay 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">: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="../wiki/emoji.html">Emoji Cheat Sheet</a></p></div></div></div>
<div class="sect1"><h2 id="ifdef-env-github-env-browser-outfilesuffix-adoc">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></div><div id="footer"><div id="footer-text">Version <br>Last updated 2019-12-19 19:32:51 +00:00</div></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script>docsearch({
  apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  indexName: 'jmonkeyengine',
  inputSelector: '#doc-search',
  debug: false // Set debug to true if you want to inspect the dropdown
});</script></body></html>