Go back to First Steps

Wiki

What is a Wiki?

• A wiki is a dynamic content manager similiar to Wikipedia. All changes to wiki pages are saved in a wiki history. You can roll back to previous versions, export the pages as txt file or compare the changes with past versions. This makes it the perfect tool collaboration tool to keep track of text changes in long text files. Each project can have its own wiki. To activate it go to the wiki module in project settings ad give a name for the main page and click 'Save'.

Features:

• Roll back history to restore previous wiki pages
• Changes are saved per user, you can see who changed what
• Color scheme based history (red=deleted, green=new)
• Create unlimited wiki pages
• Intelligent style tags makes it possible to work without repeatitive <open> and </close> tags.
• Wiki page export as txt file

You can use it to:

• Post your translations
• Add series information, reviews and images
• Gain full control of text changes made by multiple authors.

Create New Pages

• To create additional wiki pages simply point the browser to the url, where you want to create the wiki page:

Example: http://rome.jcafe24.com/wiki/*yourproject*/name_of_new_wiki_page

Will create a wiki page called "name_of_new_wiki_page" for project "*yourproject*"

Wiki Navigation

Table of content

{{toc}} => left aligned toc
{{>toc}} => right aligned toc

Wiki commands

Wiki formatting

Links

ROME links

ROME allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.

• Link to an issue: #124 (displays #124, link is striked-through if the issue is closed)
• Link to a changeset: r758 (displays r758)
• Link to a changeset with a non-numeric hash: commit:"c6f4d0fd" (displays c6f4d0fd). Added in r1236.

Wiki links:

• [[Guide]] displays a link to the page named 'Guide': Guide
• [[Guide|User manual]] displays a link to the same page but with a different text: User manual

You can also link to pages of an other project wiki:

• [[sandbox:some page]] displays a link to the page named 'Some page' of the Sandbox wiki
• [[sandbox:]] displays a link to the Sandbox wiki main page

Wiki links are displayed in red if the page doesn't exist yet, eg: Nonexistent page.

Links to others resources (0.7):

• Documents:

• document#17 (link to document with id 17)
• document:Greetings (link to the document with title "Greetings")
• document:"Some document" (double quotes can be used when document title contains spaces)

• Versions:

• version#3 (link to version with id 3)
• version:1.0.0 (link to version named "1.0.0")
• version:"1.0 beta 2"

• Attachments:

• attachment:file.zip (link to the attachment of the current object named file.zip)
• 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)

Escaping (0.7):

• You can prevent ROME links from being parsed by preceding them with an exclamation mark: !

External links

HTTP URLs and email addresses are automatically turned into clickable links:

http://www.ROME.org, someone@foo.bar

displays: http://www.ROME.org, someone@foo.bar

If you want to display a specific text instead of the URL, you can use the standard textile syntax:

"ROME web site":http://www.ROME.org

displays: ROME web site

Text formatting

For things such as headlines, bold, tables, lists, ROME supports Textile syntax. See http://hobix.com/textile/ for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.

Font style

* *bold*
* _italic_
* _*bold italic*_
* +underline+
* -strike-through-

Display:

• bold
• italic
• *bold italic*
• underline
• strike-through

Inline images

• !image_url! displays an image located at image_url (textile syntax)
• !>image_url! right floating image
• !{width:300px}image_url! sets the width of the image

If you have an image attached to your wiki page, it can be displayed inline using its filename: !attached_image.png!

Headings

h1. Heading
h2. Subheading
h3. Subheading

Paragraphs

p>. right aligned
p=. centered

This is centered paragraph.

Blockquotes

Start the paragraph with bq.

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.

Display:

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.