🚀 Sólo código modificado para instalar con docker
This commit is contained in:
parent
41d93da720
commit
de8d940598
2217 changed files with 1 additions and 278373 deletions
|
|
@ -1,17 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Redmine 404 error</title>
|
||||
<style>
|
||||
body {font-family: "Trebuchet MS", Georgia, "Times New Roman", serif; color: #303030; margin: 10px;}
|
||||
h1 {font-size:1.5em;}
|
||||
p {font-size:0.8em;}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Page not found</h1>
|
||||
<p>The page you were trying to access doesn't exist or has been removed.</p>
|
||||
<p><a href="javascript:history.back()">Back</a></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Redmine 500 error</title>
|
||||
<style>
|
||||
body {font-family: "Trebuchet MS", Georgia, "Times New Roman", serif; color: #303030; margin: 10px;}
|
||||
h1 {font-size:1.5em;}
|
||||
p {font-size:0.8em;}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Internal error</h1>
|
||||
<p>An error occurred on the page you were trying to access.<br />
|
||||
If you continue to experience problems please contact your Redmine administrator for assistance.</p>
|
||||
<p>If you are the Redmine administrator, check your log files for details about the error.</p>
|
||||
<p><a href="javascript:history.back()">Back</a></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
#!/usr/bin/env ruby
|
||||
|
||||
require File.dirname(__FILE__) + '/../config/boot'
|
||||
require File.dirname(__FILE__) + '/../config/environment'
|
||||
|
||||
class Rack::PathInfoRewriter
|
||||
def initialize(app)
|
||||
@app = app
|
||||
end
|
||||
|
||||
def call(env)
|
||||
env.delete('SCRIPT_NAME')
|
||||
parts = env['REQUEST_URI'].split('?')
|
||||
env['PATH_INFO'] = parts[0]
|
||||
env['QUERY_STRING'] = parts[1].to_s
|
||||
@app.call(env)
|
||||
end
|
||||
end
|
||||
|
||||
Rack::Handler::FastCGI.run Rack::PathInfoRewriter.new(RedmineApp::Application)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 7.7 KiB |
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Вграден код" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Вграден код" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Format de la Wiki</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Guia rapida de la Sintaxis de la Wiki (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Negreta" /></th><td style="width:50%;">**Negreta**</td><td style="width:50%;"><strong>Negreta</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Cursiva" /></th><td>*Cursiva*</td><td><em>Cursiva</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Eliminat" /></th><td>~~Eliminat~~</td><td><del>Eliminat</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Codi en línia" /></th><td>`Codi en línia`</td><td><code>Codi en línia</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Linies de codi" /></th><td>```<br /> linies<br /> de codi<br />```</td><td>
|
||||
<pre>
|
||||
linies
|
||||
de codi
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Llistes</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Llista desordenada" /></th><td>* Article 1<br /> * Sub<br />* Article 2</td><td><ul><li>Article 1<ul><li>Sub</li></ul></li><li>Article 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Llista Ordenada" /></th><td>1. Article 1<br /> 1. Sub<br />2. Article 2</td><td><ol><li>Article 1<ol><li>Sub</li></ol></li><li>Article 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Capçaleres <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Encapçament 1" /></th><td># Títol 1</td><td><h1>Títol 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Encapçament 2" /></th><td>## Títol 2</td><td><h2>Títol 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Encapçament 3" /></th><td>### Títol 3</td><td><h3>Títol 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link a la pagina Wiki" /></th><td>[[Pagina Wiki]]</td><td><a href="#">Pagina Wiki</a></td></tr>
|
||||
<tr><th></th><td>Assumpte #12</td><td>Assumpte <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revisió r43</td><td>Revisió <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Imatges <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Imatge" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Taules</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">Més informació</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Format de la Wiki</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Guia rapida de la Sintaxis de la Wiki</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Estil de font <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Negreta" /></th><td style="width:50%;">*Negreta*</td><td style="width:50%;"><strong>Negreta</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Cursiva" /></th><td>_Cursiva_</td><td><em>Cursiva</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Subratllat" /></th><td>+Subratllat+</td><td><ins>Subratllat</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Eliminat" /></th><td>-Eliminat-</td><td><del>Eliminat</del></td></tr>
|
||||
<tr><th></th><td>??Cita??</td><td><cite>Cita</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Codi en línia" /></th><td>@Codi en línia@</td><td><code>Codi en línia</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Linies de codi" /></th><td><pre><br /> linies<br /> de codi<br /></pre></td><td>
|
||||
<pre>
|
||||
linies
|
||||
de codi
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Llistes</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Llista desordenada" /></th><td>* Article 1<br />** Sub<br />* Article 2</td><td><ul><li>Article 1<ul><li>Sub</li></ul></li><li>Article 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Llista ordenada" /></th><td># Article 1<br />## Sub<br /># Article 2</td><td><ol><li>Article 1<ol><li>Sub</li></ol></li><li>Article 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Capçaleres <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Encapçament 1" /></th><td>h1. Títol 1</td><td><h1>Títol 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Encapçament 2" /></th><td>h2. Títol 2</td><td><h2>Títol 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Encapçament 3" /></th><td>h3. Títol 3</td><td><h3>Títol 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links del Redmine <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link a la pagina Wiki" /></th><td>[[Pagina Wiki]]</td><td><a href="#">Pagina Wiki</a></td></tr>
|
||||
<tr><th></th><td>Assumpte #12</td><td>Assumpte <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revisió r43</td><td>Revisió <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Imatges <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Imatge" /></th><td>!<em>imatge_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>imatge_adjunta</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Taules</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">Més informació</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,338 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>Formátování Wiki v Redminu</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Formátování Wiki (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Odkazy</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Odkazy Redmine</a></li>
|
||||
<li><a href='#4'>Externí odkazy</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Formátování textu</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Styly písma</a></li>
|
||||
<li><a href='#7'>Vložené obrázky</a></li>
|
||||
<li><a href='#8'>Nadpisy</a></li>
|
||||
<li><a href='#10'>Odstavce</a></li>
|
||||
<li><a href='#11'>Obsah</a></li>
|
||||
<li><a href='#14'>Vodorovná čára</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Zvýrazňování kódu</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Odkazy</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Odkazy Redmine</h3>
|
||||
|
||||
<p>Redmine umožňuje hypertextové odkazy mezi jednotlivými zdroji (úkoly, revize, wiki stránky...) kdekoli, kde je použito Wiki formátování.</p>
|
||||
<ul>
|
||||
<li>Odkaz na úkol: <strong>#124</strong> (zobrazí <del><a href="#" class="issue" title="Hromadná změna nezmění kategorii úkolů (Uzavřeno)">#124</a></del>, odkaz je přeškrtnutý, jestliže je úkol uzavřen)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Odkaz na poznámku k úkolu: <strong>#124-6</strong> nebo <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Odkazy Wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Příručka]]</strong> zobrazí odkaz na stránku nazvanou "Příručka": <a href="#" class="wiki-page">Příručka</a>.</li>
|
||||
<li><strong>[[Příručka#čtěte-více]]</strong> Vás přenese ke kotvě "čtěte-více". Nadpisy mají automaticky přiřazené kotvy, na které se můžete odkazovat: <a href="#" class="wiki-page">Příručka</a>.</li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Příručka|Uživatelský manuál]]</strong> zobrazí odkaz na tu samou stránku, ale s jiným textem: <a href="#" class="wiki-page">Uživatelský manuál</a>.</li>
|
||||
</ul>
|
||||
|
||||
<p>Můžete se také odkazovat na Wiki stránky jiného projektu:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[projekt_test:Nějaká stránka]]</strong> zobrazí odkaz na stránku s názvem "Nějaká stránka" na Wiki projektu projekt_test.</li>
|
||||
<li><strong>[[projekt_test:]]</strong> zobrazí odkaz na hlavní Wiki stránku projektu projekt_test.</li>
|
||||
</ul>
|
||||
|
||||
<p>Odkazy na Wiki stránky jsou zobrazeny červeně v případě, že odkazovaná stránka dosud neexistuje, např.: <a href="#" class="wiki-page new">Neexistující stránka</a>.</p>
|
||||
|
||||
<p>Odkazy na další zdroje:</p>
|
||||
|
||||
<ul>
|
||||
<li>Dokumenty:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (odkaz na dokument s ID 17)</li>
|
||||
<li><strong>document:Úvod</strong> (odkaz na dokument s názvem "Úvod")</li>
|
||||
<li><strong>document:"Nějaký dokument"</strong> (Uvozovky se mohou použít v případě, že název obsahuje mezery.)</li>
|
||||
<li><strong>projekt_test:document:"Nějaký dokument"</strong> (odkaz na dokument s názvem "Nějaký dokument" v jiném projektu "projekt_test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Verze:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (odkaz na verzi s ID 3)</li>
|
||||
<li><strong>version:1.0.0</strong> odkaz na verzi s názvem "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>projekt_test:version:1.0.0</strong> (odkaz na verzi "1.0.0" jiného projektu "projekt_test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Přílohy:
|
||||
<ul>
|
||||
<li><strong>attachment:soubor.zip</strong> (odkaz na přílohu aktuálního objektu s názvem soubor.zip)</li>
|
||||
<li>Aktuálně mohou být odkazovány pouze přílohy aktuálního objektu (u úkolu mohou být odkazy pouze na přílohy danného úkolu).</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Revize:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (odkaz na revizi)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (odkaz na revizi s nečíselným označním revize)</li>
|
||||
<li><strong>svn1|r758</strong> (odkaz na revizi určitého repozitáře, pro projekty s více repozitáři)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (odkaz na revizi s nečíselným označním revize určitého repozitáře, pro projekty s více repozitáři)</li>
|
||||
<li><strong>projekt_test:r758</strong> (odkaz na revizi jiného projektu)</li>
|
||||
<li><strong>projekt_test:commit:c6f4d0fd</strong> (odkaz na revizi s nečíselným označním revize jiného projektu)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Soubory repositáře:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (odkaz na soubor umístěný v /some/file respozitáře projektu)</li>
|
||||
<li><strong>source:some/file@52</strong> (odkaz na revizi souboru č. 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (odkaz na 120. řádek souboru)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (odkaz na 120. řádek revize souboru č. 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (použijte uvozovky, když URL obsahuje mezery)</li>
|
||||
<li><strong>export:some/file</strong> (vynutit stažení souboru)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (odkaz na soubor určitého repozitáře, pro projekty s více repositáři)</li>
|
||||
<li><strong>projekt_test:source:some/file</strong> (odkaz na soubor umístěný v /some/file repositáře projektu "projekt_test")</li>
|
||||
<li><strong>projekt_test:export:some/file</strong> (vynutit stažení souboru umístěného v /some/file repositáře projektu "projekt_test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Diskuzní fóra:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (odkaz na fórum s id 1</li>
|
||||
<li><strong>forum:Support</strong> (odkaz na fórum pojmenované Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (Použij dvojté uvozovkym jestliže název fóra obsahuje mezery.)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Příspěvky diskuzního fóra:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (odkaz na příspěvek s ID 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projekty:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (odkaz na projekt s ID 3)</li>
|
||||
<li><strong>project:projekt_test</strong> (odkaz na projekt pojmenovaný "projekt_test")</li>
|
||||
<li><strong>project:"projekt test"</strong> (odkaz na projekt pojmenovaný "projekt test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Novinky:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (odkaz na novinku id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (odkaz na novinku "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (použij dvojté uvozovky, jestliže název novinky obsahuje mezery)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Uživatelé:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (odkaz na uživatele s id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (odkaz na uživatele s loginem jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (odkaz na uživatele s loginem jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escape sekvence:</p>
|
||||
|
||||
<ul>
|
||||
<li>Zabránit parsování Redmine odkazů lze vložením vykřičníku před odkaz: !</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>Externí odkazy</h3>
|
||||
|
||||
<p>URL (začínající: www, http, https, ftp, ftps, sftp a sftps) a e-mailové adresy jsou automaticky převedeny na klikací odkazy:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>zobrazí: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>Jestliže chcete zobrazit určitý text místo URL, můžete použít standardní syntaxi Textile:</p>
|
||||
|
||||
<pre>
|
||||
"Webová stránka Redmine":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>zobrazí: <a href="http://www.redmine.org" class="external">Webová stránka Redmine</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Formátování textu</h2>
|
||||
|
||||
|
||||
<p>Pro nadpisy, tučný text, tabulky a seznamy, Redmine podporuje syntaxi Markdown. Podívejte se na <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> pro informace o využití těchto vlastností. Několik příkladů je uvedeno níže, ale Markdown toho dokáže mnohem víc.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Styly písma</h3>
|
||||
|
||||
<pre>
|
||||
* **tučný**
|
||||
* *kurzíva*
|
||||
* ***tučná kurzíva***
|
||||
* ~~přeškrtnutý~~
|
||||
</pre>
|
||||
|
||||
<p>Zobrazí:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>tučný</strong></li>
|
||||
<li><em>kurzíva</em></li>
|
||||
<li><em><strong>tučná kurzíva</strong></em></li>
|
||||
<li><del>přeškrtnutý</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Vložené obrázky</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> zobrazí obrázek z odkazu (syntaxe Markdown)</li>
|
||||
<li>Jestliže máte obrázek přiložený k Wiki stránce, může být zobrazen jako vložený obrázek pomocí jeho jména: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Nadpisy</h3>
|
||||
|
||||
<pre>
|
||||
# Nadpis 1. úrovně
|
||||
## Nadpis 2. úrovně
|
||||
### Nadpis 3. úrovně
|
||||
</pre>
|
||||
|
||||
<p>Redmine přiřadí kotvu ke každému nadpisu, takže se na ně lze odkazovat pomocí "#Nadpis", "#Podnadpis" atd.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Odstavce</h3>
|
||||
|
||||
<p>Začněte odstavec s <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails je framework pro vývoj webových aplikací podle modelu Model-View-Control.
|
||||
Vše, co je potřeba, je databázový a webový server.
|
||||
</pre>
|
||||
|
||||
<p>Zobrazí:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails je framework pro vývoj webových aplikací podle modelu Model-View-Control.<br />Vše, co je potřeba, je databázový a webový server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Obsah</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => obsah zarovnaný doleva
|
||||
{{>toc}} => obsah zarovnaný doprava
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Vodorovná čára</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine obsahuje následující vestavěná makra:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Jednoduché makro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Zobrazí seznam všech dostupných maker, včetně jejich popisu, existuje-li.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Zobrazí seznam dětských stránek. Bez parametrů zobrazí dětské stránky aktuální wiki stránky. Např.:</p>
|
||||
<pre><code>{{child_pages}} -- lze použít pouze z wiki stránky
|
||||
{{child_pages(depth=2)}} -- zobrazí dětské stránky pouze do 2. úrovně</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Vloží Wiki stránku. Např.:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Vloží sbalený blok textu. Např.:</p>
|
||||
<pre><code>{{collapse(Zobrazit detaily...)
|
||||
Toto je blok textu, který je sbalený.
|
||||
Pro rozbalení klikněte na odkaz.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Zobrazí klikací náhled obrázku. Např.:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Zvýrazňování kódu</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>Kód můžete na stránce zvýraznit pomocí následující syntaxe (záleží na velikosti písma jazyku nebo aliasu):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Váš kód vložte zde.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Např:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,354 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>Formátování Wiki v Redminu</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Formátování Wiki</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Odkazy</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Odkazy Redmine</a></li>
|
||||
<li><a href='#4'>Externí odkazy</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Formátování textu</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Styly písma</a></li>
|
||||
<li><a href='#7'>Vložené obrázky</a></li>
|
||||
<li><a href='#8'>Nadpisy</a></li>
|
||||
<li><a href='#9'>Odstavce</a></li>
|
||||
<li><a href='#10'>Citace</a></li>
|
||||
<li><a href='#11'>Obsah</a></li>
|
||||
<li><a href='#14'>Vodorovná čára</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Makra</a></li>
|
||||
<li><a href='#13'>Zvýrazňování kódu</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Odkazy</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Odkazy Redmine</h3>
|
||||
|
||||
<p>Redmine umožňuje hypertextové odkazy mezi jednotlivými zdroji (úkoly, revize, wiki stránky...) kdekoli, kde je použito Wiki formátování.</p>
|
||||
<ul>
|
||||
<li>Odkaz na úkol: <strong>#124</strong> (zobrazí <del><a href="#" class="issue" title="Hromadná změna nezmění kategorii úkolů (Uzavřeno)">#124</a></del>, odkaz je přeškrtnutý, jestliže je úkol uzavřen)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Odkaz na poznámku k úkolu: <strong>#124-6</strong>, nebo <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Odkazy Wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Příručka]]</strong> zobrazí odkaz na stránku nazvanou "Příručka": <a href="#" class="wiki-page">Příručka</a>.</li>
|
||||
<li><strong>[[Příručka#čtěte-více]]</strong> Vás přenese ke kotvě "čtěte-více". Nadpisy mají automaticky přiřazené kotvy, na které se můžete odkazovat: <a href="#" class="wiki-page">Příručka</a>.</li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Příručka|Uživatelský manuál]]</strong> zobrazí odkaz na tu samou stránku, ale s jiným textem: <a href="#" class="wiki-page">Uživatelský manuál</a>.</li>
|
||||
</ul>
|
||||
|
||||
<p>Můžete se také odkazovat na Wiki stránky jiného projektu:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[projekt_test:Nějaká stránka]]</strong> zobrazí odkaz na stránku s názvem "Nějaká stránka" na Wiki projektu projekt_test.</li>
|
||||
<li><strong>[[projekt_test:]]</strong> zobrazí odkaz na hlavní Wiki stránku projektu projekt_test.</li>
|
||||
</ul>
|
||||
|
||||
<p>Odkazy na Wiki stránky jsou zobrazeny červeně v případě, že odkazovaná stránka dosud neexistuje, např.: <a href="#" class="wiki-page new">Neexistující stránka</a>.</p>
|
||||
|
||||
<p>Odkazy na další zdroje:</p>
|
||||
|
||||
<ul>
|
||||
<li>Dokumenty:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (odkaz na dokument s ID 17)</li>
|
||||
<li><strong>document:Úvod</strong> (odkaz na dokument s názvem "Úvod")</li>
|
||||
<li><strong>document:"Nějaký dokument"</strong> (Uvozovky se mohou použít v případě, že název obsahuje mezery.)</li>
|
||||
<li><strong>projekt_test:document:"Nějaký dokument"</strong> (odkaz na dokument s názvem "Nějaký dokument" v jiném projektu "projekt_test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Verze:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (odkaz na verzi s ID 3)</li>
|
||||
<li><strong>version:1.0.0</strong> odkaz na verzi s názvem "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>projekt_test:version:1.0.0</strong> (odkaz na verzi "1.0.0" jiného projektu "projekt_test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Přílohy:
|
||||
<ul>
|
||||
<li><strong>attachment:soubor.zip</strong> (odkaz na přílohu aktuálního objektu s názvem soubor.zip)</li>
|
||||
<li>Aktuálně mohou být odkazovány pouze přílohy aktuálního objektu (u úkolu mohou být odkazy pouze na přílohy danného úkolu).</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Revize:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (odkaz na revizi)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (odkaz na revizi s nečíselným označním revize)</li>
|
||||
<li><strong>svn1|r758</strong> (odkaz na revizi určitého repozitáře, pro projekty s více repozitáři)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (odkaz na revizi s nečíselným označním revize určitého repozitáře, pro projekty s více repozitáři)</li>
|
||||
<li><strong>projekt_test:r758</strong> (odkaz na revizi jiného projektu)</li>
|
||||
<li><strong>projekt_test:commit:c6f4d0fd</strong> (odkaz na revizi s nečíselným označním revize jiného projektu)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Soubory repositáře:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (odkaz na soubor umístěný v /some/file respozitáře projektu)</li>
|
||||
<li><strong>source:some/file@52</strong> (odkaz na revizi souboru č. 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (odkaz na 120. řádek souboru)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (odkaz na 120. řádek revize souboru č. 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (použijte uvozovky, když URL obsahuje mezery)</li>
|
||||
<li><strong>export:some/file</strong> (vynutit stažení souboru)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (odkaz na soubor určitého repozitáře, pro projekty s více repositáři)</li>
|
||||
<li><strong>projekt_test:source:some/file</strong> (odkaz na soubor umístěný v /some/file repositáře projektu "projekt_test")</li>
|
||||
<li><strong>projekt_test:export:some/file</strong> (vynutit stažení souboru umístěného v /some/file repositáře projektu "projekt_test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Diskuzní fóra:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (odkaz na fórum s id 1</li>
|
||||
<li><strong>forum:Support</strong> (odkaz na fórum pojmenované Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (Použij dvojté uvozovkym jestliže název fóra obsahuje mezery.)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Příspěvky diskuzního fóra:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (odkaz na příspěvek s ID 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projekty:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (odkaz na projekt s ID 3)</li>
|
||||
<li><strong>project:projekt_test</strong> (odkaz na projekt pojmenovaný "projekt_test")</li>
|
||||
<li><strong>project:"projekt test"</strong> (odkaz na projekt pojmenovaný "projekt test")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Novinky:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (odkaz na novinku id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (odkaz na novinku "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (použij dvojté uvozovky, jestliže název novinky obsahuje mezery)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Uživatelé:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (odkaz na uživatele s id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (odkaz na uživatele s loginem jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (odkaz na uživatele s loginem jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escape sekvence:</p>
|
||||
|
||||
<ul>
|
||||
<li>Zabránit parsování Redmine odkazů, lze vložením vykřičníku před odkaz: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>Externí odkazy</h3>
|
||||
|
||||
<p>URL (začínající: www, http, https, ftp, ftps, sftp a sftps) a e-mailové adresy jsou automaticky převedeny na klikací odkazy:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>zobrazí: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>Jestliže chcete zobrazit určitý text místo URL, můžete použít standardní syntaxi textile:</p>
|
||||
|
||||
<pre>
|
||||
"Webová stránka Redmine":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>zobrazí: <a href="http://www.redmine.org" class="external">Webová stránka Redmine</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Formátování textu</h2>
|
||||
|
||||
|
||||
<p>Pro nadpisy, tučný text, tabulky a seznamy, Redmine podporuje syntaxi Textile. Podívejte se na <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> pro informace o využití těchto vlastností. Několik příkladů je uvedeno níže, ale Textile toho dokáže mnohem víc.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Styly písma</h3>
|
||||
|
||||
<pre>
|
||||
* *tučný*
|
||||
* _kurzíva_
|
||||
* _*tučná kurzíva*_
|
||||
* +podtržený+
|
||||
* -přeškrtnutý-
|
||||
</pre>
|
||||
|
||||
<p>Zobrazí:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>tučný</strong></li>
|
||||
<li><em>kurzíva</em></li>
|
||||
<li><em><strong>tučná kurzíva</strong></em></li>
|
||||
<li><ins>podtržený</ins></li>
|
||||
<li><del>přeškrtnutý</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Vložené obrázky</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> zobrazí obrázek z odkazu (syntaxe textile)</li>
|
||||
<li><strong>!>image_url!</strong> obrázek zarovnaný napravo</li>
|
||||
<li>Jestliže máte obrázek přiložený k Wiki stránce, může být zobrazen jako vložený obrázek pomocí jeho jména: <strong>!prilozeny_obrazek.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Nadpisy</h3>
|
||||
|
||||
<pre>
|
||||
h1. Nadpis 1. úrovně
|
||||
|
||||
h2. Nadpis 2. úrovně
|
||||
|
||||
h3. Nadpis 3. úrovně
|
||||
</pre>
|
||||
|
||||
<p>Redmine přiřadí kotvu ke každému nadpisu, takže se na ně lze odkazovat pomocí "#Nadpis", "#Podnadpis" atd.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Odstavce</h3>
|
||||
|
||||
<pre>
|
||||
p>. zarovnaný doprava
|
||||
p=. zarovnaný na střed
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">Toto je odstavec zarovnaný na střed.</p>
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Citace</h3>
|
||||
|
||||
<p>Začněte odstavec s <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails je framework pro vývoj webových aplikací podle modelu Model-View-Control.
|
||||
Vše, co je potřeba, je databázový a webový server.
|
||||
</pre>
|
||||
|
||||
<p>Zobrazí:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails je framework pro vývoj webových aplikací podle modelu Model-View-Control.<br />Vše, co je potřeba, je databázový a webový server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Obsah</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => obsah zarovnaný doleva
|
||||
{{>toc}} => obsah zarovnaný doprava
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Vodorovná čára</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Makra</h2>
|
||||
|
||||
<p>Redmine obsahuje následující vestavěná makra:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Jednoduché makro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Zobrazí seznam všech dostupných maker, včetně jejich popisu, existuje-li.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Zobrazí seznam dětských stránek. Bez parametrů zobrazí dětské stránky aktuální wiki stránky. Např.:</p>
|
||||
<pre><code>{{child_pages}} -- lze použít pouze z wiki stránky
|
||||
{{child_pages(depth=2)}} -- zobrazí dětské stránky pouze do 2. úrovně</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Vloží Wiki stránku. Např.:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Vloží sbalený blok textu. Např.:</p>
|
||||
<pre><code>{{collapse(Zobrazit detaily...)
|
||||
Toto je blok textu, který je sbalený.
|
||||
Pro rozbalení klikněte na odkaz.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Zobrazí klikací náhled obrázku. Např.:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Zvýrazňování kódu</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>Kód můžete na stránce zvýraznit pomocí následující syntaxe (záleží na velikosti písma jazyku nebo aliasu):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Váš kód vložte zde.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Např.:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formátování</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1><h1>Syntaxe Wiki - rychlý náhled</h1> (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Styly písma <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Tučně**</td><td style="width:50%;"><strong>Tučně</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Kurzívou*</td><td><em>Kurzívou</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Smazaný~~</td><td><del>Smazaný</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Vnořený kód`</td><td><code>Vnořený kód</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> řádky<br /> kódu<br />```</td><td>
|
||||
<pre>
|
||||
řádky
|
||||
kódu
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Seznamy</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Položka 1<br /> * Pod<br />* Položka 2</td><td><ul><li>Položka 1<ul><li>Pod</li></ul></li><li>Položka 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Položka 1<br /> 1. Pod<br />2. Položka 2</td><td><ol><li>Položka 1<ol><li>Pod</li></ol></li><li>Položka 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Nadpisy <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Nadpis 1</td><td><h1>Nadpis 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Nadpis 2</td><td><h2>Nadpis 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Nadpis 3</td><td><h3>Nadpis 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Odkazy <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Odkaz](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine odkazy <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki stránka]]</td><td><a href="#">Wiki stránka</a></td></tr>
|
||||
<tr><th></th><td>Úkol #12</td><td>Úkol <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revize r43</td><td>Revize <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Vnořené obrázky <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tabulky</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">Více informací</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formátování</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Syntaxe Wiki - rychlý náhled</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Styly písma <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Tučný" /></th><td style="width:50%;">*Tučně*</td><td style="width:50%;"><strong>Tučně</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Kurzívou" /></th><td>_Kurzívou_</td><td><em>Kurzívou</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Podtržený" /></th><td>+Podtržený+</td><td><ins>Podtržený</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Smazaný" /></th><td>-Smazaný-</td><td><del>Smazaný</del></td></tr>
|
||||
<tr><th></th><td>??Citace??</td><td><cite>Citace</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Vnořený kód" /></th><td>@Vnořený kód@</td><td><code>Vnořený kód</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Předformátovaný text" /></th><td><pre><br /> řádky<br /> kódu<br /></pre></td><td>
|
||||
<pre>
|
||||
řádky
|
||||
kódu
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Seznamy</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Nesetříděný seznam" /></th><td>* Položka 1<br />** Pod<br />* Položka 2</td><td><ul><li>Položka 1<ul><li>Pod</li></ul></li><li>Položka 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Setříděný seznam" /></th><td># Položka 1<br />## Pod<br /># Položka 2</td><td><ol><li>Položka 1<ol><li>Pod</li></ol></li><li>Položka 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Nadpisy <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Nadpis 1" /></th><td>h1. Nadpis 1</td><td><h1>Nadpis 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Nadpis 2" /></th><td>h2. Nadpis 2</td><td><h2>Nadpis 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Nadpis 3" /></th><td>h3. Nadpis 3</td><td><h3>Nadpis 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Odkazy <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Odkaz":http://foo.bar</td><td><a href="#">Odkaz</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine odkazy <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Odkaz na Wiki stránku" /></th><td>[[Wiki stránka]]</td><td><a href="#">Wiki stránka</a></td></tr>
|
||||
<tr><th></th><td>Úkol #12</td><td>Úkol <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revize r43</td><td>Revize <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Vnořené obrázky <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Obrázek" /></th><td>!<em>url_obrázku</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>vnořený_obrázek</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tabulky</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">Více informací</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wikiformatierung</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Schnellreferenz</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Schriftarten <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Fett" /></th><td style="width:50%;">*Fett*</td><td style="width:50%;"><strong>Fett</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Kursiv" /></th><td>_Kursiv_</td><td><em>Kursiv</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Unterstrichen" /></th><td>+Unterstrichen+</td><td><ins>Unterstrichen</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Durchgestrichen" /></th><td>-Durchgestrichen-</td><td><del>Durchgestrichen</del></td></tr>
|
||||
<tr><th></th><td>??Zitat??</td><td><cite>Zitat</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline-Code" /></th><td>@Inline-Code@</td><td><code>Inline-Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Vorformatierter Text" /></th><td><pre><br /> vorformatierte<br /> Codezeilen<br /></pre></td><td>
|
||||
<pre>
|
||||
vorformartierte
|
||||
Codezeilen
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Listen</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unsortierte Liste" /></th><td>* Element 1<br />** Sub<br />* Element 2</td><td><ul><li>Element 1<ul><li>Sub</li></ul></li><li>Element 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Sortierte Liste" /></th><td># Element 1<br />## Sub<br /># Element 2</td><td><ol><li>Element 1<ol><li>Sub</li></ol></li><li>Element 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Überschriften <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Überschrift 1" /></th><td>h1. Überschrift 1</td><td><h1>Überschrift 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Überschrift 2" /></th><td>h2. Überschrift 2</td><td><h2>Überschrift 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Überschrift 3" /></th><td>h3. Überschrift 3</td><td><h3>Überschrift 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link zu einer Wiki Seite" /></th><td>[[Wiki Seite]]</td><td><a href="#">Wiki Seite</a></td></tr>
|
||||
<tr><th></th><td>Ticket #12</td><td>Ticket <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">eingebettete Bilder <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Bild" /></th><td>!<em>URL_zu_dem_Bild</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>angehängtes_Bild</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">weitere Informationen</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Código resaltado" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Formato de la Wiki</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Guia Rápida de Sintaxis de la Wiki</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Estilo de fuentes <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Negrita" /></th><td style="width:50%;">*Negrita*</td><td style="width:50%;"><strong>Negrita</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Cursiva" /></th><td>_Cursiva_</td><td><em>Cursiva</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Subrayado" /></th><td>+Subrayado+</td><td><ins>Subrayado</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Tachado" /></th><td>-Tachado-</td><td><del>Tachado</del></td></tr>
|
||||
<tr><th></th><td>??Cita??</td><td><cite>Cita</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Código en linea" /></th><td>@Código en linea@</td><td><code>Código en linea</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Có preformateado" /></th><td><pre><br /> Líneas<br /> de có<br /></pre></td><td>
|
||||
<pre>
|
||||
líneas
|
||||
de código
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Código resaltado" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Listas</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Lista no ordenada" /></th><td>* artículo 1<br />** Sub<br />* artículo 2</td><td><ul><li>artículo 1<ul><li>Sub</li></ul></li><li>artículo</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Lista ordenada" /></th><td># artículo 1<br />## Sub<br /># artículo 2</td><td><ol><li>artículo 1<ol><li>Sub</li></ol></li><li>artículo 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Cabeceras <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Cabecera 1" /></th><td>h1. Título 1</td><td><h1>Título 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Cabecera 2" /></th><td>h2. Título 2</td><td><h2>Título 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Cabecera 3" /></th><td>h3. Título 3</td><td><h3>Título 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Enlaces <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Enlaces de Redmine <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Enlace a una página de la Wiki" /></th><td>[[pagina Wiki]]</td><td><a href="#">Pagina Wiki</a></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Enlace a una página de la Wiki con nombre descripciptivo" /></th><td>[[pagina Wiki|Nombre descriptivo]]</td><td><a href="#">Nombre descriptivo</a></td></tr>
|
||||
<tr><th></th><td>Petición #12</td><td>Petición <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revisión r43</td><td>Revisión <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Imágenes en línea <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Imagen" /></th><td>!<em>imagen_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>imagen_adjunta</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">Más información</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Código resaltado" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Formato de la Wiki</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Guia Rápida de Sintaxis de la Wiki</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Estilo de fuentes <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Negrita" /></th><td style="width:50%;">*Negrita*</td><td style="width:50%;"><strong>Negrita</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Cursiva" /></th><td>_Cursiva_</td><td><em>Cursiva</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Subrayado" /></th><td>+Subrayado+</td><td><ins>Subrayado</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Tachado" /></th><td>-Tachado-</td><td><del>Tachado</del></td></tr>
|
||||
<tr><th></th><td>??Cita??</td><td><cite>Cita</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Código en linea" /></th><td>@Código en linea@</td><td><code>Código en linea</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Có preformateado" /></th><td><pre><br /> Líneas<br /> de có<br /></pre></td><td>
|
||||
<pre>
|
||||
líneas
|
||||
de código
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Código resaltado" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Listas</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Lista no ordenada" /></th><td>* artículo 1<br />** Sub<br />* artículo 2</td><td><ul><li>artículo 1<ul><li>Sub</li></ul></li><li>artículo</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Lista ordenada" /></th><td># artículo 1<br />## Sub<br /># artículo 2</td><td><ol><li>artículo 1<ol><li>Sub</li></ol></li><li>artículo 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Cabeceras <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Cabecera 1" /></th><td>h1. Título 1</td><td><h1>Título 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Cabecera 2" /></th><td>h2. Título 2</td><td><h2>Título 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Cabecera 3" /></th><td>h3. Título 3</td><td><h3>Título 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Enlaces <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Enlaces de Redmine <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Enlace a una página de la Wiki" /></th><td>[[pagina Wiki]]</td><td><a href="#">Pagina Wiki</a></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Enlace a una página de la Wiki con nombre descripciptivo" /></th><td>[[pagina Wiki|Nombre descriptivo]]</td><td><a href="#">Nombre descriptivo</a></td></tr>
|
||||
<tr><th></th><td>Petición #12</td><td>Petición <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revisión r43</td><td>Revisión <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Imágenes en línea <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Imagen" /></th><td>!<em>imagen_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>imagen_adjunta</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">Más información</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,339 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Mise en page Wiki</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Liens</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Liens Redmine</a></li>
|
||||
<li><a href='#4'>Liens externes</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Formatage du texte</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Police d'écriture</a></li>
|
||||
<li><a href='#7'>Afficher une image</a></li>
|
||||
<li><a href='#8'>Titre</a></li>
|
||||
<li><a href='#9'>Paragraphes</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table des matières</a></li>
|
||||
<li><a href='#14'>Règle horizontale</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Coloration syntaxique</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Liens</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Liens Redmine</h3>
|
||||
|
||||
<p>Redmine autorise les hyperliens entre différentes ressources (Demandes, révisions, pages wiki...) n'importe où la mise en page Wiki est utilisée.</p>
|
||||
<ul>
|
||||
<li>Lien vers une demande: <strong>#124</strong> (affiche <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, le lien est barré si la demande est fermée)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Lien vers une note d'une demande: <strong>#124-6</strong>, ou <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Liens entre Wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> affiche un lien vers la page nommé 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#balise-avancée]]</strong> vous emmène à la balise "balise-avancée". Les titres ont automatiquement une balise assignée afin de pouvoir s'y référer: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|Manuel Utilisateur]]</strong> affiche un lien vers la même page mais avec un texte différent: <a href="#" class="wiki-page">Manuel Utilisateur</a></li>
|
||||
</ul>
|
||||
|
||||
<p>Vous pouvez aussi faire des liens vers des pages du Wiki d'un autre projet:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:une page]]</strong> affiche un lien vers une page nommée 'Une page' du Wiki du projet Sandbox</li>
|
||||
<li><strong>[[sandbox:]]</strong> affiche un lien vers la page principal du Wiki du projet Sandbox</li>
|
||||
</ul>
|
||||
|
||||
<p>Les liens Wiki sont affichés en rouge si la page n'existe pas encore, ie: <a href="#" class="wiki-page new">Page inexistante</a>.</p>
|
||||
|
||||
<p>Liens vers d'autres ressources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (lien vers le document dont l'id est 17)</li>
|
||||
<li><strong>document:Salutations</strong> (lien vers le document dont le titre est "Salutations")</li>
|
||||
<li><strong>document:"Un document"</strong> (Les guillements peuvent être utilisé quand le titre du document comporte des espaces)</li>
|
||||
<li><strong>sandbox:document:"Un document"</strong> (Lien vers le document dont le titre est "Un document" dans le projet différent "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (lien vers la version dont l'id est 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (lien vers la version nommée "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (lien vers la version nommée "1.0.0" dans le projet "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Pièces jointes:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (lien vers la pièce jointe de l'objet nommée file.zip)</li>
|
||||
<li>Pour le moment, seules les pièces jointes de l'objet peuvent être référencées (si vous êtes sur une demande, il est possibe de faire référence aux pièces jointes de cette demande uniquement)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Révisions:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (lien vers une révision)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (lien vers une révision sans référence numérique)</li>
|
||||
<li><strong>svn1|r758</strong> (lien vers un dépôt spécifique, pour les projets ayant plusieurs dépôts)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (lien vers une révision sans référence numérique d'un dépôt spécifique)</li>
|
||||
<li><strong>sandbox:r758</strong> (Lien vers une révision d'un projet différent)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (lien vers une révision sans référence numérique d'un autre projet)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Fichier de dépôt:
|
||||
<ul>
|
||||
<li><strong>source:un/fichier</strong> (Lien vers le fichier situé dans /un/fichier dans le dépôt du projet)</li>
|
||||
<li><strong>source:un/fichier@52</strong> (Lien vers le fichier de la révison 52)</li>
|
||||
<li><strong>source:un/fichier#L120</strong> (Lien vers la ligne 120 du fichier fichier)</li>
|
||||
<li><strong>source:un/fichier@52#L120</strong> (Lien vers la ligne 120 du fichier de la révison 52)</li>
|
||||
<li><strong>source:"un fichier@52#L120"</strong> (Utilisez des guillemets quand l'url contient des espaces)</li>
|
||||
<li><strong>export:un/fichier</strong> (Force le téléchargement du fichier)</li>
|
||||
<li><strong>source:svn1|un/fichier</strong> (Lien vers le fichier dans un dépôt spécifique, pour les projets contenant plusieurs dépôts)</li>
|
||||
<li><strong>sandbox:source:un/fichier</strong> (Lien vers le fichier situé dans /un/fichier dans le dépôt du projet "sandbox")</li>
|
||||
<li><strong>sandbox:export:un/fichier</strong> (Force le téléchargement du fichier dans le dépôt du projet "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Messages du forum:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (Lien vers le message dont l'id est 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projet:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (Lien vers le projet dont l'id est 3)</li>
|
||||
<li><strong>project:unprojet</strong> (Lien vers le projet nommé "unprojet")</li>
|
||||
<li><strong>project:"un projet"</strong> (use double quotes if project name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Eviter ces lien:</p>
|
||||
|
||||
<ul>
|
||||
<li>Vous pouvez empêcher les liens Redmine de se faire en les précédant d'un point d'exclamaion : !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>Liens externes</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>affiche: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>Si vous voulez afficher un texte spécifique à la place de l'URL, vous pouvez utilisez la syntaxe standard textile:</p>
|
||||
|
||||
<pre>
|
||||
"Site Web Redmine":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>affiche: <a href="http://www.redmine.org" class="external">Site Web Redmine</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Formatage du texte</h2>
|
||||
|
||||
|
||||
<p>Pour les éléments tel que, gras, tableau, listes, Redmine utilise la syntaxe Textile. Voir <a class="external" href="http://fr.wikipedia.org/wiki/Textile_%28langage%29">http://fr.wikipedia.org/wiki/Textile_(langage)</a> pour les informations sur l'utilisation de ces fonctionnalités. Quelques exemples sont inclus ci-dessous, mais le moteur est capable de beaucoup plus.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Police d'écriture</h3>
|
||||
|
||||
<pre>
|
||||
* *gras*
|
||||
* _italique_
|
||||
* _*gras _italique_*_
|
||||
* +sous-ligné+
|
||||
* -barré-
|
||||
</pre>
|
||||
|
||||
<p>Affiche:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>gras</strong></li>
|
||||
<li><em>_italique_</em></li>
|
||||
<li><em><strong>gras italique</strong></em></li>
|
||||
<li><ins>sous-ligné</ins></li>
|
||||
<li><del>barré</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Afficher une image</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!url_de_l_image!</strong> affiche une image situé à l'adresse displays an image located at url_de_l_image (syntaxe Textile)</li>
|
||||
<li><strong>!>url_de_l_image!</strong> Image affichée à droite</li>
|
||||
<li>Si vous avez une image en pièce jointe de votre page Wiki, elle peut être affiché en utilisant simplement sont nom: <strong>!image_en_piece_jointe.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Titre</h3>
|
||||
|
||||
<pre>
|
||||
h1. Titre
|
||||
|
||||
h2. Sous-titre
|
||||
|
||||
h3. Sous-sous-titre
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigne une balise à chacun de ses titres, vous pouvez donc les lier avec "#Titre", "#Sous-titre" et ainsi de suite.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphes</h3>
|
||||
|
||||
<pre>
|
||||
p>. aligné à droite
|
||||
p=. centré
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">Ceci est un paragraphe centré.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Commencer le paragraphe par <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Ruby on Rails, également appelé RoR ou Rails est un framework web libre écrit en Ruby. Il suit le motif de conception Modèle-Vue-Contrôleur aussi nommé MVC.
|
||||
Pour commencer à l'utiliser, il ne vous faut qu'un serveur web et une base de données.
|
||||
</pre>
|
||||
|
||||
<p>Affiche</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Ruby on Rails, également appelé RoR ou Rails est un framework web libre écrit en Ruby. Il suit le motif de conception Modèle-Vue-Contrôleur aussi nommé MVC.<br />Pour commencer à l'utiliser, il ne vous faut qu'un serveur web et une base de données.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table des matières</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => table des matières centrées à gauche
|
||||
{{>toc}} => table des matières centrées à droite
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Règle horizontale</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine possède les macros suivantes:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Macro d'exemple.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Affiche une liste de toutes les macros disponibles, les descriptions sont incluses si celles-ci sont disponibles.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Affiche une liste des sous-pages. Sans argument, cela affiche les sous-pages de la page courante. Exemples :</p>
|
||||
<pre><code>{{child_pages}} -- peut être utilisé depuis une page wiki uniquement
|
||||
{{child_pages(depth=2)}} -- affiche deux niveaux d'arborescence seulement</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Inclut une page Wiki. Exemple :</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>ou pour inclure une page d'un wiki de projet spécifique :</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Insère un bloc de texte enroulé. Exemple :</p>
|
||||
<pre><code>{{collapse(Voir les détails...)
|
||||
Ceci est un bloc de texte qui est caché par défaut.
|
||||
Il peut être déroulé en cliquant sur le lien.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Affiche une miniature cliquable d'une image jointe. Exemples :</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Miniature)}}</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Coloration syntaxique</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Placez votre code ici.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Exemple:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Code colorisé" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Syntaxe rapide des Wikis</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Gras*</td><td style="width:50%;"><strong>Gras</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italique_</td><td><em>Italique</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Sous-ligné+</td><td><ins>Sous-ligné</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Barré-</td><td><del>Barré</del></td></tr>
|
||||
<tr><th></th><td>??Citation??</td><td><cite>Citation</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Code en ligne@</td><td><code>Code en ligne</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lignes<br /> de code<br /></pre></td><td>
|
||||
<pre>
|
||||
lignes
|
||||
de code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Code colorisé <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Code colorisé" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Listes</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Titres <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Titre 1</td><td><h1>Titre 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Titre 2</td><td><h2>Titre 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Titre 3</td><td><h3>Titre 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Liens <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Liens Redmine <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Demande #12</td><td>Demande <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Images en ligne <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>url_de_l_image</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>image_en_pièce_jointe</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">Plus d'informations</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,340 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,347 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Código resaltado" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Código resaltado" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,341 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting (Markdown)</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard markdown syntax:</p>
|
||||
|
||||
<pre>
|
||||
[Redmine web site](http://www.redmine.org)
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* **bold**
|
||||
* *Italic*
|
||||
* ***bold italic***
|
||||
* _underline_
|
||||
* ~~strike-through~~
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><u>underline</u></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong></strong> displays an image located at image_url (markdown syntax)</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong></strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
# Heading
|
||||
## Subheading
|
||||
### Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>></strong></p>
|
||||
|
||||
<pre>
|
||||
> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
``` ruby
|
||||
Place your code here.
|
||||
```
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,346 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<title>RedmineWikiFormatting</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
||||
|
||||
<ul class='toc'>
|
||||
<li><a href='#2'>Links</a></li>
|
||||
<ul>
|
||||
<li><a href='#3'>Redmine links</a></li>
|
||||
<li><a href='#4'>External links</a></li>
|
||||
</ul>
|
||||
<li><a href='#5'>Text formatting</a></li>
|
||||
<ul>
|
||||
<li><a href='#6'>Font style</a></li>
|
||||
<li><a href='#7'>Inline images</a></li>
|
||||
<li><a href='#8'>Headings</a></li>
|
||||
<li><a href='#9'>Paragraphs</a></li>
|
||||
<li><a href='#10'>Blockquotes</a></li>
|
||||
<li><a href='#11'>Table of content</a></li>
|
||||
<li><a href='#14'>Horizontal Rule</a></li>
|
||||
</ul>
|
||||
<li><a href='#12'>Macros</a></li>
|
||||
<li><a href='#13'>Code highlighting</a></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
||||
|
||||
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
||||
|
||||
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
||||
<ul>
|
||||
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
||||
<li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
|
||||
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
||||
<li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
||||
<li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
|
||||
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
||||
</ul>
|
||||
|
||||
<p>You can also link to pages of an other project wiki:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
||||
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
||||
</ul>
|
||||
|
||||
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
||||
|
||||
<p>Links to other resources:</p>
|
||||
|
||||
<ul>
|
||||
<li>Documents:
|
||||
<ul>
|
||||
<li><strong>document#17</strong> (link to document with id 17)</li>
|
||||
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
||||
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
||||
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Versions:
|
||||
<ul>
|
||||
<li><strong>version#3</strong> (link to version with id 3)</li>
|
||||
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
||||
<li><strong>version:"1.0 beta 2"</strong></li>
|
||||
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Attachments:
|
||||
<ul>
|
||||
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
||||
<li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Changesets:
|
||||
<ul>
|
||||
<li><strong>r758</strong> (link to a changeset)</li>
|
||||
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
||||
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
||||
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
||||
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Repository files:
|
||||
<ul>
|
||||
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
||||
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
||||
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
||||
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
||||
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
||||
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
||||
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
||||
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
||||
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forums:
|
||||
<ul>
|
||||
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
||||
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
||||
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Forum messages:
|
||||
<ul>
|
||||
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Projects:
|
||||
<ul>
|
||||
<li><strong>project#3</strong> (link to project with id 3)</li>
|
||||
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
||||
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>News:
|
||||
<ul>
|
||||
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
||||
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
||||
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>Users:
|
||||
<ul>
|
||||
<li><strong>user#2</strong> (link to user with id 2)</li>
|
||||
<li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
|
||||
<li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Escaping:</p>
|
||||
|
||||
<ul>
|
||||
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
||||
|
||||
<p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
|
||||
|
||||
<pre>
|
||||
http://www.redmine.org, someone@foo.bar
|
||||
</pre>
|
||||
|
||||
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
||||
|
||||
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
||||
|
||||
<pre>
|
||||
"Redmine web site":http://www.redmine.org
|
||||
</pre>
|
||||
|
||||
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
||||
|
||||
|
||||
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
||||
|
||||
|
||||
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
||||
|
||||
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
||||
|
||||
<pre>
|
||||
* *bold*
|
||||
* _italic_
|
||||
* _*bold italic*_
|
||||
* +underline+
|
||||
* -strike-through-
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>bold</strong></li>
|
||||
<li><em>italic</em></li>
|
||||
<li><em><strong>bold italic</strong></em></li>
|
||||
<li><ins>underline</ins></li>
|
||||
<li><del>strike-through</del></li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
||||
<li><strong>!>image_url!</strong> right floating image</li>
|
||||
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
||||
<li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v (note that Internet Explorer is not supported).</li>
|
||||
<li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
||||
|
||||
<pre>
|
||||
h1. Heading
|
||||
|
||||
h2. Subheading
|
||||
|
||||
h3. Subsubheading
|
||||
</pre>
|
||||
|
||||
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
||||
|
||||
|
||||
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
||||
|
||||
<pre>
|
||||
p>. right aligned
|
||||
p=. centered
|
||||
</pre>
|
||||
|
||||
<p style="text-align:center;">This is a centered paragraph.</p>
|
||||
|
||||
|
||||
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
||||
|
||||
<p>Start the paragraph with <strong>bq.</strong></p>
|
||||
|
||||
<pre>
|
||||
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
||||
To go live, all you need to add is a database and a web server.
|
||||
</pre>
|
||||
|
||||
<p>Display:</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
||||
|
||||
<pre>
|
||||
{{toc}} => left aligned toc
|
||||
{{>toc}} => right aligned toc
|
||||
</pre>
|
||||
|
||||
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
||||
|
||||
<pre>
|
||||
---
|
||||
</pre>
|
||||
|
||||
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
||||
|
||||
<p>Redmine has the following builtin macros:</p>
|
||||
|
||||
<p>
|
||||
<dl>
|
||||
<dt><code>hello_world</code></dt>
|
||||
<dd><p>Sample macro.</p></dd>
|
||||
|
||||
<dt><code>macro_list</code></dt>
|
||||
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
||||
|
||||
<dt><code>child_pages</code></dt>
|
||||
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
||||
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
||||
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
||||
|
||||
<dt><code>include</code></dt>
|
||||
<dd><p>Include a wiki page. Example:</p>
|
||||
<pre><code>{{include(Foo)}}</code></pre>
|
||||
<p>or to include a page of a specific project wiki:</p>
|
||||
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
||||
|
||||
<dt><code>collapse</code></dt>
|
||||
<dd><p>Inserts of collapsed block of text. Example:</p>
|
||||
<pre><code>{{collapse(View details...)
|
||||
This is a block of text that is collapsed by default.
|
||||
It can be expanded by clicking a link.
|
||||
}}</code></pre></dd>
|
||||
|
||||
<dt><code>thumbnail</code></dt>
|
||||
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
||||
<pre>{{thumbnail(image.png)}}
|
||||
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
||||
|
||||
<dt><code>issue</code></dt>
|
||||
<dd><p>Inserts a link to an issue with flexible text. Examples:</p>
|
||||
<pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
|
||||
{{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
|
||||
{{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
|
||||
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
<pre>
|
||||
<pre><code class="ruby">
|
||||
Place your code here.
|
||||
</code></pre>
|
||||
</pre>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference (Markdown)</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>_Underline_</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>```<br /> lines<br /> of code<br />```</td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td>``` ruby<br />3.times do<br /> puts 'Hello'<br />end<br />```</td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br /> * Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br /> 1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_markdown.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td></td><td></td></tr>
|
||||
<tr><th></th><td></td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td>D</td><td>E</td><td>F</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Wiki formatting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../wiki_syntax.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Wiki Syntax Quick Reference</h1>
|
||||
|
||||
<table style="width:100%">
|
||||
<tr><th colspan="3">Font Styles <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#5" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">*Strong*</td><td style="width:50%;"><strong>Strong</strong></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>_Italic_</td><td><em>Italic</em></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>-Deleted-</td><td><del>Deleted</del></td></tr>
|
||||
<tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>@Inline Code@</td><td><code>Inline Code</code></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td><pre><br /> lines<br /> of code<br /></pre></td><td>
|
||||
<pre>
|
||||
lines
|
||||
of code
|
||||
</pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Highlighted code <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#13" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_precode.png" style="border: 1px solid #bbb;" alt="Highlighted code" /></th><td><pre><code class="ruby"><br />3.times do<br /> puts 'Hello'<br />end<br /></code></pre></td><td>
|
||||
<pre><code class="ruby syntaxhl"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
|
||||
<span class="nb">puts</span> <span class="s1">'Hello'</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</td></tr>
|
||||
|
||||
<tr><th colspan="3">Lists</th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />** Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br />## Sub<br /># Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
|
||||
|
||||
<tr><th colspan="3">Headings <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#8" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
|
||||
|
||||
<tr><th colspan="3">Links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#4" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
|
||||
<tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Redmine links <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#3" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
|
||||
<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
|
||||
<tr><th></th><td>##12</td><td><a href="#">Bug #12</a>: The issue subject</td></tr>
|
||||
<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
|
||||
<tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
|
||||
<tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
|
||||
|
||||
<tr><th colspan="3">Inline images <span class="more_info">(<a href="wiki_syntax_detailed_textile.html#7" target="_blank">more</a>)</span></th></tr>
|
||||
<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>!<em>image_url</em>!</td><td></td></tr>
|
||||
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
|
||||
|
||||
<tr><th colspan="3">Tables</th></tr>
|
||||
<tr>
|
||||
<th></th>
|
||||
<td>|_. A |_. B |_. C |<br />| A | B | C |<br />|/2. row span | B | C |<br />|\2. col span |</td>
|
||||
<td>
|
||||
<table class="sample">
|
||||
<tbody>
|
||||
<th>A</th><th>B</th><th>C</th>
|
||||
<tr><td>A</td><td>B</td><td>C</td></tr>
|
||||
<tr><td rowspan="2">row span</td><td>B</td><td>C</td></tr>
|
||||
<tr><td colspan="2">col span</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<p><a href="wiki_syntax_detailed_textile.html" onclick="window.open('wiki_syntax_detailed_textile.html', '', ''); return false;">More Information</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue