Get started with Bitbucket Cloud
New to Bitbucket Cloud? Check out our get started guides for new users.
Macro reference for Creole markup
You can use the following macros in your wiki's Creole markup:
File
Syntax : <<file path/to/file revision linenumber>>
or
<<file revison:path/to/file#linenumber>>
Links to a given file within the same project as the wiki. You cannot link to files that reside in repositories in other projects. The link syntax does not work with tags.
This macro supports the following arguments:
Argument | Description | Required? |
|---|---|---|
path/to/file | The relative path to the file from the repository root. Do not include the repository name in the path. | Yes |
revison | A revision name or hash. By default, the system returns the current revision. | No |
linenumber | The location in the file to link to. By default, the link points to line 0. | No |
Examples:
1
<<file stylesheets/foundation.css 55>>Results in the following output:
stylesheets/foundation.css
Issue
Syntax : <<issue number>>
Links to a given issue. Supports the following arguments:
Argument | Description | Required? |
|---|---|---|
number | The issue number | Yes |
Examples:
<<issue 4>>
Results in the following output:
1
#4Issue Milestone
Syntax : <<milestone>>
Lists issues for the given milestone. This supports the following arguments:
Argument | Description | Required? |
|---|---|---|
milestone | Name of the milestone. | Yes |
Example:
<<milestone Version21>>
Results in the following output:
1
2
3
Milestone Version21:
* #3 MyIssue (open)Issue Query
Syntax: <<query queryString>>
Link to the given issue queryString. This supports the following arguments:
Argument | Description | Required? |
|---|---|---|
queryString | An HTML query string. There is no AND operator for this markup. You cannot group queries. | Yes |
link | Text of link. | No |
Example:
<<query status=new&status=open Open Issues>>
The output is linked to the phrase provided.
1
Open Issues Issue List
Syntax: <<issues queryString>>
Lists issues matching the given queryString. There is no AND operator for this markup. You cannot group queries. Supports the following arguments:
Argument | Description | Required? |
|---|---|---|
queryString | An HTML query string. | Yes |
The <<issues queryString>> syntax does not fully support the query syntax with regard to sort order. Please follow issue #3964 for this problem.
Example:
<<issues status=resolved>>
Results in a list like the following:
1
2
* #7 Major Issue (resolved)
* #4 Little Bug (resolved)Changeset
Syntax: <<changeset hashvalue>>
Links to the given changeset. The system links any changeset hash automatically also. You can only link to a changeset that is within the same repository where the wiki resides. For example, if the wiki is in projectA, you cannot link to a changeset in projectB.
This macro supports the following arguments:
Argument | Description | Required? |
|---|---|---|
hashvalue | A changeset hash. | Yes |
Examples:
<<changeset 9cc27f2>>
or
9cc27f2
Results in a list of links:
1
2
9cc27f29672b
9cc27f29672bUser
Syntax: <<user accountname>>
Links to the profile of the given accountname. Supports the following arguments:
Argument | Description | Required? |
|---|---|---|
accountname | The name of the individual or user account. | Yes |
Examples:
<<user bitbucket>>
Produces the following output:
1
2
3
bitbucket
tutorialsSource
Syntax: <<file filename branch line >>or <<source filename branch line >> or <<src filename branch line >>
Links to the repository source view of the given filename. Optionally, you can refer to a branch (revision) and a particular line number. Supports the following arguments:
Argument | Description | Required? |
|---|---|---|
filename | The name of the source file. | Yes |
branch | Hash or branch name. | No |
line | A line number. | No |
Example:
<<file manage.py master 45>>
Produces output like the following:
1
manage.pyTable of Contents
Syntax: <<toc path depth>>
Only available for wikis. This macro lists and links to the headings for the given path(s). The path can be a filename or the path to a file. Supports the following arguments:
Argument | Description | Required? |
|---|---|---|
path | A simple filename or a path to a file ending in '/' (forward slash). To use the current path, do not specify path. | No |
depth | The number (1-6) of the lowest HTML header to traverse. | No |
Example:
<<toc>>, <<toc examples/>>, <<toc 2>>, <<toc troubleshooting 4>>
Produces the following output:
1
2
3
4
5
6
7
8
* Getting Started
* Installation
* OS X
* Windows
* Linux
* Requirements
* Best Practices
* How to ContributeExamples of Creole macros
Markup | Description |
|---|---|
1
<<issue 1>> | Add a link to the issue with ID of 1. |
1
<<query ?status=open&status=new All open issues>> | Add a link to all issues with status open or new, with link text 'All open issues'. |
1
<<milestone Beta 1>> | Add a list of all issues for milestone 'Beta 1', with links and status for each issue. |
1
<<issues ?status=open&status=new count|list|compact>> | List all issues that match the query (status is open or new) in one of two optional styles, or show the number of issues that match the query. |
1
<<issues ?status=open&status=new list>> | Show a full list of open or new issues, in the same layout as the milestone macro. |
1
<<issues ?status=open&status=new compact>> | Show a list of open or new issues, but only the issue ID with a link to each issue in the tracker. |
<<issues ?content=~foo>> | Display the results of a query that searches the description for a specific string. |
Was this helpful?
Still need help?
The Atlassian Community is here for you.