gollum 4.1.4 → 5.0.0

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

@@ -1,148 +1,41 @@
 /**
  *  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"
- *                         }
+ *  See default.js for documentation
  *
 **/
+
 (function($) {
 
+// The default language definition (in default.js) is markdown, so we only need to set the special helper functions.
 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"
-                            },
-  /* based on rdoc.js */
-  '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] + "\n";
-                                    }
-                                  }
-                                  $.GollumEditor.replaceSelection( repText );
-                                }
-                            },
-
-  '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',
-                                      defaultValue: selText
-                                    },
-                                    {
-                                      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 );
-                                  }
-                                });
-                              }
-                            }
+  'gollum-helpers': {
+
+    'find-header-line': function (line, token) {
+      // For use in sections.js
+      // Checks if token matches alternative-syntax markdown headers. These are of the form '===' or '---'.
+      // If so, returns an array containing the text of the header and the previous line number.
+      // If not, returns null.
+      if ( token.match(/(^[=]+$)/) || token.match(/(^[-]+$)/) ){
+        var foundLine = line-1
+        var text = window.ace_editor.getSession().getLine(foundLine);
+        if (foundLine >= 0 && !/^\s+$/.test(text)) { // Sanity check
+          return [text, foundLine];
+        }
+        else {
+          return null;
+        }
+      } else {
+        return null;
+      }
+    }
+
+  }
 
 };
 
+$.GollumEditor.defineLanguage('markdown', $.constructLanguageDefinition(MarkDown));
+
 var MarkDownHelp = [
 
   {
@@ -221,8 +114,6 @@ var MarkDownHelp = [
   }
 ];
 
-
-$.GollumEditor.defineLanguage('markdown', MarkDown);
 $.GollumEditor.defineHelp('markdown', MarkDownHelp);
 
 })(jQuery);

data/lib/gollum/public/gollum/javascript/editor/langs/mediawiki.js

@@ -0,0 +1,122 @@
+/**
+ *  MediaWiki Language Definition
+ *  See default.js for documentation
+ *
+ */
+
+(function($) {
+
+// No need to set all the replacements, only those different from the default language (Markdown).
+var MediaWiki = {
+
+  'function-bold' :         {
+                              replace: "'''$1'''$2"
+                            },
+
+  'function-italic' :       {
+                              replace: "''$1''$2"
+                            },
+  'function-hr'     :       {
+                              append: "\n---\n"
+                            },
+
+  'function-code'   :       {
+                              replace: "<code>$1</code>$2"
+                            },
+  'function-ol'   :         {
+                              link: function ( index, line) {
+                                return '# ' + line + "\n";
+                              } 
+                            },
+  'function-blockquote' :   {
+                              replace: "<blockquote>\n$1$2\n</blockquote>",
+                            },
+
+  'function-h1' :           {
+                              replace: "= $1$2 =",
+                            },
+
+  'function-h2' :           {
+                              replace: "== $1$2 ==",
+                            },
+
+  'function-h3' :           {
+                              replace: "=== $1$2 ===",
+                            },
+
+  'function-link' :         {
+                              replace: function( res ) {
+                                var rep = '';
+                                if ( res['text'] && res['href'] ) {
+                                  rep = '[' + res['href'] + ' | ' + res['text'] + ']';
+                                }
+                                return rep;
+                              }
+                            }
+};
+
+$.GollumEditor.defineLanguage('mediawiki', $.constructLanguageDefinition(MediaWiki));
+
+
+var MediaWikiHelp = [
+  {
+    menuName: 'Text Formatting',
+    content: [
+      {
+        menuName: 'Headers',
+        data: '<p>MediaWiki headers are written with different indentation using <code>= Title =</code> (equals sign). MediaWiki supports headings 1-6.</p>'
+      },
+      {
+        menuName: 'Bold / Italic',
+        data: "<p>To display text as <strong>bold</strong>, wrap the text in <code>'''</code>. To display text as <em>italic</em>, wrap the text in <code>''</code>. To create <code>monospace</code> text, wrap the text in <code>&lt;code&gt;&lt;/code&gt;</code>."
+      },
+      {
+        menuName: 'Special Characters',
+        data: '<p>Use HTML special characters, e.g. <code>&copy;</code> or <code>&euro;</code></p>'
+      }
+    ]
+  },
+  {
+    menuName: 'Blocks',
+    content: [
+      {
+        menuName: 'Paragraphs',
+        data: '<p>MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tag <code><br /></code>.</p>'
+      },
+      {
+        menuName: 'Tables',
+        data: '<p>Tables may be authored in wiki pages using either XHTML table elements directly, or using wikicode formatting to define the table. Wikitable syntax overview: ' +
+'<table cellpadding="5" cellspacing="0" border="1">' +
+'<tr><td><pre> <code>{|</code></pre>' + 
+'</td><td><b>table start</b></td></tr>' +
+'<tr><td><pre> <code>|+</code></pre></td>' +
+'<td>table <b>caption,</b> <i>optional;</i> only between <b>table start</b> and first <b>table row</b></td></tr>' +
+'<tr><td><pre> <code>|-</code></pre></td>' +
+'<td><b>table row,</b> <i>optional on first row</i> -- wiki engine assumes the first row</td></tr>' + 
+'<tr><td><pre> <code>!</code></pre></td>' + 
+'<td><b>table header</b> cell, <i>optional.</i> Consecutive <b>table header</b> cells may be added on same line separated by double marks (<code>!!</code>) or start on new lines, each with its own single mark (<code>!</code>).</td></tr>' +
+'<tr><td><pre> <code>|</code></pre></td>' +
+'<td><b>table data</b> cell, <i>required!</i> Consecutive <b>table data</b> cells may be added on same line separated by double marks (<code>||</code>) or start on new lines, each with its own single mark (<code>|</code>).</td></tr>' +
+'<tr><td><pre> <code>|}</code></pre></td>' +
+'<td><b>table end</b></td></tr></table></p>'
+      }
+    ]
+  },
+  {
+    menuName: 'Macros',
+    content: [
+      {
+        menuName: 'Links',
+        data: '<p>To create links to external pages, use single brackets, e.g. <code>[https://mediawiki.org MediaWiki]</code>. Internal links use double brackets: <code>[[Main Page]]</code>. To define the link text, use <code>[[Main Page | this is displayed]]</code> (note: the order of the URL/Page Name and the link text is reversed compared to Gollum pages in other markups).</p>'
+      },
+      {
+        menuName: 'Images',
+        data: '<p>Use Gollum internal links, e.g. <code>[[sauron.jpg]]<code>, to insert images.'
+      }
+    ]
+  }
+];
+
+$.GollumEditor.defineHelp('mediawiki', MediaWikiHelp);
+
+})(jQuery);

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

@@ -1,114 +1,69 @@
 /**
  *  Org-mode Language Definition
+ *  See default.js for documentation
 **/
+
 (function($) {
 
+// No need to set all the replacements, only those different from the default language (Markdown).
 var OrgMode = {
 
-  'function-bold' :         {
-                              search: /([^\n]+)([\n\s]*)/g,
+  'function-bold':          {
                               replace: "*$1*$2"
                             },
 
-  'function-italic' :       {
-                              search: /([^\n]+)([\n\s]*)/g,
+  'function-italic':        {
                               replace: "/$1/$2"
                             },
 
-  'function-code'   :       {
-                              search: /(^[\n]+)([\n\s]*)/g,
+  'function-code':          {
                               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-hr':            undefined,
 
   'function-blockquote' :   {
-                              search: /(.+)([\n]?)/g,
-                              replace: "#+BEGIN_QUOTE\n$1$2\n#+END_QUOTE\n"
+                              replace: "#+BEGIN_QUOTE\n$1$2\n#+END_QUOTE"
                             },
 
   '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',
-                                      defaultValue: selText
-                                    },
-                                    {
-                                      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 );
-                                  }
-                                });
+                              replace: function ( res ) {
+                                var rep = '';
+                                if ( res['text'] && res['href'] ) {
+                                  rep = '[[' + res['href'] + '][' + res['text'] + ']]';
+                                }
+                                else if ( res['href'] ) {
+                                  rep = '[[' + res['href'] + ']]';
+                                }
+                                return 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 );
-                                  }
-                                });
+                              replace: function ( res ) {
+                                var rep = '';
+                                if ( res['url'] ) {
+                                  rep = '[[' + res['url'] + ']]';
+                                }
+                                return rep;
                               }
                             }
-
 };
 
+$.GollumEditor.defineLanguage('org', $.constructLanguageDefinition(OrgMode));
+
 var OrgModeHelp = [
 
   {
@@ -168,7 +123,6 @@ var OrgModeHelp = [
 ];
 
 
-$.GollumEditor.defineLanguage('org', OrgMode);
 $.GollumEditor.defineHelp('org', OrgModeHelp);
 
 })(jQuery);