Confluence Docs 3.0 : Tasklist Macro This page last changed on Jun 08, 2009 by ggaskell. 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.
| Dynamic Tasklist 2 plugin is shipped with Confluence 2.8 The `tasklist` macro is supplied by the Dynamic Tasklist 2 plugin, which is bundled with Confluence version 2.8 and later. The new `tasklist` macro replaces the older `tasklist` and `dynamictasklist` macros.
On this page: Usage with the Macro Browser Usage with the Wiki Markup Editor Parameters Editing the Task List while Viewing a Page Sorting the Tasks Viewing the Progress on Tasks Completed Editing the Wiki Markup for a Task List ## Usage with the Macro Browser To insert the tasklist macro into a page using the Macro Browser, Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page. 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:
What you need to type | What you will get
--- | ---
{tasklist:Planning a Holiday} |
## Parameters Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro. Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (`bracketed`) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (`:`).
Parameter | Required? | Default | Description
--- | --- | --- | ---
Title | no | 'Task List' | The name of the task list. This is displayed as the title above the list of tasks. For example: {tasklist:Things to Do}
(`width`) | no | 530px | The width of the task list. For example, in Wiki Markup: {tasklist:Things to Do|width=200px} {tasklist:Things to Do|width=50%}
(`enableLocking`) | no | false | If you set this parameter to 'true', you will be able to lock individual tasks so that they cannot be changed. See instructions below on editing the task list. For example: {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 Guide.

Document generated by Confluence on Nov 05, 2009 23:35