Skip to content

jmiba/XWiki-Checkboxed-Task-Macro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 

Repository files navigation

XWiki-Checkboxed-Task-Macro

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

Additionally there is a a configurable task report macro that lists tasks from a given space: image

Installation

Head over to Releases, download the .xar file, and import it in the Wiki administration section under "Content" -> "Import"

Configure CKEditor

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

config['xwiki-macro'] = config['xwiki-macro'] || {};
config['xwiki-macro'].insertButtons = [
  {
    insertDirectly: false,
    macroCall: {
      name:'checktask',
      inline:'enforce',
    }
  }
];

This adds a clickable icon for quick insertion of a task: image

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published