third-party/codemirror-3.15/mode/tiddlywiki/index.html

   1 <!doctype html>
   2 <html>
   3   <head>
   4     <meta charset="utf-8">
   5     <title>CodeMirror: TiddlyWiki mode</title>
   6     <link rel="stylesheet" href="../../lib/codemirror.css">
   7     <script src="../../lib/codemirror.js"></script>
   8     <script src="../../addon/edit/matchbrackets.js"></script>
   9     <script src="tiddlywiki.js"></script>
  10     <link rel="stylesheet" href="tiddlywiki.css">
  11     <link rel="stylesheet" href="../../doc/docs.css">
  12     <style type="text/css">.CodeMirror {border-top: 1px solid black; border-bottom: 1px solid black;}</style>
  13   </head>
  14   <body>
  15     <h1>CodeMirror: TiddlyWiki mode</h1>
  16
  17 <div><textarea id="code" name="code">
  18 !TiddlyWiki Formatting
  19 * Rendered versions can be found at: http://www.tiddlywiki.com/#Reference
  20
  21 |!Option            | !Syntax            |
  22 |bold font          | ''bold''           |
  23 |italic type        | //italic//         |
  24 |underlined text    | __underlined__     |
  25 |strikethrough text | --strikethrough--  |
  26 |superscript text   | super^^script^^    |
  27 |subscript text     | sub~~script~~      |
  28 |highlighted text   | @@highlighted@@    |
  29 |preformatted text  | {{{preformatted}}} |
  30
  31 !Block Elements
  32 <<<
  33 !Heading 1
  34
  35 !!Heading 2
  36
  37 !!!Heading 3
  38
  39 !!!!Heading 4
  40
  41 !!!!!Heading 5
  42 <<<
  43
  44 !!Lists
  45 <<<
  46 * unordered list, level 1
  47 ** unordered list, level 2
  48 *** unordered list, level 3
  49
  50 # ordered list, level 1
  51 ## ordered list, level 2
  52 ### unordered list, level 3
  53
  54 ; definition list, term
  55 : definition list, description
  56 <<<
  57
  58 !!Blockquotes
  59 <<<
  60 > blockquote, level 1
  61 >> blockquote, level 2
  62 >>> blockquote, level 3
  63
  64 > blockquote
  65 <<<
  66
  67 !!Preformatted Text
  68 <<<
  69 {{{
  70 preformatted (e.g. code)
  71 }}}
  72 <<<
  73
  74 !!Code Sections
  75 <<<
  76 {{{
  77 Text style code
  78 }}}
  79
  80 //{{{
  81 JS styled code. TiddlyWiki mixed mode should support highlighter switching in the future.
  82 //}}}
  83
  84 <!--{{{-->
  85 XML styled code. TiddlyWiki mixed mode should support highlighter switching in the future.
  86 <!--}}}-->
  87 <<<
  88
  89 !!Tables
  90 <<<
  91 |CssClass|k
  92 |!heading column 1|!heading column 2|
  93 |row 1, column 1|row 1, column 2|
  94 |row 2, column 1|row 2, column 2|
  95 |>|COLSPAN|
  96 |ROWSPAN| ... |
  97 |~| ... |
  98 |CssProperty:value;...| ... |
  99 |caption|c
 100
 101 ''Annotation:''
 102 * The {{{>}}} marker creates a "colspan", causing the current cell to merge with the one to the right.
 103 * The {{{~}}} marker creates a "rowspan", causing the current cell to merge with the one above.
 104 <<<
 105 !!Images /% TODO %/
 106 cf. [[TiddlyWiki.com|http://www.tiddlywiki.com/#EmbeddedImages]]
 107
 108 !Hyperlinks
 109 * [[WikiWords|WikiWord]] are automatically transformed to hyperlinks to the respective tiddler
 110 ** the automatic transformation can be suppressed by preceding the respective WikiWord with a tilde ({{{~}}}): {{{~WikiWord}}}
 111 * [[PrettyLinks]] are enclosed in square brackets and contain the desired tiddler name: {{{[[tiddler name]]}}}
 112 ** optionally, a custom title or description can be added, separated by a pipe character ({{{|}}}): {{{[[title|target]]}}}<br>'''N.B.:''' In this case, the target can also be any website (i.e. URL).
 113
 114 !Custom Styling
 115 * {{{@@CssProperty:value;CssProperty:value;...@@}}}<br>''N.B.:'' CSS color definitions should use lowercase letters to prevent the inadvertent creation of WikiWords.
 116 * <html><code>{{customCssClass{...}}}</code></html>
 117 * raw HTML can be inserted by enclosing the respective code in HTML tags: {{{<html> ... </html>}}}
 118
 119 !Special Markers
 120 * {{{<br>}}} forces a manual line break
 121 * {{{----}}} creates a horizontal ruler
 122 * [[HTML entities|http://www.tiddlywiki.com/#HtmlEntities]]
 123 * [[HTML entities local|HtmlEntities]]
 124 * {{{<<macroName>>}}} calls the respective [[macro|Macros]]
 125 * To hide text within a tiddler so that it is not displayed, it can be wrapped in {{{/%}}} and {{{%/}}}.<br/>This can be a useful trick for hiding drafts or annotating complex markup.
 126 * To prevent wiki markup from taking effect for a particular section, that section can be enclosed in three double quotes: e.g. {{{"""WikiWord"""}}}.
 127 </textarea></div>
 128
 129     <script>
 130       var editor = CodeMirror.fromTextArea(document.getElementById("code"), {
 131         mode: 'tiddlywiki',
 132         lineNumbers: true,
 133         enterMode: 'keep',
 134         matchBrackets: true
 135       });
 136     </script>
 137
 138     <p>TiddlyWiki mode supports a single configuration.</p>
 139
 140     <p><strong>MIME types defined:</strong> <code>text/x-tiddlywiki</code>.</p>
 141   </body>
 142 </html>