Skip to content

O
OHR Support
Commit 3e11244c authored by Francisco Juan's avatar Francisco Juan
Browse files
Options

fixes several documentation bugs, the most important one being #91

parent bdf2a775
Hide whitespace changes
Inline Side-by-side
Showing with 222 additions and 73 deletions
public/help/wiki_syntax_detailed.html
View file @ 3e11244c
......@@ -17,6 +17,7 @@
overflow-x: auto;
}
a.new { color: #b73535; }
.output { margin: 1em 4em 1em 4em; }
.CodeRay .c { color:#666; }
......@@ -32,43 +33,53 @@
.CodeRay .s { background-color:#fff0f0 }
.CodeRay .s .dl { color:#710 }
.red{ color: red; }
.green{ color: green; }
.blue{ color: blue; }
.yellow{ color: yellow; }
.orange{ color: orange; }
.fuchsia{ color: fuchsia; }
</style>
</head>
<body>
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
<h2><a name="2" class="wiki-page"></a>Links</h2>
<h1><a name="wiki-formatting" class="wiki-page"></a>Wiki formatting</h1>
<h2><a name="disabling-wiki-formatting" class="wiki-page"></a>Disabling wiki formatting</h2>
<p>You can disable textile text formating using the &lt;notextile&gt; tag. For example, writing &lt;notextile&gt;+this+&lt;/notextile&gt; will generate +this+ instead of <ins>this</ins>.</p>
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
<h2><a name="redmine-links" class="wiki-page"></a>Redmine links</h2>
<p>Redmine allows hyperlinking between issues, changesets and 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 a changeset: <strong>r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>
<li>Link to a changeset with a non-numeric hash: <strong>commit:c6f4d0fd</strong> (displays <a href="#" class="changeset">c6f4d0fd</a>).</li>
<li>Link to a changeset of another project: <strong>sandbox:r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">sanbox:r758</a>)</li>
<li>Link to a changeset with a non-numeric hash: <strong>sandbox:c6f4d0fd</strong> (displays <a href="#" class="changeset">sandbox:c6f4d0fd</a>).</li>
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="/issues/show/124" 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 a changeset: <strong>r758</strong> (displays <a href="/repositories/revision/1?rev=758" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>
<li>Link to a changeset with a non-numeric hash: <strong>commit:c6f4d0fd</strong> (displays c6f4d0fd). Added in <a href="/repositories/revision/1?rev=1236" class="changeset" title="Merged Git support branch (r1200 to r1226).">r1236</a>.</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>[[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>
<li><strong>[[Guide]]</strong> displays a link to access the page named 'Guide' (or to create one if it doesn't exist yet): <a href="Guide.html" 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="Guide.html#further-reading" class="wiki-page">Guide</a></li>
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="Guide.html" 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>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="Nonexistent_page.html" class="wiki-page new">Nonexistent page</a>.</p>
<p>Links to other resources:</p>
<p>Links to others resources:</p>
<ul>
<li>Documents:
......@@ -76,7 +87,7 @@
<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>
......@@ -85,8 +96,8 @@
<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>
......@@ -94,48 +105,37 @@
<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>
<li>Notes:
<ul><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>
<li>Only existing pages can have attachments. If you want to attach files to a new page, save it first.</li>
<li>See the <a href="#attachments-and-images">Attachments and Images</a> section for details.</li>
</ul>
</ul></li>
</ul>
<ul>
<li>Repository files:
<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>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>
<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>export:some/file</strong> -- Force the download of the file</li>
</ul></li>
</ul>
<p>Escaping (0.7):</p>
<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:someproject</strong> (link to project named "someproject")</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>
<h2><a name="external-links" class="wiki-page"></a>External links</h2>
<p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
......@@ -151,15 +151,41 @@ http://www.redmine.org, someone@foo.bar
"Redmine web site":http://www.redmine.org
</pre>
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
<p>Displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
<h2><a name="attachments-and-images" class="wiki-page"></a>Attachments and Images</h2>
<p>On the current version of Redmine, it is not possible to attach files while on "edit mode". You have to be on "browse mode" (for example, by clicking on "Save").</p>
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
<p>When you are on browse mode, a link called "New File" will allow you to add attachments to the post.</p>
<p>If you want to put direct links to the attachments on your wiki pages, you can do so by writing:</p>
<pre>
attachment:file.zip
</pre>
<p>Where file.zip is the filename of the attached file.</p>
<h3><a name="image-uploading-steps" class="wiki-page"></a>Image uploading steps</h2>
<ol>
<li>First edit some text on your wiki page, and press "Save". You will get presented with the page on "browse mode" </li>
<li>Scroll down until you see the "New File" link. Use that link to attach files to an specific Wiki page (you can add more than one file using the "Add another file" link)</li>
<li>Once you are done adding files, enter the "edit mode again" by pressing the "edit" link</li>
<li>You can place images by putting the file name of the attached images between exclamation marks in your code:</li>
</ol>
<pre>
!diagram.jpg!
</pre>
<h2><a name="text-formatting" 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://www.textism.com/tools/textile/">http://www.textism.com/tools/textile/</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>
<h3><a name="font-style" class="wiki-page"></a>Font style</h3>
<pre>
* *bold*
......@@ -169,46 +195,76 @@ http://www.redmine.org, someone@foo.bar
* -strike-through-
</pre>
<p>Display:</p>
<p>Displays:</p>
<ul>
<li><strong>bold</strong></li>
<li><em>italic</em></li>
<li><em>*bold italic*</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>
</ul>
<h3><a name="8" class="wiki-page"></a>Headings</h3>
<h3><a name="headings" 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>
<p>Remember to leave a blank line before and after a heading - otherwise it might not get properly parsed.</p>
<h3><a name="colored-text" class="wiki-page"></a>Colored text</h2>
<p>We have added 6 small classes to the stylesheet that allow coloring text in a safe way, without using explicit styles. You can write this now:<br></p>
<pre> %(red)red text%, %(green)green text%, %(blue)blue text%, %(yellow)yellow text%, %(orange)orange text%, %(fuchsia)fuchsia text% </pre>
<p>Displays:</p>
<p><span class="red">red text</span>, <span class="green">green text</span>, <span class="blue">blue text</span>, <span class="yellow">yellow text</span>, <span class="orange">orange text</span>, <span class="fuchsia">fuchsia text</span></p>
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
<h3><a name="paragraphs" class="wiki-page"></a>Paragraphs</h3>
<p>Paragraphs must be separated by at least one blank line. One single carriage return will generate a line-break.</p>
<p>Paragraphs are left-aligned by default. You must use explicit notation if you want them to be right or center-aligned.</p>
<pre>
p>. right aligned
p=. centered
Regular left-aligned paragraph.
The first paragraph continues here, after a line break.
p. Another left-aligned paragraph, using explicit notation.
p>. This is a right-aligned paragraph.
p=. This is a centered paragraph.
</pre>
<p> Displays: </p>
<p class="output">Regular left-aligned paragraph. <br>
The first paragraph continues here, after a line break.</p>
<p style="text-align:center;">This is centered paragraph.</p>
<p class="output">Another left-aligned paragraph, using explicit notation.</p>
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
<p class="output" style="text-align:right;"> This is a right-aligned paragraph. </p>
<p class="output" style="text-align:center;">This is centered paragraph.</p>
<h3><a name="blockquotes" class="wiki-page"></a>Blockquotes</h3>
<p>Start the paragraph with <strong>bq.</strong></p>
......@@ -223,32 +279,75 @@ To go live, all you need to add is a database and a web server.
<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="lists" class="wiki-page"></a>Lists</h3>
<p>Use an asterisk (<strong>*</strong>) for unordered lists. Add one asterisk per level:</p>
<pre>
* Level 1
** Level 2
*** Level 3
* Back to level 1
</pre>
<p>Output:</p>
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
<ul>
<li>Level 1
<ul>
<li>Level 2
<ul>
<li>Level 3</li>
</ul>
</li>
</ul>
</li>
<li>Back to level 1</li>
</ul>
<p>Ordered lists work similarly, but using the number sign (<strong>#</strong>) instead of an asterisk:</p>
<pre>
{{toc}} => left aligned toc
{{>toc}} => right aligned toc
# Level 1
## Level 2
### Level 3
# Back to level 1
</pre>
<h2><a name="12" class="wiki-page"></a>Macros</h2>
<p>Output:</p>
<p>Redmine has the following builtin macros:</p>
<ol>
<li>Level 1
<ol>
<li>Level 2
<ol>
<li>Level 3</li>
</ol>
</li>
</ol>
<p><dl><dt><code>hello_world</code></dt><dd><p>Sample macro.</p></dd><dt><code>include</code></dt><dd><p>Include a wiki page. Example:</p>
</li>
<li>Back to level 1</li>
</ol>
<pre><code>{{include(Foo)}}</code></pre></dd><dt><code>macro_list</code></dt><dd><p>Displays a list of all available macros, including description if available.</p></dd></dl></p>
<h3><a name="toc" class="wiki-page"></a>Table of content</h3>
<pre>
{{toc}} => left aligned toc
{{>toc}} => right aligned toc
</pre>
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
<h2><a name="code-highlight" class="wiki-page"></a>Code highlighting</h2>
<p>Code highlightment relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a fast syntax highlighting library written completely in Ruby. It currently supports c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.</p>
<p>Code highlightment relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, javascript, rhtml, ruby, scheme, xml languages.</p>
<p>You can highlight code in your wiki page using this syntax:</p>
<pre>
&lt;pre&gt;&lt;code class="ruby"&gt;
Place you code here.
&lt;/code&gt;&lt;/pre&gt;
</pre>
......@@ -256,15 +355,65 @@ To go live, all you need to add is a database and a web server.
<pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
<span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
<span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name)
<span class="no"> 4</span> <span class="iv">@name</span> = name.capitalize
<span class="no"> 5</span> <span class="r">end</span>
<span class="no"> 6</span>
<span class="no"> 7</span> <span class="r">def</span> <span class="fu">salute</span>
<span class="no"> 8</span> puts <span class="s"><span class="dl">"</span><span class="k">Hello </span><span class="il"><span class="idl">#{</span><span class="iv">@name</span><span class="idl">}</span></span><span class="k">!</span><span class="dl">"</span></span>
<span class="no"> 9</span> <span class="r">end</span>
<span class="no"><strong>10</strong></span> <span class="r">end</span>
</code>
</pre>
<h2><a name="horizontal-rulers" class="wiki-page"></a>Horizontal Rulers (separators)</h2>
<p>Horizontal rules are generated by putting three hypens on an empty line:<p>
<pre>
This is a separator.
---
Between two paragraphs.
</pre>
<p>output:</p>
<p class="output">This is a separator.</p>
<hr class="output"/>
<p class="output">Between two paragraphs.</p>
<p>Notice that the horizontal ruler will not be generated if the line with the hypens has any other characters, or if it's not preceded and succeded with blank lines.</p>
<h2><a name="tables" class="wiki-page"></a>Tables</h2>
<p> Tables have the following format: </p>
<pre>
|_. Table header |_. Another header |
| Table cell | More cells |
</pre>
<p> Displays: </p>
<table border="1">
<tr><th>Table header</th><th>Another header</th></tr>
<tr><td>Table cell</td><td>More cells</td></tr>
</table>
<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>include</code></dt><dd><p>Include a wiki page. Example:</p>
<pre><code>{{include(Foo)}}</code></pre></dd><dt><code>macro_list</code></dt><dd><p>Displays a list of all available macros, including description if available.</p></dd></dl></p>
</body>
</html>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment