Include all child pages recipe

Includes the wiki content of all children of a page, headed by the page title and a link to edit the page.

Description

This recipe is handy if you want to have a parent page present an aggregated view of all its children, displayed in full. This recipe includes an 'Edit' link for each section, which will automatically take the page editor to edit the listed page.

Ingredients

Plugins

Linking Plugin, Reporting Plugin, Visibility Plugin

Macros

content-reporter, report-block, report-body, text-sort

Suppliers

Content Supplier

1. We'll be creating a free-flowing list of pages and their contents for this one, so we'll use the report-block report generator:

   {report-block}
   

2. Next, we set up the reporter.
   • Here we just want to list the current page's immediate children, so we'll use the content-reporter.

     {content-reporter:scope=@self > children}
     

   • In this case, we'll sort by title, but you may wish to sort by modification date or by another arbitrary piece of Scaffolding data.

       {text-sort:content:title}
     

3. Close the content-reporter around the sort parameter.

   {content-reporter}
   

4. Next, we set up the report body
   • First, open the report-body macro:

     {report-body}
     

   • Using the report-info macro, we'll list the title in a heading, with the page title as the heading value. We'll also add an 'Edit' link, shown only to users who can edit this space:

     h2. {report-info:content:title|link=true} {show-to:space=@self:edit}_({link-to:page edit}Edit{link-to})_{show-to}
     

   • Next, display the body of the current child page, rendering it as wiki text:

     {report-info:content:body|render=wiki}
     

   • Then, close the report-body.

     {report-body}
     

5. Finally, close the report generator:

   {report-block}
   

6. As an added bonus, display a link to add a new subsection at the bottom of the page. This could also be added at the top, if so desired:

   {show-to:space=@self:edit}
   {add-page:parent=@self}(+) Add a new section{add-page}
   {show-to}
   

Another serving suggestion is to mix in the Scaffolding Plugin (particularly Scaffolding 2.2) to allow the pages to be sorted by a custom data field.

For example, perhaps you would like to be able to set an arbitrary number which the children are sorted by. This can be done using the {set-data}\ macro on each child:

{set-data:Order|type=number}1{set-data}

Then, in your content-reporter block, make it the following:

{content-reporter:scope=@self > children}
  {number-sort:data:Order}
{content-reporter}

This uses the 'data:' prefix, as defined by the Scaffold Data Supplier.