Space list recipe

Display a list of spaces available in a custom format using the Reporting Plugin.

Ingredients

Plugins

Reporting Plugin

Macros

report-block, report-body, report-info, space-reporter, text-sort

Suppliers

Space Supplier

1. First, we'll start with a report-block:

   {report-block}
   

2. Next, we want to report on spaces:

   {space-reporter}
   

3. Then, we display the space name (linked) and the key using report-info.

   {report-body}
   {report-info:space:name|link=true} ({report-info:space:key})
   {report-body}
   

4. Finally, close the report-block.

   {report-block}
   

Andre Kolodochka (~andre.kolodochka)

Bo Wang [CustomWare] (~bo.wang)

CustomWare (CustomWare)

CustomWare Book - Wiki While You Work (wwyw)

CustomWare Customer Success (SUCCESS)

CustomWare Greenhouse (GREENHOUSE)

CustomWare Plugins for Atlassian (AtlassianPlugins)

David Chui (~david.chui)

David Peterson (~dpeterson)

David Vittor [CustomWare] (~dvittor)

Ellen Feaheny (~ellen.feaheny)

Jennifer Cheung [CustomWare] (~jennifer.cheung)

Knowledgebase - Adobe Flex (FLEX)

Knowledgebase - Atlassian Software (ATLASSIAN)

Knowledgebase - Microsoft SharePoint (SharePoint)

Knowledgebase - Mule ESB (MULE)

Knowledgebase - Oracle Fusion (FUSION)

Knowledgebase - Palm webOS (WebOS)

Knowledgebase - SoftwareAG webMethods (WMFAQ)

Product - DocGen for webMethods (WMDOCGEN)

Product - Unit Testing for webMethods (WMUNIT)

Robert Castaneda (~robert.castaneda)

SandPit (SANDPIT)

Stafford Vaughan (~stafford.vaughan)

Thomas Mitchell [CustomWare] (~thomas.mitchell)

User Group - Malaysian Java User Group (MyJUG)

User Group - Wiki Wednesday (WikiWednesday)

Yuen-Chi Lian (~yuenchi.lian)

Sorting

To sort, we expand the {space-reporter} macro out a bit. So, to sort by title, you would put this:

{space-reporter}
    {text-sort:space:name}
{space-reporter}

To sort by creation date in descending order (newest to oldest), try this:

{space-reporter}
    {date-sort:space:creation date|order=descending}
{space-reporter}

To sort by a custom value, it gets trickier. Firstly, we need to store a custom value somewhere. For simplicity, we'll store it on the space's homepage. Firstly, install the latest version of the Scaffolding 2 Plugin. Then, we add something like this to each space's homepage:

{set-data:space order|type=number|hidden=true}1{set-data}

This will set a number value called 'Space Order' to '1' and won't display it to the general user. Now, we need to specify that we want to sort spaces using it:

{space-reporter}
    {number-sort:space:homepage > data:space order}
{space-reporter}

This uses a 'key chain' to find the Space Order field. First, it uses the Space Supplier to find the home page, then uses the Scaffold Data Supplier to find the 'space order' field, which it then sorts with.