Page History

 found.  

h3. Retrieving a page

Pages can be retrieved based on:

- a specific *page name*,
- page *hierarchy* (parent/child relationships),
- page *labels*, and
- *metadata* _keys_ or _key:value_ pairs which the pages must have.

The macro searches for pages based on these properties in the current space by default, or in any number of spaces which can be specified in the macro parameters.

If more than one search criterion is specified (e.g. labels and metadata), then only pages meeting _all_ the selection criteria will be returned and listed by the macro (boolean AND relationship between the search terms).

Finally, if no page is found satisfying the selected parameters, a default page can be specified to be listed by the macro instead.

h3. Rendering in the context of the page that was found

The \{with-page} macro then renders the wiki markup in the macro body as if the markup were in the body of the page that was found.

Within the body of the macro, the following variables are replaced by the contents given in the following table:

|| Variable || Replacement ||
| %withceoid% | the id of the page |
| %withceotitle% | the title of the page |
| %withceoname% | the title of the page |
| %withpageid% | the id of the page |
| %withpagetitle% | the title of the page |
| %withpagename% | the title of the page |

h2. Requirements

This macro requires [Theme Builder 2.0|Documentation] or above.

h2. Usage

{code}
 {with-page:direction=ancestors|startPage=My Page|space=DOC|title=Page 1,Page 2|label=test,label2|metadata=key1,key2:value1,key2:value2|default=Default Page} 
{code}

Let's start with a simple example: rendering an image attached to the parent page, into the body of the current page.

Code Block
Show image attached to the parent page

: {with-page:direction=up}

!image.jpg! {with-page

}

Although image.jpg is attached to the parent page, it is rendered in this page. The body of the macro is the same syntax as if it were written in the parent page.

Similarly, any attachment to any parent page can be rendered or linked to the current page. Since the page can be found by labels and metadata, the specific page name is not required. For instance:

Code Block
Link to "sample.pdf" attached to the first parent page labeled "topic": {with-page:direction=

up|label=topic}

[^sample.pdf] {with-page

}

Wiki Markup

Suppose there is a page somewhere in the current tree (not necessarily a direct parent, child or sibling) which has attachments we want to use in the current page. We can combine \{with-page} macros, first searching up the tree, then within that macro search down the tree again, looking for the page. Finally, we provide markup making use of the attachments found. {code} Find page labeled 'sponsors' in the current

page tree,

knowing

it

is a

child

of

a parent page with the

label 'homepage', then render the images attached to the page labeled 'sponsors' in a gallery on the current page: {with-page:direction=

up|

label=homepage}

{with-page:direction=down|

label=sponsors} {gallery} {with-page}

{

with-page

} {code} Which results in:

Find

page

labeled 'sponsors' in the

current page tree, knowing it is a child of a parent page with the label 'homepage', then render the images attached to the page labeled 'sponsors' in a gallery on the current page {with-page:direction=up|label=homepage} {with-page:direction=down|label=

sponsors} {gallery} {

with-page}

{with-page}

Wiki Markup
If you are using a page to include in a sidebar on all pages in a space, you can use

the \{with-page} macro

to

show

content in

the

sidebar

depending

on the location of the

current page. For instance, if you have a Forum set up (using the Bubbles plugin) you can show information in the sidebar relevant to the forum, only on forum pages. In this example, we will display a list of child pages to the Forum page, labeled 'sticky': {code} Forum-specific

content

for the sidebar {with-page:direction=

up|startPage=

@self|

title=Forum}

This will only appear when you're in the

%withpagetitle% section of the space

. {

list-

descendants:

startPage=

@self|

label=

sticky} {with-ancestor}

{code} Which results in: Forum-specific content for the sidebar {with-page:direction=

up|startPage=

@self|

title=

Forum} This will only appear when you're in the %withpagetitle% section of the space. {list-descendants:startPage=@self|label=sticky} {with-ancestor}