Include Plugin

• Download the Plugin

It is recommended to delete all cache files in <dokuwiki>/data/cache directly after upgrading the plugin

This is a handy plugin with which you can include another wiki page into the current one.

Simply enclose the ID of the page to be included in double curly brackets:

{{page>[id]#[section]&[flags]}}
{{section>[id]#[section]&[flags]}}
{{namespace>[namespace]&[flags]}}

The plugin offers three syntaxes, {{page>...}} and {{section>...}} and {{namespace>...}}.

Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces¹⁾.

The plugin can be configured in the DokuWiki configuration manager available in the admin menu. These settings also affect the blog plugin which uses the include plugin to generate the blog page.

Simple macros are possible to serve a page on a per user or per date base. These are:

Examples:

{{page>@MONTH@:@DAY@:birthdays}}
{{page>@USER@:message}}

You may use flags to override default all configuration settings:

Example:

{{page>concept&firstseconly&footer}}

You can try the plugin here.

Please report bugs or feature requests at the Bug tracker.

• Git Repository
• Bug Tracker

• please kill me
• another attempt to fix the metadata issue
• sort pages in namespace mode
• release preparations
• minor corrections for ns syntax and range detection
• hopefully fixed caching related ACL issues
• fixed namespace includsion
• hopefully fixed all ACL dependant caching issues

The include plugin sometimes behaves strangely: The including page does not reflect the changes on the included page (unless you edit and save the including page). This is because what is displayed is the cached version of the including page. DokuWiki believes that nothing was changed, and so it does not refresh the cache.

Below are some include test, to pages in the same namespace, and other namespaces.

I wonder if this is the intended behaviour, or its just happening for some users.

• Attach ~~NOCACHE~~ to the Including Page.
• Append ?purge=1 to the Including Page URL and load the page - then edit the Included Page and change something.

None of the above worked for me: I cannot include pages from other namespaces.

ALL FINE WITH THIS METHOD!

• Including Page on root namespace.
• Included Page in same namespace: includetest (Included pagename has no spaces..):

Link syntax to Included Page contains no spaces (since the pagename also does not):

{{page>includetest}}

page_includetest

THIS METHOD DOES NOT UPDATE CORRECTLY THE INCLUDING PAGE!

• Including Page on root namespace.
• Included Page in same namespace: included test page (Included pagename has spaces):

Link syntax to Included Page contains spaces (which were not replaced by _):

{{page>included test page}}

page_included_test_page

ALL FINE WITH THIS METHOD!

• Including Page on root namespace.
• Included Page in same namespace: included test page 2 (Included pagename has spaces):

Link syntax to Included Page contains no spaces (and all are replaced by _):

{{page>included_test_page_2}}

page_included_test_page_2

THIS METHOD DOES NOT UPDATE CORRECTLY THE INCLUDING PAGE!

THIS METHOD DOES NOT EVEN DISPLAY A LINK TO THE INCLUDING PAGE!!!

• Including Page not on root namespace: E.g., playground.
• Included Page in same namespace: includetest (Included pagename has no spaces..):
• Included Page is referred by its absolute path (from root), and not its relative path (just its name, in this case)

Link syntax to Included Page contains no spaces (since the pagename also does not):

{{page>:playground:includetest}}

includetest

THIS METHOD DOES NOT UPDATE CORRECTLY THE INCLUDING PAGE!

THIS METHOD DOES NOT EVEN DISPLAY A LINK TO THE INCLUDING PAGE!!!

• Including Page not on root namespace: E.g., playground.
• Included Page in same namespace: included test page 2 (Included pagename has spaces):
• Included Page is referred by its absolute path (from root), and not its relative path (just its name, in this case)

Link syntax to Included Page contains no spaces (and all are replaced by _):

{{page>:playground:included_test_page_2}}

included_test_page_2

THIS METHOD DOES NOT UPDATE CORRECTLY THE INCLUDING PAGE!

• Including Page not on root namespace: E.g., playground.
• Included Page in other namespace: includetest (Included pagename has no spaces..):

Link syntax to Included Page contains no spaces (since the pagename also does not):

{{page>:wiki:includetest}}

includetest

THIS METHOD DOES NOT UPDATE CORRECTLY THE INCLUDING PAGE!

• Including Page not on root namespace: E.g., playground.
• Included Page in other namespace: included test page 2 (Included pagename has spaces):
• Relative path to Included Page (..:)

Link syntax to Included Page contains spaces (not replaced by _):

{{page>:playground:included test page}}

included_test_page

THIS METHOD DOES NOT UPDATE CORRECTLY THE INCLUDING PAGE!

• Including Page not on root namespace: E.g., playground.
• Included Page in other namespace: included test page 2 (Included pagename has spaces):
• Relative path to Included Page (..:)

Link syntax to Included Page contains no spaces (all are replaced by _):

{{page>..:wiki:included_test_page_2}}

included_test_page_2

For the tested installations it was not possible to include pages on different namespaces.

Tested installations: * DokuWiki “rc2009-12-02 Mulled Wine” with several other plugins installed, Apache, PHP

• Both on a home Ubuntu 9.10 server, and on a commercial site5 server.

Is this the intended behaviour?

Can we include pages from other namespaces?

• If not, can someone change the plugin so that it does? This is a very important and fundamental plugin, it should not give limitations like this ;)

In response to all the above, I am able to include a page from another namespace in my wiki. I have ~~NOCACHE~~ in the included page and used '&purge=true' to get the receiving page to load correctly. My included page has underscores, as does my link syntax. This is a Xampplite server running on windows and browsing with Firefox portable. — andrew - 2010-02-05