History: PluginKanban
Preview of version: 13
The Kanban feature doesn't work in Tiki24 and we are hard at work to get it ready for Tiki25. It will not be backported to Tiki24 because we need to make some not-easy-to-backport changes.
TODOs from Benoit G:
- Support other enumerable fields, most importantly item links. If not, it may not be that usable for users.
- General filtering, and specifying default values for new cards (so they are included in the filter...). Discussed with Jonny, surprisingly annoying to implement cleanly syntaxically. Without this the feature would be unusable for more advanced use cases (no way to restrict by project for example). This is the only remaining thing that will change the user facing syntax (additions only most probably however).
Plugin Kanban
Will be introduced in Tiki25. Use this wiki plugin to move tracker items with drag & drop capabilities in Trello-like boards.
If setting up manually:
It requires following preference settings to work:
- API access enabled (Security > API access),
- Always Load Vue.js (Features > Interface > Always Load Vue.js),
- Enable Vue.js (Features > Interface > Enable Vue.js)
Search for "vuejs". Tiki search wont find "vue" or "vue.js".
Alternatively using profiles:
On fresh installs of Tiki >= 25.x you will be able to use
https://profiles.tiki.org/Kanban_Board via the Wizard, click to apply any profile but click 25.x as version then enter "Kanban" in the search field of the profiles management page. Then apply the profile and visit https://example.org/tiki-index.php?page=Kanban-Board.
Table of contents
Parameters
Introduced in Tiki 25. Required parameters are in
bold.Go to the source code
Preferences required: wikiplugin_kanban
| Parameters | Accepted Values | Description | Default | Since |
|---|---|---|---|---|
order |
word | Sort order for cards within a cell. Must be a numeric field. You will have to create it if the board represents an existing tracker. It is not meant to be displayed to the user, or represent something global like "priority" (that would make no sense on a partial representation). It merely means that the card is displayed above any card with lower value, and below any card with a higher one if displayed in the same cell. When a card is moved board will halve the value of the two surrounding cards to compute the new value. | 25.0 | |
title |
word | Tracker field containing the inline editable text shown on each card. | 25.0 | |
column |
word | Tracker field representing the columns, usually a dropdown list with options such as "Wishes", "Work" and "Done". | 25.0 | |
boardTrackerId |
int | Id of the tracker the board is a partial representation of | 24.0 | |
description |
word | Optional text shown below the title on each card. | 25.0 | |
swimlane |
word | Tracker field representing the "rows" or "swimlanes" of the board. Can be any field with discrete values. Usually represents a client, a project, or a team member. By default, all tracker items with that field set to a valid values will be shown on the board. To allow empty values, see swimlaneValues. Note: A kanban board can have multiple rows, but these rows aren't independent, they share the same possible States and Wip limits. If what you want is completely independent "rows", create two boards on the same tracker, with different filters. | 25.0 | |
columnValues |
text separator: : |
For the tracker field mapped in "column", defines for each column the value a tracker item must have for that field, as well as the label displayed as the column header and the WiP limit for that column. Implicitely defines the number of columns and in which order they are shown; You can skip values so they are not part of the board (and you typically do, if only to eventually archive done cards). The parameter is and array of colon separated values, each containing a coma separated arguments configuring the column. In order, the configuration represent the: 1) Mandatory. The value the mapped field must have in the tracker item for the card to be shown in the matching column. 2) Optional. If present and not "null", the text to be displayed as the column header instead of the normal tracker field label for the value above. (For example "Done" instead of "Closed") 3) Optional. If present and not "null", the WiP (Work in Progress) limit for the cards in the column. In "null", there is no limit for the number of cards in the column. Typically you will use null for the first and last column. null or nothing between the comas means the parameter is not set. Necessary since the arguments are positional. So for example: someValue,someAlternateTextToDisplay,null:someOtherValue,,4 Means the board would have two colums, the first column would be titled "someAlternateTextToDisplay" containing cards with the value "someValue" for the mapped field and no limit to the number of cards. The second column would have cards with "someOtherValue" for the mapped field, with whatever the label is for that value in the field definition, and the column would be highlighted red if there is more than 4 cards. No card with any other value would be anywhere on the board. To allow empty values, include a field with an empty value (ex: someValue:someOtherValue:,Unsorted cards) If the whole parameter is absent (not recommended), all possible field values will be used to generate columns (except the empty value). | 25.0 | |
swimlaneValues |
text separator: : |
Similar to columnValues, except there is no WiP limit. To allow empty values, include a field with an empty value (ex: someValue:someOtherValue:,Unsorted cards). An aditional swimlane will be included for empty values. If the parameter is present but only contains the empty value (ex: ,Unsorted cards), all possible field values will be used to generate swimlanes, and an aditional swimlane will be included for empty values. | 25.0 |
Examples
Example 1
This code:
Copy to clipboard
{kanban trackerId="8" title="Kanban Board for doc.t.o issues" description="Item Description" xaxis="f_113" yaxis="f_118" swimlane="f_117"}
Would produce on this site:
User error
Tracker not specified in param "boardTrackerId".
Related pages
Aliases
Related