Project

General

Profile

RedmineTextFormattingRedmineLinks » History » Version 6

Mischa The Evil, 2021-02-05 21:15
Make user Redmine link example more explicit.

1 1 Hiroo Hayashi
Redmine allows hyperlinking between resources (wiki pages, issues, documents...) from anywhere text formatting is used.
2
3
Wiki links:
4
5
* *[[Guide]]* displays a link to the page named 'Guide': [[Guide]]
6
* *[[Guide#further-reading]]* takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: [[Guide#further-reading]]
7
* *[[Guide|User manual]]* displays a link to the same page but with different text: [[Guide|User manual]]
8
* *[[Guide#User-guide|User guide]]* displays a link to the header on the same page with different text: [[Guide#User-guide|User guide]]
9
10
You can also link to pages of another project's wiki (using the project identifier):
11
12
* *[[sandbox:some page]]* displays a link to the page named 'Some page' of the Sandbox wiki
13
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
14
15
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
16
17
Links to other resources:
18
19
* Issues:
20
21
  * *!#124* (link to an issue: displays #124, link is striked-through if the issue is closed)
22
  * *!#124-6*, or *!#124#note-6* (link to an issue note: displays #124-6, or #124#note-6)
23
24
* Documents:
25
26
  * *!document#17* (link to document with id 17)
27
  * *!document:Greetings* (link to the document with title "Greetings")
28
  * *!document:"Some document"* (double quotes can be used when document title contains spaces)
29
  * *!sandbox:document:"Some document"* (link to a document with title "Some document" in project identifier "sandbox")
30
31
* Versions:
32
33
  * *!version#3* (link to version with id 3)
34
  * *!version:1.0.0* (link to version named "1.0.0")
35
  * *!version:"1.0 beta 2"* (double quotes can be used when version name contains spaces)
36
  * *!sandbox:version:1.0.0* (link to version "1.0.0" in the project identifier "sandbox")
37
38
* Attachments:
39
  
40
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
41
  * *!attachment:"file name.zip"* (double quotes can be used when the filename contains non word characters)
42
  * 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)
43
44
* Changesets:
45
46
  * *!r758* (link to a changeset, displays r758)
47
  * *!commit:c6f4d0fd* (link to a changeset with a non-numeric hash)
48
  * *!svn1|r758* (link to a changeset of a specific repository, for projects with multiple repositories)
49
  * *!commit:hg|c6f4d0fd* (link to a changeset with a non-numeric hash of a specific repository)
50
  * *!sandbox:r758* (link to a changeset of another project)
51
  * *!sandbox:commit:c6f4d0fd* (link to a changeset with a non-numeric hash of another project identifier)
52
53
* Repository files:
54
55
  * *!source:some/file* (link to the file located at /some/file in the project's repository)
56
  * *!source:"some file"* (link to the file with non word characters in the path)
57
  * *!source:some/file@52* (link to the file's revision 52)
58 3 Vojtěch Srdečný
  * *!source:some/file@master* (link to the file in branch _master_)
59 1 Hiroo Hayashi
  * *!source:some/file#L120* (link to line 120 of the file)
60
  * *!source:some/file@52#L120* (link to line 120 of the file's revision 52)
61
  * *!source:repo_identifier|some/file* (link to a file of a specific repository, for projects with multiple repositories)
62
  * *!sandbox:source:some/file* (link to the file in the project identifier "sandbox")
63 5 Mischa The Evil
  * *!sandbox:source:repo_identifier|some/file* (link to the file, with non word characters in the path, of a specific repository in the project identifier "sandbox")
64 1 Hiroo Hayashi
  * *!export:some/file* (force the download of the file)
65
 
66
* Forums:
67
68
  * *!forum#2* (link to forum with id 2)
69
  * *!forum:Discussion* (link to forum with name "Discussion")
70
  * *!forum:"Help and more"* (double quotes can be used when forum name contains spaces)
71
72
* Forum messages:
73
74
  * *!message#1218* (link to message with id 1218)
75
76
* News items
77
78
  * *!news#1* (link to news item with id 1)
79
  * *!news:Greetings* (link to news item with name "Greetings")
80
  * *!news:"eCookbook first release !"* (double quotes can be used when news item name contains spaces)
81
82
* Projects:
83
84
  * *!project#3* (link to project with id 3)
85
  * *!project:someproject* (link to project with name "someproject")
86
  * *!project:"Multiple words project"* (double quotes can be used when project name contains spaces)
87
88 2 Davide Cavarretta
* Users:
89
90 6 Mischa The Evil
  * *user:jsmith* (Link to user with login "jsmith")
91 2 Davide Cavarretta
92
93
94 1 Hiroo Hayashi
Escaping:
95
96
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !