wiki_translation.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <title>Wiki Translation Repositories :: jMonkeyEngine Docs</title>
  7. <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs-wiki/3.8/wiki_translation.html">
  8. <meta name="generator" content="Antora 3.0.1">
  9. <link rel="stylesheet" href="../../_/css/site.css">
  10. <meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
  11. <meta property="og:description" content="Wiki Translation Repositories">
  12. <meta property="og:title" content="jMonkeyEngine Docs">
  13. <link rel="stylesheet" href="../../_/css/site-extra.css">
  14. <link rel="stylesheet" href="../../_/css/vendor/docsearch.min.css">
  15. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css -->
  16. <link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
  17. </head>
  18. <body class="article">
  19. <header class="header">
  20. <nav class="navbar">
  21. <div class="navbar-brand">
  22. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
  23. <img alt="" src="../../_/img/jme-logo.png" height="32" type="image/x-icon">
  24. </a>
  25. <div class="navbar-item hide-for-print">
  26. <input id="search-input" type="text" placeholder="Search docs">
  27. </div>
  28. <button class="navbar-burger" data-target="topbar-nav">
  29. <span></span>
  30. <span></span>
  31. <span></span>
  32. </button>
  33. </div>
  34. <div id="topbar-nav" class="navbar-menu">
  35. <div class="navbar-end">
  36. <div class="navbar-item theme-switch-wrapper">
  37. <label class="theme-switch" for="checkbox">
  38. <input type="checkbox" id="checkbox" />
  39. <div class="slider round"></div>
  40. </label>
  41. </div>
  42. <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
  43. </div>
  44. </div>
  45. </nav>
  46. </header>
  47. <div class="body">
  48. <div class="nav-container" data-component="docs-wiki" data-version="3.8">
  49. <aside class="nav">
  50. <div class="panels">
  51. <div class="nav-panel-menu is-active" data-panel="menu">
  52. <nav class="nav-menu">
  53. <h3 class="title"><a href="wiki_contributor.html">Wiki Contribution</a></h3>
  54. <ul class="nav-list">
  55. <li class="nav-item" data-depth="0">
  56. <ul class="nav-list">
  57. <li class="nav-item" data-depth="1">
  58. <a class="nav-link" href="wiki_contributor.html">Contributor</a>
  59. </li>
  60. <li class="nav-item" data-depth="1">
  61. <a class="nav-link" href="wiki_admin.html">Admin</a>
  62. </li>
  63. <li class="nav-item" data-depth="1">
  64. <a class="nav-link" href="emoji.html">Emoji</a>
  65. </li>
  66. <li class="nav-item" data-depth="1">
  67. <a class="nav-link" href="atom_editor.html">Atom Editor</a>
  68. </li>
  69. <li class="nav-item" data-depth="1">
  70. <a class="nav-link" href="atom_snippets.html">Atom Snippets</a>
  71. </li>
  72. </ul>
  73. </li>
  74. </ul>
  75. </nav>
  76. </div>
  77. <div class="nav-panel-explore" data-panel="explore">
  78. <div class="context">
  79. <span class="title">Wiki Contribution</span>
  80. <span class="version">3.8</span>
  81. </div>
  82. <ul class="components">
  83. <li class="component">
  84. <span class="title">JME</span>
  85. <ul class="versions">
  86. <li class="version">
  87. <a href="../../docs/3.8/documentation.html">3.8</a>
  88. </li>
  89. <li class="version">
  90. <a href="../../docs/3.4/documentation.html">3.4</a>
  91. </li>
  92. <li class="version">
  93. <a href="../../docs/3.3/documentation.html">3.3</a>
  94. </li>
  95. <li class="version">
  96. <a href="../../docs/3.2/documentation.html">3.2</a>
  97. </li>
  98. </ul>
  99. </li>
  100. <li class="component is-current">
  101. <span class="title">Wiki Contribution</span>
  102. <ul class="versions">
  103. <li class="version is-current">
  104. <a href="wiki_contributor.html">3.8</a>
  105. </li>
  106. </ul>
  107. </li>
  108. <li class="component">
  109. <span class="title">Wiki UI</span>
  110. <ul class="versions">
  111. <li class="version">
  112. <a href="../../wiki-ui/index.html">master</a>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. </div>
  118. </div>
  119. </aside>
  120. </div>
  121. <main class="article">
  122. <div class="toolbar" role="navigation">
  123. <button class="nav-toggle"></button>
  124. <nav class="breadcrumbs" aria-label="breadcrumbs">
  125. <ul>
  126. <li><a href="wiki_contributor.html">Wiki Contribution</a></li>
  127. <li><a href="wiki_translation.html">Wiki Translation Repositories</a></li>
  128. </ul>
  129. </nav>
  130. <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs-wiki/modules/ROOT/pages/wiki_translation.adoc">Edit this Page</a></div>
  131. </div>
  132. <div class="content">
  133. <article class="doc">
  134. <h1 class="page">Wiki Translation Repositories</h1>
  135. <div id="preamble">
  136. <div class="sectionbody">
  137. <div class="paragraph">
  138. <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>
  139. </div>
  140. <div class="paragraph">
  141. <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>
  142. </div>
  143. <div class="paragraph">
  144. <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="#ROOT:documentation.adoc#languages" class="xref unresolved">Languages</a> topic.</p>
  145. </div>
  146. <div class="admonitionblock warning">
  147. <table>
  148. <tr>
  149. <td class="icon">
  150. <i class="fa icon-warning" title="Warning"></i>
  151. </td>
  152. <td class="content">
  153. <div class="paragraph">
  154. <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="#ROOT:bsd_license.adoc" class="xref unresolved">jMonkeyEngine licensing</a>.</p>
  155. </div>
  156. <div class="paragraph">
  157. <p>This includes the use of a domain name that includes the jMonkeyEngine name.</p>
  158. </div>
  159. </td>
  160. </tr>
  161. </table>
  162. </div>
  163. </div>
  164. </div>
  165. <div class="sect1">
  166. <h2 id="prerequisites"><a class="anchor" href="#prerequisites"></a>Prerequisites</h2>
  167. <div class="sectionbody">
  168. <div class="paragraph">
  169. <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>
  170. </div>
  171. <div class="paragraph">
  172. <p>You will need to meet these requirements to continue:</p>
  173. </div>
  174. <div class="ulist">
  175. <ul>
  176. <li>
  177. <p>A <a href="https://github.com/">GitHub</a> account.</p>
  178. </li>
  179. <li>
  180. <p>Either <a href="https://help.github.com/articles/set-up-git/">Git</a> or the <a href="atom_editor.html" class="xref page">Atom Editor</a> installed on your system.</p>
  181. </li>
  182. </ul>
  183. </div>
  184. <div class="admonitionblock note">
  185. <table>
  186. <tr>
  187. <td class="icon">
  188. <i class="fa icon-note" title="Note"></i>
  189. </td>
  190. <td class="content">
  191. 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.
  192. </td>
  193. </tr>
  194. </table>
  195. </div>
  196. <div class="admonitionblock tip">
  197. <table>
  198. <tr>
  199. <td class="icon">
  200. <i class="fa icon-tip" title="Tip"></i>
  201. </td>
  202. <td class="content">
  203. <div class="paragraph">
  204. <p>For a list of git commands, use one of these:</p>
  205. </div>
  206. <div class="ulist">
  207. <ul>
  208. <li>
  209. <p><a href="https://services.github.com/on-demand/resources/cheatsheets/">Git Cheat Sheets</a></p>
  210. </li>
  211. <li>
  212. <p><a href="http://rogerdudler.github.io/git-guide/">git - the simple guide</a></p>
  213. </li>
  214. </ul>
  215. </div>
  216. <div class="paragraph">
  217. <p>See also Travis-CI:</p>
  218. </div>
  219. <div class="ulist">
  220. <ul>
  221. <li>
  222. <p><a href="https://docs.travis-ci.com/user/getting-started/">Getting Started</a></p>
  223. </li>
  224. </ul>
  225. </div>
  226. </td>
  227. </tr>
  228. </table>
  229. </div>
  230. </div>
  231. </div>
  232. <div class="sect1">
  233. <h2 id="githubtravis-ci-setup"><a class="anchor" href="#githubtravis-ci-setup"></a>GitHub/Travis CI Setup</h2>
  234. <div class="sectionbody">
  235. <div class="paragraph">
  236. <p>This topic applies to both Git and the Atom Editor. You must do this before you do anything else.</p>
  237. </div>
  238. <div class="olist arabic">
  239. <div class="title">Github</div>
  240. <ol class="arabic">
  241. <li>
  242. <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>
  243. <div class="olist loweralpha">
  244. <ol class="loweralpha" type="a">
  245. <li>
  246. <p>Enter a unique name for your repository.</p>
  247. </li>
  248. </ol>
  249. </div>
  250. </li>
  251. <li>
  252. <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>
  253. <div class="olist loweralpha">
  254. <ol class="loweralpha" type="a">
  255. <li>
  256. <p>This will automatically setup your repository for compiling &#8220;gh-pages&#8221;.</p>
  257. </li>
  258. <li>
  259. <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>
  260. <div class="admonitionblock note">
  261. <table>
  262. <tr>
  263. <td class="icon">
  264. <i class="fa icon-note" title="Note"></i>
  265. </td>
  266. <td class="content">
  267. <div class="paragraph">
  268. <p>There are two URLs you will need for configuration.</p>
  269. </div>
  270. <div class="ulist">
  271. <ul>
  272. <li>
  273. <p>Your <code><strong>gh-pages</strong></code> URL: https://username.github.io/repo-name/</p>
  274. </li>
  275. <li>
  276. <p>Your <code><strong>repository</strong></code> URL: https://github.com/username/repo-name</p>
  277. </li>
  278. </ul>
  279. </div>
  280. <div class="paragraph">
  281. <p>This is how they will be referred to in this tutorial.</p>
  282. </div>
  283. </td>
  284. </tr>
  285. </table>
  286. </div>
  287. </li>
  288. </ol>
  289. </div>
  290. </li>
  291. <li>
  292. <p>Setup GH_TOKEN variable:</p>
  293. <div class="olist loweralpha">
  294. <ol class="loweralpha" type="a">
  295. <li>
  296. <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>
  297. </li>
  298. <li>
  299. <p>Describe it however you wish and then you will need to check some boxes. Check these ones:</p>
  300. <div class="ulist checklist">
  301. <ul class="checklist">
  302. <li>
  303. <p><i class="fa fa-check-square-o"></i> public_repo</p>
  304. <div class="openblock">
  305. <div class="content">
  306. <div class="paragraph">
  307. <p>If your repository is private, you can set repo instead.</p>
  308. </div>
  309. <div class="paragraph">
  310. <p>GitHub will create the token and show a page with the value.</p>
  311. </div>
  312. <div class="admonitionblock warning">
  313. <table>
  314. <tr>
  315. <td class="icon">
  316. <i class="fa icon-warning" title="Warning"></i>
  317. </td>
  318. <td class="content">
  319. <strong>THIS IS THE ONLY TIME YOU GET TO SEE THIS SO DON&#8217;T CLICK AWAY IMMEDIATELY!</strong>
  320. </td>
  321. </tr>
  322. </table>
  323. </div>
  324. <div class="paragraph">
  325. <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>
  326. </div>
  327. </div>
  328. </div>
  329. </li>
  330. </ul>
  331. </div>
  332. </li>
  333. </ol>
  334. </div>
  335. </li>
  336. </ol>
  337. </div>
  338. <div class="olist arabic">
  339. <div class="title">Travis CI</div>
  340. <ol class="arabic">
  341. <li>
  342. <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>
  343. </li>
  344. <li>
  345. <p>Click the &#8220;Travis-CI&#8221; link. If you don&#8217;t see one listed, find it using the search box.</p>
  346. </li>
  347. <li>
  348. <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>
  349. <div class="olist loweralpha">
  350. <ol class="loweralpha" type="a">
  351. <li>
  352. <p>When ready, select the <b class="button">Install</b> button.</p>
  353. </li>
  354. <li>
  355. <p>Click through until you are redirected to the Travis-Ci website.</p>
  356. </li>
  357. </ol>
  358. </div>
  359. </li>
  360. <li>
  361. <p>On Travis-CI, flick the repository switch on for your gh-pages project.</p>
  362. <div class="admonitionblock tip">
  363. <table>
  364. <tr>
  365. <td class="icon">
  366. <i class="fa icon-tip" title="Tip"></i>
  367. </td>
  368. <td class="content">
  369. You can’t see your project on the list? Click on the Sync account button (top right) and it should be OK.
  370. </td>
  371. </tr>
  372. </table>
  373. </div>
  374. </li>
  375. <li>
  376. <p>Click the <span class="icon"><i class="fa fa-cog"></i></span> cog to go to the settings tab and configure it.</p>
  377. <div class="olist loweralpha">
  378. <ol class="loweralpha" type="a">
  379. <li>
  380. <p>Check some options on General:</p>
  381. <div class="olist lowerroman">
  382. <ol class="lowerroman" type="i">
  383. <li>
  384. <p>check the Build only if .travis.yml is present option.</p>
  385. </li>
  386. <li>
  387. <p>Check the Build pushed options.</p>
  388. </li>
  389. </ol>
  390. </div>
  391. </li>
  392. <li>
  393. <p>Create some Environment Variables that will be used in .travis.yml file:</p>
  394. <div class="olist lowerroman">
  395. <ol class="lowerroman" type="i">
  396. <li>
  397. <p>GH_TOKEN: the token created on previous step.</p>
  398. <div class="admonitionblock warning">
  399. <table>
  400. <tr>
  401. <td class="icon">
  402. <i class="fa icon-warning" title="Warning"></i>
  403. </td>
  404. <td class="content">
  405. Uncheck the Display value in build log option. This is the default action.
  406. </td>
  407. </tr>
  408. </table>
  409. </div>
  410. </li>
  411. </ol>
  412. </div>
  413. </li>
  414. </ol>
  415. </div>
  416. </li>
  417. </ol>
  418. </div>
  419. <div class="sect2">
  420. <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>
  421. <div class="olist arabic">
  422. <ol class="arabic">
  423. <li>
  424. <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>
  425. <div class="listingblock">
  426. <div class="content">
  427. <pre class="highlightjs highlight"><code class="language-none hljs">$ git clone https://github.com/jMonkeyEngine/wiki.git
  428. $ git clone https://github.com/user/repository.git
  429. $ cd repository
  430. $ git checkout master</code></pre>
  431. </div>
  432. </div>
  433. </li>
  434. <li>
  435. <p>Copy everything from the localized wiki repository to the localized new repository, especially these files:</p>
  436. <div class="olist loweralpha">
  437. <ol class="loweralpha" type="a">
  438. <li>
  439. <p>.travis.yml</p>
  440. </li>
  441. <li>
  442. <p>build.gradle</p>
  443. </li>
  444. <li>
  445. <p>deploy_ghpages.sh</p>
  446. </li>
  447. <li>
  448. <p>gradlew</p>
  449. <div class="openblock">
  450. <div class="content">
  451. <div class="paragraph">
  452. <p><code>Travis CI</code> will execute <code>./gradlew asciidoctor</code> and <code>./deploy_ghpages.sh</code> after you push your commits.</p>
  453. </div>
  454. <div class="admonitionblock important">
  455. <table>
  456. <tr>
  457. <td class="icon">
  458. <i class="fa icon-important" title="Important"></i>
  459. </td>
  460. <td class="content">
  461. 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.
  462. </td>
  463. </tr>
  464. </table>
  465. </div>
  466. </div>
  467. </div>
  468. </li>
  469. </ol>
  470. </div>
  471. </li>
  472. <li>
  473. <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>
  474. <div class="listingblock">
  475. <div class="content">
  476. <pre class="highlightjs highlight"><code class="language-none hljs">git update-index --chmod=+x deploy_ghpages.sh
  477. git update-index --chmod=+x gradlew
  478. git push</code></pre>
  479. </div>
  480. </div>
  481. </li>
  482. <li>
  483. <p>At this point you need to change the wiki specific attributes to complete the setup.</p>
  484. <div class="ulist">
  485. <ul>
  486. <li>
  487. <p>See <a href="#changing-wiki-specific-attributes">Changing Wiki Specific Attributes</a></p>
  488. </li>
  489. </ul>
  490. </div>
  491. </li>
  492. </ol>
  493. </div>
  494. </div>
  495. <div class="sect2">
  496. <h3 id="using-atom-editor-to-finish"><a class="anchor" href="#using-atom-editor-to-finish"></a>Using Atom Editor to finish</h3>
  497. <div class="paragraph">
  498. <p>This topic assumes you have already downloaded, installed and configured the <a href="atom_editor.html" class="xref page">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>
  499. </div>
  500. <div class="olist arabic">
  501. <ol class="arabic">
  502. <li>
  503. <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>
  504. <div class="olist loweralpha">
  505. <ol class="loweralpha" type="a">
  506. <li>
  507. <p>Delete the new page that opens by default.</p>
  508. </li>
  509. </ol>
  510. </div>
  511. </li>
  512. <li>
  513. <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>
  514. <div class="olist loweralpha">
  515. <ol class="loweralpha" type="a">
  516. <li>
  517. <p>Enter &#8220;github&#8221; into the search box.</p>
  518. </li>
  519. <li>
  520. <p>Select the <b class="button">GitHub Clone</b> button.</p>
  521. </li>
  522. <li>
  523. <p>Enter the URL to your <code><strong>repository</strong></code>.</p>
  524. </li>
  525. <li>
  526. <p>When ready, click the <b class="button">Clone</b> button.</p>
  527. </li>
  528. </ol>
  529. </div>
  530. </li>
  531. <li>
  532. <p>Copy everything from the localized wiki repository to the localized new repository, especially these files:</p>
  533. <div class="olist loweralpha">
  534. <ol class="loweralpha" type="a">
  535. <li>
  536. <p>.travis.yml</p>
  537. </li>
  538. <li>
  539. <p>build.gradle</p>
  540. </li>
  541. <li>
  542. <p>deploy_ghpages.sh</p>
  543. </li>
  544. <li>
  545. <p>gradlew</p>
  546. </li>
  547. </ol>
  548. </div>
  549. </li>
  550. <li>
  551. <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>
  552. <div class="olist loweralpha">
  553. <ol class="loweralpha" type="a">
  554. <li>
  555. <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>
  556. <div class="listingblock">
  557. <div class="title">Using Git Plus</div>
  558. <div class="content">
  559. <pre class="highlightjs highlight"><code class="language-none hljs">git update-index --chmod=+x deploy_ghpages.sh
  560. git update-index --chmod=+x gradlew
  561. git push</code></pre>
  562. </div>
  563. </div>
  564. </li>
  565. <li>
  566. <p>If you dont have Git, then edit the <code>travis.yml</code> file and add this after the <code>branches:</code> command.</p>
  567. <div class="listingblock">
  568. <div class="title">No Git Installed</div>
  569. <div class="content">
  570. <pre class="highlightjs highlight"><code class="language-none hljs">branches:
  571. except:
  572. - gh-pages
  573. # No git, change permissions here.
  574. before_install:
  575. - chmod +x deploy_ghpages.sh
  576. - chmod +x gradlew</code></pre>
  577. </div>
  578. </div>
  579. </li>
  580. </ol>
  581. </div>
  582. </li>
  583. <li>
  584. <p>At this point you need to change the wiki specific attributes to complete the setup.</p>
  585. <div class="ulist">
  586. <ul>
  587. <li>
  588. <p>See <a href="#changing-wiki-specific-attributes">Changing Wiki Specific Attributes</a></p>
  589. </li>
  590. </ul>
  591. </div>
  592. </li>
  593. </ol>
  594. </div>
  595. </div>
  596. <div class="sect2">
  597. <h3 id="changing-wiki-specific-attributes"><a class="anchor" href="#changing-wiki-specific-attributes"></a>Changing Wiki Specific Attributes</h3>
  598. <div class="admonitionblock important">
  599. <table>
  600. <tr>
  601. <td class="icon">
  602. <i class="fa icon-important" title="Important"></i>
  603. </td>
  604. <td class="content">
  605. <div class="paragraph">
  606. <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>
  607. </div>
  608. <div class="paragraph">
  609. <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>
  610. </div>
  611. </td>
  612. </tr>
  613. </table>
  614. </div>
  615. <div class="olist arabic">
  616. <div class="title">Git CommandLine</div>
  617. <ol class="arabic">
  618. <li>
  619. <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>
  620. <div class="olist loweralpha">
  621. <ol class="loweralpha" type="a">
  622. <li>
  623. <p>Find the official wiki <code><strong>gh-pages</strong></code> address of <code>https://wiki.jmonkeyengine.org</code>.</p>
  624. </li>
  625. <li>
  626. <p>Replace it with your <code><strong>gh-pages</strong></code> address <code>https://username.github.io/repo-name</code>.</p>
  627. </li>
  628. <li>
  629. <p>Find the official wiki <code><strong>repository</strong></code> address of <code>https://github.com/jMonkeyEngine/wiki</code>.</p>
  630. </li>
  631. <li>
  632. <p>Replace it with your <code><strong>repository</strong></code> address of <code>https://github.com/username/repo-name</code>.</p>
  633. </li>
  634. </ol>
  635. </div>
  636. </li>
  637. <li>
  638. <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>
  639. <div class="listingblock">
  640. <div class="content">
  641. <pre class="highlightjs highlight"><code class="language-none hljs">image:https://travis-ci.org/jMonkeyEngine/wiki.svg?branch=master["Build Status", link="https://travis-ci.org/jMonkeyEngine/wiki"]</code></pre>
  642. </div>
  643. </div>
  644. </li>
  645. <li>
  646. <p>After you have done all the above, commit and push to your wiki repository.</p>
  647. </li>
  648. </ol>
  649. </div>
  650. <div class="olist arabic">
  651. <div class="title">Atom Editor</div>
  652. <ol class="arabic">
  653. <li>
  654. <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>
  655. <div class="olist loweralpha">
  656. <ol class="loweralpha" type="a">
  657. <li>
  658. <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>
  659. </li>
  660. <li>
  661. <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>
  662. </li>
  663. <li>
  664. <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>
  665. </li>
  666. <li>
  667. <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>
  668. </li>
  669. </ol>
  670. </div>
  671. </li>
  672. <li>
  673. <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>
  674. <div class="listingblock">
  675. <div class="content">
  676. <pre class="highlightjs highlight"><code class="language-none hljs">image:https://travis-ci.org/jMonkeyEngine/wiki.svg?branch=master["Build Status", link="https://travis-ci.org/jMonkeyEngine/wiki"]</code></pre>
  677. </div>
  678. </div>
  679. </li>
  680. <li>
  681. <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>
  682. </li>
  683. <li>
  684. <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>
  685. <div class="olist loweralpha">
  686. <ol class="loweralpha" type="a">
  687. <li>
  688. <p>Stage All.</p>
  689. </li>
  690. <li>
  691. <p>Enter a &#8220;initial commit&#8221; message.</p>
  692. </li>
  693. <li>
  694. <p>Commit and push to your wiki repository. You can see the result after a few minutes.</p>
  695. </li>
  696. </ol>
  697. </div>
  698. </li>
  699. </ol>
  700. </div>
  701. </div>
  702. </div>
  703. </div>
  704. <div class="sect1">
  705. <h2 id="conclusion"><a class="anchor" href="#conclusion"></a>Conclusion</h2>
  706. <div class="sectionbody">
  707. <div class="paragraph">
  708. <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>
  709. </div>
  710. <div class="paragraph">
  711. <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/docs/modules/ROOT/pages/jme3.adoc">documentation page</a> adding your repository link under the &#8220;Languages&#8221; topic.</p>
  712. </div>
  713. <div class="paragraph">
  714. <p>Thanks for your interest in removing the language barrier that may prevent other monkeys from learning more about the jMonkeyEngine.</p>
  715. </div>
  716. </div>
  717. </div>
  718. </article>
  719. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  720. <div class="toc-menu"></div>
  721. </aside>
  722. </div>
  723. </main>
  724. </div>
  725. <footer class="footer">
  726. <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
  727. </footer>
  728. <script src="../../_/js/vendor/docsearch.min.js"></script>
  729. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
  730. <script>
  731. var search = docsearch({
  732. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  733. indexName: 'jmonkeyengine',
  734. inputSelector: '#search-input',
  735. autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  736. algoliaOptions: { hitsPerPage: 10 }
  737. }).autocomplete
  738. search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
  739. function focusSearchInput () { document.querySelector('#search-input').focus() }
  740. if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
  741. </script>
  742. <script src="../../_/js/site.js"></script>
  743. <script async src="../../_/js/vendor/highlight.js"></script>
  744. </body>
  745. </html>