atom_snippets.html 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  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>Atom Snippets :: jMonkeyEngine Docs</title>
  7. <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs-wiki/3.8/atom_snippets.html">
  8. <link rel="prev" href="atom_editor.html">
  9. <meta name="generator" content="Antora 3.0.1">
  10. <link rel="stylesheet" href="../../_/css/site.css">
  11. <meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
  12. <meta property="og:description" content="Atom Snippets">
  13. <meta property="og:title" content="jMonkeyEngine Docs">
  14. <link rel="stylesheet" href="../../_/css/site-extra.css">
  15. <link rel="stylesheet" href="../../_/css/vendor/docsearch.min.css">
  16. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css -->
  17. <link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
  18. </head>
  19. <body class="article">
  20. <header class="header">
  21. <nav class="navbar">
  22. <div class="navbar-brand">
  23. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
  24. <img alt="" src="../../_/img/jme-logo.png" height="32" type="image/x-icon">
  25. </a>
  26. <div class="navbar-item hide-for-print">
  27. <input id="search-input" type="text" placeholder="Search docs">
  28. </div>
  29. <button class="navbar-burger" data-target="topbar-nav">
  30. <span></span>
  31. <span></span>
  32. <span></span>
  33. </button>
  34. </div>
  35. <div id="topbar-nav" class="navbar-menu">
  36. <div class="navbar-end">
  37. <div class="navbar-item theme-switch-wrapper">
  38. <label class="theme-switch" for="checkbox">
  39. <input type="checkbox" id="checkbox" />
  40. <div class="slider round"></div>
  41. </label>
  42. </div>
  43. <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
  44. </div>
  45. </div>
  46. </nav>
  47. </header>
  48. <div class="body">
  49. <div class="nav-container" data-component="docs-wiki" data-version="3.8">
  50. <aside class="nav">
  51. <div class="panels">
  52. <div class="nav-panel-menu is-active" data-panel="menu">
  53. <nav class="nav-menu">
  54. <h3 class="title"><a href="wiki_contributor.html">Wiki Contribution</a></h3>
  55. <ul class="nav-list">
  56. <li class="nav-item" data-depth="0">
  57. <ul class="nav-list">
  58. <li class="nav-item" data-depth="1">
  59. <a class="nav-link" href="wiki_contributor.html">Contributor</a>
  60. </li>
  61. <li class="nav-item" data-depth="1">
  62. <a class="nav-link" href="wiki_admin.html">Admin</a>
  63. </li>
  64. <li class="nav-item" data-depth="1">
  65. <a class="nav-link" href="emoji.html">Emoji</a>
  66. </li>
  67. <li class="nav-item" data-depth="1">
  68. <a class="nav-link" href="atom_editor.html">Atom Editor</a>
  69. </li>
  70. <li class="nav-item is-current-page" data-depth="1">
  71. <a class="nav-link" href="atom_snippets.html">Atom Snippets</a>
  72. </li>
  73. </ul>
  74. </li>
  75. </ul>
  76. </nav>
  77. </div>
  78. <div class="nav-panel-explore" data-panel="explore">
  79. <div class="context">
  80. <span class="title">Wiki Contribution</span>
  81. <span class="version">3.8</span>
  82. </div>
  83. <ul class="components">
  84. <li class="component">
  85. <span class="title">JME</span>
  86. <ul class="versions">
  87. <li class="version">
  88. <a href="../../docs/3.8/documentation.html">3.8</a>
  89. </li>
  90. <li class="version">
  91. <a href="../../docs/3.4/documentation.html">3.4</a>
  92. </li>
  93. <li class="version">
  94. <a href="../../docs/3.3/documentation.html">3.3</a>
  95. </li>
  96. <li class="version">
  97. <a href="../../docs/3.2/documentation.html">3.2</a>
  98. </li>
  99. </ul>
  100. </li>
  101. <li class="component is-current">
  102. <span class="title">Wiki Contribution</span>
  103. <ul class="versions">
  104. <li class="version is-current">
  105. <a href="wiki_contributor.html">3.8</a>
  106. </li>
  107. </ul>
  108. </li>
  109. <li class="component">
  110. <span class="title">Wiki UI</span>
  111. <ul class="versions">
  112. <li class="version">
  113. <a href="../../wiki-ui/index.html">master</a>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. </div>
  119. </div>
  120. </aside>
  121. </div>
  122. <main class="article">
  123. <div class="toolbar" role="navigation">
  124. <button class="nav-toggle"></button>
  125. <nav class="breadcrumbs" aria-label="breadcrumbs">
  126. <ul>
  127. <li><a href="wiki_contributor.html">Wiki Contribution</a></li>
  128. <li><a href="atom_snippets.html">Atom Snippets</a></li>
  129. </ul>
  130. </nav>
  131. <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs-wiki/modules/ROOT/pages/atom_snippets.adoc">Edit this Page</a></div>
  132. </div>
  133. <div class="content">
  134. <article class="doc">
  135. <h1 class="page">Atom Snippets</h1>
  136. <div class="paragraph">
  137. <p>Copy and paste this text into your Atom Editor <span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Snippets&#8230;&#8203;</b></span> page to add some useful shortcuts. Feel free to contribute any changes so other editors can benifit by selecting the &#8220;Edit this Page&#8221; link in the header of this page and submitting a pull request in the wiki repo.</p>
  138. </div>
  139. <div class="listingblock">
  140. <div class="content">
  141. <pre class="highlightjs highlight"><code class="language-none hljs"># Your snippets
  142. #
  143. # Atom snippets allow you to enter a simple prefix in the editor and hit tab to
  144. # expand the prefix into a larger code block with templated values.
  145. #
  146. # You can create a new snippet in this file by typing "snip" and then hitting
  147. # tab.
  148. #
  149. # An example CoffeeScript snippet to expand log to console.log:
  150. #
  151. # '.source.coffee':
  152. # 'Console log':
  153. # 'prefix': 'log'
  154. # 'body': 'console.log $1'
  155. #
  156. # Each scope (e.g. '.source.coffee' above) can only be declared once.
  157. #
  158. # This file uses CoffeeScript Object Notation (CSON).
  159. # If you are unfamiliar with CSON, you can read more about it in the
  160. # Atom Flight Manual:
  161. # http://flight-manual.atom.io/using-atom/sections/basic-customization/#_cson
  162. '.source.asciidoc':
  163. 'Cross reference internal element, same page':
  164. 'prefix': 'xrefI'
  165. 'body': '&lt;&lt;${1:reference-a-section-in-the-same-page},${2:label text}&gt;&gt;'
  166. 'Cross reference internal element, same module':
  167. 'prefix': 'xrefIsm'
  168. 'body': '&lt;&lt;${1:target-page-filename}.adoc#${2:reference-section},${3:label text}&gt;&gt;'
  169. 'Cross reference internal element, named module':
  170. 'prefix': 'xrefInm'
  171. 'body': '&lt;&lt;${1:module-name}:${2:target-page-filename}.adoc#${3:reference-section},${4:label text}&gt;&gt;'
  172. 'Cross reference page, same module':
  173. 'prefix': 'xrefPsm'
  174. 'body': 'xref:${1:target-page-filename}.adoc[${2:link text}]'
  175. 'Cross reference page, named module':
  176. 'prefix': 'xrefPnm'
  177. 'body': 'xref:${1:module-name}:${2:target-page-filename}.adoc[${3:link text}]'
  178. 'Cross reference page, ROOT module':
  179. 'prefix': 'xrefPrm'
  180. 'body': 'xref:ROOT:${1:target-page-filename}.adoc[${2:link text}]'
  181. 'Admonition Block':
  182. 'prefix': 'admonB'
  183. 'body': """
  184. [${1:NOTE}${2:TIP}${3:IMPORTANT}${4:CAUTION}${5:WARNING}]
  185. ====
  186. $6
  187. ====
  188. $7
  189. """
  190. 'Admonition Block with Title':
  191. 'prefix': 'admonBwT'
  192. 'body': """
  193. [${1:NOTE}${2:TIP}${3:IMPORTANT}${4:CAUTION}${5:WARNING}]
  194. .${6:Optional Title}
  195. ====
  196. $7
  197. ====
  198. $8
  199. """
  200. 'Admonition Paragraph':
  201. 'prefix': 'admonP'
  202. 'body': """
  203. ${1:NOTE}${2:TIP}${3:IMPORTANT}${4:CAUTION}${5:WARNING}: $6
  204. """
  205. 'Admonition Paragraph with Title':
  206. 'prefix': 'admonPwT'
  207. 'body': """
  208. .${1:Optional Title}
  209. ${2:NOTE}${3:TIP}${4:IMPORTANT}${5:CAUTION}${6:WARNING}: $7
  210. """
  211. 'Include partial same module':
  212. 'prefix': 'part'
  213. 'body': 'include::partial$${1:partial-filename}.adoc[${3:line=}${4:tag=}${5:tags=}]'
  214. 'Include partial different module':
  215. 'prefix': 'partM'
  216. 'body': 'include::${1:module}:partial$${2:partial-filename}.adoc[${3:line=}${4:tag=}${5:tags=}]'
  217. 'Include partial ROOT':
  218. 'prefix': 'partR'
  219. 'body': 'include::ROOT:partial$${1:partial-filename}.adoc[${2:line=}${3:tag=}${4:tags=}]'
  220. 'Module inline image':
  221. 'prefix': 'imgMI'
  222. 'body': 'image:${1:module}:${2:target-resource-filename.ext}[${3:}]'
  223. 'Module block image':
  224. 'prefix': 'imgMB'
  225. 'body': 'image::${1:module}:${2:target-resource-filename.ext}[${3:}]'
  226. 'ROOT inline image':
  227. 'prefix': 'imgRI'
  228. 'body': 'image:ROOT:${1:target-resource-filename.ext}[${2:}]'
  229. 'ROOT block image':
  230. 'prefix': 'imgRB'
  231. 'body': 'image::ROOT:${1:target-resource-filename.ext}[${2:}]'</code></pre>
  232. </div>
  233. </div>
  234. <nav class="pagination">
  235. <span class="prev"><a href="atom_editor.html">Atom Editor</a></span>
  236. </nav>
  237. </article>
  238. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  239. <div class="toc-menu"></div>
  240. </aside>
  241. </div>
  242. </main>
  243. </div>
  244. <footer class="footer">
  245. <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
  246. </footer>
  247. <script src="../../_/js/vendor/docsearch.min.js"></script>
  248. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
  249. <script>
  250. var search = docsearch({
  251. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  252. indexName: 'jmonkeyengine',
  253. inputSelector: '#search-input',
  254. autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  255. algoliaOptions: { hitsPerPage: 10 }
  256. }).autocomplete
  257. search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
  258. function focusSearchInput () { document.querySelector('#search-input').focus() }
  259. if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
  260. </script>
  261. <script src="../../_/js/site.js"></script>
  262. <script async src="../../_/js/vendor/highlight.js"></script>
  263. </body>
  264. </html>