Theme Builder Plugin

[All Adaptavist Apps]

Page tree

Versions Compared

Old Version 7

changes.mady.by.user Unknown User (doobya)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (gwilson)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

{with-page} macro

Description

The {with-page} macro does two things:

...

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.

...

Requirements

This macro requires Builder 3.0 or above.

Usage

Code Block
 {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}

...

unmigrated-wiki-markup
Expand
Display or link to an attachment from an ancestor page
Display or link to an attachment from an ancestor page

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}
{code}

Which results in:

Show image attached to the parent page:
{with-page:direction=up}
 !image.jpg!
{with-page}

Although

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}
{code}

Which results in:

Link to "sample.pdf" attached to the first parent page labeled "topic"
{with-page:direction=up|label=topic}
 [^sample.pdf]
{with-page}

...

Expand
Displaying content in a sidebar specific to the current page's location in the page tree
Displaying content in a sidebar specific to the current page's location in the page tree
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:|Doobya: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}

...