Skip to Content

CheckboxedTask

Last modified by Admin Trust-IT on 2023/01/06 21:17

This macro adds a checkboxed task with checkbox macro and an event listener for ticking completed tasks off using the checkboxes

Example:

CKEditor:

In order to make best use of it, add the following CKeditor configuration to your editor through the dedicated "WYSIWYG Editor" section in the Wiki Administration:

1
2
3
4
5
6
7
8
9
10
config['xwiki-macro'] = config['xwiki-macro'] || {};
config['xwiki-macro'].insertButtons = [
  {
    insertDirectly: false,
    macroCall: {
      name:'checktask',
      inline:'enforce',
    }
  }
];

Macros and components: 

  • CheckboxedTask: Contains the checktask macro that inserts checkboxed tasks in pages and a JavaScript listener that listens for checking/unchecking events
  • CheckboxedTaskListener: Event listener that listens for creating and updating tasks on pages, adding xobjects to the respective pages
  • CheckboxUpdater: Is called by the JavaScript listener to update the xobject of a task when checked or unchecked
  • Task Class:  Xobject class that defines the properties of tasks to be saved 
  • CheckboxedTaskReport: Contains the macro reportchecktasks that inserts a task report in pages using the default live data macro. Also contains another JavaScript listener listening for cheking/unchecking events within the live data table.
  • TasksJSON: Defines the database query and formats the input for the live data macro in  the task report
  • CheckboxedTaskTranslations: Contains the localized labes of the task and task report macros