3.1 Creating tasks

VisualWikitext

Latest revision as of 14:47, 2 April 2024

SimpleTasks is available from BlueSpice 4.4.

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.

Task item

To add a simple task:

Type [] at the beginning of the line and then add text directly after the checkbox.
Press Enter. The line is automatically converted into a checklist item.

To add a simple task as Content Droplet:

Click the Content Droplet icon in the editor toolbar.
Select the Tasklist droplet. This inserts a checkbox.
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.

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.

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.

Finished task list

To add a combined task item:

Add your task list item as described above.
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 (optional).
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. Every time a task is created, the assigned user is notified in e-mail and in the wiki about the new task.

Users can modify their notification preferences as needed.

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
Property:Task/Status

Technical Reference: SimpleTasks

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

@@ Line 1: / Line 1: @@
-{{BSVersion|bsvFrom=4.4|bsvFeature="Mentions and Tasks"}}
+{{DISPLAYTITLE:Tasks}}
+<bookshelf src="Book:User manual" />
+{{BSVersion|bsvFrom=4.4|bsvFeature=SimpleTasks}}
+__TOC__
+== What are tasks? ==
+Tasks are  checklist items that can be checked on or off to indicate if the task is open or completed.
+{{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 show a checkbox with a task description. [[File:droplet-task-item.png|alt=unchecked task checkbox with description|center|thumb|Task item|350x350px]]
-To directly address a user on a page, you can mention that user. A mention is then shown as a specially formatted name. It can be used in combination with a task and date to create a task item for the mentionned user.
+'''To add a simple task:'''
-== What are mentions? ==
+# '''Type''' <code>[]</code> at the beginning of the line and then add text directly after the checkbox.
-If you mention a user on a page, the user's name is inserted as a mention-item. The user  is notified of the mention, because it creates a link to the user's profile page.
+# '''Press''' Enter. The line is automatically converted into a checklist item.
-'''To mention a user:'''
+'''To add a simple task as Content Droplet:'''
-# '''Select''' the ''Mention'' menu item in the editor toolbar.[[File:Manual:droplet-mention-VE.png|alt=visual editor menu bar with mention item selected|center|thumb|The "mention"  menu item]]
+#'''Click''' the Content Droplet icon in the editor toolbar.
-# '''Enter''' a user name. The mention is added to the page.[[File:Manual:mention-example.png|alt=Example of a formatted user mention|center|thumb|User mention on the page.]]
+#'''Select''' the Tasklist droplet. This inserts a checkbox.
+#'''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.
-== What are tasks? ==
+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.
-Tasks are  checklist items that can be checked on or off to indicate if the task is open or completed.
+[[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]]
-{{Textbox|boxtype=important|text=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.
-To add a simple task:
-# '''Click''' the Content Droplet icon in the editor toolbar.
+===Combined tasks===
-# '''Select''' the Tasklist droplet. This inserts a checkbox.
+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:
-# '''Add''' the task description next to the checkbox.[[File:droplet-task-item.png|alt=unchecked task checkbox with description|center|thumb|Task item]]
-# '''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.
+#'''Add''' your task list item as described above.
+#'''Add''' a [[Manual: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).
+#'''Copy''' the entire task line and paste it on a new line to create the next task item.
-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.
+=== My Tasks ===
-[[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]]
+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.
-=== Combined tasks ===
+Users can modify their [[Manual:Preferences|notification preferences]] as needed.
-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, a single task item is created.
-To add a combined task item:
+== Querying tasks ==
+If you are familiar with [[Reference:Semantic MediaWiki|Semantic MediaWiki]], you can query the task items. They are added as [https://www.semantic-mediawiki.org/wiki/Help:Subobjects_and_queries semantic subobjects] with the following properties:
-# '''Add''' your task list item as described above.
+* Property:Task/Desc
-# '''Add''' a mention (as described above) immediately after the task description to assign the task to a user.
+* Property:Task/Due date
-# '''Add''' a ''Date'' Content Droplet immediately after the user mention (optional).[[File:droplet-date-inspector.png|alt=Date inspector with Insert-button|center|thumb|350x350px|The "Date" Content Droplet]]
+* Property:Task/User
-# '''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]]
+* Property:Task/Status
+{{translation}}