gollum 1.1.1 → 1.2.0

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

@@ -0,0 +1,173 @@
+/**
+ *  Org-mode Language Definition
+**/
+(function() {
+
+var OrgMode = {
+  
+  '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]?)/g,
+                              replace: "* $1$2"
+                            },
+  
+  /* This works, just like it works for Markdown */                     
+  'function-ol'   :         {
+                              search: /(.+)([\n]?)/g,
+                              replace: "1. $1$2"
+                            },
+                            
+  'function-blockquote' :   {
+                              search: /(.+)([\n]?)/g,
+                              replace: "#+BEGIN_QUOTE\n$1$2\n#+END_QUOTE\n"
+                            },
+
+  '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['href'] + '][' 
+                                             + res['text'] + ']]';
+                                    }
+                                    else if ( res['href'] ) {
+                                      rep = '[[' + 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'
+                                    },
+                                  ],
+                                  OK: function( res ) {
+                                    var rep = '';
+                                    if ( res['url'] ) {
+                                      rep = '[[' + res['url'] + ']]';
+                                    }
+                                    $.GollumEditor.replaceSelection( rep );
+                                  }
+                                });
+                              }
+                            }
+                            
+};
+
+var OrgModeHelp = [
+
+  {
+    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>'
+                },
+                {
+                  menuName: 'Headers',
+                  data: '<p>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.</p>'
+                },
+                {
+                  menuName: 'Blockquotes',
+                  data: '<p>To create a blockquote, simple embed the text between <code>#+BEGIN_QUOTE</code> and <code>#+END_QUOTE</code>. An example quote block is displayed below:<br><code>#+BEGIN_QUOTE<br>This is my quote block. Quote something nice here, otherwise there is no point in quoting.<br>#+END_QUOTE</code></p>'
+                },
+                {
+                  menuName: 'Lists',
+                  data: '<p>Org-mode 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> or <code>-</code>.</p>'
+                },
+                {
+                  menuName: 'Code Blocks',
+                  data: '<p>Code Blocks are similar to blockquote, except that <code>#+BEGIN_EXAMPLE</code> and <code>#+END_EXAMPLE</code> are used.</p>'
+                },
+                {
+                  menuName: 'Tables',
+                  data: '<p>Org-mode supports simple tables (tables with equal number of cells in each row). To create a simple table, just separate the contents of each cell with a <code>|</code> character. For example, <br><br><code>|one|two|three|<br>|four|five|six|</code><br><br> will appear as a table with two rows and three columns.  Additionally, <br><br><code>|one|two|three|<br>|---+---+-----|<br>|four|five|six|</code><br><br> will also appear as a table, but the first row will be interpreted as a header row and the <code>&lt;th&gt;</code> tag will be used to render it. </p>'
+                },
+              ]
+  },
+  
+  {
+    menuName: 'Span Elements',
+    content: [
+                {
+                  menuName: 'Links',
+                  data: '<p>To create links to external pages, you need to enclose the URI in double square brackets. (i.e., <code>[[http://github.com/]]</code> will automatically be parsed to <a href="javascript:void(0);">http://github.com/</a>)If you want to add text, to be displayed to the user, you write the URI and the text next to each other, both enclosed in square brackets and both of them together enclosed in another pair of square brackets. For example, if you want your link to display the text &ldquo;GitHub&rdquo;, you write <code>[[http://github.com][GitHub]]</code>.</p>'
+                },
+                
+                {
+                  menuName: 'Emphasis',
+                  data: '<p>Forward slashes (<code>/</code>) are treated as emphasis and are wrapped with an <code>&lt;i&gt;</code> tag. Asterisks (<code>*</code>) are treated as bold using the <code>&lt;b&gt;</code> tag.</p>'
+                },
+                
+                {
+                  menuName: 'Code',
+                  data: '<p>To create inline spans of code, simply wrap the code in equal signs (<code>=</code>). Orgmode will turn <code>=myFunction=</code> into <code>myFunction</code>.</p>'
+                },
+                
+                {
+                  menuName: 'Images',
+                  data: "<p>Org-mode image syntax is exactly same as the syntax that you would use for a URI to link to itself. The image URI is enclosed in double square brackets. Alt text on images is not currently supported by Gollum's Org-mode parser.</p>"
+                }
+              ]
+  },
+];
+
+
+jQuery.GollumEditor.defineLanguage('org', OrgMode);
+jQuery.GollumEditor.defineHelp('org', OrgModeHelp);
+
+})();

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

@@ -0,0 +1,111 @@
+/**
+ *  Pod Language Definition
+**/
+(function() {
+
+var Pod = {
+  
+  'function-bold' :         {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "B<$1>$2"
+                            },
+  
+  'function-italic' :       {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "I<$1>$2"
+                            },
+  
+  'function-code'   :       {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "C<$1>$2"
+                            },
+                            
+  'function-h1'         :   {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "=head1 $1$2"
+                            },
+                            
+  'function-h2'         :   {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "=head2 $1$2"
+                            },
+                            
+  'function-h3'         :   {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "=head3 $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 = 'L<' + res['text'] + '|' 
+                                             + res['href'] + '>';
+                                    }
+                                    $.GollumEditor.replaceSelection( rep );
+                                  }
+                                }); 
+                              }
+                            }
+                            
+};
+
+jQuery.GollumEditor.defineLanguage('pod', Pod);
+
+
+var PodHelp = [
+                {
+                  menuName: 'Command Paragraphs',
+                  content: [
+                    {
+                      menuName: 'Headings',
+                      data: '<p>All command paragraphs start with <code>=</code> (equals sign).</p><p>To create headings 1 through 4, begin your command paragraph with <code>=headN</code>, where <code>N</code> is the number of the heading 1 through 4. For example, to make a first-order heading (the largest possible,) write <code>=head1</code>, then on the next line begin your paragraph that you want under the heading.</p>'
+                    },
+                    {
+                      menuName: 'Beginning &amp; Ending',
+                      data: '<p>Perl pod blocks should begin with <code>=pod</code> and end with <code>=cut</code>, signifying to Pod parsers that the pod block has begun and ended. These command paragraphs only signal the beginning and end of a pod block.</p>'
+                    },
+                    {
+                      menuName: 'Other Formats',
+                      data: '<p>pod also allows blocks in other formats, such as HTML or plain text. To create one of these blocks, use the <code>=format SYNTAX</code> command paragraph, where <code>SYNTAX</code> is the syntax of the block (e.g. <code>html</code> or <code>txt</code>). At the end of your block, use the <code>=end SYNTAX</code> block.</p>'
+                    },
+                    {
+                      menuName: 'Encoding',
+                      data: '<p>If you are having encoding troubles, use the <code>=encoding ENC_TYPE</code> command, where <code>ENC_TYPE</code> is the encoding type (e.g. <code>utf8</code>, <code>koi8-r</code>). This will affect the entire document, not just the block below the command.</p>'
+                    }
+                  ]
+                },
+                {
+                  menuName: 'Formatting',
+                  content: [
+                    {
+                      menuName: 'Text',
+                      data: '<p>Formatting text as <strong>bold</strong>, <em>italic</em> or <code>code</code> works in the <code>S&lt;word&gt;</code> syntax, where <code>S</code> is an abbreviation for the type of text you are trying to create. For example, <code>B&lt;my bold text&gt;</code> becomes <strong>my bold text</strong>,  <code>I&lt;italic text&gt;</code> becomes <em>italic text</em> and <code>C&lt;code here()&gt;</code> becomes <code>code here()</code>.</p>'
+                    },
+                    {
+                      menuName: 'Hyperlinks',
+                      data: '<p>Writing hyperlinks in pod is much like formatting text, using the same <code>S&lt;&gt;</code> syntax. Instead of <code>B</code>, <code>I</code> or <code>C</code>, use <code>L</code> to begin a hyperlink.</p><p>pod allows you to hyperlink to a <code>man</code> page, a Perl documentation page, or another web page. To link to a <code>man</code> or Perl documentation page, simply include the page name in the link (e.g. <code>L&lt;perl(1)&gt;</code> or <code>L&lt;Net::Ping&gt;</code>). If you want to link to a web page, separate the URL and the link text with a pipe (e.g. to link to github.com, write <code>L&lt;GitHub|http://github.com/&gt;</code>).'
+                    }
+                  ]
+                }
+];
+
+jQuery.GollumEditor.defineHelp('pod', PodHelp);
+
+})();

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

@@ -0,0 +1,74 @@
+/**
+ *  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 RDoc = {
+  
+  'function-bold' :         {
+                              search: /([^\n]+)([\n\s]*)/g,
+                              replace: "((*$1*))$2"
+                            }
+  'function-code'   :       {
+                              search: /([^\n]+)([\n\s]*)/g,
+                              replace: "(({$1}))$2"
+                            },
+  
+  'function-ul'     :       { 
+                              search: /(.+)([\n]?)/gi,
+                              replace: "* $1$2"
+                            },
+                    
+  'function-ol'   :         {
+                              exec: function( txt, selText, $field ) {
+                                var count = 1;
+                                // split into lines
+                                var repText = '';
+                                var lines = selText.split("\n");
+                                var hasContent = /[\w]+/;
+                                for ( var i = 0; i < lines.length; i++ ) {
+                                  if ( hasContent.test(lines[i]) ) {
+                                    repText += '(' + (i + 1).toString() + ') ' +
+                                               lines[i];
+                                  }
+                                }
+                                $.GollumEditor.replaceSelection( repText );
+                              }
+                            },
+                            
+  'function-h1'         :   {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "= $1$2"
+                            },
+                            
+  'function-h2'         :   {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "== $1$2"
+                            },
+                            
+  'function-h3'         :   {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "=== $1$2"
+                            }
+                            
+};
+
+jQuery.GollumEditor.defineLanguage('rdoc', RDoc);
+
+})();

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

@@ -0,0 +1,175 @@
+/**
+ *  Textile Language Definition
+ */
+(function() {
+
+var Textile = {
+  
+  'function-bold' :         {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "*$1*$2"
+                            },
+  
+  'function-italic' :       {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "_$1_$2"
+                            },
+                            
+  'function-hr'     :       {
+                              append: "\n***\n"
+                            },
+  
+  'function-code'   :       {
+                              search: /(^[\n]+)([\n\s]*)/g,
+                              replace: "<pre><code>$1</code></pre>$2"
+                            },
+  
+  'function-ul'     :       { 
+                              search: /(.+)([\n]?)/gi,
+                              replace: "* $1$2"
+                            },
+                    
+  'function-ol'   :         {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "# $1$2"
+                            },
+                            
+  'function-blockquote' :   {
+                              search: /(.+)([\n]?)/gi,
+                              replace: "bq. $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 = '';
+                                   if ( res['text'] && res['href'] ) {
+                                      h = '"' + res['text'] + '":' +
+                                          res['href'];
+                                   }
+                                   $.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'] ) {
+                                      var h = '!' + res['url'];
+                                      if ( res['alt'] != '' ) {
+                                        h += '(' + res['alt'] + ')';
+                                      }
+                                      h += '!';
+                                      $.GollumEditor.replaceSelection( h );
+                                    }
+                                  }
+                                });
+                              }
+                            }
+                            
+};
+
+jQuery.GollumEditor.defineLanguage('textile', Textile);
+
+
+var TextileHelp = [
+  {
+    menuName: 'Phrase Modifiers',
+    content: [
+                {
+                  menuName: 'Emphasis / Strength',
+                  data: '<p>To place emphasis or strength on inline text, simply place <code>_</code> (underscores) around the text for emphasis or <code>*</code> (asterisks) around the text for strength. In most browsers, <code>_mytext_</code> will appear as italics and <code>*mytext*</code> will appear as bold.</p><p>To force italics or bold, simply double the characters: <code>__mytext__</code> will appear italic and <code>**mytext**</code> will appear as bold text.</p>'
+                },
+                {
+                  menuName: 'Citations / Editing',
+                  data: '<p>To display citations, wrap your text in <code>??</code> (two question marks).</p><p>To display edit marks such as deleted text (strikethrough) or inserted text (underlined text), wrap your text in <code>-</code> (minuses) or <code>+</code> (pluses). For example <code>-mytext-</code> will be rendered as <span style="text-decoration: line-through;">mytext</span> and <code>+mytext+</code> will be rendered as <span style="text-decoration: underline;">mytext</span></p>'
+                },
+                {
+                  menuName: 'Superscript / Subscript',
+                  data: '<p>To display superscript, wrap your text in <code>^</code> (carets). To display subscript, wrap your text in <code>~</code> (tildes).</p>'
+                },
+                {
+                  menuName: 'Code',
+                  data: '<p>To display monospace code, wrap your text in <code>@</code> (at symbol). For example, <code>@mytext@</code> will appear as <code>mytext</code>.</p>'
+                },
+                {
+                  menuName: 'Acronyms',
+                  data: '<p>To create an acronym, suffix the acronym with the definition in parentheses. For example, <code>JS(JavaScript)</code> will be displayed as <abbr title="JavaScript">JS</abbr>.</p>'
+                }
+              ]
+  },
+  {
+    menuName: 'Block Modifiers',
+    content: [
+                {
+                  menuName: 'Headings',
+                  data: '<p>To display a heading in Textile, prefix your line of text with <code>hn.</code>, where <code>n</code> equals the heading size you want (1 is largest, 6 is smallest).</p>'
+                },
+                {
+                  menuName: 'Paragraphs / Quotes',
+                  data: '<p>To create a new paragraph, prefix your first line of a block of text with <code>p.</code>.</p><p>To create a blockquote, make sure at least one blank line exists between your text and any surrounding text, and then prefix that block with <code>bq.</code> If you need to extend a blockquote to more than one text block, write <code>bq..</code> (note the two periods) and prefix your next normal paragraph with <code>p.</code></p>'
+                },
+                {
+                  menuName: 'Code Blocks',
+                  data: '<p>Code blocks in textile are simply prefixed like any other block. To create a code block, place the beginning of the block on a separate line and prefix it with <code>bc.</code></p><p>To display a preformatted block, prefix the block with <code>pre.</code></p>'
+                },
+                {
+                  menuName: 'Lists',
+                  data: '<p>To create ordered lists, prefix each line with <code>#</code>. To create unordered lists, prefix each line with <code>*</code>.</p>'
+                }
+             ]
+  },
+  {
+    menuName: 'Links / Images',
+    content: [
+               {
+                 menuName: 'Links',
+                 data: '<p>To display a link, put the text you want to display in quotes, then a colon (<code>:</code>), then the URL after the colon. For example <code>&quot;GitHub&quot;:http://github.com/</code> will appear as <a href="javascript:void(0);">GitHub</a>.</p>'
+               },
+               {
+                 menuName: 'Images',
+                 data: '<p>To display an image, simply wrap the image&rsquo;s URL in <code>!</code> (exclamation points). If you want to link the image to a URL, you can blend the image and link syntax: place your image URL in the exclamation points and suffix that with a colon and your URL. For example, an image at <code>http://myurl/image.png</code> that should link to <code>http://myurl/</code> should be written as <code>!http://myurl/image.png!:http://myurl/</code>.</p>'
+               }
+             ]
+  }
+];
+
+jQuery.GollumEditor.defineHelp('textile', TextileHelp);
+
+})();