Manual:Extension/AtMentions and Manual:Extension/SimpleTasks: Difference between pages

(Difference between pages)
No edit summary
 
No edit summary
 
Line 1: Line 1:
{{BSVersion|bsvFrom=4.4|bsvFeature=AtMentions}}
{{Manual:Extension/AtMentions}}


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 [[Manual:Extension/ContentDroplets/Mentions and Tasks|in combination with a task and date]] to create a task item for the mentioned user.
== What are tasks? ==
==What are mentions?==
Tasks are  checklist items that can be checked on or off to indicate if the task is open or completed.
If you mention a user on a page, the user's name is inserted as a mention-item.
{{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.  


'''To mention a user:'''
To add a simple task:
#'''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]]
 
#'''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.]]
#'''Click''' the Content Droplet icon in the editor toolbar.
The user is notified of the mention, because it creates a link to the user's profile page. Users can change their notification settings for mentions in their preference. By default, users get in-wiki notifications, but no e-mail notifications.[[File:mention-notification-setting.png|alt=Checked checkbox for in-wiki notifications and unchecked e-mail notifications in the users preferences|center|thumb|Notification setting for mentions]]
#'''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]]
#'''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.
[[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]]
 
===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.
 
To add a combined task item:
 
#'''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 [[Manual:Extension/DateTimeTools|''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]]
 
=== My Tasks ===
Users can see all their open tasks on their  [[Reference:UnifiedTaskOverview|task list]].
 
=== 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:
 
* Property:Task/Desc
* Property:Task/Due date
* Property:Task/User

Revision as of 12:13, 14 November 2023

AtMentions is available from BlueSpice 4.4.


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 mentioned user.

What are mentions?

If you mention a user on a page, the user's name is inserted as a mention-item.

To mention a user:

  1. Select the Mention menu item in the editor toolbar or type @ in visual editing mode.
    visual editor menu bar with mention item selected
    The "mention" menu item
  2. Enter a user name. The mention is added to the page.
    Example of a formatted user mention
    User mention on the page.

The user is notified of the mention, because it creates a link to the user's profile page. Users can change their notification settings for mentions in their preference. By default, users get in-wiki notifications, but no e-mail notifications.

Checked checkbox for in-wiki notifications and unchecked e-mail notifications in the users preferences
Notification setting for mentions

Related info

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.

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.
    unchecked task checkbox with description
    Task item
  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.

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.
    Task list with 4 tasks that have a description, mention and date
    Finished task list

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