All macros configurations

Last modified by Adina Milica on 2024/06/20 14:52

Manage
- Copy
Actions
Viewers
- Source
- Children
- Attachments (73)
- History
- Information
- Likes

A look into all XS macro configs

Note: The initial list contained some macros that are made only for xwiki.org. These are:

ajax (initially #2), backwardCompatibilityReport134 (6), backwardCompatiblityReport (7), backwardCompatiblityReportXml (8), browser (18), check (21), codePres (24), contributors (29), database (31), displayChanges (34), faq (40), getChanges (43), imagePres (50), language (54), latestBlogPosts (55), pdftoc (69), plantuml (71), poweredBy (73), productVersions (74), releasenotechanges (77), remotecode (78), scm (79), showhide (81), spaceindex (82), spaces (83), todo (88), version (95), videoCard (96), workspaces (101)

The following ones are XS macros or popular installable macros:

Macros & their field problems

How should one interpret the table below:

In the left side, you can see how the macro modal config looks like, what its fields are, descriptions etc.
In the right side, you can see the name of the macro, the link to its documentation and the fields in order with the respective categorization.

For some I've added other problems that I identified (bad labels, different field category needed, bad descriptions, necessary link to doc, etc.), but all rules from here should be considered when revamping any of the configurations.

Id	How the config looks
activity (legacy) this deprecated version's documentation the new application's documentation (Notifications) if it's deprecated, it shouldn't be available at all or, at least, shouldn't be available easily to the user In order: Entries: number field Wikis: multi choice field Spaces: multi choice field + page reference field Authors: multi choice field Tags: multi choice field Minor: bad label + checkbox field RSS: bad label + checkbox field
async documentation opens blank but you can write in it In order: didn't show it, but it should have content field (another time, it did show it) - wiki syntax field Async: bad label+ checkbox field Cached: bad label + checkbox field Context: code field + advaced usage field Id override: code field / simple text field + advanced usage field
attachmentGalleryPicker documentation In order: Filter: multi choice field + requires link to docs Id: code field/simple text field + requires link to docs Limit: number field Target: technichal terminology + page reference field
attachmentSelector documentation In order: Classname: should be a page reference field Property: singular choice from a limited list + bad label/technical terminology Object: I have no idea what this is, the documentation doesn't give an example for the usage of this field + bad label CssClass: CSS code field + the documentations doesn't give an example for how to use it Savemode: singular choice from 2 options, both can be explained under 1-2 lines + technical terminology/bad label Buttontext: simple text input + should have a placeholder with the default value DefautlValue: file reference field + technical terminology/bad label Filter: multi choice field + bad label DisplayImage: checkbox field + bad label Width: measurement field Height: measurement field Alternate text: simple text field Link: checkbox field + bad label Targetdocname: page reference field Version summary: checkbox field
blogpostcreate documentation can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do In order: Blog: Singular choice / page reference field Content: wiki syntax field
blogPostLayoutCards documentation should be under a common blog post layout macro in which the user can select the layout can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do In order: Reference: page reference field / singular choice + bad label Content: wiki syntax field Params: technical terminology/bad label + seems to be multi-choice field
blogPostLayoutCompact documentation should be under a common blog post layout macro in which the user can select the layout can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do In order: Reference: page reference field / singular choice + bad label Content: wiki syntax field Params: technical terminology/bad label + seems to be multi choice field
blogPostLayoutFull documentation should be under a common blog post layout macro in which the user can select the layout can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do In order: Reference: page refference field / singular choice + bad label Content: wiki syntax field Params: technical terminology/bad label + seems to be multi-choice field
blogPostLayoutImage documentation should be under a common blog post layout macro in which the user can select the layout can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do In order: Reference: page refference field / singular choice + bad label Content: wiki syntax field Params: technical terminology/bad label + seems to be multi choice field
blogPostLayoutLink documentation should be under a common blog post layout macro in which the user can select the layout can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do In order: Reference: page reference field / singular choice field + bad label Content: wiki syntax field Params: technical terminology/bad label + seems to be multi choice field
blogpostlist documentation can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do In order: Blog: singular choice field Category: singular choice field, but it depends if the person want a category or a category space, it's a bit weird From date: date field To date: date field Published: singular choice Hidden: singular choice Limit: number field Layout: should be a singular chhoice field that lets the user select from the available layouts Layoutparams: technical terminology + multi choice field Paginated: should be a checkbox field
blogs documentation can be found only by installing blog application, but it doesn't get recommended for installing in quick actions like other macros do
box documentation opens in blank In order: CssClass: css code field Image: file reference field Title: simple text field Width: measurement field Content: wiki syntax field
cache documentation opens in blank, but you can write in it In order: Content: wiki syntax field Id: wiki syntax field + advanced field + link to documentation MaxEntries: number field TimeToLive: measurement field
chart documentation Type: singular choice field + bad label Content: wiki syntax field Height: measurement field Params: technical terminology + multi choice field + link to docs Source: advanced field + singular choice field Title: simple text field Width: measurement field Revamp inspiration: link
children documentation
code documentation In order: Language: singular choice field Content: wiki sintax field CssClass: css code field Image: file reference field + alternative way of referencing Layout: singular choice field Title: simple text field Width: measurement field Source: code field (for script) + page reference field (for pages)
comment documentation opens blank In order: Content: wiki syntax field
container documentation open blank In order: CSS Class: css code field Justify: checkbox field + bad label Layout style: singular choice field Content: wiki syntax field Revamp inspiration: link
content documentation opens blank In order: syntax: singular choice field Source: code field (for scripts)
context documentation open blank, but you can write in it, makes sense In order: Page: page reference field Restricted: checkbox field + bad label Transformation context: singular choice (it's already a dropdown, but it's not consistent visually with other dropdowns) Content: wiki syntax field Source: code field
dashboard documentation opens blank In order: Layout: bad label + singular choice field Source: bad label + page reference field Style: both a singular choice and a CSS code field (could be split in 2 seperate fields) Revamp inspiration: link
diagram documentation In order: Reference: page reference field (the default tree location should be in diagram) Cached: checkbox field + bad label
display documentation In order: page: page reference field Exclude First Heading: checkbox field + bad label Section: section reference field Revamp inspiration: link
displayIcon documentation In order: Name: should be transformed in Choose icon, singular choice field with previews of icons and their name besides, searchable Icon set: singular choice from a limited list + maybe should be before the Choose icon field, as you choose the icon from a certain icon right? Fallback: bad label + checkbox field Revamp inspiration: link
documents or pages documentation ?? In order: Count: number field + bad label Actions: checkbox field + bad Label + probably should be included in the columns field and not be standalone Space: bad label + incorrect terminology + singular choice field (wikis are a limited list) Id: bad label + should be a singular choice from a limited list of available liveTables Parent: page reference field Columns: multi choice field + columns should have their pretty name Location: page reference field	Seems to work like pages, so I'll add pages here:
documentTree documentation In order: Read only: checkbox field + bad label Show wikis: checkbox field + bad field Show wiki prety name: checkbox field Show spaces: checkbox field Show page title: checkbox field Show translations: checkbox field Show attachements: checkbox field Show Objects: checkbox field Show class propertis: checkbox field Page Hierarhy Mode: singular choice field Root: bad label + page reference field Compact: bad label + checkbox field Links: bad label + checkbox field Checkboxes: checkbox field Open to: page reference field Filter Hidden Documents: bad label + checkbox field Limit: bad label + number field Exclusions: multi choice field + page reference fields
error documentation In order: CssClass: css code field Image: file reference field + Alternative to referencing/selecting file (upload) Title: simple text field Width: measuremnt field Content: wiki syntax field
example documentation ????
footnote documentation bugged In order: Content: wiki syntax field
gallery documentation In order: Content: wiki syntax field CssClass: css code field Height: measurement field Width: measurement field
groovy documentation opens blank In order: Content: wiki syntax field Jars: multi choice field + file reference field with filtering around only searching thorugh .jar files Output: checkbox field + bad label Wiki: bad label + checkbox field
html documentation opens blank In order: Content: wiki syntax field Clean: checkbox field Wiki: checkbox field + bad label
html5video documentation Url: simple text field + paste clipboard icon Width: measurement field Height: measurement field Attachment: bad label + this fields should be merged with Url under a common label of Source where there are given multiple options of entering the video through a link or as a file reference field VideoPoster: bad label (should be video thumbnail) + file reference field Dash: page reference field seems Reference: ?? then what is Attachement Ratio: singular choice field	Added the Video macro, not sure if the same
iconPicker documentation opens in blank In order: Id: bad description (it should be " ID based on which other HTML components can refer to this picker and use it") + simple text field Class: css code field or singular choice field Prefix: simple text field + specify default in placeholder name
id documentation Name: simple text field
image kind of a documentation	doesn't have a config
include documentation In order: Page: page reference field Author: singular choice field (the arrow is not consistent) Exclude First heading: checkbox field Section: section reference field
info documentation In order: CssClass: css code field Image: file reference field + Alternative to referencing/selecting file (upload) Title: simple text field Width: measuremnt field Content: wiki syntax field
jira documentation In order: Content: wiki syntax field URL: bad lebel + simple text field Fields: probably a multi choice field Id: simple text field maxCount: bad label + placeholder should specify default value Parameters: multi choice field? Source: singular choice field Style: singular choice field
liveData documentation In order: Filters: should use the livedata Filter UI existing in the view/editing mode of the page (not in the config) Id: singular choice field from a limited list of available livetables + bad label + should allow creating a new dynamic data type (AWM) from this UI layouts: singular choice field Limit: number field Offset: technical terminology + number field Page sizes: this can stay like this, numbers delimited with columns Properties: bad label (should be column) + multi choice field Show page size drop-down: checkbox field Sort: should use the livedata Sort UI existing in the view/editing mode of the page (not in the config) Source parameters: code field Content: bad label + code field
mention documentation	no need for config
menu documentation opens blank but you can write in it, a bit weird In order: Type: singular choice field Id: code field/simple text field + bad description + link to doc Label: simple text field
messageSender documentation opens blank In order: Visibility: singular choice field Visibility parameters: bad label + user reference field + for groups: simgular choice dropdown + bad description Visibility options: bad label + bad description + singular choice dropdown
missingLicenseMessage documentation ??? In order: Extension name: link in description+ simple text field
notifications documentation In order: Count: number field Use the references of the user: checkbox field Display own events: checkbox field Display minor events: checkbox field Display system events: checkbox field Display read events: checkbox field Display "read" status: checkbox field Wikis: multi choice field Spaces: multi-choice field Pages: multi-choice field + page reference field Users: multi choice field + user reference field Display followed user only: checkbox field Display RSS link: checkbox field Tags: multi-choice field
notificationsApplicationsPreferences ---------------------- continue linking docs documentation In order: Target: singular chocie field User: user reference field
notificationsAutoWatchPreferences documentation In order: Target: singular chocie field User: user reference field
notificationsCustomFiltersPreferences documentation In order: User: user reference field Target: singular chocie field
notificationsEmailPreferences documentation In order: User: user reference field Target: singular chocie field
notificationsFiltersPreferences documentation (deprecated) In order: User: user reference field
notificationsSystemFiltersPreferences documentation In order: User: user reference field Target: singular chocie field
office documentation should just show a uplod or select office file, no need to put that in the configuration In order: Filter styles: checkbox field Reference: bad label + file reference (it's already kind of done, just needs to be consistent)
pdfviewer documentation In order: File: file reference field Height: measurement field Width: measurement field Delegate my view right: should be checkbox field Document: file reference field
pollsrecent documentation doesn't appear in quick actions as recommended for install like other extensions, cannot be found Limit: number field
putFootnotes documentation opens in blank if it doens't find any footnotes
python documentation In order: Content: wiki syntax field Jars: multi choice field + file reference field with filtering around only searching thorugh .jar files Output: checkbox field + bad label Wiki: bad label + checkbox field
script documentation opens in blank In order: Content: wiki syntax field Jars: multi choice field + file reference field with filtering around only searching thorugh .jar files Language: singular choice field Output: checkbox field + bad label Wiki: bad label + checkbox field
success documentation In order: CssClass: css code field Image: file reference field Title: simple text field Width: measuremnt field Content: wiki syntax field
tagcloud documentation Space: singular choice field Spaces: multi choice field Limit: number field
template documentation opens blank should just be a button to choose a template, no need to have this in the config Name: bad label + singular choice field Ouput: bad label + checkbox field
toc documentation if no headings are present, opens blank Depth: bad label + number field Reference: bad label + page reference field Scope: singular choice field Start: bad leble + number field Numbered: bad label + checkbox
translation documentation Content: wiki syntax Key: bad label (has to stay consistent with the technical term of translation key) + singular choice field if possible _ link to docs Locale: bad label + should be two separate field: language & country, both singular choice field Parameters: based on the translation key, should be dynamically allocated a number of sub-fields, simple text fields
tree documentation not only it opens blank, but you cannot double click it (bugged?) Reference: bad bad label + page reference field + really bad description Root: I think it's a page reference field Drag and drop: bad label + checkbox field Context menu: bad label + checkbox field Class: css code field Icons: bad label + checkbox field Edges: bad label + checkbox field Links: bad label + checkbox field Checkboxes: bad label + checkbox field Open to: code field? or page reference field Finder: bad label + checkbox Show root: checkbox field Limit: number field Exclusions: multi choice field + page reference field Content: wiki syntax field
uiextension documentation doesn't need a modal config, could just render a button "Insert UI extension", clicking it would open a list with all UI extension available (is this list that big?) Identifier: singular choice field
uiextensions documentation doesn't need a modal config, could just render a button "Insert UI extension", clicking it would open a list with all UI extension available (is this list that big?) Extension Point: singular choice field
useravatar documentation In order: Username: user reference field (seems to be already, but can be improved) Height: measurement field Width: measurement field
velocity documentation opens blank In order: Content: code field Filter: singular choice field Jars: file reference field + page reference field Output: bad label + checkbox field Wiki: bad label + checkbox field
warning documentation In order: CssClass: css code field Image: file reference field Title: simple text field Width: measuremnt field Content: wiki syntax field
wikimacrocontent documentation opens blank doesn't work, you can't type in it in editable mode (bug?)
wikimacroparameter documentation can't find the right documentation In order: Name: Content
wikis documentation