##// END OF EJS Templates
jro_apps » redmine
RSS
[#20288] Update the i18n'ed core doc to match CodeRay 1.1.0 capabilities....
[#20288] Update the i18n'ed core doc to match CodeRay 1.1.0 capabilities. This commit includes: <pre> 1. an update of the list of languages supported by CodeRay: * added: + clojure [added in CodeRay 1.0.x] + diff (patch) [added in CodeRay 0.8.x] + go [added in CodeRay 1.1.x] + haml [added in CodeRay 1.0.x] + lua [added in CodeRay 1.1.x] + sass [added in CodeRay 1.1.x] + taskpaper [added in CodeRay 1.1.x] + text (plain, plaintext) [never been documented in Redmine] * removed: - scheme [removed from CodeRay 1.0.x] * renamed: ~ erb (eruby, rhtml) [renamed from rhtml in CodeRay 1.0.x] 2. the inclusion of additional, comma-separated language mappings (aliases) inside parentheses: * cpp (c++, cplusplus) * delphi (pascal) * diff (patch) * erb (eruby, rhtml) * html (xhtml) * javascript (ecmascript, ecma_script, java_script, js) * ruby (irb) * text (plain, plaintext) * yaml (yml) </pre> Regarding the i18n: I used English as the base language. The changed sentence was the same in 94 out of 98 language files, public\help\xx[-xx]\wiki_syntax_detailed_[markdown||textile].html. The only four exceptions were: * cs; public\help\cs\wiki_syntax_detailed_textile.html * fr; public\help\fr\wiki_syntax_detailed_textile.html * ja; public\help\ja\wiki_syntax_detailed_textile.html * zh-tw; public\help\zh-tw\wiki_syntax_detailed_textile.html In the above given files, the sentence containing the supported languages is translated (and/or stylized). I have chosen to replace the whole translated sentence with the new English base sentence, as such leaving decisions about stylizing language names to translators and the people that actually use the respective languages. In general (and for English, as it's the base language) I think we can better stick to non-capitalized language names to prevent any formatting confusion. Contributed by Mischa The Evil. git-svn-id: http://svn.redmine.org/redmine/trunk@14489 e93f8b46-1217-0410-a6f0-8f06a7374b81
Toshi MARUYAMA - - Load All Authors

File last commit:

r14107:7c46fe1e4bd6
r14107:7c46fe1e4bd6
Show More
wiki_syntax_detailed_textile.html
333 lines | 14.6 KiB | text/html | HtmlDjangoLexer
/ public / help / sr-yu / wiki_syntax_detailed_textile.html
History | Source | Raw |Copy content |Copy permalink
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 <!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" />
<style type="text/css">
body { font:80% Verdana,Tahoma,Arial,sans-serif; }
h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
pre, code { font-size:120%; }
pre code { font-size:100%; }
pre {
margin: 1em 1em 1em 1.6em;
padding: 2px;
background-color: #fafafa;
border: 1px solid #dadada;
width:95%;
overflow-x: auto;
}
a.new { color: #b73535; }
.syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
.syntaxhl .comment { color:#666; }
.syntaxhl .class { color:#B06; font-weight:bold }
.syntaxhl .delimiter { color:black }
.syntaxhl .function { color:#06B; font-weight:bold }
.syntaxhl .inline { background: #eee }
.syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
.syntaxhl .instance-variable { color:#33B }
.syntaxhl .reserved { color:#080; font-weight:bold }
.syntaxhl .string { background-color:#fff0f0; color: #D20; }
.syntaxhl .string .delimiter { color:#710 }
</style>
</head>
<body>
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
<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 note: <strong>#124-6</strong>, or <strong>#124#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>[[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>
Jean-Philippe Lang
Adds News and Forum link documentation (#13497)....
 r13413 <ul>
<li>Forums:
Jean-Philippe Lang
Replace tabs with spaces and remove trailing tabs in several files (#20140)....
 r13983 <ul>
Jean-Philippe Lang
Adds News and Forum link documentation (#13497)....
 r13413 <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>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 <ul>
<li>Forum messages:
Jean-Philippe Lang
Replace tabs with spaces and remove trailing tabs in several files (#20140)....
 r13983 <ul>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 <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>
Jean-Philippe Lang
Adds News and Forum link documentation (#13497)....
 r13413 <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>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 </ul></li>
</ul>
Jean-Philippe Lang
Adds News and Forum link documentation (#13497)....
 r13413 <ul>
<li>News:
Jean-Philippe Lang
Replace tabs with spaces and remove trailing tabs in several files (#20140)....
 r13983 <ul>
Jean-Philippe Lang
Adds News and Forum link documentation (#13497)....
 r13413 <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>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866
<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>HTTP URLs 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>
Toshi MARUYAMA
fix wiki syntax "bold italic" (#15391, #15401)...
 r12071 <li><em><strong>bold italic</strong></em></li>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 <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>
Toshi MARUYAMA
use escaping html in wiki_syntax_detailed.html...
 r12093 <li><strong>!&gt;image_url!</strong> right floating image</li>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 <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>
<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>
Toshi MARUYAMA
use escaping html in wiki_syntax_detailed.html...
 r12093 p&gt;. right aligned
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 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>
Toshi MARUYAMA
use escaping html in wiki_syntax_detailed.html...
 r12093 {{toc}} =&gt; left aligned toc
{{&gt;toc}} =&gt; right aligned toc
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 </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>
Jean-Baptiste Barth
Include new standard macros in wiki syntax detailed help pages (#17847)....
 r13020 <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>
Jean-Philippe Lang
Wrong syntax for wiki macros in wiki_syntax_detailed.html (#19381)....
 r13720 <pre><code>{{child_pages}} -- can be used from a wiki page only
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
Jean-Baptiste Barth
Include new standard macros in wiki syntax detailed help pages (#17847)....
 r13020
<dt><code>include</code></dt>
<dd><p>Include a wiki page. Example:</p>
Jean-Philippe Lang
Wrong syntax for wiki macros in wiki_syntax_detailed.html (#19381)....
 r13720 <pre><code>{{include(Foo)}}</code></pre>
Jean-Baptiste Barth
Include new standard macros in wiki syntax detailed help pages (#17847)....
 r13020 <p>or to include a page of a specific project wiki:</p>
Jean-Philippe Lang
Wrong syntax for wiki macros in wiki_syntax_detailed.html (#19381)....
 r13720 <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
Jean-Baptiste Barth
Include new standard macros in wiki syntax detailed help pages (#17847)....
 r13020
<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>
</dl>
</p>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
Toshi MARUYAMA
[#20288] Update the i18n'ed core doc to match CodeRay 1.1.0 capabilities....
 r14107 <p>Default 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, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml and yaml (yml) languages, where the names inside parentheses are aliases.</p>
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866
<p>You can highlight code in your wiki page using this syntax:</p>
<pre>
&lt;pre&gt;&lt;code class="ruby"&gt;
Jean-Philippe Lang
Typo in wiki_syntax_detailed.html (#19444)....
 r13775 Place your code here.
Toshi MARUYAMA
copy English wiki syntax helps to other languages (#14630)...
 r11866 &lt;/code&gt;&lt;/pre&gt;
</pre>
<p>Example:</p>
<pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
<span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
<span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
<span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
<span class="line-numbers"> 5</span> <span class="reserved">end</span>
<span class="line-numbers"> 6</span>
<span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
<span class="line-numbers"> 8</span> puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
<span class="line-numbers"> 9</span> <span class="reserved">end</span>
<span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
</pre>
</body>
</html>