How do I format a Wiki page on Mindmakers?¶
Links¶
Mindmakers links¶
Mindmakers 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
- [[Guide#User-guide|User guide]] displays a link to the header on the same page with a different text: User guide
You can also link to pages of another 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:
- 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)
- Repository files
- source:some/file – Link to the file located at /some/file in the project’s repository
- source:some/file@52 – Link to the file’s revision 52
- source:some/file#L120 – Link to line 120 of the file
- source:some/file@52#L120 – Link to line 120 of the file’s revision 52
- export:some/file – Force the download of the file
- Users
- {{user_link(login_name)}} – Link to a user using his actual login name
- * Example: Use {{user_link(flashgordon)}}
Escaping:
- You can prevent Mindmakers 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.mindmakers.org, someone@foo.bar
displays: http://www.mindmakers.org, someone@foo.bar
If you want to display a specific text instead of the URL, you can use the standard textile syntax:
"Mindmakers web site":http://www.mindmakers.org
displays: Mindmakers web site
Text formatting¶
For things such as headlines, bold, tables, lists, Mindmakers supports Textile syntax. See http://www.textism.com/tools/textile/ for information on using any of these features. A few samples are included below.
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.
Unordered lists¶
* Item 1 * Item 2 * Item 21 * Item 22 * Item 3
displays:
- Item 1
- Item 2
- Item 21
- Item 22
- Item 3
Ordered lists¶
# Item 1 # Item 2 # Item 3
displays:
- Item 1
- Item 2
- Item 3
Tables¶
|_.UserID|_.Name|_.Group| |\3=.IT| |1|Artur Pirozhkov|/2.Users| |2|Vasya Rogov| |3|John Smith|Admin|
Display:
UserID | Name | Group |
---|---|---|
IT | ||
1 | Artur Pirozhkov | Users |
2 | Vasya Rogov | |
3 | John Smith | Admin |
Table of content¶
{{toc}} => left aligned toc
{{>toc}} => right aligned toc
Macros¶
Mindmakers has the following builtin macros:
child_pages
Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:
!{{child_pages}} – can be used from a wiki page only
!{{child_pages(Foo)}} – lists all children of page Foo
!{{child_pages(Foo, parent=1)}} – same as above with a link to page Foocomment_form
Displays a comment form.
comments
Display comments of the page.
count
Count access to the pages.
!{{count}}
div_end_tag
Displays a
</div>
!{{div_end_tag}}
div_start_tag
Displays a
<div id="id_name" class="class_name">
!{{div_start_tag(id_name)}}'
!{{div_start_tag(id_name, class_name)}}dmsf
Wiki link to DMSF file:
{{dmsf(file_id [, title [, revision_id]])}}
file_id / revision_id can be found in link for file/revision download.
dmsff
Wiki link to DMSF folder:
{{dmsff(folder_id [, title])}}
folder_id may be missing. folder_id can be found in link for folder opening.
fn
Create a footnote.
{{fn(word, description}}
fnlist
Displays footnotes of the page.
hello_world
Sample macro.
hook
Adds new Redmine hook to Wiki page and calls it. Example:
!{{hook(name, argument=value)}}
iframe
Insert an iframe tag
!{{iframe(url, width, height)}}
include
Include a wiki page. Example:
!{{include(Foo)}}
or to include a page of a specific project wiki:
!{{include(projectname:Foo)}}
lastupdated_at
Displays a date that updated the page.
!{{lastupdated_at}}
lastupdated_by
Displays a user who updated the page.
!{{lastupdated_by}}
macro_list
Displays a list of all available macros, including description if available.
member_list
new
Displays a string 'new’.
!{{new(yyyy-mm-dd)}}
!{{new(yyyy-mm-dd, expire)}}Default of expire is 5.
new_page
Create new page.
news_list
news_list_all
Displays list of members for now.
Will later implement different lists.popularity
Displays list of the popular pages.
!{{popularity}}
!{{popularity(max)}}
!{{popularity(max, term)}}project
Creates link to other project.
{{project(project_name)}} {{project(project_identifire}} {{project(project_name, alias)}} {{project(project_identifire, alias}}
recent
Displays a list of pages that were changed recently. '
!{{recent}}'
!{{recent(number_of_days)}}ref_issues
Displays a list of referer issues.
show_count
Displays an access count of the page.
!{{show_count}}
show_vote
Display result of vote macro.
!{{show_vote(key)}}
tagcloud
Displays tagcloud.
!{{tagcloud}}
taggedpages
Displays pages that have specified tag.
!{{taggedpages(tagname)}}
!{{taggedpages(tagname, project)}}tags
Displays tags.
!{{tags}}
twitter
Creates link to twitter account page.
!{{twitter(user_name)}}
user_link
Wrap username with link to public user page.
vote
Vote macro.
!{{vote(key)}}
!{{vote(key, label)}}wiki
Link to wiki page of other project.
!{{wiki(project_name, wiki_page)}}
!{{wiki(project_name, wiki_page, alias)}}
!{{wiki(project_identifier, wiki_page)}}
!{{wiki(project_identifier, wiki_page, alias)}}
Code highlighting¶
Code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, javascript, rhtml, ruby, scheme, xml languages.
You can highlight code in your wiki page using this syntax:
<pre><code class="ruby">
Place you code here.
</code></pre>
Example:
1# The Greeter class
2class Greeter
3 def initialize(name)
4 @name = name.capitalize
5 end
6
7 def salute
8 puts "Hello #{@name}!"
9 end
10end