Wiki FAQ
How can I add images to a wiki page?
- Clone the wiki to your local computer with
hg clone http://bitbucket.org/<yourusername>/<yourrepo>/wiki/ - Copy the image to your local clone directory
- Commit the image with
hg commit -A -m "added image" - Push the new changeset to the wiki with
hg push https://bitbucket.org/<yourusername>/<yourrepo>/wiki/
How can I add a table of content?
Insert <<toc>> into the page that needs the table of content (ToC). You could also create a ToC for a directory. The general syntax for the ToC generation is <<toc [file/folder] [level=3]>>.
How do I use syntax highlighting?
You can also highlight snippets of text, we use the excellent Pygments library.
Here's an example of some Python code:
Here's how it's done:
{{{
#!python
def wiki_rocks(text):
formatter = lambda t: "funky"+t
return formatter(text)
}}}
Make sure to bookmark the vast library of Pygment lexers. We accept the 'short name' or the 'mimetype' of anything in there.
How do I link to an issue?
<<issue 1>> links to the issue with id 1.
<<query ?status=open&status=new All open issues>>
A link to all issues with status open or new, where the link text is “All open issues”.
<<milestone Beta 1>> lists of issues for milestone “Beta 1”, with
links and status for each issue.
<<issues ?status=open&status=new count|list|compact>>
Lists all issues that match the query (status is open or new) in one of two optional styles, or shows the number of issues that match the query.
<<issues ?status=open&status=new list>>
Shows a full list of open or new issues, in the same layout as the milestone-macro.
<<issues ?status=open&status=new compact>>
Shows a list of open or new issues, but only the issue id with a link to each issue in the tracker.
How do I link to a changeset?
<<changeset 45cc878df717>>
A link to changeset 45cc878df717’s diff-view.
How do i link to a file?
<<file path/to/File [revision] [linenumber]>> <<file [rev:]path/to/File[#L123]>>
A link to a file for the given revision an linenumber, where both are optionnal. By default, point to 'tip' and '0'.
Doesn't seem to work with tags.
Why do I lose wiki tags on the top line?
Your editor is inserting a UTF BOM in your wiki file. See issue #448
Is there a quick reference for Creole syntax?
http://www.wikicreole.org/attach/CheatSheet/creole_cheat_sheet.png
Note that this cheat sheet doesn't include the optional syntax additions that are available on Bitbucket (which doesn't include alternate link syntax and indented paragraphs).
