|
|
Headings
To create a header, place "hn. " at the start of the line (where n can be a number from 1-6).
| Notation |
Comment |
| h1. Biggest heading |
Biggest heading
|
| h2. Bigger heading |
Bigger heading
|
| h3. Big Heading |
Big Heading
|
| h4. Normal Heading |
Normal Heading
|
| h5. Small Heading |
Small Heading
|
| h6. Smallest Heading |
Smallest Heading
|
Text Effects
Text effects are used to change the formatting of words and sentences.
| Notation |
Comment |
| *strong* |
Makes text strong.
|
| _emphasis_ |
Makes text emphasis.
|
| ??citation?? |
Makes text in citation.
|
| -strikethrough- |
Makes text as strikethrough.
|
| +underlined+ |
Makes text as underlined.
|
| ^superscript^ |
Makes text in superscript.
|
| ~subscript~ |
Makes text in subscript.
|
| {{text will be monospaced}} |
Makes text as code text.
|
| bq. Some block quoted text |
To make an entire paragraph into a block quotation, place "bq. " before it.
Example:
Some block quoted text
|
Text Breaks
Most of the time, explicit paragraph breaks are not required - Confluence will be able to paginate your paragraphs properly.
| Notation |
Comment |
| (empty line) |
Produces a new paragraph |
| \\ |
Creates a line break. Not often needed, most of the time Confluence will guess new lines for you appropriately. |
| ---- |
Creates a horizontal rule |
| --- |
Produces — symbol. |
| -- |
Produces – symbol. |
Links
Links are the heart of Confluence, so learning how to create them quickly is important.
| Notation |
Comment |
[#anchor]
[^attachment.ext]
or
[pagetitle]
[pagetitle#anchor]
[pagetitle^attachment.ext]
or
[spacekey:pagetitle]
[spacekey:pagetitle#anchor]
[spacekey:pagetitle^attachment.ext]
|
Creates an internal hyperlink to the specified page in the desired space (or the current one if you don't specify any space). Appending the optional '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Also having the optional '^' followed by the name of an attachment will lead into a link to the attachment of the desired page.
Example:
pagetitle
If such a page doesn't already exist, it will allow you to create the page in the current space. Create page links will have a  after them.
Example:
anewpage
|
[link alias|#anchor|link tip]
[link alias|^attachment.ext|link tip]
or
[link alias|pagetitle|link tip]
[link alias|pagetitle#anchor|link tip]
[link alias|pagetitle^attachment.ext|link tip]
or
[link alias|spacekey:pagetitle|link tip]
[link alias|spacekey:pagetitle#anchor|link tip]
[link alias|spacekey:pagetitle^attachment.ext|link tip]
|
Creates an internal hyperlink to the specified page in the desired space (or the current one if you don't specify any space) where the link text is different from the actual hyperlink link. Also you can have an optional link tip which will appear as tooltip. Appending the optional '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Also having the optional '^' followed by the name of an attachment will lead into a link to the attachment of the desired page.
Example:
link alias
|
|
[/2004/01/12/Blog Post]
[spacekey:/2004/01/12/Blog Post]
|
Creates an internal hyperlink to the specified blog post in the desired space (or the current one if you don't specify any space). You must specify the date the post was made in /year/month/day form as shown. Anchors and link text can be added the same way as described above. If you attempt to link to a blog post that doesn't exist, no link will be created.
Example:
|
[/2004/01/12]
[spacekey:/2004/01/12]
or
[my link name|/2004/01/12]
[my link name|spacekey:/2004/01/12]
|
Creates an internal hyperlink to a view of a whole day's blog. Specify the date you wish to link to as year/month/day. Link titles can be supplied as with other links. It is possible to link to days with no blog posts on them: the destination page will just be empty.
Examples:
|
[$12345]
or
[my link name|$12345]
|
Creates a link to a piece of content by its internal database ID. This is currently the only way to link to a mail message.
Examples:
|
[spacekey:]
[custom link title|spacekey:]
|
Creates a link to the space homepage, or space summary page of a particular space. Which of these the link points to depends on the configuration of the space being linked to. If the space does not exist, the link will be drawn with a strike-through to indicate it is an invalid space.
Examples:
|
[~username]
[custom link title|~username]
|
Creates a link to the user profile page of a particular user. By default, will be drawn with a user icon and the user's full name, but if you supply a custom link text, the icon will not be drawn. If the user being linked to does not exist, the link will be drawn with a strike-through.
Examples:
|
[phrase@shortcut]
[custom link text|phrase@shortcut] |
Creates a shortcut link to the specified shortcut site. Shortcuts are configured by the site administrator. You can add a link title to shortcuts in the same manner as other links.
Examples:
|
[http://confluence.atlassian.com]
[Atlassian|http://atlassian.com] |
Creates a link to an external resource, special characters that come after the URL and are not part of it must be separated with a space. External links are denoted with an arrow icon.
Note: the [] around external links are optional in the case you do not want to use any alias for the link.
Examples:
|
| [mailto:legendaryservice@atlassian.com] |
Creates a link to an email address, complete with mail icon.
Example:
 legendaryservice@atlassian.com
|
[file://c:/temp/foo.txt]
[file://z:/file/on/network/share.txt] |
This only works on Internet Explorer
Creates a link to file on your computer or on a network share that you have mapped to a drive
|
Lists
Lists allow you to present information as a series of ordered items.
| Notation |
Comment |
* some
* bullet
** indented
** bullets
* points
|
A bulleted list (must be in first column). Use more (**) for deeper indentations.
Example:
|
- different
- bullet
- types
|
A list item (with -), several lines create a single list.
Example:
|
# a
# numbered
# list
|
A numbered list (must be in first column). Use more (##, ###) for deeper indentations.
Example:
- a
- numbered
- list
|
|
# a
# numbered
#* with
#* nested
#* bullet
# list * a
* bulletted
*# with
*# nested
*# numbered
* list
|
You can even go with any kind of mixed nested lists:
Example:
- a
- numbered
- list
- a
- bulletted
- with
- nested
- numbered
- list
|
Images
Images can be embedded into Confluence pages from attached files or remote sources.
| Notation |
Comment |
!http://www.host.com/image.gif!
or
!attached-image.gif!
|
Inserts an image into the page. If a fully qualified URL is given the image will be displayed from the remote source, otherwise an attached image file is displayed.
|
!spaceKey:pageTitle^image.gif!
!/2007/05/23/My Blog Post^image.gif!
|
Inserts an image that is attached on another page or blog post. If no space key is defined, the current is space is used by default.
|
| !image.jpg|thumbnail! |
Insert a thumbnail of the image into the page (only works with images that are attached to the page). Users can click on the thumbnail to see the full-sized image. Thumbnails must be enabled by the site administrator for this to work.
|
| !image.gif|align=right, vspace=4! |
For any image, you can also specify attributes of the image tag as a comma separated list of name=value pairs like so.
|
{gallery}
{gallery:columns=3}
{gallery:title=Some office photos, and a waterfall|columns=3}
{gallery:title=Some office photos, without the waterfall|exclude=waterfall.jpg}
{gallery:title=One office photo, and a waterfall|include=office1.jpg,waterfall.jpg}
{gallery:title=Some office photos, and a waterfall|page=Gallery of Pictures}
{gallery:title=Some office photos, and a waterfall|page=DOC:Gallery of Pictures}
{gallery:title=Some office photos, and a waterfall|sort=name}
{gallery:title=Some office photos, and a waterfall|sort=date|reverse=true}
|
Create a gallery of thumbnails of all images attached to a page. This will only work on pagesthat allow attachments, obviously. The title parameter allows you to supply a title for the gallery The columns parameter allows you to specify the number of columns in the gallery (by default, 4) The exclude parameter allows you to specify the name of attached images to ignore (i.e., they will not be included in the gallery). You can specify more than one picture, separated by commas. Example: exclude=my picture.png,my picture2.gif The include parameter allows you to specifically include one or more attached images. The gallery will show only those pictures. You can specify more than one picture, separated by commas. Example: include=my picture.png,my picture2.gif The page parameter allows you specify the title of one or more pages which contains the images you want displayed. If a page is in the same space as the page containing the macro, use the format page=My Page Name. To specify a page in a different space, use page=SPACEKEY:My Page Name, such as page=DOC:Gallery Macro. You can specify more than one page, separated by commas. Example: page=Image Gallery,STAFF:Group Photos If a page or attachment file name contains a comma, you can use it in the include, exclude, or page parameters by enclosing it in single or doublequotes. Example: include="this,that.jpg",theother.png The sort parameter allows you to control the order of the images. The options are name,comment, date, or size. The reverse parameter is used in conjunction with the sort parameter to reverse the order of the specified sort. Valid values are true and false. Previous versions of the Gallery macro had an additional slideshow parameter. This is no longer used in the latest version, and the slide show is always enabled. We have left the parameter here for compatibility with older versions of the macro.
|
{gliffy:name=My UML Diagram}
{gliffy:name=My UML Diagram|size=M|align=right}
{gliffy:space=Software|page=User flow|name=My user flow drawing|size=T|align=center}
{gliffy:space=Software|page=User flow|name=My user flow drawing|size=T|align=center|version=3}
|
Includes a Gliffy diagram in the page.
- name - (required) The name of the diagram. This name must be unique for the current page.
- space - (required if page attribute used, otherwise optional) The space key of the page that the diagram is attached to.
- page - (required if space attribute used, otherwise optional) The name of the page that the diagram is attached to.
- pageid - (optional) The id of the page the diagram is attached to (alternative to specifying the space and page name).
- size - (optional, default is L) The size of the image that will be shown. Possible values are L (Full size), M (medium), S (small), T (Thumbnail)
- align - (optional, default is left) Horizontal alignment of the diagram image on the page. Possible values are left,center, and right.
- alt - (optional, default is diagram name) Image tag alternative text.
- border - (optional, default is true) Display the border around an image.
- version - (optional) The version of the diagram to display. If this attribute is not defined, the latest version of the diagram will be displayed. NOTE: When updating a diagram, the version number will be updated in each macro ONLY on the page that contains the diagram attachment.
|
Tables
Tables allow you to organise content in a rows and columns, with a header row if required.
Advanced Formatting
More advanced text formatting.
| Notation |
Comment |
{code:title=Bar.java|borderStyle=solid}
// Some comments here
public String getFoo()
{
return foo;
}
{code}
{code:xml}
<test>
<another tag="attribute"/>
</test>
{code}
|
Makes a pre-formatted block of code with syntax highlighting. All the optional parameters of {panel} macro are valid for {code} too. The default language is Java but you can specify JavaScript, ActionScript, XML, HTML and SQL too.
Example:
public String getFoo()
{
return foo;
}
<test>
<another tag="attribute"/>
</test>
|
{newcode}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code. The language defaults to Java.
|
{newcode:vbnet}
Public Module Test
Public Sub Main()
Console.WriteLine("Hello World!");
End Sub
End Module
{newcode}
{newcode:language=vbnet}
Public Module Test
Public Sub Main()
Console.WriteLine("Hello World!");
End Sub
End Module
{newcode}
|
Specify the language using the default parameter of the "lang" parameter.
|
{newcode:title=Test title}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, including a title.
|
{newcode:collapse=true}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a collapsed version of syntax highlighted version of the code.
|
{newcode:linenumbers=false}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, without line numbers.
|
{newcode:firstline=10}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, without an alternative number as the first line.
|
{newcode:ruler=true}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, with a ruler to indicate the columns.
|
{newcode:theme=django}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, without an alternative theme.
|
{newcode}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code. The language defaults to Java.
|
{newcode:vbnet}
Public Module Test
Public Sub Main()
Console.WriteLine("Hello World!");
End Sub
End Module
{newcode}
{newcode:language=vbnet}
Public Module Test
Public Sub Main()
Console.WriteLine("Hello World!");
End Sub
End Module
{newcode}
|
Specify the language using the default parameter of the "lang" parameter.
|
{newcode:title=Test title}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, including a title.
|
{newcode:collapse=true}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a collapsed version of syntax highlighted version of the code.
|
{newcode:linenumbers=false}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, without line numbers.
|
{newcode:firstline=10}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, without an alternative number as the first line.
|
{newcode:ruler=true}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, with a ruler to indicate the columns.
|
{newcode:theme=django}
public class Test {
public static void main (String[] args) {
System.out.println("Hello World!");
}
}
{newcode}
|
Shows a syntax highlighted version of the code, without an alternative theme.
|
{note:title=Be Careful}
The body of the note here..
{note}
|
Prints a simple note to the user.
- title: - (optional) the title of the note.
- icon: - (optional) if "false", dont display the icon.
|
{warning:title=Warning}
Insert warning message here!
{warning}
|
Prints a warning note to the user.
- title: - (optional) the title of the warning.
- icon: - (optional) if "false", dont display the icon.
|
{info:title=Be Careful}
This macro is useful for including helpful information in your confluence pages
{info}
|
Prints an informational note.
- title: - (optional) the title of the information box.
- icon: - (optional) if "false", dont display the icon.
|
{tip:title=Handy Hint}
Join the Confluence Mailing-List!
{tip}
|
Prints a helpful tip for the user.
- title: - (optional) the title of the tip.
- icon: - (optional) if "false", dont display the icon.
|
{include:Home}
{include:FOO:Home}
{include:spaceKey=FOO|pageTitle=Home}
|
Includes one page within another (this example includes a page called "Home"). Pages from another space can be included by prefacing the page title with a space key and a colon.
The user viewing the page must have permission to view the page being included, or it will not be displayed.
|
Confluence Content
Ways to include, summarise or refer to other Confluence content.
| Notation |
Comment |
!quicktime.mov!
!spaceKey:pageTitle^attachment.mov!
!quicktime.mov|width=300,height=400!
!media.wmv|id=media!
|
Embeds an object in a page, taking in a comma-separated of properties.
Default supported formats:- Flash (.swf)
- Quicktime movies (.mov)
- Windows Media (.wma, .wmv)
- Real Media (.rm, .ram)
- MP3 files (.mp3)
Other types of files can be used, but may require the specification of the "classid", "codebase" and "pluginspage" properties in order to be recognised by web browsers.
Common properties are:
- width - the width of the media file
- height - the height of the media file
- id - the ID assigned to the embedded object
Due to security issues, files located on remote servers are not permitted
Styling
By default, each embedded object is wrapped in a "div" tag. If you wish to style the div and its contents, override the "embeddedObject" CSS class. Specifying an ID as a property also allows you to style different embedded objects differently. CSS class names in the format "embeddedObject-ID" are used.
|
{viewfile:presentation.ppt}
{viewfile:space=dog|page=testpage|name=worddocument.doc}
{viewfile:spreadsheet.xls|grid=false|sheet=Sheet 1|row=4|col=5}
{viewfile:slideshow.pdf|width=200|height=150}
|
Embeds the content of a file attachment into a Confluence page.
Supported formats:
- Microsoft Word Documents
- Embedded as html
- Microsoft Excel Spreadsheets
- Embedded as html
- Microsoft Powerpoint Presentations
- Embedded in a flash slideshow control or as a single image for individual pages
- Adobe PDF files
- Embedded in a flash slideshow control or as a single image for individual pages
- space: - (optional)the space key for the attachment. The default is the space of the page calling the macro.
- page: - (optional)the page or blog post that contains the attachment. The default is the page calling the macro.
- date: - (optional)the date of the blog post that contains the attachment in the form mm/dd/yyyy. Only applicable if the file is attached to a blog post
- name: - (required)the filename of the attachment. Can also be specified as the first argument using macro shorthand. {viewfile:filename.ext}
Macro arguments specific to Excel spreadsheets
- grid - (optional)If true, the worksheet gridlines will be rendered. The default is true.
- sheet - (optional)The name of the worksheet to render. The default is the first sheet in the workbook
- row - (optional)the last row in the worksheet to render. The default is the last row with content.
- col - (optional)the last column in the worksheet to render. The default the last column with content.
Macro arguments specific to Powerpoint and PDF presentations
- slide - (optional)instead of an entire slideshow, you can specify a slide index (0-based). the slide at the specified index will be rendered as a jpg image in the page.
- height - (optional)overrides the default height of the flash control or image.
- width - (optional)overrides the default width of the flash control or image.
|
{children}
{children:all=true}
{children:depth=x}
{children:depth=x|style=h3}
{children:excerpt=true}
{children:page=Another Page}
{children:page=/}
{children:page=SPACEKEY:}
{children:page=SPACEKEY:Page Title}
{children:first=x}
{children:sort=<mode>|reverse=<true or false>}
|
Displays the children and descendants of the current page. Specify 'all=true' to show all descendants of this page, or depth=x (where x is any number > 0) to show that many levels of descendants. The 'style' attribute can be any of 'h1' through 'h6'. If you specify a style, the top level of child pages will be displayed as headings of that level, with their children then displayed as lists below. A great way to throw together a quick contents page! You can view the children of a different page in the same space with {children:page=Another Page Title}. If you specify a page of '/', you will list all the pages in the space with no parent (i.e. the top-level pages), excluding the current page If you specify a page of 'FOO:' (the colon is required), you will list all the pages with no parent in the space with key "FOO". Specify 'excerpt=true' to also display the first line of the page's excerpt (see the excerpt macro) if it exists.
Example:
The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Specify 'creation' to sort by content creation date, 'title' to sort alphabetically on title and 'modified' to sort of last modification date. Use the reverse attribute to optionally reverse the sorting. The 'first' attribute allows you to restrict the number of children displayed at the top level.
|
{excerpt}Confluence is a knowledge-sharing application that enables teams to communicate more effectively{excerpt}
{excerpt:hidden=true}This excerpt will be recorded, but will not be displayed on the page.{excerpt}
|
Marks some part of the page as the page's 'excerpt'. This doesn't change the display of the page at all, but other macros (for example children, excerpt-include and blog-posts) can use this excerpt to summarise the page's content.
- hidden: If the value of "hidden" is true, then the contents of the excerpt macro will not appear on the page.
|
{excerpt-include:Home}
{excerpt-include:Home|nopanel=true}
{excerpt-include:blogPost=/2006/12/28/News Page}
|
Includes the excerpt from one page (see the excerpt macro) within another. The included page must be in the same space as the page on which the macro is used.
- nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.
|
{toc:style=disc|indent=20px}
{toc:outline=true|indent=0px|minLevel=2}
{toc:type=flat|separator=pipe|maxLevel=3}
|
Creates a Table of Contents for headings on the the current page.
- type - (optional) The type of output. May be one of the following:
- list - (default) The headings are output in hierarchical list format.
- flat - The headings are listed on a single line with a separator between them.
- class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
- style - (optional) The style of the list items if in list mode. The style may be any of the following:
- none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
- any CSS style - Headings are output in indented lists with the specified CSS style.
- outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
- ident - (optional) The amount to indent each list sub-heading by (default is '10px').
- separator - (optional) The type of separator to use if the style is flat. May be one of the following:
- bracket - Square brackets ('[', ']') surrounding each item. (default)
- brace - Square brackets ('[', ']') surrounding each item. (default)
- comma - A comma (',') between each item.
- paren - Parentheses ('(', ')') surrounding each item.
- pipe - A pipe ('|') between each item.
- newline - A line break after each item.
- "custom" - Any other character you wish, specified between quotes.
- minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
- maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
- include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
- exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
- printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
|
{toc-zone:separator\=brackets|location=top}
h1. First Heading
blah blah blah...
{toc-zone} |
Creates a Table of Contents for headings contained in the macro body.
- location - (optional) The location to have the table of contents output. May be 'top' or 'bottom'. If not set, it will be output at both locations.
- type - (optional) The type of output. May be one of the following:
- list - (default) The headings are output in hierarchical list format.
- flat - The headings are listed on a single line with a separator between them.
- class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
- style - (optional) The style of the list items if in list mode. The style may be any of the following:
- none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
- any CSS style - Headings are output in indented lists with the specified CSS style.
- outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
- ident - (optional) The amount to indent each list sub-heading by (default is '10px').
- separator - (optional) The type of separator to use if the style is flat. May be one of the following:
- bracket - Square brackets ('[', ']') surrounding each item. (default)
- brace - Square brackets ('[', ']') surrounding each item. (default)
- comma - A comma (',') between each item.
- paren - Parentheses ('(', ')') surrounding each item.
- pipe - A pipe ('|') between each item.
- newline - A line break after each item.
- "custom" - Any other character you wish, specified between quotes.
- minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
- maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
- include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
- exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
- printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
|
External Content
Ways to include, summarise or refer to content from other servers.
Misc
|
