Document Accordion Macro
 | Rendering macro for displaying multiple documents as an accordion |
| Type | JAR |
| Category | |
| Developed by | |
| Active Installs | 15 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
Rendering macro for displaying multiple documents as an accordion
Usage
Select the entries of a AWM application
Select blog posts available on a given space
Parameters definition
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| xclass | yes | a document reference | Limit the selection to documents containing objects instance of this XClass (not mandatory, at least xclass or space mandatory) | |
| space | yes | a document reference | If the xclass parameter is set: limit the selection to this page and its children (The space parameter is used as a filter) If the xclass parameter is not set: the space parameter must be an Application Within Minutes, in this case the macro will display items of that application. | |
| sort | yes | CHRONO, ALPHA | CHRONO | Sort the available documents chronologically or alphabetically. |
| openFirstAccordion | yes | true, flase | true | Show first accordions. |
| displayAuthor | yes | true, flase | true | Display the document author. |
| displayDate | yes | true, false | true | Display the document last modification date. |
| accordionMaxHeight | yes | integer | 0 | The maximum height (in px) that an accordion use to display the document content. To avoid scrollbars use zero for an unlimited height. |
| limit | yes | integer | 100 | Limit the number of accordions that could be displayed. |
Known issues
Screenshots
Screenshots of using the macro in the WYSIWYG editor.
Select the macro on the Wysiwyg
Doc Accordion Macro on the Wysiwyg macro editor
Doc Accordion Macro - More parameters
Doc Accordion Macro results display
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Release Notes
v1.1.3
v1.1.2
v1.1.1
v1.1
v1.0
First version
Dependencies
Dependencies for this extension (org.xwiki.contrib:macro-docaccordion 1.1.3):
- org.xwiki.rendering:xwiki-rendering-api 8.4
- org.xwiki.rendering:xwiki-rendering-transformation-macro 8.4
- org.xwiki.platform:xwiki-platform-query-manager 8.4
- org.xwiki.platform:xwiki-platform-oldcore 8.4
- org.xwiki.platform:xwiki-platform-skin-skinx 8.4
