The Tasklist macro allows you to create and update a list of tasks on the wiki page. Users viewing the page can modify the tasks without putting the page into 'Edit' mode, provided they have the required permissions to modify the page.

On this page:

Usage with the Macro Browser

To insert the tasklist macro into a page using the Macro Browser,

Once you've found the tasklist macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

To add a task list using the Wiki Markup Editor, you must first edit the page and then type the macro code:

{tasklist:NAME OF TASK LIST}

Here is an example:

{tasklist:Planning a Holiday}

Parameters

{tasklist:Things to Do}

{tasklist:Things to Do|width=200px}

{tasklist:Things to Do|width=50%}

{tasklist:Things to Do|enableLocking=true}

Editing the Task List while Viewing a Page

While viewing a page, you can change the tasks in a task list as follows:

• Adding a task: Type the task description in the text box under the list name, and click the 'Add' button.
• Completing/uncompleting a task: Click the checkbox next to a task to mark the task as complete. The task name will become a lighter color and the progress bar will be updated. Click the checkbox again to mark the task as uncompleted. You can also click the 'Uncheck all' button to mark all tasks as uncompleted.
• Editing a task: Move your mouse to hover your cursor over the task. Click the edit icon (pencil) that appears to the right of the task. The task name will become editable and the edit icon will be replaced with a save icon. Make your change and press the 'Enter' key to save or click the save icon.
• Deleting a task: Move your mouse to hover your cursor over the task. Click the delete icon (trash can) that appears to the right of the task.
• Viewing details of a task: Click the arrow icon to the left of the task name. The task details will open in an expanded view.
• Locking a task: Provided that the locking parameter has been set to 'true', you can click the lock icon to prevent the task from being edited, deleted, or otherwise changed.

Once the task details are visible, you have more options:

• Changing the priority: Click the appropriate radio button — 'High', 'Medium' or 'Low'.
• Assigning the task: Change the assignee of the task by typing in or searching for a username.
  
  Screenshot: Task List showing Task Details
  
  

Sorting the Tasks

There are two ways to sort the entries in the task list:

• The 'Sort by' dropdown list.
• Drag and drop.

Using the 'Sort by' dropdown list to sort the tasks:

• Click the 'Sort by' dropdown list and select one of the options:
  • Custom: This is the default option.
  • Priority: Sort the list in order of the priority you have allocated to each task.
  • Date Created: Sort the list in order of the dates upon which the tasks were created.
  • Completed: Move all completed tasks to the bottom or top of the list.
  • Name: Sort the list in order of the task names.
  • Assignee: Sort the list in order of the usernames assigned to the tasks.
• When you have selected a sort order, a new ascending/descending sequence icon appears to the right of the 'Sort by' box. Click the ascending/descending sequence icon to reverse the sort order.

Dragging and dropping a task into a new position:

• Click the 'drag me' handle to the right of the task name.
• Holding down the mouse button, drag the task up or down the list. Make sure the task is positioned to the left of the existing tasks. A space will open and you will be able to drop the task into its new position.

Viewing the Progress on Tasks Completed

The bar at the top of the task list displays two different colours, indicating the percentage of tasks completed.

Screenshot: Progress Bar on Task List

Editing the Wiki Markup for a Task List

The data for the task list is stored in the Confluence page. Most people will find it easier to add or modify tasks while viewing the page. But if you want to edit or even create the task list directly, you can do so by editing the page itself. Here is an example, showing the Wiki Markup for the above task list:

{tasklist:Planning a Holiday}
||Completed||Priority||Locked||CreatedDate||CompletedDate||Assignee||Name||
|F|M|F|1206677926204|          |smaddox|Book tickets|
|F|H|F|1206677938246|          |smaddox|Check passport expiry|
|F|M|F|1206677946737|          |smaddox|Apply for visa|
|F|M|F|1206677954490|          |smaddox|Buy suitcases|
{tasklist}

RELATED TOPICS

Working with Macros

Take me back to the Confluence User's Guide.