Creating a user macro in Atlassian Confluence to extract a page from a multi-project space and filter the information according to the desired project can be achieved by defining a macro that includes user input fields and programming logic to filter content based on the selected project. Here’s a basic example of how you might approach this task:
Define the User Macro:
Go to Confluence Administration and select User Macros.
Click Create a User Macro and fill out the fields such as Name, Description, and other macro details.
Macro Template:
Write the macro template to include a text field where users can input the desired project name.
Use Confluence’s scripting capabilities to filter and display the content based on the input.
Here is a simple example in the FreeMarker Markup Language (FML):
## Macro name: projectFilterMacro
## Macro title: Project Filter Macro
## Description: Filters content based on project name input
## Macro input:
## - projectName: Text (single-line input), Required, no default.
## @param projectName:title=Project Name|type=string|required=true|desc=Enter the project name to filter content
<ac:structured-macro ac:name="excerpt-include">
<ac:parameter ac:name="nopanel">true</ac:parameter>
<ac:parameter ac:name="context">page</ac:parameter>
<ac:parameter ac:name="excerpt">">
## Filter pages by project name
#set($projectName = $paramprojectName)
#if($projectName)
<ac:structured-macro ac:name="content-report-table">
<ac:parameter ac:name="space">MULTI_PROJECT_SPACE_KEY</ac:parameter>
<ac:parameter ac:name="maxResults">10</ac:parameter>
<ac:parameter ac:name="title">Pages for $projectName</ac:parameter>
<ac:parameter ac:name="cql">
type = page AND label in (project-$projectName) AND space = MULTI_PROJECT_SPACE_KEY
</ac:parameter>
<ac:parameter ac:name="columns">title, created, creator</ac:parameter>
</ac:structured-macro>
#else
<p>Please enter a project name to filter the content.</p>
#end
Usage:
Place the macro on a Confluence page where you want the filtered results to appear.
Users can then input the desired project name, and the macro will display the relevant pages from the specified multi-project space.
This macro uses the content-report-table Confluence macro with a CQL (Confluence Query Language) parameter to filter pages based on the project label. Replace MULTI_PROJECT_SPACE_KEY with your actual Confluence space key.
Notes:
Space Key: Ensure that the space key (MULTI_PROJECT_SPACE_KEY) is correctly specified to target the right multi-project space.
Labeling: Pages should be appropriately labeled (e.g., project-ProjectName) to be filtered effectively.
Additional Customization: You might need to adjust the macro parameters and CQL filters based on your specific requirements and Confluence setup.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.