From Let's Grow Mushrooms

PmWiki: IncludeOtherPages

The (:include:) directive makes it possible to insert (or "transclude") the contents of other pages into the current wiki page. All of the include directives below perform a straight text inclusion. In particular, any page links in the included text are assumed to link to pages in the current group if not otherwise qualified.

Syntax

The basic syntax is

• (:include PageName:)

• {Group/PageName$:PTVar}

The full syntax is

• (:include
  FullName#fromanchor#toanchor lines=12..34 self=0 basepage=abc variable=value :)

Parameters

The directive can have multiple Name parameters with or without anchors, and multiple template variable parameters.

Named pages

You can use the above feature to display an error message if an include fails. Create a page, eg. Site.IncludeFailed containing the error message. You can use any page name. Then, in your include markup, append this page at the end of the page list:

 (:include Page1 Page2 Page3 Site.IncludeFailed:)

A slightly more complex approach is outlined at the talk page.

#From#To anchors

Lines=from..to

Self=

Page text variables

Basepage=

If basepage= is provided all relative links and page variables are interpreted relative to basepage.
So, if one creates TemplateName as

Name: {$:Name}
Address: {$:Address}

then the directive

will retrieve the contents of TemplateName, treating any page variables and links as being relative to PageName.
In particular, the values for {$:Name} and {$:Address} will be taken from PageName, but things like {$Title} and {$LastModifiedBy} would also work here.

Basepage usage

The primary purpose of basepage is to allow the include of pages in a way that mimics the 2.1.x behavior where page variables
and links are interpreted relative to the currently displayed page.
This is done with:

  -or-

It also allows GroupHeader and GroupFooter to have their page variables and links be relative to the currently displayed page
(instead of GroupHeader and GroupFooter):

  ## PmWiki default $GroupHeaderFmt setting
  $GroupHeaderFmt = 
    '(:include {$Group}.GroupHeader self=0 basepage={*$FullName}:)(:nl:)';

Otherwise, using IncludeOtherPages inside of a GroupHeader would display 'GroupHeader' and not the name of the currently displayed page.

The basepage= parameter is general enough that it can also be used as a templating engine, so that
we can grab a template page containing variables that are then filled in with values from another page:

And, of course, a single TemplatePage can actually contain multiple templates delimited by anchors, so that we end up with a syntax eerily similar^[1] to pagelist-templates:

    (:include TemplatePage#abc basepage=DataPage :)

So then TemplatePage can use a syntax like:

    
    [[#abc]]
    ...template stuff here...
    [[#abcend]]

and it's possible to display TemplatePage as a template without it being interpreted... same as we do for Site.PageListTemplates.

Specifying variables as parameters

You can also specify variable values inline with the include statement, and refer to the variables in the template using the {$$variable1} format:

This assumes that a site has $EnableRelativePageVars enabled, which is recommended in PmWiki 2.2.0 -- but was disabled by default in version 2.2.8 and earlier.

For example, on my included page ("template") I might have this:

[[#ivars]]
Hi, {$$Name}, how are you today?
[[#ivarsend]]

Then, including that section above (that section is available via the section {$FullName}#ivars)) you get this type of behavior:

(:include {$FullName}#ivars Name=Sam:)

If a value contains spaces, quote it:

(:include {$FullName}#ivars Name="my
friend":)

See also $EnableUndefinedTemplateVars.

Specific markup

(:nl:) acts like a new line in the markup, only if there isn't one already.

The purpose of (:nl:) is to be able to write things like "(:include Page1:)(:nl:)(:include Page2:)" which guarantees that the first line of Page2 is treated as a separate line from the last line of Page1, but without inadvertently generating a blank line between them.

See this thread and this thread for more info.

(:nl:) is not intended to put a newline character in the output!

See Also

• Page text variables Page variables automatically made available through natural or explicit page markup
• Cookbook:IncludeUrl

Styling Note

By default, Included pages or lines cannot be distinguished from other text on the page. To provide a visual indication that this text is special, you can apply Wiki Styles. For example:

%define=leftborder border-left="2px solid #88f" margin-left="2px"
padding="1px 0 3px 10px"%
What is PmWiki?
>>leftborder<< (:include PmWiki.PmWiki lines=1..4:) 
>><<
''Have a very nice day!''

Parameter References

Any parameters supplied to an include statement (whether they are keywords or not) are accessible inside the included page as a special {$$...} variable of the same name. This feature can be used to provide extra information to use when displaying the included page.

Notes

• You can also say (:include My/Page#myanchor lines=4:) which starts from, and includes, the line with the anchor [[#myanchor]] for four lines.

Notes about use with conditional markup

The (:include ...:) markup is processed after conditional markup is evaluated.
Therefor you can include a page or page section as part of a condition, like

But (:include SomePage#section:) doesn't look to see if [[#section]] is part of a conditional, like

(:include SomePage#section:) will ignore such a condition.

When testing variables in included pages the context of the page (source or target) can be useful.
See special references for details.