Changes for page AWMKanbanMacro
Last modified by Ryan C on 2025/07/17 22:45
From 3.1 to 2.1
Show context
Hide context
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -3,17 +3,14 @@ 3 3 Example: 4 4 5 5 ##{{{ 6 -{{awmkanban app="Help.Applications.Movies" category="databaseList1" displayedCategoryColumns="Help.Applications.Contributors.Charlie Chaplin" columns="staticList1,boolean1" xwql="obj.boolean1=0" /}}6 +{{awmkanban app="Help.Applications.Movies" category="databaseList1" columns="staticList1,boolean1" xwql="obj.boolean1=0" /}} 7 7 }}}## 8 8 9 -* ##app or className## - application or className for which to build the kanban board 10 -* ##category## - class field used to group the kanban board into columns 11 -* ##displayedCategoryColumns## - only display these values of the `category` field as columns 12 -* ##xwql## - additional xwql to restrict the query 13 -* ##title## - field to display the title 14 -* ##columns## - the class fields to display as a description in each card 15 -* ##order## - order to sort the data by. Example: 'doc.name desc', 'doc.date desc', 'customClassField1 asc, customClassField2 desc, doc.name desc' or 'customClassField1 asc' if the className object contains such custom fields 16 -* ##limit## - the maximum amount of items to show. If the ##displayedCategoryColumns## parameter is set, the limit is applied for each column. 9 +* ##app or className## application or className for which to build the kanban board 10 +* ##category## field to use to break down the kanban board 11 +* ##xwql## additional xwql to restrict the query 12 +* ##title## field to display the title 13 +* ##columns## additional columns to display 17 17 18 18 Examples: 19 19 ... ... @@ -21,10 +21,6 @@ 21 21 22 22 {{awmkanban app="Help.Applications.Movies" category="databaseList1" columns="staticList1,boolean1"/}} 23 23 24 -== Kanban of Movies showing the director field, only showing a subset of directors== 25 - 26 -{{awmkanban app="Help.Applications.Movies" category="databaseList1" displayedCategoryColumns="Help.Applications.Contributors.Charlie Chaplin" columns="staticList1,boolean1"/}} 27 - 28 28 == Kanban of Movies by genre showing the director field only comedy movies == 29 29 30 30 {{awmkanban app="Help.Applications.Movies" category="databaseList1" columns="staticList1,boolean1" xwql="obj.boolean1=0"/}}
-
XWiki.WikiMacroClass[1]
-
- Macro code
-
... ... @@ -27,19 +27,9 @@ 27 27 ## We don't override the xwql variable in case it was defined externally by another macro calling this one (e.g. TaskManager.KanbanBoardMacro). 28 28 #set($xwql = "") 29 29 #end 30 -#if ($xcontext.macro.params.colors) 31 - #set($colors = $xcontext.macro.params.colors) 32 -#else 33 - ## We set as default the original colors: green,blue,orange,yellow,red 34 - #set($colors = "#8C4,#0AC,#F91,#FC3,#E43") 35 -#end 36 -#set ($displayedCategoryColumns = "$!xcontext.macro.params.displayedCategoryColumns") 37 -#set ($order = "$!xcontext.macro.params.order") 38 -#set ($limit = "$!xcontext.macro.params.limit") 39 - 40 40 #set($width = "$xcontext.macro.params.width") 41 -#set($source = $xwiki.getDocument("Macros.KanbanAWMSource").getURL("get", "xpage=plain&outputSyntax=plain&className=${escapetool.url($className)}&category=${escapetool.url($category)}& displayedCategoryColumns=${escapetool.url($displayedCategoryColumns)}&title=${escapetool.url($title)}&columns=${escapetool.url($columns)}&xwql=${escapetool.url($xwql)}&colors=${escapetool.url($colors)}&order=${escapetool.url($order)}&limit=${escapetool.url($limit)}"))42 -#set($awmupdatepath = "/objects/${className}/0/properties/${category}/") 43 -{{kanban source="${source}" updateService="" addBoardButton="false" addItemButton="false" removeBoardButton="false" addRemoveButton="false" awmupdatepath="${awmupdatepath}" width="${width}" /}}31 +#set($source = $xwiki.getDocument("Macros.KanbanAWMSource").getURL("get", "xpage=plain&outputSyntax=plain&className=${escapetool.url($className)}&category=${escapetool.url($category)}&title=${escapetool.url($title)}&columns=${escapetool.url($columns)}&xwql=${escapetool.url($xwql)}")) 32 +#set($awmupdatepath = "/objects/${className}/0/properties/${category}/") 33 +{{kanban source="${source}" updateService="" addBoardButton="false" addItemButton="false" removeBoardButton="false" removeItemButton="false" awmupdatepath="${awmupdatepath}" width="${width}" /}} 44 44 {{/velocity}} 45 45
-
XWiki.WikiMacroParameterClass[6]
-
- Parameter description
-
... ... @@ -1,1 +1,1 @@ 1 -Order to sort the data by . Example: 'doc.name desc', 'doc.date desc', or 'customClassField1 asc' if the className object contains such a field. Sort by multiple fields: 'customClassField1 asc, customClassField2 desc, doc.name desc'1 +Order to sort the data by
-
XWiki.WikiMacroParameterClass[9]
-
- Parameter description
-
... ... @@ -1,1 +1,1 @@ 1 - The classproperties to displayin each cardescriptions additional data(comma separated values)1 +Columns to use to display additional data
-
XWiki.WikiMacroParameterClass[11]
-
- Parameter name
-
... ... @@ -1,1 +1,0 @@ 1 -colors - Parameter description
-
... ... @@ -1,1 +1,0 @@ 1 -List of colors separated by commas, each color corresponds to a column.
-
XWiki.WikiMacroParameterClass[12]
-
- Parameter name
-
... ... @@ -1,1 +1,0 @@ 1 -displayedCategoryColumns - Parameter description
-
... ... @@ -1,1 +1,0 @@ 1 -Have only these category values as board columns, i.e. for 'ToDo,InProgress' (comma separated values) you will only have 2 kanban columns. Note that these should be values accepted by the specified category property. - Parameter mandatory
-
... ... @@ -1,1 +1,0 @@ 1 -No
-
XWiki.WikiMacroParameterClass[13]
-
- Parameter default value
-
... ... @@ -1,1 +1,0 @@ 1 -50 - Parameter name
-
... ... @@ -1,1 +1,0 @@ 1 -limit - Parameter description
-
... ... @@ -1,1 +1,0 @@ 1 -Set the maximum amount of items to show. If the displayedCategoryColumns parameter is set, the limit is applied for each column. - Parameter mandatory
-
... ... @@ -1,1 +1,0 @@ 1 -No