This issue has been created
There are 2 updates.
 
 
XWiki Platform / cid:jira-generated-image-avatar-3f5b4dc3-a95a-49c1-bb3d-ac18108693ba XWIKI-25023 Open

Filter the XClass picker by category, using a category: prefix in its search field

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-7e594c48-5b65-4010-a1af-f12f77facaa7 Manuel Leduc created this issue on 18/Sep/26 15:01
 
Summary: Filter the XClass picker by category, using a category: prefix in its search field
Issue Type: cid:jira-generated-image-avatar-53daa093-475c-4473-8540-147780779eb1 New Feature
Assignee: Unassigned
Components: Web - Templates & Resources, XClass
Created: 18/Sep/26 15:01
Priority: cid:jira-generated-image-static-major-97543320-ef3a-4d5d-9ed5-0833ac706007 Major
Reporter: Manuel Leduc
Description:

Context

The XClass picker (the classPicker Velocity macro of macros.vm) lists every XClass the current user can view, with nothing to distinguish a business XClass (a Meeting or a Recipe, created through AWM or by hand) from a purely technical one (rights, comments, and the like). This is already noise in the object and class editors, and it becomes a real obstacle as soon as the picker is offered to non-technical users -- for instance in a macro that lets them pick an XClass, choose the properties to display, and get a Live Data out of it (XWIKI-24831).

This is option 5.2 of the proposal http://forum.xwiki.org/t/improve-the-listing-of-xclass-in-the-xclass-picker/18766/7

Categories on XClasses

Give XClasses a set of categories, following the conventions already used for macro categories:

  • an XClass can carry several categories (e.g. Development and Internal), not a single flag
  • two categories are special, internal and deprecated, and are hidden from non-advanced users
  • an XClass carrying neither is considered non-technical, so existing XClasses stay visible by default

Filtering in the picker

The filtering happens in the picker's existing search field, through a category: prefix, rather than through a second filtering field -- the picker is a compact dropdown and should stay one:

  • category:photography returns every XClass in the photography category
  • meetings category:projectmanagement returns every XClass whose name contains meetings and that belongs to the projectmanagement category

Left to decide

  • how a category is stored: an XObject added to the XClass page, or a BaseClass meta-property (options 2.1 and 2.2 of the proposal)
  • which categories to set on the XClasses currently shipped by XWiki, and the migration this implies
 
 

2 updates

 
cid:jira-generated-image-avatar-7e594c48-5b65-4010-a1af-f12f77facaa7 Changes by Manuel Leduc on 18/Sep/26 15:02
 
Issue Type: New Feature Improvement
Description: h2. Context

The XClass picker (the {{classPicker}} Velocity macro of {{macros.vm}}) lists every XClass the current user can view, with nothing to distinguish a business XClass (a Meeting or a Recipe, created through AWM or by hand) from a purely technical one (rights, comments, and the like). This is already noise in the object and class editors, and it becomes a real obstacle as soon as the picker is offered to non-technical users
\ -- for instance in a macro that lets them pick an XClass, choose the properties to display, and get a Live Data out of it (XWIKI-24831).

This is option 5.2 of the proposal
http https ://forum.xwiki.org/t/improve-the-listing-of-xclass-in-the-xclass-picker/18766/7

h2. Categories on XClasses

Give XClasses a set of categories, following the conventions already used for macro categories:

* an XClass can carry several categories (e.g. {{Development}} and {{Internal}}), not a single flag
* two categories are special, {{internal}} and {{deprecated}}, and are hidden from non-advanced users
* an XClass carrying neither is considered non-technical, so existing XClasses stay visible by default

h2. Filtering in the picker

The filtering happens in the picker's existing search field, through a {{category:}} prefix, rather than through a second filtering field
\ -- the picker is a compact dropdown and should stay one:

* {{category:photography}} returns every XClass in the {{photography}} category
* {{meetings category:projectmanagement}} returns every XClass whose name contains {{meetings}} and that belongs to the {{projectmanagement}} category

h2. Left to decide

* how a category is stored: an XObject added to the XClass page, or a {{BaseClass}} meta-property (options 2.1 and 2.2 of the proposal)
* which categories to set on the XClasses currently shipped by XWiki, and the migration this implies