Space Details - Jira – Atlassian

Space Details
Key:
CONF20
Name:
Confluence 2 User Guide
Description:
Creator (Creation Date):
User Guide for Confluence version 2
dave@atlassian.com (Jun 21, 2005)
Last Modifier (Mod. Date): rosie@atlassian.com (Jan 02, 2007)
Available Pages
•
Confluence 2 Home
•
•
•
Download the User Guide
Importing Content Into Confluence
•
Importing Pages from Disk
•
Site Backup and Restore
•
Space Backup and Restore
Working with Pages Overview
•
Commenting on a Page
•
Adding a Comment
•
Deleting Comments
•
Linking to Comments
•
Sample Page
•
child page
•
Viewing Comments
•
Concurrent Editing and Merging Changes
•
Concurrent Editing in Confluence 2.1
•
Copying a Page
•
Creating a New Page
•
Choose a Page
•
Deleting a page
•
Deleting an Attachment
•
Display an older version of a page
•
Editing an Existing Page
•
Linking pages
•
Making Rich Text or Wiki Markup Editing Default
•
Page Layout in Edit Mode (Rich Text)
•
Page Layout in Edit Mode (Wiki Markup)
•
Page Layout in View Mode
•
Purging Deleted Pages
•
Recording Change Comments
•
Restoring a Deleted Page
•
Viewing Page Information
Document generated by Confluence on Feb 08, 2007 14:05
Page 1
•
•
•
•
•
•
•
•
Viewing History of a Page
•
Comparing Two Different Versions of a Page
•
Restoring an Older Version of a Page
•
Viewing Recent changes
•
Working with Drafts Overview
•
Working with Drafts Faq
•
Writing Confluence pages
Working with Labels Overview
•
Adding a Global Label
•
Adding a Personal Label
•
Adding a Space Label
•
Adding a Team Label
•
Label Macros
•
Content by Label Macro
•
Navmap Macro
•
Recently Used Labels Macro
•
Related Labels Macro
•
Removing a Label
•
Viewing Global Labels
•
Viewing labelled pages
•
Viewing personal labels
•
Viewing Popular Labels
What's New in Confluence 2.0
•
What's New-Favourites
•
What's new-Labels
•
What's New-Rich Text Editor
•
What's new-RSS Feed Builder
Archiving Mail Overview
•
Adding a Mail Account
•
Deleting Mail
•
Fetching Mail
•
Importing Mail
•
Linking to Mail
•
Managing Mail Accounts
•
Restoring Mail
•
Viewing Mail
Displaying an Image
•
Image File Formats
Working with Favourites Overview
•
Adding Favourites
•
Removing Favourites
•
Viewing Favourites
Keyboard Shortcuts
Tracking Updates Overview
•
Managing Watches
Document generated by Confluence on Feb 08, 2007 14:05
Page 2
•
•
•
•
Subscribing to Daily Email Reports
Subscribing to RSS Feeds within Confluence
•
Using pre-specified RSS feeds
•
Using the RSS Feed Builder
•
Watching a Page
•
Watching a Space
•
Working with RSS Feeds
User Profile Overview
•
Changing Password
•
Editing User Preferences
•
Editing User Profile
•
Email Address Privacy
•
Linking to Personal Spaces and User Profiles
•
Updating Email Address
•
Uploading a Profile Picture
•
Viewing User Profile
Working with Macros
•
Blog Posts Macro
•
Children Display Macro
•
Child Page 1
•
Grandchild
•
Child Page 2
•
Code Block Macro
•
Create Space Button Macro
•
Dynamic Tasklist Macro
•
Excerpt Include Macro
•
Excerpt Macro
•
Favourite Pages Macro
•
Flowchart Macro
•
Gallery Macro
•
Global Reports Macro
•
IM Presence Macro
•
Include Page Macro
•
Sample Include Page
•
JIRA Issues Macro
•
JIRA Portlet Macro
•
JUnit Report Macro
•
Noformat Macro
•
Recently Updated Content Macro
•
RSS Feed Macro
•
Search Macro
•
Space Details Macro
•
Spacegraph Macro
•
Spaces List Macro
•
Thumbnail Macro
Document generated by Confluence on Feb 08, 2007 14:05
Page 3
•
•
•
•
•
•
•
Userlister Macro
•
Welcome Message macro
Searching Confluence
•
Confluence Search Fields
•
Confluence Search Syntax
•
Searching the People Directory
Working with Attachments Overview
•
Attaching Files to a Page
•
Attachment Versions
•
Displaying List of Attachments in a Page
•
Downloading Attachments
•
Editing Attachment Details
•
Embedding Multimedia Content
•
Embedding PowerPoint Presentations in a Page
•
Finding an Attachment
•
Linking to Attachments
•
Viewing Attachment Details
Working with Page Families
•
Breadcrumbs
•
Changing Parent of a Page
•
Creating a Child Page
•
Viewing a Page's Family
•
Viewing a Page's Location within a Space
•
Viewing Children of a Page
•
Viewing Hierarchy of Pages within a Space
•
What is a Page Family?
Dashboard
•
Customising the Dashboard
Exporting a Space
•
Confluence to HTML
•
Confluence to PDF
•
Create PDF in another language
•
Confluence to XML
•
Exporting to a Word document
Working with Links Overview
•
CamelCase linking
•
CamelCasePage
•
Changing the Title of a link
•
Release Notes
•
Linking an Image
•
Linking to Pages in Another Space
•
Linking to Pages Within the Same Space
•
Linking to Web Pages
•
Trackback
•
Working with Anchors
Document generated by Confluence on Feb 08, 2007 14:05
Page 4
•
•
•
•
•
•
•
•
Rich Text Editor Overview
•
Enabling Rich Text Editing
•
Rich Text-Creating a new link
•
Rich Text-Inserting an image
•
Rich Text-Inserting emoticons
•
Rich Text-Inserting Symbols
•
Rich Text-Linking to a Page
•
Rich Text-Linking to an Attachment
•
Rich Text-Linking to an Image
•
Rich Text-Working with Tables
•
Rich Text-Working with Text Effects
Security Overview
•
Page Level Permissioning
•
Setting Page Permissions
•
Viewing Page Permissions
•
Site Administrators and their permissions
•
Space Administrators and their permissions
•
Space Permissions Overview
•
Assigning Space Permissions
•
Revoking Space Permissions
•
Viewing Space Permissions
•
Users and Groups
•
Viewing Restricted Pages
Confluence Glossary
Customising Look and Feel
•
Applying Themes
•
Changing a Space's Logo
•
Customising Homepage
•
Editing a Space's Colour Scheme
•
Modify Confluence User Interface Text
•
Modifying Confluence Layouts Using Custom Decorators
Working with News Overview
•
Adding News
•
Editing News
•
Linking to News
•
Viewing News
Confluence Icons
Working with Templates Overview
•
Adding a Template
•
Creating a Page using a Template
•
Editing a template
•
Removing a Template
Working with Spaces Overview
•
Administering Spaces
•
Browsing a space
Document generated by Confluence on Feb 08, 2007 14:05
Page 5
•
•
•
Editing Space Details
•
Managing Orphaned Pages
•
Managing Undefined Pages
•
Tree View of Pages
•
Viewing Pages Alphabetically
•
Viewing Recently Updated Content
•
Viewing Space Details
•
Converting a Global Space to a Personal Space
•
Deleting a Space
•
Guidelines For Partitioning Content Into Spaces & Pages
•
Moving Content from one Space to Another
•
Moving a family of pages from one space to another
•
Moving a Page from one Space to Another
•
Moving an Attachment
•
Setting up a New Global Space
•
Setting up your Personal Space
•
Viewing all Spaces
•
Viewing Space Activity
Space Attachments Directory
Confluence Notation Guide Overview
•
Confluence Emoticons
•
Form Field Markup for Templates
•
Working with Headings
•
Working with Lists
•
Working with Tables
•
Working with Text Breaks
•
Working with Text Effects
Document generated by Confluence on Feb 08, 2007 14:05
Page 6
Confluence 2 Home
This page last changed on Jan 30, 2007 by noam@atlassian.com.
Confluence 2 User Guide
What's New in Confluence 2
Get Familiar with the Confluence Workspace
Working with Spaces
Working with Pages
Working with Attachments
Working with Images
Working with Links
Working with Labels
Working with News
Tracking Updates
Searching
Working with Favourites
Working with User Profiles
Customising Confluence
Working with Page Templates
Archiving Mail
Exporting and Importing
Security
Appendix A - Confluence Notation Guide
Appendix B - Rich Text Editor
Appendix C - Keyboard Shortcuts
Appendix D - Macros
Appendix E - Glossary
Download
You can download the Confluence User Guide in
PDF, HTML or XML formats.
About
The Confluence 2 User Guide provides an
overview of the key features of Confluence 2 and
explains both its basic and more advanced usage
as a knowledge management tool, and a
collaborative environment. If you still have a
question that hasn't been answered, write and tell
us about it.
For more documentation please visit [Confluence
2 Documentation Home].
Is your Confluence version older than 2.0? View
the Confluence 1.4 User Guide.
What's New in Confluence 2
Customisable Dashboard
Rich Text Editing
Labels
Favourites
RSS Feed Builder
Get Familiar with the Confluence Workspace
The Dashboard
Customising the Dashboard
Document generated by Confluence on Feb 08, 2007 14:05
Page 7
Page Layout in View Mode
Page Layout in Edit Mode (Wiki Markup)
Page Layout in Edit Mode (Rich Text)
Confluence Icons
Working with Spaces
Working with Spaces Overview
Setting up a New Global Space
Setting up your Personal Space
NEW in 2.2!
Viewing all Spaces
Viewing Space Details
Editing Space Details
Browsing a Space
Viewing Space Activity NEW in 2.3!
Moving Content from one Space to Another
Deleting a Space
Converting a Global Space to a Personal Space
Administering Spaces
Working with Pages
Working with Pages Overview
Creating a New Page
Writing Confluence pages
Editing an Existing Page
Concurrent Editing and Merging Changes
Concurrent Editing in Confluence 2.1
Working with Drafts Overview
NEW in 2.1!
Working with Drafts FAQ
NEW in 2.1!
Copying a Page
Deleting a Page
Moving a Page
Restoring a Deleted Page
Purging Deleted Pages
Commenting on a Page
Attaching Files to a Page
Working with Page Families
Linking Pages
Recording Change Comments
Viewing History of a Page
Viewing Page Information
Page Level Permissioning
Working with Attachments
Working with Attachments Overview
Attaching Files to a Page
Linking to Attachments
Document generated by Confluence on Feb 08, 2007 14:05
Page 8
Finding an Attachment
Viewing Attachment Details
Editing Attachment Details
Downloading Attachments
Deleting an Attachment
Displaying List of Attachments in a Page
Embedding Multimedia Content
Working with Images
Displaying an Image
Rich Text-Inserting an Image
Image File Formats
Thumbnail Macro
Gallery Macro
Working with Links
Working with Links Overview
Linking to Pages within the Same Space
Linking to Pages in Another Space
Linking to Web Pages
Changing the Title of a Link
Linking an Image
Linking to Comments
Linking to News
Linking to Personal Spaces and User Profiles
Linking to Mail
Linking to Attachments
Working with Anchors
CamelCase Linking
Trackback
Working with Labels
Working with Labels Overview
Adding a Global Label
Adding a Personal Label
Adding a Space Label
Adding a Team Label
Viewing Labelled Pages
Viewing Global Labels
Viewing Personal Labels
Viewing Popular Labels
Removing a Label
Label Macros
Working with News
Document generated by Confluence on Feb 08, 2007 14:05
Page 9
Working with News Overview
Viewing News
Adding News
Editing News
Linking to News
Tracking Updates
Tracking Updates Overview
Watching a Page
Watching a Space
Subscribing to Daily Email Reports
Managing Watches
Working with RSS Feeds
Subscribing to RSS Feeds within Confluence
Using the RSS Feed Builder
Using pre-specified RSS feeds
Subscribing to External RSS feeds
Searching
Searching Confluence
Searching the People Directory
NEW in 2.3!
Confluence Search Syntax
Confluence Search Fields
Working with Favourites
Working with Favourites Overview
Adding Favourites
Viewing Favourites
Adding a Personal Label
Removing Favourites
Working with User Profiles
User Profile Overview
Editing User Profile
Uploading a Profile Picture
NEW in 2.3!
Updating Email Address
Changing Password
Email Address Privacy
Editing User Preferences
Linking to Personal Spaces and User Profiles
Setting up your Personal Space
NEW in 2.2!
Document generated by Confluence on Feb 08, 2007 14:05
Page 10
Customising Confluence
Customising Homepage
Customising Look and Feel
Applying Themes
Modifying Confluence Layouts Using Custom Decorators
Editing a Space's Colour Scheme
Changing a Space's Logo
Working with Page Templates
Working with Templates Overview
Adding a Template
Form Field Markup for Templates
Creating a Page using a Template
Editing a Template
Removing a Template
Archiving Mail
Archiving Mail Overview
Adding a Mail Account
Managing Mail Accounts
Importing Mail
Viewing Mail
Fetching Mail
Deleting Mail
Restoring Mail
Linking to Mail
Exporting and Importing
Space Backup and Restore
Site Backup and Restore
Confluence to HTML
Confluence to PDF
Confluence to PDF in another language
Confluence to XML
Confluence to Word
Importing Content Into Confluence
Security
Security Overview
Users and Groups
Site Administrators and their permissions
Space Administrators and their permissions
Document generated by Confluence on Feb 08, 2007 14:05
Page 11
Space Permissions Overview
Viewing Space Permissions
Assigning Space Permissions
Page Permissions
Appendix A - Confluence Notation Guide
Confluence Notation Guide overview
Working with Headings
Working with Text Effects
Working with Text Breaks
Working with Links
Working with Anchors
Working with Images
Working with Lists
Working with Tables
Working with Macros
Working with Attachments
Appendix B - Rich Text Editor
Rich Text Editor Overview
Enabling Rich Text Editing
Making Rich Text or Wiki Markup Editing Default
Rich Text-Working with Text Effects
Rich Text-Working with Tables
Rich Text-Inserting an Image
Rich Text-Creating a New Link
Rich Text-Linking to an Image
Rich Text-Linking to an Attachment
Rich Text-Linking to a Page
Rich Text-Inserting Emoticons
Rich Text-Inserting Symbols
Appendix C - Keyboard Shortcuts
Keyboard Shortcuts
Appendix D - Macros
Macros
Appendix E - Glossary
Confluence Glossary
Document generated by Confluence on Feb 08, 2007 14:05
Page 12
.
Comments
I'm looking for information about *Panels* and how to create the symbols/colors for Information Panels,
Warning Panels, etc. which can be found in this space.
Posted by jtneill at Nov 21, 2006.
.....................................................................................................................................................................
Add under "Working with pages" a link to "How to Rename Pages". This information is very difficult to
find otherwise.
The method: Click edit. When you click edit for a page, the title of the page is displayed in a box just
above the rich text or wiki markup window. The title within that box is actually editable. Editing the title
of the page renames it, and fixes all the links that point to it to go to the newly renamed page.
• You should also link from
http://confluence.atlassian.com/display/CONF20/Editing+an+Existing+Page to the details on
how to rename.
• Some small text in the UI of the edit page "Edit here to rename this page" would be a helpful hint.
Posted by garnetr at Dec 07, 2006.
.....................................................................................................................................................................
It appears that the {nomarkup} user macro has been removed from the documentation wiki. This means
that all of the examples that show what you should type instead say "unknown macro {nomarkup}"
Posted by jdibble at Dec 29, 2006.
.....................................................................................................................................................................
thank you, this has been fixed.
Posted by rosie@atlassian.com at Jan 18, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 13
Download the User Guide
This page last changed on Feb 05, 2007 by ivan@atlassian.com.
There are now two separate Confluence 2.0 User Guide XML exports available for download.
• For users who use the newest Confluence release version 2.3
2.3-CONF20-20070115-15_42_50.zip
• For users who use versions of Confluence released prior to 2.3, such as 2.2.10 or 2.2.9, so
forth.
prior-2.3-CONF20-20070116-09_28_43.zip
Download
Name
Size
Creator
Date
2.3-CONF20-20070115-15_42_50.zip
61.82 Mb
ivan@atlassian.com
Jan 15, 2007
CONF20-20060614-00_07_00.pdf
2.14 Mb
cmiller
Jun 15, 2006
prior-2.3-CONF20-20070116-09_28_43.zip
21.20 Mb
ivan@atlassian.com
Jan 15, 2007
CONF20-20060614-00_29_10.zip
7.75 Mb
cmiller
Document generated by Confluence on Feb 08, 2007 14:05
Jun 15, 2006
Comment
Confluence 2.0 Edit |
User Guide
Remove
(XML Zip) Confluence 2.3
Confluence 2.0 Edit |
User Guide
Remove
(PDF)
generated
14-June-06
Confluence 2.0 Edit |
User Guide
Remove
(XML Zip) prior
Confluence 2.3
Confluence 2.0 Edit |
User Guide
Remove
(HTML Zip)
generated
14-June-06
Page 14
Importing Content Into Confluence
This page last changed on Oct 08, 2006 by bob.swift@charter.net .
Confluence stores all page data in Confluence's wiki markup syntax. Importing non-wiki markup into
Confluence requires a conversion process.
• Text with basic formatting can be pasted directly into the Rich Text Editor. This includes simple
Word documents or web pages.
• Import document files such as Microsoft Word and Excel, or content from other wikis, use a
[Content Converter]
• Pages already in wiki markup can be Imported From Disk
For web content:
• Convert a HTML file to a Confluence page using the [HTML To Confluence Converter]
• Embed an external web page into Confluence with the [Html-include Macro]
• Use HTML code in a page with the [HTML Macro]
Document generated by Confluence on Feb 08, 2007 14:05
Page 15
Importing Pages from Disk
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to import text files from a disk or a directory on the Confluence server, and
convert them into corresponding Confluence pages. Each file will be imported as a Confluence page with
the same name as the file.
The text file needs to contain Confluence markup to be converted accurately into a Confluence
page.
You need to be a space administrator to import text files.
To import text files,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on the 'Import pages from disk' link in the left panel under the heading 'Import'. This will
display a new screen.
4. Type in the directory's path in the 'Import directory' text field.
5. Check 'Trim file extensions' to remove file extensions when converting the files to Confluence
pages. Note that the Confluence pages will take their titles from the files' names (including their
extensions). So to avoid having page titles with the suffix 'txt' in them, make sure you check this
box.
6. Check 'Overwrite existing pages' if you want to replace existing Confluence pages with the same
page title.
7. Click 'Import'.
Screenshot : Importing text files
The ability to import pages from disk applies only to global spaces, so the 'Import' section in the
above screenshot does not appear in the 'Space Admin' tab for personal spaces. Please see
Working with Spaces Overview for information about the differences between global spaces and
personal spaces.
Document generated by Confluence on Feb 08, 2007 14:05
Page 16
RELATED TOPICS
Take me back to Confluence 2 Home
Comments
What kind of encoding shall the filename and the text have? I am about to import som swedish texts (å,
ä, ö, Å, Ä, Ö)
/John, Sweden
Posted by di99pejo at Oct 20, 2006.
.....................................................................................................................................................................
Currently, this method uses the default system encoding of Java, which is determined automatically from
your system. This means it should work with whatever encoding is native for files on your operating
system.
I'd suggest importing one or two files first as a test, and if there is a problem with the encoding, let us
know and we can add a configuration option to Confluence to change it.
Posted by mryall at Oct 23, 2006.
.....................................................................................................................................................................
There is now a JIRA issue for [this enhancement], with two possible workarounds.
Posted by mryall at Oct 30, 2006.
.....................................................................................................................................................................
Hi there, I'm wondering whether space admins could markup the text to include labels and hierachial data
as well? It's a really nifty import plugin if you've got a small number of pages, but I've got a heap and
I'm wondering how they can go in labelled and all.
Posted by daletan at Jan 03, 2007.
.....................................................................................................................................................................
Is there a way to import attachments using this feature? How about linking children pages to parent
pages?
I wish to use it for bulk loading but may of the pages will have children and attachments.
Posted by rickshaw at Jan 19, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 17
Site Backup and Restore
This page last changed on Dec 27, 2006 by david.soul@atlassian.com.
By default, Confluence backs up all data and attachments once a day to a backup file. These files are
called XML site backups, stored in the backups directory of Confluence home. You can also create XML
site backups manually.
•
•
•
•
[Restore your site from an XML site backup]
[Manually create an XML site backup]
[Configure Daily Backups]
[User Submitted Backup & Restore Scripts]
XML site backups are fine for most instances of Confluence. However, large instances of Confluence will
find backups may become slow to create and use large amounts of disk space.
Backups For Large Instances
XML site backups are unsuitable for instances of Confluence that contain hundreds of large pages, as XML
backups take progressively longer to complete as the amount of text increases. Another issue with XML
site backups is that Confluence instances with a gigabytes of attachments will consume disk space
rapidly. This is because each site backup contains all content needed for a site restore. For example, if a
1 gig instance of Confluence is backed up daily, it will create 30 gig of backups per month if left
unattended. When administering a large instance, you can reduce disk space by setting XML site backups
to exclude attachments, then manually scheduling a backup of your attachments from the Confluence
home directory or database. The backup manager can save space by saving changed files instead of all
content.
Creation Delay
Disk Usage
Recommended Backup
Method
Acceptible
Acceptible
XML site backup with
attachments
Acceptible
Unacceptible
XML site backup minus
attachments, plus manual
backup of attachments
Unacceptible
Unacceptible
Manual backup of database and
attachments
Creation Delay is the time it takes to create an XML site backup minus attachments.
Disk Usage can be estimated by multiplying the frequency of your XML site backups by their current
size.
Manual Backups
Confluence's [attachment storage configuration] can be set to store attachments in the Confluence home
directory, or in the database.
Document generated by Confluence on Feb 08, 2007 14:05
Page 18
Database Backup
Use your Database Administration Tool to create a backup of your Confluence database. if your database
is storing your attachments, importing this later will restore all content.
Attachment Backup
If stored on the filesystem, attachments are placed under the attachments directory of your Confluence
home directory. Copy this directory to create a backup of all attachments.
Backup FAQ
Unable to render {include} Couldn't find a space with key: DOC
Document generated by Confluence on Feb 08, 2007 14:05
Page 19
Space Backup and Restore
This page last changed on Feb 26, 2006 by dave@atlassian.com.
Confluence can backup all the content, comments and attachments for a space. The process involves
converting the data in the space into XML format. The end product is a zip file that contains XML file(s)
and optionally, all the attachments in the space. To transfer this data to another Confluence site, you
simply restore this zip file.
Creating a Space Backup
Instructions on how to create a backup for a space can be found here.
Restoring/Importing a Space Backup
Instructions on how to restore or import the backup of a space can be found [here].
Document generated by Confluence on Feb 08, 2007 14:05
Page 20
Working with Pages Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Pages are the primary means of storing and sharing information in Confluence. Pages are the building
blocks of spaces.
Pages in Confluence are:
•
•
•
•
•
•
•
•
•
•
created easily from anywhere within the site.
written in a simple markup language, or using the Rich Text editor.
organised hierarchically via parent-child relationships between pages.
navigated through flexible linking within and between spaces.
collaborated on via threaded or flat comments.
controlled through page level security permissioning.
tracked through page notifications.
maintained through a recording of page history, and you can link to older versions.
entirely searchable(including attachments).
exported to PDF, WORD, HTML or XML.
RELATED PAGES
Creating a New Page
Confluence Notation Guide Overview
Working with page families
Working with Drafts
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 21
Commenting on a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
A comment is a remark, question, or any other additional information you wish to add to a page
pertaining to the topic the page covers.
Comments are a means by which a community of users can interact with each other on the site.
You can leave a comment on any page or news item in Confluence.
What would you like to do?
View Comments
Add Comments
Link to Comments
Delete Comments
RELATED TOPICS
Working with Pages Overview
Take me back to Confluence 2 Home
Comments
Can you edit comments that you've made?
Posted by charlieperry@hotmail.co.uk at Jan 14, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 22
Adding a Comment
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can leave a comment on any page or news item in Confluence.
To add a comment, you require 'Create Comments' permission which is assigned by a space administrator
from the Space Administration screens. See Space permissions or contact a space administrator for more
information.
You can either add a new comment or respond to a previous comment (only available in 'threaded' view).
Use Confluence markup or the Rich Text editor to write the comment.
Adding a new comment
• If your page is in 'Show' comments view, look for the comments box at the bottom of the page.
Type in your text and click ' Post' when you are done.
• If your page is in 'Hide' comments view, look for the link to 'Add Comment' at the bottom of the
page.
Click on this link to open up the comments box. Type in your text and click ' Post'.
Screenshot : Comments box
Responding to a comment
This option is only available when the comments are in 'threaded' view.
• Click on the 'Reply to this' link located below the text of a comment.
This will open up a new comments box. Type in your text and click ' Post'.
Screenshot : Example comment
Document generated by Confluence on Feb 08, 2007 14:05
Page 23
RELATED TOPICS
Viewing Comments
Linking to Comments
Deleting Comments
Take me back to Confluence 2 Home
Comments
It's so simple to add a new comment. Give it a try.
Posted by vidya at Aug 24, 2005.
.....................................................................................................................................................................
Is there any way we can apply a template to the comment field? I'm thinking of using a comment box in
the format of a form, but I am not exactly sure if this is possible.
Posted by wayne.cheng@sap.com at Jul 14, 2006.
.....................................................................................................................................................................
When someone adds a comment to a page....is the "watch this page" automatically turned on for that
user? I thought they would only receive a notice when someone replies to the comment....not when the
page is updated.
Posted by kenswank at Jul 31, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 24
Deleting Comments
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To delete a comment from a page, you require 'Remove Comments' permission which is assigned by a
space administrator from the Space Administration screens. See Space permissions or contact a space
administrator for more information.
Currently, it is not possible to delete all comments for a page simultaneously.
To delete a comment,
1. Go to the page that contains the comment.
2. Click on the 'Remove' link located at the bottom of the comments box. This is only displayed if you
have permission to remove comments for this page.
Warning
Deleted comments cannot be restored.
RELATED TOPICS
Viewing Comments
Adding a Comment
Linking to Comments
Take me back to Confluence 2 Home
Comments
what happens to a deleted comment?
is it removed completely from the system or kept and just not made accessible throught the page
anymore?
can you restore deleted comments as is the case with pages?
what happens to links (internal and permanent) pointing to a deleted comment?
Posted by tmenzel at Apr 10, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 25
Linking to Comments
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to create a link to a comment.
To link to a comment from within Confluence,
1. Click on 'Permalink' located below the text of the comment within the comments box.
You will notice in the address bar of your browser that the url displayed ends in a series of
numerals.
2. Copy only the numerals.
3. Click on the 'edit' tab of the page from which you want to link to the comment.
4. Paste the numerals between square brackets (as you would when you create any link in
Confluence), and then include the dollar sign '$' in front of the numerals.
Example
What you need to type
[$129613]
What you will get
[$129613]
Because you are linking to the actual database ID of the comment, you do not need to specify a
space or a page id explicitly as that's calculated automatically from the database ID.
For example link to a [comment in differnet space] .
To link to a comment from outside Confluence,
1. Right click on 'Permalink' located below the text of the comment within the comments box.
2. Copy the link location of the comment. Alternately, click on 'Permalink' and copy the url displayed
in the address bar of your browser.
3. Use this url to link to the comment from your web page.
Screenshot : Permalink location
Screenshot : Permalink url
Document generated by Confluence on Feb 08, 2007 14:05
Page 26
RELATED TOPICS
Commenting on a Page
Adding a Comment
Working with Links
Take me back to Confluence 2 Home
Comments
The word 'different' is spelt incorrectly in the line following the note on this page.
Posted by slieschke at Nov 22, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 27
Sample Page
This page last changed on Nov 22, 2005 by vidya.
Start of sample page content
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras
rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada
massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat
eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac
magna. Suspendisse euismod libero eget mauris.
End of sample page content
Comments
I don't understand latin!
Posted by vidya at Sep 01, 2005.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 28
child page
This page last changed on Sep 25, 2005 by vidya.
Document generated by Confluence on Feb 08, 2007 14:05
Page 29
Viewing Comments
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Comments in Confluence are displayed in one of two views which is configured globally by a site
administrator:
• Threaded - this view shows the comments in a hierarchy of responses. Each subsequent reply to a
comment is indented to indicate the relationships between the comments. See screenshot 1.
• Flat - this view displays all the comments in one single list and does not indicate the relationships
between comments.
Confluence also allows you to 'show' or 'hide' comments on a page.
• Show
° the page's comments are visible below its contents when you view the page.
° a comments box at the bottom of the page allows you to post a new comment.
• Hide
° the page's comments are hidden when you view the page. A link at the bottom of the page
tells you if the page has comments. Clicking this link will display the comments. See
screenshot 2.
° to post a new comment, click on 'Add a new comment'.
Screenshot: Threaded View
Screenshot: Hide View
Note
Confluence defaults the view to 'Show' or 'Hide' comments based on what your preference was on
your last visit to the site.
RELATED TOPICS
Document generated by Confluence on Feb 08, 2007 14:05
Page 30
Commenting on a Page
Adding a Comment
Linking to Comments
Deleting Comments
Take me back to Confluence 2 Home
Comments
I'm working with an evaluation of confluence and I can't figure out how to enable the commenting feature
on pages. Did we somehow disable it? Could it be a permission problem? There aren't any pages in the
demonstration space that have comments I can see...
Posted by derek at Jan 03, 2006.
.....................................................................................................................................................................
Derek,
Permission to comment in a space is assigned by a space administrator from the space administration
screens. This page shows you how to do this.
Thanks,
Vidya
Posted by vidya at Jan 03, 2006.
.....................................................................................................................................................................
We had an error in our page template that took the comment section out! Thanks for the quick response
and pointers though!
/Derek
Posted by derek at Jan 04, 2006.
.....................................................................................................................................................................
Is there any possibility to show all comments from a space on one page? (An overview of all space
comments) It's too difficult to browse over all sites to look for new comments. They will be buried in
oblivion.
Thanks,
Nils
Posted by bacher at Aug 22, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 31
Concurrent Editing and Merging Changes
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Sometimes, two or more people may edit a page at the same time. When this happens, Confluence will
do its best to ensure that nobody's changes are lost.
For example, Alice and Bob both edit the same page at the same time.
If Alice clicks save before Bob, Bob is now effectively editing an out-of-date version of the page. When
Bob clicks save, Confluence will examine his changes to see if any overlap with Alice's. If the changes do
not overlap (i.e. Alice and Bob edited different parts of the page), Bob's changes will be merged with
Alice's automatically.
If Bob's changes overlap with Alice's, Confluence will display an error message to Bob showing where
Alice has changed the page, and giving Bob the options to overwrite Alice's changes with his own, to
re-edit the document to incorporate Alice's work, or to cancel his own changes entirely.
RELATED TOPICS
Viewing History of a Page
Viewing Page Information
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 32
Concurrent Editing in Confluence 2.1
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Concurrent editing is made easier in Confluence 2.1.
How will I know if someone else is editing the same page as I am?
If another user is editing the same page as you, Confluence will display a message above your edit
screen letting you know who the other user is and when the last edit was made.
What happens if two of us are editing the same page and the other user saves before I do?
If someone else has saved the page before you, when you click 'Save', Confluence will check if there are
any conflicts between your changes and theirs. If there are no conflicting changes, Confluence will merge
both the edits successfully. If there are any conflicts, Confluence will display them for you and give you
the option to either 'Overwrite' the other user's changes, 'Merge your changes' manually, or 'Discard'
them.
RELATED TOPICS
Working with Drafts Overview
Working with Drafts FAQ
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 33
Copying a Page
This page last changed on Jan 22, 2007 by rosie@atlassian.com.
Copying a page duplicates the page.
To copy a page,
1. Click on the 'Info' tab of the page.
2. In the first box displayed, click 'Copy' beside 'Operations'. This will open up a copy of the page in
edit mode. By default, Confluence will name the page as 'Copy of Pagename'.
3. Rename the page and make any other changes required.
4. If you need to move the new page to a different space or a different parent, click the 'EDIT' link (to
the right of 'Location', just below the page's name), then select the new space and/or parent.
5. Click 'Save'.
Note
Copying a page will duplicate all of the original page's attachments, but will not copy comments or
labels from the original page.
RELATED TOPICS
Working with Pages Overview
Take me back to Confluence 2 Home
Comments
I failed to copy a page from one space to another. The error message I got was that the page already
existed in the source space (I used the same page name).
Is there a way to easily copy a page (preserving the page name) from one space to another?
thanks a lot!
Document generated by Confluence on Feb 08, 2007 14:05
Page 34
Marianne
Posted by marianne.vanhauwaert@persgroep.be at May 12, 2006.
.....................................................................................................................................................................
Need to be able to copy all pages under a page
Posted by rschwarz at Aug 03, 2006.
.....................................................................................................................................................................
1000% agree.
This is cruicial for orgznizing wide, well structured nodes.
Simple example: we are creating a node for each project. Each project node has many subnodes. So I
wish to have some TEMPLATES space with preconfigured kind of different *structures*.
Any ideas ?
Posted by pkasperskyi at Oct 19, 2006.
.....................................................................................................................................................................
I understand from CSP-6645 that to make a copy of a page you need to have create page privileges for
the source space as well as the destination space. I suggest this is stated in the documentation above.
However, it seems a strange requirement to me. Why should create page privileges for the source space
be required?
David
Posted by davida at Jan 19, 2007.
.....................................................................................................................................................................
Have added this information -- thank you for the suggestion.
Posted by rosie@atlassian.com at Jan 22, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 35
Creating a New Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Creating a page in Confluence is easy. You can create a page from anywhere within the site by clicking
the 'Add Page' link located at the top of every page and beside the space link on the dashboard.
To create a page, you require 'Create Pages' permission which is assigned by a space administrator from
the Space Administration screens. See Space permissions or contact a space administrator for more
information.
Need help writing pages?
There are two ways to add a new page:
1. Click on the 'Add Page'
link located beside each space on the dashboard and at the top of
every page.
This link is only displayed if you have permission to create pages for the space. If you do not see this
link, you probably do not have permission to add pages and should contact your space administrator.
1.
2.
3.
4.
5.
Click on the 'Add Page' link. This will bring up a new screen.
Enter a 'Title' for your page.
Click 'Edit beside 'Location' to change the location of the page.
From the drop-down menu displayed, select the 'Space' where you want your page to be located.
In the 'Parent Page' input field, specify a parent, if needed. If you want to move the page to the
root directory of a space, leave this field blank.
If you clicked on 'Add page' from another page, Confluence will default the new page as a child
of the first. To choose a different parent, click on the Choose a page
icon. A pop-up screen allows
you select a parent page from one of the tabs displayed or to locate pages anywhere within the site
using the search facility.
6. Enter content for your page using Confluence Notation, or the Rich Text editor. See Writing
Confluence pages.
7. 'Preview' if desired. Click 'Add'.
2. Follow an undefined link
In Confluence, you can create links to pages that you intend to create at a later point. This type of a link
is an undefined link and is indicated with a plus sign. Clicking on the link brings up the 'Add Page' screen.
Follow the same steps outlined above to create the page.
Here is an example of an undefined link:
What you need to type
[Link to new page]
Document generated by Confluence on Feb 08, 2007 14:05
What you will get
Link to new page
Page 36
Screenshot : Adding a page
Click on the thumbnail to see the larger image:
Handy Hint
In Confluence, the title of a page is used to create page links.
Note
Confluence does not accept the following characters in the title of the page:
:, @, /, %, \, &, !, |, #, $, *, ;, ~, [, ], (, ), {, }, <, >, .
RELATED TOPICS
Writing Confluence Pages
Confluence Notation Guide Overview
Editing an Existing Page
Working with Page Families
Linking Pages
Page Level Permissioning
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 37
Choose a Page
This page last changed on Nov 28, 2005 by vidya.
Use the 'Choose a Page' option when you want to locate a page in the site to set as a parent page.
To choose a page,
1. Go to the page and click on the 'Edit' tab.
2. Click this icon
to bring up a pop-up screen displaying the following tabs:
• History : Displays a list of pages recently visited by you.
• Recently Modified : Displays pages most recently modified by you.
• Referring Pages : Displays a list of all pages that refer to the current page.
3. Select the desired parent page from the list of pages in one of the tabs.
Note
You cannot create a new page using this option.
RELATED TOPICS
Moving Content from one Space to Another
Working with Page Families
Document generated by Confluence on Feb 08, 2007 14:05
Page 38
Deleting a page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To delete a page, you require 'Remove Pages' permission which is assigned by a space administrator from
the Space Administration screens. See Space Permissions or contact a space administrator for more
information.
To delete a page,
1. Go to the page and click on the 'Edit' tab.
2. Click on the 'Remove' link located at the top of the page. This is only displayed if you have
permission to remove this page.
Handy Hint
Deleted pages are stored in the trash and can be recovered by a space administrator.
RELATED TOPICS
Restoring a Deleted Page
Purging Deleted Pages
Creating a New Page
Editing an existing page
Take me back to Confluence 2 Home
Comments
Having just had to delete multiple pages one by one it would be nice if Confluence made this easier.
Posted by euan.semple@gmail.com at May 19, 2006.
.....................................................................................................................................................................
On our Version: 2.1.5a Build:#411 the link is a "trash can" icon, not a "remove" link.
Posted by cwjordan at Jul 05, 2006.
.....................................................................................................................................................................
Is there any other way for an admin to delete a page. I'm having trouble with the markup on a page
that's making my browser hang, so I can't even get into Edit mode to delete the page. --/carlos
Posted by carlosp at Jul 29, 2006.
.....................................................................................................................................................................
Yes, delete multiple pages would be very useful!
Maybe the "Browse Space" location could be suitable for such a function.
Document generated by Confluence on Feb 08, 2007 14:05
Page 39
Posted by loetterle at Sep 13, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 40
Deleting an Attachment
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To delete an attachment, you require 'Remove Attachments' permission which is assigned by a space
administrator from the Space Administration screens. See Space permissions or contact a space
administrator for more information.
To delete an attachment,
1. Go to the page that contains the attachment.
2. Click on the 'Attachments Tab'. This will display a list of the attachments in the page. Click on the
'Remove' link beside the attachment you want to delete.
3. Click 'OK' to confirm your action.
RELATED TOPICS
Working with Attachments
Finding an Attachment
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 41
Display an older version of a page
This page last changed on Jul 10, 2006 by david.soul@atlassian.com.
To point users to an outdated version of a page:
1. View the page and click the "view change" link displayed after the "last edited by" information.
2. In the box on the left-hand side of the "compared to", click on the "Version ## by Username" to
show the full outdated version.
3. Click "<< View previous version" to scroll back through the outdated versions until you find the one
you would like to link, and copy the URL from your address bar. This link is of the format
http://confluence.atlassian.com/pages/viewpage.action?pageId=12345
These links inform the users that what they are viewing is out of date and provide a link to the current
edition.
Document generated by Confluence on Feb 08, 2007 14:05
Page 42
Editing an Existing Page
This page last changed on Jan 04, 2007 by rosie@atlassian.com.
To edit an existing page, you require 'Edit Pages' permission which is assigned by a space administrator
from the Space Administration screens. See Space permissions or contact a space administrator for more
information.
To edit an existing page,
1. Go to the page and click on the 'Edit' tab. This is only displayed if you have permission to edit the
page. This will bring up the edit screen in either the Wiki Markup or the Rich Text mode, whichever
is your current default.
2. Makes changes to the content or add new content as you would when you create a new page. Click
on the tabs to switch between 'Rich Text' and 'Wiki Markup' edit modes. You can also use a
combination of the two editors; Confluence retains changes made in one mode when you switch to
the other.
3. Click 'Preview' to view your changes. Click 'Save'.
Click thumbnail to see a Confluence page in
Wiki Markup mode of editing
Click thumbnail to see a Confluence page in
Rich Text mode of editing
To view changes between different versions of the page, view the history of the page.
NOTE
While the Rich Text editor includes almost all formatting options possible with Wiki markup, you
will still need to use wiki markup for more complex functions like macros.
RELATED TOPICS
Creating a New Page
Deleting a Page
Adding a Comment
Linking Pages
Document generated by Confluence on Feb 08, 2007 14:05
Page 43
Working with Pages Overview
Working with Drafts
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 44
Linking pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
What would you like to do?
Link to a page within a space
Link to a page in another space
Link to a webpage
RELATED TOPICS
Working with links
Working with pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 45
Making Rich Text or Wiki Markup Editing Default
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can default to either 'Rich Text' or 'Wiki Markup' modes of editing depending on your preference.
To default to Rich Text or Wiki markup modes of editing,
1. Go to the edit tab of the page. This will open up the page in your current default mode.
2. If the current edit mode is not your default, you can make it your default by clicking the 'Make
Default' link beside the tabs.
RELATED TOPICS
Rich Text Editor Overview
Take me back to Confluence 2 Home
Comments
Is it possible to hide the "wiki markup" tab in the edit mode?
It might be useful to avoid confusion to the enduser.
Posted by loetterle at Sep 07, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 46
Page Layout in Edit Mode (Rich Text)
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Here's what the Confluence edit page looks like Rich Text mode:
Note
The options available to you in the 'Edit' mode of a page depend on the permissions granted to
you by the space administrator.
Document generated by Confluence on Feb 08, 2007 14:05
Page 47
RELATED TOPICS
Page Layout in View Mode
Dashboard
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 48
Page Layout in Edit Mode (Wiki Markup)
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Here's what the Confluence edit page looks like in Wiki Markup mode:
Note
The options available to you in the 'Edit' mode of a page depend on the permissions granted to
you by the space administrator.
RELATED TOPICS
Page Layout in View Mode
Dashboard
Document generated by Confluence on Feb 08, 2007 14:05
Page 49
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 50
Page Layout in View Mode
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Here's what a typical Confluence 2.0 page looks like in 'view' mode:
Note
Note that in Confluence, your view of a space depends on the permissions granted to you by the
space administrator.
RELATED TOPICS
Page Layout in Edit Mode (Wiki Markup)
Dashboard
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 51
Purging Deleted Pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Purging deleted pages permanently clears them from 'Trash'.
You need to be a space administrator to purge deleted pages for a space.
To purge deleted pages,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on 'Trash' from the left panel. A list of deleted pages and emails for the space is displayed.
4. Click on the 'Purge' link beside a page or else click on 'Purge all' to permanently clear all deleted
pages and emails.
RELATED TOPICS
Deleting a Page
Restoring a Deleted page
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 52
Recording Change Comments
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
A change comment is a short description that details the changes made to a page during an edit. Change
comments are a useful way of keeping track of the history of a page.
The change comments input-field is located below the edit screen:
Once a comment has been added, it becomes visible in the view mode of the page, so that users are
aware of the most recent changes made to a page. If a comment has been recorded, you will see a link
to 'Show Comment' below the page title. Click on the link to view the comment.
The change comments for a page are recorded under the 'History' of a page.
RELATED TOPICS
Viewing history of a page
Document generated by Confluence on Feb 08, 2007 14:05
Page 53
Take me back to Confluence 2 Home
Comments
I'm not sure it's exactly relevant here, but I can't figure out how to remove a change comment once it's
been added? I see how way to delete regular comments, just not the change comments.
It would be helpful if this page explained how to delete them or stated that deleting isn't possible.
Thanks,
Stew
Posted by stews at Mar 22, 2006.
.....................................................................................................................................................................
111111
Posted by xc at Apr 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 54
Restoring a Deleted Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
When you restore a page, you are retrieving it from 'Trash' to the same location in the space where it
existed before it was deleted.
You need to be a space administrator to restore deleted pages.
To restore a deleted page,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on 'Trash' from the left panel. A list of deleted pages and emails for the space is displayed.
4. Click on the 'Restore' link beside the page you want to restore.
Handy Hint
If a new page has already been created in that space with the same name as the deleted page,
you will be given an option to rename the page before it is restored.
RELATED TOPICS
Deleting a Page
Purging Deleted Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 55
Viewing Page Information
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The 'Info' tab of a page is your window to page level information. It displays:
1.
2.
3.
4.
Page Details: Title, author, date of creation, date of last modification and the tiny link of the page.
Page Hierarchy: Parent-child relationships of the page.
Page Permissions: Whether there are any page-level security restrictions that apply to the page.
Recent Changes: Links to the five most recent versions of the page along with the name of the
editor and the date of modification.
5. View History: All the versions of the page in reverse chronological order, with an option to compare
versions or to restore a previous version.
RELATED TOPICS
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 56
Viewing History of a Page
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
Confluence tracks histories of changes to pages by maintaining a version of the page each time it is
modified. It is easy to view changes between different versions and to restore a previous version if
required.
What would you like to do?
View recent changes
View change comments
Compare two different versions of a page
Restore an older version of a page
RELATED TOPICS
Viewing Page Information
Working with Pages
Tracking Updates
Take me back to Confluence 2 Home
Comments
If someone deletes a page, is there an audit trail? I was expecting something like a space history which
will capture which page was deleted, when and by whom?
Posted by bagheera at Mar 20, 2006.
.....................................................................................................................................................................
When I add or remove a comment on a page why doesn't this get versioned? We would really like to have
this functionality...is this possible with Confluence?
Posted by btknorr@gmail.com at Apr 06, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 57
Comparing Two Different Versions of a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To compare two different versions of a page,
1. Go to the page and click on the 'Info' tab.
2. Click on the 'View Page History' link. This will display a list of all previous versions of the page in
reverse chronological order.
3. Select the versions you want to compare by checking the boxes beside them.
4. Click 'Compare Selected Versions'.
Lines inserted are shown in green, and lines removed in red.
Screenshot : Comparing Changes
RELATED TOPICS
Viewing Recent changes
Restoring an Older Version of a Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 58
Restoring an Older Version of a Page
This page last changed on Jan 15, 2007 by rosie@atlassian.com.
To restore an an older version of a page,
1. Go to the page and click on the 'Info' tab.
2. Click on 'View Page History'. This will display a list of all the older versions of the page in reverse
chronological order.
Click on the links to view previous versions or select two different versions and click 'Compare
selected versions' to view the changes made between them.
3. Click 'Restore this version' beside the desired version.
Screenshot : Restore an older version
Restoring an older version creates a copy of that version. For example, in the above screenshot, if you
selected v.17 and clicked 'Restore this version', a copy of v.17 would be created. This copy would be
v.19, and would become the current version.
RELATED TOPICS
Viewing Recent changes
Comparing Two Different Versions of a Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 59
Viewing Recent changes
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To view the most recent changes to a page,
1. Click the 'View Change' link at the top of each page below the page title. This highlights the
changes between the current and previous versions of the page.
Or
2. Go to the page and click on the 'Info' tab. The five most recent versions of the page are listed along
with the date of their modification and the name of the modifying author under the heading,
'Recent Changes'.
3. Click on 'View changes' beside the desired version. The changes from the previous version are
highlighted.
Lines inserted are shown in green, and lines removed in red.
Screenshot : Viewing Recent Changes
RELATED TOPICS
Comparing Two Different Versions of a Page
Restoring an Older Version of a Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 60
Working with Drafts Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence will autosave the page you are editing periodically, and maintain a copy of it as a draft in the
event that some system failure or error prevents you from saving your changes.
• Drafts are created while adding and editing a page or news item.
• A draft is only available to you if you have not been able to save your changes. You cannot create a
draft explicitly.
• Drafts are listed in the 'Drafts' tab of your profile. Only you can view and edit your drafts.
• Once you have resumed editing a draft, or chosen to discard it, it is removed from this view.
Read the Drafts FAQ for more information on working with drafts.
RELATED TOPICS
Working with Drafts FAQ
Concurrent Editing and Merging Changes
Take me back to Confluence 2.0 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 61
Working with Drafts Faq
This page last changed on Feb 02, 2006 by vidya.
Drafts are a feature of Confluence 2.1.
This page covers some of the common questions you may have while using drafts. Read Working with
Drafts Overview for more information.
1.
2.
3.
4.
5.
6.
7.
What is a draft?
How often are drafts saved?
Where can I see my drafts?
I lost my changes before I could add the page. What do I do?
What happens if I am editing the draft of a page that has since been updated?
If I click one of the other page tabs when I am editing a page, will I lose my changes?
How do I configure the time for how often drafts are saved?
What is a draft?
A draft is an autosaved version of the page which is created by Confluence when you have made changes
to a page but have failed to save it.
How often are drafts saved?
By default, Confluence saves a draft of your page once every thirty seconds. A site administrator can
configure how often drafts are saved from the Administration Console.
Where can I see my drafts?
Your drafts are listed under the 'Drafts' Tab when you go to your Profile.
I lost my changes before I could add the page. What do I do?
Confluence will save a draft of the page even if you haven't successfully added it yet.
Document generated by Confluence on Feb 08, 2007 14:05
Page 62
There are two ways to resume editing the page:
1. Go to the 'Drafts' tab of your 'Profile'. A draft of the page will be listed with an option to 'Resume
Editing'.
If you had not entered a page title, the draft will be listed without a title as well.
2. When you next click 'Add Page' in that space, Confluence will ask you if you want to resume editing
the page that wasn't saved.
What happens if I am editing the draft of a page that has since been updated?
When this happens, Confluence will display a message informing you that you are editing an outdated
page. If there are no conflicts between the two versions, Confluence will give you the option to 'Merge
and Resume editing'.
If there are any conflicts, Confluence will give you the option to 'View the Conflict' or to 'Discard' your
changes.
If I click one of the other page tabs when I am editing a page, will I lose my changes?
No. Whenever you click on any of the page tabs, Confluence will automatically save a draft. When you
click on the 'Edit' tab again, Confluence will let you know that a version of the page you are editing was
unsaved and give you the option to resume editing.
*How do I configure the time for how often drafts are saved?*
A site administrator can configure a different time setting for how often drafts are to be saved from the
Administration Console > General Configuration.
RELATED TOPICS
Working with Drafts Overview
Concurrent Editing in Confluence 2.1
Document generated by Confluence on Feb 08, 2007 14:05
Page 63
Take me back to Confluence 2.0 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 64
Writing Confluence pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence pages can be written in two ways:
• using a simple markup language. The Quick Notation Guide is conveniently placed beside the edit
screen. Click on the Full Notation Guide in your help window to view the entire list of formatting
and other complex operations that Confluence's Notation permits, along with the markup detailing
how to perform them.
And / Or
• using the Rich Text editor. Similar to editors available in standard text editing applications, the Rich
Text editor allows you to enter content as you would in a WORD document and apply formatting by
clicking icons on a toolbar.
NOTE
While the Rich Text editor permits all formatting options possible with Wiki markup, you will still
need to use wiki markup for other more complex functions like macros.
RELATED TOPICS
Confluence Notation Guide Overview
Rich Text Editor Overview
Working with Pages Overview
Creating a New Page
Editing an Existing Page
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 65
Working with Labels Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Labels are user-defined tag words that can be assigned to pages to categorise, identify or bookmark
content in Confluence.
For example, you can assign the label 'accounting' to all accounts-related pages on the site. You can then
browse all pages with the label 'accounting' in an individual space or across the site, do a search based
on it, and even use it to filter information when you subscribe to a Confluence RSS feed.
Because labels are user-defined, you can add any word (or even make up your own) that helps you
identify the content in the site.
Labels appear below the page tabs in a page and can be added or removed without affecting the content
of the page.
There are two different types of labels:
Global Labels: A global label is available to all users across the site. Once a global label is added, any
user with permission to view a page can also view its labels. Any user with permission to edit a page can
add a global label to a page.
Personal Labels: A personal label is only available to the user that created it. Any user with 'view'
permission can add a personal label to a page.
Here are some of the advantages of using labels:
• Labels are user-defined which means that you decide what information is relevant to you and how
you are going to label it.
• You can group pages without having to restructure the site.
• Labels are easy to add and edit, and do not affect the actual content of the page.
• You can use labels to filter information during a search.
• You can add as many labels as you like to a page.
RELATED TOPICS
Document generated by Confluence on Feb 08, 2007 14:05
Page 66
Viewing Global Labels
Viewing Personal Labels
Adding a Global Label
Adding a Personal Label
Label Macros
Take me back to Confluence 2 Home
Comments
There are other pages that need to be linked here. Adding a team label for instance. Why not use the
children macro so that this is automatic instead of requiring explicit coding that tends to be out of date?
Posted by bob.swift@lakeviewtech.com at Jan 22, 2006.
.....................................................................................................................................................................
Generally, 'related pages' can't be modeled as parent-child relationships because the relationship is
multi-dimensional and reciprocal. The forthcoming admin guide uses labels to sort related pages, which
works better.
(Most of the user guide was written with Confluence 1.4, before labels were available. We'll back-port the
admin guide's use of labels to the user guide once everything is live)
Posted by cmiller at Jan 22, 2006.
.....................................................................................................................................................................
Is it possible to rename a global label?
Posted by abosse at Nov 09, 2006.
.....................................................................................................................................................................
Hi,
I am giving Label for my page as : My Stuff ,but the problem is that it is taking it as 2 different lable like
one label as My and second label as Stuff.
Is that label dosen't accept space between tow words.
Can it is possible to give label with 2 words having space in between.
Posted by shameem_khan at Nov 13, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 67
Adding a Global Label
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Any user with 'edit' permission for a page can add a global label to it.
To add a global label,
1. Go to the 'view' mode of the page. If the page already has labels, these will be displayed at the top
of the page below the page title.
2. Click on the 'Edit' link beside the list of labels (highlighted in yellow). This will display a form with
an input field and a list of 'Suggested Labels' to choose from.
3. Check if you want to use any of the suggested labels; these are a list of labels you've used recently
and the most popular labels in the space. Clicking on a label will add it to the page.
If you want to add a new label, simply type it in and click 'Add'. As you type, the drop-down field
will display the label closest to the word you are typing. It is possible another user may have added
the same label or a similar label which you can select and reuse.
4. Click 'Done'.
Note
Labels are always in lowercase. Even if you use uppercase characters, Confluence will convert
these to lowercase when it adds the label.
Screenshot : Adding a Label
RELATED TOPICS
Adding a Personal Label
Removing a label
Adding a Space Label
Adding a Team Label
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 68
Comments
Is it possible to label a page by creation? the user don't have to enter it or don't have to select a
template.
For example, this link creates a page from the page where you on: (change localhost by server, fill in
spacekey and pageId).
http://localhost:8080/pages/createpage.action?spaceKey=***&fromPageId=****
Can you add something here as a parameter, so the new page will have the label you want? or what do
you have to add for example if you put this as a link in an usermacro, so the usermacro will automatically
add a predefined label to the newly created page (performed by the usermacro)?
Posted by dieter at Sep 25, 2006.
.....................................................................................................................................................................
Yes, you can do this with the labelsString parameter. The end of the link will be:
/pages/createpage.action?spaceKey=KEY&fromPageId=12345&labelsString=some+test+labels
This parameter simply puts a value in the labels text box on the Create Page screen, which the user can
still edit if she wants. If she doesn't, the labels you provided will get applied to the new page.
Posted by mryall at Sep 26, 2006.
.....................................................................................................................................................................
super! thank you!
Posted by dieter at Sep 28, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 69
Adding a Personal Label
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Any user with 'view' permission can add a personal label. Personal labels are only available to the user
that created them. To differentiate them from global labels, personal labels include the prefix "my:" in the
label name.
Here are some examples of personal labels:
"my:sales", "my:stuff", "my:trivia"
To add a personal label,
1. Go to the 'view' mode of the page.
2. Click on the 'Edit' link beside 'Labels'. This link is highlighted in yellow. This will open up a form
with an input field and a list of 'suggested labels'.
3. Check if you want to use any of the suggested labels; these are a list of labels you've used recently,
and the most popular labels in the space. Your personal labels will also appear here if you have used
them frequently or recently. Clicking on a label will add the label to the page.
If you want to add a new label, simply type it in using the markup "my:label" and click 'Done' to
add the label.
Note
Labels are always in lowercase. Even if you use uppercase characters, Confluence will convert
these to lowercase when it adds the label.
Screenshot : Adding a Label
RELATED TOPICS
Adding a Global Label
Adding a Space Label
Adding a Team Label
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 70
Document generated by Confluence on Feb 08, 2007 14:05
Page 71
Adding a Space Label
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To add a Space Label,
1. Click on the 'Browse Space' link at the top right-hand corner of the page.
2. Go to the 'Advanced' tab and click 'Edit Space Details'. This will take you to a new screen.
3. Click 'Edit Space Labels' in the left navigation frame. In the input field displayed under the heading
'Labels', type in your label and click 'Add'. A list of suggested labels is also displayed in the form.
Click on the label to add it.
Screenshot : Adding a space label
RELATED TOPICS
Adding a Global Label
Adding a Personal Label
Adding a Team Label
Take me back to Confluence 2 Home
Comments
It would be useful to have some content or links here about how and where you use Space Lables.
Posted by petemiller111 at Oct 16, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 72
Adding a Team Label
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Team labels are used to group together related spaces.
For example, if you have one or more spaces on the site that the Sales team may be interested in, you
can group all these spaces together under the label 'sales'.
On the Dashboard, you can then choose 'Sales' from the drop down menu under the 'Team' tab in the
spaces list, and have only the list of spaces relevant to the Sales team displayed. The 'Recently
Updated' section will also display content only from these spaces.
You will need to add the same label all the spaces you want to group together.
To add a Team Label,
1.
2.
3.
4.
Click on the 'Browse Space' link at the top right-hand corner of the page.
Go to the 'Advanced' tab and click 'Edit Space Details'. This will take you to a new screen.
Click 'Edit Space Labels' in the left navigation frame.
In the input field displayed under 'Team Labels', type in your label and click 'Add'. A list of
'Suggested Labels' is also displayed in the form. Click on the label to add it.
Screenshot: Adding a team label
Screenshot: List of team related spaces on the dashboard
Document generated by Confluence on Feb 08, 2007 14:05
Page 73
RELATED TOPICS
Adding a Global Label
Adding a Personal Label
Adding a Space Label
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 74
Label Macros
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
1. Navmap Macro
Renders the list of pages associated with a specified label as a navigation map.
2. Related Labels Macro
Lists labels commonly associated with the current page's labels.
3. Content by Label Macro
Displays a list of content marked with specified labels.
4. Recently Used Labels Macro
Lists labels most recently used in a specified scope (Global, Space, or Personal)
RELATED TOPICS
Working with Labels Overview
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 75
Content by Label Macro
This page last changed on Jan 22, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Contentbylabel macro lists content associated with specific labels.
Contentbylabel Macro
What you need to type
What you will get
{contentbylabel:documentation, my:stuff}
Confluence 2 Home (Confluence 2 User Guide)
Labels: favourite, guide, userguide, user,
documentation, contents, confluence20
Related Labels Macro (Confluence 2 User Guide)
Labels: documentation
Working with Macros (Confluence 2 User Guide)
Labels: list, confluence, summary, all,
documentation, macro, index
By default, Confluence lists all the labels for each result displayed. See optional parameters below to
disable this.
Recommended Default Usage
To display all pages with the label needs-fixing, use:
{contentbylabel:needs-fixing|showLabels=false|maxResults=99|showSpace=false}
Optional Parameters
No
parameter
Default
Description
1
key
all
Filter by space
(Keywords @all and
@self available with
Confluence 2.2.2 and
higher)
2
type
false
Filter by content type
3
showLabels
true
Show or hide labels for
results
4
showSpace
true
Show or hide spaces for
results
5
excerpt
false
Show or hide excerpts
for results
Document generated by Confluence on Feb 08, 2007 14:05
Page 76
6
7
maxResults
5
Specify maximum
results to display
sort=creation
sort=title
sort=modified
recent
The 'sort' attribute is an
optional attribute that
allows you to configure
how the children are
sorted. Use the 'reverse'
attribute to optionally
reverse the sorting.
1. Filter by space
{contentbylabel:dogs,cats|key=PETS}
2. Show only results in current space (Confluence 2.2.2 and higher)
{contentbylabel:dogs,cats|key=@self}
3. Show results from all spaces (Confluence 2.2.2 and higher)
{contentbylabel:dogs,cats|key=@all}
4. Filter by content type: pages or blog posts
{contentbylabel:dogs,cats|type=page,blogpost}
5. Hide labels for results
{contentbylabel:dogs,cats|showLabels=false}
6. Hide spaces for results
{contentbylabel:dogs,cats|showSpace=false}
7. Display excerpts for results
{contentbylabel:dogs,cats|excerpt=true}
Document generated by Confluence on Feb 08, 2007 14:05
Page 77
8. Specify the maximum number of results to display
{contentbylabel:dogs,cats|maxResults=99}
9. Sort by creation date, modification date or title
{children|sort=creation|reverse=true}
RELATED TOPICS
Related Labels Macro
Navmap Macro
Recently Used Labels Macro
Working with Labels Overview
Working with Macros
Take me back to Confluence 2 Home
Comments
it appears that contentbylabel is limited to show max 5 entries - any way to change that value?
Posted by keepthebyte at Jan 13, 2006.
.....................................................................................................................................................................
There is an undocumented parameter: maxResults. Why the default is 5 is strange. The default should be
all.
Posted by bob.swift@charter.net at Jan 13, 2006.
.....................................................................................................................................................................
Are there more undocumented parameters? I'm looking for a way to get a sorted result-list.
No content found for label(s) outlook2003.
does work as it should, however, if i append |sort=title it won't. Any clues?
Posted by muellerj at Jan 13, 2006.
.....................................................................................................................................................................
Doesn't look like it. I should have said, not documented here. The notation guide shows the maxresults
parameter.
Posted by bob.swift@charter.net at Jan 13, 2006.
.....................................................................................................................................................................
If you want more options, such as those found on the {children} macro, please vote for this JIRA issue
and add any additional parameters that are required: http://jira.atlassian.com/browse/CONF-5137
Document generated by Confluence on Feb 08, 2007 14:05
Page 78
Posted by gfraser at Jan 14, 2006.
.....................................................................................................................................................................
Bob,
Thanks for pointing that out. I have included it now.
Cheers,
Vidya
Posted by vidya at Jan 15, 2006.
.....................................................................................................................................................................
Is there hidden option to filter by multiple labels? blog-posts macro has "match-labels=all" option, but
from some reason blog-posts won't work if page is included, but this macro works.
Posted by ajevic at Feb 06, 2006.
.....................................................................................................................................................................
excerpt=true does not seem to work for blogpost. The content is not shown. Pls anyone confirm this?
Posted by cychiam at Sep 12, 2006.
.....................................................................................................................................................................
Hi, If this macro can display the title of a page, it can also display the author of the page ?
Is there a way to do that ? ...
'Cause i can't find the source code of this macro /:
Posted by gludenglu at Oct 23, 2006.
.....................................................................................................................................................................
Showing excerpts doesn't seem to be working for me. Does it work? Does the page itself need something
done to it to display the excerpt?
Posted by hork at Nov 01, 2006.
.....................................................................................................................................................................
Is there a way to specify that you want to list all the pages in the space that *don't* have a label?
I'd like to make a page that lists all the other pages in the space that don't have labels.
Posted by hork at Nov 01, 2006.
.....................................................................................................................................................................
I guess the page has to have an excerpt defined for it to display. There is an excerpt macro that needs to
be used on the page to define the excerpt that will show up.
Posted by hork at Nov 01, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 79
I'd like to specify AND syntax for choosing pages that have label "A" and label "B". There should be a
standard way to filter pages that is used in
Unable to render {include} No page title provided
and
No content found for label(s) .
and any other macros that select pages.
Posted by tony.marshall@citigroup.com at Nov 15, 2006.
.....................................................................................................................................................................
Re-written to display properly.
I'd like to specify AND syntax for choosing pages that have label "A" and label "B". There should be a
standard way to filter pages that is used in {include} and {contentByLabel}and any other macros that
select pages.
Posted by tony.marshall@citigroup.com at Nov 15, 2006.
.....................................................................................................................................................................
I have the below code written for my macro but it still shows the space in the results for the label. What
am i doing wrong?
{contentbylabel:mylabel|showLabels=false|showSpace=false|maxResults=100}
Posted by jguthrie at Dec 07, 2006.
.....................................................................................................................................................................
Also wanted to let you know, 'modification' should actually be 'modified' for the sort criteria...
Posted by jguthrie at Dec 07, 2006.
.....................................................................................................................................................................
Can this label be improved or have a variable that automatically detects the labels that are on the page
and organizes content by them without the user needing to put the label in. (labels changing etc...) Last
comment, sorry to all who are watching this page. :$
Posted by jguthrie at Dec 07, 2006.
.....................................................................................................................................................................
Is there an option to show time since last modified?
Ronnie
Posted by ronnie chan at Dec 27, 2006.
.....................................................................................................................................................................
I second that, is there any information how AND-filtering by several labels is possible ?
Posted by christian.hansen@oenb.at at Jan 18, 2007.
.....................................................................................................................................................................
Fixed - thank you very much.
Document generated by Confluence on Feb 08, 2007 14:05
Page 80
Posted by rosie@atlassian.com at Jan 22, 2007.
.....................................................................................................................................................................
Feedback on improving this piece of documentation (or any other) is much appreciated; but to ensure a
quick response to questions and about using Confluence, please visit the Forums or log a support call. If
you have a suggestion about improving Confluence, please vote for relevant issues in the Confluence
project, or log a new issue if appropriate.
Posted by rosie@atlassian.com at Jan 22, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 81
Navmap Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Navmap macro displays the list of pages associated with a specified label as a navigation map.
A label must be specified for this macro.
Navmap macro
What you need to type
What you will get
{navmap:documentation}
Confluence 2
Home
Related Labels
Macro
Working with
Macros
Optional Parameters:
No
parameter
Default
Description
1
title
None
Specify a title for the
navigation map
2
wrapAfter
5
Specify the number of
cells in a row
3
cellWidth
90 px
Specify the cell width
4
cellHeight
60 px
Specify the cell height
5
Theme
Confluence
Define a theme for the
navmap
1. Specify a title for the navigation map
What you need to type
{navmap:documentation|title=Confluence
Documentation}
What you will get
Confluence Documentation
Confluence 2
Home
Related Labels
Macro
Working with
Macros
2. Specify the number of cells in a row
The default is 5 cells.
{navmap:mylabel|wrapAfter=3}
Document generated by Confluence on Feb 08, 2007 14:05
Page 82
3. Specify the cell width
The default width is 90px
{navmap:mylabel|cellWidth=120}
4. Specify the cell height
The default is 60px
{navmap:mylabel|cellHeight=120}
5. Define a theme for the navmap
If you want to create your own look and feel for the navmap (say one with rounded corners), you can do
so by adding a file to the WEB-INF/classes/templates/macros directory. The file name convention to use
is: navmap-mytheme.vm. You can use whatever name you like in place of mytheme. Just make sure you
specify this when calling the macro using theme=mytheme.
RELATED TOPICS
Related Labels Macro
Content by Label Macro
Recently Used Labels Macro
Working with Labels Overview
Working with Macros
Take me back to Confluence 2 Home
Comments
Is there any way to limit the navmap macro to a particular space? (I.e. similar to how one can limit the
contentbylabel macro.)
Posted by m-grady@uiuc.edu at Oct 12, 2006.
.....................................................................................................................................................................
+1 for this feature!
Is there a JIRA project where we can log this request?
Posted by doobya at Dec 08, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 83
Recently Used Labels Macro
This page last changed on Feb 04, 2007 by ktran.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Recently-used-label macro renders a list of the most recently used labels in a specified scope
(Global/Space/Personal)
Recently-used-labels macro
What you need to type
{recently-used-labels}
What you will get
label, new, intro, markup, wiki, daily-backup, icon,
directory, people, personalise
Optional Parameters
Specify the number of labels to be displayed.
By default, 10 labels are displayed.
{recently-used-labels:count=5}
Specify the scope of labels to be displayed.
The default scope is 'global'.
{recently-used-labels:scope=space}
Display the labels in a table.
{recently-used-labels:style=table}
Specify a title for the table view
{recently-used-labels:style=table|title=List of my recently used labels}
Document generated by Confluence on Feb 08, 2007 14:05
Page 84
Related Labels Macro
Content by Label Macro
Recently Used Labels Macro
Working with Labels Overview
Working with Macros
Take me back to Confluence 2 Home
Comments
Love the label feature
But, the example syntax is wrong. The first pipe needs to be a colon. For example:
{recently-used-labels|count=5}
Needs to be
{recently-used-labels:count=5}
Posted by kentsiggers@comcast.net at May 17, 2006.
.....................................................................................................................................................................
Hi Kent,
Thank you for notifying us of the problem. The document has now been corrected.
Regards,
Kevin
Posted by ktran at Feb 04, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 85
Related Labels Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Related-labels macro lists the labels commonly associated with the current page's labels.
Related-labels macro
What you need to type
{related-labels}
What you will get
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
documentation
test
installation
example
confluence20
index
macro
contents
all
user
summary
confluence
userguide
guide
list
favourite
Optional Parameters
Specify the labels for which you want to view related labels
What you need to type
{related-labels:labels=documentation, my:stuff}
Document generated by Confluence on Feb 08, 2007 14:05
What you will get
•
•
•
•
•
•
•
•
•
•
•
•
confluence20
index
macro
contents
all
user
summary
confluence
userguide
guide
list
favourite
Page 86
RELATED TOPICS
Navmap Macro
Content by Label Macro
Recently Used Labels Macro
Working with Labels Overview
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 87
Removing a Label
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To remove a label,
1. Go to the page that contains the label. All labels are displayed at the top of the page below the page
title.
2. Click 'Edit' beside the list of labels (highlighted in yellow). Each of the labels will display a
mark
beside it.
3. Click
to remove the label, then click 'Done'
RELATED TOPICS
Working with Labels overview
Take me back to Confluence 2 Home
Comments
The above procedure only removes a label from a page. The label itself continues to exist, even if there
are no pages left to which it is attached, (Browse Space -> Labels). I have not found a way yet to
completely delete labels from the internal labels' database.
Posted by pas at Jul 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 88
Viewing Global Labels
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Any page that has labels will have them listed at the top of the page below the page title.
Global labels are visible to all users with 'view' permission and personal labels are only visible to the user
that created them.
To view global labels,
1. If you are in a page that has labels, clicking on a label will take you to the 'Label' tab of the 'Browse
Space' view where all pages in the space with that label will be listed.
Click on the link 'See content from all spaces' to view all pages with the same label across the
site.
2. Click on the 'Labels' tab in the 'Browse Space' view of the space. You have the option to view
labels in one of two ways:
• Click 'All labels' to view all labels in the space. From this view, you can click on a link to view
an alphabetical listing of all labels across the site. Clicking on a label will list all content in the
space with that label. It will also display any related labels if they exist. Related labels are
labels that frequently appear on pages together. For Example, if pages labelled with 'sales' also
tend to have the label 'marketing', these will be displayed as related labels.
• Click popular labels to view a list of the most frequently used labels in that space. From here,
you can also view the most popular global labels across the site.
Confluence defaults to one of these views when you go to the 'Labels' tab based on your
preference on your last visit to the site.
Each of these views also displays a list of up to fifteen most 'Recent Labels' and 'Popular
Labels' in the space.
Screenshot : Labels as they are displayed on a page
Screenshot : Viewing all labels
Document generated by Confluence on Feb 08, 2007 14:05
Page 89
RELATED TOPICS
Viewing
Viewing
Viewing
Viewing
Labelled Pages
Global Labels
Personal Labels
Popular Labels
Take me back to Confluence 2 Home
Comments
Hey guys, since my primary way (shortest path) of finding content using global labels is the quick search
bar, it doesn't make sense that I don't have an easy way of finding out what all the global labels are that
are defined on a confluence site. The only way to find that out, as far as I can tell, is to navigate to some
space first that happens to have a label, and then go into browse space on that space. That is really
awkward.
Posted by weaverj at Nov 02, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 90
Viewing labelled pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The easiest way to find labelled content is to do a quick search for it. If there is a label matching your
query, it will be listed above the search results. Clicking on the link will display all content in the site with
that label.
• You can view all labelled content for a space by going to the 'Label' tab in the 'Browse Space' view
of a space.
• You can view content labelled with personal labels by going to your 'Profile' and clicking on the
'Label' tab.
Viewing labelled content
Advanced label searching
In the search box, you can use the labelText: prefix to search specifically for page labels.
Searching for ...
Returns content that ...
confluence labelText:plugin
contains the word confluence or has the label
plugin
confluence AND labelText:plugin
contains the word confluence and has the label
plugin
labelText:import labelText:plugin
has the label import or has the label plugin
labelText:import AND labelText:plugin
has the label import and has the label plugin
RELATED TOPICS
Viewing Global Labels
Viewing Personal Labels
Viewing Popular Labels
Searching Confluence
Document generated by Confluence on Feb 08, 2007 14:05
Page 91
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 92
Viewing personal labels
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Any page that has labels (global or personal) will have them listed at the top of the page below the page
title. Personal labels are only visible to the user that created them.
To view your personal labels,
1. If you are in a page that has personal labels, clicking on a label will take you to the 'Label' tab of
your 'Profile' where all pages in the space with that label will be listed.
2. Go to your 'Profile' by clicking the link located at the top of the page.
• Go the 'Label' tab. This will display all content with personal labels in the space. A list of your
personal labels along with the number of pages that contain the label is also displayed. Clicking
on a link will list all content with that label.
Viewing personal labels
RELATED LABELS
Viewing Labelled Pages
Viewing Global Labels
Viewing Popular Labels
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 93
Viewing Popular Labels
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Popular labels are labels that are frequently used. Confluence allows you to view the most popular labels
both within a space and across the site.
To view popular labels,
1. Go to the 'Label' tab in the 'Browse Space' view of the space.
2. Click on the link 'popular labels'. This will list the most popular labels in the space and also display
a link to view all 'global popular labels' (across the site).
• Clicking on a label will display all content in the site with that label.
• Click 'global popular labels' to view the most popular labels in the site.
In both these views, you have the option to sort the listing of labels to display them 'alphabetically' or
in order of their 'popularity'.
The bigger the font size, the more popular the label.
space attachments directory^Viewing popular labels
RELATED TOPICS
Viewing Labelled Pages
Viewing Global Labels
Viewing Personal Labels
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 94
What's New in Confluence 2.0
This page last changed on Nov 30, 2005 by vidya.
1. The Dashboard
Faster Access to Content that is relevant to you!
• Customised Space lists : You can now customise the Dashboard to view only the list of spaces
you are interested in, or that is relevant to your team. Switch between tabs to view:
° My Spaces : What you marked as your favourite spaces.
° Team Spaces : Spaces pertaining to a team grouped together using team labels.
° New : New spaces added to the site in the last seven days.
° All : All the spaces on the site.
• Customised Recently Updated Content : If you are in 'My spaces' view, only the updated content
from your favourite spaces is displayed in this section.
• List of your favourite pages : A list of your most recently added favourite pages is displayed
under 'Favourite Pages'.
• RSS Feed Builder: Create custom RSS feeds to track changes to content in Confluence you are
interested in.
NEXT : Rich Text editor
Document generated by Confluence on Feb 08, 2007 14:05
Page 95
What's New-Favourites
This page last changed on Nov 28, 2005 by vidya.
4. Favourites
Bookmark your favourite pages and spaces
Once you add spaces and pages to a favourites list, you can:
1. Access your favourite spaces from the Dashboard:
2. View all your favourite pages and spaces by going to your 'Profile':
2. View your most recent favourite pages from the Dashboard:
Document generated by Confluence on Feb 08, 2007 14:05
Page 96
NEXT : RSS Feed Builder
Comments
Is there a macro to list a user's favorites in a page?
Posted by thomasvdv at Dec 15, 2005.
.....................................................................................................................................................................
Thomas,
Yes, the 'Favourite Pages Macro' lists a user's favourite pages.
Here is the link to the documentation: Favourite Pages Macro.
Cheers,
Vidya
Posted by vidya at Dec 15, 2005.
.....................................................................................................................................................................
Is there an easy way a person can find what they have added to the wiki in the form of pages, comments
etc. Like a "show your posts" link that some people have on forums?
Thanks!
Posted by jguthrie at Nov 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 97
What's new-Labels
This page last changed on Nov 28, 2005 by vidya.
3. Labels
Labels are 'tag words' that you can assign to content in Confluence to help you identify or categorise it.
Labels are user-defined and can be added and removed quickly without affecting the actual content of a
page.
For example, you can assign the label 'sales' to all Sales related pages on the site. You can then use that
label to view all pages with the label 'sales' in an individual space or across the site, do a search based on
it, and even use it to filter information when you subscribe to an RSS feed within Confluence.
You can do many more useful things with labels but here are a few examples:
1. Group pages by adding a label, without restructuring the site
2. Click on a label to view all pages in the space with the same label
Document generated by Confluence on Feb 08, 2007 14:05
Page 98
3. Use labels to filter information when you create customised
RSS feeds
NEXT : Add Favourites
Document generated by Confluence on Feb 08, 2007 14:05
Page 99
What's New-Rich Text Editor
This page last changed on Nov 30, 2005 by vidya.
2. The Rich Text Editor
Wiki Markup or Rich Text - You decide!
Creating Confluence pages is now made even simpler with the introduction of the long awaited Rich Text
Editor.
The Rich Text editor allows for most page formatting options available in standard text editing
applications.
The 'Edit' screen lets you switch between 'Rich Text' and 'Wiki Markup' edit modes without losing the
changes you've made; so you can use a combination of both while editing. You can also default to either
'Wiki Markup' or 'Rich Text' depending on your preference.
NEXT : Labels
Document generated by Confluence on Feb 08, 2007 14:05
Page 100
What's new-RSS Feed Builder
This page last changed on Nov 28, 2005 by vidya.
4. RSS Feed Builder
Use the RSS feed builder to can create customised RSS feeds to subscribe to changes within Confluence.
Design your feeds by filling out a simple form that lets you specify the type/s of content in Confluence
you wish to track changes to, and how you want to subscribe to them.
NEXT : 2.O DOCUMENTATION HOME
Document generated by Confluence on Feb 08, 2007 14:05
Page 101
Archiving Mail Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to collect and archive mail within each space individually. This is a useful facility
that allows you to archive all emails pertaining to a particular project on Confluence alongside it in the
same space.
You can download mail from one or more pop-accounts. You can also import mail from mbox files either
on your local system or on the Confluence server.
Mail is contained in the 'Mail' tab under the 'Browse Space' view of a space. You can navigate mail
easily, and also use the 'Quick Search' to search mail and the attachments it contains.
What would you like to do?
Add a Mail Account
Manage Mail accounts
Import Mail
View Mail
Fetch Mail
Delete Mail
Restore Mail
Link to Mail
The ability to archive mail applies only to global spaces, not personal spaces. Please see Working
with Spaces Overview for information about the differences between global spaces and personal
spaces.
RELATED TOPICS
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 102
Adding a Mail Account
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
When you add a mail account, you are configuring Confluence to download mail from that account and
archive it within the space. Since Confluence removes emails from an email account as it is added to the
Mail Archive, Confluence must be setup to poll a clone email account rather than the actual account. For
example, to archive the actual account sales@company.com to your Confluence Sales space, you must
first create a clone account such as conf-sales@company.com that contains the same email content.
Stage 1 - Creating A Clone Email Account
1.
2.
3.
4.
Add a new email account on the mail server with the clone email address
Copy all existing emails from the actual account to the clone account
Setup the actual account to bcc sent emails to the clone account
Setup the actual account to forward received emails to the clone account
Stage 2 - Archive Clone Account To Mail Archive
1. If you are not a space administrator for the target space, contact your Confluence administrator to
request Space Admin permission. You need to be a space administrator before you can add a mail
account to the space.
2. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
3. Go to the 'Space Admin' tab and click on 'Mail Accounts' under the heading 'Mail' in the left
panel. This will bring up a new screen listing the existing mail accounts and displaying a link to add
a new pop-account.
4. Click 'Add mail account' located at the top of the page. This will bring up a form into which you
need to enter your account configuration details.
5. Enter the details, (Protocol may be POP/S or IMAP/S) (See below) and click 'Create'. Configured
accounts will have their mail downloaded and removed from the server, so make sure you are
downloading from a clone account.
Screenshot Of Adding A POP Account
a.
i.
• Account Name: Enter a name for this account by which it will be known in
Confluence.
• Description: Provide a description for this account (Optional).
• Protocol: Choose from POP, IMAP, POPS or IMAPS
• Hostname: Enter the account mail server host name.
Document generated by Confluence on Feb 08, 2007 14:05
Page 103
• Port: The mail server's port number will be displayed by default. Do not edit this
field.
• Username: Enter a username for this account.
• Password: The account's password.
Note: The ability to import mail applies only to global spaces, so the 'Import' section in the above
screenshot does not appear in the 'Space Admin' tab for personal spaces. Please see Working with
Spaces Overview for information about the differences between global spaces and personal spaces.
RELATED TOPICS
Archiving Mail Overview
Managing Mail Accounts
Importing Mail
Viewing Mail
Fetching Mail
Deleting Mail
Linking to Mail
Take me back to Confluence 2 Home
Comments
Any idea how to configure the system to get mails from a GMAIL or a YAHOO account?
Posted by christian.barthelemy@airbus.com at Jan 27, 2006.
.....................................................................................................................................................................
I need this info too. Gmail uses SSL over port 995 - I can specify the port but there is no options for
other security elements.
Posted by jon_cheyne at Apr 17, 2006.
.....................................................................................................................................................................
How do you tell confluence to fetch the email on a automatic schedule?
Does it do it automatically every hour or something?
Thanks,
Posted by jamesb@pharos-comms.com at Jul 25, 2006.
.....................................................................................................................................................................
Never mind, I found the info here http://confluence.atlassian.com/display/CONF20/Fetching+Mail
Posted by jamesb@pharos-comms.com at Jul 25, 2006.
.....................................................................................................................................................................
(-)Configured accounts will have their mail downloaded and removed from the server!
Document generated by Confluence on Feb 08, 2007 14:05
Page 104
Does this mean that mail will be deleted from IMAP accounts, or should it read "Configured POP accounts
..." ?
Posted by pip at Nov 01, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 105
Deleting Mail
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To delete mail for a space, you require 'Remove Mail' permission which is assigned by a space
administrator from the Space Administration screens. See Space Permissions or contact a space
administrator for more information.
Only a space administrator can delete all mails for the space simultaneously.
To delete mail for a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Mail' tab. A list of messages in the space is displayed in reverse chronological order.
3. Delete an individual email by clicking the trash
icon beside it.
If you are a space adminstrator, you can delete all emails within a space simultaneously by clicking
on the 'Delete All' link at the top of the mail view. Deleted mail is stored under 'Trash' and can be
restored by a space administrator from the 'Space Admin' tab.
Warning
Mails deleted using the 'Delete All' option cannot be restored.
RELATED TOPICS
Restoring Mail
Archiving Mail Overview
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 106
Fetching Mail
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence fetches mail from the server once every 30 minutes.
You need to be a space administrator to manually retrieve new mail from mail accounts.
To manually retrieve mail,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Mail' tab. A list of messages for the space is displayed in reverse chronological order.
3. Click on the 'Fetch Mail' link located above the list of messages. Any new messages will be
displayed in order of most recent first.
Note
Once mail is fetched, it will be removed from the server.
RELATED TOPICS
Viewing Mail
Archiving Mail Overview
Deleting Mail
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 107
Importing Mail
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to import mail from mbox files located either on your local system or on the
Confluence server and archive it within the space.
You need to be a space administrator to import mail for a space.
To import mail from an mbox file,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin' and click on 'Mail Accounts' under the heading 'Mailbox Import' in
the left panel. This will bring up a new screen.
• To import from a Local system, click 'Browse' to select the mbox file. Then click 'Import'.
• To import from the Server, enter the location of the mbox file on the server in the 'Server'
text field and click 'Import'.
Screenshot : Importing mail
The ability to import mail applies only to global spaces, so the 'Import' section in the above
screenshot does not appear in the 'Space Admin' tab for personal spaces. Please see Working with
Spaces Overview for information about the differences between global spaces and personal
spaces.
RELATED TOPICS
Archiving Mail Overview
Adding a Mail Account
Importing Mail
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 108
Document generated by Confluence on Feb 08, 2007 14:05
Page 109
Linking to Mail
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Currently in Confluence, while it is possible to link to a mail message, the method is a little cumbersome.
You need to edit in 'Wiki Markup' mode to create a link to an email.
To link to an email,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Mail' tab. The mail is displayed in reverse chronological order with a default of 30 mails
per page. Move between pages to locate the message you want to link to.
3. Click on the mail message. You will notice in the address bar of your browser that the url displayed
ends in a series of numerals.
4. Copy only the numerals.
5. Click on the 'edit' tab of the page from which you want to link to the message.
6. Paste the numerals between square brackets (as you would when you create any link in
Confluence), and then include the dollar sign '$' in front of the numerals.
Here's an example:
|
Clicking on the link will open up the mail message.
RELATED TOPICS
Working with Links Overview
Archiving Mail Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 110
Managing Mail Accounts
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to be a space administrator to manage mail accounts for a space.
To manage mail accounts,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Space Admin' tab and click on 'Mail Accounts' under the heading 'Mail' in the left
panel. This will bring up a new screen listing the existing mail accounts each with a link to 'Edit',
'Remove' or 'Disable' the account.
• Edit : This link allows you to change the configuration settings for the mail account.
• Remove: This link lets you remove the account permanently.
• Disable: This link allows you to temporarily disable the account.
Screenshot : Managing mail accounts
RELATED TOPICS
Archiving Mail Overview
Adding a Mail Account
Importing Mail
Viewing Mail
Fetching Mail
Deleting mail
Restoring Mail
Linking to Mail
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 111
Restoring Mail
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Deleted email messages are stored under 'Trash' and can be restored by a space administrator from the
Space Administration screens.
You can only restore an email from trash if it was deleted individually and not using the 'Remove All'
operation.
To restore mail,
1.
2.
3.
4.
Click on the 'Browse Space' for the space.
Go to the tab 'Space Admin'
Click on 'Trash' in the left panel. A list of pages and emails deleted from the space is displayed.
Click on 'Restore' beside the email you want to restore.
To view this email, you will have to go to the ' Mail' tab under 'Browse Space'.
RELATED TOPICS
Viewing Mail
Fetching Mail
Deleting Mail
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 112
Viewing Mail
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
In Confluence, each global space can be set up to archive mail.
To view mail messages archived within a particular space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Mail' tab. The mail is displayed in reverse chronological order with a default of 30 mails
per page. You can move between pages by clicking the
and
links or by
selecting a particular page number.
3. Click on a mail message to view its contents.
Screenshot : Mail Archive
If you are a space administrator, or have been given permission to delete mail messages, you can
also delete emails from here.
Navigating Mail
'Find More': These links links at the top of an email message let you search for other emails from the
same author or on the same subject.
'Attachments': This link located below the email body allows you to view mail attachments. The link is
only displayed if any attachments exist.
'Entire Thread': This link allows you to view the mail's thread, if one exists.
The 'Mail Operations' panel is located to the right of the mail view and displays links to:
• Entire Thread: View the thread that this mail belongs to. This option is only available when the
mail belongs to a thread.
• Next By Date: Navigate to the next message.
• Previous By Date: Navigate to the previous message.
• Remove Mail: Remove the current mail from the space.
• Mail Archive: Go to the mail archive view for this space.
Document generated by Confluence on Feb 08, 2007 14:05
Page 113
Handy Hint
Use the Quick Search facility to quickly locate a mail
RELATED TOPICS
Archiving Mail Overview
Viewing Mail
Fetching Mail
Deleting Mail
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 114
Displaying an Image
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Displaying an image from either a remote source or from an attached file is easy.
This page shows you how to display an image using Confluence Notation, aka [Wiki Markup]. You can
also use the Rich Text editor to insert an attached image into your page.
To display an image from a remote source,
You need to know the url from which the image can be linked.
What you need to type
What you will get
!http://www.atlassian.com/images/confluence_feature.gif!
Cannot resolve external resource into attachment.
To display an image attached to a page,
Once you attach the image, you can display it from the page like this:
What you need to type
What you will get
!fish.gif!
To display an image attached to another Confluence page,
You need to edit in 'Wiki Markup' mode.
What you need to type
What you will get
!Space attachments directory^fish.gif!
Where:
'Space Attachments Directory' is the name of the page containing the attachment.
Warning
Confluence will only allow you to attach a file when you have already created a page.
Example of use
Is there any way to upload an attachement only one time? Like a html homepage, where you
load a picture on the server and after that you are able to link that file for the next
time you need that attachement. So we have to upload one image 10 times if we want to use
Document generated by Confluence on Feb 08, 2007 14:05
Page 115
them on another site?
1. Attach image to a particular page.
2. An user needs to have view permission for that page.
3. To link to this resource use the syntax highlighted above:
!Home^myimg.jpg!
or even
!SPACE:Home^myimg.jpg!
RELATED TOPICS
Rich Text-Inserting an Image
Attaching Files to a Page
Image File Formats
Thumbnail Macro
Gallery Macro
Take me back to Confluence 2 Home
Comments
How does one display an image with a CamelCased name, like !ThisIsMyImage.gif!?
Posted by dt.public@gmail.com at Oct 25, 2005.
.....................................................................................................................................................................
How do you change the size of an embedded image? When in richtext mode you can actually re-size the
image onscreen, but it does not stick when you save.
In addition, when you use the richtext image embed tool you can adjust the alignment and it appears
with markup looking like this:
!fish.gif|align=left!
... but I don't see any documentation indicating the existence of a parameter like "align" and how to use
it. I'm hopeful there is a scaling parameter or other way of sizing. Is there?
Posted by rwarren@picarro.com at Jan 27, 2006.
.....................................................................................................................................................................
I was trying to add a lnk to an image in a different space but it said it couldn't find it. I wasn't sure if the
problem was that the attachment was in a different space or that the page name was complex.
Here's what I tried:
!Stew's personal workspace^Home^open.gif!
Document generated by Confluence on Feb 08, 2007 14:05
Page 116
Posted by stews at Mar 23, 2006.
.....................................................................................................................................................................
It's a bit late but maybe it's helping someone else: there is plug-in for modifying embedded images.
http://confluence.atlassian.com/display/CONFEXT/JMAGE+Plugin
Posted by tattva at May 24, 2006.
.....................................................................................................................................................................
Hi Stew,
The syntax you are using is invalid. Try this:
[!page_name^image.name!]
http://confluence.atlassian.com/display/CONF20/Linking+an+Image
Thanks,
Ivan
Posted by ivan@atlassian.com at Aug 07, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 117
Image File Formats
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to attach image files of any format to a page. However, your ability to display
them depends on the image file formats supported by the browser you are using.
Confluence supports the following image formats for its Thumbnail and Gallery macros :
• gif
• jpeg
• png
The bmp format is not supported.
RELATED TOPICS
Displaying an Image
Thumbnail Macro
Gallery Macro
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 118
Working with Favourites Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
With Confluence 2.0, you can keep track of your favourite spaces and pages.
Adding a page or a space as a favourite provides you with faster access to the content you are interested
in within the site.
1. Favourite Spaces
Once you add a space as a favourite, it will appear in the 'MY' tab in the spaces section of the dashboard.
The 'Recently updated' section in this view will also display content only from your favourite spaces.
The Dashboard remembers which one of the views, 'My', 'Team', 'All' or 'New' you were most recently
viewing. So if you clicked the 'MY' tab on this visit, next time around, as soon as you log in to Confluence,
only the list of your favourite spaces and the recently modified content within them will be displayed to
you.
2. Favourite Pages
The dashboard will display a list of your most recently added favourite pages, so you can access them
easily as soon as you login to Confluence.
3. All your favourites
You can view a list of all pages and spaces you added as favourites by going to your 'Profile'. This means
that you no longer have to navigate through complicated site structures to find the pages that you are
Document generated by Confluence on Feb 08, 2007 14:05
Page 119
interested in but can go to them directly.
In Confluence version 2.3 and later you can also nominate favourite people in the People
Directory.
RELATED TOPICS
Adding Favourites
Removing Favourites
Dashboard
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 120
Adding Favourites
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To add a page as a favourite,
Go to the page. Click on the star icon '
change to '
' located at the top right-hand corner of the page. This will
' to indicate that you have added it as a favourite.
To add a global space as a favourite,
Go to the Dashboard. Click on the star icon '
This will change to '
' located beside the space in the list of spaces displayed.
' to indicate that you have added it as a favourite.
To add a personal space as a favourite,
Go to the People Directory. Click on the star icon '
people displayed. This will change to '
' located beside the person's name in the list of
' to indicate that you have added that person's personal space
as a favourite.
More about global spaces and personal spaces
RELATED TOPICS
Viewing favourites
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 121
Removing Favourites
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To remove a page as a favourite,
Go to the page. Click on the star icon
change to
located at the top right-hand corner of the page. This will
to indicate that you have removed it from your favourites.
To add a space as a favourite,
Go to the dashboard. Click on the star icon
This will change to to
located beside the space in the list of spaces displayed.
indicate that you have removed it from your favourites.
RELATED TOPICS
Viewing favourites
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 122
Viewing Favourites
This page last changed on Jan 01, 2007 by rosie@atlassian.com.
You can view your favourite spaces by going to the 'MY' tab under the spaces section on the Dashboard.
Confluence will also list your most recently added favourite pages on the Dashboard.
To view all your favourites,
1. Click on the 'Profile' link located at the top right-hand corner of the page.
2. Go to the 'Labels' tab. A list of your personal labels is displayed to the left of the screen under
'Your Labels'.
3. Click on 'Favourite'. This will display a list of all spaces and pages that you have added as
favourites.
Screenshot : Viewing your favourites
RELATED TOPICS
Adding Favourites
Removing Favourites
Document generated by Confluence on Feb 08, 2007 14:05
Page 123
Keyboard Shortcuts
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence provides the following keyboard shortcuts:
All Screens
Keystroke
Alt-S
Action
Search field
Login Screen
Keystroke
Action
Alt-U
Username field
Alt-P
Password field
Alt-R
Check 'Remember Me'
View Screen
Keystroke
Action
Alt-V
View Page Tab
Alt-E
Edit Tab
Alt-A
Attachments Tab
Alt-I
Information Tab
Add Page Screen
Keystroke
Action
Alt-A
Add Page
Alt-P
Preview Page
Edit Page Screen
Keystroke
Action
Alt-U
Update Page
Alt-P
Preview Page
RELATED TOPICS
Document generated by Confluence on Feb 08, 2007 14:05
Page 124
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 125
Tracking Updates Overview
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
Here's how you can keep track of changes to a single page, an entire space, or to all spaces on your site.
You can only track updates to content visible to you.
Watch a space: be notified by email of new or modified content within a space.
Watch a page : be notified by email of updates to a page.
Subscribe to Daily Email Reports : be notified daily of changes in all spaces to which you have 'view'
access.
RSS Feeds : subscribe to Confluence RSS feeds to stay informed of
•
•
•
•
New
New
New
New
and updated pages
comments
news items
attachments
RELATED TOPICS
Managing Watches
Viewing History of a Page
Viewing Space Activity
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 126
Managing Watches
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The 'Watches' tab under your 'Preferences' settings displays a list of all pages and spaces you are
currenty watching. You will be sent email notifications when changes are made to your watched pages
and spaces.
To manage your notifications for your 'Watches',
1. Click on the 'Preferences' link (or 'Profile' link, in Confluence versions prior to 2.3) located below
the breadcrumbs at the top of the page.
2. Go to the 'Watches' tab. This lists the pages and spaces you are currently watching. Click the trash
icon beside any unwanted watches to remove them.
3. Go to the 'Edit Profile' tab, then click the 'Email' link.
4. Check the 'Notify on my actions' box if you want Confluence to include your own actions in your
notifications for your watches. Deselect this if you do not want to be notified of your own actions.
Note that this option only applies to your watches and not to the Daily Report .
5. Use the 'Email Format' drop-down menu to choose whether you want to receive your notifications
as HTML or plain text. Note that this will apply to the Daily Report as well as to your notifications for
watches.
RELATED TOPICS
Watching a Space
Watching a Page
Subscribing to Daily Email Reports
Tracking Updates Overview
User Profile Overview
Take me back to Confluence 2 Home
Comments
Is it possible (for admins) to "mass-subscribe" users or usergroups to daily updates or change-tracking
e-mails for certain pages/spaces?
If the answer of the above question is "yes", what would then be the answer of the following question:
how?
Posted by steffenj at Jul 17, 2006.
.....................................................................................................................................................................
I also urgently need to do this.
Posted by mrjcleaver at Jul 21, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 127
This requirement is an existing feature request. We encourage you to add your comments/requirements
to this issue, vote for the issue to increase its popularity (and therefore likelihood of being implemented
in an upcoming release) and/or add yourself to the watchers list for the latest updates here:
http://jira.atlassian.com/browse/CONF-3703
Posted by noam@atlassian.com at Aug 30, 2006.
.....................................................................................................................................................................
+1 to be able to subscribe people to watchs. Also, is there a way to list who is watching your pages?
Posted by jwatkins@kumc.edu at Oct 25, 2006.
.....................................................................................................................................................................
I agree that it is essential that people can limit daily updates or change-tracking e-mails to certain
pages/spaces that are relvant to their work.
Posted by annawsi@hotmail.com at Jan 22, 2007.
.....................................................................................................................................................................
The ability to activate a watch for a group, would be quite useful for my company as well.
Posted by dnaphil at Jan 23, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 128
Subscribing to Daily Email Reports
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
When you subscribe to the daily report, you will be sent an email with a summary report of changes in all
spaces visible to you.
To subscribe to the daily report,
1. Click on the 'Preferences' link (or 'Profile' link, in Confluence versions prior to 2.3) located below
the breadcrumbs at the top of the page.
2. Go to the 'Edit Profile' tab.
3. Click the 'Email' link in the left-hand column.
4. Check the box beside 'Subscribe to daily updates'.
5. From the 'Email Format' drop down menu, select whether you want to receive your notifications as
HTML or plain text. This will apply to all your email notifications, including your watches.
6. Click 'Save'.
Here is an example:
RELATED TOPICS
Tracking updates overview
User Profile Overview
Document generated by Confluence on Feb 08, 2007 14:05
Page 129
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 130
Subscribing to RSS Feeds within Confluence
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
RSS feeds allow you to track updates to content within Confluence. You will need an RSS newsreader to
subscribe to them.
You can create a customised RSS feed using the RSS Feed Builder (
Recommended) or subscribe to
one of the pre-specified feeds generated by Confluence.
What would you like to do?
• Create and subscribe to customised RSS feeds using the RSS Feed Builder
— create a
customised RSS feed (e.g. filter your feed using a label; specify the number of items and days to
include in your feed; etc.)
• Subscribe to pre-specified RSS feeds
— generate an RSS feed automatically in a minimal
number of steps.
To have your newsreader log into Confluence, you can append
?os_username=yourusername&os_password=yourpassword to the URL of the feed you are trying
to retrieve. Note, however, that this means someone with access to your RSS newsreader
configuration can read your password.
RSS Newsreaders
The following are some popular RSS newsreader programs for various operating systems. You can find a
more comprehensive list on Google's open directory
Windows
•
•
•
•
•
SharpReader
NewsGator
Syndirella
FeedDemon
NewzCrawler
Mac OS X
•
•
•
•
Safari
NetNewsWire
NewsFire
Shrook
Multi-Platform
Document generated by Confluence on Feb 08, 2007 14:05
Page 131
• NewsMonster (Runs in the Mozilla web browser)
• Radio Userland (Windows and MacOS)
• AmphetaDesk (Windows, Unix, Mac OS X)
RELATED TOPICS
Tracking Updates Overview
Working with RSS feeds
RSS Feed Macro
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 132
Using pre-specified RSS feeds
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
If you want to customise your Confluence RSS feed (e.g. use a label to filter your feed), use the RSS
Feed builder instead.
To subscribe to RSS feeds generated by Confluence, for a particular space
1. Click on the 'Browse Space' link for the space. This is located at the the top of every page and
beside the space link on the dashboard.
2. Go to the 'Advanced' tab and click on 'RSS Feeds'.
3. Copy and paste the link for one of the following feeds into your RSS newsreader:
• Pages
• News
• Mail
• Comments
• Attachments
• All content
To subscribe to RSS feeds generated by Confluence, for a particular page (where available)
1. Locate the following icon, which is available in the top-right corner of certain pages:
2. Copy and paste the icon's link into your RSS newsreader.
RELATED TOPICS
Using the RSS Feed Builder
Subscribing to External RSS Feeds
Tracking Updates Overview
Working with RSS feeds
RSS Feed Macro
Take me back to Confluence 2 Home
Comments
Copy and paste the link for one of the following feeds into your RSS newsreader:
•
•
•
•
•
•
Pages
News
Mail
Comments
Attachments
All content
Document generated by Confluence on Feb 08, 2007 14:05
Page 133
This only creates a file calles createrssfeed.action. I don't get any ursl to copy into may Feed reader.
What do I do with this file?
Posted by eld at Jan 31, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 134
Using the RSS Feed Builder
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Using the RSS feed builder, you can create customised RSS feeds to subscribe to changes within
Confluence.
More information about RSS Feeds.
To create a customised RSS feed,
1. Go to the dashboard and click on the RSS feed builder link
located below the list of spaces.
This will display a form as shown below.
2. Type of Content: Check the boxes to select one or more content types you want to subscribe to:
Pages, News Items, Mail, Comments, and Attachments.
3. Choose whether to sort items in your RSS feed by the date they were originally Created or the date
they were last Modified.
4. (Applies to pages only.) Choose whether your RSS feed should display the entire page content, or
just the updated content.
5. Select one or more spaces from the drop-down list. Press Ctrl + left mouse button to select multiple
spaces.
6. If you want to filter your RSS feed using a label, enter the label name in the input-field.
7. Choose the format for your RSS feed (if different from the default).
8. Specify the number of items you want displayed and from how far in back in time you want
Confluence to look.
9. Type a name for your RSS feed.
10. Click 'Create RSS Feed' when you are done. This will take you to a new screen. Drag or copy the
link displayed into your RSS reader.
Document generated by Confluence on Feb 08, 2007 14:05
Page 135
Document generated by Confluence on Feb 08, 2007 14:05
Page 136
RELATED TOPICS
RSS Feed FAQ
Tracking Updates Overview
Working with RSS Feeds
Take me back to Confluence 2 Home
Comments
All Here are some instructions I wrote up for using Confluence's RSS Feeds with the Opera Browser. I
couldn't get Firefox to work with the RSS feature – if someone could figure that out, I'd appreciate it
(please see my message and responses at
http://forums.atlassian.com/message.jspa?messageID=257222265#257222265).
Document generated by Confluence on Feb 08, 2007 14:05
Page 137
Also, feel free to move these instructions to a more appropriate location – I was not able to add a wiki
page.
- Keith Bennett
Using RSS and Opera to Receive Notification of Content
Changes
Confluence provides an easy way to receive notification of changes to all or part of the content data base.
It uses RSS as an industry standard means of providing this notification.
There are many software applications that can function as RSS clients (a list can be found here), but we
will focus on RSS-enabled web browsers since, assuming they are already installed, they do not require
installation of additional software. Although Firefox theoretically supports RSS, we have been unable to
get it to work. Until we fix this, we will assume the use of the Opera browser, a fine browser that can be
downloaded at http://www.opera.com/download/.
The process of setting up change notification can be broken down into the following major steps:
1. Creating an RSS link using Confluence software.
2. Configuring the RSS client (Opera) to use that link.
Creating the RSS Link
• Point your web browser to the Dashboard wiki page. (You can usually get there from any wiki page
by clicking "Dashboard" above the corporate logo in the upper left corner of the page.) Log in if you
are asked to do so.
• Click the Feed Builder link adjacent to the RSS icon at the lower left of the page.
• Fill in the desired values.
° You'll probably want to limit notification to a subset of the available spaces.
° You can use labels to limit your search if the pages have been labelled with keywords. Go here
to learn more about this and other uses of labels.
° We suggest you leave the feed format at RSS 2.0 unless you have a special need to do
otherwise.
• When you're done specifying these settings, click the Create RSS Feed button.
Configuring Opera With the RSS Link
If the above steps have worked correctly, you will now see a page entitled RSS Feed Created.
• Click the RSS 2.0 link in the middle of the page. Log in if you are asked to.
Document generated by Confluence on Feb 08, 2007 14:05
Page 138
• You will see a dialog box entitled New subscription. Click Yes to subscribe to the Confluence feed.
That's it. You're done. You will see a page with the recent changes. To view this page in the future, open
the Feeds menu from the browser's menu bar, and select the feed name you specified earlier.
Posted by keithrbennett at Dec 28, 2005.
.....................................................................................................................................................................
Clarification: In the above instructions, when I referred to "we", I meant my organization, and not
Atlassian.
- Keith
Posted by keithrbennett at Dec 28, 2005.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 139
Watching a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
When you watch a page, you are notified by email whenever the page is modified.
To watch a page, you require 'View' permission for the page.
To start watching a page,
1. Go to the page.
2. Click the 'Watch Page' icon
Watching Page' icon
located at the top of the screen. This will be replaced with the 'Stop
.
To stop watching a page,
1. Go to the page.
2. Click the 'Stop watching Page' icon
the 'Watch Page' icon
located at the top of the screen. This link will be replaced
.
Here is an example:
Handy Hint
You can manage your watches via the Notifications tab under your user profile settings.
RELATED TOPICS
Watching a Space
Managing Watches
Tracking Updates Overview
Browsing a Space
Document generated by Confluence on Feb 08, 2007 14:05
Page 140
Updating Email Address
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 141
Watching a Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
When you watch a space, you are notified by email whenever content is added to it or updated.
To start watching a space,
1. Click on the 'Browse Space' link for the space.
2. Go to the 'Advanced' tab. In the left panel, click on 'Start watching this space'. This link will be
replaced with a new link to 'Stop watching this space'.
To stop watching a space,
1. Click on the 'Browse Space' link for the space.
2. Go to the 'Advanced' tab. In the left panel, click on 'Stop watching this space'. This link will be
replaced with a new link to 'Start watching this space'.
Handy Hint
You can also stop watching a space via the Watches tab under user profile settings.
RELATED TOPICS
Watching a Page
Managing Watches
Tracking Updates Overview
Browsing a Space
Updating Email Address
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 142
Working with RSS Feeds
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
An RSS feed is a format for delivering summaries of regularly changing web content. Subscribing to an
RSS feed allows you to stay informed of the latest content from sites that you are interested in.
RSS isn't designed to be read in a regular web browser, but specialised RSS newsreader programs can
check RSS files every so often, and tell you what's new on a site.
Confluence works with RSS in two ways:
• Confluence generates its own RSS feeds for tracking updates to content within Confluence. You will
need an RSS reader which can grab the RSS feeds from Confluence and display them for you.
• Confluence's RSS macro allows you to display the contents of RSS feeds from other sites. In the
case of external RSS feeds, Confluence can act as a reader.
For a technical description of RSS, read Mark Pilgrim's "What is RSS?" article on XML.com.
RELATED TOPICS
Subscribing to RSS Feeds within Confluence
Subscribing to External RSS Feeds
Tracking Updates Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 143
User Profile Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Each user in Confluence has a user profile.
Click on the 'Preferences' link (or 'Profile' link, for Confluence versions prior to 2.3) located at the top
of every page below the 'breadcrumbs' to view your user profile.
The profile view is divided into the following five tabs:
View Profile:
• view your personal details and photograph (optional).
• view your profile information: group membership, site preferences, email notification preferences,
and user statistics (the date on which you signed up to the site, date of your last login, and the
number of pages you have authored).
Edit Profile:
•
•
•
•
•
edit your personal details (name and email address).
upload a profile picture (optional).
change your password.
choose your preferences (homepage, language and timezone).
subscribe to email notifications.
Labels:
• view your personal labels.
Watches:
• view a list of the pages and spaces you are currently watching.
Drafts:
• retrieve any pages you were in the process of editing.
Additionally, if you haven't yet set up your personal space, a 'Create Personal Space' link will be
available.
Document generated by Confluence on Feb 08, 2007 14:05
Page 144
RELATED TOPICS
Tracking Updates Overview
Setting up your Personal Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 145
Changing Password
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To change your Confluence password,
1. Click on the 'Preferences' link (or 'Profile' link, in Confluence versions prior to 2.3) located below
the breadcrumbs at the top of the page.
2. Click on the 'Edit Profile' tab.
3. Click the 'Password' link in the left-hand column.
4. Enter your current password and your new password in the form displayed.
5. Click 'Save' to save your changes.
RELATED TOPICS
Viewing User Profile
Editing User Profile
Uploading a Profile Picture
Setting up your Personal Space
Managing Watches
Updating Email Address
Email Address Privacy
Take me back to Confluence 2 Home
Comments
How does changing the password work when confluence is setup to validate against LDAP or jira users?
Posted by david_ruddock at May 26, 2006.
.....................................................................................................................................................................
Is it possible to prevent users from changing their passwords?
Posted by woz100 at Jan 04, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 146
Editing User Preferences
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can customise Confluence by choosing your site preferences — homepage, language and (in
Confluence version 2.3 and later) timezone.
To edit your user preferences,
1. Click on the 'Preferences' link (or 'Profile' link, in Confluence versions prior to 2.3) located below
the breadcrumbs at the top of the page.
2. Click on the 'Edit Profile' tab.
3. In the left-hand column, click the 'General' link (under 'Preferences').
4. Choose your preferences in the form that is displayed.
• Site homepage — choose the page that you would like to see whenever you login to
Confluence.
• Preferred language — choose your language.
• Timezone — choose your timezone.
5. Click 'Save' to save your changes.
Screenshot : Edit preferences
RELATED TOPICS
Editing User Profile
Uploading a Profile Picture
Setting up your Personal Space
Managing Watches
Email Address Privacy
Document generated by Confluence on Feb 08, 2007 14:05
Page 147
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 148
Editing User Profile
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Your User Profile contains basic information about you. If you do not have a personal space, your User
Profile will be displayed when your name is clicked in the People Directory.
To edit your user profile,
1. Click on the 'Preferences' link (or 'Profile' link, in Confluence versions prior to 2.3) located below
the breadcrumbs at the top of the page.
2. Click on the 'Edit Profile' tab. Enter details about yourself in the form that is displayed.
• Full Name - enter your name as you would like it to appear in your profile.
• Email - specify your email address which will be used when sending you mail notifications.
• Information about me - Enter information about yourself that other users can view (such as
your professional information, hobbies, and other interests). You can use Confluence markup in
this field.
3. Click 'Save' to save your changes.
Screenshot : Edit profile
Handy Hint
Confluence administrators can configure Confluence so that it masks email addresses (e.g.
'example at atlassian dot com'), protecting it from search engine spiders and the like.
Document generated by Confluence on Feb 08, 2007 14:05
Page 149
RELATED TOPICS
Viewing User Profile
Uploading a Profile Picture
Setting up your Personal Space
Managing Watches
Email Address Privacy
Take me back to Confluence 2 Home
Comments
Where is the 'Use Rich Text Editor' as default selection, was this removed?
Posted by danblack at Dec 14, 2005.
.....................................................................................................................................................................
Dan,
Since it is possible to make 'Rich Text' or 'Wiki Markup' default from the edit page itself, this option has
been removed from the profile screen.
Thanks for pointing it out. I have updated this page.
Cheers,
Vidya
Posted by vidya at Dec 14, 2005.
.....................................................................................................................................................................
Is there a way for administrators to edit other users' profiles? The idea is for our HR dept. to be
responsible for uploading users' pictures and information (i.e. department, manager, etc.).
Posted by etsai@edmunds.com at Mar 10, 2006.
.....................................................................................................................................................................
I'd like to second Eddie's request.
One other item of interest for our organization is to somehow link to the user picture. A great way to do
this would be in the [~username] macro, if this would display not an icon, but a small thumbnail of the
user's photo (I'd ask for a hover of the large photo, but then that would be picky).
Posted by mircea_botez@yahoo.com at Aug 31, 2006.
.....................................................................................................................................................................
Is there a way to have a large image size for the users profile? The thumbnail is way too small to view.
Also, anyway to setup a default page that would allow users to provide info about themselves? (i.e.
Hobbies, companies previously worked at, etc.)
Posted by manuel.bernal@vontu.com at Oct 31, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 150
Can users change their own username? Can administrators change a user username? Or is someone
forced to register with a new username?
Posted by abelfiore at Dec 28, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 151
Email Address Privacy
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence can mask the email addresses of users to protect them from mail spammers.
This is done by a site administrator and is configured through the Administration Console. The site
administrator has three options for email address privacy:
• Public: email addresses are displayed publicly.
• Masked: email addresses are still displayed publicly, but masked in such a way to make it harder
for spam-bots to harvest them.
• Private: only site administrators can see the email addresses.
Note
Anyone in the confluence-admin group will still be listed (with their email address) on the
administrators page, although their addresses will be masked.
RELATED TOPICS
Editing User Profile
Viewing User Profile
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 152
Linking to Personal Spaces and User Profiles
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to create a link to a user's personal space (or user profile).
You can link to a user's personal space (or user profile) easily if you know their username.
To link to a user's personal space,
What you need to type
Unknown macro: {nomarkup}
What you will get
[~username]
[~username]
If the user does not have a personal space, then the link will go to their user profile.
RELATED TOPICS
User Profile Overview
Setting up your Personal Space
Working with Links
Take me back to Confluence 2 Home
Comments
How do I link to news within a user's space from another space?
Posted by charlieperry@hotmail.co.uk at Dec 18, 2006.
.....................................................................................................................................................................
As far as I can tell, Charlie, this can't be done. News seems to be limited to one-space (there is no
spacekey parameter on the blog-posts tag). Maybe there's a way which isn't documented?
Posted by n.nayar@sap.com at Jan 05, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 153
Updating Email Address
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The email address you specify in your profile settings is used for your mail notifications and is also
displayed in your profile description.
To update your email address,
1.
2.
3.
4.
Click on the 'Profile' link located below the breadcrumbs at the top of your page.
Go to the 'Edit Profile' tab. This will bring up a form.
Enter your new email address in the 'Email' textbox.
Click 'Update'.
RELATED TOPICS
Changing Password
Editing User Profile
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 154
Uploading a Profile Picture
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Your profile picture is used as the icon for your personal space, and to represent you in the People
Directory. You may upload your own profile picture, or use one of the images provided by Confluence.
If you upload your own profile picture, it will be resized to 48x48 pixels.
To upload a profile picture,
1. Click on the 'Preferences' link located below the breadcrumbs at the top of the page. This will
display your profile.
2. Go to the 'Edit Profile' tab.
3. Click the 'Profile Picture' link.
4. Either:
a. To upload a picture, click the ' Browse' button to locate your picture, then click the 'Upload'
button.
or:
b. Select one of the icons provided.
Document generated by Confluence on Feb 08, 2007 14:05
Page 155
5. Click the 'Save' button.
RELATED TOPICS
Editing User Profile
Setting up your Personal Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 156
Viewing User Profile
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To view your user profile, click on the ' Profile' link located below the breadcrumbs at the top of the page.
The 'View' tab displays:
Profile Description - information you have entered about yourself and a photograph if you have
included one. See Screenshot 1.
Recently Edited - a list of ten items mostly recently edited by you.
Profile Summary - displays:
• 'Groups' to which you belong.
• Your notification 'Preferences' which are configured through the Edit Profile tab, and the homepage
for your site.
• Your 'User Statistics': the date on which you signed up to the site, date of your last login, and the
number of pages you have authored.
See Screenshot 2.
Here is an example. This is Charles' profile:
Screenshot 1 : Profile Description
Document generated by Confluence on Feb 08, 2007 14:05
Page 157
Screenshot 2 : Profile Information
Document generated by Confluence on Feb 08, 2007 14:05
Page 158
RELATED TOPICS
Editing User Profile
Managing Watches
Take me back to Confluence 2 Home
Comments
It's preferences link not profile link and its on the right hand side.
Posted by chengt@gmail.com at Oct 31, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 159
Working with Macros
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Macros perform programmatic functions within a page and can be used to generate complex content
structures or dynamic content.
Macros allow you to create markup or include dynamic content in a page that may not be possible using
Confluence notation. For example, the Attachments macro will list a page's attachments in the page itself,
so that readers do not have to visit the Attachments tab.
Generally speaking, a macro is simply a command wrapped inside curly braces {...}.
For instance, the Attachments Macro is written as:
{attachments}
Optional Parameters in Macros
For each macro, you can also have optional parameters that can often be combined to refine or control
the macro's output.
With attachments, for instance, you have two optional parameters:
• to specify the file formats of the attachments displayed.
• to choose whether or not you want old versions of the attachments displayed.
These optional parameters are included within the curly braces, following a colon, like this:
{attachments:patterns=.*jpg}
When specifying more than one parameter within the same macro, the pipe symbol is used to separate
one from the other, like this:
{attachments:old=true|patterns=.*jpg}
The macros currently available in Confluence are listed below. For each macro, all the optional
parameters are also listed with examples of their usage. To learn how to write your own macro, or use
macros written by other people, read the [Confluence Plugin Guide]
Confluence Macros
Attachments Macro
Displays a list of attachments belonging to the
current page.
Blog Posts Macro
Lists the most recent news items in the space.
Document generated by Confluence on Feb 08, 2007 14:05
Page 160
Children Display Macro
Code Block Macro
Content by Label Macro
Displays the children and descendants of the
current page.
Displays code in your document with the
appropriate syntax highlighting.
Renders a list of content associated with specific
labels
Create Space Button Macro
Renders a create space button linked to the create
space page.
Dynamic Tasklist Macro
Displays a dynamic task list which can be modified
in 'view' mode.
Excerpt Macro
Allows you to define a part of the page as the
page's 'excerpt' which is then used by other
macros to summarise a page's content.
Favourite Pages Macro
Displays a list of your favourite pages.
Excerpt Include Macro
Includes one page's excerpt in another.
Flowchart Macro
Gallery Macro
Global Reports Macro
Displays flowcharts and other diagrams composed
of shapes joined by lines.
Forms a thumbnail gallery of all images attached
to a page.
Renders a list of links to global reports within a
table.
IM Presence Macro
Displays graphically when a contact is online.
Include Page Macro
Inserts the contents of the specified page into the
current one.
JIRA Issues Macro
Displays a list of JIRA issues in a page.
JIRA Portlet Macro
Displays a JIRA dashboard portlet in Confluence.
JUnit Report Macro
Display a summary of JUnit test results.
[Layout Macros]
Format a page into columns.
Navmap Macro
Renders the list of pages associated with a
specified label as a navigable map.
Noformat Macro
Displays a block of text in monospace font.
Recently Updated Content Macro
Includes a list of recently changed content.
Recently Used Labels Macro
Related Labels Macro
RSS Feed Macro
Lists labels most recently used in a specified scope
(Global, Space, or Personal)
Lists labels frequently appearing on the same
pages as the current page's labels.
Displays the contents of an RSS feed.
Search Macro
Searches Confluence, and includes the results in
the page.
Space Details Macro
Includes the summary of a Confluence space in
the page.
Document generated by Confluence on Feb 08, 2007 14:05
Page 161
Spacegraph Macro
Displays a chart of the pages in a space and their
connections.
Spaces List Macro
Displays a list of all spaces visible to the user.
Thumbnail Macro
Creates a thumbnail of an inline image.
Userlister Macro
Displays a list of Confluence users, from an
optional group.
Welcome Message Macro
Includes the Confluence site welcome message.
RELATED TOPICS
Confluence Notation Guide Overview
[Confluence Plugin Guide]
Take me back to Confluence 2 Home
Comments
This page doesn't include all macros. For example: {color} and {html}.
Where is there an actual consolidated list of all default macros with help?
Posted by rwarren@picarro.com at Feb 07, 2006.
.....................................................................................................................................................................
The full notation guide on the Wiki Markup editor tab (to the left of the editor) shows a great deal more
information on various macros like {note} and {panel} and {section} and stuff. I am not sure if it is
exhaustive but there is lots of good info there.
Posted by jay.guidos@petlynx.net at Mar 16, 2006.
.....................................................................................................................................................................
Let me echo Russell's request. Please add documentation for those tags. THanks.
Posted by bclee at Apr 20, 2006.
.....................................................................................................................................................................
Adaptavist maintains fairly good documentation on their macros, as well as some of the bundled macros.
Posted by bhyman at Jul 11, 2006.
.....................................................................................................................................................................
Messed up my Adaptavist link, sorry.
Posted by bhyman at Jul 11, 2006.
.....................................................................................................................................................................
FYI, we'll be doing a massive overhaul of our macro documentation once our Builder 2.0 theme is
released, basically to improve usability using some of the new features in the theme.
Document generated by Confluence on Feb 08, 2007 14:05
Page 162
Posted by gfraser at Jul 11, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 163
Blog Posts Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Blog Posts Macro allows you to display a space's news items within a page. Clicking on the title of
the news item opens it up in a new window.
Blog Posts Macro
What you need to type
What you will get
Unknown macro: {nomarkup}
Tuesday, 20 September 2005
Tuesday, 20 September 2005
Test News
Test News
asas
asas
Posted at 20 Sep @ 8:43 PM by
Posted at 20 Sep @ 8:43 PM by
vidya |
4
4
comments | Edit
comments | Edit
Friday, 26 August 2005
vidya |
Friday, 26 August 2005
Sample News
Sample News
This is a sample news item for the Documentation
Space.
Posted at 26 Aug @ 1:48 AM by
vidya |
This is a sample news item for the Documentation
Space.
Posted at 26 Aug @ 1:48 AM by
0
comments | Edit
Friday, 8 July 2005
Test News
Last changed: Aug 11, 2005 23:26 by vidya
vidya |
0
comments | Edit
Friday, 8 July 2005
Test News
Last changed: Aug 11, 2005 23:26 by vidya
Sample News
Sample News
Posted at 08 Jul @ 12:48 PM by
Posted at 08 Jul @ 12:48 PM by
admin |
admin |
2 comments | Edit
2 comments | Edit
Optional Parameters
No
parameter
Default
1
no
2
content
excerpts
Display the content in
its entirety, as short
excerpts, or as a list of
titles
3
time
none
Specify from how far
back in time you want
items displayed
Document generated by Confluence on Feb 08, 2007 14:05
15
Description
Specify the number of
posts you want
displayed
Page 164
4
labels
none
To display content with
specified labels
Optional Parameters
1. Specify the number of posts you want displayed
{blog-posts:1}
2. Display the content in its entirety, as short excerpts, or as a list of titles
Excerpts
{blog-posts:5|content=excerpts}
Titles
{blog-posts:5|content=titles}
3. Choose from how far back in time you want items displayed
For example, "time=12h" would display those items created in the last twelve hours, and "time=7d"
would show items made in the last week. (The default is no limit)
Hours
{blog-posts:time=12h}
Days
{blog-posts:time=7d}
4. Filter items using labels
• To display content with any of the specified labels
The following code will display items that contain either of the labels, 'atlassian' or 'confluence'
{blog-posts:labels=atlassian,confluence|}
Document generated by Confluence on Feb 08, 2007 14:05
Page 165
• To display content with all of the specified labels
The following code will display content with both labels 'atlassian' and 'confluence'
{blog-posts:labels=atlassian,confluence|match-labels=all}
5. Filter items using a user name
• To display content associated to a particular user
The following code will display the first 10 items posted by a user.
{blog-posts:10|spaces=~username}
6. Filter items by combining parameters
The following code will display the first 10 items posted by a user from a particular space as a list.
{blog-posts:10|spaces=space name,~username|content=title}
RELATED TOPICS
Working with Macros
Working with News Overview
Take me back to Confluence 2 Home
Comments
Is there any way to constrain the formating of the display for this macro? It's pretty messy if you've got it
in a list. The title, for example is huge.
Posted by doggy@doggy.com at Dec 26, 2005.
.....................................................................................................................................................................
Why I can't add this macro to page that is part of another page? I am getting error "Unable to render
(blog-posts) Already included page...."? Everything works with contentbylabel macro... except that
macro doesn't suit my need...
Posted by ajevic at Feb 06, 2006.
.....................................................................................................................................................................
Is there a way to display only the blog item titles without the table header?
Document generated by Confluence on Feb 08, 2007 14:05
Page 166
Also, it would be nice if you could choose the order and types of content displayed. For example you
might setup the macro to handle this:
Title
Author
Date Posted
Test News
vidya
Sep 20, 2005 20:43
Sample News
vidya
Aug 26, 2005 01:48
Test News
admin
Jul 08, 2005 12:48
Posted by dnagoda at Apr 07, 2006.
.....................................................................................................................................................................
Oops! Previous macro call wasn't escaped. Should have looked like this:
{blog-posts:content=user-defined| fields=date, title}
Posted by dnagoda at Apr 07, 2006.
.....................................................................................................................................................................
Here's a bug. When I use the macro like this...
{blog-posts:4|content=excerpts}
... I don't actually get the 4 most recent posts. The "most recent" post is actually from a couple of weeks
ago. The other three are the most recent. What's up with that?
/carlos
Posted by carlosp at Jun 10, 2006.
.....................................................................................................................................................................
How do we limit the blogposts to a specific space or ask it to show news from all spaces?
Also, it seems to over-cache - delete a post from a space yet it still lingers in the blog-posts macro for
ages...
Posted by gfraser at Jul 26, 2006.
.....................................................................................................................................................................
How can we style the blog-posts....change the css for the macro?
thnx,
steve
Posted by steves at Aug 15, 2006.
.....................................................................................................................................................................
Hi,
This macro doesnt appear to be working correctly- it doesnt update with the latest posts, and sometimes
skips some old ones too. It is very random in this behaviour. Any ideas?
Document generated by Confluence on Feb 08, 2007 14:05
Page 167
Posted by tom_crowder@hotmail.com at Aug 15, 2006.
.....................................................................................................................................................................
Thomas, that sounds like an unusual problem. Could you please raise a support request with some
screenshots and details of your problem?
Posted by mryall at Aug 16, 2006.
.....................................................................................................................................................................
It's over-caching - we've noticed the same sort of thing and so have our clients, eg:
• add a new post and it doesn't show up for an hour or so
• delete a post and it's still shown
When the cache eventually clears down, it obviously shows the correct information, but while that cache
is in place people get confused because the blog-posts macro is not accurately reflecting the actual blog
posts.
Posted by gfraser at Aug 16, 2006.
.....................................................................................................................................................................
Hi,
I need to format the output of this macro for one space. I tried a if ($helper.spaceKey == <myspace>)
to do the formatting in lastblogs.vm, however it does not seem to be able to get the $helper object.
Anyone who knows how to get the spacekey from within the .vm file? (I did try the #set ($helper =
params.get("helper")) as in page.vmd, but that did not work
Posted by solfrid.hengebol@accenture.com at Sep 14, 2006.
.....................................................................................................................................................................
Is it possible to add a parameter to only show news from a specific user?
Posted by achambers@relic.com at Sep 27, 2006.
.....................................................................................................................................................................
Yes, I am updating this documentation now.
Posted by ivan@atlassian.com at Dec 05, 2006.
.....................................................................................................................................................................
I noticed that the HTML for the Title column's heading specifies width="70%" (Confluence 2.3). This is not
appropriate when the Author and Date posted column values are about the same length as the title. Web
browsers are perfectly good at table layout so I don't see the point of this.
Posted by peter.hilton at Jan 15, 2007.
.....................................................................................................................................................................
Feature request: New parameter for specifying start (and stop) times, so it will be possible to list the
most recent posts with excerpts and the older ones with just titles:
Document generated by Confluence on Feb 08, 2007 14:05
Page 168
h2. News the last 7 days
{blog-posts:15|time=7d|content=excerpts}
h3. News the last month (excluding the last 7 days which are listed above)
{blog-posts:15|starttime=7d|time=30d|content=excerpts}
http://jira.atlassian.com/browse/CONF-7672
Posted by cl@escenic.com at Jan 16, 2007.
.....................................................................................................................................................................
I'm finding the spaces=~username parameters isn't working. Is this also a caching issue, or is there are
required version for this macro?
Posted by cbbarkin at Feb 02, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 169
Children Display Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
Use the Children Display Macro to display the children and the descendants of a page.
Note that only pages to which you have 'View' permission will be displayed.
Children Display Macro
What you need to type
Unknown macro: {nomarkup}
What you will get
• Child Page 1
• Child Page 2
• Child Page 1
• Child Page 2
Optional Parameters
No
parameter
Default
Description
1
all
true
Display all descendants
2
page
current
Specify which page to
display children for in a
current space or in a
different space
3
depth
none
Specify the depth of
descendents to display
4
first
none
Restrict the number of
children displayed at the
top level
5
style
none
Specify the style in
which descendants are
displayed
6
excerpt
false
Display the child pages'
excerpts, if they exist
sort=creation
sort=title
sort=modification
recent
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
7
Document generated by Confluence on Feb 08, 2007 14:05
Page 170
and 'modified' to sort of
last modification date.
1. Display all descendants of the page
{children:all=true}{nomarkup}
2a. Specify which page to display children for
{children:page=page name}
2b. Specify which page in a different space to display children for
{children:page=space key:page name}
3. Specify the depth of descendants
{children:depth=2}
4. Restrict the number of children displayed at the top level
{children:first=x}
5. Specify the style in which descendants are displayed
Choose from heading levels h1 to h6.
{children:depth=1|style=h3}
6. Display the child pages' excerpts, if they exist
{children:depth=2|excerpt=true}
7. Sort children by creation date, modification date or title
{children|sort=creation|reverse=true}
Document generated by Confluence on Feb 08, 2007 14:05
Page 171
If the page parameter is '/', then the macro will list all the current space's "top level" pages –
those without parents. If the page parameter is a space key followed by a
colon (e.g {children:page=DOC:}), then the top level pages of that space will be listed.
RELATED TOPICS
Working with Page Families
Working with Macros
Take me back to Confluence 2 Home
Comments
It would be nice if in addition to "excerpt=true" you could do "include=true" that would include the fully
rendered content of the children pages. This would simplify allowing multiple authors updating content
for a single page (by breaking it up into parts, attached as childrem).
Posted by marvingreenberg at Dec 06, 2005.
.....................................................................................................................................................................
Will support be added so that only children with a particular label are listed?
e.g.
Unable to render {children} Can only find children for a page, this is a comment
Posted by thomasvdv at Jan 10, 2006.
.....................................................................................................................................................................
again:
{children:label=somelabel, anotherlabel}
Posted by thomasvdv at Jan 10, 2006.
.....................................................................................................................................................................
Thomas,
There is already a feature request for this: http://jira.atlassian.com/browse/CONF-4645. If you would like
to see this feature included in Confluence, please vote for it.
Vidya
Posted by vidya at Jan 10, 2006.
.....................................................................................................................................................................
Just as an FYI for anyone monitoring this page, there is a syntax error in the bullet 7 code-block. The
children macro keyword ought to be followed by a colon (:), not a pipe (|).
Posted by thadras at Mar 22, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 172
Setting excerpt=true doesn't seem to work properly when the excerpt on the target page has content
within the excerpt on more than one line. The children macro only shows the first line. Is this a bug? For
example:
{excerpt}
Test1
Test2
{excerpt}
The children macro will only show Test1...why is this?
Posted by btknorr@gmail.com at Apr 05, 2006.
.....................................................................................................................................................................
It's expected behaviour - there are many macros such as {children} and {pagetree}, etc., that display
excerpts and in order to ensure consistent results various things are excluded from the excerpts:
• Only the first line is shown, other lines are ignored
• Images and macros within excerpts are not displayed for aesthetic, usability and security reasons
Posted by gfraser at Apr 05, 2006.
.....................................................................................................................................................................
Would it be possible to make this configurable? Maybe have an option to include all the lines within an
excerpt? If so, maybe we could even specify a delimiter for how multiple lines are display for the children
macro. So if the delimiter is a space then the expert above would display as Test1 Test2...thoughts?
Posted by btknorr@gmail.com at Apr 05, 2006.
.....................................................................................................................................................................
In general I need a way to pull in the full excerpt (not just the first line) from multiple pages and list
them all. I would like to use the standard "excerpt" tag, but it doesn't look like I can. I guess the
meta-data plugin is the way to go.
Thanks.
Posted by btknorr@gmail.com at Apr 06, 2006.
.....................................................................................................................................................................
Latest addition to this macro : You can display children for pages within different wiki spaces.
*{children:page=<Spacekey>:<Page Name>}*
Following code will display output as follows:&nbsp;
*{children:page=*CODEGEIST*:*Atlassian Codegeist*}*
Unable to render {children} Page not found: *CODEGEIST*:*Atlassian Codegeist*
Posted by rakadam at Jul 16, 2006.
Document generated by Confluence on Feb 08, 2007 14:05
Page 173
.....................................................................................................................................................................
You can use the Content by Label Macro instead, eg
{contentbylabel:troubleshooting-faq|showLabels=false|maxResults=99|showSpace=false}
Posted by david.soul@atlassian.com at Sep 18, 2006.
.....................................................................................................................................................................
Hi,
Please, can you tell me where i can find the source code of this macro ?
For my confluence i wish to have the same result but with a 'add page' link next to the first level of
'children' . The parent page must be each first level.
Thks
Posted by gludenglu at Oct 12, 2006.
.....................................................................................................................................................................
Hi, new query...
I am keen to know, is it possible for Children Macro to know how many children are in its output.
What I am looking for is a Link only to show if the Children macro actually contains something. i.e. based
on permissioning the children macro may contain a variable number of 'children', however if that value is
'zero' then there i no need to show the link at all.
There is probably another way to handle this, but I thought I would start here.
Posted by guyh@ncompass.co.uk at Oct 13, 2006.
.....................................................................................................................................................................
Its in the Confluence source, let me know if you need to know the specific class (it should be easy to find
by searching).
Posted by david.soul@atlassian.com at Nov 08, 2006.
.....................................................................................................................................................................
The Content by Label macro won't work if you only want to list the pages that are children with a
matching label. The Content by Label macro will list all pages that match that label for a Space or all
Spaces.
Posted by david.head@honeywell.com at Dec 06, 2006.
.....................................................................................................................................................................
Does the children macro filter out children that are not accessible to the current user because she has no
permission to read them?
If it doesn't, how easy would it be to modify the macro to take permissions into account?
Document generated by Confluence on Feb 08, 2007 14:05
Page 174
Posted by u.cei@sourcesense.com at Jan 19, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 175
Child Page 1
This page last changed on Aug 14, 2005 by vidya.
Document generated by Confluence on Feb 08, 2007 14:05
Page 176
Grandchild
This page last changed on Aug 14, 2005 by vidya.
Document generated by Confluence on Feb 08, 2007 14:05
Page 177
Child Page 2
This page last changed on Aug 14, 2005 by vidya.
Document generated by Confluence on Feb 08, 2007 14:05
Page 178
Code Block Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Code Block Macro allows you to display source code in your document with the appropriate syntax
highlighting.
You can specify the programming language. Confluence currently supports Java, XML and SQL with Java
being the default language for this macro.
Code Block Macro
{code:language} ... code ... {code}
OR
{code} ... java code ... {code}
Example 1: Java
What you need to type
{code}
public String getFoo()
{
return foo;
}
{code}
What you will get
public String getFoo()
{
return foo;
}
Example 2: XML
What you need to type
{code:XML}
<test>
<another tag="attribute"/>
</test>
{code}
What you will get
<test>
<another tag="attribute"/>
</test>
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
How about a feature to have line numbers in the code block that you can toggle on and off?
Document generated by Confluence on Feb 08, 2007 14:05
Page 179
For example: http://wiki.apache.org/geronimo/CodingStandards#
Posted by ed@edhorne.com at Jan 18, 2006.
.....................................................................................................................................................................
This page would do well to declare a list of supported languages.
Posted by tezza at May 08, 2006.
.....................................................................................................................................................................
Here's more detailed documentation: http://www.adaptavist.com/display/USERGUIDE/code+macro
Note that in Confluence 2.2, there is a new Code Formatter plugin so it's possible that there may be other
languages supported at a later date.
Posted by gfraser at May 08, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 180
Create Space Button Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The Create Space Button Macro renders a create space icon that links to the 'create space' page.
To display this icon, you require 'Create Space' permission which is assigned by a site administrator from
the Administration Console. See Security or contact a site administrator for more information.
Create Space Button Macro
What you need to type
What you will get
Unknown macro: {nomarkup}
Optional Parameter
No
1
parameter
size
Default
small
Description
Specify whether to use
small or large icon
Specify the size of the icon displayed
What you need to type
What you will get
Unknown macro: {nomarkup}
RELATED TOPICS
Setting up a New Global Space
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 181
Dynamic Tasklist Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Dynamic Tasklist Macro displays a task list which can be modified in the page as it is viewed.
Optionally, you can specify the name of the task list name.
Dynamic Tasklist Macro
What you need to type
What you will get
Unknown macro: {nomarkup}
Tasks: thingsToDo
Add Task:
Live Example
Here is a live example of the dynamic task list in operation. Play with it! Add new tasks, complete or
uncomplete tasks, grab the handles on the right hand side to reorder your tasks.
Error formatting macro: dynamictasklist: com.thoughtworks.xstream.converters.ConversionException:
Cannot deserialize object with new readObject()/writeObject() methods ---- Debugging information ---required-type : java.util.Collections$SynchronizedRandomAccessList class :
com.atlassian.confluence.extra.dynamictasklist.model.TaskList line number : 3 path :
/com.atlassian.confluence.extra.dynamictasklist.model.TaskList/tasks ------------------------------RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
The name of the tasklist can't contain spaces. If you do use a space, the tasklist won't work.
Posted by woefdram at Dec 22, 2005.
.....................................................................................................................................................................
I really like this feature. One thing I don't think I can live without though is the ability to edit a task.
Any idea on when this will be available?
Document generated by Confluence on Feb 08, 2007 14:05
Page 182
Posted by btknorr@gmail.com at Dec 28, 2005.
.....................................................................................................................................................................
Very interesting enhancement to the basic Tasklist macro, that it's changeable and that it indicates who
added the item.
It's still my first day trying out Confluence (though I got pretty into TWiki a few years back) and I'm very
impressed.
I'm really looking for a macro to aid in showing summaries from children pages that shows something like
the excerpt and page status value, where you could indicate a status of Open, Hold or Closed. Hopefully
I'll find something in either search or children?
Posted by stews at Mar 21, 2006.
.....................................................................................................................................................................
Take a look at the [CONFEXT:Metadata Plugin] - might not be exactly what you're after, but could prove
better for your needs.
Posted by gfraser at Mar 21, 2006.
.....................................................................................................................................................................
Also a button to clear all would be handy. We'd like to use this for a daily task list.
Posted by todd_rinaldo at May 31, 2006.
.....................................................................................................................................................................
I like this macro. But i found sth wrong. When I used this macro in my global template under view mode
or preview mode, I can see a line of word "". But when I add a new page by this template , it works very
well. Also it's not a very big problem, I really expect Confluence can be perfect. My confluence version is
"Version: 2.2.9 Build:#527 ## 07, 2006"
Posted by bryanzk at Oct 26, 2006.
.....................................................................................................................................................................
Use an underscore "_" instead of a space in the title.
It is displayed as a space.
Posted by gbheyd at Nov 06, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 183
Excerpt Include Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The Excerpt Include Macro is used to display one page's excerpt in another.
To use this macro, the excerpt must have been defined using the Excerpt Macro and both pages must
exist in the same space.
Excerpt Include Macro
What you need to type
What you will get
Unknown macro: {nomarkup}
Excerpt Macro
Excerpt Macro
Optionally,
Remove the panel
By default, the excerpt is displayed within a panel. A value of "nopanel=true" displays the excerpt without
the panel.
{excerpt-include:Home|nopanel=true}
RELATED TOPICS
Excerpt Macro
Working with Macros
Take me back to Confluence 2 Home
Comments
I am trying to take an excerpt from one space page and have that excerpt appear in another space's
page. Is this possible? I can use an include in this instance and it works, but there are two lines of text I
want to leave out in the new space. Is there any other way to take a mirror image of part of a page and
paste it in another space's page without storing this data in two spaces? Ideally I want to be able to edit
this from the orignal space page and have those edits automatically appear in the new space.
Posted by frinzlja@ugcorp.com at Jan 29, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 184
Excerpt Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The excerpt macro is used to mark a part of a page's content as its summary. By itself, the excerpt
macro does not change the display of a page. However, defining an excerpt enables other macros such as
'excerpt-include' and 'blog-posts' macros to display a summary of a page's content.
You can only have one excerpt for a page.
Excerpt Macro
{excerpt}A short summary of this page{excerpt}
Optionally,
Hide the contents of the excerpt
{excerpt:hidden=true}A short summary of this page{excerpt}
RELATED TOPICS
Excerpt Include Macro
Working with Macros
Take me back to Confluence 2 Home
Comments
Please add support for embedding other macros inside the excerpt macro...for example:
This is a test for {include:Test Page}
Posted by btknorr@gmail.com at Mar 09, 2006.
.....................................................................................................................................................................
The example didn't show up correctly...here it is:
{excerpt}This is a test for{include:Test Page}{excerpt}
Posted by btknorr@gmail.com at Mar 09, 2006.
.....................................................................................................................................................................
No, please don't - having macros rendering inside excerpts would be a nightmare - all kinds of macros
now display excerpts and to have things randomly breaking, not to mention the obvious security risks of
being able to inject macros in to unexpected places, would be quite painful.
Document generated by Confluence on Feb 08, 2007 14:05
Page 185
Posted by gfraser at Mar 09, 2006.
.....................................................................................................................................................................
Actually macros rending inside excerpts is already supported when using the excerpt-include macro...it
doesn't work with the contentbylabel macro...so this is really where I would like to see the additional
support.
Posted by btknorr@gmail.com at Mar 09, 2006.
.....................................................................................................................................................................
Note that you could use the [Metadata plugin] to do what you are after...
Posted by gfraser at Mar 09, 2006.
.....................................................................................................................................................................
The {excerpt-include} macro is manually added to pages so you get to see the results and have control
over it. If macros started rendering inside "lists" that show excerpts, it would be a very huge nightmare
for the vast majority of our clients.
Posted by gfraser at Mar 09, 2006.
.....................................................................................................................................................................
I understand...that makes sense...I will try out the metadata macro...thanks!
Posted by btknorr@gmail.com at Mar 09, 2006.
.....................................................................................................................................................................
The metadata plugin is awesome...this is definitely the direction to go...I would love to see this plugin
become standard in Confluence....thanks.
Posted by btknorr@gmail.com at Mar 10, 2006.
.....................................................................................................................................................................
Fear not - we're working on a solution to everyone's plugin woes
Will be released to CONFEXT
sometime today we hope... Stay tuned...
Guy
http://adaptavist.com
Posted by gfraser at Mar 10, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 186
Favourite Pages Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Use the Favourite Pages Macro to display a list of your favourite pages.
Favourite Pages Macro
What you need to type
Unknown macro: {nomarkup}
Favourite Pages
There are currently no pages on your favourites
list. You can add pages to this list by clicking on
the top right of the page you're viewing.
What you will get
Favourite Pages
There are currently no pages on your favourites
list. You can add pages to this list by clicking on
the top right of the page you're viewing.
Optional Parameters
1. Specify the maximum number of results to be displayed
{favpages:maxResults=5}
RELATED TOPIC
Working with Favourites Overview
Working with Macros
Take me back to Confluence 2 Home
Comments
Is it possible to list favorite pages without the default header?
Posted by thomasvdv at Dec 15, 2005.
.....................................................................................................................................................................
Thomas,
Currently, this is not possible, but I have created a feature request [here].
Posted by vidya at Dec 15, 2005.
.....................................................................................................................................................................
This macro doesn't appear in the notation guide - I've looked a couple of times but could not see it
mentioned when viewing "All" items in the guide?
Document generated by Confluence on Feb 08, 2007 14:05
Page 187
Posted by gfraser at Feb 10, 2006.
.....................................................................................................................................................................
this macro is part (a module) of a macro-plugin called "Advanced Macros" which ships at least with
confluence 2.1.4 (see dashboard > administration > plugins). though some of these Advanced Macros are
actually in the notation guide
Posted by oliver.schormann@glonz.com at Mar 03, 2006.
.....................................................................................................................................................................
Is it possible for the Confluence administrator to change the spelling of "favourite" to "favorite"? If so,
where can you accomplish this task?
Posted by judy_sing@gap.com at Aug 15, 2006.
.....................................................................................................................................................................
I have the same issue - any way to change the spelling to "favorite"
Same issue with "Colour Scheme" - would like to change to "Color Scheme".
Posted by mikes at Aug 29, 2006.
.....................................................................................................................................................................
Did this get resolved?
Posted by jguthrie at Nov 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 188
Flowchart Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Flowchart Macro displays flowcharts or other diagrams composed of shapes joined by lines.
Flowchart Macro
{flowchart}
A -> B
{flowchart}
Important
This macro requires that GraphViz is installed. You should perform the default installation for your
operating system.
Make sure that your PATH includes the directory containing the graphviz 'dot' executable, and that
Confluence has been restarted so that it 'sees' the new PATH.
On Windows,
• Set the path in the Control Panel, under System Properties > Advanced > Environment
Variables. Choose the system variable 'Path' and make sure that C:\Program
Files\ATT\Graphviz\bin is included (assuming you installed Graphviz in the default location).
• After setting this, restart Confluence so that Confluence sees the new PATH value.
On Linux or Unix,
• Make sure that the user who runs Confluence has a PATH which includes the directory that 'dot' has
been installed into.
For details on composing diagrams, see the GraphViz Documentation.
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
Where should I get the jar including workflow chart macro?
Posted by yxt168118 at Apr 11, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 189
[DOC:Flowchart Macro] has more info.
Posted by bob.swift@charter.net at Apr 11, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 190
Gallery Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Gallery Macro creates a gallery of thumbnails from all the images that are attached to a page and
displays them in a tabular format. Clicking on the thumbnail opens up the full-size image in a new
window. You can also view the images as a slideshow by clicking the 'View as Slideshow' link located
below the title.
You can specify a title for the gallery and also configure how many columns you want for the table in
which your images are displayed. Confluence automatically displays the corresponding comment below
the image.
Confluence only creates thumbnails of images in these file formats:gifs, pngs and jpegs. The bmp format
is not supported.
To use the gallery macro, simply include the following markup in your page and replace the title with your
own.
Gallery Macro
What you need to type
{gallery:title=Some office photos, and a waterfall}{gallery}
What you will get
Some office photos, and a waterfall
(view as slideshow)
Here is
the
waterfall
photo
Here&apos;s
an
office
photo
The default number of columns for the table is 4.
Document generated by Confluence on Feb 08, 2007 14:05
Page 191
Optional Parameter
No
parameter
Default
Description
1
columns
4
Specify the number of
columns for your table
2
slideshow
true
Disable slide show
option
Specify the number of columns for your table
{gallery:columns=3|title=Some office photos, and a waterfall}{gallery}
Disable slide show option
By default, Confluence displays the link to view the images as a slideshow. To disable this link, include
the following code within the macro:
{gallery:slideshow=false}
RELATED TOPICS
Displaying an Image
Thumbnail Macro
Attaching Files to a Page
Editing Attachment Details
Working with Macros
Take me back to Confluence 2 Home
Comments
This gallery macro is great!
Is it possible to control the order of the photos' display? It looks like it goes in the order in which the files
were attached to the page.
If it is not possible to modify the gallery macro, is it possible to support changing the order of the files in
the attachments collection? I suppose I could remove them all, and then add them in the desired order,
but I would like to avoid that if possible.
Thanks,
Keith
Posted by keithrbennett at Dec 30, 2005.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 192
There is a feature request already open on Atlassian's JIRA. If you can comment and vote for it, that
would help raise the priority of this request.
Posted by gfraser at Dec 31, 2005.
.....................................................................................................................................................................
I to like this feature, just wondering how I would control the size of the window opened for the photos.
I have tried making the photos smaller in size, but they still open in a window larger than my screen.
Am I missing something?
Allan
Posted by allan.d.voltz@boeing.com at Mar 14, 2006.
.....................................................................................................................................................................
What mechanism/algorithm is used to determine the order? I appreciate that there is currently no
support for specifying this manually but if i knew the algorithm i could change the attachment names to
get the order i want...
Posted by skaze at Jun 22, 2006.
.....................................................................................................................................................................
Just voting for John's question. I tried to create a slideshow out of a powerPoint presentation, but the
slides are stubbornly show in wrong order. Best option would be to have a parameter to deceide whether
you want the pictures to be shown in alphabetical order, according the time of creation or in another
order.
-Tomi Nummi
Posted by tomi.nummi@sulake.com at Aug 23, 2006.
.....................................................................................................................................................................
Agreed, some help here would be good. I've tried ensuring the alphabetical order and upload order but it
completely refuses to the pics in any kind of useful order. I had to resort to listing the thumbnails myself:
!image1.gif|thumbnail! !image2.gif|thumbnail! !image3.gif|thumbnail!
Thus losing the great extras of the gallery (slideshow, auto inclusion of new images).
How does it decide?
Posted by xurf at Sep 08, 2006.
.....................................................................................................................................................................
It would be nice to have clearer information for newbies about how this macro is to be used. Such as, the
images displayed are taken from attachments (i.e. nothing goes between {gallery} and {gallery}). Also,
picture titles come from the attachment comment field.
Document generated by Confluence on Feb 08, 2007 14:05
Page 193
Posted by cjackson@ci.tacoma.wa.us at Oct 06, 2006.
.....................................................................................................................................................................
Hmmm... A closer reading reveals that this information is included. However, I do think it could be made
a little clearer for beginners.
Posted by cjackson@ci.tacoma.wa.us at Oct 06, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 194
Global Reports Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Global Reports macro renders a list of links to global reports.
These include:
• A list of all orphaned pages in the site.
• A list of all undefined links in the site.
• RSS feeds for new pages and news items.
Global Reports Macro
What you need to type
Unknown macro: {nomarkup}
Global Reports
New or updated pages since your last login
Find all pages that aren't linked from anywhere
Find all undefined pages
Feed for new pages or new blogs
What you will get
Global Reports
New or updated pages since your last login
Find all pages that aren't linked from anywhere
Find all undefined pages
Feed for new pages or new blogs
Optional Parameters
Specify the width of the table in which the links are displayed
{global-reports : width=50%}
By default, the table width is set to 99%.
RELATED TOPICS
Subscribing to RSS Feeds within Confluence
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 195
IM Presence Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The IM macros indicate graphically when a contact is signed into one of the following Instant
Messenging services:
• Yahoo
• AIM
• ICQ.
Yahoo! Presence Macro
What you need to type
What you will get
{yahoo:myYahooId}
If online
{yahoo:myYahooId}
If offline
AIM Presence Macro
What you need to type
What you will get
{aim:myScreenName}
If online
{aim:myScreenName}
If offline
ICQ Presence Macro
What you need to type
{ icq:icqnumber}
{ icq:icqnumber}
What you will get
If online
If offline
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
Can you add the msn here?
Posted by yxt168118 at Apr 11, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 196
This noe has support for MSN: http://confluence.atlassian.com/display/CONFEXT/IM+Presence+Plugin
Posted by cl@escenic.com at Oct 11, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 197
Include Page Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Include Page Macro allows you to display the contents of one Confluence page in another.
To display a page's contents, you require 'View' permission for that page. This is assigned by a space
administrator from the Space Administration screens. See Space Permissions or contact a space
administrator for more information.
Include Page Macro
What you need to type
Unknown macro: {nomarkup}
What you will get
Start of sample page content
Start of sample page content
Lorem ipsum dolor sit amet, consectetuer
adipiscing elit. Aliquam fermentum vestibulum est.
Cras rhoncus. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac
turpis egestas. Sed quis tortor. Donec non ipsum.
Mauris condimentum, odio nec porta tristique,
ante neque malesuada massa, in dignissim eros
velit at tellus. Donec et risus in ligula eleifend
consectetuer. Donec volutpat eleifend augue.
Integer gravida sodales leo. Nunc vehicula neque
ac erat. Vivamus non nisl. Fusce ac magna.
Suspendisse euismod libero eget mauris.
Lorem ipsum dolor sit amet, consectetuer
adipiscing elit. Aliquam fermentum vestibulum est.
Cras rhoncus. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac
turpis egestas. Sed quis tortor. Donec non ipsum.
Mauris condimentum, odio nec porta tristique,
ante neque malesuada massa, in dignissim eros
velit at tellus. Donec et risus in ligula eleifend
consectetuer. Donec volutpat eleifend augue.
Integer gravida sodales leo. Nunc vehicula neque
ac erat. Vivamus non nisl. Fusce ac magna.
Suspendisse euismod libero eget mauris.
End of sample page content
End of sample page content
Where:
'Sample Include Page' is the title of the page whose contents you want to display.
Optional Parameter
Display contents of a page located in another space
{include:ds:Confluence Overview}
Where:
Document generated by Confluence on Feb 08, 2007 14:05
Page 198
'DS' is the spacekey of the other space.
'Confluence Overview' is the name of the page whose contents you want to display.
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
Are these includes cached as part of regular page caching?
Posted by bagheera at Mar 30, 2006.
.....................................................................................................................................................................
In order to provide users of my wiki space with something to read and review offline on the train (!), I
created a page which used the {include} macro to create a page made up of multiple other pages,
effectively:
{include:chapter 1}
{include:chapter 2}
{include:chapter 3}
...
The export page to PDF option (icon at top right of screen works well for the text - but it omits any
images on the included pages. Is this a bug? or a feature?
The individual pages (chapter 1, chapter 2, etc) export to PDF with images ok on their own.
Posted by ameban at May 11, 2006.
.....................................................................................................................................................................
Hi Alan,
I have created an issue regarding
http://jira.atlassian.com/browse/CONF-6436
Please add a watch to it for updates.
Thanks,
Ivan
Posted by ivan@atlassian.com at Jun 23, 2006.
.....................................................................................................................................................................
Is it possible to use macros in combination so that you can include only portions of one page in another,
rather than only being able to include a whole page?
Posted by sltrunzo at Oct 16, 2006.
.....................................................................................................................................................................
You can use {excerpt-include:<page-name>} to include the portion of a page surrounded by
Document generated by Confluence on Feb 08, 2007 14:05
Page 199
{excerpt} tags.
Posted by ameban at Oct 16, 2006.
.....................................................................................................................................................................
I'd like to have another optional parameter "labels=true" whereby the labels of the included page will be
associated with the including page. This would be very useful to manage labels used on included pages in
the same way that the
Unknown macro: {add-label}
and
Unknown macro: {choose-label}
macros work with page templates.
In my case I have labels on various distribution notice pages. I would like the labels to be automatically
attached to any page that uses the distribution notice so that I can easily check that all content has the
correct distribution notice.
I've created an issue here: CONF-7309
In the meantime I can use the
Unknown macro: {metadata}
plugin for the same purpose, but it is more complicated and therefore less approachable for others in my
organisation to implement themselves.
Posted by jibjab at Nov 13, 2006.
.....................................................................................................................................................................
sorry forgot to escape the macros
Posted by jibjab at Nov 15, 2006.
.....................................................................................................................................................................
It should be added to the documentation that pages referenced on the include page macro (and other
similar macros) do not get automatically changed when the page is renamed. This is a significant
inhibitor to using this capability.
Posted by bob.swift@lakeviewtech.com at Nov 15, 2006.
.....................................................................................................................................................................
is there a way to include a page and all its child pages..rather than doing it one by one?
Posted by ankur.gupta@globallogic.com at Dec 17, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 200
Sample Include Page
This page last changed on Sep 15, 2005 by vidya.
Start of sample page content
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras
rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada
massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat
eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac
magna. Suspendisse euismod libero eget mauris.
End of sample page content
Document generated by Confluence on Feb 08, 2007 14:05
Page 201
JIRA Issues Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The Jira Issues Macro allows you to display JIRA issues matching any JIRA filter within a page in
Confluence.
Embed JIRA Issue Filter Results Into A Confluence Page
Stage 1 - Obtain Issue Filter URL
1.
2.
3.
4.
5.
Visit your JIRA instance and login if required
Visit the 'Find Issues' screen and create a 'New' filter. Do not modify an existing filter
Setup your search parameters and use 'View' to check the issues returned
Once the filter is finished, visit the 'Filter View' tab, located above and to the left of the 'View' button
From the 'Filter View' tab, locate the 'Current View' links section displayed below and find the 'XML'
link
6. Copy the 'XML' link to your clipboard
Stage 2 - Embed Issue Filter URL
1.
2.
3.
4.
Visit your Confluence instance and login if required
Edit the page you wish to embed the issues into
Switch to the Wiki Markup editor
Copy the following text into the a new line at the appropriate location
{jiraissues:url=CONTENT}
5. Replace CONTENT with the search URL from your clipboard
6. If you need to login to JIRA to view the search results, append the following parameters to the end
of the search URL:
&os_username=MYNAME&os_password=MYPASSWORD
Document generated by Confluence on Feb 08, 2007 14:05
Page 202
where MYNAME is a JIRA username and MYPASSWORD their password. This user should not have an
& symbol in their username or password
7. Customise the macro by [adding optional parameters] as required
8. Save the updated macro to the Confluence page
Parameters & Troubleshooting
See the [JIRA Issues Macro troubleshooting].
RELATED TOPICS
Working with Macros
[JIRA Issues Macro]
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 203
JIRA Portlet Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The JIRA Portlet Macro displays a JIRA dashboard portlet in Confluence.
To do this, you will need to include the url of the portlet in the macro.
JIRA Portlet Macro
{jiraportlet:url=urlOfJIRAPortlet}
Here's how you locate the url of a JIRA portlet:
1. Add the portlet you wish to include in Confluence to your JIRA dashboard (once you have copied the
portlet's URL into Confluence, you can remove from your JIRA dashboard).
2. Click 'On' beside 'Configure' on your dashboard.
3. Right-click on the title located at the top-left corner of the portlet and copy its link location. See
screenshot 1.
4. Paste it into the {jiraportlet} macro.
Screenshot 1: Copy link location
Optional Parameters
No
1
parameter
baseurl
Default
none
Description
If Confluence retrieves
the JIRA portlet from
some other URL than
JIRA's public URL, you
should supply JIRA's
public URL in the
baseurl parameter.
Confluence 2.1.2 or
later
Here is an example:
Statistics: Confluence (Fix For Versions (non-archived))
2.2
Document generated by Confluence on Feb 08, 2007 14:05
1
Page 204
2.2.2
3
2.3-DR2
1
2.3
1
2.3.1
1
2.3.2
13
2.3.x
25
2.4
33
Buffy
Unscheduled
1%
1%
1%
4
2516
97%
Warning
If your JIRA instance requires you to log in, you must add
&os_username=username&os_password=password to the end of the URL (substituting a valid JIRA
username and password) so that Confluence can log in to retrieve the portlet. This is a temporary
measure until we get Confluence and JIRA cross-authentication working more effectively.
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
Does the jiraportlet macro support the https protocol?
Posted by sdockery@ariasolutions.com at Apr 21, 2006.
.....................................................................................................................................................................
With regard to the above warning, has there been any changes for getting cross-authentication working?
If so, can you please share the details of the necessary versions?
Posted by thadras at Oct 12, 2006.
.....................................................................................................................................................................
It may be helpful to note that the 'ON' next to 'Configure' link is only available when you have a custom
Document generated by Confluence on Feb 08, 2007 14:05
Page 205
dashboard..
Also, it's cumbersome to get portlet URLs this way. Perhaps something could be added to show the URL
some other way?
Posted by matthew.shepherd@tdstelecom.com at Oct 20, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 206
JUnit Report Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The JUnit Report Macro displays a summary of JUnit test results from a directory accessible from the
Confluence server.
When generating reports, set ant formatter to 'XML'.
Junit Report Macro
{junitreport:directory=file:///*directory*/}
or
{junitreport:url=http://*host*/*path*}
where:
directory : URL of a directory containing your test result files.
url : URL of a particular test result XML file.
reportdetail: Detail for report. Can be 'all', 'fixture', 'summary' or 'failuresonly'.
debug: Shows the content of failures, as well as the error messages.
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 207
Noformat Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The Noformat Macro displays a block of text in monospace font with no other formatting.
Noformat Macro
What you need to type
{noformat}
I do not want this text formatted!
{noformat}
What you will get
I do not want this text formatted!
Optional parameter
Remove the panel around the text
What you need to type
{noformat:nopanel:true}
I do not want this text formatted!
{noformat:nopanel:true}
What you will get
I do not want this text formatted!
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
Note: The second example is incorrect in the "What you need to type" column. It should be:
{noformat:nopanel=true}
I do not want this text formatted!
{noformat:nopanel=true}
Posted by kc.baltz@copart.com at Nov 11, 2006.
.....................................................................................................................................................................
Nope, it should be:
{noformat:nopanel=true}
I do not want this text formatted!
{noformat}
Posted by gfraser at Nov 11, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 208
Recently Updated Content Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Recently Updated Content macro displays a list of the most recently changed content within
Confluence.
Recently Updated Content Macro
What you need to type
What you will get
{recently-updated}
Recently Updated
by ivan@atlassian.com (05 Feb)
Download the User Guide
by rosie@atlassian.com (05 Feb)
Re: Form Field Markup for Templates
by rosie@atlassian.com (05 Feb)
Form Field Markup for Templates
by mdoar (05 Feb)
Re: Working with Headings
by dawen.tan@sadasystems.com (05 Feb)
Re: Form Field Markup for Templates
by di99pejo (05 Feb)
Re: Working with News Overview
by Kevin Tran (04 Feb)
Re: Recently Used Labels Macro
by Kevin Tran (04 Feb)
Recently Used Labels Macro
by cbbarkin (02 Feb)
Re: Blog Posts Macro
by joon@sds.co.kr (02 Feb)
Re: Adding a Template
Optional Parameters
No
parameter
Default
Description
1
spaces
space the page
containing the macro is
in
Filter by space, '*'
means all spaces. ('*'
only available from
Confluence 2.1.2
onwards)
2
width
99%
Specify the width of the
Document generated by Confluence on Feb 08, 2007 14:05
Page 209
table
3
labels
none
Filter content using
labels
4
types
all types
Filter content using
type: page, blogpost or
news, spacedesc,
attachment, comment,
mail, userinfo (types
only available from
Confluence 2.1.2
onwards)
1. Specify the spaces for which you want to view recently updated content
{recently-updated: spaces=Name1,Name2 | width=50% }
2. Specify the width of the table
{recently-updated: width=50% }
The list is rendered in a table whose width can be specified using the width argument (width=50% in the
above example) or else Confluence defaults the width to 99%.
3. Filter content using labels
{recently-updated: spaces=sales,marketing | labels=timesheets,summaries}
RELATED TOPICS
Viewing Recently Updated Content
Working with Macros
Take me back to Confluence 2 Home
Comments
Can I specify how many items I want in my list. I know I can do this with Blog lists but I can't seem to do
it with recently updated lists.
Posted by charlieperry@hotmail.co.uk at Nov 16, 2006.
.....................................................................................................................................................................
I added this request to the old confluence docs as well.
Document generated by Confluence on Feb 08, 2007 14:05
Page 210
It would be nice to have a date function so you could say
{recently-added:
{recently-added:
{recently-added:
{recently-added:
{recently-added:
{recently-added:
date=today}
date=yesterday}
date=thisweek}
date=lastweek}
date=thismonth}
date=lastmonth}
Posted by techsupport.ss@ubc.ca at Nov 23, 2006.
.....................................................................................................................................................................
it would be better to use the same parameter formats as the blogposts macro...
Posted by gfraser at Nov 23, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 211
RSS Feed Macro
This page last changed on Jan 09, 2007 by bob.swift@charter.net .
RSS feed macro embeds an RSS feed on a page. It can display the contents of external feeds, or internal
feeds generated by Confluence. To display blog posts or list recently updated pages in a space, use the
Feed Builder to create an internal feed, then render it using this macro. RSS feeds are updated every
hour.
•
•
•
•
•
Usage
Optional Parameters
Working Example
Enabling Feed Caching For Faster Pages
Accessing Internal HTTPS Feeds
Usage
Use the Wiki Markup Editor to edit the page and insert the RSS macro with your feed link.
Public Feeds
Replace the example
Unknown macro: {nomarkup}
http://www.example.com/rss/
feed link below with your own
{rss:url=http://www.example.com/rss/}
Private Feeds with HTTP Basic Authentication
Private feeds are only accessible to users that are logged in. To view a private feed, you will need a login
for the site. Append your username, for example user123 with password pa55w0rD onto the feed URL by
pasting ?os_username=user123&os_password=pa55w0rD onto the end. To access a private feed
{rss:url=http://www.example.com/rss/?os_username=user123&os_password=pa55w0rD}
Private Feeds with HTTPS/SSL
HTTPS-protected feeds for external sites cannot be accessed from Confluence. To request this, please
vote for HTTPS-enabled RSS Feeds. You may need to create a login first.
If your Confluence site has HTTPS enabled for all content, you can only access an internal RSS feeds after
Document generated by Confluence on Feb 08, 2007 14:05
Page 212
Making Internal HTTPS Feeds Accessible.
Optional Parameters
Number
Parameter
Default
Description
1
max
15
Limit the number of
entries displayed
2
showTitlesOnly
false
Show only the RSS feed
titles
3
titleBar
true
Hide the feeds titlebar
The effects of these parameters are described below.
1. Limit the number of entries displayed
This parameter defaults to '15'.
{rss:url=http://host.com/rss.xml|max=5}
2. Show only the RSS feed titles.
This parameter defaults to 'False'.
{rss:url=http://host.com/rss.xml|showTitlesOnly=true}
3. Hide the feeds titlebar
This parameter defaults to 'True'.
{rss:url=http://host.com/rss.xml|titleBar=false}
Working Example
ABC News: Breaking Stories (rss_2.0)
(Latest ABC News)
Victim's father testifies at Norfolk Island murder trial
Holden export deal good news for SA workers: Deputy Premier
Senate inquiry calls for funding boost to disability services
Kelly critics way off the beam, says PM
Document generated by Confluence on Feb 08, 2007 14:05
Page 213
Unemployment rate falls to lowest level in 30 years
This was rendered using the wiki markup
{rss:url=http://www.abc.net.au/news/syndicate/breakingrss.xml|max=5|showTitlesOnly=true}
Enabling Feed Caching For Faster Pages
This requires the installing the Cache Macro. To enable caching:
1. [Install the Confluence Repository Client] into Confluence.
2. Once setup, use the Confluence Repository Client plugin page to install the "Scripting Plugin" and
"Utilities Plugin".
3. For each RSS macro that you wish to cache, surround your RSS Feed call with a Cache macro call.
To caching feeds for 60 minutes:
{cache:refresh=60m}
{rss:url=http://rss.news.yahoo.com/rss/stocks|max=5}
{cache}
As the page will not display feed updates until the cached version is refreshed, you may like to
[customise the cache behaviour].
Accessing Internal HTTPS Feeds
This only applies to Confluence instances which have [enabled HTTPS for all content]. If your site is fully
HTTPS, the RSS macro cannot access internal feeds. To enable the RSS macro to access internal feeds
without affecting your HTTPS setup, enable local-only HTTP access:
1. Shut down Confluence
2. Use the SSL guide to re-enable HTTP access to Confluence. This means that Confluence will be
accessible via both HTTP and HTTPS
3. Insert a firewall rule to redirect all HTTP requests not from the Confluence server to the equivalent
HTTPS URL. This ensures that users will only be able to access Confluence via HTTPS, as intended. If
you have still left HTTP access for attachments enabled (to avoid the IE download bug) you must
selectively enable those URLS as well
4. Modify your Confluence RSS macro feed link to use the HTTP URL, and restart Confluence
Troubleshooting
Check out [RSS Feed Troubleshooting And Tasks].
Related Topics
Document generated by Confluence on Feb 08, 2007 14:05
Page 214
Subscribing to RSS Feeds within Confluence
Tracking Updates Overview
Working with Macros
Return to Confluence 2 Home
Comments
I am a bit confused as to how to make this function work within confluence.
Objective: display more than one rss news feeds from several spaces within wiki on one main landing
page within wiki.
In other words, I am developing a main intranet landing space in Confluence. In the uppermost part of
the page, I want to import news feeds from other spaces in Confluence. ex; "Announcements" "Company
News" would be feeds from their associated space.
Here is what I am doing and the resulting output:
From space "Announcements"; go to Space Amin/Advanced/RSS Feeds and select the feed I want - in
this case it would be "new news posts". I get a pop-up where I can either choose "Save to disk" or "Open
with". If I save to disk, I get a file on my desktop called "creatorsfeed.action" and have no clue how to
use this. From documentation I have read and other feeds I have been able to import, I am supposed to
see something like [http://rss.cnn.com/rss/cnn_tech.rss] - where I would then put on my page like this
[rss:url=http://rss.cnn.com/rss/cnn_tech.rss\]. On the otherhand, if I choose the "Open with" option, I
get a notepad full of code that again, does resemble the above rss link.
So has anyone tried this wth any success? I would like to be able to give office admins, developers, sales,
etc access to post the latest news and have it show up on the main Intranet (Confluence) space.
I am running Confluence 2.2.6a if thatmakes any difference.
Thanks
-J
Posted by jalvarez@hi5.com at Oct 12, 2006.
.....................................................................................................................................................................
I have problems displaying content of an RSS 1.0 feed, while a RSS 2.0 feed does work. Does the RSS
Feed Macro only support RSS 2.0 ?
Posted by joost@claroquesi.info at Oct 23, 2006.
.....................................................................................................................................................................
I am working on a similar problem, and I can't get it to work using the link from the builder. What gives?
Posted by daletan at Dec 28, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 215
Search Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Search Macro does an inline site search and displays the results in the page.
Search Macro
What you need to type
What you will get
{search:query=my_query}
Found 0 search result(s) for my_query
Optional Parameters
Optional Parameters
No
parameter
Default
Description
1
maxLimit
none
Set a limit to the
number of search
results displayed
2
spacekey
all
Specify the key of the
space you want to
search in
3
type
all
Specify the content type
4
lastModified
none
Specify a time period
1. Set a limit to the number of search results displayed
{search:query=my_query|maxLimit=x}
2. Specify the key of the space you want to search in
{search:query=my_query|spacekey=Doctemp}
3. Specify the content type (page, comment, blogpost, attachment, userinfo, spacedesc)
{search:query=my_query|type=comment}
Document generated by Confluence on Feb 08, 2007 14:05
Page 216
4. Specify a time period in which the content was last modified
For example, 3d = modified in the last 3 days, 1m3d = modified in the last month and three days)
{search:query=my_query|lastModified= 2d}
Note
Search results will not include those from pages to which you do not have 'View' permission.
RELATED TOPICS
Searching Confluence
Working with Macros
Take me back to Confluence 2 Home
Comments
What about the "labelText:" and "title:" functionality? These work fine with the confluence text box, but
not with the search macro. Any ideas?
Posted by klausi at Mar 08, 2006.
.....................................................................................................................................................................
Is it possible to format the output of the search?
Posted by timokopp at Apr 05, 2006.
.....................................................................................................................................................................
Great question...I also need to be able to only search on page titles...is this possible with the the search
macro?
Posted by btknorr@gmail.com at Apr 06, 2006.
.....................................................................................................................................................................
Hi,
I would have expected search results to show the {excerpt} of a page if one was available..
Posted by damonrand at Jul 31, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 217
Space Details Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need edit in 'Wiki Markup' mode to include macros in your page.
The Space Details macro renders the space's details in a table within the page.
Space Details Macro
What you need to type
Unknown macro: {nomarkup}
Name: Confluence 2 User Guide
Key: CONF20
Home Page:
Confluence 2 Home
Created By: dave@atlassian.com (Jun 21, 2005)
Space Labels: (None)
Team Labels: (None)
What you will get
Name: Confluence 2 User Guide
Key: CONF20
Home Page:
Confluence 2 Home
Created By: dave@atlassian.com (Jun 21, 2005)
Space Labels: (None)
Team Labels: (None)
Edit Space Details
Edit Space Details
Optional Parameter
Specify the width of the table in which the space details are displayed
{space-details: width=50%}
The table width is defaulted to 99%.
RELATED TOPICS
Viewing Space Details
Editing Space Details
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 218
Spacegraph Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Spacegraph Macro displays a chart of all the pages in a space and the connections between them.
This macro requires that GraphViz is installed. You should perform the default installation for your
operating system. See the Flowchart Macro for Graphviz configuration information.
For details on composing diagrams, see the GraphViz Documentation.
This macro is shipped with Confluence as source. To use it, you need to build the 'graphviz' plugin. To do
this, you need to install ant and run the command:
ant -Dlibrary=graphviz install
from the plugins directory.
Spacegraph Macro
{spacegraph:ds}
Optional Parameter
Specify the space by including its spacekey in the macro
{spacegraph:ds|spacekey:Doctemp}
By default, this is set to the current space.
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 219
Spaces List Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The Spaces List Macro is used to display a list of spaces from within a page.
By default, Confluence lists the spaces from your current view of spaces on the Dashboard.
For each space listed, there is a link to browse the space, and to add a new page (if the user has
permission to create pages).
Spaces List Macro
What you need to type
What you will get
{spaces-list}
•
•
•
•
Spaces:
My
Team
All
Kevin's Space (KEV)
Kevin Tran (~ktran)
Optional Parameters
No
parameter
Default
Description
1
width
100%
Specify the width of the
table
2
spaces-list
all
Specify the view from
which spaces are listed
Specify the width of the table in which the spaces are listed
{spaces-list:width=40%}
Specify the view from which spaces are listed
{spaces-list:team}
Replace 'team' with 'all', 'my' or 'new' to display all spaces, my spaces only or news spaces only.
RELATED TOPICS
Browsing a Space
Document generated by Confluence on Feb 08, 2007 14:05
Page 220
Creating a New Page
Working with Macros
Take me back to Confluence 2 Home
Comments
Need to add a type of "personal" to see a list of the personal spaces.
Posted by garnetr at Dec 14, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 221
Thumbnail Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
Use the Thumbnail Macro when you want to create a thumbnail of an inline image attached to any
Confluence page. Clicking on the thumbnail image will pop up a window containing the full-size image.
The macro resizes the original image proportionately allowing for a maximum height or width of 200
pixels.
Thumbnail Macro
What you need to type
What you will get
Unknown macro: {nomarkup}
where:
'waterfall.jpg' is the name of your image
Thumbnail Macro when displaying an image attached to another Confluence page
What you need to type
What you will get
Unknown macro: {nomarkup}
where:
'Space attachments directory' is the name of the other page
Confluence will only create thumbnails for these file formats: gif, jpg, and png. The bmp format is
Document generated by Confluence on Feb 08, 2007 14:05
Page 222
not supported.
RELATED TOPICS
Gallery Macro
Image File Formats
Attaching Files to a Page
Working with Macros
Take me back to Confluence 2 Home
Comments
Is there any way to specify the dimensions of a thumbnail you add?
Posted by eeustace at Mar 03, 2006.
.....................................................................................................................................................................
The size of thumbnails (including those displayed by the {gallery} macro) is defined in the "General
Configuration" settings within the Administration Console.
Alternatively, you can simply specify the width and height of an image (I don't know if this is compatible
with the "thumbnail" parameter as that probably overrides them). There are lots of examples of the
various image settings here: http://www.adaptavist.com/display/USERGUIDE/Image+Options
Posted by gfraser at Mar 03, 2006.
.....................................................................................................................................................................
Not quite sure how to tackle this issue...
I'm finding the thumbnail macro really useful, but when I create my PDF's to hand to the suits the
thumbnail image is excluded. I can understand the reasoning behind this - the considering the image was
thumbnailed in the first place it's a safe assumption it's quite large.
The problem is my text will often talk to the image. 'The following example shows...' etc etc
I don't really want to put the full image in my page, but would like to have them as part of my exported
documents.
Encountered this one? How do people solve this?
Posted by borg at Jun 03, 2006.
.....................................................................................................................................................................
Using an arrow with the thumbnail is also nice. Let's users know that the content is clickable. Perhaps
there should be a shortcut to do this?
[!fish.gif|thumbnail!|^fish.gif]
Document generated by Confluence on Feb 08, 2007 14:05
Page 223
Posted by tmcken at Oct 27, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 224
Userlister Macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Userlister Macro displays a list of users registered in Confluence.
Userlister Macro
What you need to type
What you will get
!userlist.gif!
{userlister}
Optional Parameters
Specify one or more groups using a comma separated list of group names
Here is an example that lists the users that belong to the group 'Confluence-Users'.
{userlister:groups=confluence-users}
Filter the users based on whether they are online or not
An optional true/false value filters the users based upon their online status
Here is an example that lists all currently online users in the group 'Confluence Users'
{userlister:groups=confluence-users|online=true}
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Comments
This has stopped working in my installation also.
Posted by bob.swift@lakeviewtech.com at Feb 28, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 225
Not working for me either. It just shows nothing. No error messages. Am logged in as
Confluence-Administator, so it is unlikely to be a permission problem.
Posted by jonty.hurwitz at Sep 12, 2006.
.....................................................................................................................................................................
Is there a way to specify a number of column and the maximum user in one column ?
Or please can you tell me where can i find the java source code ?
Posted by gludenglu at Oct 11, 2006.
.....................................................................................................................................................................
Can I just list the groups that have access to a page and not all the individual users?
Posted by guyh@ncompass.co.uk at Oct 17, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 226
Welcome Message macro
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
The Welcome Macro allows you to include the Confluence site welcome message in your page.
The welcome message is configured by a site administrator from the Administration Console.
Welcome Macro
What you need to type
What you will get
Unknown macro: {nomarkup}
RELATED TOPICS
Working with Macros
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 227
Searching Confluence
This page last changed on Jan 03, 2007 by rosie@atlassian.com.
The fastest way to find what you are looking for in Confluence is to do a site search. Confluence will
search all content, including attachments.
Quick Search
The Quick Search feature makes it possible for you to search Confluence wherever you happen to be in
the site. The Quick Search box is located at the top right hand corner of every screen. Simply type in
your query and click the search button.
By default, Confluence will search all content (except mail) in all global spaces, and display the results in
a new screen. Here are the results of searching for 'Confluence' :
Screenshot : Search results for 'Confluence'
For each result, the title of the content item, the space to which it belongs, its author and the date of
its last modification are presented. The first two lines from the item are also displayed to give you an
indication of its content.
Only search results from spaces you have permission to view will be displayed.
See Confluence Search Syntax for more ways to use the search box.
Advanced Search
The Advanced Search allows you to refine your search.
When you do a Quick Search, the Advanced Search facility is displayed along with the results.
• Location - Search within a particular space, or within Favourites, Personal Spaces, Global Spaces or
Document generated by Confluence on Feb 08, 2007 14:05
Page 228
All Spaces.
• Group by - Decide how you want the results are grouped: by 'content type' or by 'space'.
• Type - Decide which of the 'content types' you want to search.
• Date - Search by 'date' of modification.
Screenshot : Advanced Search
Additionally, Confluence Search Fields describes special parameters you can use in the search field to
search on various metadata.
Searching Attachments
Confluence will search the following type of attachments:
•
•
•
•
•
•
Word
Text
Powerpoint
Excel
PDF
HTML
Document generated by Confluence on Feb 08, 2007 14:05
Page 229
To search other types of attachments, you will need to use [Attachment content extractor plugins]
----
RELATED TOPICS
Confluence Search Syntax
Confluence Search Fields
Viewing labelled pages
Searching the People Directory
Take me back to Documentation Home
Comments
I have a question regarding pages retrieved with the search function. In the result list the searchterms
are highlighted... Is it possible to show a clicked page with the searchterms highlighted as well?
Best Regards
Posted by dnemesiss@yahoo.de at Nov 29, 2006.
.....................................................................................................................................................................
Yes this is already an improvement request logged in JIRA
Please follow progress there.
Ib
Posted by ivan@atlassian.com at Jan 31, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 230
Confluence Search Fields
This page last changed on Nov 09, 2006 by tom@atlassian.com.
This document intends to give programmers and advanced users of Confluence an overview
over the lucene search fields used in Confluence.
Field searches
Confluence data is stored in fields which can be specified in the search. To search a specific field, type the
name of the field followed by a colon ":" and then the term you are looking for.
title:"Some Title"
labelText:chalk
The field is only valid for the term directly preceeding the colon. The following query will only find "Some"
in the title field and will search for Title in the default fields.
title:Some Title
Confluence Search Fields
Pages
Name
News
Indexed
Stored
Tokenized
Name
Indexed
Stored
Tokenized
handle
true
true
false
handle
true
true
false
type
true
true
false
type
true
true
false
urlPath
true
true
false
urlPath
true
true
false
title
true
true
true
title
true
true
true
spacekey
true
true
false
spacekey
true
true
false
labelText
true
true
true
labelText
true
true
true
modified
true
true
false
modified
true
true
false
created
true
true
false
created
true
true
false
userpermission
true
true
false
userpermission
true
true
false
contentBody
true
true
true
contentBody
true
true
true
Document generated by Confluence on Feb 08, 2007 14:05
Page 231
Attachments
Name
Mails
Indexed
Stored
Tokenized
Name
Indexed
Stored
Tokenized
handle
true
true
false
handle
true
true
false
type
true
true
false
type
true
true
false
urlPath
true
true
false
urlPath
true
true
false
filename
true
true
true
title
true
true
true
title
true
true
false
spacekey
true
true
false
comment
true
true
true
messageid true
true
false
spacekey
true
true
false
inreplyto
true
true
false
modified
true
true
false
recipients true
true
true
created
true
true
false
labelText
true
true
true
userpermission
true
true
false
modified
true
true
false
contentBody
true
true
true
created
true
true
false
userpermission
true
true
false
contentBody
true
true
true
Personal Information
Name
Indexed
Stored
Tokenized
handle
true
true
false
type
true
true
false
urlPath
true
true
false
fullName
true
true
true
username
true
true
true
title
true
true
false
labelText
true
true
true
modified
true
true
false
created
true
true
false
userpermission
true
true
false
contentBody
true
true
true
Comments
THANK YOU JENS! Superb, I've been after such a list ever since I realised that Lucene (sp?) allowed this
sort of thing. Yay! Mind if I rob a copy for our own user guide? We've got a page dedicated to advanced
searching
Document generated by Confluence on Feb 08, 2007 14:05
Page 232
Posted by gfraser at Feb 09, 2006.
.....................................................................................................................................................................
This is only a simple overview over the fields used in the index. We will need to filter and document the
important content fields to make this document more useful.
Posted by jens@atlassian.com at Feb 09, 2006.
.....................................................................................................................................................................
I noticed that there were 2 "recipients" fields in the Mail properties?
Posted by gfraser at Feb 09, 2006.
.....................................................................................................................................................................
Guy,
You're more than welcome to grab a copy. We'll have to work on documenting each single field and filter
the less useful ones. For example the handle and modified fields are not very useful for a field search.
Would be great if you could let us know when you make any enhancements to the docs.
Cheers,
Jens
Posted by jens@atlassian.com at Feb 09, 2006.
.....................................................................................................................................................................
I've noticed that too. Will have to check that
Posted by jens@atlassian.com at Feb 09, 2006.
.....................................................................................................................................................................
Adding a footnote here for what the "default" contentBody (and title) tokenizer setup would be handy.
Posted by benny.yih@ieee.org at Mar 10, 2006.
.....................................................................................................................................................................
Let's say that lots of my pages each have lots of attachments, potentially big ones.
Is it possible to specify a search that searches only the attachments of the currently-displayed page?
And, also handy would be ... a way to search the targets of links in the current page.
TIA.
Posted by fbaube at May 09, 2006.
.....................................................................................................................................................................
Thanks, this has come in handy.
Document generated by Confluence on Feb 08, 2007 14:05
Page 233
BTW, do you know how to index particular fields that aren't currently indexed, e.g. creatorName and
lastModifierName?
I've found a tool (LUKE) to update indexes, though Confluence seems to have it's own determination of
what's indexed. Is this configurable somewhere?
Thanks,
Jim
Posted by jclark42796 at Oct 17, 2006.
.....................................................................................................................................................................
How do you search date fields? e.g. created. The index shows the value "0etd7sv5q". How would you find
out which pages were created 10/17/2006? I tried variations of the date format, e.g.
created:"2006-10-16"
Thanks,
Jim
Posted by jclark42796 at Oct 17, 2006.
.....................................................................................................................................................................
I have the same problem as Jim. It seems that Confluence ignores or at least doesn't understand search
queries like "lastModified:yesterday" or "lastModified:2d" (= two days ago) although I found these
expressions in the documentation (don't remember the link).
TIA,
Aleks
Posted by spaddo at Oct 29, 2006.
.....................................................................................................................................................................
Did you get this figured out? I am trying to search for everything that I have created or has my
username attached to. (Basically a "show my posts" like in a forum, so i can see what i have posted or
commented on etc.)
Posted by jguthrie at Nov 03, 2006.
.....................................................................................................................................................................
I did figure it out. You'll need to create an extractor plugin Extractor plugins allow you to insert fields in
to the index. You'll need to be familiar with Java and building Java software using Ant.
I don't have the code here at home but if you have access to the Confluence source code you can look at
the class
com.atlassian.confluence.search.lucene.extractor.ContentEntityMetadataExtractor
My extractor looks something like:
Document generated by Confluence on Feb 08, 2007 14:05
Page 234
import
import
import
import
import
bucket.search.Searchable;
bucket.search.lucene.Extractor;
com.atlassian.confluence.core.ConfluenceEntityObject;
org.apache.lucene.document.Document;
org.apache.lucene.document.Field;
public class MyExtractor implements Extractor
{
public void addFields(Document document, StringBuffer defaultSearchableText, Searchable
searchable)
{
if (searchable instanceof ConfluenceEntityObject)
extractCreator((ConfluenceEntityObject) searchable, document);
}
private void extractCreator(ConfluenceEntityObject ceo, Document document)
{
if (ceo.getCreatorName() != null)
document.add(new Field("author", ceo.getCreatorName(), Field.Store.YES,
Field.Index.UN_TOKENIZED));
}
}
What I did was add the page "creator" to the index as "author"
if (ceo.getCreatorName() != null)
document.add(new Field("author", ceo.getCreatorName(), Field.Store.YES,
Field.Index.UN_TOKENIZED));
After installing the plugin you can use the Lucene index viewer to see your documents with the "author"
added to the index, at something like http://localhost:8080/confluence/admin/indexbrowser.jsp
You should then be able to search for your docs using a search query of "author:my_userid".
I may just post the packaged plugin but it may take a week or so before that happens.
Posted by jclark42796 at Nov 03, 2006.
.....................................................................................................................................................................
packaged plugin would be great! We haven't actually installed Confluence yet so i have some time to
wait.
I was just testing out a few things and being able to easily find content you have posted,
commented on etc. seemed to be missing.
Posted by jguthrie at Nov 06, 2006.
.....................................................................................................................................................................
Shouldn't a search using this syntax: username:"jguthrie" return pages I have created, edited, or
commented on etc? As it stand right now, this search doesn't return any results.
Posted by jguthrie at Nov 09, 2006.
.....................................................................................................................................................................
To add what I've done above in MyExtractor, I've added an alternative indexed field for creation date.
import bucket.search.Searchable;
import bucket.search.lucene.Extractor;
import com.atlassian.confluence.core.ConfluenceEntityObject;
Document generated by Confluence on Feb 08, 2007 14:05
Page 235
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
public class MyExtractor implements Extractor
{
public void addFields(Document document, StringBuffer defaultSearchableText, Searchable
searchable)
{
if (searchable instanceof ConfluenceEntityObject)
extractCreator((ConfluenceEntityObject) searchable, document);
}
private void extractCreator(ConfluenceEntityObject ceo, Document document)
{
if(ceo.getCreationDate() != null)
{
ThreadLocalSimpleDateFormat format = new ThreadLocalSimpleDateFormat("yyyy-MM-dd");
document.add(new Field("createdDate", format.format(ceo.getCreationDate()),
org.apache.lucene.document.Field.Store.YES,
org.apache.lucene.document.Field.Index.UN_TOKENIZED));
}
}
Adding this format of creation date allows me do a query like:
createdDate:2006-11-09
Posted by jclark42796 at Nov 09, 2006.
.....................................................................................................................................................................
As noted above in "Confluence Search Fields", username is only a search field for personal information,
not pages. creatorName (author) and lastModifierName (editor) are in the index but not searchable.
Therefore, I had to create an extractor plugin to allow searching for editor/author see my comments
above
Posted by jclark42796 at Nov 09, 2006.
.....................................................................................................................................................................
I'm pretty sure there is already a {contentbyuser} macro that comes with Confluence...?
Posted by gfraser at Nov 09, 2006.
.....................................................................................................................................................................
I could be mistaken, but I think [Jeff] is trying to perform a search vs. using a macro. The extractor I
wrote would insert searchable fields in to the Confluence search index. I guess he could create a page
that includes the macro.
Posted by jclark42796 at Nov 09, 2006.
.....................................................................................................................................................................
Oh ok, i understand now. I thought they are all search able and the headings were just for the type of
information that can be searched....
Posted by jguthrie at Nov 09, 2006.
.....................................................................................................................................................................
Yes I was trying to perform a search as I was hoping for users to be able to have an easy way for them to
navigate back to pages they have created, edited, commented on etc. I will have to give your extractor a
go I think.
Did you finish making it a packaged plugin? The way getting these things installed where
i work is i need to go through a sys admin to get plugins etc installed etc... I don't have direct access to
Document generated by Confluence on Feb 08, 2007 14:05
Page 236
the server and file system of our Confluence install.
Posted by jguthrie at Nov 09, 2006.
.....................................................................................................................................................................
I am getting an unknown macro error on this when I try to use it. Do you have a link to its use? I did a
search and your comment appears to be the only place its mentioned.
Posted by jguthrie at Nov 09, 2006.
.....................................................................................................................................................................
I might have the macro name incorrect - I only ever used that macro once and it generated a HUGE list
of results (as I'd added literally thousands of pages to our site) so didn't return to it. The big drawback of
that macro (if it's still available) is that its results aren't paginated. If the macro is still part of Confluence,
it should show up in the notation guide.
Posted by gfraser at Nov 09, 2006.
.....................................................................................................................................................................
Try this
Content created by Anonymous
There are no pages at the moment.
e.g.
Content created by Anonymous
There are no pages at the moment.
Posted by jclark42796 at Nov 09, 2006.
.....................................................................................................................................................................
whoops, try this
{content-by-user:jguthrie}
Posted by jclark42796 at Nov 09, 2006.
.....................................................................................................................................................................
Ah, hyphens! I knew there was something like that
Posted by gfraser at Nov 09, 2006.
.....................................................................................................................................................................
That is exactly what i wanted!!! Thanks a ton!
Posted by jguthrie at Nov 10, 2006.
.....................................................................................................................................................................
That is exactly what i wanted!!! Thanks a ton!
Posted by jguthrie at Nov 10, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 237
This worked for me in Confluence 2.2.8. When I try to build it under Confluence 2.3 I get the following
error:
[mkdir] Created dir: /opt/confluence/confluence-2.3/plugins/bcsearch/classes
[javac] Compiling 1 source file to /opt/confluence/confluence-2.3/plugins/bcsearch/classes
[javac]
/opt/confluence/confluence-2.3/plugins/bcsearch/src/java/brazos/confluence/plugins/search/PageAuthorExtractor.java:
cannot find symbol
[javac] symbol : class Searchable
[javac] location: package bucket.search
[javac] import bucket.search.Searchable;
[javac]
^
[javac]
/opt/confluence/confluence-2.3/plugins/bcsearch/src/java/brazos/confluence/plugins/search/PageAuthorExtractor.java:
package bucket.search.lucene does not exist
[javac] import bucket.search.lucene.Extractor;
[javac]
^
[javac]
/opt/confluence/confluence-2.3/plugins/bcsearch/src/java/brazos/confluence/plugins/search/PageAuthorExtractor.java:
cannot find symbol
[javac] symbol: class Extractor
[javac] public class PageAuthorExtractor implements Extractor
[javac]
^
[javac]
/opt/confluence/confluence-2.3/plugins/bcsearch/src/java/brazos/confluence/plugins/search/PageAuthorExtractor.java:
cannot find symbol
[javac] symbol : class Searchable
[javac] location: class brazos.confluence.plugins.search.PageAuthorExtractor
[javac]
public void addFields(Document document, StringBuffer defaultSearchableText, Searchable
searchable)
[javac]
^
[javac] 4 errors
Posted by sudhakar@co.brazos.tx.us at Jan 09, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 238
Confluence Search Syntax
This page last changed on Jan 03, 2007 by rosie@atlassian.com.
Searching Syntax
Here's how you can refine your search. Confluence will ignore common words like "the" unless you place
your query within quotes.
Exact phrase search
To search for content that contains the exact phrase "chalk and cheese"
"chalk and cheese"
Or Search
To search for content that contains one of the terms, "chalk" OR "cheese"
chalk OR cheese
And Search
To search for content that contains both the terms "chalk" AND "cheese"
chalk AND cheese
Not search
To search for content that contains "chalk" but NOT "cheese"
chalk NOT cheese
Excluded Term search
Similar to the NOT search, to search for content that contains "chalk" and "butter" but NOT "cheese"
chalk butter -cheese
Grouping Search
To search for content that MUST contain "chalk" but CAN contain either "cheese" or "butter" use the
search:
Document generated by Confluence on Feb 08, 2007 14:05
Page 239
(cheese OR butter) AND chalk
Title Search
To search for content with "chalk" in its title, where title is the field keyword.
title:chalk
Wild card searchesSingle character
To search for "butter" or "batter" you can use the search:
b?tter
To search for "chicken" or "chickpea" you can use the search:
chick*
Wildcards can be used anywhere within a word, except at the very beginning.
For example:
*chick
is an invalid serch term.
Mutliple characters
To search for "chick" or "chickpea":
c*c*
You can also combine search characters to get the exact word. For example the search term below will
return "chic" yet not "chickpea":
c*c?
Proximity searches
This search ensure that the two words specified must be within a certain number of words of each
other to be included.
"octagon post"~1
Document generated by Confluence on Feb 08, 2007 14:05
Page 240
will return "Octagon blog post".
"octagon post"~0
is an invalid search term.
Range search
Searches for names that fall alphabetically within the specifed range.
[adam to ben]
Note: You can't use the AND keyword inside this statement.
Fuzzy search
This search looks for words spelled similarly.
To search for octagon, if unsure about spelling:
octogan~
will correctly return "octagon"
Combined search
You can also combine various search terms together:
o?tag* AND past~ AND ("blog" AND "post")
RELATED TOPICS
Searching Confluence
Confluence Search Fields
Take me back to Confluence 2 Home
Comments
I've noticed that + seems to work too. AFAIK...
Unknown macro: {nofofmat}
Document generated by Confluence on Feb 08, 2007 14:05
Page 241
chalk AND cheeze
and
+chalk +cheeze
get you the same results.
Posted by gpullis at Nov 07, 2006.
.....................................................................................................................................................................
Sorry about that. I meant to say...
I've noticed that + seems to work too. AFAIK...
chalk AND cheeze
and
+chalk +cheeze
get you the same results.
Gotta remember to hit that preview button before posting.
Posted by gpullis at Nov 07, 2006.
.....................................................................................................................................................................
If wildcards are invalid at the beginning of the string, how can I search for *@domain.com ?
This would be useful to regroup emails coming from a particular source or client.
Posted by pat pitou at Jan 30, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 242
Searching the People Directory
This page last changed on Jan 04, 2007 by rosie@atlassian.com.
The People Directory is available in Confluence version 2.3 and later.
The People Directory displays a list of people who use your Confluence site.
To go to the People Directory, click the ' People Directory' link on the Dashboard, next to the following
icon :
The People Directory looks like this:
The 'Personal Space' icon
indicates that the person has set up a personal space.
•
If the 'Personal Space' icon appears beneath a person's name, clicking that person's name (or their
picture) will take you to their personal space.
• If the 'Personal Space' icon does not appear beneath a person's name, clicking that person's name
(or their picture) will display their [user profile].
Searching for People
To search for a particular person, type their first name and/or last name into the search box and click the
'Search' button.
Document generated by Confluence on Feb 08, 2007 14:05
Page 243
•
•
To search everyone who uses your Confluence site, click the ' All People' link.
To search just those people who have set up a personal space, click the 'People with Personal
Spaces' link.
Favourite People
The top part of the People Directory screen displays any people that you have nominated as your
favourites.
• To add a person to your Favourite People, click the grey star icon
• To remove a person from your Favourite People, click the yellow star icon
Once you add a person to your Favourite People, their personal space (if they have one) will be
added to your list of favourite spaces on the Dashboard.
RELATED TOPICS
Setting up your Personal Space
Editing your User Profile
Uploading a Profile Picture
Take me back to Home Help
Comments
We really need this soon!
The thought of having a separate app just for blogging/discussion, apart
from our current project/team spaces will not fly. Neither will having 500 personal spaces cluttering up
the dashboard. This will be a great enhancement.
Posted by bpair at Dec 12, 2006.
.....................................................................................................................................................................
I need to migrate all the spaces from one Confluence to another active instance of Confluence. I need an
easy way to find all the users who created personal spaces so I can export them from the one system,
and restore them on the other.
Posted by garnetr at Dec 13, 2006.
.....................................................................................................................................................................
You could do that pretty easily by going to the database directly: select * from SPACE where
SPACETYPE = 'personal'
Posted by cmiller at Jan 01, 2007.
.....................................................................................................................................................................
Take a look here: http://forums.atlassian.com/thread.jspa?threadID=14907&tstart=0
Document generated by Confluence on Feb 08, 2007 14:05
Page 244
Posted by f.marx@enbw.com at Jan 04, 2007.
.....................................................................................................................................................................
Is there a macro for this? We have a custom page for our dashboard.
Posted by gpullis at Jan 12, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 245
Working with Attachments Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
An attachment is any file that is included with your page. Images, word documents, presentations and
sound files are some examples of attachments.
Attachments are useful when you want to share information that exists in another file format.
In Confluence, attachments are contained in the 'Attachments' tab of a page.
Once you attach a file, you can then provide a link to it from the page. Clicking on the link will open up
the attachment so long as you have the requisite software application to open the attachment.
In the case of image attachments, Confluence allows you to display attached images on the page.
Attaching a file with the same name as an existing attachment will create a new version of the
attachment.
RELATED TOPICS
Linking to Attachments
Attaching Files to a Page
Displaying an Image
Downloading Attachments
Attachment Versions
[Configuring Attachment Size]
[Attachment Storage Configuration]
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 246
Attaching Files to a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
When you attach a file to a page, Confluence makes a copy of it and stores it on the server. File
attachments in Confluence are contained in the 'Attachments' tab of a page.
To attach a file, you require 'Create Attachments' permission which is assigned by a space administrator
from the Space Administration screens. See Space Permissions or contact a space administrator for more
information.
To attach a file to a page,
1.
2.
3.
4.
5.
Go to the page and click on the 'Attachments' tab.
Browse through your files and select the file you'd like to attach.
Enter a description for the attachment in the 'Comment' text field (optional).
Click 'Attach more files' if required.
Click 'Attach File'.
Attachment Versioning
If you upload a file with the same name as an existing attachment, Confluence will rename the old file
and maintain a version of it on the server.
Screenshot : Attachment Versioning
Handy Hint
Changes you make to the original file after you've attached it don't affect the copy in Confluence.
To update the content of the file, you will need to upload a new version.
RELATED TOPICS
Working with Attachments
Working with Images
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 247
Attachment Versions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To create a new version of an existing attachment, simply upload an attachment with the same filename.
The existing file will be kept as Version 1, and can be accessed from the page's 'Attachments' tab.
RELATED TOPICS
Moving an Attachment
Viewing Attachment Details
Working with Attachments
Take me back to Confluence 2 Home
Comments
How would you delete a particular version of a file if you have multiple versions?
Posted by ahnguyen at Aug 22, 2006.
.....................................................................................................................................................................
You can only delete all versions
this very bad idea ...
Posted by nairamk at Nov 24, 2006.
.....................................................................................................................................................................
Is there any way where we can download a file and making changes and then save the attachments
directly to the same page, with version maintained.
Posted by meer.saif at Jan 17, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 248
Displaying List of Attachments in a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to include macros in your page.
Use Confluence's Attachments macro to display the list of attachments that belong to a page.
Attachments macro
What you need to type
What you will get
Unknown macro: {nomarkup}
Name Size Creator DateComment
office1.jpg
94 kb vidya Aug
Edit |
09,
Remove
2005
waterfall.jpg
1.27 vidya Aug
Edit |
Mb
09,
Remove
2005
editProfile.png
33 kb vidya Aug
Edit |
09,
Remove
2005
Name Size Creator DateComment
office1.jpg
94 kb vidya Aug
Edit |
09,
Remove
2005
waterfall.jpg
1.27 vidya Aug
Edit |
Mb
09,
Remove
2005
editProfile.png
33 kb vidya Aug
Edit |
09,
Remove
2005
Optional Parameters
Parameter
Default
Description
patterns
all
Specify which attachments to
display using filename patterns
old
false
Include old attachments
1. Filter attachments by filename
{attachments:patterns=.*jpg,.*gif}
Use a comma-separated list of regular expressions to specify the filenames of the attachments you want
displayed.
Note
The patterns are regular expressions, so to match a file suffix of 'jpg', use .*jpg, not *.jpg.
Here's a detailed tutorial on regular expressions.
2. Include old attachments
Document generated by Confluence on Feb 08, 2007 14:05
Page 249
{attachments:old=true}
An optional true/false value determines whether to show old versions of attachments. This is set to false
by default.
RELATED TOPICS
Working with Attachments Overview
Working with Macros
Take me back to Confluence 2 Home
Comments
Hi,
Is there a way to control which columns are shown on the page. I'd like to display just a few of them.
Thanks, Arjen
Posted by arjenvandenakker at Dec 08, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 250
Downloading Attachments
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To download a single attachment of a page,
1. Go to the page and click on the 'Attachments' tab.
2. Right-click on the attachment link and select 'Save Link As'. This will open up a dialog box. Select
the directory into which you want to download the file and click 'Save'.
To download all the attachments of a page,
1. Go to the page and click on the 'Attachments' tab.
2. Click on the 'Download All' link at the top of page to download a zipped file of all the page's
attachments.
RELATED TOPICS
Working with Attachments Overview
Viewing Attachment Details
Take me back to Confluence 2 Home
Comments
Vidya,
How could I download all the attachments of one page or space?
Is there any way to do that? I mean a kind of 'bulk downloading'.
thx
Posted by msciarra at Jan 18, 2006.
.....................................................................................................................................................................
Hi Marcos,
Currently, there is no way to download all attachments in a space at one shot. You can however,
download all the attachments that belong to a page. Just go to the 'attachments' tab and click 'Download
All'.
Hope this helps,
Vidya
Posted by vidya at Jan 18, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 251
Editing Attachment Details
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To edit an attachment's details, you require 'Create Attachments' permission which is assigned by a space
administrator from the Space Administration screens. See Space Permissions or contact a space
administrator for more information.
To edit the details of an attachment,
1. Go to the page that contains the attachment.
2. Click on the 'Attachments' tab.
3. Click on the 'Edit' link beside the attachment. This will bring up a new screen.
• Rename or modify the name of the attachment in the 'File Name' text field.
• Update the existing comment or enter a new comment in the 'New Comment' text field.
• Move the attachment to another page.
4. Click 'OK'.
RELATED TOPICS
Moving an Attachment
Viewing Attachment Details
Working with Attachments
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 252
Embedding Multimedia Content
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can now embed multimedia files into a Confluence page as as easily as you can an image. Confluence
supports these 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.
If you get an error 'Unable to embed content of type application/octet-stream', this means the mime-type
is not being correctly recognised. You can add a type parameter to the embedded markup to override the
auto-detected mime-type. See below for an example.
To embed a multimedia file,
Attach the file to the page. You can then include it as you would include an image, like this:
!filename.mov!
NOTE: Due to security reasons, files located on remote servers are not permitted.
Optionally
Define the properties of the embedded object using a comma separated list of properties
!filename.mov|height=800,width=600,id=media!
Overriding the mime-type of a file without a meaningful extension:
!filename|type=image/jpeg!
Note: For advanced 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.
RELATED TOPICS
Document generated by Confluence on Feb 08, 2007 14:05
Page 253
Working with attachments overview
Take me back to Confluence 2 Home
Comments
Sorry if this is an inappropriate place for this question, but has anyone else gotten this to work with
WMVs? Is it necessary to have a separate streaming server running on your machine? It works fine with
Quicktime movies, but I can't get even the simplest WMVs to play. Ideas?
Posted by amitchell at Dec 06, 2005.
.....................................................................................................................................................................
Well, never mind. I got my WMVs streaming in IE but not Firefox. I guess the problem is client side.
Posted by amitchell at Dec 06, 2005.
.....................................................................................................................................................................
Has anyone tried embedding MindManager .mmap files? Given that they have an IE browser plugin
viewer, I bet this could work pretty well. Imagine building a mindmap of links into your Confluence wiki
space as an alternative means of navigation?
Sounds pretty cool to me.
Posted by stews at Mar 21, 2006.
.....................................................................................................................................................................
Is there an ability to provide player controls when embedded QuickTime movies are included in a page? I
was hoping to create pages that included some QT movies but not have them automatically play when
the page loads.
Posted by geofcorb at Jul 28, 2006.
.....................................................................................................................................................................
Our confluence is on https. When we embed a flash file, we get the message "This page contains both
secure and nonsecure items. Do you want to display the nonsecure items."
I uploaded the files trough attachments. They are in the same location as the images. The images don't
give the problem, only the flash files.
Any ideas?
Posted by jeroen.keppens@unibet.com at Oct 17, 2006.
.....................................................................................................................................................................
I found this on the macromedia site:
http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_16588
Unfortunately I can't change the codebase since I use the !testfile.swf! annotation...
Posted by jeroen.keppens@unibet.com at Oct 17, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 254
I can't figure out how to specify the codebase... If I try to attach the file and refer as this:
!blah.vsd|type=application/x-visio,classid=clsid:279D6C9A-652E-4833-BEFC-312CA8887857,codebase=vviewer.exe!
It doesn't resolve to the proper link for the codebase (although the blah.vsd is fine). But if I use the full
http:// to the viewer, Confluence converts it into an href in the rendered page.
Posted by demner at Dec 11, 2006.
.....................................................................................................................................................................
After embedding a couple of Flash .swf's i'm noticing that they run slowly. My movies are running at 30
fps in Flash. Any ideas why this is happening or if installing the Flash macro would help here?
Cheers
Posted by dropthebomb at Jan 31, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 255
Embedding PowerPoint Presentations in a Page
This page last changed on Jun 06, 2006 by ivan@atlassian.com.
The simplest way to embed a PowerPoint presentation in Confluence is to convert the PowerPoint file to
web page format, and embed the page inside your Confluence document. If you accept page edits or
comments from untrustworthy users, you should not attempt this process, due to a risk of malicious user
attacks via the html-include macro.
1. Review the risks associated with enabling the html macro [here].
2. If you decide to proceed, follow [the instructions] to enable embedded html pages using the macro.
3. Select an PPT converter. There are at least two applications that can convert PPT to HTML. One is
Producer for PowerPoint. If you don't actually have PowerPoint on your machine, you can use the
Internet Assistant for Powerpoint instead. Download and install your converter.
4. Follow the converser usage documentation to create the html conversion. An Internet Assistant
conversion guide can be found here. The conversion process will create a small collection of html
pages. Each slide will have it's own page, plus an index page with buttons to let you switch between
slide pages.
5. If you wish, you can test the html presentation now by loading the index page in your browser.
6. Place the html files into their own directory, named uniquely by the title of your presentation.
7. Find a suitable location to host these files within your web server. Confluence hosts all files within
the <my-install-directory>/confluence/ directory, so a good example location for Confluence
standalone users is to go to <my-install-directory>/confluence/pages/ and create a
subdirectory called powerpoint.
8. Move the html directory into the PowerPoint folder, eg.
<my-install-directory>/confluence/pages/powerpoint/<my-presentation-name> containing
index.html, slide01.html... or similar.
9. Edit or create the page you wish to embed the PowerPoint presentation. In wiki markup, add a call
to the html-include macro to the index page of your slides. Remember that URLS are case
sensitive. For example
{html-include:url=http://<my-base-url>/pages/powerpoint/<my-presentation-name>/index.html}
10. Save the page. The index page to your slides should now appear.
Comments
Hmm. Two observations:
1 PowerPoint is the staple communication format in most organisations, used by executives, sales
people and consultants alike.
2 They will hate your solution as it is a) involves more than one step, b) is too complicated c) demands
technical knowledge d) demands external tools.
It needs confluence to be able to designate a topic to be exclusive to a single attachment, and have the
topic attachment placeholder updated whenever the attachment is updated.
See
http://confluence.atlassian.com/display/DISC/MS+Office+Integration?focusedCommentId=182208#comment-182208
Document generated by Confluence on Feb 08, 2007 14:05
Page 256
Posted by mrjcleaver at Jul 25, 2006.
.....................................................................................................................................................................
For collaboration teams, it would be ideal if team users could open the link to the attached powerpoint
presentation, make modifications, and when they save the presentation, the attachment is updated
Posted by i4g at Nov 06, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 257
Finding an Attachment
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Space attachments
To find an attachment associated with a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Attachments' tab. This will display a list of all attachments in the space. You can view
the attachment itself or the page to which it is attached by clicking on the corresponding link.
Browse through the list to locate the attachment. Or else, use the 'Filter by Extension' option to
search for a file format.
Screenshot : Space Attachments
Page attachments
To find attachments associated with a page,
Go to the page and click on the 'Attachments' tab. This will display a list of all files attached to the page.
Click on a link to view the corresponding attachment.
Screenshot : Space Attachments
Handy Hint
If you know the title of an attachment, you might find it faster by doing a Quick Search.
Unsure what an attachment is? See Working with attachments
RELATED TOPICS
Document generated by Confluence on Feb 08, 2007 14:05
Page 258
Attaching Files to a Page
Viewing Attachment Details
Deleting an Attachment
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 259
Linking to Attachments
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Once you attach a file, you can easily provide a link to it from the page.
While image attachments can be displayed in a page, other types of attachments can be referenced, like
this:
What you need to type
[^Working with attachments.pdf]
What you will get
Working with attachments.pdf
Where:
'Working with attachments.pdf' is the name of the file you want to link to.
You can also use the Rich Text editor to link to an attachment.
Linking to an attachment in another page
You can link to any attachment on your site using the following syntax.
Attached to another page in the same space
[link alias|pagetitle^attachment.ext|link tip]
Attached to another page in another space
[link alias|spacekey:pagetitle^attachment.ext|link tip]
Optionally,
• use an alias to refer to the attachment
• provide a link tip for the link
Usage example:
This is a link to this page - myself
RELATED TYPES
Rich Text-Linking to an attachment
Displaying an Image
Document generated by Confluence on Feb 08, 2007 14:05
Page 260
Attaching Files to a Page
Take me back to Confluence 2 Home
Comments
Is it possible to link to attachments in another page?
Posted by thomasvdv at Dec 15, 2005.
.....................................................................................................................................................................
Thomas,
Yes, it is possible to link to attachments anywhere on your site.
I have updated the documentation above. I hope it answers your questions.
Cheers,
Vidya
Posted by vidya at Dec 15, 2005.
.....................................................................................................................................................................
Is it possible to link to a specific version of an attachment?
Posted by ckrul at Feb 02, 2006.
.....................................................................................................................................................................
When I insert a link to a attachment, it works real fine.
But as soon as I edit the same page for a second time, the links change automatically from
[^Working with attachments.pdf] to [Working with attachments.pdf]
Seems like a bug to me!
Posted by tattva at Feb 03, 2006.
.....................................................................................................................................................................
Did you manage to find a solution to this?
Jon
Posted by jwilson@lohika.com at Feb 21, 2006.
.....................................................................................................................................................................
If the full URL is specified, you can specify a version like this:
http://confluence.atlassian.com/download/attachments/133726/view.gif?version=1
Document generated by Confluence on Feb 08, 2007 14:05
Page 261
I don't know if it's possible to use wiki markup to do a similar thing...
Posted by gfraser at Feb 21, 2006.
.....................................................................................................................................................................
It's not -- at least with the version of Confluence we are using (1.4.4 build #221). I assumed it was
possible, however, since when you link to an attachment using wiki markup, the link text shows this:
https://my.server.x/confluence/download/attachments/2946/my+attached+file.zip?version=1
Note the version information on the end of the link! This would naturally lead you to suspect that
including another version is possible using wiki markup. However, I could not get this to work, and have
resorted to using the 'full link method' you suggest.
This has obvious disadvantages, though, not least the fact that the tooltip on attachments linked in this
way now says "Visit page outside Confluence"
Cheers,
Ed
Posted by edbradburn at Mar 21, 2006.
.....................................................................................................................................................................
Vidya,
the above works well with regular pages, but when I try to insert a link in a weblog entry to an
attachment located on another confluence page, it does not work, e.g. "[Page^attachment.txt]". A
page-link however, works: "[Page]".
Bug or Feature? Or have I missed something here?
Thanks
Andreas
Posted by adeimer at Mar 21, 2006.
.....................................................................................................................................................................
Just a minor comment: I would have found it helpful if this page would say that a link to an attachment
will always open the latest version of the attachment if no explicit version number is specified.
Posted by davida at Sep 05, 2006.
.....................................................................................................................................................................
hello
Posted by zhaoxin@symbio.com.cn at Sep 05, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 262
Is it possible in CALENDAR plugin to add a link to an attachment. for an event.
For example, If I am delivering a setup to a client, I would like to mark in my calendar that on December
4 I delivered a setup to the client along with the setup.exe.
Posted by dhondia at Dec 05, 2006.
.....................................................................................................................................................................
Confluence external links to attachments are very difficult to use because they require knowledge of
arbitrary page IDs.
Example:
http://confluence.atlassian.com/download/attachments/133726/view.gif?version=1
How can any external program easily know that when it wants to link to the view.gif attachments on the
"Home" page of the "DevTalk" wiki space, it needs to somehow know that is page 133726. An alternative
form of linking should also be offered:
http://confluence.atlassian.com/download/attachments/DevTalk/Home/view.gif?version=1
Also, this second type of URL is much easier to deal with when doing conversions from Twiki to
Confluence, since they use a /pub/spacename/pagename/attachmentfilename format for their links.
Posted by garnetr at Dec 11, 2006.
.....................................................................................................................................................................
Is it possible to insert a table of the attachments to the actual page? (e.g you can see from the page
what the attachments without requesting to view the page's attachments)
Posted by oferb@expand.com at Dec 19, 2006.
.....................................................................................................................................................................
Obviously allowing the version to be specified would be nice, for example:
[^Working with attachments.pdf]
to
[^Working with attachments.pdf#1]
or some tag to signify version number.
The long way would be to just link the entire shortcut, such as:
[http://confluence.atlassian.com/download/attachments/145958/Working+with+attachments.pdf?version=1]
One method might help others:
• create Shortcut Link in Administration, such as:
Document generated by Confluence on Feb 08, 2007 14:05
Page 263
wikiattach => http://confluence.atlassian.com/download/attachments/
• then use shortcut providing rest of link, such as:
[145958/Working+with+attachments.pdf?version=1@wikiattach]
I assume this would then allow wikiattach to change URL/Port, but the rest of the link would stay the
same.
Posted by kgossage at Jan 26, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 264
Viewing Attachment Details
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To view the properties of an attachment associated with a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Attachments' tab. This will display a list of all the attachments in the space. Each
attachment is displayed along with its details. See screenshot 1 below.
To view the properties of an attachment associated with a page,
1. Go to the page.
2. Click on the 'Attachments' tab. This will display a list of all the attachments in the page along with
their details. For each attachment, links are also provided to edit the attachment's details and to
delete the attachment. See screenshot 2.
Attachment Details:
• The Size tells you how much space the attachment takes up. You can sort by size by clicking the
column title.
• The Creator is the user who attached this file. Clicking on the link takes you to their profile.
• The Date is the date the file was attached. You can sort by date by clicking the column title.
• The Comment is a short description for the attachment.
• The Edit link lets you edit the attachment details.
• The Remove link lets you delete the attachment.
Screenshot 1: Space Attachment Details
Screenshot 1: Page Attachment Details
Unsure what an attachment is?
RELATED TOPICS
Working with Attachments
Document generated by Confluence on Feb 08, 2007 14:05
Page 265
Finding an Attachment
Deleting an Attachment
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 266
Working with Page Families
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
In Confluence, you can organize pages into a hierarchy of parent and child pages. Pages in such a
hierarchy are called a 'page family'.
Page families are a simple but effective way of categorizing content and making navigation of your site
easier by providing links forward and backwards through the page hierarchy. Read more about page
families.
What would you like to do?
View a Page's Family
View a Page's Location within a Space
View Hierarchy of all Pages within a Space
View the Children of a Page
Create a Child page
Change Parent of a page
RELATED TOPICS
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 267
Breadcrumbs
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The breadcrumbs of a page display its location in the content hierarchy of Confluence. They trace the
path from the current page back to the dashboard allowing easy navigation up and down the page
hierarchy.
The breadcrumbs are displayed at the top of every page.
If you glance up at the breadcrumbs region of this page, above the title, you will see that it reads:
Dashboard > Confluence 2.0 User Guide > Working with Page Families > Breadcrumbs
This means that this page is a child of 'Working with Page Families' which in turn is a part of the space
'Confluence 2.0 User Guide'.
RELATED TOPICS
Working with Page Families
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 268
Changing Parent of a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To change the parent of an existing page,
1. Go to the page and click on the 'Edit' tab.
2. Click 'Edit' beside 'Location'.
The space in which the page is located will appear by default in the 'Space' drop down menu.
If
you wish to select a parent in another space, you will need to move the page to that space. A child
cannot have a parent in a different space
3. Use the Choose a page option to locate the parent page. Or else simply type in the name of the
parent page.
4. Click 'Save'.
RELATED TOPICS
Move a Page Family
Read about Page Families
View Hierarchy of a Page
Viewing a Page's Location within a Space
View Hierarchy of all Pages within a Space
View the Children of a Page
Working with Pages
Take me back to Confluence 2 Home
Comments
When I change the parent of a page A, page A's relationship with its children are dropped, thus orpaning
those pages (making them show up on the root menu). This was not the result I was expecting. In fact, it
makes reorganizing the hierarchy very cumbersome. Is there a solution to this problem?
Posted by tmcken at Apr 05, 2006.
.....................................................................................................................................................................
I am getting the same, within the same Space... If moving to another space, then it asks if it should
move the chield pages. But within the same space, nothing is moved in real, only relations are (should
be) updated: I don't know why that relationships become broken down...
Posted by murat.eksioglu@oksijen.com at May 12, 2006.
.....................................................................................................................................................................
The bug mentioned above occurs in Confluence 2.1.3, 2.1.4 and 2.1.5a.
It is [fixed in Confluence 2.2].
Posted by mryall at Jul 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 269
Is there anyway to manipulate the hierarchy of a page with macros?
Thanks.
Posted by vlaurenz at Nov 10, 2006.
.....................................................................................................................................................................
Currently I'm trying do create a new wiki space. There seems to exist a hierarchy of pages, but I cannot
influence the hierarchy. There is no option for me to change the parent of the page. Is there some
(hidden) flag that allows or denies the changing of the parent of a page? I'm using Confluence 2.2.8
(which is a pretty current version, I think).
Posted by mliebelt at Dec 25, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 270
Creating a Child Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To create a child page, you require 'Create Pages' permission which is assigned by a space administrator
from the Space Administration screens. See Space permissions or contact a space administrator for more
information.
Confluence allows you to create child pages in three different ways:
1. Click on the 'Add Page' link from an existing page. Confluence defaults the new page as a child of
the first.
2. Click on the 'Add Page' link from anywhere else in Confluence and select the parent page by using
the Choose a Page option.
3. Click on the 'Add Child Page' link that is displayed when you choose to 'show' children of a page.
This option is available only when the page already has children.
RELATED TOPICS
Working with Page Families
View the Children of a Page
Change Parent of a Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 271
Viewing a Page's Family
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To view a page's family, go to the page and click on the ' Info' tab.
The page's parent and children, if any exist, are listed under the heading 'Hierarchy'.
If there are more than 10 children, only the first 10 will be shown by default. To view all the children,
click 'Show all'. Click 'Hide all' to hide them again.
Screenshot : Viewing a page's family
Note
If no parent is displayed for the page, either the page sits in the root directory of the space or its
parent has been deleted.
RELATED TOPICS
What is a Page Family?
Viewing a Page's location within a Space
View Heirarchy of all Pages within a Space
View the Children of a Page
Create a Child page
Change Parent of a Page
Orphaned Pages
Take me back to Confluence 2 Home
Comments
Is there a way to sort the list of child pages other than by the date they were created?
Posted by b.remedios at Feb 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 272
Viewing a Page's Location within a Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To view a page's location within the hierarchy of its space, click on the ' View in hierarchy' link at the
bottom of the page.
This link is only displayed if the page has children.
Screenshot : Viewing a page's location in the space's hierarchy
Alternately, the breadcrumbs or the 'you are here' path at the top every page display the page's location
in the space's hierarchy.
RELATED TOPICS
Learn about Page Families
View a Page's Location within a Space
View the Children of a Page
Create a Child Page
Change Parent of a Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 273
Viewing Children of a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence displays the children of a page, if any exist, in one of two views configured globally by a site
administrator:
Show : In this view, a list of the page's children is displayed as links at the bottom of the page. Clicking
on a link will take you to the corresponding child page.
Hide: In this view, the list of the page's children is hidden when you view the page. A link at the bottom
of the page tells you how many children the page has. Clicking on this link will display the list of its
children.
Screenshot : Show children
• to hide the list of children, click on 'Hide Children'.
• to view the location of the page in the space's hierarchy, click on ' View in hierachy'
• to add a new child page, click on 'Add child page'
Screenshot : Hide children
Note
Confluence defaults the view to 'Show' or 'Hide' children based on what your preference was on
your last visit to the site.
RELATED TOPICS
Children Display Macro
What is a page family?
View Hierarchy of a Page
Create a Child Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 274
Document generated by Confluence on Feb 08, 2007 14:05
Page 275
Viewing Hierarchy of Pages within a Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The 'Tree View' under the 'Browse Space' mode displays the hierarchy of the pages within the space. It
is a useful way of viewing all the parent-child relationships between pages in the space at a single glance.
To see the tree view of pages within a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Pages' tab and click on the link 'Tree View'. Click on the expand icon to view the
children of a page.
Screenshot : Tree View
RELATED TOPICS
Read about page families
Viewing a Page's Location within a Space
View the children of a page
Create a child page
Change parent of a page
Working with pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 276
What is a Page Family?
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
In Confluence, you can organize pages into a hierarchy of parent and child pages. Pages in such a
hierarchy are called a 'page family'.
Page families are a simple but effective way of categorizing content and making navigation of your site
easier by providing links forward and backwards through the page hierarchy.
A parent page is at the topmost level of that hierarchy.
For example, in your organization, you may have a space for 'Fun'. Under this space you could have the
following pages:
Screenshot : Page Family
The 'Recreation' page in this hierarchy is the parent page and the 'Sports', 'Music' and 'Up Coming Trips'
pages are its child pages. Together, they comprise a page family.
Confluence will only allow you to create page families that are a simple tree. What this means is that you
can create any number of nested families but a child can have only one parent.
RELATED TOPICS
Viewing a Page's Family
Viewing a Page's Location within a Space
View Hierarchy of all Pages within a Space
View the Children of a Page
Create a Child Page
Change Parent of a Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 277
Dashboard
This page last changed on Jan 14, 2007 by rosie@atlassian.com.
The Dashboard is the front page of a Confluence site. It provides an overview of the site, access to all
spaces to which you have 'view' permission, and displays a list of the most recently updated content
within them.
You can go to the Dashboard from any page on your site by clicking on the logo beside the page title or
via the breadcrumbs (the "You are here" path) located at the top of every page.
The dashboard is divided into five sections:
1. The Welcome Message for the site, which is configured from the Administration Console.
2. A list of the spaces within the site to which you have access, presented via convenient tabs: 'My',
'Team', 'New' or 'All' spaces. See Customising the Dashboard.
3. A list of the most Recently Updated documents on the site from the spaces listed. For example, if
you click on the tab 'Team', the recently updated content from your team spaces will be listed here.
4. A list of your Favourite Pages. See Working with Favourites.
5. Useful links:
a.
— see Setting up a New Global Space
b.
— see Using the RSS Feed Builder
c.
— see Searching the People Directory
The Dashboard is the only place in Confluence from where you can:
• access all existing spaces on the site.
• add a new space to the site.
By default, the Dashboard is also the site homepage. However, you can set any other page in Confluence
as the homepage via the Space Admin tab or your User Profile settings.
Screenshot : Dashboard
Document generated by Confluence on Feb 08, 2007 14:05
Page 278
RELATED TOPICS
Confluence Glossary
Confluence Icons
Working with Spaces Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 279
Customising the Dashboard
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can customise the Dashboard to provide access to the content on the site that is most relevant to
you.
Here's how:
1. Add spaces as your favourites.
Once you add spaces as your favourites, you can click on the 'MY' tab in the spaces section of the
Dashboard to view a list of only your favourite spaces. The 'Recently updated' section in this view will
also display content only from these spaces.
2. Provide spaces with Team labels.
Team labels are used to group together related spaces. For example, you may want to group together all
spaces relating to a project team. Once you add team labels, you can click on the 'Team' tab in the
spaces section, select a team from the drop down menu, and have only the list of spaces pertaining to
that team displayed. The 'Recently updated' section in this view will also display content only from
these spaces.
The Dashboard remembers which one of the views, 'My', 'Team', 'All' or 'New' you were most recently
viewing. So if you clicked the 'MY' tab on this visit, next time around, as soon as you log in to Confluence,
only the list of your favourite spaces and the recently modified content within them will be displayed to
you.
3. Add pages as your favourites.
Whichever view you are in, the Dashboard will display a list of your five most recently added favourite
pages, so you can access those pages easily.
Screenshot : The Dashboard
Document generated by Confluence on Feb 08, 2007 14:05
Page 280
RELATED TOPICS
Working with Labels Overview
Working with Favourites Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 281
Exporting a Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to export a part of, or the entire contents of a space to HTML, PDF or XML.
What would you like to do?
Export from Confluence to PDF
Export from Confluence to HTML
Export from Confluence to XML
RELATED TOPICS
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 282
Confluence to HTML
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to export a part of, or the entire contents of a space into a zipped archive of HTML
files. This is useful if you want convert your space into a static web site.
To export to HTML, you will need 'Export Space' permission which is assigned by a space administrator
from the Space Administration screens. See Space Permissions or contact a space administrator for more
information.
To export to HTML,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page or beside
the space link on the dashboard.
2. Go to the 'Advanced' Tab and click on ' Export Space' in the left panel.
3. Click the radio button to select HTML from the list of export options.
4. Check the box 'Include Comments' if you want to include comments for the pages you are
exporting.
5. Select the pages you want to export by checking the boxes in the tree view of pages displayed. By
default, all pages are selected. You have the option to 'Check All' or 'Clear All' pages. See
screenshot.
6. Click 'Export'. This will create a zipped archive of html files.
7. Extract the files into a folder.
• Page attachments are placed in individual folders named using the format :
'nameofpage_attachments'.
• By default, the 'Space Details' page is exported as index.html and displays the space's details as
well as a list of all available pages within it.
Screenshot : Select Pages
RELATED TOPICS
Confluence to PDF
Confluence to XML
Document generated by Confluence on Feb 08, 2007 14:05
Page 283
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 284
Confluence to PDF
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to export a single page, a part of a space, or an entire space into a single PDF file.
You can export a single page in Confluence to PDF simply by clicking the pdf
icon located at the top of
each page below the Quick Search box.
If you wish to export particular pages or entire space, follow the instructions below.
To export to PDF, you will need 'Export Space' permission which is assigned by a space administrator
from the Space Administration screens. See Space Permissions or contact a space administrator for more
information.
To export to PDF,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Advanced' tab and click on 'Export Space' in the left panel.
3. Click the radio button to select PDF from the list of export options.
4. Check the box 'Include Comments' if you want to include the comments for the pages you are
exporting.
5. Select the pages you want to export by checking the boxes in the tree view of pages displayed. By
default, all pages are selected. You have the option to 'Check All' or 'Clear All' pages. See
screenshot.
6. Click 'Export'. This will create a zipped file of the PDF document.
7. Extract the zip file. Click on the PDF file to launch it.
Notes
Only image attachments which have been inserted into a page are included when exporting to
PDF.
To export a PDF containing international text, you need to install a Unicode font in Confluence.
Screenshot: Selecting pages to export
Document generated by Confluence on Feb 08, 2007 14:05
Page 285
RELATED TOPICS
Create PDF in another language
Confluence to HTML
Confluence to XML
[DOC:Customise Adobe PDF Exports]
Take me back to Confluence 2 Home
Comments
Is it possible to export a page family?
Posted by osolage at Dec 07, 2005.
.....................................................................................................................................................................
Osolage,
Yes, it is possible to export a page family to pdf. You need to follow the same steps outlined in the
documentation above. Just select the pages in the family you want to export. Confluence displays the
pages in a tree view, so this should be easy.
Cheers,
Vidya
Posted by vidya at Dec 07, 2005.
.....................................................................................................................................................................
Is there a way to access in page.pdfexport.vm the full user name instead of the login name? Which
velocity context object do I need?
Cheers,
Dennis
Posted by d.reiter at Dec 15, 2005.
.....................................................................................................................................................................
Hi Dennis,
At the moment, there is no easy way to access a user's full name (or other information) from the
PDF/HTML export templates. The macros.vm file contains a 'usernameLink' macro which would be quite
useful, except that it relies on the action hierarchy to be present, so scratch that...
The other option is to access the UserUtils.getUser() method, where you pass in the username and it
returns back to you a User object (from which you can get the full name, etc). However this is not in the
Velocity context by default. The easiest way to get it into the context would be to add a method to
GeneralUtil (which IS in the context) that accesses UserUtils and returns the User object.
e.g. you might put this into GeneralUtil:
Document generated by Confluence on Feb 08, 2007 14:05
Page 286
public User getUser(String username)
{
try
{
return UserUtils.getUser(username);
}
catch (EntityNotFoundException e)
{
return null;
}
}
Hope this helps,
Jeremy
Posted by jeremy@atlassian.com at Dec 15, 2005.
.....................................................................................................................................................................
Hi,
following up this diskussion the way to output high quality PDFs and other formats would probably be
using confluence API from JAVA and connect it with a good formatting engine which allows PDF output. I
personally prefere products as compart DOPE (http://www.compart.net/Products/Dope-compose.html) or
the famous renderx fop engine (www.renderx.com).
My best,
M.A.Bednarz
Posted by javaarchitect at Mar 25, 2006.
.....................................................................................................................................................................
When you export the whole space to PDF the order of pages in the PDF is not the same as the order of
the pages in the page tree. It appear to be ALPHA ordered in the PDF, so I spent a couple of hours
renaming all my pages to have titles in the correct alpha order. Except, the order of pages isn't ALPHA:
it's WIERD. It is consistent between exports, but no discernable pattern. So the export is nearly useless...
Posted by neil.benson@increaseconsulting.com at Apr 27, 2006.
.....................................................................................................................................................................
It would be helpful to make the page selection tree on the Export page more intelligent. If a page is
unticked, its descendants should also be unticked (or at least greyed) and the reverse. Needs some
thinking about, but I think that an isolated tick per page is not powerful enough.
Posted by davida at Oct 31, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 287
Create PDF in another language
This page last changed on Oct 17, 2006 by david.soul@atlassian.com.
To export a Confluence page written in another language, you will first need to install the necessary font
for that language. This will basically involve uploading a font file to Confluence.
Here are the exact steps on how to do this:
1. Find the appropriate font file
Windows users
All font files in Windows are stored in a directory called
C:\WINDOWS\Fonts
Unix users
All font files in Unix are stored in the
/usr/share/fonts
Microsofts True Type core fonts such as Verdana can be downloaded here
http://corefonts.sourceforge.net/
2. Copy the font file into a temporary folder (for example a folder on the
Desktop)
3. Navigate to the Administration > PDF Language Support screen and upload
the file you copied in step one.
Click Install and that's it!
Please note the only font files supported are true type fonts and true type collections (file
extensions are *.ttf and *.ttc).
We recommend you to use Unicode font Verdana for correct character encoding and exporting to
pdf.
Document generated by Confluence on Feb 08, 2007 14:05
Page 288
Confluence to XML
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to export a part of, or the entire contents of a space into a zipped archive of XML
files.
This is useful if you want to take a backup of the space, export the space to another Confluence instance,
or wish to use the data from the space in another application.
To export to XML, you will need 'Export Space' permission which is assigned by a space administrator
from the Space Administration screens. See Space Permissions or contact a space administrator for more
information.
Site administrators can import a space from a zipped archive of its xml files.
To export to XML,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page or beside
the space link on the dashboard.
2. Go to the 'Advanced' tab and click on 'Export Space' in the left panel.
3. Click the radio button to select XML from the list of export options.
4. Check the box 'Include Comments' if you want to include comments for the pages you are
exporting.
5. Check 'Backup Attachments' if you want include all attachments for the space in the export.
6. Select the pages you want to export by checking the boxes in the tree view of pages displayed. By
default, all the pages are selected. You have the option to 'Check All' or 'Clear All' pages. See
screenshot.
7. Click 'Export'. This will create a zipped archive of XML files.
Screenshot 2 : Select Pages
RELATED TOPICS
Confluence to PDF
Confluence to XML
Document generated by Confluence on Feb 08, 2007 14:05
Page 289
Take me back to Confluence 2 Home
Comments
Its somewhat confusing that Export Space is under Advanced but that Import Space is under Space
Admin!
Posted by mrjcleaver at Apr 04, 2006.
.....................................................................................................................................................................
[Import space] is actually under 'Backup & Restore' in Administration. Importing pages from disk is in
Space Admin. This is logical if you consider the permissions required to access the action:
• all users can export a space (as long as they have 'export' permission)
• only space administrators can import pages from disk
• only Confluence administrators can import an entire space.
Posted by mryall at Oct 23, 2006.
.....................................................................................................................................................................
Is there a way to export user groups? This would be very helpful to us.
Posted by david.trier at Jan 24, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 290
Exporting to a Word document
This page last changed on Nov 30, 2005 by cmiller.
Confluence allows you to export a single page into a Word document. This is extremely useful for
emailing around content to non-Confluence users, printing a document or just creating a backup in Word.
You will require 'Export Pages' permission to export a page to a Word document.
To export to a Word document,
1. Click on the 'Info' tab of the page.
2. In the first box displayed, click 'Word' beside 'Export As'. By default, this will create a Word
document with the same name as the Confluence page.
Screenshot : Export to Word
Document generated by Confluence on Feb 08, 2007 14:05
Page 291
Working with Links Overview
This page last changed on Jan 04, 2007 by rosie@atlassian.com.
Confluence tries to encourage linking by making it simple as possible. You can link to content anywhere
within Confluence or an external site just as easily, using the same syntax. Confluence also gives you the
flexibility to do some pretty complicated things with links.
You can create links to and from any of the editable content on the site:
• Pages in the same space, in another space, or outside Confluence
•
•
•
•
•
News items
Comments
User profiles or personal spaces
Mail messages
Attachments
Links in Confluence are always denoted by square brackets. Whenever you place text between square
brackets, Confluence recognises it as a link.
Handy Hint
Links in Confluence will not break even when you move content between spaces on your site!
RELATED TOPICS
Rich Text-Creating a New Link
Changing the Title of a Link
Linking to Comments
Working with Anchors
CamelCase Linking
Trackback
Take me back to Confluence 2 Home
Comments
A very simple question:
How can i unlink a word without making the necessary changes in the "Wiki Markup" tab?
I think it is not possible to remove a link in the WYSIWYG Editor...
Posted by loetterle at Sep 14, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 292
CamelCase linking
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
CamelCase is a form of markup used in many wikis where words capitalized and compounded together
without spaces LikeThis, are used to create links.
By default, CamelCasing is not enabled in Confluence. However, a site administrator can turn on
CamelCasing from the Administration Console.
To link to a page in the same space using CamelCase linking
What you need to type
Unknown macro: {nomarkup}
What you will get
CamelCasePage
CamelCasePage
where:
'CamelCasePage' is the name of the page you want to link to.
To link to a page you intend to create later (undefined page) using CamelCase linking
Confluence allows you to create links first and add add content to pages later. This type of a link is an
undefined link and is indicated with the plus sign. Clicking on the link will bring up a screen where you
can add content for the page.
What you need to type
Unknown macro: {nomarkup}
What you will get
NonExistentPage
NonExistentPage
where:
'NonExistentPage' is the title of the page you intend to create later.
To ensure a CamelCase word does not become a link
(Confluence 2.1.3 or later)
Sometimes you may wish to use a CamelCase word in a page, but do not want it to be drawn as a link.
You can accomplish this using the {nolink} macro:
What you need to type
Document generated by Confluence on Feb 08, 2007 14:05
What you will get
Page 293
Unknown macro: {nomarkup}
SomeWord
SomeWord
Unknown macro: {nomarkup}
SomeWord
SomeWord
{nolink} and {nl} do the same thing, just use whichever you find more convenient.
The {nolink} and {nl} macros are only available in Confluence 2.1.3 or later. In versions of Confluence
prior to 2.1.3, there is no way to prevent a CamelCase word from becoming a link short of disabling
CamelCase linking across the entire Confluence site.
RELATED TOPICS
Working with links
Take me back to Confluence 2 Home
Comments
You may better explain, what CamelCase is? I havent catched it after reading this page.
Posted by f.marx@enbw.com at Nov 08, 2006.
.....................................................................................................................................................................
CamelCase is the art of writing multiple words together without using a space (instead using mixed case
letters). It's a developer centric way of writing clear variable names or unclear wiki links.
Posted by ahardy at Nov 20, 2006.
.....................................................................................................................................................................
Ok. And using CamelCase is a way for automatic linking. So when writing CamelCase a link ist
autmaticaly generated without any brackets. Turning on CamelCase then means that these links are
generated. I think you have to say this.
Posted by f.marx@enbw.com at Nov 20, 2006.
.....................................................................................................................................................................
Correct. Except CamelCase is already switch on by default....and developers automatically write
everything in CamelCase. Meaning confluence has a heart attack adding links everywhere, make pages
harder to read. Make links explicit by using [link name] convention or [space name:link name] if linking
to a page outside current space.
Posted by ahardy at Nov 20, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 294
CamelCasePage
This page last changed on Jan 18, 2006 by cmiller.
This page is a demonstration of a page that can be linked to using CamelCase linking. You can find more
information on the subject here.
Document generated by Confluence on Feb 08, 2007 14:05
Page 295
Changing the Title of a link
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Sometimes, you may need to change the default labels for links if they are not particularly informative or
attractive, and especially if you are including the links in the middle of your own text.
To change the title of a link,
What you need to type
Unknown macro: {nomarkup}
What you will get
the current release notes
the current release notes
Where:
'the current release notes' is your new label.
'Release Notes' is the name of the page you want to link to.
Example: Changing the title of a news item
What you need to type
Unknown macro: {nomarkup}
What you will get
an article on the subject
an article on the subject
Where:
'an article on the subject' is how you want to refer to the news item
'/2005/08/26/' is the date the news item was published.
'Sample News'' is the actual title of the news item
Example: Combining inter-space links and labelled links
What you need to type
Unknown macro: {nomarkup}
What you will get
What can Confluence do for you?
What can Confluence do for you?
Where:
'What can Confluence do for you?' is your label.
'DS' is the space key of the space the page you want to link to is located.
'Confluence Overview' is the name of the page in that space.
Document generated by Confluence on Feb 08, 2007 14:05
Page 296
RELATED TOPICS
Linking to Pages Within the Same Space
Linking to Pages in Another Space
Linking to Web Pages
Take me back to Confluence 2 Home
Comments
I noticed that you can use an image as an alias for a link, even though I could not find this in the
documentation for either linking or images !!
Posted by detlev.mueller@bluescopesteel.com at Jan 31, 2006.
.....................................................................................................................................................................
Thanks Detlev, for pointing that out. I have documented it here.
Cheers,
Vidya
Posted by vidya at Jan 31, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 297
Release Notes
This page last changed on Aug 18, 2005 by vidya.
Start of release notes content
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras
rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada
massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat
eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac
magna. Suspendisse euismod libero eget mauris.
End of release notes content
Document generated by Confluence on Feb 08, 2007 14:05
Page 298
Linking an Image
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To link an image to a page,
What you need to type
Unknown macro: {nomarkup}
What you will get
[!dochome.gif!]
[!dochome.gif!]
To link an image attached to another page,
What you need to type
Unknown macro: {nomarkup}
What you will get
[!Displaying an Image^fish.gif!]
[!Displaying an Image^fish.gif!]
RELATED TOPICS
Working with Links Overview
Displaying an Image
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 299
Linking to Pages in Another Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To link to a page in a different space
What you need to type
Unknown macro: {nomarkup}
What you will get
DS:Confluence Overview
DS:Confluence Overview
where:
'DS' is the space key of the space you are linking to, in this instance, the Demonstration Space.
'Confluence Overview' is the name of the page in the space, 'DS'.
To link to the homepage of another space
What you need to type
Unknown macro: {nomarkup}
What you will get
DS:
DS:
where:
'DS' is the space key of the space you are linking to, in this instance, the Demonstration Space.
The space key is the short name displayed in parentheses beside each space name on the dashboard,
and in various other places across the site.
Handy Hint
You can also create a link to any Confluence page by clicking 'Insert Link' when you are in the
'Edit' mode of a page. A pop-screen allows you to select pages from anywhere within Confluence.
Selecting a page creates a link to that page.
RELATED TOPICS
Link to a Page within a Space
Link to a Web Page
Working with Links
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 300
Linking to Pages Within the Same Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can either use Confluence Notation or use the Rich Text editor to link to Confluence pages.
In Confluence notation, links are always denoted by square brackets. Whenever you place text between
square brackets, Confluence recognizes it as a link.
To link to a page in the same space
What you need to type
Unknown macro: {nomarkup}
What you will get
Confluence 2 Home
Confluence 2 Home
where:
'Home' is the name of the page you want to link to.
To link to a page you intend to create later (undefined page)
Confluence allows you to create links first and add add content to pages later. This type of a link is an
undefined link and is indicated with the plus sign. Clicking on the link will bring up a screen where you
can add content for the page.
What you need to type
Unknown macro: {nomarkup}
What you will get
Link to new page
Link to new page
where:
'Link to a new page' is the title of the page you intend to create later.
You can also create a link to any Confluence page by clicking 'Insert Link' when you are in the
'Edit' mode of a page. A pop-screen allows you to select pages from anywhere within Confluence.
Selecting a page creates a link to that page.
RELATED TOPICS
Link to a Page in Another Space
Link to a Web Page
Working with Links
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 301
Comments
I think it should be "where: *Confluence 2.0 Home* is the name of the page you want to link to" rather
than just "where: *Home* is the name..."
Posted by mikec at Jun 15, 2006.
.....................................................................................................................................................................
A helpful subitem here would be 'Renaming a page' without breaking existing incoming links. Thanks.
Posted by jbibbee@internet2.edu at Sep 07, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 302
Linking to Web Pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To link to a web page outside Confluence,
What you need to type
Unknown macro: {nomarkup}
What you will get
http://www.atlassian.com/software/confluence
http://www.atlassian.com/software/confluence
Where:
Unknown macro: {nomarkup}
'http://www.atlassian.com/software/confluence'
is the url that you want to link to.
Confluence will also try to find URLs within the text of the page and convert them into links, but it may
have trouble separating the link from its surrounding text, especially when punctuation is involved.
Putting the link inside square brackets will ensure that it is interpreted the right way.
You can also use the Rich Text editor to link to a webpage.
RELATED TOPICS
Rich Text-Linking to a page
Linking to Pages Within the Same Space
Linking to Pages in Another Space
Working with Links Overview
Take me back to Confluence 2 Home
Comments
when looking at confluence wiki markup, I was surprised that no way was described for displaying text
rather than the url. Shouldn't an example be given for that ?
Atlassian Confluence
Posted by d.thomas@its.uq.edu.au at May 25, 2006.
.....................................................................................................................................................................
oops could my previous comment be removed ?
when looking at confluence wiki markup, I was surprised that no way was described for displaying text
rather than the url. Shouldn't an example be given for that ?
What you need to type
Document generated by Confluence on Feb 08, 2007 14:05
What you will get
Page 303
Unknown macro: {nomarkup}
Atlassian Confluence
Atlassian Confluence
Posted by d.thomas@its.uq.edu.au at May 25, 2006.
.....................................................................................................................................................................
Can you force a link to open in another window?
Posted by seamonk at Jun 21, 2006.
.....................................................................................................................................................................
I also want to do that: I don't want external links to mean the user leaves my site. A refinement would be
default those links to be in a new window, unless I specify otherwise.
Posted by mrjcleaver at Jul 23, 2006.
.....................................................................................................................................................................
[CONFEXT:New window macro]
Posted by bob.swift@lakeviewtech.com at Jul 23, 2006.
.....................................................................................................................................................................
Is there a standard macro for the server confluence is on, so you can do something like this:
[
Unknown macro: {ServerURL}
/foo/bar.html]
?
Posted by daveyost at Sep 23, 2006.
.....................................................................................................................................................................
Is there a possibility to generate some Quicklinks for individual resources. I think this is simmilar to the
comment befor.
e.g. We often want to generate a link like this:
myservice://asdf.asdf.com/home/service/ Linkme?c=asdf
Genereting this link just by typing [{myservice|Linkme}] or simmilar would be great!
Is there a possibility to do that?
Posted by f.marx@enbw.com at Oct 23, 2006.
.....................................................................................................................................................................
Thanks. Found it at: Shortcut Links.
Posted by f.marx@enbw.com at Nov 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 304
OK, I was trying to find out how to SUPPRESS this automatic recognition of URLs, like
Unknown macro: {nomarkup}
http://foo.bar/baz
instead of http://foo.bar/baz, and found the useful nomarkup macro used liberally on this page. But our
confluence installation (2.2.9 build 527) doesn't seem to have that. Is that some secret atlassian macro?
Posted by marvingreenberg at Dec 06, 2006.
.....................................................................................................................................................................
nomarkup is a user macro which just consists of $body
Posted by tom@atlassian.com at Dec 14, 2006.
.....................................................................................................................................................................
Hi,
I am trying to create a link to Jira from confluence. My requirment is such that anybody who is logged in
Confluence will have access to Jira. For this, I have modified the Authenticator for Jira and have unit
tested it and seems to work fine.
The problem is I am not able to sent the username and password to Jira from Confluence. I tried to set
the username, password in session but nothing worked. Is it possible to get login info in the page using
Macros?
Thnaks
Anirban
Posted by anirban.tarafdar@in.pwc.com at Jan 02, 2007.
.....................................................................................................................................................................
How do I mark up external links similar to this (including "
Unknown macro: {", "}
"):
Unknown macro: {071FF1BF-8462-4634-B23B-42FC9D754B88}
">https://www.extra.filenet.com/getContent?iut=1168632099632278165630&objectStoreName=eXtra&objectType=do
Unknown macro: {071FF1BF-8462-4634-B23B-42FC9D754B88}
Thanks
Patrick
Posted by pchesnot@us.ibm.com at Jan 12, 2007.
.....................................................................................................................................................................
Can I link to an external web page and automatically log into it (enter and execute a username and
password)?
Document generated by Confluence on Feb 08, 2007 14:05
Page 305
Thanks in advance,
JuTomlin
Posted by jutomlin@cisco.com at Jan 25, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 306
Trackback
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Trackback is a mechanism by which two sites can stay informed each time one site refers to the other by
means of trackback 'pings'.
In Confluence, Trackback is enabled by a site administrator from the Administration Console. When
Trackback is enabled, any time you link to an external webpage that supports Trackback Autodiscovery,
Confluence will send a Trackback ping to that page to inform it that it has been linked to.
Confluence pages also support Trackback Autodiscovery, and when Trackback is enabled can receive
trackback pings sent by other sites.
To see who has sent a Trackback ping to a Confluence page,
1. Go to the page.
2. View the Page Information under the Info tab
3. Any Trackback pings the page has received will be listed under the page's Incoming Links
RELATED TOPICS
Linking to Web Pages
Working with Links Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 307
Working with Anchors
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to create anchor links.
Anchors allow you to link to specific places within a page. Anchor links can be especially useful when
navigating between sections of a long page or when you want to link to a segment of a page and not to
the page as a whole.
Anchors are made up of two parts:
• The link
• The content to which you are linking.
In Confluence, you can place an anchor in a page using the anchor macro. This creates an anchor called
"here", but you can substitute this with whatever name you like.
Anchor Macro
{anchor:here}
Once an anchor is in the page, you can link to it by putting #here (or whatever anchor name you choose)
at the end of a link pointing to that page.
For example, there are two anchors in this page called "top" and "bottom", which you can link to like so:
[#top]
[#bottom]
These links come out like this: top bottom.
Linking to an anchor in the same page
[#anchorname]
Linking to an anchor in another page
[nameofpage#anchorname]
Linking to an anchor in a page in another space
[spacekey:nameofpage#anchorname]
Document generated by Confluence on Feb 08, 2007 14:05
Page 308
Linking to headings
Confluence treats all headings as anchors. So you don't have to place an anchor but simply link to it like
this:
[#textofheading]
Warning
Page titles and links to other spaces can be combined with anchors and attachments, but you
can't use attachments and anchors in the same link.
Note that if you are adding an anchor to the site welcome message, it must be to another page. Internal
only links such as {anchor:bottom} will not render.
RELATED TOPICS
Working with Links Overview
Take me back to Confluence 2 Home
Comments
It would be realy nice to be able to have the option to display the text of the anchor.
For example if I put here an anchor Same Text "" I should not repeat the text inside the anchor (unless I
choose to do so or it doesn't make sense to display that anchor.
Posted by otodoran at Dec 21, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 309
Rich Text Editor Overview
This page last changed on Dec 08, 2005 by vidya.
The Rich Text editor provides users accustomed to html or other standard text editing applications, an
easier and faster way to creating Confluence pages. It allows you to enter content as you would in a
Word document, and apply formatting simply by clicking icons on a toolbar.
If you are loyal to wiki markup, you can continue to use it. The 'Edit' screen lets you switch between
'Rich Text' and 'Wiki Markup' edit modes without losing the changes you've made; so you can use a
combination of both while editing. For instance, you can use the rich text editor to change the text colour
and then switch to wiki markup to create links.
You can also default to either 'Wiki Markup' or 'Rich Text' depending on your preference.
Note
A site administrator will need to Enable Rich Text Editing from the Administration Console before
you can start using the Rich Text editor
The Rich Text Editor
RELATED TOPICS
Enabling Rich Text Editing
Making Rich Text or Wiki Markup Editing Default
Rich Text-Working with Text Effects
Document generated by Confluence on Feb 08, 2007 14:05
Page 310
Rich
Rich
Rich
Rich
Rich
Rich
Rich
Rich
Text-Working with Tables
Text-Inserting an Image
Text-Creating a New Link
Text-Linking to an Image
Text-Linking to an Attachment
Text-Linking to a Page
Text-Inserting Emoticons
Text-Inserting Symbols
Comments
Change screenshot?
Posted by vidya at Nov 30, 2005.
.....................................................................................................................................................................
Why does Confluence routinely delete the space directly after a text effect (bold, italic, or underline)? I've
noticed that all the bold text here is written as 'bold'... I'm assuming this is because the problem is
known and there's no plans to fix it. It's very frustrating to have text go from this: "bold text is great!" to
"boldtext is great!"
The same thing happens with italics and underline. Is this a known issue? Is it fixed? What's the deal?
Posted by chris martin at Dec 04, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 311
Enabling Rich Text Editing
This page last changed on Nov 30, 2005 by vidya.
With Confluence 2.0, users have the option of using Confluence's Rich Text editor to create pages. To
enable this option, a site administrator will need to turn on 'Rich Text Editing' from the Administration
Console.
RELATED TOPICS
Rich Text Editor Overview
Making Rich Text or Wiki Markup Editing Default
Document generated by Confluence on Feb 08, 2007 14:05
Page 312
Rich Text-Creating a new link
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To create a new link,
1. Click on this '
' icon in the toolbar. This will pop-up up the ' Link Properties' screen.
2. In the 'Link' text field, enter a name for the link.
In the 'Alias' text field, enter an alias name (if needed).
An alias is used to change the default label of a link if it is not particularly informative or
attractive, and is useful when including the link in the middle of your own text.
3. Click 'Ok' to add the link.
Screenshot : Creating a new link
RELATED TOPICS
Rich Text-Linking to a page
Rich Text-Inserting an image
Rich Text-Linking to an attachment
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 313
Rich Text-Inserting an image
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To insert an image,
1. Click on the toolbar. This will open up the ' Image Properties' window.
2. All attached images are displayed. Click on an image to select it and click 'OK' to insert the image.
3. To attach a new image, ' Browse' to select your file and click 'Attach'.
Screenshot : Inserting an image
RELATED TOPICS
Rich Text-Linking to an attachment
Rich Text Editor Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 314
Rich Text-Inserting emoticons
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To insert an emoticon,
1. Click
on the toolbar. This will pop up the emoticons window.
2. Select the emoticon to insert it.
Screenshot : Emoticons
RELATED TOPICS
Rich Text-Inserting an Image
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 315
Rich Text-Inserting Symbols
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To insert a symbol,
1. Click
on the toolbar. This will pop up the ' Custom Characters' window.
2. Click on the symbol to insert it.
Screenshot : Custom Characters
RELATED TOPICS
Rich Text-Inserting emoticons
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 316
Rich Text-Linking to a Page
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To link to a page in Confluence,
1. Click
on the toolbar. This will open up the ' Link Properties' window.
2. Click on one of these tabs: 'History' or 'Recently Modified' to select the page you want to link to.
or
Do a 'Search' for the page using the search facility and select a page from the search results.
3. Click 'OK'
To link to a page outside Confluence,
1. Click
on the toolbar. This will open up the ' Link Properties' window.
2. Click on 'External Links' tab.
3. Enter the URL of the webpage in the text-entry field and click 'Insert'
RELATED TOPICS
Rich Text-Creating a new link
Take me back to Confluence 2 Home
Comments
Why does Confluence, after linking to a page that already exists, sometimes delete the space the follows
it? For example, if I was linking to the Home page, it might delete the space between the text "Home"
and "page" making it "Homepage". This isn't always happening, it appears to be random and more likely
if you constantly edit the page afterwards. When you go to the Rich Text editor to add a space, there will
already be one there.
You can go into the Wiki Markup editor and fix the problem space, but whenever you edit that page
again, the problem will return - making you go back AGAIN to add the space.
Posted by chris martin at Dec 04, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 317
Rich Text-Linking to an Attachment
This page last changed on Nov 30, 2005 by vidya.
To link to an attachment,
1. Click
on the toolbar. This will open up the ' Link Properties' window.
2. Go to the 'Attachments' tab. All page attachments are listed. Click on the attachment title to select
it and then click 'OK'.
3. If you don't find the attachment you are looking for, you can also attach a new file from here.
'Browse' to select your file and click 'Attach'.
Screenshot : Linking to an Attachment
RELATED TOPICS
Rich Text-Linking to an Image
Document generated by Confluence on Feb 08, 2007 14:05
Page 318
Rich Text-Linking to an Image
This page last changed on Nov 30, 2005 by vidya.
To link to an image,
1. Click on the toolbar. This will open up the ' Link Properties' window.
2. Go to the 'Attachments' tab. All attachments are listed. Click on the image name to select it, and
then click 'OK'.
3. To attach a new image, ' Browse' to select your file and click 'Attach'.
RELATED TOPICS
Rich Text-Linking to an Attachment
Rich Text-Inserting an Image
Comments
Hello,
is there a way to insert images with Copy & Paste. E.g. if you have done a screenshot and want it to
insert directly into Confluence without having to save it with an extra application.
In JIRA there is such a feature, but I haven't found a similar plug-in for Confluence.
Posted by tattva at May 24, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 319
Rich Text-Working with Tables
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To create a table,
1. Click
on the toolbar. This will pop up a window.
2. Enter the number of columns and rows for your table.
3. Check the box if you want a heading style applied to the first row of the table.
4. Click 'Insert'.
Working with Tables
To do this
Click this
Add row (before)
Add row (after)
Delete row
Add column (before)
Add column (After)
Delete column
RELATED TOPICS
Rich Text Editor Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 320
Rich Text-Working with Text Effects
This page last changed on Jan 22, 2007 by rosie@atlassian.com.
The Rich Text editor supports most text effects available in standard text editing applications.
To apply an effect, select the text and click on the icon, or use the shortcut key.
To do this
Click this
Shortcut Key
Bold
ctrl+b
Italics
ctrl+i
Underline
ctrl+u
Strike
Heading
Heading 5
RELATED TOPICS
Rich Text Editor Overview
Take me back to Confluence 2 Home
Comments
ctrl+i doesn't work well in Mac OS X+Firefox. Can you have an alternate for this valuable shortcut?
Posted by greening at Mar 01, 2006.
.....................................................................................................................................................................
It should be ctrl+u for underline not crtl+i
Posted by csummers@lrnelson.com at Jan 22, 2007.
.....................................................................................................................................................................
Fixed - thank you very much.
Posted by rosie@atlassian.com at Jan 22, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 321
Security Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Open or closed? It's your call.
Confluence gives you the choice to make the site as open or as closed as you wish.
As a tool for communication and collaboration, Confluence is best used the more users you have
participating on the site.
So it's advisable to design a security system that doesn't restrict users unless you can think of a
very good reason for doing so. Because Confluence tracks histories of changes, it is easy to see
who has changed what, and to reverse any edits if required.
There are three levels of permissions in Confluence.
Global permissions
Global permissions are site-level permissions.
This topic is covered in the Site Administrator's Guide.
The permission to create a new space or to administrate one is granted by a site administrator from the
global Administration Console.
• Attach Files to User Profile: Users with this permission can attach a picture to their user profile.
• Personal Space: Users with this permission can create a personal space within a Confluence site.
• Create Space: Users with this permission can create new global spaces within a Confluence site.
When a space is created, the creator automatically has the 'Administrate Space' permission for that
space.
• Administrate Confluence: Users with this permission can perform a host of functions relating to
the management of Confluence, including Administration of spaces.
Space permissions
Every space has its own, independent set of permissions. These permissions determine the access
settings for different users of the space.
In order to assign these permissions, a user must be a space administrator (have the 'Administrate
Space' permission) for that space.
See Users and Groups to learn how these permissions are assigned.
Document generated by Confluence on Feb 08, 2007 14:05
Page 322
Page Permissions
You can further set page level restrictions, if you have the permission yourself to 'Restrict Pages'.
Warning
If you misconfigure a space so that nobody has access to administer it any more, you will need to
have someone in the confluence-administrators group fix the permissions for you.
RELATED TOPICS
Users and Groups
Viewing Space Permissions
Assigning Space Permissions
Page Permissions
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 323
Page Level Permissioning
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Page permissions allow you to control who can view or edit individual pages. Page permissions are set
when editing a page from menus below the text-entry box.
A user can restrict the viewing or editing of a page either to themselves, or to a single group to which
they belong. You can only restrict page permissions to a group that you are a member of, to prevent you
from locking yourself out of a page. In the group picker, only groups you are a member of are listed.
In order to set or modify page permissions, a user needs to have 'Restrict Pages' permission in the space
to which the page belongs, and permission to edit the page itself. So if a user is restricted from editing a
page through page permissions, they are also restricted from changing the permissions themselves.
Page Security Rules
Users can only view page or space content for which they or a group they are in has 'View' permission.
Pages that a user does not have 'View' access to are referred to inaccessible pages. Visit Inaccessible
Page to see how Confluence deals with pages a user cannot view; anonymous users are directed to the
login page while logged-in users are shown a permissions error page with a list of the groups with 'View'
permission to the page. It is not possible to conceal the existence of pages, though you can restrict View
access to page content. To keep the existence of a page or space secret, do not link to it from other
sources.
Permissions and Child Pages
If a page has its 'View' permission restricted, that restriction will be inherited by all its children (and their
children, and so on). If a 'View' permission is added to a page that has already inherited page
permissions from its parent, users must satisfy both permissions in order to see the page.
'Edit' restrictions are not inherited.
Child Page Permissions Example
Consider the page 'Documents', with a child page 'Executive', which itself has a child page 'Payroll'. To
begin with, anyone who can view the space to which these pages belong can see all three pages.
For security reasons, page permissions are set on the 'Executive' page, restricting it to the
'mycompany-management group'. At this point, anyone can still see the 'Documents' page, but you must
be in the 'mycompany-management group' in order to view either 'Executive' or 'Payroll'.
Since 'Payroll' information is considered particularly private, the 'Payroll' page then has its page
permissions set to only allow members of the 'mycompany-financial' group to view it. At this point,
anyone can see the 'Documents' page, only members of 'mycompany-management' can see 'Executive',
and only users who are members of both the 'mycompany-management' and 'mycompany-financial'
groups can view 'Payroll'.
Document generated by Confluence on Feb 08, 2007 14:05
Page 324
Note
Space administrators are responsible for the management of a space and its contents. As a result,
page permissions affect them differently.
Space administrators can:
• view all content on the site : If there are page permissions that restrict the viewing of a page
to a single user, or to a group to which the space administrator doesn't belong, a space
administrator can still view the page by removing the restriction.
• edit all content on the page.
• remove all restrictions from a page.
What would you like to do?
View Page Permissions
View Restricted Pages
Set Page Permissions
Confluence 2.2.x only permits restricting view or edit permission to one group. To apply your vote
towards support for multiple groups, visit [CONF-3701@JIRA].
RELATED TOPICS
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 325
Setting Page Permissions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Page permissions are set when editing a page.
Drop-down menus below the text-entry box allow you to restrict the viewing or editing of a page either to
yourself, or to any group to which you belong.
In order to set or modify page permissions, you need to have 'Restrict Pages' permissions in the space to
which the page belongs, and sufficient permissions to edit the page itself. If you are restricted from
editing a page through page permissions, you are also restricted from changing the permissions
themselves.
View Permissions:
Restrict viewing to yourself: Assigning this permission makes the page invisible to all users except
yourself. However, a space administrator can still view the page from the space administration screens by
removing the restriction.
Restrict viewing to a group: Restricting a page to a group makes the page visible only to users in that
group. A space administrator, even if not a member of the specified group, can still view the page from
the space administration screens by removing the restriction.
Edit Permissions:
Restrict editing to yourself: Assigning this permission will restrict editing of the page to yourself and
space administrators.
Restrict editing to a group: Assigning this permission will restrict editing of the page to a group and
space administrators.
You are only permitted to restrict view or edit permissions to groups you currently belong to. The
main reason for this is that if you attempted to restrict a page to a group you didn't belong to,
you would be unable to undo the restriction, as you would no longer have access to the page.
Note
Space administrators are responsible for the management of a space and its contents. As a result,
page permissions affect them differently.
Space administrators can:
• view all content on the site : If there are page permissions that restrict the viewing of a page
to a single user, or to a group to which the space administrator doesn't belong, a space
administrator can still view the page by removing the restriction.
• edit all content on the page.
• remove all restrictions from a page.
Document generated by Confluence on Feb 08, 2007 14:05
Page 326
Screenshot : Restricting Pages
RELATED TOPICS
Space Permissions Overview
Viewing Page Permissions
Viewing Restricted Pages
Working with Pages
Take me back to Confluence 2 Home
Comments
It's not possible to restrict a page within a space to a set of groups (rather than just one group) is it?
Posted by emily@ucdavis.edu at Oct 17, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 327
Viewing Page Permissions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To view the permissions that apply to a page,
1. Go to the page and click on the 'Info' tab. Page-level restrictions are listed under the heading, 'Page
Permissions'.
2. When you are in the edit mode of a page, the page's permissions, if any, are listed under
'Restrictions' at the bottom of the edit screen:
Click 'EDIT' to set permissions for the page.
RELATED TOPICS
Setting Page Permissions
Viewing Restricted Pages
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 328
Site Administrators and their permissions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
A site administrator is any user who has permission to administrate Confluence. The 'Administrate
Confluence' permission is itself assigned from the Administration Console.
Site administrators have complete access to Confluence regardless of any site or space level restrictive
permissions.
All members of the group, 'confluence-administrators' are by default, site administrators.
All site adminstrative functions are performed from the Administration Console. You need to be a site
administrator to access the Administration Console.
RELATED TOPICS
Users and Groups
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 329
Space Administrators and their permissions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
A space administrator is a user with the 'Administrate Space' permission for a space. This permission
itself is assigned from the space administration screens by a space administrator.
A space administrator has permission to do anything in the space regardless of any other setting.Space
administrators are responsible for the management of a space and its contents, page permissions affect
them differently.
Space administrators can:
• view all content on the site : If there are page permissions that restrict the viewing of a page to a
single user, or to a group to which the space administrator doesn't belong, a space administrator
can still view the page by removing the restriction.
• edit all content on the page.
• remove all restrictions from a page.
A space administrator can remove page permissions from the space administrative interface.
All space administrative functions are performed from the 'Space Admin' tab under the 'Browse Space'
view a space. You need to be a space administrator to access the space administration screens.
RELATED TOPICS
Space Permissions Overview
Take me back to Confluence 2 Home
Comments
Is it possible for the Space Administrator not only to remove restrictions, but also set restrictions to
pages?
Posted by f.marx@enbw.com at Oct 30, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 330
Space Permissions Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Every space has its own independent set of permissions.
Space permissions can only be granted by a space administrator. A space administrator has permission to
do anything in the space regardless of any other setting.
Permissions can be assigned to any Confluence user-group, to an individual user in the Confluence-User
group, and to users in the Anonymous group.
Here are the different permissions that can be assigned at the space level:
• View: user can view this space's content.
• Pages: user can view the space's details, and its page and blog-posts.
o Create - user may create and edit pages in this space.
o Export - user may export pages in this space.
o Restrict - user may apply page level permissions.
o Remove - user may remove pages in this space.
• Blog Posts:
o Create - user may post blogs in this space.
o Delete - user may remove blogs in this space.
• Comments:
o Create - user may make comments in this space.
o Delete - user may remove comments from this space.
• Attachments:
o Create - user may add attachments in this space.
o Delete - user may remove attachm\ents from this space.
• Space:
o Export - user may export content from this space.
o Administer - user has administrative permissions over this space.
• Mail: User may delete individual mail items.
Warning
If you misconfigure a space so that nobody has access to administer it any more, you will need to
have someone in the confluence-administrators group fix the permissions for you.
RELATED TOPICS
Users and Groups
Viewing Space Permissions
Assigning Space Permissions
Revoking Space Permissions
Page Permissions
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 331
Assigning Space Permissions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Space permissions can be assigned across user-groups or to individual users of Confluence.
You need to be a space administrator to assign space permissions.
To assign space permissions,
1. Click on the 'Browse Space' link for that space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on the 'Permissions' link in the left panel under the heading 'Security'. This will display the
space's current permissions assigned to the different groups and users.
4. Click 'Edit permissions'. This will bring up a new screen. See screenshot.
This screen is divided into three headings:
• Groups : Select the group to which you want to assign permissions from the drop down menu.
All current groups on the site will be available in the drop down list. To add a new group, click
'Add Group'.
To assign permissions, check the box beside each of the desired permissions.
• Individual users : Select an individual user to whom you want to assign permissions by
clicking the 'browse' icon and selecting the user from the displayed list.
° Click 'Add' to add the user.
° Check the boxes for the permissions you wish to assign this user.
• Anonymous users : Check the boxes for the permissions you wish to assign to all anonymous
users of the site.
5. Click 'Save All' to apply the permissions.
Screenshot : Assigning Space Permissions
Document generated by Confluence on Feb 08, 2007 14:05
Page 332
RELATED TOPICS
Space Permissions Overview
Viewing Space Permissions
Revoking Space Permissions
Users and Groups
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 333
Revoking Space Permissions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to be a space administrator to remove or revoke space permissions.
To revoke space permissions,
1. Click on the 'Browse Space' link for that space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on the 'Permissions' link in the left panel under the heading 'Security'. This will display the
space's current permissions assigned to the different groups and users.
4. Click 'Edit permissions'. This will bring up a new screen. See screenshot.
5. Uncheck the permissions you which to revoke. Removing the 'View' permission for a user or group
will remove all access to that space for the user or group.
6. Click 'Save All' to apply the permissions.
Screenshot : Assigning Space Permissions
RELATED TOPICS
Space Permissions Overview
Document generated by Confluence on Feb 08, 2007 14:05
Page 334
Assigning Space Permissions
Viewing Space Permissions
Users and Groups
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 335
Viewing Space Permissions
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to be a space administrator to view the permissions assigned for a space.
To view the permissions assigned for a space,
1. Click on the 'Browse Space' link for that space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on the 'Permissions' link in the left panel under the heading 'Security'. This will display
graphically, all the permissions assigned to the different groups and users.
Below is an example. The ticks in the boxes indicate which permissions have been granted. The crosses
indicate which permissions have been denied.
Screenshot : Viewing space permissions
RELATED TOPICS
Space Permissions Overview
Users and Groups
Assigning Space Permissions
Page Permissions
Document generated by Confluence on Feb 08, 2007 14:05
Page 336
Take me back to Confluence 2 Home
Comments
How does a regular user figure out who the administrator is for a space? Or how does a user contact a
space administrator if they don't know who the space administrator is?
Posted by toey at Jan 31, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 337
Users and Groups
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
A user is any individual who accesses Confluence.
New users are created by a site administrator via the Administration Console.
A site administrator can also group users together into user-groups for more convenient administration.
This means that any security permissions you assign at the site, space and page levels can be assigned
to a whole group. A user in one of these groups will automatically be granted all permissions granted to
the group.
There are two special groups in Confluence:
• Confluence-Administrators - This is a 'super-group' and a user from this group has permission to
do anything in the site regardless of any other setting. Users in the confluence-administrators group
are listed on the 'Contact Administrators' page that is linked from the footer throughout the site.
• Confluence-Users - This is a 'default-group' of all new users. Permissions you assign to this group
will be assigned to all new signed-up users of Confluence.
Anonymous-Users
Confluence treats all users who do not log in when they access Confluence as being 'Anonymous'.
Administrators can assign permissions to this group separately.
RELATED TOPICS
Space Permissions Overview
Viewing Space Permissions
Assigning Space Permissions
Page Permissions
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 338
Viewing Restricted Pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Restricted pages are pages that have 'View' or 'Edit' restrictions applied to them through page-level
permissioning .
You need to be a space administrator to view the list of restricted pages in a space.
To view restricted pages,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page or beside
the space link on the dashboard.
2. Go to the 'Space Admin' tab. This tab is only displayed if you are a space administrator.
3. Click on 'Restricted Pages' in the left panel under the heading 'Security'.
A list of all restricted pages in the space is displayed.
4. Click on the 'lock'
icon to remove restrictions for the page.
Here's an example:
RELATED TOPICS
Viewing Page Permissions
Setting Page Permissions
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 339
Confluence Glossary
This page last changed on Jan 14, 2007 by rosie@atlassian.com.
Administration Console
The Administration Console is the interface for the global administration of Confluence.
Only site administrators can access the Administration Console.
Breadcrumbs
The breadcrumbs trace the path from the current page to the dashboard along the space's
page-hierarchy.
The breadcrumbs in Confluence are listed at the top of every page.
CamelCase
CamelCase is a form of markup commonly used in wikis where words compounded together LikeThis
without spaces are used to create links.
In Confluence, Camelcasing can be turned on from the Administration Console.
Change Comment
A change comment is a short description entered during the edit of a page to record the changes being
made in the edit.
Child Pages
Creating child and parent pages is a means by which you can organize content on the site. A child page is
a page that has a parent in any of the Confluence spaces.
A child can only have one parent.
Comments
A comment may be a remark, question, or any other additional information you wish to add to a page
pertaining to the topic the page covers. You can comment on any page or news item in Confluence.
Document generated by Confluence on Feb 08, 2007 14:05
Page 340
Confluence Markup
This is the markup used to write and edit pages in Confluence. Based on Textile , the markup, when you
become familiar with it, makes creating pages as easy as writing email.
Custom Decorators
Decorator files are used to define layouts in Confluence. They are vmd files and require knowledge of the
language, Velocity, to edit.
Dashboard
The dashboard is the front page of a Confluence site. It provides an overview of the site, access to all
spaces, and displays a list of the most recently updated content within them.
Form Field Markup
Form field markup is a specialised markup for creating form fields and is used when creating page
templates.
Global Administrators
A global administrator is the same as a site administrator.
---Global Spaces
Global spaces contain content on any theme or topic of your choice.
For more information about global spaces and personal spaces, see Working with Spaces Overview.
JIRA
JIRA is Atlassian's award winning Issue tracking and project management application.
Visit Atlassian's website to learn more about JIRA.
Labels
Document generated by Confluence on Feb 08, 2007 14:05
Page 341
Labels are user-defined tag words assigned to pages to categorise content in Confluence.
Macros
A macro is a command wrapped inside curly braces {...} used to perform programmatic functions and
generate more complex content structures in Confluence.
News Items
A news item may be a journal entry, status report or any other timely information pertaining to a space.
Notifications
A notification is an email message sent to you updating you of changes to pages and spaces you choose
to 'watch'.
Orphaned Pages
An orphaned page is a page without any incoming links.
Pages
Pages are the primary means of storing information in Confluence. They are the building blocks of spaces
and are written in Confluence markup.
Page Family
Pages in Confluence can be organised into a hierarchy of parent and child pages. A parent and all its
children comprise a page family.
Confluence permits nested page families.
Parent Page
A parent page is a page that has one or more child pages. It may itself be a child of another page.
People Directory
Document generated by Confluence on Feb 08, 2007 14:05
Page 342
The People Directory contains a list of all users in your Confluence site. Each user's name links to their
personal space.
Permalink
A permalink is the url used to link to specific content items like comments.
---Personal Spaces
Personal spaces belong to particular users, and rather than being listed on the Dashboard, are available
from the People Directory.
For more information about global spaces and personal spaces, see Working with Spaces Overview.
RSS Feeds
An RSS feed is a format for delivering summaries of regularly changing web content. RSS is read by RSS
newsreader programs.
You will need an RSS reader to subscribe to feeds within Confluence.
Confluence acts as an RSS reader for feeds from sites outside of Confluence.
RSS Reader
An RSS reader is a specialised RSS program (also called aggregator) that displays the contents of RSS
feeds for you. To subscribe to RSS feeds within Confluence, you will need an RSS reader.
Site Administrators
A site administrator is any user who has permission to administer Confluence. The 'Administrate
Confluence' permission is itself assigned from the Administration Console.
Site administrators have complete access to Confluence regardless of any site or space level restrictive
permissions.
All members of the group, 'confluence-administrators' are by default, site administrators.
----
Document generated by Confluence on Feb 08, 2007 14:05
Page 343
Space Administrators
A space administrator is a user with the 'Administrate Space' permission for the space. A user with this
permission can perform a host of functions relating to the management of a space and has complete
access to the space regardless of any other control settings or permissions.
Permissions for a space are only assigned and modified by space administrators.
Spaces
A space is an area on your site into which you can group different content items together based on any
theme of your choice. All content in Confluence is organised into spaces.
There are two types of spaces: global spaces and personal spaces.
Templates
A template is a pre-defined page that can be used as a prototype when creating pages. Templates are
useful for giving pages a common style or format.
Themes
Themes are pre-defined 'look and feel' styles which are configured from the administration menu and can
be applied across Confluence or to a single space.
Tiny links
A tiny link is the shortened url of a page which is useful when sending links to the page, for example, via
email.
Trackback
Trackback is a mechanism by which two sites can stay informed each time one site refers to the other by
means of trackback 'pings'.
In Confluence, Trackback is enabled from the Administration Console.
Trackback Autodiscovery
Trackback autodiscovery is a block of code that can be placed in a web-page to describe where trackback
pings should be sent for that page. You can read the technical specification for autodiscovery here.
Document generated by Confluence on Feb 08, 2007 14:05
Page 344
When Trackback is enabled, Confluence uses Trackback Autodiscovery to ping pages that are linked to,
and to advertise its own pages as being able to receive pings.
Undefined Links
An undefined link is a link to a page that has not yet been created. Clicking on the page link allows you
create the page.
User Profile
Every user account in Confluence is linked to a profile that contains user related information and options
to configuring user preferences.
Watching a Page
When you watch a page, you are sent an email notification whenever that page has been modified.
Watching a Space
When you watch a space, you are sent an email notification whenever content has been added or
modified in that space.
Wiki
Pioneered by Ward Cunningham, and named after the Hawaiian word for 'quick', a wiki is a website that
makes it easy for anyone to contribute pages, and link them together.
----
RELATED TOPICS
Confluence Icons
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 345
Customising Look and Feel
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to customise the 'look and feel' of an individual space on the Confluence instance
through options available in the Space Administration menu. By default, the look and feel of a space is
based on global settings configured from the Administration Console.
You need to be a space administrator to edit the look and feel of a space.
Applying Themes
Changing a Space's Logo
Customising Homepage
Editing a Space's Colour Scheme
Modify Confluence User Interface Text
RELATED TOPICS
Browsing a space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 346
Applying Themes
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Themes allow you to personalise the 'look and feel' of Confluence. Themes can can be applied across
Confluence or to individual spaces. Use themes if you want to add a new functionality or significantly alter
the appearance of Confluence.
Themes are created and installed from the Administration Console by site administrators. Once a theme
has been installed, a space administrator can then apply it to the space.
By default, no themes are applied and the look and feel of a space conforms to global look and feel
settings.
To apply a theme to a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on 'Themes' in the left panel under the heading 'Look and Feel'. This will bring up a new
screen. Any themes installed will be listed here. See Screenshot below.
4. Click on the radio button to select a theme.
5. Click 'Confirm'.
Screenshot : Applying a theme
RELATED TOPICS
Editing a Space's Colour Scheme
Customising Look and Feel
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 347
Changing a Space's Logo
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
In Confluence, you can replace the default logo for a space with a logo of your own choice.
You need to be a space administrator to replace a space's logo.
To change a space's logo,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page or beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click on 'Change Space Logo' in the left panel under the heading 'Look and Feel'. This will bring
up a new screen. See screenshot below.
4. Use the browse option to locate the new logo and click 'Upload'.
Screenshot : Change space's logo
RELATED TOPICS
Customising Look and Feel
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 348
Customising Homepage
This page last changed on Jan 04, 2007 by rosie@atlassian.com.
Registered users of the site can choose the page to which they are directed after they login to
Confluence. By default, users are directed to the Dashboard after logging in.
To set the site homepage,
1. Click on the 'profile' link located at the top right-hand corner of the page.
2. Click the tab 'Edit My Profile'.
3. From the drop-down menu beside Site Homepage, select a space. Note that only the list of spaces
to which you have 'view' access is displayed here. Selecting a space will direct you to its homepage
when you login.
4. Click 'Save'.
RELATED TOPICS
User Profile Overview
Space Homepage
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 349
Editing a Space's Colour Scheme
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to customise the colour scheme of a space. By default, a space's colour scheme is
based on global settings configured from the Administration Console.
You need to be a space administrator to edit a space's colour scheme.
To change the colour scheme for a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Space Admin' tab. This tab is only displayed if you are a space administrator.
3. Click on 'Colour Scheme' in the left panel under the heading 'Look and Feel'. This will bring up a
new screen. See Screenshot below.
4. Click on 'Edit space colour scheme'. Enter standard HTML/CSS2 colour codes, or use the
colour-picker
to choose a new colour from the palette provided. Any changes you make will
immediately be reflected across the Confluence installation.
The colour scheme applies to the following UI elements:
•
•
•
•
•
•
•
•
•
Top Bar - the bar across the top of the page that contains the breadcrumbs.
Space Name Text - the text of the current space name located above the page title.
Heading Text - all heading tags throughout the space.
Links - all links throughout the space.
Borders and Dividers - table borders and dividing lines.
Menu Bar Background - background of top navigational buttons
Menu Bar Text - text that appears on the menu bar
Menu Bar Background Highlight - background colour of menu bar when highlighted.
Menu Bar Text Highlight - menu bar text when highlighted
Screenshot : Editing a space's colour scheme
Document generated by Confluence on Feb 08, 2007 14:05
Page 350
Handy Hint
If you mess things up, just click the 'Reset to Global Colour Scheme' button and then try
again.
RELATED TOPICS
Customising Look and Feel
Take me back to Confluence 2 Home
Comments
hi there,
for which purposes are the colors "Custom Color 1-5", and how can i use them?
greetings
Posted by loetterle at Aug 02, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 351
Modify Confluence User Interface Text
This page last changed on Nov 20, 2006 by ivan@atlassian.com.
All Confluence UI text is contained in a single Java properties file. This file can be modified to change the
default text or translate Confluence into [other languages] than English.
The UI text file is ConfluenceActionSupport.properties. From your Confluence install directory:
\confluence\WEB-INF\classes\com\atlassian\confluence\core\ConfluenceActionSupport.properties
The file contains parameters with name=value pairs, in the format:
parameter.name=Parameter value
Parameter names are any text before the '=' character and should never be modified. Any text after the
'=' character is the parameter value, which can be modified freely and can also contain variables. An
example involving variables is:
popular.labels=The three most popular labels are {0}, {1} and {2}.
For more information on replacing values, check out [Translating ConfluenceActionSupport Content]. Note
that plugins store their text internally, so you must modify plugin text individually.
Steps For Modification
1. Stop Confluence
2. Under your install direcory, open
\confluence\WEB-INF\classes\com\atlassian\confluence\core\ConfluenceActionSupport.properties
3. Search for the text you wish to modify, update the parameter value and save the file
4. Start Confluence
Common Modifications
Task
Search For
Notes
Rename 'Dashboard'
Dashboard
The dashboard.name parameter
has the name. To change
'Dashboard' to 'My Portal',
change
dashboard.name=Dashboard to
dashboard.name=My Portal and
update any other occurrences of
the word 'Dashboard' in the
instance
Modify login page text
login.
The login.instructions
parameter has the "Enter your
account details below to login to
Document generated by Confluence on Feb 08, 2007 14:05
Page 352
Confluence" text
Modify Keyboard Shortcuts
Confluence provides a set of [keyboard shortcuts]. You could customise the shortcuts by making
modifications inside the ConfluenceActionSupport.properties file.
• To disable a particular shortcut, you can simply just comment out a respective line of code. One
may like to disable the shortcut to one of the navigation links: View, Edit, Attachments, Info . For
instance, to disable shortcut to Attachments one would comment out the following line:
#navlink.attachments.accesskey=a
• To modify an access key, one could simply just change the letter, bearing in mind the fact that the
letter must be unique.
Document generated by Confluence on Feb 08, 2007 14:05
Page 353
Modifying Confluence Layouts Using Custom Decorators
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence is built on top of the Open Source SiteMesh library, a web-page layout system that provides a
consistent look and feel across a site. SiteMesh works through 'decorators' that define a page's layout
and structure.
To edit the layout of Confluence, you will need to modify these decorator files. A decorator file is a vmd
file and is written in a very simple programming language called Velocity. Learn more about Velocity.
Once you become familiar with Velocity, you can edit the decorator files to personalise the appearance of
Confluence.
You need to be a site administrator to edit decorator files.
These files are grouped into:
Site layouts : These are used to define the controls that surround each page in the site. For example, if
you want to make changes to the header and the footer, you will need to modify these layouts.
Content layouts : These control the appearance of content such as pages and news items: they don't
change the way the pages themselves are displayed, but they allow you to alter the way the surrounding
comments or attachments are shown.
Export Layouts: These control the appearance of spaces and pages when they are exported to HTML. If
you are using Confluence to generate a static website, for example, you will need to modify these
layouts.
Learn more about using decorators.
To edit a decorator file,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Space Admin' tab. This tab is only displayed if you are a space administrator.
3. Click on the 'Layout' link in the left panel under the heading 'Look and Feel'. A list of the layouts
for the space is listed.
• Click 'View Default' to view the vmd file.
• Click 'Create Custom' to edit the default vmd file. This will open up the vmd file in edit mode.
Make changes and click 'Update'.
Document generated by Confluence on Feb 08, 2007 14:05
Page 354
Click thumbnail to view an example of a vmd file:
RELATED TOPICS
Customising Look and Feel
Applying Themes
Take me back to Confluence 2 Home
Comments
Despite the title being "Site layouts", am I correct in thinking that these are customised on a per-space
basis?
Posted by gwynevans at Oct 17, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 355
Working with News Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Each space in Confluence can publish its own news. News items may be announcements, journal entries,
status reports or any other timely information you would categorise as 'news' pertaining to a space.
News items for a space are contained in the 'News' tab under the Browse Space view of a space.
Confluence catalogues each news item chronologically and allows you to browse news for the space easily
by navigating a calendar.
Creating and editing a news item is just as easy as creating and editing any other page in Confluence.
What would you like to do?
View news
Add news
Edit news
Link to news
RELATED TOPICS
Tracking Updates Overview
Take me back to Confluence 2 Home
Comments
Dear Vidya,
HELP!
I need to place news (blogs) from different spaces to one page (desirable on Dashboard). How it to
make?
My Confluence version is 2.0.2 Build:#322 ### 05, 2005.
In advance I thank. Firat.
Posted by fvakiliev at Jun 14, 2006.
.....................................................................................................................................................................
Firat,
may be use of blogpost macro with labels will help you to acheive it ...
syntax is No news found.
r
Document generated by Confluence on Feb 08, 2007 14:05
Page 356
Posted by rakadam at Jun 28, 2006.
.....................................................................................................................................................................
{blog-posts:labels=atlassian,confluence|match-labels=all
Posted by rakadam at Jun 28, 2006.
.....................................................................................................................................................................
Thanks Rajendra. Not so conveniently, but has helped.
Posted by fvakiliev at Jul 03, 2006.
.....................................................................................................................................................................
I have found the best decision:
{blog-posts:5|labels=}
...#lso blogs from all spaces and with any labels will be show.
Posted by fvakiliev at Jul 03, 2006.
.....................................................................................................................................................................
Question about Mail "watch this page" and News. We are using
Tuesday, 20 September 2005
Test News
asas
Posted at 20 Sep @ 8:43 PM by
vidya |
4 comments | Edit
vidya |
0 comments | Edit
admin |
2 comments | Edit
Friday, 26 August 2005
Sample News
This is a sample news item for the Documentation Space.
Posted at 26 Aug @ 1:48 AM by
Friday, 8 July 2005
Test News
Last changed: Aug 11, 2005 23:26 by vidya
Sample News
Posted at 08 Jul @ 12:48 PM by
macro on front page of a space. When News posts are added Mail is not sent to subscribers. Is there a
way to get mail sent when new News posts are created?
Posted by ghbrett at Oct 31, 2006.
.....................................................................................................................................................................
Yipes, sorry bout the last post. I forgot to delimit the macro.
What I meant to ask is:
Document generated by Confluence on Feb 08, 2007 14:05
Page 357
Question about Mail "watch this page" and News. We are using {blog-posts} macro on front page of a
space. When News posts are added Mail is not sent to subscribers. Is there a way to get mail sent when
new News posts are created?
Posted by ghbrett at Oct 31, 2006.
.....................................................................................................................................................................
Is this above really working for listing ALL news from ALL spaces? I want to add a list of all news to the
dashboard or at least with a list in just one page in one of my spaces...
If there is a solution for the dashboard, how and where do a modify the dashboard ?
Posted by di99pejo at Feb 05, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 358
Adding News
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To add a news item for a space, you require 'Create News' permission which is assigned by a space
administrator from the Space Administration screens. See Space permissions or contact a space
administrator for more information.
To add a news item,
1. Click on the 'Add News'
link located at the top of every page in the space. This will
bring up a new screen.
2. Enter a title for your news item in the 'Title' text field.
3. Enter your content in the text-entry box using Confluence markup as you would in any other page in
Confluence.
4. Preview and click 'Add'.
Your news item can be viewed by going to the 'News' tab under the 'Browse Space' view of the space.
RELATED TOPICS
Creating a New Page
Working with News Overview
Editing News
Linking to News
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 359
Editing News
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To edit a news item, you require 'Create News' permission which is assigned by a space administrator
from the Space Administration screens. See Space Permissions or contact a space administrator for more
information.
To edit a news item,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'News' tab. A list of the most recent news items within the space is presented. A calendar
allows you to browse other news items. Locate the news item you wish to edit and click on its title.
This will open up the news item.
3. Click on the 'Edit' tab. This will bring up the 'Edit' screen. Use regular Confluence Markup to edit the
news item.
4. 'Preview' your changes if desired, and click 'Update'.
Editing a news item is similar to editing any other page in Confluence. However, there are a few
differences you need to keep in mind while editing a news item:
• You cannot change the title of a news item.
• You cannot move a news item to another space.
• A news item has no parent.
RELATED TOPICS
Editing an Existing Page
Working with News Overview
Take me back to Confluence 2 Home
Comments
Hi How about changing the date? I'd like to create a news pages for future dates as invitations to meetings.
Possible?
Posted by pness at Oct 25, 2006.
.....................................................................................................................................................................
As far as I know, this is not possible. We have external users who maintain their work logs using news
items and they have been looking (without success) to add some work items to a page in the future, as a
kind of to-do reminder. It would be a nice feature to be added to Confluence...
Posted by gert@anova.be at Oct 30, 2006.
Document generated by Confluence on Feb 08, 2007 14:05
Page 360
.....................................................................................................................................................................
I don't have an edit tab in the "news" page view. I first that it would have been changed with the page
layout changes I made but I just used the "reset to default" link to switch it back. As I did not find an
issue about that concerning version: 2.2.9 Build:#527 I think it depends on my environment. Maybe I
should add it is a personal license and I am logged in as admin.
Is there any further trick or pitfall about it ?
Posted by thu75 at Jan 09, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 361
Linking to News
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to edit in 'Wiki Markup' mode to create a link to a news item.
To link to a news item,
You need to know the title of the news item as well as the date on which it was created.
1. Convert the date into the format: year/month/day.
2. You can now create a link to the news item, like this:
What you need to type
Unknown macro: {nomarkup}
What you will get
/2005/08/26/Sample News
/2005/08/26/Sample News
Where:
'/2005/08/26' is the date the news item was published.
'Sample News' is the title of the news item.
You can also link to a whole day's news items, just by leaving out the news item's title at the end of the
link.
Note
Linking to a news item that has not been created yet will not result in a link; news items are very
tightly bound to the time at which they were created, and thus it makes no sense to link to them
before they exist.
RELATED TOPICS
Working with News Overview
Working with Links Overview
Take me back to Confluence 2 Home
Comments
It's probably obvious to old-time wikiers, but you might want to add to this documentation that they
can provide an alias for the news item with the following format:
[alias here|2006/03/22/Managing Project Pages]
But what would make this feature even more useful is if the link syntax would accept the news item
name as it's naturally formatted by the browser when you display that page, like this:
Document generated by Confluence on Feb 08, 2007 14:05
Page 362
[alias here|2006/03/22/Managing+Project+Pages]
Posted by stews at Mar 22, 2006.
.....................................................................................................................................................................
How can we link to a blog/news home?
Posted by jtneill at Nov 21, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 363
Viewing News
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To view the news items within a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'News' tab. This will display the latest news items in the space along with the date of
each item and the name of its author.
Use the Calendar to help you find other news items in the space. Days which have news items are
underlined to indicate that they link to a view of all the news items posted on that day.
When you are viewing a single news item, you'll see links below the calendar to the next and previous
news items.
Screenshot : Viewing News
RELATED TOPICS
Blog Posts Macro
Adding News
Linking to News
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 364
Confluence Icons
This page last changed on Jan 04, 2007 by rosie@atlassian.com.
Icons are used throughout Confluence to provide quick links and indicators. The most frequently used
icons are:
Icon
Description
Go to the people directory.
View a user profile.
Go to a personal space.
Go to a global space.
View a space's homepage.
View a page.
Add a page.
Add a child page to the current page.
View a piece of news.
Add a piece of news.
This page has been edited since you last viewed it.
Click to view the page.
View a comment.
Add a comment.
View a piece of archived mail that has been
imported into Confluence.
View a page that has been imported into
Confluence.
View an attachment.
This link goes to an attachment.
This link goes to a destination outside Confluence.
This page/space/person is currently a favourite.
Click to remove from your favourites.
Add this page, space or person to your favourites.
You are currently watching this page or space.
Click to stop watching.
Start watching this page or space.
Go to the RSS feed builder.
Subscribe to a pre-defined RSS feed.
View a printable version of this page.
Document generated by Confluence on Feb 08, 2007 14:05
Page 365
Export the contents of this space.
Define labels.
Choose a space's theme.
Choose a space's colour scheme.
Define a layout for a space, its pages and/or news
items.
View space permissions.
View page permissions.
RELATED TOPICS
Dashboard
Confluence Glossary
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 366
Working with Templates Overview
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Users can create editable forms to enter page content by creating a template. For example, a software
development project may have a template for use-cases; or a systems administration space, a template
for defining what information is being kept about each server.
In Confluence, there are two types of templates:
• Global Templates : These are defined by site administrators through the Administration Console
and are available in every space.
• Space Templates: These are defined by space administrators in the space administration screens,
and are only available in the space in which they are defined.
Global templates can only be created by site administrators, and space templates by space
administrators.
Templates are written in regular Confluence markup, using special markup to define form fields that need
to be filled in.
Here is an example:
Note
Currently, templates can only be used to create a page. Once a page is created, the template is
gone and all further editing is performed as if the template was never used. In the future,
templates will be expanded to do more interesting things such as remaining part of the page,
having more complex (and even dynamic) fields, being able to search Confluence based on the
value of particular fields, and so on.
Important Plugins For Templates
Two popular plugins that expand on template behaviour are the [Zones Plugin] and [Scaffolding Plugin].
Below is a comparision:
Document generated by Confluence on Feb 08, 2007 14:05
Page 367
Field
Description
Default
Basic
[Zones Plugin]
Flexible
[Scaffolding Plugin]
Powerful
Saves page version
history
Can set page title
Allows return to form
version
Suitable for dynamic
data
Has a library of
examples
RELATED TOPICS
Adding a Template
Editing a template
Removing a Template
Creating a Page using a Template
Working with Pages
Take me back to Confluence 2 Home
Comments
If you need more functionality or 'permanent templates', check out [Scaffolds]
Posted by david.soul@atlassian.com at Jul 11, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 368
Adding a Template
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to be a space administrator to create a space template.
To add a template for a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Templates' tab and click on 'Add New Space Template'. This will bring up the 'create
template' screen.
3. Enter a name for your template in the 'Name' text field and an optional description in the
'Description' text field.
4. Using regular Confluence markup and form field markup (if you are using forms), enter content in
the text-entry box as you would in any other Confluence page. For example:
5. Preview and click 'Add'. Your template will be added to the list of space templates and be displayed
when you click on the 'Templates' tab for the space.
For more information, check out this an example template.
NEXT: Creating a Page using a Template
RELATED TOPICS
Working with Templates overview
Editing a Template
Removing a Template
Browsing a Space
Working with Pages
Take me back to Confluence 2 Home
Comments
hi there,
Document generated by Confluence on Feb 08, 2007 14:05
Page 369
why is it not possible to create a template in a WYSIWYG editor?
Posted by loetterle at Aug 08, 2006.
.....................................................................................................................................................................
Hi Stefan.
This would require creating extra WYSIWYG editor function specifically for template creation and inserting
the editor into the template page. There hasn't been any requests for this feature yet, but you can log a
new feature request for this at http://jira.atlassian.com
David
Posted by david.soul@atlassian.com at Aug 14, 2006.
.....................................................................................................................................................................
Hi,
Could you add some simple instructions for creating a global template (available to all spaces)?
Posted by davida at Aug 30, 2006.
.....................................................................................................................................................................
Hi.
I am Korean. I am using confluence 2.3.1. My server characterset, and confluence is utf8. utf8 is not
problem int using korean. But I don't use list in list. If korean word is in list, list is not working.
Type
@TYPE|list(Organisation,Individual, ##)@
@TYPE list(Organisation,Individual,'##')@
Posted by joon@sds.co.kr at Feb 02, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 370
Creating a Page using a Template
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to create a page based on a global template (available to all spaces) or a space
template (available only to that space). This page is intended for users who have already created a
template.
To create a page from an existing template
1. Click on the 'Add Page' link located beside each space on the dashboard or at the top of every page
in Confluence.
2. Click on the link 'Select a template page' located above the text-entry box.
This is only displayed if there are any templates defined. If you do not see this link, then there are
currently no templates defined and an administrator will have to create one before you can use it.
Clicking this link will display the list of the templates that are available in the current space.
3. Select a template and click 'Next'. This will display the template.
If the template uses a form, enter the appropriate values into the form fields and press the 'Insert
Variables' button. This will take you to the 'edit' mode of the page where you can add more content or
make further changes before adding the page.
Screenshot : Choose a template
Screenshot : Fill out the form
Document generated by Confluence on Feb 08, 2007 14:05
Page 371
Screenshot : Resulting page
RELATED TOPICS
Adding a Template
Editing a Template
Removing a Template
Document generated by Confluence on Feb 08, 2007 14:05
Page 372
Form Field Markup for Templates
Browsing a Space
Take me back to Confluence 2 Home
Comments
How do I add a label to pages made from the template?
I want every page to have a certain label.
Thanks
Posted by mrjcleaver at Apr 04, 2006.
.....................................................................................................................................................................
Can I use templates from other spaces to create a page?
Thanks,
Marianne
Posted by marianne.vanhauwaert@persgroep.be at May 15, 2006.
.....................................................................................................................................................................
Adaptavist have a plugin that lets you do just that:
http://www.adaptavist.com/display/USERGUIDE/add-label+macro
Posted by mryall at Jul 10, 2006.
.....................................................................................................................................................................
Unfortunately, this isn't possible in Confluence at the moment. If you need this functionality frequently,
you could raise a feature request in JIRA.
Posted by mryall at Jul 10, 2006.
.....................................................................................................................................................................
Is it possible to link directly to a template? i.e. when the user clicks on the link, they should be taken
directly to the template form so that they can start creating the page using the template...
Posted by mattz at Aug 07, 2006.
.....................................................................................................................................................................
Yes - use the Create Page macro:
http://www.adaptavist.com/display/USERGUIDE/create-page+macro
A recent release adds full support for standard Confluence templates - see [CONFEXT:Create Page Macro]
Document generated by Confluence on Feb 08, 2007 14:05
Page 373
Posted by gfraser at Aug 07, 2006.
.....................................................................................................................................................................
I'd like to create a template that has a list of values for a Wiki page link, or text entry box for such. The
template form does not seem to recognize a syntax like:
[@DIVISION|list(ClassTech,CommTech,CSS)] or
[@STAFF]
Is there a way to do this in a template? (The list works fine if I remove the link [] on either side, but I
want the pages created with the template to be linked to one of the DIVISION pages. So that when I go
to a particular page for a DIVISION, the Info tab "links" section shows all the pages created related to
that DIVISION. Is there another way to accomplish this?)
Posted by m-grady@uiuc.edu at Aug 21, 2006.
.....................................................................................................................................................................
Is there a way to assign the page name of an new article within a template?
Posted by loetterle at Sep 12, 2006.
.....................................................................................................................................................................
I have this same request, I'd like to see if a template can drop in a default page title/name when used
from the Create Page macro. Ideally it would be a standard name follwed by some unique identifier, like a
date/time stampe.
Posted by honconftest at Sep 13, 2006.
.....................................................................................................................................................................
We need this functionality. I have created an improvement request in JIRA. Please vote for it if you are
interested.
Posted by davida at Oct 23, 2006.
.....................................................................................................................................................................
Sorry, I omitted the link to the issue, its CONF-7200.
Posted by davida at Oct 23, 2006.
.....................................................................................................................................................................
Same Request from my side.
Posted by jma at Nov 16, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 374
Editing a template
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to be a space administrator to modify a space template.
To edit a template,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Templates' tab. A list of templates for the space is displayed.
3. Click on the 'Edit' link beside the chosen template. This will bring up the 'edit' screen for the
template.
4. Make changes or add new content as you would when you add a template, using form field markup,
if required.
5. Click 'Update' to save your changes.
RELATED TOPICS
Adding a Template
Creating a Page using a Template
Working with Templates
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 375
Removing a Template
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to be a space administrator to remove a space template.
To remove a space template,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Templates' tab. A list of templates for the space is displayed.
3. Click on the 'Remove' link beside the template you wish to delete.
4. Confirm your action by clicking 'OK' when the confirmation screen is brought up.
Warning
Deleted templates cannot be restored.
RELATED TOPICS
Editing a Template
Adding a Template
Creating a Page using a Template
Working with Templates
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 376
Working with Spaces Overview
This page last changed on Jan 11, 2007 by rosie@atlassian.com.
In Confluence, content is organised into spaces. There are two types of spaces:
• Global spaces are areas on your site into which you can group content items (pages, attachments,
news, etc) based on any theme or topic of your choice. For example, you may want separate areas
on your site for each team or project within your organisation. In Confluence, you can set up a
different space for each team or project. You can build content for each of these spaces individually,
decide who its users are, and even archive mail separately within each. There is no limit to the
number of global spaces you can create within Confluence!
• Personal spaces belong to particular users, and rather than being listed on the Dashboard (see
below), are available from the People Directory. They can contain pages and news items, be
searched and browsed. They can be kept private, or opened up so the whole world can view and
edit them, just like global spaces. (Note: personal spaces are available in Confluence version 2.2
and later.)
Confluence treats each space as an independently managed wiki. What this means is that each space
functions autonomously within your site.
Each space:
• has its own pages, news items, comments, RSS feeds and mail (mail applies to global spaces only).
• has its own access control settings, so you can set different levels of access to different spaces.
• can be separately exported to PDF , WORD, HTML or XML.
You can view all the global spaces within a site via the Dashboard. You also group global spaces together
into 'Team Spaces' or 'My Spaces' to enable easy access to the content that is most relevant to you. See
Customising the Dashboard.
Here is an example of how you could categorise information using spaces:
'My' spaces are spaces that you have nominated as your favourites.
Document generated by Confluence on Feb 08, 2007 14:05
Page 377
RELATED TOPICS
Setting up a New Global Space
Setting up your Personal Space
Viewing all Spaces
Browsing a Space
Moving Content from one Space to Another
Deleting a Space
Viewing Space Activity
Administering Spaces
Take me back to Confluence 2 Home
Comments
A list of example spaces would be beneficial in helping new users understand how spaces should be
used.
For example:
Should a company start with fewer spaces and use page families and then move a page family to its own
space once it is large enough to need its own space?
Maybe a list of internal and external spaces that Atlassian uses internally would be provided as an
example.
Posted by grothwell at Aug 05, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 378
Administering Spaces
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
To view the space administration menu,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator. All the
options pertaining to the management of a space are listed in the left panel. Click on a link to take
you to the corresponding screen.
To administer a personal space,
For personal spaces, the options available are divided into three categories under these headings:
1. Space Operations
• Edit a space's details
• Edit space labels and team labels
• Remove a space
• Purge or restore content from trash
2. Security
• View or set space permissions
• View restricted pages
3. Look and Feel
• Apply a theme
• Change the colour scheme
• Edit the space's layouts
Screenshot : Space Administration menu for a personal space
Document generated by Confluence on Feb 08, 2007 14:05
Page 379
To administer a global space,
Note that you need to be a space administrator to perform administrative functions relating to a global
space.
For global spaces, the options available are divided into five categories under these headings:
1. Space Operations
• Edit a space's details
• Edit space labels and team labels
• Remove a space
• Purge or restore content from trash
2. Security
• View or set space permissions
• View restricted pages
3. Mail
• Manage mail accounts
• Import mail
4. Look and Feel
• Apply a theme
• Change the colour scheme
• Edit the space's layouts
• Change the space's logo
5. Import
• Importing Pages from Disk
Screenshot : Space Administration menu for a global space
Document generated by Confluence on Feb 08, 2007 14:05
Page 380
RELATED TOPICS
Browsing a Space
Working with Spaces Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 381
Browsing a space
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
The 'Browse Space' view is your window to space-wide summary information as well as to a host of
tools relating to the management of your space. You can browse a space from either the Dashboard or
from within a space by clicking this icon
located at the top of every page.
The components in this view are organised into 8 blue tabs:
Screenshot: Browsing a space — 'Advanced' tab
The tabs that are displayed to you will depend on your Confluence site configuration, the type of space
you are viewing and the space permissions granted to you for the space.
1. Pages
• View pages alphabetically
• View recently updated content
• See tree view of pages
More about Working with pages
2. Labels
• View labels
3. Attachments
• Find an attachment
• View details of an attachment
More about Working with attachments
4. Mail
• View mail for this space
• Fetch new mail
• Delete mail
More about Working with mail
Document generated by Confluence on Feb 08, 2007 14:05
Page 382
5. News
• View news items for this space
More about Working with news
6. Activity
• View space activity
7. Advanced
• View space details
• Edit space details
• Manage orphaned pages
• Manage undefined pages
• Adding a Template Manage page templates
• Export a space
• Subscribe to RSS feeds within Confluence
• Watch a space
• Add a space to your favourites
8. Space Administration
RELATED TOPICS
Working with Spaces Overview
Setting up a New Global Space
View all spaces
Move content from one space to another
Delete a space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 383
Editing Space Details
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You need to be a space administrator to edit the details of a space.
To edit the details of a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Space Admin' tab and click on 'Edit Space Details' in the left panel. This brings up a
new screen where you can:
• type in a different name for the space.
• enter or modify the space description.
• select a new homepage for the space from the drop-down menu.
3. Click 'Update' to save your changes.
Note
You cannot edit the key or the creator's name.
RELATED TOPICS
Viewing Space Details
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 384
Managing Orphaned Pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
An orphaned page is a page without any incoming links. What this means is that unless you know that
this page exists, you are not likely to come across it in the space during the natural course of navigation.
When you are working in a large space with a number of pages, it is difficult to keep track of all of them.
An orphaned page may be redundant or need to be referred to from another page. Confluence allows you
to view all the orphaned pages in a space so you can "tidy up" the space by either deleting pages or by
reorganizing them.
To view the orphaned pages in a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Advanced' tab and click on 'Orphaned Pages' from the left panel.
You can delete an orphaned page by clicking on the 'trash' icon beside it.
Screenshot : Managing Orphaned Pages
RELATED TOPICS
Managing Undefined pages
Browsing a Space
Take me back to Confluence 2 Home
Comments
Document generated by Confluence on Feb 08, 2007 14:05
Page 385
you say " you can "tidy up" the space by either deleting pages or by reorganizing them." Bu I am not
seeing the reorganizing them part. Can you be more specific?
Thanks.
Posted by lois54 at Oct 18, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 386
Managing Undefined Pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
In Confluence, you can create links to pages that you intend to create later. This is a useful facility as it
allows you to create links first and enter content for those pages later. These are 'undefined links' and are
indicated with this sign to remind you that those pages need to be created.
For example, Link to new page
Because you may be working with a large number of pages each with a number of links, this view gives a
consolidated report of all the undefined pages so you can manage your space better.
To view the undefined links in a space,
1. Click on the 'Browse Space' link for the space.
2. Go to the 'Advanced' tab and click on 'Undefined Links' from the left panel. This will display a list
of all the undefined pages in the space.
Click on the 'Add Page' icon beside a page to add content.
RELATED TOPICS
Managing Orphaned Pages
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 387
Tree View of Pages
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
The tree view displays the parent-child relationships of the pages in the space.
Learn about Page families in Confluence.
To see the tree view of pages within a space,
1. Click on the 'Browse Space' link for that space.
2. Go the 'Pages' tab and click on the link 'Tree View'. Click on the expand icon to view the children
of a page.
Screenshot : Tree View of pages
RELATED TOPICS
Read about Page Families
Viewing a Page's Location within a Space
View the Children of a Page
Working with Pages
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 388
Viewing Pages Alphabetically
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Use this view when you are looking for a specific page in a space and you know its title.
To view the pages in your space alphabetically,
1. Click on the 'Browse Space' link for the space.
2. Go to the 'Pages' tab and click on 'Alphabetical View'.
3. Click on a letter to display all the pages beginning with that letter. Clicking on a page link will take
you to that page.
Handy Hint
If you know the title of a page, you might find it faster using the Quick Search.
RELATED TOPICS
View Recently Updated pages
See Tree View
Browsing a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 389
Viewing Recently Updated Content
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
The 'Recently Updated' view is a useful way of keeping track of the changes being made in a space. It
displays links to the most recently added or modified content within the space including pages, news
items, mail messages and comments.
To view the recently updated content in a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Pages' tab and click on the link 'Recently Updated'. A list of the most recently added or
modified content in the space is displayed. Clicking on a link will open up the corresponding
document.
RELATED TOPICS
Recently Updated Content Macro
View Pages Alphabetically
See Tree View of Pages
Browsing a Space
Viewing Space Activity
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 390
Viewing Space Details
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
To view a space's details,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Advanced' tab and click on 'Space details' in the left panel.
The details displayed are:
• The Name of the space.
• The Key used to refer to the space. This key is a shorthand name for the space that is used for web
urls, reports, and when linking content between spaces. Note that personal space keys always
contain a '~', whereas global space keys never do.
• Any Labels defined for this space.
• The Homepage of the space. This is the default page to which users are directed when they click on
the link to the space from the dashboard.
• The Creator of the space.
• Space Description: This is a short description of the space used to provide users with an idea of
the space's contents (optional).
Here is an example:
Screenshot : Space Details
RELATED TOPICS
Editing Space Details
Browsing a Space
Viewing Space Activity
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 391
Converting a Global Space to a Personal Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Please see Working with Spaces Overview for information about the differences between global
spaces and personal spaces.
Generally, the easiest way to create your personal space is to follow the instructions described in Setting
up your Personal Space. However, sometimes you may need to convert an existing global space into a
personal space, particularly if you used Confluence before the introduction of personal spaces in version
2.2.
To convert a global space to a personal space, you require the following permissions:
• 'Personal Space' permission, which is assigned by a site administrator from the Administration
Console. See Security or contact a site administrator for more information.
• Space 'Admin' permission, which is assigned by a space administrator\.
To convert a global space to a personal space,
1. Go to the global space and click the 'Browse Space' link. This is located at the top of every page in
the space, and beside the space link on the Dashboard.
2. Go to the tab 'Space Admin'. This tab is only displayed if you are a space administrator.
3. Click the 'Edit Space' link in the left panel.
4. In the 'Convert to Personal Space' section:
• Choose whether to Update Links to pages in this space (recommended).
• Choose the User whose personal space this global space will become.
• Click the 'Convert Space' button.
Document generated by Confluence on Feb 08, 2007 14:05
Page 392
Note that the ability to archive mail and import pages from disk applies only to global spaces, so the 'Mail'
and 'Import' sections in the above screenshot do not appear in the 'Space Admin' tab for personal spaces.
Please see Working with Spaces Overview for information about the differences between global spaces
and personal spaces.
RELATED TOPICS
Working with Spaces Overview
Setting up your Personal Space
Uploading a Profile Picture
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 393
Deleting a Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Deleting a space permanently removes the space and all of its contents.
You need to be a space administrator to delete a space.
To delete a space,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Space Admin' tab. This tab is only displayed if you are a space administrator.
3. Click on the 'Remove Space' link in the left panel under the heading 'Space Operations'.
4. Click 'OK' when the confirmation screen is brought up.
Warning
Use caution while deleting a space. Once deleted, there is no way to restore a space.
RELATED LINKS
Working with spaces
Setting up a New Global Space
Viewing all Spaces
Browsing a Space
Moving Content from one Space to Another
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 394
Guidelines For Partitioning Content Into Spaces & Pages
This page last changed on Dec 04, 2006 by david.soul@atlassian.com.
Brief guidelines for grouping content into the Confluence space and page format used by Confluence.
Partitioning Guidelines
To ensure maintainable and logical spaces, content should be broken into spaces by:
1. Evaluating permissions across the wiki content. If members require conflicting access, for example
user 1 must access content on topics A and B, while user 2 must access content for topics B and C,
then the topics must be separated into three spaces.
2. Grouping content by topic, project or team.
For semi-static content, a space for each topic is fine. If there is a substantial project-related content that
must be exclusive to different groups, you should use separate spaces.
Spaces & Pages Information
Useful notes about spaces and pages:
1. Spaces cannot be nested
2. Page permissions can prevent users who can access the space from accessing that page
3. Page permissions alone cannot keep the existence of a page secret. The page should be in a
restricted space instead
4. Pages can be easily moved between spaces
Comments
Although not quite finished, this may be of some use:
http://www.adaptavist.com/display/USERGUIDE/Content+Organisation
Posted by gfraser@adaptavist.com at Dec 01, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 395
Moving Content from one Space to Another
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
While each space in Confluence functions independently, Confluence is flexible enough to let you move
content easily between spaces.
What would you like to do?
Move a Page from one Space to Another
Move a Family of Pages from one Space to Another
Move an Attachment
RELATED LINKS
Working with Spaces
Browsing a Space
Take me back to Confluence 2 Home
Comments
How would you move all content and settings (an entire space) from once Space (OLDSPACE) to another
Space (NEWSPACE)?
What about having Confluence create a redirection page automatically when a page is moved? (In case
the old page is bookmarked?)
Posted by liberty_miller at Dec 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 396
Moving a family of pages from one space to another
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To move page families, you require 'Create Pages' permission for each page in that family. Space
Permissions are assigned by a space administrator from the Space Administration screens.
To move an entire family of pages from one space to another, or within a space
1.
2.
3.
4.
5.
Go to the top most page (parent page) in that family.
Click on the 'Edit' tab. The page's current location is listed below the title input-field.
Click 'Edit' beside 'Location'.
From the drop-down menu displayed, select the space to which you want to move the page family.
If you want to specify a parent page, click on the Choose a Page icon
and select the page from
one of the tabs displayed. Or else, use the search facility to locate the page.
If you want to move the page directly under the new space, leave this field blank. See Working with
page families for more information.
6. Check the box titled 'Move Children'.
7. Click 'Save'.
RELATED TOPICS
Moving a Page from one Space to Another
Moving an Attachment
Take me back to Confluence 2 Home
Comments
In addition to the Move command, how about adding a facility to Copy all the pages from one space to
another? This way I can create a protected space as a form of an organizational template that users can
copy from to initialize a new space with a set of 'template pages'. I.e. I would create a space call Book
Prototype and have pages within it called Introduction, Chapter, Epilogue, Glossary, etc. that the user
would then fill out as appropriate. Ideally I'd like to create a space programmatically and copy over the
template pages after the user fills in a conventional template with pertinent starting info.
Brian
Posted by b.remedios at Feb 03, 2006.
.....................................................................................................................................................................
I am also interested in how to copy a family of pages from one space to another. Here is our scenario.
We have a wiki server inside our firewall which has a lot of documents. Some of that we would like to
give it to external customers.
Hence we have a Wiki server outside the firewall. Now i would like to copy or export an entire space or a
family of pages to the external wiki. How do i do that ?
Document generated by Confluence on Feb 08, 2007 14:05
Page 397
Thanks
G
Posted by gvasista@gmail.com at Feb 06, 2006.
.....................................................................................................................................................................
On #confluence (irc.freenode.net):
(14:55:30) MartinCleaver: That "edit" beside "location" - it looks like the label control!
(14:57:47) fallout: yeah, it definitely looks like their label thing
(14:57:54) fallout: and it's small enough that it's easy to miss.
Posted by mrjcleaver at Oct 06, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 398
Moving a Page from one Space to Another
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can easily moves pages from one space to another within Confluence.
To move a page, you require 'Create Pages' permission which is assigned by a space administrator from
the Space Administration screens. See Space permissions or contact a space administrator for more
information.
To move a page from its current space to another space within your site,
1.
2.
3.
4.
Go to the page and click on the 'Edit' tab.
The page's current location is listed below the title input-field. Click 'Edit' beside 'Location'.
From the drop-down menu displayed, select the space to which you want to move the page.
If you want to specify a parent page, click on the Choose a Page icon
and select the page from
one of the tabs displayed. If you want the page to have no parent in the new space, leave this field
blank. See Working with page families for more information.
5. Click 'Save'.
Handy Hint
Any links to the page from the current space will automatically be renamed to point to the page in
the new space.
RELATED TOPICS
Moving a Family of Pages from one Space to Another
Moving an Attachment
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 399
Moving an Attachment
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can move an attachment from its current location to any page within the site.
To move an attachment, you require 'Create Attachments' permission which is assigned by a space
administrator from the Space Administration screens. See Space permissions or contact a space
administrator for more information.
To move an attachment,
1. Go to the page that contains the attachment and click on the 'Attachments' tab.
2. Click the 'Edit' link beside the attachment. This will bring up a new screen.
• Rename the attachment in the 'File Name' text field (optional).
• Update the existing comment or enter a new comment in the 'New Comment' text field
(optional).
3. Select the page to which you want to move the attachment by clicking on the Choose a page link. A
pop-up screen allows you to locate pages anywhere within the site.
4. Against 'Update Links', select 'Yes' to ensure that any links to this attachment are maintained
when you move it. Only select 'No' if you are sure that there are no links to this attachment within
the current space.
5. Click 'OK'.
Screenshot : Moving an attachment
RELATED TOPICS
Moving a Page from one Space to Another
Moving a Family of Pages from one Space to Another
Document generated by Confluence on Feb 08, 2007 14:05
Page 400
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 401
Setting up a New Global Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
To set up a new global space, you require 'Create Space' permission which is assigned by a site
administrator from the Administration Console. See Security or contact a site administrator for more
information.
To create a new global space,
1. Click on the link 'Create a Space'
located below the list of spaces on the
dashboard.
2. Enter a few details about your space.
• Space Name: Enter a name for the space.
• Space Key : Enter a simple key to refer to your space (A-Z, a-z, 0-9). This key is a shorthand
name for the space that is used when linking content between spaces, for web urls, and
reports.
For example, the 'Development Space' might have a space key of 'DEV'.
• Space Description: Enter a description to give other users an idea of the space's contents
(optional). A space description may contain Confluence markup.
3. Click 'OK'.
Now, you can start adding pages to your space.
RELATED TOPICS
Working with Spaces Overview
Setting up your Personal Space
Viewing Space Details
Editing Space Details
Browsing a Space
Deleting a Space
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 402
Setting up your Personal Space
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Your personal space is a place where you can publish your own pages and news items. Your personal
space can be reached by clicking your name in the People Directory.
To set up your personal space, you require 'Personal Space' permission which is assigned by a site
administrator from the Administration Console. See Security or contact a site administrator for more
information.
To create your personal space,
1. Click on the 'Preferences' link located below the breadcrumbs at the top of the page.
2. This will display your Profile. Click the link 'Create Personal Space':
3. Enter a few details about your space:
• Choose who can view content
• Choose who can contribute (create and edit) content
• Choose the Theme (look and feel) for your personal space.
Document generated by Confluence on Feb 08, 2007 14:05
Page 403
4. Click the 'Create' button.
Now, you can start adding pages to your personal space. You may also want to upload your photo.
Handy Hint
Once you have set up your personal space, you can return to it any time by clicking your name
(next to the word 'Welcome' at the top of the page).
RELATED TOPICS
Working with Spaces Overview
Converting a Global Space to a Personal Space
User Profile Overview
Linking to Personal Spaces and User Profiles
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 404
Viewing all Spaces
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Once you login, the list of spaces you have permission to view is displayed on your Dashboard under the
spaces section.
The list of spaces is displayed via meaningful tabs :
•
•
•
•
My Spaces : Spaces you marked as your favourites.
Team Spaces : Spaces pertaining to a team grouped together using team labels.
New : New spaces added to the site in the last seven days.
All : All the spaces on the site.
Screenshot : Viewing Spaces
• Additionally, a list of personal spaces is available via the People Directory icon on the Dashboard:
Go to the Dashboard from any page on your site simply by clicking the logo beside the page title or via
the breadcrumbs (the "you are here" path) located at the top of every page.
If you do not login, you will be treated as an 'anonymous user' and only those spaces to which an
anonymous user has 'View' permission will be displayed on the Dashboard.
Permission to a space is granted by a space administrator. See Space permissions for more information.
Handy Hint
Use the Spaces List Macro to view the list of spaces from any other page in Confluence.
RELATED TOPICS
Working with Spaces Overview
Setting up a New Global Space
Document generated by Confluence on Feb 08, 2007 14:05
Page 405
Browsing a Space
Moving Content from one Space to Another
Deleting a Space
Take me back to Home Help
Comments
Unfortunately, as an administrator, there doesn't seem to be an easy way to view a list of all users who
have created personal spaces, whether public or private.
Posted by garnetr at Dec 13, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 406
Viewing Space Activity
This page last changed on Jan 07, 2007 by rosie@atlassian.com.
In Confluence version 2.3 and later, statistics on each space's activity are available. These include:
• How many pages and news posts have been
° viewed
° added
° edited
• Which content is the most popular (i.e. most frequently viewed)
• Which content is the most active (i.e. most frequently edited)
• Which people are the most active contributors/editors of content
To view a space's activity,
1. Click on the 'Browse Space' link for the space. This is located at the top of every page and beside
the space link on the dashboard.
2. Go to the 'Activity' tab.
The number of pages and news posts that have been viewed, added and edited will be displayed
graphically, showing trends over a period of time, e.g.:
Screenshot : Number of viewed pages and news posts in a week
Document generated by Confluence on Feb 08, 2007 14:05
Page 407
The top 10 most popular and most active pages and/or news posts will be listed, with a link to each, e.g.:
Screenshot : Popular content
If your Confluence site is [clustered], Space Activity will not be available.
Document generated by Confluence on Feb 08, 2007 14:05
Page 408
RELATED TOPICS
Browsing a Space
Viewing Space Details
Viewing History of a Page
Tracking Updates Overview
Take me back to Confluence 2 Home
Document generated by Confluence on Feb 08, 2007 14:05
Page 409
Space Attachments Directory
This page last changed on Nov 28, 2005 by vidya.
This page contains all the attachments for the Confluence 2.0 documentation space.
Document generated by Confluence on Feb 08, 2007 14:05
Page 410
Confluence Notation Guide Overview
This page last changed on Jan 10, 2007 by ivan@atlassian.com.
Confluence pages are stored internally in a simple content-formatting language called Wiki Markup,
based on Textile .
The Wiki Markup Editor allows users to edit Confluence pages directly in wiki markup language. This
has the advantage of being faster than the Rich Text Editor for some formatting tasks. When using the
wiki markup editor to edit a page, examples of commonly used markup are displayed in a panel on the
right called the Quick Notation Guide, with a link to the Full Notation Guide for more detail.
Because wiki markup is designed to be simple to learn, the quickest way to learn wiki markup is to edit
an existing page, switch to the wiki markup editor and experiment. More resources on wiki markup
editing can be found below.
Full Notation Guide To customise the look and feel of the notation guide, please see these instructions.
Working with Headings
Working with Text Effects
Working with Text Breaks
Working with Links
Working with Anchors
Working with Images
Working with Lists
Working with Tables
Working with Macros
Confluence Emoticons
Here's a short example of some typical markup:
What you type
h4. Confluence Markup
Ideally, the markup should be _readable_
and even *clearly understandable* when you
are
editing it. Inserting formatting should
require few keystrokes, and little thought.
After all, we want people to be
concentrating on the words, not on where
the angle-brackets
should go.
* Kinds of Markup
** Text Effects
** Headings
** Text Breaks
** Links
** Other
Document generated by Confluence on Feb 08, 2007 14:05
What you get
Confluence Markup
Ideally, the markup should be readable and even
clearly understandable when you are
editing it. Inserting formatting should require few
keystrokes, and little thought.
After all, we want people to be concentrating on
the words, not on where the angle-brackets
should go.
• Kinds of Markup
° Text Effects
° Headings
° Text Breaks
° Links
° Other
Page 411
Here, in comparison, is how that would look if you had to edit the page in HTML:
<h4>Confluence Markup</h4>
<p>Ideally, the markup should be <em>readable</em> and even <strong>clearly
understandable</strong>
when you are editing it. Inserting formatting should require few keystrokes, and little
thought</p>
<p>After all, we want people to be concentrating on the words, not on where the angle-brackets
should
go.</p>
<ul>
<li>Kinds of Markup
<ul>
<li>Text Effects</li>
<li>Headings</li>
<li>Text Breaks</li>
<li>Links</li>
<li>Other</li>
</ul>
</li>
</ul>
RELATED TOPICS
Rich Text Editor Overview
Writing Confluence Pages
Creating a New Page
Working with Macros
Take me back to Confluence 2 Home
Comments
This Notation Guide Incomplete!
The Notation Guide here is not as complete as the 'full notational gude' available in the page editor. The
latter, on the other hand cannot be printed or converted to PDF
Posted by pas at May 10, 2006.
.....................................................................................................................................................................
What 'full notational guide'?
Posted by daveyost at Sep 23, 2006.
.....................................................................................................................................................................
The full notation guide that is linked to when you edit in Wiki Markup(via the Wiki Marup Tab
). You
can print this out by selecting ALL, you could even export to PDF if you wanted by printing through a
freeware PDF creator such as CutePDF
Posted by tbaker@insidefr.com at Oct 03, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 412
Confluence Emoticons
This page last changed on Aug 30, 2006 by mryall.
Emoticons are little images you can easily use in a Confluence page. They use a simple wiki markup as
shown below, or you can insert them using the Rich Text editor.
Graphical emoticons (smileys).
Notation
Image
:)
:(
:P
:D
;)
(y)
(n)
(i)
(/)
(x)
(!)
(+)
(-)
(?)
(on)
(off)
(*)
(*r)
(*g)
(*b)
(*y)
Comments
Is it possible to add other icons to this list? We have standard icons that we use that would be nice to
add in quickly instead of attaching to the wiki page, and then adding.
Document generated by Confluence on Feb 08, 2007 14:05
Page 413
Posted by carriemiller at Oct 10, 2006.
.....................................................................................................................................................................
Is it possible to remove icons from this list, so that certain keystrokes are not automatically translated to
emoticons? I know that emoticons can be escaped using a backslash, but that is not a suitable solution
for some of our users.
Posted by tgoymerac at Nov 20, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 414
Form Field Markup for Templates
This page last changed on Feb 05, 2007 by rosie@atlassian.com.
Templates are written in the same notation as other pages in Confluence with special markup to insert
form fields.
Here are the three kinds of form fields supported and the markup to create them:
Text field
@VAR@
Creates a text input field for a
variable called VAR
@VAR|textarea(5,10)@
Creates a 5 x 10 text-area for a
variable called VAR
Text area
Drop down menu
Creates a drop-down box
containing the values "one",
"two", "three" and "four"
@VAR|list(one,two,three,four)@
Every input field must have a unique name. If you have more than one text input field in the same
template with the same name, Confluence will make sure that they all end up with the same value (This
is useful if you need the same information in more than one place in the page).
Warning
There must be no spaces between the @-signs in the markup. This means you can't have items in
your drop-down lists that contain spaces.
Improved Markup
The above formatting is the basic markup bundled with Confluence, but two plugins expand on this
markup to provide greater functionality. Links to these plugins and a comparison can be found in the
Working with Templates Overview.
RELATED TOPICS
Working with Templates Overview
[Scaffolding Plugin]
[Zones Plugin]
Adding a Template
Editing a Template
Creating a Page using a Template
Take me back to Confluence 2 Home
Comments
Document generated by Confluence on Feb 08, 2007 14:05
Page 415
I know those form fields from an open-source Wiki. Here I cannot find any information about how to use
those form variables after they have been defined for a page. Somewhere you're writing that it's for
structuring the content but what can I DO with it?
For example, I would like to create a page which links all pages with the variable "myname". Can I only
do this with labels?
Posted by tattva at Feb 03, 2006.
.....................................................................................................................................................................
It would be nice to be able to create a list out of the users within a particular group (similar to what you
can do with the {scaffold} plug-in). Something like @VAR|groupmembers(confluence-users) would be
good.
Default values for variables would also be high on the basic-additions wishlist.
In general more "special markup" functionality would be great (or more documented functionality, as I
suspect there is more than is here).
Posted by rwarren@picarro.com at Mar 01, 2006.
.....................................................................................................................................................................
Yes, you can use the {contentbylabel:myname} to do that.
Posted by gfraser at Mar 01, 2006.
.....................................................................................................................................................................
Are there some sample templates that use forms? A search isn't so fruitful...
Posted by amyoung at Mar 06, 2006.
.....................................................................................................................................................................
Can a dropdown list be created from sql output?
Posted by melogin at Mar 30, 2006.
.....................................................................................................................................................................
You can now find an example at Adding a Template
Posted by david.soul@atlassian.com at Aug 14, 2006.
.....................................................................................................................................................................
This is not possible without [creating a plugin]
Posted by david.soul@atlassian.com at Aug 14, 2006.
.....................................................................................................................................................................
You also can't have a "-" between the @ signs in a template. This should be documented.
Posted by gkotik at Aug 18, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 416
I'm experimenting with the form fields directly on a page (not a template). I've noticed switching
between Rich text and wiki markup editing causes the @@ signs to disappear. Is there any way of
preventing this? Also, is there any way of controlling the alignment of the form fields. I'm using a table to
align form fields, is there another way?
Posted by ahardy at Aug 21, 2006.
.....................................................................................................................................................................
Hey Alan,
did you find any solution for that issue yet?
Posted by loetterle at Sep 12, 2006.
.....................................................................................................................................................................
I couldn't get the forms to work on a page outside of a template. Also, you can't use a drop-down in a
table, because the | is read as another cell. This is a big problem for my design.
Posted by sltrunzo at Nov 02, 2006.
.....................................................................................................................................................................
This size of textares not quit work.
When specified a size with axb, as row x column. Firefox only recognize the row, but not IE, and both FF
and IE don't recognize columns, then they insert column=40 by default.
since that, I tried to specify only the number of row, like @textarea|textarea(5)@, now both IE and FF
recognize the number of rows, and work nice with default column = 40.
I believe it should be a bug. If it is open source I would fix it myself. Should it be fixed quick and have us
updated? so that we could continue using textarea and be able to specify number of column.
Posted by dawen.tan@sadasystems.com at Dec 14, 2006.
.....................................................................................................................................................................
Actually, I believe it is a bug for rendering size of textarea.
When specified @var|texrarea(5x10)@, the size is rendered to html as :<textarea
name="variableValues.var" rows="5x10" cols="40"></textarea> that is a mistake output. currently, to
work around it, I only specify the row number, like: (var), then we would have:<textarea
name="variableValues.var" rows="5" cols="40"></textarea> although when column number is not
under control, at least, we could make number of row as we expected.
Posted by dawen.tan@sadasystems.com at Dec 14, 2006.
.....................................................................................................................................................................
can i submit the form and capture the values ?
what are the real use-cases of these ?
Posted by nayanah at Jan 12, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 417
You guys need to update
the documentation!!!!!
commenets from Filip De Haes [Filip.DeHaes@vdab.be] about the documentation for textarea:
Hey,
Just wanna mention the textarea size properties of the confluence wiki do work, but the documentation is
wrong.
Just replace the x with ,
E.g. @VAR|textarea(30,160)@
Maybe you can add it to the comments at
http://confluence.atlassian.com/display/CONF20/Form+Field+Markup+for+Templates . I'm too lazy.
Cheers,
Filip
Posted by dawen.tan@sadasystems.com at Feb 05, 2007.
.....................................................................................................................................................................
thank you, fixed
Posted by rosie@atlassian.com at Feb 05, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 418
Working with Headings
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can use Confluence Notation or the Rich Text editor to create headers.
Creating a header is easy. Simply place "hn." at the start of your line (where n can be a number from
1-6).
What you need to type
What you will get
Biggest heading
Biggest heading
Bigger heading
Bigger heading
Big heading
Big heading
Normal heading
Normal heading
Small heading
Small heading
Smallest heading
Smallest heading
Note that Confluence treats all headings as anchors.
RELATED TOPICS
Rich Text-Working with Text Effects
Working with Text Effects
Working with Macros
Take me back to Confluence 2 Home
Comments
Is it possible to make automatically-numbered headings?
For example, it would be nice if the following code
Document generated by Confluence on Feb 08, 2007 14:05
Page 419
# h1. Introduction
Body Text
# h1. Overview
Body Text
bore this result:
1. Introduction
body text
2. Overview
Posted by paw at Nov 14, 2006.
.....................................................................................................................................................................
We're interested in numbered headings too - has anyone created a macro to do this?
~Matt
Posted by mdoar at Feb 05, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 420
Working with Lists
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Confluence allows you to create bulleted or numbered lists, and is flexible enough to allow a combination
of the two lists.
Simple lists
Use the hyphen (-) to create simple lists.
Make sure there is a space between the hyphen and your text.
What you need to type
What you will get
• some
• bullet
• points
- some
- bullet
- points
Bulleted lists
Use the asterisk (*) to create bullets. For each subsequent level, add an extra asterisk.
Make sure there is a space between the asterisk and your text.
What you need to type
* some
* bullet
** indented
** bullets
* points
What you will get
• some
• bullet
° indented
° bullets
• points
Numbered lists
Use the hash (#) to create numbered lists.
Make sure there is a space between the hash and your text.
What you need to type
# a
# numbered
# list
What you will get
1. a
2. numbered
3. list
Mixed lists
Document generated by Confluence on Feb 08, 2007 14:05
Page 421
If you need to separate the text within lists using line breaks, make sure you do so using //. Line
breaks using empty lines may disrupt the list.
What you need to type
# Here
#* is
#* an
# example
#* of
#* a
# mixed
# list
What you will get
1. Here
• is
• an
2. example
• of
• a
3. mixed
4. list
RELATED TOPICS
Working with Text Breaks
Confluence Notation Guide overview
Take me back to Confluence 2 Home
Comments
Is there any way to make the numbered List start with any other number than 1?
Posted by kjahn at May 22, 2006.
.....................................................................................................................................................................
Is there any way to create a list with alpha headings? For example, I want to create the following:
1. First number
a. First alpha
b. Second alpha
c. Third alpha
2. Second number
a. First alpha
b. Second alpha
3. Third number
Posted by jdibble at Jun 08, 2006.
.....................................................................................................................................................................
Is there any way to create outline numbers? For example, I want to create the following:
1. First item
1.1 First sub-item
1.2 Second sub-item
1.3 Third sub-item
2. Second item
Document generated by Confluence on Feb 08, 2007 14:05
Page 422
2.1 x
2.2 y
2.3 z
I realize that this isn't supported in HTML, so I doubt you have a solution for it.
Posted by jdibble at Jun 08, 2006.
.....................................................................................................................................................................
I would also like to know if it possible to have an alpha ordered list.
Posted by alternateroute at Nov 19, 2006.
.....................................................................................................................................................................
Is there any way to create an alpha list period? i.e. can you do that or the reverse as well?
Posted by sgarber at Dec 27, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 423
Working with Tables
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
You can use Confluence Notation or the Rich Text editor to create tables.
Confluence allows you to create two types of tables.
Currently, Confluence does not support nested tables.
Table type 1
Allows you to create a simple table with an optional header row. You cannot set the width of the columns
in this table.
Use double bars for a table heading row.
What you need to type
||heading 1||heading 2||heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|
What you will get
heading 1
heading 2
heading 3
col A1
col A2
col A3
col B1
col B2
col B3
Table type 2
Allows you to specify the width of the columns in the table.
What you need to type
{section:border=true}
{column:width=30%}
Text for this column goes here. This is
{column}
the smaller column with a width of only 30%.
{column:width=70%}
Text for this column goes here. This is
{column}
the larger column with a width of 70%.
{section}
What you will get
Document generated by Confluence on Feb 08, 2007 14:05
Page 424
Text for this column goes here. This is the smaller
column with a width of only 30%.
Text for this column goes here. This is the larger
column with a width of 70%.
RELATED TOPICS
Rich Text-Working with Tables
Working with Macros
Take me back to Confluence 2 Home
Comments
You can also use a vertical header with:
||heading 1|col A1|col A2|col A3|
||heading 2|col B1|col B2|col B3|
which results in:
heading 1
col A1
col A2
col A3
heading 2
col B1
col B2
col B3
Posted by david_ruddock at Jun 05, 2006.
.....................................................................................................................................................................
How do you code multiple rows in Table Type 2?
Posted by carlosp at Jun 11, 2006.
.....................................................................................................................................................................
Hiho,
how do I set background color in tables? I
Posted by heiket at Jun 13, 2006.
.....................................................................................................................................................................
Feature request I guess... how about having a "rich table" that included the ability to sort by column on
the headers? Surely those people at google aren't the only ones who can write proper javascript?
Posted by xurf at Sep 08, 2006.
.....................................................................................................................................................................
How can I create table cells that span multiple columns or rows?
Posted by greheine at Oct 20, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 425
HI,
I am just starting out with confluence and the Wiki Markup, I was wondering if you did find out how to
start a new line in a table?
Using the help:
Text for this column goes here. This is the smaller
column with a width of only 30%.
Text for this column goes here. This is the larger
column with a width of 70%.
Thanks
Amy
Posted by amiliau@caltex.com.au at Jan 02, 2007.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 426
Working with Text Breaks
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Paragraph break
An empty line produces a new paragraph. Most of the time, explicit paragraph breaks are not required Confluence will be able to paginate your paragraphs properly.
Line break
Use two backslashes
Unknown macro: {nomarkup}
(
)
to create a line break.
What you need to type
here is some text
Unknown macro: {nomarkup}
divided
What you will get
here is some text
divided
using line
breaks
Unknown macro: {nomarkup}
using line
Unknown macro: {nomarkup}
breaks
Horizontal ruler
Use four dashes (----) to create a horizontal ruler.
Make sure that the dashes are in a separate line from the text.
What you need to type
here is some text
Unknown macro: {nomarkup}
What you will get
here is some text
divided
by a horizontal ruler
Document generated by Confluence on Feb 08, 2007 14:05
Page 427
divided
by a horizontal ruler |
RELATED TOPICS
Working with Lists
Confluence Notation Guide overview
Take me back to Confluence 2 Home
Comments
"An empty line produces a new paragraph. Most of the time, explicit paragraph breaks are not required Confluence will be able to paginate your paragraphs properly."
Not true newlines seems
to
always
starts a
new paragraph.
As shown
here...
(The text should reflow.) We have "2.1.5a Build:#411 2006-03-16" here and it suffers from the same
bug.
Posted by bear at Oct 19, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 428
Working with Text Effects
This page last changed on Jan 02, 2007 by rosie@atlassian.com.
Use the markup shown in the examples below to format the text in your pages.
What you need to type
What you will get
*strong*
strong
_emphasis_
emphasis
??citation??
citation
-deleted-
deleted
+inserted+
inserted
^superscript^
superscript
~subscript~
subscript
{{monospaced}}
monospaced
bq. Here's how you make text in a paragraph into
a block quotation
Unknown macro: {nomarkup}
Here's how you make text in a paragraph
into a block quotation
look ma, red text!
look ma, red text!
RELATED TOPICS
Working with Headings
Take me back to Confluence 2 Home
Comments
something needs to be done about the syntax for the coloring of text. It does not show the actual syntax.
This is what I pulled out of the Full Notation Guide from our instance of Confluence:
{color:red}
look ma, red text!
{color}
Posted by osolage at Dec 28, 2005.
.....................................................................................................................................................................
Is it possible to comment out portions of the contents in a page? Something like they have in HTML/XML
would be nice: <!-- look ma, invisible! -->
Posted by pas at May 10, 2006.
Document generated by Confluence on Feb 08, 2007 14:05
Page 429
.....................................................................................................................................................................
Is there some way to justify text (left, center, right)? I'd like to align some text to the right, but I cannot
find a way to do this in the Wiki mark-up language.
Posted by karlj@expedia.com at Jun 02, 2006.
.....................................................................................................................................................................
Document generated by Confluence on Feb 08, 2007 14:05
Page 430
Download PDF

advertising