Manual:Extension/SimpleTasks: Difference between revisions

No edit summary
Tag: 2017 source edit
No edit summary
Line 4: Line 4:
{{Textbox|boxtype=important|text=Each task description needs to be unique, since the task ID is created from the description.|header=}}
{{Textbox|boxtype=important|text=Each task description needs to be unique, since the task ID is created from the description.|header=}}
===Simple tasks===
===Simple tasks===
Simple tasks show a checkbox with a task description.  
Simple tasks show a checkbox with a task description. [[File:droplet-task-item.png|alt=unchecked task checkbox with description|center|thumb|Task item|350x350px]]


To add a simple task:
'''To add a simple task:'''


#'''Click''' the Content Droplet icon in the editor toolbar.
#'''Click''' the Content Droplet icon in the editor toolbar.
#'''Select''' the Tasklist droplet. This inserts a checkbox.
#'''Select''' the Tasklist droplet. This inserts a checkbox.
#'''Add''' the task description next to the checkbox.[[File:droplet-task-item.png|alt=unchecked task checkbox with description|center|thumb|Task item]]
#'''Add''' the task description next to the checkbox.
#'''Repeat''' steps 2 and 3 to add more tasks. Alternatively, copy the first task line and paste it onto new lines. Then change the individual task descriptions.
#'''Repeat''' steps 2 and 3 to add more tasks. Alternatively, copy the first task line and paste it onto new lines. Then change the individual task descriptions.


You can now check the items of your list. Everytime a checkbox is checked or unchecked, the version history of the page creates an entry.
You can now check the items of your list. Everytime a checkbox is checked or unchecked, the version history of the page creates an entry.
[[File:Manual:droplet-task-history.png|alt=version history of the page with comments showing versions with checkbox status changes|center|thumb|550x550px|Checkbox changes in the page history]]
[[File:Manual:droplet-task-history.png|alt=version history of the page with comments showing versions with checkbox status changes|center|thumb|650x650px|Checkbox changes in the page history]]


===Combined tasks===
===Combined tasks===
Tasks can have three elements:  (1) A task checkbox with label, (2) an assignee, and (3) an optional date. When these elements are added to the page consecutively (the order of these elements is flexible), a single task item is created.  
Tasks can have three elements:  (1) A task checkbox with label, (2) an assignee, and (3) an optional date. When these elements are added to the page consecutively (the order of these elements is flexible), a single task item is created. [[File:Pagedraft:mentionswithtasks.png|alt=Task list with 4 tasks that have a description, mention and date|center|thumb|650x650px|Finished task list]]To add a combined task item:
 
To add a combined task item:


#'''Add''' your task list item as described above.
#'''Add''' your task list item as described above.
#'''Add''' a mention (as described above) immediately after the task description to assign the task to a user.
#'''Add''' a mention (as described above) immediately after the task description to assign the task to a user.
#'''Add''' a ''Date'' Content Droplet immediately after the user mention (optional).
#'''Add''' a ''Date'' Content Droplet immediately after the user mention (optional).
#'''Copy''' the entire task line and paste it on a new line to create the next task item.[[File:Pagedraft:mentionswithtasks.png|alt=Task list with 4 tasks that have a description, mention and date|center|thumb|650x650px|Finished task list]]
#'''Copy''' the entire task line and paste it on a new line to create the next task item.


=== My Tasks ===
=== My Tasks ===

Revision as of 15:53, 5 December 2023

What are tasks?

Tasks are checklist items that can be checked on or off to indicate if the task is open or completed.

Each task description needs to be unique, since the task ID is created from the description.

Simple tasks

Simple tasks show a checkbox with a task description.

unchecked task checkbox with description
Task item

To add a simple task:

  1. Click the Content Droplet icon in the editor toolbar.
  2. Select the Tasklist droplet. This inserts a checkbox.
  3. Add the task description next to the checkbox.
  4. Repeat steps 2 and 3 to add more tasks. Alternatively, copy the first task line and paste it onto new lines. Then change the individual task descriptions.

You can now check the items of your list. Everytime a checkbox is checked or unchecked, the version history of the page creates an entry.

version history of the page with comments showing versions with checkbox status changes
Checkbox changes in the page history

Combined tasks

Tasks can have three elements: (1) A task checkbox with label, (2) an assignee, and (3) an optional date. When these elements are added to the page consecutively (the order of these elements is flexible), a single task item is created.

Task list with 4 tasks that have a description, mention and date
Finished task list

To add a combined task item:

  1. Add your task list item as described above.
  2. Add a mention (as described above) immediately after the task description to assign the task to a user.
  3. Add a Date Content Droplet immediately after the user mention (optional).
  4. Copy the entire task line and paste it on a new line to create the next task item.

My Tasks

Users can see all their open tasks on their task list.

Querying tasks

If you are familiar with Semantic MediaWiki, you can query the task items. They are added as semantic subobjects with the following properties:

  • Property:Task/Desc
  • Property:Task/Due date
  • Property:Task/User



To submit feedback about this documentation, visit our community forum.

No categories assignedEdit

Discussions