|
|
# User guide
|
|
|
|
|
|
## Wiki editing
|
|
|
|
|
|
Basic wiki editing is explained
|
|
|
[here](https://www.ohwr.org/help/wiki_syntax_detailed.html)
|
|
|
|
|
|
## Differences between Redmine and Twiki
|
|
|
|
|
|
Headers
|
|
|
|
|
|
---++ Twiki header
|
|
|
|
|
|
h2. Redmine header
|
|
|
|
|
|
(remember to leave one empty line before and after the header on redmine)
|
|
|
|
|
|
Sublists are not idented; instead, the number of stars expresses the
|
|
|
list level:
|
|
|
|
|
|
* Twiki list
|
|
|
* Twiki sublist
|
|
|
|
|
|
* Redmine list
|
|
|
** Redmine sublist
|
|
|
|
|
|
Numbered lists are expressed with the \# symbol:
|
|
|
|
|
|
1. Twiki numbered list
|
|
|
|
|
|
# Redmine numbered list
|
|
|
|
|
|
Links are also different
|
|
|
|
|
|
[[http://www.google.com][Twiki external link to google]]
|
|
|
[[Description][Twiki wiki page link]]
|
|
|
|
|
|
"Redmine external link to google":http://www.google.com
|
|
|
"Redmine wiki page link":Description
|
|
|
|
|
|
On redmine there's an specific way link to issues, commits and files on
|
|
|
the repository. These really don't have an equivalent on
|
|
|
Twiki:
|
|
|
|
|
|
A link to a file stored on the repository: [link](https://www.ohwr.org/project/ohr-support/blob/master/trunk/path/to/file.txt)
|
|
|
A link to revision 40 of that file: [link](https://www.ohwr.org/project/ohr-support/blob/master/trunk/path/to/file.txt@40)
|
|
|
A link to line 14 of revision 40 of that file: [link](https://www.ohwr.org/project/ohr-support/blob/master/trunk/path/to/file.txt@40#14)
|
|
|
|
|
|
A link to revision 758: r758
|
|
|
|
|
|
A link to an issue: #124
|
|
|
|
|
|
## Attaching files to wiki pages
|
|
|
|
|
|
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").
|
|
|
|
|
|
When you are on browse mode, a link called "New File" will allow you to
|
|
|
add attachments to the post.
|
|
|
|
|
|
If you want to put direct links to the attachments on your wiki pages,
|
|
|
you can do so by writing:
|
|
|
|
|
|
attachment:file.zip
|
|
|
|
|
|
Where file.zip is the filename of the attached file.
|
|
|
|
|
|
## Putting images on wiki pages
|
|
|
|
|
|
\# First edit some text on your wiki page, and press "Save". You will
|
|
|
get presented with the page on "browse mode"
|
|
|
|
|
|
\# 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)
|
|
|
|
|
|
\# Once you are done adding files, enter the "edit mode again" by
|
|
|
pressing the "edit" link
|
|
|
|
|
|
\# You can place images by putting the file name of the attached images
|
|
|
between exclamation marks in your code:
|
|
|
|
|
|
diagram.jpg
|
|
|
|