atom_snippets.html 6.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <!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>Atom Snippets Page</title><link rel="stylesheet" href="./asciidoctor.css">
  2. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css">
  3. <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/atom_snippets.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>Atom Snippets Page</h1><div class="details"><span class="author" id="author">mitm</span><br><span id="revnumber">version 2,</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="#snippets-explained">Snippets Explained</a></li></ul></div></div><div id="content"><div id="preamble"><div class="sectionbody"><div class="paragraph"><p>Edit this file to add snippets to the snippets.cson file for the
  4. <a href="https://atom.io/">Atom editor</a>. To use these snippets just copy and paste
  5. the text below into your snippets.cson file.</p></div>
  6. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code># Your snippets
  7. #
  8. # Atom snippets allow you to enter a simple prefix in the editor and hit tab to
  9. # expand the prefix into a larger code block with templated values.
  10. #
  11. # You can create a new snippet in this file by typing "snip" and then hitting
  12. # tab.
  13. #
  14. # An example CoffeeScript snippet to expand log to console.log:
  15. #
  16. # '.source.coffee':
  17. # 'Console log':
  18. # 'prefix': 'log'
  19. # 'body': 'console.log $1'
  20. #
  21. # Each scope (e.g. '.source.coffee' above) can only be declared once.
  22. #
  23. # This file uses CoffeeScript Object Notation (CSON).
  24. # If you are unfamiliar with CSON, you can read more about it in the
  25. # Atom Flight Manual:
  26. # http://flight-manual.atom.io/using-atom/sections/basic-customization/#_cson
  27. '.source.asciidoc':
  28. 'Inter-Doc Cross Reference':
  29. 'prefix': 'xref'
  30. 'body': '&lt;&lt;${1:path/to/wiki/page}#,${2:custom label text}&gt;&gt;'
  31. 'Admonition Block':
  32. 'prefix': 'admonB'
  33. 'body': """
  34. [${1:NOTE}${2:TIP}${3:IMPORTANT}${4:CAUTION}${5:WARNING}]
  35. ====
  36. $6
  37. ====
  38. $7
  39. """
  40. 'Admonition Block with Title':
  41. 'prefix': 'admonBwT'
  42. 'body': """
  43. [${1:NOTE}${2:TIP}${3:IMPORTANT}${4:CAUTION}${5:WARNING}]
  44. .${6:Optional Title}
  45. ====
  46. $7
  47. ====
  48. $8
  49. """
  50. 'Admonition Paragraph':
  51. 'prefix': 'admonP'
  52. 'body': """
  53. ${1:NOTE}${2:TIP}${3:IMPORTANT}${4:CAUTION}${5:WARNING}: $6
  54. """
  55. 'Admonition Paragraph with Title':
  56. 'prefix': 'admonPwT'
  57. 'body': """
  58. .${1:Optional Title}
  59. ${2:NOTE}${3:TIP}${4:IMPORTANT}${5:CAUTION}${6:WARNING}: $7
  60. """</code></pre></div></div></div></div>
  61. <div class="sect1"><h2 id="snippets-explained">Snippets Explained</h2><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 10%;"><col style="width: 45%;"><col style="width: 45%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Prefix</th><th class="tableblock halign-left valign-top">Inserted Syntax</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><p class="tableblock">xref</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><code>&lt;&lt;path/to/wiki/page#,custom label text&gt;&gt;</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Inserts an <code>Inter-Document Cross Reference</code>.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">admonB</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">[NOTETIPIMPORTANTCAUTIONWARNING]<br>
  62. ====<br>
  63. ====</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Inserts an <code>Admonition Block</code> with the <mark>NOTE</mark> style highlighted. Use the <kbd>Tab</kbd> key to cycle to the next style
  64. and <kbd>Backspace</kbd> off any unwanted style as you go. The final <kbd>Tab</kbd> will take you into the block.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">admonBwT</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">[NOTETIPIMPORTANTCAUTIONWARNING]<br>
  65. .Optional Title<br>
  66. ====<br>
  67. ====</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Inserts an <code>Admonition Block</code> with title.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">admonP</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">NOTETIPIMPORTANTCAUTIONWARNING:</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Inserts an <code>Admonition Paragraph</code> with the <mark>NOTE</mark> style highlighted. Use the <kbd>Tab</kbd> key to cycle to the next style
  68. and <kbd>Backspace</kbd> off any unwanted style as you go. The final <kbd>Tab</kbd> will take you to the beginning of the paragraph.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">admonPwT</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">.Optional Title<br>
  69. NOTETIPIMPORTANTCAUTIONWARNING:</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Inserts an <code>Admonition Paragraph</code> with title.</p></td></tr></tbody></table></div></div></div><div id="footer"><div id="footer-text">Version 2<br>Last updated 2020-05-21 00:29:23 +00:00</div></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script>docsearch({
  70. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  71. indexName: 'jmonkeyengine',
  72. inputSelector: '#doc-search',
  73. debug: false // Set debug to true if you want to inspect the dropdown
  74. });</script></body></html>