gollum 1.1.1 → 1.2.0

data/lib/gollum/frontend/public/javascript/editor/langs/asciidoc.js

@@ -0,0 +1,168 @@
+/**
+ *  ASCIIDoc Language Definition
+ *
+ */
+
+(function() {
+
+var ASCIIDoc = {
+  
+  'function-bold' :         {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "*$1*$2"
+                            },
+  
+  'function-italic' :       {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "_$1_$2"
+                            },
+  
+  'function-code'   :       {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "+$1+$2"
+                            },
+  
+  'function-ul'     :       { 
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "* $1$2"
+                            },
+                   
+  'function-ol'   :         {
+                              search: /(.+)([\n]?)/g,
+                              replace: ". $1$2"
+                            },
+                            
+  'function-blockquote' :   {
+                              search: /(.+)([\n]?)/g,
+                              replace: "----\n$1$2\n----\n"
+                            },
+                            
+  'function-link'       :   {
+                              exec: function( txt, selText, $field ) {
+                                var results = null;
+                                $.GollumEditor.Dialog.init({
+                                  title: 'Insert Link',
+                                  fields: [
+                                    {
+                                      id:   'text',
+                                      name: 'Link Text',
+                                      type: 'text',
+                                      help: 'The text to display to the user.'
+                                    },
+                                    {
+                                      id:   'href',
+                                      name: 'URL',
+                                      type: 'text',
+                                      help: 'The URL to link to.'
+                                    }
+                                  ],
+                                  OK: function( res ) {
+                                   var h = '';
+                                   if ( res['text'] && res['href'] ) {
+                                      h = res['href'] + '[' + 
+                                          res['text'] + ']';
+                                    }
+                                    $.GollumEditor.replaceSelection( h );
+                                  }
+                                });
+                                
+                               
+                              }
+                            },
+                     
+  'function-image'      :   {
+                              exec: function( txt, selText, $field ) {
+                                var results = null;
+                                $.GollumEditor.Dialog.init({
+                                  title: 'Insert Image',
+                                  fields: [
+                                    {
+                                      id: 'url',
+                                      name: 'Image URL',
+                                      type: 'text'
+                                    },
+                                    {
+                                      id: 'alt',
+                                      name: 'Alt Text',
+                                      type: 'text'
+                                    }
+                                  ],
+                                  OK: function( res ) {
+                                    var h = '';
+                                    if ( res['url'] && res['alt'] ) {
+                                      h = 'image::' + res['url'] +
+                                          '[' + res['alt'] + ']';
+                                    }
+                                    $.GollumEditor.replaceSelection( h );
+                                  }
+                                });
+                              }
+                            }
+                            
+};
+
+jQuery.GollumEditor.defineLanguage('asciidoc', ASCIIDoc);
+
+
+var ASCIIDocHelp = [
+  {
+    menuName: 'Text Formatting',
+    content: [
+      {
+        menuName: 'Headers',
+        data: '<p>ASCIIDoc headers can be written in two ways: with differing underlines or with different indentation using <code>=</code> (equals sign). ASCIIDoc supports headings 1-4. The editor will automatically use the <code>=</code> notation. To create a level one header, prefix your line with one <code>=</code>. Level two headers are created with <code>==</code> and so on.</p>'
+      },
+      {
+        menuName: 'Bold / Italic',
+        data: '<p>To display text as <strong>bold</strong>, wrap the text in <code>*</code> (asterisks). To display text as <em>italic</em>, wrap the text in <code>_</code> (underscores). To create <code>monospace</code> text, wrap the text in <code>+</code> (plus signs).'
+      },
+      {
+        menuName: 'Scripts',
+        data: '<p>Superscript and subscript is created the same way as other inline formats. To create superscript text, wrap your text in <code>^</code> (carats). To create subscript text, wrap your text in <code>~</code> (tildes).</p>'
+      },
+      {
+        menuName: 'Special Characters',
+        data: '<p>ASCIIDoc will automatically convert textual representations of commonly-used special characters. For example, <code>(R)</code> becomes &reg;, <code>(C)</code> becomes &copy; and <code>(TM)</code> becomes &trade;.</p>'
+      }
+    ]
+  },
+  {
+    menuName: 'Blocks',
+    content: [
+      {
+        menuName: 'Paragraphs',
+        data: '<p>ASCIIDoc allows paragraphs to have optional titles or icons to denote special sections. To make a normal paragraph, simply add a line between blocks and a new paragraph will start. If you want to title your paragraphs, adda line prefixed by <code>.</code> (full stop). An example paragraph with optional title is displayed below:<br><br><code>.Optional Title<br><br>This is my paragraph. It is two sentences long.</code></p>'
+      },
+      {
+        menuName: 'Source Blocks',
+        data: '<p>To create source blocks (long blocks of code), follow the same syntax as above but with an extra line denoting the inline source and lines of four dashes (<code>----</code>) delimiting the source block.. An example of Python source is below:<br><br><code>.python.py<br>[source,python]<br>----<br># i just wrote a comment in python<br># and maybe one more<br>----</code></p>'
+      },
+      {
+        menuName: 'Comment Blocks',
+        data: '<p>Comment blocks are useful if you want to keep notes for yourself inline but do not want them displayed to the public. To create a comment block, simply wrap the paragraph in dividers with four slashes (<code>////</code>). An example comment block is below:<br><br><code>////<br>My comment block is here now<br><br>It can be multiple paragraphs. Really.<br>////</p>'
+      },
+      {
+        menuName: 'Quote Blocks',
+        data: '<p>Quote blocks work much like comment blocks &mdash; simply create dividers using four underscores (<code>____</code>) around your quote. An example quote block is displayed below:<br><code>____<br>This is my quote block. Quote something nice here, otherwise there is no point in quoting.<br>____</code></p>'
+      }
+    ]
+  },
+  {
+    menuName: 'Macros',
+    content: [
+      {
+        menuName: 'Links',
+        data: '<p>To create links to external pages, you can simply write the URI if you want the URI to link to itself. (i.e., <code>http://github.com/</code> will automatically be parsed to <a href="javascript:void(0);">http://github.com/</a>. If you want different text to be displayed, simply append it to the end of the URI in between <code>[</code> (brackets.) For example, <code>http://github.com/[GitHub]</code> will be parsed as <a href="javascript:void(0);">GitHub</a>, with the URI pointing to <code>http://github.com</code>.</p>'
+      },
+      {
+        menuName: 'Images',
+        data: '<p>Images in ASCIIDoc work much like hyperlinks, but image URLs are prefixed with <code>image:</code>. For example, to link to an image at <code>images/icons/home.png</code>, write <code>image:images/icons/home.png</code>. Alt text can be added by appending the text to the URI in <code>[</code> (brackets).</p>'
+      }
+    ] 
+  }
+];
+
+jQuery.GollumEditor.defineHelp('asciidoc', ASCIIDocHelp);
+
+})();
+

data/lib/gollum/frontend/public/javascript/editor/langs/creole.js

@@ -0,0 +1,103 @@
+/**
+ *  Creole Language Definition
+ *
+ */
+(function() {
+
+var Creole = {
+  
+  'function-bold' :         {
+                              search: /([^\n]+)([\n]*)/gi,
+                              replace: "**$1**$2"
+                            },
+  
+  'function-italic' :       {
+                              search: /([^\n]+)([\n]*)/gi,
+                              replace: "//$1//$2"
+                            },
+  
+  'function-code'   :       {
+                              search: /([^\n]+)([\n]*)/gi,
+                              replace: "{{{$1}}}$2"
+                            },
+                            
+  'function-hr'     :       {
+                              append: "\n\n----\n\n";
+                            },
+  
+  'function-ul'     :       { 
+                              search: /(.+)([\n]?)/gi,
+                              replace: "* $1$2"
+                            },
+  
+  /* This looks silly but is completely valid Markdown */                     
+  'function-ol'   :         {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "# $1$2"
+                            },
+                            
+  'function-link'       :   {
+                              exec: function( txt, selText, $field ) {
+                                var results = null;
+                                $.GollumEditor.Dialog.init({
+                                  title: 'Insert Link',
+                                  fields: [
+                                    {
+                                      id:   'text',
+                                      name: 'Link Text',
+                                      type: 'text',
+                                      help: 'The text to display to the user.'
+                                    },
+                                    {
+                                      id:   'href',
+                                      name: 'URL',
+                                      type: 'text',
+                                      help: 'The URL to link to.'
+                                    }
+                                  ],
+                                  OK: function( res ) {
+                                   var h = '[[' + res['href'] + '|' + 
+                                           res['text'] + ']]';
+                                   $.GollumEditor.replaceSelection( h );
+                                  }
+                                });
+                                
+                               
+                              }
+                            },
+                     
+  'function-image'      :   {
+                              exec: function( txt, selText, $field ) {
+                                var results = null;
+                                $.GollumEditor.Dialog.init({
+                                  title: 'Insert Image',
+                                  fields: [
+                                    {
+                                      id: 'url',
+                                      name: 'Image URL',
+                                      type: 'text'
+                                    },
+                                    {
+                                      id: 'alt',
+                                      name: 'Alt Text',
+                                      type: 'text'
+                                    }
+                                  ],
+                                  OK: function( res ) {
+                                    if ( res['url'] && res['alt'] ) {
+                                      var h = '{{' + res['url'];
+                                      if ( res['alt'] != '' ) {
+                                        h += '|' + res['alt'] + '}}';
+                                      }
+                                    }
+                                    $.GollumEditor.replaceSelection( h );
+                                  }
+                                });
+                              }
+                            }
+                            
+};
+
+jQuery.GollumEditor.defineLanguage('creole', Creole);
+
+})();

data/lib/gollum/frontend/public/javascript/editor/langs/markdown.js

@@ -0,0 +1,211 @@
+/**
+ *  Markdown Language Definition
+ *  
+ *  A language definition for string manipulation operations, in this case 
+ *  for the Markdown, uh, markup language. Uses regexes for various functions
+ *  by default. If regexes won't do and you need to do some serious 
+ *  manipulation, you can declare a function in the object instead.
+ *
+ *  Code example:
+ *  'functionbar-id'  :   {
+ *                          exec: function(text, selectedText) {
+ *                                   functionStuffHere();
+ *                                },
+ *                          search: /somesearchregex/gi,
+ *                          replace: 'replace text for RegExp.replace',
+ *                          append: "just add this where the cursor is"
+ *                         }  
+ *
+**/
+(function() {
+
+var MarkDown = {
+  
+  'function-bold' :         {
+                              search: /([^\n]+)([\n\s]*)/g,
+                              replace: "**$1**$2"
+                            },
+  
+  'function-italic' :       {
+                              search: /([^\n]+)([\n\s]*)/g,
+                              replace: "_$1_$2"
+                            },
+  
+  'function-code'   :       {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "`$1`$2"
+                            },
+                            
+  'function-hr'     :       {
+                              append: "\n***\n"
+                            },
+  
+  'function-ul'     :       { 
+                              search: /(.+)([\n]?)/g,
+                              replace: "* $1$2"
+                            },
+  
+  /* This looks silly but is completely valid Markdown */                     
+  'function-ol'   :         {
+                              search: /(.+)([\n]?)/g,
+                              replace: "1. $1$2"
+                            },
+                            
+  'function-blockquote' :   {
+                              search: /(.+)([\n]?)/g,
+                              replace: "> $1$2"
+                            }, 
+                            
+  'function-h1'         :   {
+                              search: /(.+)([\n]?)/g,
+                              replace: "# $1$2"
+                            },
+                            
+  'function-h2'         :   {
+                              search: /(.+)([\n]?)/g,
+                              replace: "## $1$2"
+                            },
+                            
+  'function-h3'         :   {
+                              search: /(.+)([\n]?)/g,
+                              replace: "### $1$2"
+                            },
+                            
+  'function-link'       :   {
+                              exec: function( txt, selText, $field ) {
+                                var results = null;
+                                $.GollumEditor.Dialog.init({
+                                  title: 'Insert Link',
+                                  fields: [
+                                    {
+                                      id:   'text',
+                                      name: 'Link Text',
+                                      type: 'text'
+                                    },
+                                    {
+                                      id:   'href',
+                                      name: 'URL',
+                                      type: 'text'
+                                    }
+                                  ],
+                                  OK: function( res ) {
+                                   var rep = '';
+                                   if ( res['text'] && res['href'] ) {
+                                      rep = '[' + res['text'] + '](' 
+                                             + res['href'] + ')';
+                                    }
+                                    $.GollumEditor.replaceSelection( rep );
+                                  }
+                                }); 
+                              }
+                            },
+                     
+  'function-image'      :   {
+                              exec: function( txt, selText, $field ) {
+                                var results = null;
+                                $.GollumEditor.Dialog.init({
+                                  title: 'Insert Image',
+                                  fields: [
+                                    {
+                                      id: 'url',
+                                      name: 'Image URL',
+                                      type: 'text'
+                                    },
+                                    {
+                                      id: 'alt',
+                                      name: 'Alt Text',
+                                      type: 'text'
+                                    }
+                                  ],
+                                  OK: function( res ) {
+                                    var rep = '';
+                                    if ( res['url'] && res['alt'] ) {
+                                      rep = '![' + res['alt'] + ']' +
+                                            '(' + res['url'] + ')';
+                                    }
+                                    $.GollumEditor.replaceSelection( rep );
+                                  }
+                                });
+                              }
+                            }
+                            
+};
+
+var MarkDownHelp = [
+
+  {
+    menuName: 'Block Elements',
+    content: [
+                {
+                  menuName: 'Paragraphs & Breaks',
+                  data: '<p>To create a paragraph, simply create a block of text that is not separated by one or more blank lines. Blocks of text separated by one or more blank lines will be parsed as paragraphs.</p><p>If you want to create a line break, end a line with two or more spaces, then hit Return/Enter.</p>'
+                },
+                {
+                  menuName: 'Headers',
+                  data: '<p>Markdown supports two header formats. The wiki editor uses the &ldquo;atx&rsquo;-style headers. Simply prefix your header text with the number of <code>#</code> characters to specify heading depth. For example: <code># Header 1</code>, <code>## Header 2</code> and <code>### Header 3</code> will be progressively smaller headers. You may end your headers with any number of hashes.</p>'
+                },
+                {
+                  menuName: 'Blockquotes',
+                  data: '<p>Markdown creates blockquotes email-style by prefixing each line with the <code>&gt;</code>. This looks best if you decide to hard-wrap text and prefix each line with a <code>&gt;</code> character, but Markdown supports just putting <code>&gt;</code> before your paragraph.</p>'
+                },
+                {
+                  menuName: 'Lists',
+                  data: '<p>Markdown supports both ordered and unordered lists. To create an ordered list, simply prefix each line with a number (any number will do &mdash; this is why the editor only uses one number.) To create an unordered list, you can prefix each line with <code>*</code>, <code>+</code> or <code>-</code>.</p> List items can contain multiple paragraphs, however each paragraph must be indented by at least 4 spaces or a tab.'
+                },
+                {
+                  menuName: 'Code Blocks',
+                  data: '<p>Markdown wraps code blocks in pre-formatted tags to preserve indentation in your code blocks. To create a code block, indent the entire block by at least 4 spaces or one tab. Markdown will strip the extra indentation you&rsquo;ve added to the code block.</p>'
+                },
+                {
+                  menuName: 'Horizontal Rules',
+                  data: 'Horizontal rules are created by placing three or more hyphens, asterisks or underscores on a line by themselves. Spaces are allowed between the hyphens, asterisks or underscores.'
+                }
+              ]
+  },
+  
+  {
+    menuName: 'Span Elements',
+    content: [
+                {
+                  menuName: 'Links',
+                  data: '<p>Markdown has two types of links: <strong>inline</strong> and <strong>reference</strong>. For both types of links, the text you want to display to the user is placed in square brackets. For example, if you want your link to display the text &ldquo;GitHub&rdquo;, you write <code>[GitHub]</code>.</p><p>To create an inline link, create a set of parentheses immediately after the brackets and write your URL within the parentheses. (e.g., <code>[GitHub](http://github.com/)</code>). Relative paths are allowed in inline links.</p><p>To create a reference link, use two sets of square brackets. <code>[my internal link][internal-ref]</code> will link to the internal reference <code>internal-ref</code>.</p>'
+                },
+                
+                {
+                  menuName: 'Emphasis',
+                  data: '<p>Asterisks (<code>*</code>) and underscores (<code>_</code>) are treated as emphasis and are wrapped with an <code>&lt;em&gt;</code> tag, which usually displays as italics in most browsers. Double asterisks (<code>**</code>) or double underscores (<code>__</code>) are treated as bold using the <code>&lt;strong&gt;</code> tag. To create italic or bold text, simply wrap your words in single/double asterisks/underscores. For example, <code>**My double emphasis text**</code> becomes <strong>My double emphasis text</strong>, and <code>*My single emphasis text*</code> becomes <em>My single emphasis text</em>.</p>'
+                },
+                
+                {
+                  menuName: 'Code',
+                  data: '<p>To create inline spans of code, simply wrap the code in backticks (<code>`</code>). Markdown will turn <code>`myFunction`</code> into <code>myFunction</code>.</p>'
+                },
+                
+                {
+                  menuName: 'Images',
+                  data: '<p>Markdown image syntax looks a lot like the syntax for links; it is essentially the same syntax preceded by an exclamation point (<code>!</code>). For example, if you want to link to an image at <code>http://github.com/unicorn.png</code> with the alternate text <code>My Unicorn</code>, you would write <code>![My Unicorn](http://github.com/unicorn.png)</code>.</p>'
+                }
+              ]
+  },
+  
+  {
+    menuName: 'Miscellaneous',
+    content: [
+                {
+                  menuName: 'Automatic Links',
+                  data: '<p>If you want to create a link that displays the actual URL, markdown allows you to quickly wrap the URL in <code>&lt;</code> and <code>&gt;</code> to do so. For example, the link <a href="javascript:void(0);">http://github.com/</a> is easily produced by writing <code>&lt;http://github.com/&gt;</code>.</p>'
+                },
+                
+                {
+                  menuName: 'Escaping',
+                  data: '<p>If you want to use a special Markdown character in your document (such as displaying literal asterisks), you can escape the character with the backslash (<code>\\</code>). Markdown will ignore the character directly after a backslash.'
+                }
+              ]
+  }
+];
+
+
+jQuery.GollumEditor.defineLanguage('markdown', MarkDown);
+jQuery.GollumEditor.defineHelp('markdown', MarkDownHelp);
+
+})();