java
/
jMonkeyEngine-wiki
同期ミラー https://github.com/jMonkeyEngine/wiki.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866
							<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Wiki Translation Repositories :: jMonkeyEngine Docs</title>
    <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs/wiki/wiki_translation.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="Wiki Translation Repositories">
<meta property="og:title" content="jMonkeyEngine Docs">
<link rel="stylesheet" href="../../_/css/site-extra.css">
<link rel="stylesheet" href="../../_/css/vendor/docsearch.min.css">
<!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.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_translation.html">Wiki Translation Repositories</a></li>
  </ul>
</nav>
  <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs/modules/ROOT/pages/wiki/wiki_translation.adoc">Edit this Page</a></div>
  </div>
  <div class="content">
<article class="doc">
<h1 class="page">Wiki Translation Repositories</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Official translations of the wiki are not practical due to varying dialects, dodgy translator programs, and the increased workload needed to officially support the translations. A different approach is to have monkeys, who wish to contribute to the community, run their own translation of the wiki.</p>
</div>
<div class="paragraph">
<p>This tutorial will go into the details of how to setup a copy of the wiki on <a href="https://github.com/">GitHub</a> that looks and feels like the official wiki, including <a href="https://github.com/marketplace/travis-ci">Travis-CI</a> automatically converting your AsciiDoc content to HTML, then publishing those files on each commit.</p>
</div>
<div class="paragraph">
<p>You are not required to translate every page or even mirror changes to the official wiki. What is required is a linked wiki be robust enough to actually help other monkeys and that the content is kept current. If it&#8217;s deemed worthy, a link to your repository, whether its stored on your own domain or not, will be added to the main page of the wiki under the <a href="../documentation.html#languages#" class="page">Languages</a> topic.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
<div class="paragraph">
<p>Although this is a tutorial on setting up and configuring your own copy of the official wiki, you still must adhere to the <a href="../bsd_license.html" class="page">jMonkeyEngine licensing</a>.</p>
</div>
<div class="paragraph">
<p>This includes the use of a domain name that includes the jMonkeyEngine name.</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="prerequisites"><a class="anchor" href="#prerequisites"></a>Prerequisites</h2>
<div class="sectionbody">
<div class="paragraph">
<p>For this tutorial you can either setup with Git, or the Atom Editor, which uses basic GitHub commands by default. You will be <strong>loosely</strong> implementing the instructions from <a href="https://github.com/steveklabnik/automatically_update_github_pages_with_travis_example">Steve Klabnik</a>.</p>
</div>
<div class="paragraph">
<p>You will need to meet these requirements to continue:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>A <a href="https://github.com/">GitHub</a> account.</p>
</li>
<li>
<p>Either <a href="https://help.github.com/articles/set-up-git/">Git</a> or the <a href="atom_editor.html" class="page">Atom Editor</a> installed on your system.</p>
</li>
</ul>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The Atom editor also has a <a href="https://atom.io/packages/git-plus">Git Plus</a> package that uses Git if it&#8217;s already on your system. Open <code><span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Settings</b></span></code> and enter &#8220;git&#8221; into the search box to locate and install.
</td>
</tr>
</table>
</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>For a list of git commands, use one of these:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="https://services.github.com/on-demand/resources/cheatsheets/">Git Cheat Sheets</a></p>
</li>
<li>
<p><a href="http://rogerdudler.github.io/git-guide/">git - the simple guide</a></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>See also Travis-CI:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="https://docs.travis-ci.com/user/getting-started/">Getting Started</a></p>
</li>
</ul>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="githubtravis-ci-setup"><a class="anchor" href="#githubtravis-ci-setup"></a>GitHub/Travis CI Setup</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This topic applies to both Git and the Atom Editor. You must do this before you do anything else.</p>
</div>
<div class="olist arabic">
<div class="title">Github</div>
<ol class="arabic">
<li>
<p>Create a <a href="https://help.github.com/articles/creating-a-new-repository/">new repository</a> on <a href="https://github.com/">github.com</a> for your wiki. (NOT a fork)</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Enter a unique name for your repository.</p>
</li>
</ol>
</div>
</li>
<li>
<p>After your repository has been created, you will need to add a new &#8220;gh-pages&#8221; <a href="https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/">branch</a>.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>This will automatically setup your repository for compiling &#8220;gh-pages&#8221;.</p>
</li>
<li>
<p>After creating the &#8220;gh-pages&#8221; branch, from your repositories main page, click the <span class="icon"><i class="fa fa-cog"></i></span>  <b class="button">Settings</b> link and scroll down to the &#8220;GitHub Pages&#8221; panel for more configuration options and to see your sites new URL.</p>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>There are two URLs you will need for configuration.</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Your <code><strong>gh-pages</strong></code> URL: https://username.github.io/repo-name/</p>
</li>
<li>
<p>Your <code><strong>repository</strong></code> URL: https://github.com/username/repo-name</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>This is how they will be referred to in this tutorial.</p>
</div>
</td>
</tr>
</table>
</div>
</li>
</ol>
</div>
</li>
<li>
<p>Setup GH_TOKEN variable:</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>You need to generate a <a href="https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/">GH_TOKEN</a> in github.com, and set up Environment Variables in travis-ci.org or travis-ci.com, depending on whether your repository is public or not. This variable will be used in the deploy_ghpages.sh file.</p>
</li>
<li>
<p>Describe it however you wish and then you will need to check some boxes. Check these ones:</p>
<div class="ulist checklist">
<ul class="checklist">
<li>
<p><i class="fa fa-check-square-o"></i>  public_repo</p>
<div class="openblock">
<div class="content">
<div class="paragraph">
<p>If your repository is private, you can set repo instead.</p>
</div>
<div class="paragraph">
<p>GitHub will create the token and show a page with the value.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
<strong>THIS IS THE ONLY TIME YOU GET TO SEE THIS SO DON&#8217;T CLICK AWAY IMMEDIATELY!</strong>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>You will need to copy this token into someplace you trust. It&#8217;ll never be shown to you after this time, so it&#8217;s important to double-check your work. You can always regenerate a new token, but then you will have to change any script or apps that use it.</p>
</div>
</div>
</div>
</li>
</ul>
</div>
</li>
</ol>
</div>
</li>
</ol>
</div>
<div class="olist arabic">
<div class="title">Travis CI</div>
<ol class="arabic">
<li>
<p>Click your name icon and select <code><span class="menuseq"><b class="menu">Settings</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Billing</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Marketplace</b></span></code> or the &#8220;Marketplace&#8221; link at the top of the page header.</p>
</li>
<li>
<p>Click the &#8220;Travis-CI&#8221; link. If you don&#8217;t see one listed, find it using the search box.</p>
</li>
<li>
<p>Scroll to the bottom of the page and under &#8220;Pricing and setup&#8221; select the &#8220;Open Source&#8221; option if this is a public_repo or the payment plan of your choice.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>When ready, select the <b class="button">Install</b> button.</p>
</li>
<li>
<p>Click through until you are redirected to the Travis-Ci website.</p>
</li>
</ol>
</div>
</li>
<li>
<p>On Travis-CI, flick the repository switch on for your gh-pages project.</p>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You can’t see your project on the list? Click on the Sync account button (top right) and it should be OK.
</td>
</tr>
</table>
</div>
</li>
<li>
<p>Click the <span class="icon"><i class="fa fa-cog"></i></span>  cog to go to the settings tab and configure it.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Check some options on General:</p>
<div class="olist lowerroman">
<ol class="lowerroman" type="i">
<li>
<p>check the Build only if .travis.yml is present option.</p>
</li>
<li>
<p>Check the Build pushed options.</p>
</li>
</ol>
</div>
</li>
<li>
<p>Create some Environment Variables that will be used in .travis.yml file:</p>
<div class="olist lowerroman">
<ol class="lowerroman" type="i">
<li>
<p>GH_TOKEN: the token created on previous step.</p>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
Uncheck the Display value in build log option. This is the default action.
</td>
</tr>
</table>
</div>
</li>
</ol>
</div>
</li>
</ol>
</div>
</li>
</ol>
</div>
<div class="sect2">
<h3 id="using-git-command-line-to-finish"><a class="anchor" href="#using-git-command-line-to-finish"></a>Using Git Command Line to finish</h3>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Clone the <a href="https://github.com/jMonkeyEngine/wiki">wiki</a> or your fork of the wiki and your new repository. Cloning and pushing takes some time due to the size of the wiki. Be patient.</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>$ git clone https://github.com/jMonkeyEngine/wiki.git
$ git clone https://github.com/user/repository.git
$ cd repository
$ git checkout master</code></pre>
</div>
</div>
</li>
<li>
<p>Copy everything from the localized wiki repository to the localized new repository, especially these files:</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>.travis.yml</p>
</li>
<li>
<p>build.gradle</p>
</li>
<li>
<p>deploy_ghpages.sh</p>
</li>
<li>
<p>gradlew</p>
<div class="openblock">
<div class="content">
<div class="paragraph">
<p><code>Travis CI</code> will execute <code>./gradlew asciidoctor</code> and <code>./deploy_ghpages.sh</code> after you push your commits.</p>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
If you have ever forked the official wiki, I suggest you rename it to origin_wiki or official_wiki. Then, you can still contribute to the official wiki with that fork.
</td>
</tr>
</table>
</div>
</div>
</div>
</li>
</ol>
</div>
</li>
<li>
<p>Give gradlew, deploy_ghpages.sh permission to be executed. If you don’t do this, travis-ci.org will fail, due to no permission.</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>git update-index --chmod=+x deploy_ghpages.sh
git update-index --chmod=+x gradlew
git push</code></pre>
</div>
</div>
</li>
<li>
<p>At this point you need to change the wiki specific attributes to complete the setup.</p>
<div class="ulist">
<ul>
<li>
<p>See <a href="#Changing-Wiki-Specific-Attributes#">Changing Wiki Specific Attributes</a></p>
</li>
</ul>
</div>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="using-atom-editor-to-finish"><a class="anchor" href="#using-atom-editor-to-finish"></a>Using Atom Editor to finish</h3>
<div class="paragraph">
<p>This topic assumes you have already downloaded, installed and configured the <a href="#../wiki\atom_editor.adoc" class="page unresolved">Atom Editor</a> as well as cloned the  <a href="https://github.com/jMonkeyEngine/wiki">wiki</a> or your fork of the wiki and it&#8217;s open in the Atom Editor.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>In the Atom Editor, select <code><span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">New Window</b></span></code> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>N</kbd>.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Delete the new page that opens by default.</p>
</li>
</ol>
</div>
</li>
<li>
<p>In the new window, select <code><span class="menuseq"><b class="menu">Packages</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Command Palette</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Toggle</b></span></code> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Enter &#8220;github&#8221; into the search box.</p>
</li>
<li>
<p>Select the <b class="button">GitHub Clone</b> button.</p>
</li>
<li>
<p>Enter the URL to your <code><strong>repository</strong></code>.</p>
</li>
<li>
<p>When ready, click the <b class="button">Clone</b> button.</p>
</li>
</ol>
</div>
</li>
<li>
<p>Copy everything from the localized wiki repository to the localized new repository, especially these files:</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>.travis.yml</p>
</li>
<li>
<p>build.gradle</p>
</li>
<li>
<p>deploy_ghpages.sh</p>
</li>
<li>
<p>gradlew</p>
</li>
</ol>
</div>
</li>
<li>
<p>Give gradlew, deploy_ghpages.sh permission to be executed. If you don’t do this, travis-ci.org will fail, due to no permission.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>If you use Git Plus, select <code><span class="menuseq"><b class="menu">Packages</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Git Plus</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Run</b></span></code> and enter these arguments.</p>
<div class="listingblock">
<div class="title">Using Git Plus</div>
<div class="content">
<pre class="highlightjs highlight"><code>git update-index --chmod=+x deploy_ghpages.sh
git update-index --chmod=+x gradlew
git push</code></pre>
</div>
</div>
</li>
<li>
<p>If you dont have Git, then edit the <code>travis.yml</code> file and add this after the <code>branches:</code> command.</p>
<div class="listingblock">
<div class="title">No Git Installed</div>
<div class="content">
<pre class="highlightjs highlight"><code>branches:
  except:
    - gh-pages
# No git, change permissions here.
before_install:
 - chmod +x deploy_ghpages.sh
 - chmod +x gradlew</code></pre>
</div>
</div>
</li>
</ol>
</div>
</li>
<li>
<p>At this point you need to change the wiki specific attributes to complete the setup.</p>
<div class="ulist">
<ul>
<li>
<p>See <a href="#Changing-Wiki-Specific-Attributes#">Changing Wiki Specific Attributes</a></p>
</li>
</ul>
</div>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="changing-wiki-specific-attributes"><a class="anchor" href="#changing-wiki-specific-attributes"></a>Changing Wiki Specific Attributes</h3>
<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>These changes will make your copy of the wiki, including all links, 100% dependent on your <code><strong>gh-pages</strong></code> branch. You&#8217;re on your own after this point so if you want selective links to still point to the official wiki, it&#8217;s up to you to determine which.</p>
</div>
<div class="paragraph">
<p>At minimum, you still have to change the attributes &#8220;endpoint-url&#8221;, &#8220;wiki_link_edit_prefix&#8221;, and &#8220;wiki_link_create_prefix&#8221; in the &#8220;<strong>build.gradle</strong>&#8221; file.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="olist arabic">
<div class="title">Git CommandLine</div>
<ol class="arabic">
<li>
<p>Using <a href="https://git-scm.com/docs/git-grep">Git Grep</a> or the command line editor of your choice, find and replace the following:</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Find the official wiki <code><strong>gh-pages</strong></code> address of <code>https://wiki.jmonkeyengine.org</code>.</p>
</li>
<li>
<p>Replace it with your <code><strong>gh-pages</strong></code> address <code>https://username.github.io/repo-name</code>.</p>
</li>
<li>
<p>Find the official wiki <code><strong>repository</strong></code> address of <code>https://github.com/jMonkeyEngine/wiki</code>.</p>
</li>
<li>
<p>Replace it with your <code><strong>repository</strong></code> address of <code>https://github.com/username/repo-name</code>.</p>
</li>
</ol>
</div>
</li>
<li>
<p>Change the <a href="https://docs.travis-ci.com/user/status-images/">build status link</a> for your repository in the README.adoc page.</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>image:https://travis-ci.org/jMonkeyEngine/wiki.svg?branch=master["Build Status", link="https://travis-ci.org/jMonkeyEngine/wiki"]</code></pre>
</div>
</div>
</li>
<li>
<p>After you have done all the above, commit and push to your wiki repository.</p>
</li>
</ol>
</div>
<div class="olist arabic">
<div class="title">Atom Editor</div>
<ol class="arabic">
<li>
<p>Select <code><span class="menuseq"><b class="menu">Find</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Find in Project</b></span></code> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>F</kbd>.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Enter the official wiki <code><strong>gh-pages</strong></code> address of <code>https://wiki.jmonkeyengine.org</code> into the search box and then select the <b class="button">Find All</b> button.</p>
</li>
<li>
<p>Enter your <code><strong>gh-pages</strong></code> address <code>https://username.github.io/repo-name</code> in the &#8220;Replace All&#8221; box and when ready, select the <b class="button">Replace All</b> button.</p>
</li>
<li>
<p>Enter the official wiki <code><strong>repository</strong></code> address of <code>https://github.com/jMonkeyEngine/wiki</code> into the search box and then select the <b class="button">Find All</b> button.</p>
</li>
<li>
<p>Enter your <code><strong>repository</strong></code> address of <code>https://github.com/username/repo-name</code> in the &#8220;Replace All&#8221; box and when ready, select the <b class="button">Replace All</b> button.</p>
</li>
</ol>
</div>
</li>
<li>
<p>Change the <a href="https://docs.travis-ci.com/user/status-images/">build status link</a> for your repository in the README.adoc page.</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>image:https://travis-ci.org/jMonkeyEngine/wiki.svg?branch=master["Build Status", link="https://travis-ci.org/jMonkeyEngine/wiki"]</code></pre>
</div>
</div>
</li>
<li>
<p>After you have done all the above, <code><span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Save All</b></span></code>.</p>
</li>
<li>
<p>Open the Git panel, <code><span class="menuseq"><b class="menu">Packages</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">GitHub</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Toggle Git Tab</b></span></code> or <kbd>Ctrl</kbd> + <kbd>9</kbd>.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Stage All.</p>
</li>
<li>
<p>Enter a &#8220;initial commit&#8221; message.</p>
</li>
<li>
<p>Commit and push to your wiki repository. You can see the result after a few minutes.</p>
</li>
</ol>
</div>
</li>
</ol>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="conclusion"><a class="anchor" href="#conclusion"></a>Conclusion</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Travis should have built your copy of the wiki and moved all the .html to your &#8220;gh-pages&#8221; branch. If this didn&#8217;t happen, then something is wrong with your setup. Examine the logs of your repository from your Travis-CI account to help you troubleshoot where you went wrong. You can expand any of the command tags by clicking on them to get a more in-depth reveal of the logged info.</p>
</div>
<div class="paragraph">
<p>When you feel your repository is ready, create a thread on the <a href="https://hub.jmonkeyengine.org/">forum</a> requesting it be added to the official wiki. If approved, create a pull request of the wiki <a href="https://github.com/jMonkeyEngine/wiki/blob/master/src/docs/asciidoc/documentation.adoc">main page</a> adding your repository link under the &#8220;Languages&#8221; topic.</p>
</div>
<div class="paragraph">
<p>Thanks for your interest in removing the language barrier that may prevent other monkeys from learning more about the jMonkeyEngine.</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/vendor/docsearch.min.js"></script>
<!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
<script>
var search = docsearch({
  apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  indexName: 'jmonkeyengine',
  inputSelector: '#search-input',
  autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  algoliaOptions: { hitsPerPage: 10 }
}).autocomplete
search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
function focusSearchInput () { document.querySelector('#search-input').focus() }
if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
</script>
<script src="../../_/js/site.js"></script>
<script async src="../../_/js/vendor/highlight.js"></script>
  </body>
</html>