Manual:Extension/SimpleTasks: Difference between revisions

Latest revision as of 11:24, 31 August 2026

Link to YouTube video. To see example checklist — Mentions and tasks (4:39 min.)

Tasks are checklist items that can be checked or unchecked to indicate whether a task is open or completed. SimpleTasks also supports assigning tasks to users and adding due dates.

NoteEach task description must be unique because the task ID is generated from the task description.

Create a simple task

A simple task consists of a checkbox and a task description.

Unchecked task checkbox with task description

Task item

Create a task in the editor

To add a simple task:

Type [] at the beginning of a line and enter the task description directly after the checkbox.
Press Enter.
The line is automatically converted into a checklist item.

Create a task with the Tasklist Content Droplet

To add a simple task with the Content Droplet:

Select the Content Droplet icon in the editor toolbar.
Select Tasklist. A checkbox is inserted.
Add the task description next to the checkbox.
Repeat the previous two steps to add more tasks. Alternatively, copy the first task line to new lines and change the individual task descriptions.

Each task can be checked or unchecked. Each change to a checkbox creates an entry in the page version history.

Page version history showing changes to task checkbox states

Task changes in the page history

Create a combined task

A combined task can contain three elements:

a task checkbox with a task description
an assignee
an optional due date

When these elements are added consecutively, they are recognized as a single task item. The order of the elements is flexible.
To create a combined task:

Add a task item as described in Create a simple task.
Add a mention immediately after the task description to assign the task to a user.
Add a Date Content Droplet immediately after the user mention to add a due date. This step is optional.
Copy the complete task line and paste it on a new line to create another task item.
Change the task description, assignee, and date as needed.

View and manage assigned tasks

Assigned users can view their open tasks in the task list.
When an assigned task is created, the assigned user receives a notification in the wiki. An email notification is also sent when email is available in the system.
Notification settings can be adjusted in the user's notification preferences.

Create a task report

All tasks in the wiki can be displayed in a table using the Task report Content Droplet.

Parameters dialog for the Task report

Task report parameters

To insert a task report:

Select the Content Droplet icon in the editor toolbar.
Select Task report.
Configure the optional filters as needed.
Select Insert.

The following filters are available:

Filter	Description
Assignees	Filters the report by assigned users.
Namespaces	Filters the report by namespace.
Due until	Filters tasks by their due date.
State	Filters tasks by their current state, such as open or done.

Task report showing an open task with filter options

Task report

@@ Line 1: / Line 1: @@
-{{BSVersion|bsvFrom=4.4|bsvFeature=SimpleTasks}}
+[[File:SMWCon2023-Mentions-and-Tasks-thumb.png|alt=Link to YouTube video. To see example checklist|thumb|280x280px|[[File:youtube-icon.png|left|22x22px]][https://www.youtube.com/watch?v=ZBRDZR2b4EI Mentions and tasks] (4:39 min.)]]
-[] [[User:WikiSysop|Meryam Sahin]] Rework this page[[File:SMWCon2023-Mentions-and-Tasks-thumb.png|alt=Link to YouTube video. To see example checklist|thumb|280x280px|[[File:youtube-icon.png|left|22x22px]][https://www.youtube.com/watch?v=ZBRDZR2b4EI Mentions and tasks] (4:39 min.)]]
+Tasks are checklist items that can be checked or unchecked to indicate whether a task is open or completed. '''SimpleTasks''' also supports assigning tasks to users and adding due dates.
-== What are tasks? ==
+{{Textbox|boxtype=important|header=Note|text=Each task description must be unique because the task ID is generated from the task description.|icon=yes}}
-Tasks are  checklist items that can be checked on or off to indicate if the task is open or completed.
+== Create a simple task ==
-{{Textbox|boxtype=important|text=Each task description needs to be unique, since the task ID is created from the description.|header=}}
+A simple task consists of a checkbox and a task description.
-===Simple tasks===
+[[File:simpletasks-task-item.png|alt=Unchecked task checkbox with task description|center|thumb|Task item|350x350px]]
-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]]
+=== Create a task in the editor ===
+To add a simple task:
-'''To add a simple task:'''
+# Type <code>[]</code> at the beginning of a line and enter the task description directly after the checkbox.
+# Press Enter.
-# '''Type''' <code>[]</code> at the beginning of the line and then add text directly after the checkbox.
+# The line is automatically converted into a checklist item.
-# '''Press''' Enter. The line is automatically converted into a checklist item.
+=== Create a task with the Tasklist Content Droplet ===
+To add a simple task with the '''Content Droplet''':
-'''To add a simple task as Content Droplet:'''
+# Select the '''Content Droplet''' icon in the editor toolbar.
+# Select '''Tasklist'''. A checkbox is inserted.
-#'''Click''' the Content Droplet icon in the editor toolbar.
+# Add the task description next to the checkbox.
-#'''Select''' the Tasklist droplet. This inserts a checkbox.
+# Repeat the previous two steps to add more tasks. Alternatively, copy the first task line to new lines and change the individual task descriptions. <br>
-#'''Add''' the task description next to the checkbox.
+Each task can be checked or unchecked. Each change to a checkbox creates an entry in the page version history.
-#'''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.
+[[File:simpletasks-task-history.png|alt=Page version history showing changes to task checkbox states|center|thumb|Task changes in the page history|650x650px]]
+== Create a combined task ==
-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.
+A combined task can contain three elements:
-[[File: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]]
+* a task checkbox with a task description
+* an assignee
-===Combined tasks===
+* an optional due date <br>
-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:
+When these elements are added consecutively, they are recognized as a single task item. The order of the elements is flexible. <br>
+To create a combined task:
-#'''Add''' your task list item as described above.
+# Add a task item as described in [[#Create a simple task|Create a simple task]].
-#'''Add''' a [[Manual:Extension/AtMentions|mention]]  immediately after the task description to assign the task to a user.
+# Add a [[Extension/AtMentions|mention]] 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 to add a due date. This step is optional.
-#'''Copy''' the entire task line and paste it on a new line to create the next task item.
+# Copy the complete task line and paste it on a new line to create another task item.
+# Change the task description, assignee, and date as needed.
-=== My Tasks ===
+== View and manage assigned tasks ==
-Users can see all their open tasks on their  [[Reference:UnifiedTaskOverview|task list]]. Every time a task is created, the assigned user is notified in e-mail and in the wiki about the new task.
+Assigned users can view their open tasks in the [[Reference:UnifiedTaskOverview|task list]]. <br>
+When an assigned task is created, the assigned user receives a notification in the wiki. An email notification is also sent when email is available in the system. <br>
-Users can modify their [[Manual:Preferences|notification preferences]] as needed.
+Notification settings can be adjusted in the user's [[Preferences|notification preferences]].
+== Create a task report ==
-== Task report ==
+All tasks in the wiki can be displayed in a table using the '''Task report''' Content Droplet.
-[[File:Manual Extension SimpleTasks 1747821827754.png|thumb|300x300px|alt=Parameter dialogue for the task report|Insert report]]All tasks that exist in the wiki can be displayed together in a table. To do this, insert the Task report [[Manual:Extension/ContentDroplets|content droplet]].
+[[File:simpletasks-task-report-parameters.png|thumb|300x300px|alt=Parameters dialog for the Task report|Task report parameters]]
+To insert a task report:
-The following optional filters are available:
+# Select the '''Content Droplet''' icon in the editor toolbar.
+# Select '''Task report'''.
-* Assignees
+# Configure the optional filters as needed.
-* Namespaces
+# Select '''Insert'''. <br>
-* Due until (date)
+The following filters are available:
-* Status (open, done)
+{| class="wikitable"
+! Filter
-Click Insert to display the report.
+! Description
-{{Textbox|boxtype=|header=|text=|icon=}}
+|-
-[[File:Manual Extension SimpleTasks 1747822282310.png|alt=Filterable task report with one open task|center|thumb|650x650px|Task report]]
+| Assignees
+| Filters the report by assigned users.
-== Querying tasks ==
+|-
-If you are familiar with [[Reference:Semantic MediaWiki|Semantic MediaWiki]], you can query the task items.
+| Namespaces
+| Filters the report by namespace.
-{{Textbox|boxtype=important|header=Wichtig!|text=Semantic properties for tasks are only generated if the checklist entry has an assigned user! Checklists that are created in the namespace "User" cannot be queried.|icon=yes}}
+|-
+| Due until
-Tasks with an assigned user are stored as subobjects [https://www.semantic-mediawiki.org/wiki/Help:Subobjects_and_queries semantic subobjects] with the following properties:
+| Filters tasks by their due date.
+|-
-* Property:Task/Desc
+| State
-* Property:Task/Due date
+| Filters tasks by their current state, such as open or done.
-* Property:Task/User
+|}
-* Property:Task/Status
+[[File:simpletasks-task-report.png|alt=Task report showing an open task with filter options|center|thumb|Task report|650x650px]]
-{{translation}}