Patch #5948
Update help/wiki_syntax_detailed.html with more link options
| Status: | Closed | Start date: | 2010-07-23 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | Jean-Baptiste Barth | % Done: | 100% |
|
| Category: | Documentation | |||
| Target version: | 1.0.3 |
Description
This patch adds documentation of links to forum posts to the file help/wiki_syntax_detailed.html. It also normalizes some of the formatting.
A considering comitter should also normalize the whole file to \n line endings.
Related issues
Associated revisions
Updated wiki-syntax help page to reflect new link options and last coderay upgrade. #5948
Contributed by Holger Just and Mischa The Evil
History
#1 Updated by Mischa The Evil over 1 year ago
- File update_wiki_syntax_detailed-r4249.diff added
Updated the patch against current trunk and included new languages supported by Coderay 0.9.2 (latest included version).
For reviewers:
1Index: public/help/wiki_syntax_detailed.html
2===================================================================
3--- public/help/wiki_syntax_detailed.html (revision 4249)
4+++ public/help/wiki_syntax_detailed.html (working copy)
5@@ -66,7 +66,7 @@
6
7 <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>
8
9- <p>Links to others resources (0.7):</p>
10+ <p>Links to other resources:</p>
11
12 <ul>
13 <li>Documents:
14@@ -74,6 +74,7 @@
15 <li><strong>document#17</strong> (link to document with id 17)</li>
16 <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
17 <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
18+ <li><strong>document:some_project:"Some document"</strong> (link to a document with title "Some document" in other project "some_project")
19 </ul></li>
20 </ul>
21
22@@ -95,19 +96,36 @@
23 </ul>
24
25 <ul>
26- <li>Repository files
27+ <li>Repository files:
28 <ul>
29- <li><strong>source:some/file</strong> -- Link to the file located at /some/file in the project's repository</li>
30- <li><strong>source:some/file@52</strong> -- Link to the file's revision 52</li>
31- <li><strong>source:some/file#L120</strong> -- Link to line 120 of the file</li>
32- <li><strong>source:some/file@52#L120</strong> -- Link to line 120 of the file's revision 52</li>
33- <li><strong>export:some/file</strong> -- Force the download of the file</li>
34- </ul></li>
35+ <li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
36+ <li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
37+ <li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
38+ <li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
39+ <li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
40+ <li><strong>export:some/file</strong> (force the download of the file)</li>
41+ </ul></li>
42 </ul>
43-
44- <p>Escaping (0.7):</p>
45
46 <ul>
47+ <li>Forum messages:
48+ <ul>
49+ <li><strong>message#1218</strong> (link to message with id 1218)</li>
50+ </ul></li>
51+ </ul>
52+
53+ <ul>
54+ <li>Projects:
55+ <ul>
56+ <li><strong>project#3</strong> (link to project with id 3)</li>
57+ <li><strong>project:someproject</strong> (link to project named "someproject")</li>
58+ </ul></li>
59+ </ul>
60+
61+
62+ <p>Escaping:</p>
63+
64+ <ul>
65 <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
66 </ul>
67
68@@ -219,7 +237,7 @@
69
70 <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
71
72- <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>
73+ <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>
74
75 <p>You can highlight code in your wiki page using this syntax:</p>
76
#2 Updated by Mischa The Evil over 1 year ago
- Assignee changed from Muntek Singh to Eric Davis
- Target version set to 1.0.3
#3 Updated by Eric Davis over 1 year ago
- Assignee deleted (
Eric Davis)
#4 Updated by Jean-Baptiste Barth over 1 year ago
- Status changed from New to Resolved
- Assignee set to Jean-Baptiste Barth
- % Done changed from 0 to 100
Applied in r4308, thanks!
#5 Updated by Eric Davis over 1 year ago
- Status changed from Resolved to Closed
Merged into 1.0-stable for release in 1.0.3
