#{ link_to @blob.basename, raw_path(@project, @treeish, @path) }
#{ link_to @blob.basename.encode_to_default, raw_path(@project, @treeish, @path) }
ASCIIDoc headers can be written in two ways: with differing underlines or with different indentation using = (equals sign). ASCIIDoc supports headings 1-4. The editor will automatically use the = notation. To create a level one header, prefix your line with one =. Level two headers are created with == and so on.
=
==
To display text as bold, wrap the text in * (asterisks). To display text as italic, wrap the text in _ (underscores). To create monospace text, wrap the text in + (plus signs).' + }, + { + menuName: 'Scripts', + data: '
*
_
monospace
+
Superscript and subscript is created the same way as other inline formats. To create superscript text, wrap your text in ^ (carats). To create subscript text, wrap your text in ~ (tildes).
^
~
ASCIIDoc will automatically convert textual representations of commonly-used special characters. For example, (R) becomes ®, (C) becomes © and (TM) becomes ™.
(R)
(C)
(TM)
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 . (full stop). An example paragraph with optional title is displayed below:.Optional TitleThis is my paragraph. It is two sentences long.
.
.Optional TitleThis is my paragraph. It is two sentences long.
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 (----) delimiting the source block.. An example of Python source is below:.python.py[source,python]----# i just wrote a comment in python# and maybe one more----
----
.python.py[source,python]----# i just wrote a comment in python# and maybe one more----
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 (////). An example comment block is below:////My comment block is here nowIt can be multiple paragraphs. Really.////
////
////My comment block is here nowIt can be multiple paragraphs. Really.////
Quote blocks work much like comment blocks — simply create dividers using four underscores (____) around your quote. An example quote block is displayed below:____This is my quote block. Quote something nice here, otherwise there is no point in quoting.____
____
____This is my quote block. Quote something nice here, otherwise there is no point in quoting.____
To create links to external pages, you can simply write the URI if you want the URI to link to itself. (i.e., http://github.com/ will automatically be parsed to http://github.com/. If you want different text to be displayed, simply append it to the end of the URI in between [ (brackets.) For example, http://github.com/[GitHub] will be parsed as GitHub, with the URI pointing to http://github.com.
http://github.com/
[
http://github.com/[GitHub]
http://github.com
Images in ASCIIDoc work much like hyperlinks, but image URLs are prefixed with image:. For example, to link to an image at images/icons/home.png, write image:images/icons/home.png. Alt text can be added by appending the text to the URI in [ (brackets).
image:
images/icons/home.png
image:images/icons/home.png
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.
If you want to create a line break, end a line with two or more spaces, then hit Return/Enter.
Markdown supports two header formats. The wiki editor uses the “atx’-style headers. Simply prefix your header text with the number of # characters to specify heading depth. For example: # Header 1, ## Header 2 and ### Header 3 will be progressively smaller headers. You may end your headers with any number of hashes.
#
# Header 1
## Header 2
### Header 3
Markdown creates blockquotes email-style by prefixing each line with the >. This looks best if you decide to hard-wrap text and prefix each line with a > character, but Markdown supports just putting > before your paragraph.
>
Markdown supports both ordered and unordered lists. To create an ordered list, simply prefix each line with a number (any number will do — this is why the editor only uses one number.) To create an unordered list, you can prefix each line with *, + or -.
-
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’ve added to the code block.
Markdown has two types of links: inline and reference. 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 “GitHub”, you write [GitHub].
[GitHub]
To create an inline link, create a set of parentheses immediately after the brackets and write your URL within the parentheses. (e.g., [GitHub](http://github.com/)). Relative paths are allowed in inline links.
[GitHub](http://github.com/)
To create a reference link, use two sets of square brackets. [my internal link][internal-ref] will link to the internal reference internal-ref.
[my internal link][internal-ref]
internal-ref
Asterisks (*) and underscores (_) are treated as emphasis and are wrapped with an <em> tag, which usually displays as italics in most browsers. Double asterisks (**) or double underscores (__) are treated as bold using the <strong> tag. To create italic or bold text, simply wrap your words in single/double asterisks/underscores. For example, **My double emphasis text** becomes My double emphasis text, and *My single emphasis text* becomes My single emphasis text.
<em>
**
__
<strong>
**My double emphasis text**
*My single emphasis text*
To create inline spans of code, simply wrap the code in backticks (`). Markdown will turn `myFunction` into myFunction.
`
`myFunction`
myFunction
Markdown image syntax looks a lot like the syntax for links; it is essentially the same syntax preceded by an exclamation point (!). For example, if you want to link to an image at http://github.com/unicorn.png with the alternate text My Unicorn, you would write .
!
http://github.com/unicorn.png
My Unicorn
If you want to create a link that displays the actual URL, markdown allows you to quickly wrap the URL in < and > to do so. For example, the link http://github.com/ is easily produced by writing <http://github.com/>.
<
<http://github.com/>
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 (\\). Markdown will ignore the character directly after a backslash.' + } + ] + } +]; + + +jQuery.GollumEditor.defineLanguage('markdown', MarkDown); +jQuery.GollumEditor.defineHelp('markdown', MarkDownHelp); + +})(); diff --git a/public/javascripts/gollum/editor/langs/org.js b/public/javascripts/gollum/editor/langs/org.js new file mode 100644 index 000000000..24d5aa216 --- /dev/null +++ b/public/javascripts/gollum/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: '
\\
Simply prefix your header text with the number of * characters to specify heading depth. For example: * Header 1, ** Header 2 and *** Header 3 will be progressively smaller headers.
* Header 1
** Header 2
*** Header 3
To create a blockquote, simple embed the text between #+BEGIN_QUOTE and #+END_QUOTE. An example quote block is displayed below:#+BEGIN_QUOTEThis is my quote block. Quote something nice here, otherwise there is no point in quoting.#+END_QUOTE
#+BEGIN_QUOTE
#+END_QUOTE
#+BEGIN_QUOTEThis is my quote block. Quote something nice here, otherwise there is no point in quoting.#+END_QUOTE
Org-mode supports both ordered and unordered lists. To create an ordered list, simply prefix each line with a number (any number will do — this is why the editor only uses one number.) To create an unordered list, you can prefix each line with + or -.
Code Blocks are similar to blockquote, except that #+BEGIN_EXAMPLE and #+END_EXAMPLE are used.
#+BEGIN_EXAMPLE
#+END_EXAMPLE
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 | character. For example, |one|two|three||four|five|six| will appear as a table with two rows and three columns. Additionally, |one|two|three||---+---+-----||four|five|six| will also appear as a table, but the first row will be interpreted as a header row and the <th> tag will be used to render it.
|
|one|two|three||four|five|six|
|one|two|three||---+---+-----||four|five|six|
<th>
To create links to external pages, you need to enclose the URI in double square brackets. (i.e., [[http://github.com/]] will automatically be parsed to http://github.com/)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 “GitHub”, you write [[http://github.com][GitHub]].
[[http://github.com/]]
[[http://github.com][GitHub]]
Forward slashes (/) are treated as emphasis and are wrapped with an <i> tag. Asterisks (*) are treated as bold using the <b> tag.
/
<i>
<b>
To create inline spans of code, simply wrap the code in equal signs (=). Orgmode will turn =myFunction= into myFunction.
=myFunction=
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.
All command paragraphs start with = (equals sign).
To create headings 1 through 4, begin your command paragraph with =headN, where N is the number of the heading 1 through 4. For example, to make a first-order heading (the largest possible,) write =head1, then on the next line begin your paragraph that you want under the heading.
=headN
N
=head1
Perl pod blocks should begin with =pod and end with =cut, 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.
=pod
=cut
pod also allows blocks in other formats, such as HTML or plain text. To create one of these blocks, use the =format SYNTAX command paragraph, where SYNTAX is the syntax of the block (e.g. html or txt). At the end of your block, use the =end SYNTAX block.
=format SYNTAX
SYNTAX
html
txt
=end SYNTAX
If you are having encoding troubles, use the =encoding ENC_TYPE command, where ENC_TYPE is the encoding type (e.g. utf8, koi8-r). This will affect the entire document, not just the block below the command.
=encoding ENC_TYPE
ENC_TYPE
utf8
koi8-r
Formatting text as bold, italic or code works in the S<word> syntax, where S is an abbreviation for the type of text you are trying to create. For example, B<my bold text> becomes my bold text, I<italic text> becomes italic text and C<code here()> becomes code here().
code
S<word>
S
B<my bold text>
I<italic text>
C<code here()>
code here()
Writing hyperlinks in pod is much like formatting text, using the same S<> syntax. Instead of B, I or C, use L to begin a hyperlink.
S<>
B
I
C
L
pod allows you to hyperlink to a man page, a Perl documentation page, or another web page. To link to a man or Perl documentation page, simply include the page name in the link (e.g. L<perl(1)> or L<Net::Ping>). 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 L<GitHub|http://github.com/>).' + } + ] + } +]; + +jQuery.GollumEditor.defineHelp('pod', PodHelp); + +})(); diff --git a/public/javascripts/gollum/editor/langs/rdoc.js b/public/javascripts/gollum/editor/langs/rdoc.js new file mode 100755 index 000000000..eca68f4da --- /dev/null +++ b/public/javascripts/gollum/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); + +})(); diff --git a/public/javascripts/gollum/editor/langs/textile.js b/public/javascripts/gollum/editor/langs/textile.js new file mode 100755 index 000000000..9d8486714 --- /dev/null +++ b/public/javascripts/gollum/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: "
man
L<perl(1)>
L<Net::Ping>
L<GitHub|http://github.com/>
$1
To place emphasis or strength on inline text, simply place _ (underscores) around the text for emphasis or * (asterisks) around the text for strength. In most browsers, _mytext_ will appear as italics and *mytext* will appear as bold.
_mytext_
*mytext*
To force italics or bold, simply double the characters: __mytext__ will appear italic and **mytext** will appear as bold text.
__mytext__
**mytext**
To display citations, wrap your text in ?? (two question marks).
??
To display edit marks such as deleted text (strikethrough) or inserted text (underlined text), wrap your text in - (minuses) or + (pluses). For example -mytext- will be rendered as mytext and +mytext+ will be rendered as mytext
-mytext-
+mytext+
To display superscript, wrap your text in ^ (carets). To display subscript, wrap your text in ~ (tildes).
To display monospace code, wrap your text in @ (at symbol). For example, @mytext@ will appear as mytext.
@
@mytext@
mytext
To create an acronym, suffix the acronym with the definition in parentheses. For example, JS(JavaScript) will be displayed as JS.
JS(JavaScript)
To display a heading in Textile, prefix your line of text with hn., where n equals the heading size you want (1 is largest, 6 is smallest).
hn.
n
To create a new paragraph, prefix your first line of a block of text with 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 bq. If you need to extend a blockquote to more than one text block, write bq.. (note the two periods) and prefix your next normal paragraph with p.
bq.
bq..
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 bc.
bc.
To display a preformatted block, prefix the block with pre.
pre.
To create ordered lists, prefix each line with #. To create unordered lists, prefix each line with *.
To display a link, put the text you want to display in quotes, then a colon (:), then the URL after the colon. For example "GitHub":http://github.com/ will appear as GitHub.
:
"GitHub":http://github.com/
To display an image, simply wrap the image’s URL in ! (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 http://myurl/image.png that should link to http://myurl/ should be written as !http://myurl/image.png!:http://myurl/.
http://myurl/image.png
http://myurl/
!http://myurl/image.png!:http://myurl/
' + argObject.body + '