plugin:include [DokuWiki]

<!DOCTYPE html> <html lang="en" dir="ltr" class="no-js"> <head> <meta charset="utf-8" /> <title>plugin:include [DokuWiki]</title> <meta name="generator" content="DokuWiki"/> <meta name="theme-color" content="#008800"/> <meta name="robots" content="index,follow"/> <meta name="keywords" content="plugin,include"/> <link rel="search" type="application/opensearchdescription+xml" href="/lib/exe/opensearch.php" title="DokuWiki"/> <link rel="start" href="/"/> <link rel="contents" href="/plugin:include?do=index" title="Sitemap"/> <link rel="manifest" href="/lib/exe/manifest.php"/> <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/feed.php"/> <link rel="alternate" type="application/rss+xml" title="Current namespace" href="/feed.php?mode=list&ns=plugin"/> <link rel="edit" title="Edit this page" href="/plugin:include?do=edit"/> <link rel="alternate" type="text/html" title="Plain HTML" href="/_export/xhtml/plugin:include"/> <link rel="alternate" type="text/plain" title="Wiki Markup" href="/_export/raw/plugin:include"/> <link rel="canonical" href="https://www.dokuwiki.org/plugin:include"/> <link rel="stylesheet" href="/lib/exe/css.php?t=dokuwiki&tseed=f1005bad3d81fc9c803c7f93d32a390e"/> <script >var NS='plugin';var JSINFO = {"plugins":{"edittable":{"default columnwidth":""}},"id":"plugin:include","namespace":"plugin","ACT":"show","useHeadingNavigation":0,"useHeadingContent":0};(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement);</script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.4/jquery.min.js" defer="defer"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min.js" defer="defer"></script> <script src="/lib/exe/js.php?t=dokuwiki&tseed=f1005bad3d81fc9c803c7f93d32a390e&lang=en" defer="defer"></script> <meta name="viewport" content="width=device-width,initial-scale=1" /> <link rel="shortcut icon" href="/lib/tpl/dokuwiki/images/favicon.ico" /> <link rel="apple-touch-icon" href="/lib/tpl/dokuwiki/images/apple-touch-icon.png" /> <meta name="verify-v1" content="OVxl3gsCv2MhZqh1cBQyl0JytWXSwXMjyvwc+4w3WtA=" /> <meta name="google-site-verification" content="YhTVK69hW94ZXUtc2zSLPxTkZKbZIn0zK67mz5WQB-E" />  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-83791-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-83791-1', { 'anonymize_ip': true }); </script> </head> <body> <div id="dokuwiki__site"><div id="dokuwiki__top" class="site dokuwiki mode_show tpl_dokuwiki showSidebar hasSidebar">  <header id="dokuwiki__header"><div class="pad group"> <div class="headings group"> <ul class="a11y skip"> <li><a href="#dokuwiki__content">skip to content</a></li> </ul> <h1 class="logo"><a href="/start" accesskey="h" title="Home [h]"><img src="/lib/tpl/dokuwiki/images/logo.png" width="64" height="64" alt="" /><span>DokuWiki</span></a></h1> <p class="claim">It's better when it's simple</p> </div> <div class="tools group">  <div id="dokuwiki__usertools"> <h3 class="a11y">User Tools</h3> <ul> <li class="action login"><a href="/plugin:include?do=login&sectok=" title="Log In" rel="nofollow"><span>Log In</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10 17.25V14H3v-4h7V6.75L15.25 12 10 17.25M8 2h9a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2v-4h2v4h9V4H8v4H6V4a2 2 0 0 1 2-2z"/></svg></a></li> </ul> </div>  <div id="dokuwiki__sitetools"> <h3 class="a11y">Site Tools</h3> <form action="/start" method="get" role="search" class="search doku_form" id="dw__search" accept-charset="utf-8"><input type="hidden" name="do" value="search" /><input type="hidden" name="id" value="plugin:include" /><div class="no"><input name="q" type="text" class="edit" title="[F]" accesskey="f" placeholder="Search" autocomplete="on" id="qsearch__in" value="" /><button value="1" type="submit" title="Search">Search</button><div id="qsearch__out" class="ajax_qsearch JSpopup"></div></div></form> <div class="mobileTools"> <form action="/doku.php" method="get" accept-charset="utf-8"><div class="no"><input type="hidden" name="id" value="plugin:include" /><select name="do" class="edit quickselect" title="Tools"><option value="">Tools</option><optgroup label="Page Tools"><option value="edit">Edit this page</option><option value="revisions">Old revisions</option><option value="backlink">Backlinks</option></optgroup><optgroup label="Site Tools"><option value="recent">Recent Changes</option><option value="media">Media Manager</option><option value="index">Sitemap</option></optgroup><optgroup label="User Tools"><option value="login">Log In</option></optgroup></select><button type="submit">></button></div></form> </div> <ul> <li class="action recent"><a href="/plugin:include?do=recent" title="Recent Changes [r]" rel="nofollow" accesskey="r">Recent Changes</a></li><li class="action media"><a href="/plugin:include?do=media&ns=plugin" title="Media Manager" rel="nofollow">Media Manager</a></li><li class="action index"><a href="/plugin:include?do=index" title="Sitemap [x]" rel="nofollow" accesskey="x">Sitemap</a></li> </ul> </div> </div>  <div class="breadcrumbs"> <div class="trace"><span class="bchead">Trace:</span> <span class="bcsep">•</span> <span class="curid"><bdi><a href="/plugin:include" class="breadcrumbs" title="plugin:include">include</a></bdi></span></div> </div> <hr class="a11y" /> </div></header> <div class="wrapper group">  <nav id="dokuwiki__aside" aria-label="Sidebar"><div class="pad aside include group"> <h3 class="toggle">Sidebar</h3> <div class="content"><div class="group"> <p> <strong>Learn about DokuWiki</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/features" class="wikilink1" title="features" data-wiki-id="features">Features</a> & <a href="/blogroll" class="wikilink1" title="blogroll" data-wiki-id="blogroll">reviews</a> </div> </li> <li class="level1"><div class="li"> <a href="/install" class="wikilink1" title="install" data-wiki-id="install">Installation guide</a></div> </li> <li class="level1"><div class="li"> <a href="/manual" class="wikilink1" title="manual" data-wiki-id="manual">User manual</a> & <a href="/wiki:syntax" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">syntax</a></div> </li> <li class="level1"><div class="li"> <a href="/changes" class="wikilink1" title="changes" data-wiki-id="changes">Release notes</a></div> </li> <li class="level1"><div class="li"> <a href="/faq" class="wikilink1" title="faq" data-wiki-id="faq">FAQ</a></div> </li> </ul> <p> <strong>Advanced Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/extensions" class="wikilink1" title="extensions" data-wiki-id="extensions">Extensions</a></div> </li> <li class="level1"><div class="li"> <a href="/development" class="wikilink1" title="development" data-wiki-id="development">Development manual</a></div> </li> </ul> <p> <strong>Corporate Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/faq:support" class="wikilink1" title="faq:support" data-wiki-id="faq:support">Get support</a></div> </li> <li class="level1"><div class="li"> <a href="/donate" class="wikilink1" title="donate" data-wiki-id="donate">Donations</a></div> </li> </ul> <p> <strong>Our Community</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/teams:getting_involved" class="wikilink1" title="teams:getting_involved" data-wiki-id="teams:getting_involved">Get involved</a></div> </li> <li class="level1"><div class="li"> <a href="/dokuinstall" class="wikilink1" title="dokuinstall" data-wiki-id="dokuinstall">Users</a></div> </li> <li class="level1"><div class="li"> <a href="http://forum.dokuwiki.org" class="urlextern" title="http://forum.dokuwiki.org">User forum</a></div> </li> <li class="level1"><div class="li"> <a href="/mailinglist" class="wikilink1" title="mailinglist" data-wiki-id="mailinglist">Development mailinglist</a></div> </li> </ul> <hr /> <p> Follow us on <a href="https://phpc.social/@dokuwiki" class="urlextern" title="https://phpc.social/@dokuwiki">Mastodon</a> and other <a href="/social" class="wikilink1" title="social" data-wiki-id="social">social networks</a>. </p> <p> <a href="/privacy" class="wikilink1" title="privacy" data-wiki-id="privacy">Our Privacy Policy</a> </p> </div></div> </div></nav>  <main id="dokuwiki__content"><div class="pad group"> <div class="pageId"><span>plugin:include</span></div> <div class="page group">   <div id="dw__toc" class="dw__toc"> <h3 class="toggle">Table of Contents</h3> <div> <ul class="toc"> <li class="level1"><div class="li"><a href="#include_plugin">Include Plugin</a></div> <ul class="toc"> <li class="level2"><div class="li"><a href="#installation">Installation</a></div></li> <li class="level2"><div class="li"><a href="#examples">Examples</a></div></li> <li class="level2"><div class="li"><a href="#syntax">Syntax</a></div></li> <li class="level2"><div class="li"><a href="#configuration_and_flags">Configuration and Flags</a></div></li> <li class="level2"><div class="li"><a href="#macros">Macros</a></div></li> <li class="level2"><div class="li"><a href="#demo">Demo</a></div></li> <li class="level2"><div class="li"><a href="#development">Development</a></div></li> <li class="level2"><div class="li"><a href="#faq">FAQ</a></div> <ul class="toc"> <li class="level3"><div class="li"><a href="#the_include_plugin_breaks_the_wrap_and_folded_and_similar_plugins_when_used_inside_them">The include plugin breaks the wrap and folded (and similar) plugins when used inside them</a></div></li> <li class="level3"><div class="li"><a href="#is_it_possible_to_include_the_same_page_twice">Is it possible to include the same page twice?</a></div></li> <li class="level3"><div class="li"><a href="#does_the_include_plugin_respect_acls_of_the_included_pages">Does the include plugin respect ACLs of the included pages?</a></div></li> <li class="level3"><div class="li"><a href="#why_does_the_include_plugin_first_close_the_previous_section_and_opens_it_again_afterwards">Why does the include plugin first close the previous section and opens it again afterwards?</a></div></li> <li class="level3"><div class="li"><a href="#has_the_include_plugin_feature_xyz_when_will_you_implement_xyz">Has the include plugin feature XYZ/when will you implement XYZ?</a></div></li> <li class="level3"><div class="li"><a href="#how_to_avoid_inclusion_of_whole_page_content_if_section_does_not_exist">How to avoid inclusion of whole page content if section does not exist?</a></div></li> </ul> </li> <li class="level2"><div class="li"><a href="#discussion">Discussion</a></div> <ul class="toc"> <li class="level3"><div class="li"><a href="#discussions_in_dw-forum">Discussions in DW-forum</a></div></li> <li class="level3"><div class="li"><a href="#user_comments">User comments</a></div></li> <li class="level3"><div class="li"><a href="#showlink_vs_link_flag">showlink vs link flag</a></div></li> <li class="level3"><div class="li"><a href="#controlling_header_size_in_included_pages">Controlling header size in included pages</a></div></li> <li class="level3"><div class="li"><a href="#including_a_paragraph_or_excerpt_from_a_page">Including a paragraph or excerpt from a page</a></div></li> <li class="level3"><div class="li"><a href="#angua">2012-01-25 "Angua"</a></div></li> <li class="level3"><div class="li"><a href="#include_from_same_page">Include from same page?</a></div></li> <li class="level3"><div class="li"><a href="#align_feature">Align Feature</a></div></li> <li class="level3"><div class="li"><a href="#exclude_feature">Exclude Feature</a></div></li> <li class="level3"><div class="li"><a href="#empty_section">Empty Section</a></div></li> <li class="level3"><div class="li"><a href="#no_other_data">No Other data</a></div></li> <li class="level3"><div class="li"><a href="#namespace_lists_using_linkonly_and_beforeeach_aftereach">Namespace lists using &linkonly and &beforeeach/&aftereach</a></div></li> <li class="level3"><div class="li"><a href="#option_to_pass_revision_of_main_page_to_includes_pages">Option to pass revision of main page to includes pages</a></div></li> <li class="level3"><div class="li"><a href="#translations">Translations</a></div></li> <li class="level3"><div class="li"><a href="#display_search_results_on_a_page">Display search results on a page?</a></div></li> <li class="level3"><div class="li"><a href="#passing_parameters_arguments">Passing parameters/arguments</a></div></li> </ul></li> </ul></li> </ul> </div> </div>  <h1 class="sectionedit1" id="include_plugin">Include Plugin</h1> <div class="level1"> <div class="pluginrepo_entry"><div class="usageInfo"><div class="compatibility"><p class="label">Compatible with DokuWiki</p><div class="versions"><ul><li class="yes">2024-02-06 "Kaos" <strong><span>yes</span></strong></li><li class="yes">2023-04-04 "Jack Jackrum" <strong><span>yes</span></strong></li><li class="yes">2022-07-31 "Igor" <strong><span>yes</span></strong></li><li class="yes">2020-07-29 "Hogfather" <strong><span>yes</span></strong></li></ul></div></div><ul class="actions"><li><a class="download" href="https://github.com/dokufreaks/plugin-include/tarball/master">Download</a></li><li><a class="bugs" href="https://github.com/dokufreaks/plugin-include/issues">Report bugs</a></li></ul><div class="clearer"></div></div><div class="mainInfo"><p class="description"><a class="media" href="/plugins"><img alt="plugin" class="medialeft" src="/lib/plugins/pluginrepo/images/dwplugin.png" width="60" height="60" /></a> Include another wiki page into the current one</p></div><div class="metaInfo"><dl><dt>Last updated on</dt><dd>2023-09-22</dd><dt>Provides</dt><dd><a href="/plugins?plugintype=1#extension__table" class="wikilink1" title="List all Syntax plugins">Syntax</a>, <a href="/plugins?plugintype=16#extension__table" class="wikilink1" title="List all Helper plugins">Helper</a></dd><dt>Repository</dt><dd><a class="urlextern" href="https://github.com/dokufreaks/plugin-include/">Source</a></dd><dt>Conflicts with</dt><dd><a href="/plugin:combo" class="wikilink1" title="plugin:combo" data-wiki-id="plugin:combo">combo</a>, <a href="/plugin:datepicker" class="wikilink1" title="plugin:datepicker" data-wiki-id="plugin:datepicker">datepicker</a>, <a href="/plugin:editsections2" class="wikilink1" title="plugin:editsections2" data-wiki-id="plugin:editsections2">editsections2</a>, <a href="/plugin:header2" class="wikilink1" title="plugin:header2" data-wiki-id="plugin:header2">header2</a>, <a href="/plugin:header3" class="wikilink1" title="plugin:header3" data-wiki-id="plugin:header3">header3</a>, <a href="/plugin:mediasyntax" class="wikilink1" title="plugin:mediasyntax" data-wiki-id="plugin:mediasyntax">mediasyntax</a>, <a href="/plugin:multiselect" class="wikilink1" title="plugin:multiselect" data-wiki-id="plugin:multiselect">multiselect</a>, <a href="/plugin:numberedheadings" class="wikilink1" title="plugin:numberedheadings" data-wiki-id="plugin:numberedheadings">numberedheadings</a>, <a href="/plugin:outliner" class="wikilink1" title="plugin:outliner" data-wiki-id="plugin:outliner">outliner</a>, <a href="/plugin:photogallery" class="wikilink1" title="plugin:photogallery" data-wiki-id="plugin:photogallery">photogallery</a>, <a href="/plugin:rowmove" class="wikilink1" title="plugin:rowmove" data-wiki-id="plugin:rowmove">rowmove</a>, <a href="/plugin:wideredit" class="wikilink1" title="plugin:wideredit" data-wiki-id="plugin:wideredit">wideredit</a></dd></dl></div><div class="moreInfo"><p class="similar">Similar to <a href="/plugin:composer" class="wikilink1" title="plugin:composer" data-wiki-id="plugin:composer">composer</a>, <a href="/plugin:displaywikipage" class="wikilink1" title="plugin:displaywikipage" data-wiki-id="plugin:displaywikipage">displaywikipage</a>, <a href="/plugin:docincluder" class="wikilink1" title="plugin:docincluder" data-wiki-id="plugin:docincluder">docincluder</a>, <a href="/plugin:dwinsect" class="wikilink1" title="plugin:dwinsect" data-wiki-id="plugin:dwinsect">dwinsect</a>, <a href="/plugin:dwspecialist" class="wikilink1" title="plugin:dwspecialist" data-wiki-id="plugin:dwspecialist">dwspecialist</a>, <a href="/plugin:dyncontent" class="wikilink1" title="plugin:dyncontent" data-wiki-id="plugin:dyncontent">dyncontent</a>, <a href="/plugin:embed" class="wikilink1" title="plugin:embed" data-wiki-id="plugin:embed">embed</a>, <a href="/plugin:includeuserpage" class="wikilink1" title="plugin:includeuserpage" data-wiki-id="plugin:includeuserpage">includeuserpage</a>, <a href="/plugin:pagebox" class="wikilink1" title="plugin:pagebox" data-wiki-id="plugin:pagebox">pagebox</a>, <a href="/plugin:tabinclude" class="wikilink1" title="plugin:tabinclude" data-wiki-id="plugin:tabinclude">tabinclude</a>, <a href="/plugin:templater" class="wikilink1" title="plugin:templater" data-wiki-id="plugin:templater">templater</a>, <a href="/plugin:tplinc" class="wikilink1" title="plugin:tplinc" data-wiki-id="plugin:tplinc">tplinc</a>, <a href="/plugin:wst" class="wikilink1" title="plugin:wst" data-wiki-id="plugin:wst">wst</a></p><p class="tags">Tagged with <a href="/plugins?plugintag=embed#extension__table" class="wikilink1" title="List all plugins with this tag">embed</a>, <a href="/plugins?plugintag=include#extension__table" class="wikilink1" title="List all plugins with this tag">include</a></p><p class="needed">Needed for <a href="/plugin:blog" class="wikilink1" title="plugin:blog" data-wiki-id="plugin:blog">blog</a>, <a href="/plugin:crosspost" class="wikilink1" title="plugin:crosspost" data-wiki-id="plugin:crosspost">crosspost</a>, <a href="/plugin:editor" class="wikilink1" title="plugin:editor" data-wiki-id="plugin:editor">editor</a>, <a href="/plugin:multinamespace" class="wikilink1" title="plugin:multinamespace" data-wiki-id="plugin:multinamespace">multinamespace</a>, <a href="/plugin:randominc" class="wikilink1" title="plugin:randominc" data-wiki-id="plugin:randominc">randominc</a>, <a href="/plugin:tiledblog" class="wikilink1" title="plugin:tiledblog" data-wiki-id="plugin:tiledblog">tiledblog</a></p></div><div class="authorInfo"><strong>By <a href="mailto:freaks%20%5Bat%5D%20dokuwiki%20%5Bdot%5D%20org" class="mail" title="freaks [at] dokuwiki [dot] org">Dokufreaks (previous authors: Michael Hamann, Gina Häußge, Michael Klier, Esther Brunner)</a></strong><ul><li><a href="/plugin:tag" class="wikilink1" title="plugin:tag" data-wiki-id="plugin:tag">tag</a></li> <li><a href="/plugin:cloud" class="wikilink1" title="plugin:cloud" data-wiki-id="plugin:cloud">cloud</a></li> <li><a href="/plugin:folded" class="wikilink1" title="plugin:folded" data-wiki-id="plugin:folded">folded</a></li> <li><a href="/plugin:task" class="wikilink1" title="plugin:task" data-wiki-id="plugin:task">task</a></li> <li><a href="/plugin:linkback" class="wikilink1" title="plugin:linkback" data-wiki-id="plugin:linkback">linkback</a></li> <li><a href="/plugin:keyboard" class="wikilink1" title="plugin:keyboard" data-wiki-id="plugin:keyboard">keyboard</a></li> <li><a href="/plugin:var" class="wikilink1" title="plugin:var" data-wiki-id="plugin:var">var</a></li> <li><a href="/plugin:poll" class="wikilink1" title="plugin:poll" data-wiki-id="plugin:poll">poll</a></li> <li><a href="/plugin:feed" class="wikilink1" title="plugin:feed" data-wiki-id="plugin:feed">feed</a></li> <li><a href="/plugin:charter" class="wikilink1" title="plugin:charter" data-wiki-id="plugin:charter">charter</a></li> <li>and 13 more</li></ul></div></div> <p> <img src="/lib/images/smileys/exclaim.svg" class="icon smiley" alt=":!:" /> The 2018-11-29 release fixes a security issue where ACLs were ignored for pages in namespace includes with DokuWiki version Greebo. If you rely on <abbr title="Access Control List">ACL</abbr> checks in namespace includes or allow edits from users who must not see all pages, please upgrade <abbr title="As soon as possible">ASAP</abbr>! <img src="/lib/images/smileys/exclaim.svg" class="icon smiley" alt=":!:" /> </p> <p> This is a handy plugin with which you can include another wiki page into the current one. Just including certain sections of a page or even whole namespaces is supported, too. </p> </div> <div class="secedit editbutton_section editbutton_1"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Include Plugin] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="include_plugin" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1-1131" /><button type="submit" title="Include Plugin">Edit</button></div></form></div> <h2 class="sectionedit2" id="installation">Installation</h2> <div class="level2"> <p> Search and install the plugin using the <a href="/plugin:extension" class="wikilink1" title="plugin:extension" data-wiki-id="plugin:extension">Extension Manager</a>. Refer to <a href="/plugins" class="wikilink1" title="plugins" data-wiki-id="plugins">Plugins</a> on how to install plugins manually. </p> <p> If you need support for older version of DokuWiki you can try the <a href="https://github.com/downloads/dokufreaks/plugin-include/plugin-include-2009-11-27.tgz" class="urlextern" title="https://github.com/downloads/dokufreaks/plugin-include/plugin-include-2009-11-27.tgz">2009-11-27</a> version of the include plugin, but please note that this old version has known bugs. If you need support for older versions of DokuWiki in the current include plugin version please open a feature request in the <a href="https://github.com/dokufreaks/plugin-include/issues" class="urlextern" title="https://github.com/dokufreaks/plugin-include/issues">issue tracker</a>. </p> </div> <div class="secedit editbutton_section editbutton_2"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Installation] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="installation" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1132-1745" /><button type="submit" title="Installation">Edit</button></div></form></div> <h2 class="sectionedit3" id="examples">Examples</h2> <div class="level2"> <p> <code>{{page>wiki:syntax#Tables}}</code> will include the section about tables of the syntax page. </p> <p> <code>{{namespace>project_foo}}</code> will include all pages in the <code>project_foo</code> namespace. </p> <p> <code>{{page>blog:mypage&tags&comments}}</code> will include the page <code>blog:mypage</code> and show the tags from the <a href="/plugin:tag" class="wikilink1" title="plugin:tag" data-wiki-id="plugin:tag">tag</a> plugin and the number of comments from the <a href="/plugin:discussion" class="wikilink1" title="plugin:discussion" data-wiki-id="plugin:discussion">discussion</a> plugin. Both plugins need to be installed for this example. </p> <p> <code>{{tagtopic>testtag}}</code> will include all pages with the tag <code>testtag</code>, the <a href="/plugin:tag" class="wikilink1" title="plugin:tag" data-wiki-id="plugin:tag">tag</a> plugin needs to be installed for this example. </p> </div> <div class="secedit editbutton_section editbutton_3"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Examples] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="examples" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1746-2327" /><button type="submit" title="Examples">Edit</button></div></form></div> <h2 class="sectionedit4" id="syntax">Syntax</h2> <div class="level2"> <p> The plugin offers four syntaxes, <code>{{page>...}}</code> , <code>{{section>...}}</code> , <code>{{namespace>...}}</code> and <code>{{tagtopic>...}}</code>. </p> <p> Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces. Tagtopic includes all pages with a <code>tagtopic</code> <code>tag</code>. </p> <pre class="code">{{page>[id]&[flags]}} {{section>[id]#[section]&[flags]}} {{namespace>[namespace]#[section]&[flags]}} {{tagtopic>[tag]&[flags]}}</pre> <div class="table sectionedit5"><table class="inline"> <tr class="row0"> <th class="col0"> [id] </th><td class="col1"> page ID of the page to include; some <a href="#macros" title="plugin:include ↵" class="wikilink1">macros</a> are possible; shortcuts are resolved (<code>:</code>, <code>.</code>, <code>..</code>) </td><td class="col2"> required </td> </tr> <tr class="row1"> <th class="col0"> [section] </th><td class="col1"> limits the included page to a specific section and its subsections </td><td class="col2"> optional; default is the whole page , this can be used with namespace (if matches)</td> </tr> <tr class="row2"> <th class="col0"> [tag]</th><td class="col1">include pages with tag topic tag, requires <a href="/plugin:tag" class="wikilink1" title="plugin:tag" data-wiki-id="plugin:tag">tag</a> </td><td class="col2">required </td> </tr> <tr class="row3"> <th class="col0"> [flags] </th><td class="col1"> flags delimited by <code>&</code>, see <a href="#configuration_and_flags" title="plugin:include ↵" class="wikilink1">flags</a> </td><td class="col2"> optional </td> </tr> </table></div> <div class="secedit editbutton_table editbutton_5"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Table] " /><input type="hidden" name="target" value="table" /><input type="hidden" name="hid" value="table" /><input type="hidden" name="range" value="2802-3267" /><button type="submit" title="Table">Edit</button></div></form></div> </div> <div class="secedit editbutton_section editbutton_4"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Syntax] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="syntax" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="2328-3269" /><button type="submit" title="Syntax">Edit</button></div></form></div> <h2 class="sectionedit6" id="configuration_and_flags">Configuration and Flags</h2> <div class="level2"> <p> The plugin can be configured in the DokuWiki configuration manager available in the admin menu. These settings also affect the <a href="/plugin:blog" class="wikilink1" title="plugin:blog" data-wiki-id="plugin:blog">blog</a> plugin which uses the include plugin to generate the blog page. For most settings there are flags that allow to override the setting. Some features are only available as flag. </p> <div class="table sectionedit7"><table class="inline"> <thead> <tr class="row0"> <th class="col0 leftalign"> Configuration option </th><th class="col1 leftalign"> Flags </th><th class="col2 leftalign"> Description </th> </tr> </thead> <tr class="row1"> <th class="col0 leftalign"> <code>noheader</code> </th><td class="col1 leftalign"> <code>noheader</code>/ (<code>show</code>)<code>header</code> </td><td class="col2 leftalign"> Don't display the header of the inserted section </td> </tr> <tr class="row2"> <th class="col0 leftalign"> <code>firstseconly</code> </th><td class="col1 leftalign"> <code>firstsec</code>(<code>tion</code>)<code>only</code>/ <code>fullpage</code> </td><td class="col2 leftalign"> Display only the first section of the included page </td> </tr> <tr class="row3"> <th class="col0 leftalign"> <code>readmore</code> </th><td class="col1 leftalign"> <code>readmore</code>/<code>noreadmore</code> </td><td class="col2 leftalign"> Show “read more” link in case of firstsection only </td> </tr> <tr class="row4"> <th class="col0 leftalign"> <code>showtaglogos</code> </th><td class="col1 leftalign"> - </td><td class="col2 leftalign"> Show/hide an image for the first tag (if the page has tags) </td> </tr> <tr class="row5"> <th class="col0 leftalign"> <code>showfooter</code> </th><td class="col1 leftalign"> <code>footer</code>/<code>nofooter</code> </td><td class="col2 leftalign"> Show/hide page footer below the included page </td> </tr> <tr class="row6"> <th class="col0 leftalign"> <code>showlink</code> </th><td class="col1 leftalign"> <code>link</code>/<code>nolink</code> </td><td class="col2 leftalign"> Makes the first headline of a included page/section a link to the included page/section </td> </tr> <tr class="row7"> <th class="col0 leftalign"> <code>showpermalink</code> </th><td class="col1 leftalign"> <code>permalink</code>/ <code>nopermalink</code> </td><td class="col2 leftalign"> Show/hide a permalink to the included page in the page footer </td> </tr> <tr class="row8"> <th class="col0 leftalign"> <code>showdate</code> </th><td class="col1 leftalign"> <code>date</code>/<code>nodate</code> </td><td class="col2 leftalign"> Show/hide creation date of the page in the page footer </td> </tr> <tr class="row9"> <th class="col0 leftalign"> <code>showmdate</code> </th><td class="col1 leftalign"> <code>mdate</code>/<code>nomdate</code> </td><td class="col2 leftalign"> Show/hide modification date of the page in the page footer </td> </tr> <tr class="row10"> <th class="col0 leftalign"> <code>showuser</code> </th><td class="col1 leftalign"> <code>user</code>/<code>nouser</code> </td><td class="col2 leftalign"> Show/hide user name of the page creator in the page footer </td> </tr> <tr class="row11"> <th class="col0 leftalign"> <code>showcomments</code> </th><td class="col1 leftalign"> <code>comments</code>/<code>nocomments</code> </td><td class="col2 leftalign"> Show/hide number of comments in the page footer (requires the <a href="/plugin:discussion" class="wikilink1" title="plugin:discussion" data-wiki-id="plugin:discussion">discussion</a> plugin) </td> </tr> <tr class="row12"> <th class="col0 leftalign"> <code>showlinkbacks</code> </th><td class="col1 leftalign"> <code>linkbacks</code>/<code>nolinkbacks</code> </td><td class="col2 leftalign"> Show/hide number of linkbacks in the page footer (requires the <a href="/plugin:linkback" class="wikilink1" title="plugin:linkback" data-wiki-id="plugin:linkback">linkback</a> or <a href="/plugin:backlinks" class="wikilink1" title="plugin:backlinks" data-wiki-id="plugin:backlinks">backlinks</a> plugin) </td> </tr> <tr class="row13"> <th class="col0 leftalign"> <code>showtags</code> </th><td class="col1 leftalign"> <code>tags</code>/<code>notags</code> </td><td class="col2 leftalign"> Show/hide tags in the page footer (requires the <a href="/plugin:tag" class="wikilink1" title="plugin:tag" data-wiki-id="plugin:tag">tag</a> plugin) </td> </tr> <tr class="row14"> <th class="col0 leftalign"> <code>showeditbtn</code> </th><td class="col1 leftalign"> <code>editbtn</code> or <code>editbutton</code>/<code>noeditbtn</code> or <code>noeditbutton</code> </td><td class="col2 leftalign"> Show/hide edit buttons (section edit buttons, edit button below the included page) </td> </tr> <tr class="row15"> <th class="col0 leftalign"> <code>doredirect</code> </th><td class="col1 leftalign"> <code>redirect</code>/<code>noredirect</code> </td><td class="col2 leftalign"> Redirect back to original page after an edit </td> </tr> <tr class="row16"> <th class="col0 leftalign"> <code>usernamespace</code> </th><td class="col1 leftalign"> - </td><td class="col2 leftalign"> Namespace for user pages (see <code>showuser</code> configuration) (default <code>user</code>) </td> </tr> <tr class="row17"> <th class="col0 leftalign"> <code>doindent</code> </th><td class="col1 leftalign"> <code>indent</code>/<code>noindent</code> </td><td class="col2 leftalign"> Indent included pages relative to the section of the page they get included in </td> </tr> <tr class="row18"> <th class="col0 leftalign"> <code>linkonly</code> </th><td class="col1 leftalign"> <code>linkonly</code>/<code>nolinkonly</code> or <code>include_content</code> </td><td class="col2 leftalign"> Display only a link instead of the whole page content </td> </tr> <tr class="row19"> <th class="col0 leftalign"> <code> title</code> </th><td class="col1 leftalign"> <code>title</code>/<code>notitle</code> </td><td class="col2 leftalign"> Show the title instead of the page id </td> </tr> <tr class="row20"> <th class="col0 leftalign"> <code>pageexists</code> </th><td class="col1 leftalign"> <code>pageexists</code>/ <code>nopageexists</code> </td><td class="col2 leftalign"> Only list page ids of existing pages (see <code>existlink</code>) </td> </tr> <tr class="row21"> <th class="col0 leftalign"> - </th><td class="col1 leftalign"> <code>existlink</code> </td><td class="col2 leftalign"> Display a link and do so only if page page-id exists (combination of <code>linkonly</code> and <code>pageexists</code>) </td> </tr> <tr class="row22"> <th class="col0 leftalign"> <code>parlink</code> </th><td class="col1 leftalign"> <code>parlink</code>/<code>noparlink</code> </td><td class="col2 leftalign"> (Don't) put the link into a paragraph environment (for inline lists) </td> </tr> <tr class="row23"> <th class="col0 leftalign"> <code>order</code> </th><td class="col1 leftalign"> <code>order=OPTION</code> </td><td class="col2 leftalign"> Ordering criteria for namespace includes, possible options: page ID (<code>id</code>), title (<code>title</code>), date created (<code>created</code>), date modified (<code>modified</code>), <a href="/plugin:indexmenu#metadata_tag_syntax" class="wikilink1" title="plugin:indexmenu" data-wiki-id="plugin:indexmenu">indexmenu sort order</a> (<code>indexmenu</code>), custom sort order using the <code>{{include_n>[number]}}</code> on the pages that are included similar to the indexmenu tags (<code>custom</code>). </td> </tr> <tr class="row24"> <th class="col0 leftalign"> <code>rsort</code> </th><td class="col1 leftalign"> <code>rsort</code>/<code>sort</code> </td><td class="col2 leftalign"> Reverse the sort order in namespace includes. </td> </tr> <tr class="row25"> <th class="col0 leftalign"> <code>depth</code> </th><td class="col1 leftalign"> <code>depth=DEPTH</code> </td><td class="col2 leftalign"> The maximum depth of subnamespaces of which pages are included in namespace includes, default is <code>1</code> for only the specified namespace, <code>0</code> is for unlimited depth. </td> </tr> <tr class="row26"> <th class="col0 leftalign"> - </th><td class="col1 leftalign"> <code>inline</code> </td><td class="col2 leftalign"> Don't close/open sections when including a page. This flag should be used when the include syntax is used inside other syntax elements like lists or tables or inside other plugin syntax. </td> </tr> <tr class="row27"> <th class="col0 leftalign"> - </th><td class="col1 leftalign"> <code>beforeeach=ENTITY</code>/ <code>aftereach=ENTITY</code> </td><td class="col2 leftalign"> Display an <a href="/entities" class="wikilink1" title="entities" data-wiki-id="entities">entity</a> before/after each included page. The entity is printed outside the section/include environment, this is mainly for adding custom <abbr title="HyperText Markup Language">HTML</abbr> code (when the text isn't recognized as entity it is directly displayed but escaped so you can't directly use <abbr title="HyperText Markup Language">HTML</abbr> code here). </td> </tr> <tr class="row28"> <th class="col0 leftalign"> <code>safeindex</code> </th><td class="col1 leftalign"> - </td><td class="col2 leftalign"> Don't index metadata of included pages that are non-public. This can cause problems with other plugins that use the metadata index and can be safely disabled in wikis where the permissions of the included pages match the permissions of the parent pages. </td> </tr> <tr class="row29"> <th class="col0 leftalign"> - </th><td class="col1 leftalign"> <code>exclude=/REGEX/</code> </td><td class="col2 leftalign"> Regular expression to exclude certain pages, will match on full page ID. E.g. to exclude <code>ns:page_name</code> use <code>/ns:page_name/</code> as value. Use a <a href="https://regex101.com/" class="urlextern" title="https://regex101.com/">regex tester</a> to debug complicated patterns. </td> </tr> </table></div> <div class="secedit editbutton_table editbutton_7"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Table] " /><input type="hidden" name="target" value="table" /><input type="hidden" name="hid" value="table1" /><input type="hidden" name="range" value="3627-17545" /><button type="submit" title="Table">Edit</button></div></form></div> <p> Examples: </p> <pre class="code">{{page>concept&firstseconly&footer}} {{page>mypage&noindent}} {{namespace>myns&order=modified}} {{namespace>myns&exclude=/myns:subns:.+|myns:page/}}</pre> </div> <div class="secedit editbutton_section editbutton_6"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Configuration and Flags] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="configuration_and_flags" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="3270-17717" /><button type="submit" title="Configuration and Flags">Edit</button></div></form></div> <h2 class="sectionedit8" id="macros">Macros</h2> <div class="level2"> <p> Simple macros are possible to serve a page on a per user or per date base. These are: </p> <div class="table sectionedit9"><table class="inline"> <tr class="row0"> <th class="col0 leftalign"> @USER@ </th><td class="col1"> username </td> </tr> <tr class="row1"> <th class="col0 leftalign"> @NAME@ </th><td class="col1"> full name of user </td> </tr> <tr class="row2"> <th class="col0"> @GROUP@ </th><td class="col1"> first group the user belongs to </td> </tr> <tr class="row3"> <th class="col0 leftalign"> @YEAR@ </th><td class="col1"> 4-digit year </td> </tr> <tr class="row4"> <th class="col0"> @MONTH@ </th><td class="col1"> 2-digit month </td> </tr> <tr class="row5"> <th class="col0">@WEEK@ </th><td class="col1">2-digit ISO week number </td> </tr> <tr class="row6"> <th class="col0 leftalign"> @DAY@ </th><td class="col1"> 2-digit day </td> </tr> <tr class="row7"> <th class="col0"> @DATE<expr>@ </th><td class="col1"> use a calculated date instead of today in date macros </td> </tr> </table></div> <div class="secedit editbutton_table editbutton_9"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Table] " /><input type="hidden" name="target" value="table" /><input type="hidden" name="hid" value="table2" /><input type="hidden" name="range" value="17825-18114" /><button type="submit" title="Table">Edit</button></div></form></div> <p> <expr> in <strong><code>@DATE<expr>@</code></strong> can be one of: </p> <div class="table sectionedit10"><table class="inline"> <tr class="row0"> <th class="col0"> PYEAR </th><td class="col1"> previous year </td> </tr> <tr class="row1"> <th class="col0"> NYEAR </th><td class="col1"> next year </td> </tr> <tr class="row2"> <th class="col0"> PMONTH </th><td class="col1"> previous month </td> </tr> <tr class="row3"> <th class="col0"> NMONTH </th><td class="col1"> next month </td> </tr> <tr class="row4"> <th class="col0"> PWEEK </th><td class="col1"> previous week </td> </tr> <tr class="row5"> <th class="col0"> NWEEK </th><td class="col1"> next week </td> </tr> <tr class="row6"> <th class="col0"> YESTERDAY </th><td class="col1"> yesterday's date </td> </tr> <tr class="row7"> <th class="col0"> TOMORROW </th><td class="col1"> tomorrow's date </td> </tr> </table></div> <div class="secedit editbutton_table editbutton_10"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Table] " /><input type="hidden" name="target" value="table" /><input type="hidden" name="hid" value="table3" /><input type="hidden" name="range" value="18163-18374" /><button type="submit" title="Table">Edit</button></div></form></div> <p> Examples: </p> <pre class="code">{{page>@MONTH@:@DAY@:birthdays}}</pre> <p> includes the page <code>birthdays</code> in namespace <month>:<day>: eg. <code>10:15: birthdays</code> for the 15th of october. </p> <pre class="code">{{page>@USER@:message}}</pre> <p> includes the page <code>message</code> from the namespace <user> of the logged in user </p> <pre class="code">{{page>foo@DATENWEEK@@YEAR@:@WEEK@}}</pre> <p> includes the page <weekno> from the namespace <code>foo<year></code> with next week's date e.g. foo2012:01 for the 27th of december 2011 </p> </div> <div class="secedit editbutton_section editbutton_8"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Macros] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="macros" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="17718-18807" /><button type="submit" title="Macros">Edit</button></div></form></div> <h2 class="sectionedit11" id="demo">Demo</h2> <div class="level2"> <p> <img src="/lib/images/smileys/fixme.svg" class="icon smiley" alt="FIXME" /> There is currently no demo site available. </p> <p> Use of the plugin is shown in this video here: <a href="https://www.youtube.com/watch?v=6RO8TSZBedU&t=8m47s" class="urlextern" title="https://www.youtube.com/watch?v=6RO8TSZBedU&t=8m47s">https://www.youtube.com/watch?v=6RO8TSZBedU&t=8m47s</a> <img src="/lib/images/smileys/fixme.svg" class="icon smiley" alt="FIXME" /> Video not available (2021-03-20) </p> </div> <div class="secedit editbutton_section editbutton_11"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Demo] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="demo" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="18808-19013" /><button type="submit" title="Demo">Edit</button></div></form></div> <h2 class="sectionedit12" id="development">Development</h2> <div class="level2"> </div> <h4 id="change_log">Change Log</h4> <div class="level4"> <ul class="rss"><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/c66bac01f1466a2ecc077b77ba2dd7bc0f343ab2" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/c66bac01f1466a2ecc077b77ba2dd7bc0f343ab2">Merge pull request #322 from dokuwiki-translate/lang_update_951_17271…</a> (2024-09-23 23:34)</div></li><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/5e1dff2d4355830e37e4edf1931bf3c4d87d30ec" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/5e1dff2d4355830e37e4edf1931bf3c4d87d30ec">translation update</a> (2024-09-23 19:00)</div></li><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/a6cfd524c816c907f69eb4a243c1660cb097c775" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/a6cfd524c816c907f69eb4a243c1660cb097c775">Merge pull request #295 from fjf2002/clear-both-missing-causes-follow…</a> (2024-03-07 08:32)</div></li><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/290003151d2b744c270d960349d872071f0b2fdd" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/290003151d2b744c270d960349d872071f0b2fdd">Merge branch 'dokufreaks:master' into clear-both-missing-causes-follo…</a> (2023-09-27 12:24)</div></li><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/86d24a163e94f506f1192c3ab5a4e111a1f1e9d8" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/86d24a163e94f506f1192c3ab5a4e111a1f1e9d8">Version upped</a> (2023-09-22 23:50)</div></li><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/5126bb827beae18b728c3e9d7862c7361bd7d89b" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/5126bb827beae18b728c3e9d7862c7361bd7d89b">Remove unsupported PHP versions and old exclude from CI</a> (2023-09-22 23:29)</div></li><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/02c330c705a38cf5fd8299f261dfdd96c3f1b813" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/02c330c705a38cf5fd8299f261dfdd96c3f1b813">Fix PHPUnit warnings</a> (2023-09-22 23:14)</div></li><li><div class="li"><a href="https://github.com/dokufreaks/plugin-include/commit/5b531ba971ca49b02b1703afc8110b28ea2b2969" class="urlextern" title="https://github.com/dokufreaks/plugin-include/commit/5b531ba971ca49b02b1703afc8110b28ea2b2969">unterminated-float-causes-following-caption-to-wrap</a> (2023-07-04 14:49)</div></li></ul> </div> <h4 id="bugs_feature_requests">Bugs / Feature Requests</h4> <div class="level4"> <p> Please report bugs or feature requests at the <a href="https://github.com/dokufreaks/plugin-include/issues" class="urlextern" title="https://github.com/dokufreaks/plugin-include/issues">Bug tracker</a>. </p> </div> <h4 id="known_bugs_and_issues">Known Bugs and Issues</h4> <div class="level4"> <p> There are currently no known bugs and issues for which no workarounds exist (see <a href="#faq" title="plugin:include ↵" class="wikilink1">FAQ</a>). </p> </div> <div class="secedit editbutton_section editbutton_12"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Development] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="development" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="19014-19413" /><button type="submit" title="Development">Edit</button></div></form></div> <h2 class="sectionedit13" id="faq">FAQ</h2> <div class="level2"> </div> <div class="secedit editbutton_section editbutton_13"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[FAQ] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="faq" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="19414-19430" /><button type="submit" title="FAQ">Edit</button></div></form></div> <h3 class="sectionedit14" id="the_include_plugin_breaks_the_wrap_and_folded_and_similar_plugins_when_used_inside_them">The include plugin breaks the wrap and folded (and similar) plugins when used inside them</h3> <div class="level3"> <p> This can be solved by using the <code>inline</code> flag of the include plugin. This mode strips all section from the included page and should solve issues with invalid <abbr title="HyperText Markup Language">HTML</abbr> and thus no longer working wrap and folded plugins. This also solves problems with invalid <abbr title="HyperText Markup Language">HTML</abbr> code when the include plugin is used inside tables or other syntax environments. When the page contains headers this might look strange depending on the template. </p> </div> <h4 id="addendum">Addendum</h4> <div class="level4"> <p> If you are using the <a href="/plugin:wrap" class="wikilink1" title="plugin:wrap" data-wiki-id="plugin:wrap">Wrap Plugin</a> on both the page you are using the <code>{{section>target&inline}}</code> from and the page <em>target</em>, you need to make sure any pair of WRAP tags on <em>target</em> are either entirely within the included section or entirely outside of the section. For instance, including the FOO section into another page might break the other page: </p> <pre class="code"><WRAP right 35%> ==== FOO ==== Content goes here </WRAP> ==== BAR ====</pre> <p> FOO contains the <code></WRAP></code> end-tag, but not a corresponding start-tag. Thus, if the use of <a href="/plugin:include" class="wikilink1" title="plugin:include" data-wiki-id="plugin:include">include</a> is within a WRAPed block, that WRAP block will be ended early. </p> <p> The simplest solution is to never use WRAP on both pages, only on included pages or only on pages that include others – however, that's not very realistic or useful. The other (somewhat brittle) solution is to make the section on <em>target</em> end before the WRAP close tag. You can do this by inserting a dokuwiki section header (at the same level) before the close tag, but after the section's content. However, I've not been able to determine if this is an intended behavior of dokuwiki, or if this is undocumented behavior and therefore subject to change at any time. </p> <p> So, to make the above example work correctly, it should look like this: </p> <pre class="code"><WRAP right 35%> ==== BAZ ==== Content goes here ==== ==== </WRAP> ==== QUX ====</pre> <p> Now <code>{{section>whatever#BAZ}}</code> will work fine. </p> </div> <div class="secedit editbutton_section editbutton_14"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[The include plugin breaks the wrap and folded (and similar) plugins when used inside them] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="the_include_plugin_breaks_the_wrap_and_folded_and_similar_plugins_when_used_inside_them" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="19431-21427" /><button type="submit" title="The include plugin breaks the wrap and folded (and similar) plugins when used inside them">Edit</button></div></form></div> <h3 class="sectionedit15" id="is_it_possible_to_include_the_same_page_twice">Is it possible to include the same page twice?</h3> <div class="level3"> <p> Yes, this is possible since the 2011-01-01 version and hasn't been possible before. But you can't include the same page again inside a page in order to avoid endless recursion (and things like page1 > page2 > page1 doesn't work, too). </p> </div> <div class="secedit editbutton_section editbutton_15"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Is it possible to include the same page twice?] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="is_it_possible_to_include_the_same_page_twice" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="21428-21721" /><button type="submit" title="Is it possible to include the same page twice?">Edit</button></div></form></div> <h3 class="sectionedit16" id="does_the_include_plugin_respect_acls_of_the_included_pages">Does the include plugin respect ACLs of the included pages?</h3> <div class="level3"> <p> The include plugin tries its best to respect ACLs and it should work under normal circumstances. Whenever the view permissions of included pages change the cache is purged and the included pages are adapted according to the current permissions. Due to limitations in the caching system this might fail if a page is accessed very frequently with changing permissions. If this is an issue for you you can disable caching of the affected pages using the <code>~~NOCACHE~~</code> syntax. As always there is no guarantee that everything works as expected, please test if everything works and report a bug if you should notice anything unexpected. </p> <p> As of version 2012-11-24, there is a new security feature called <code>safeindex</code> that is turned on by default, it's purpose is to prevent the indexer from indexing metadata of included pages that aren't public. That way links that are in protected pages won't be visible as link of a public page in the backlinks list. </p> </div> <div class="secedit editbutton_section editbutton_16"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Does the include plugin respect ACLs of the included pages?] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="does_the_include_plugin_respect_acls_of_the_included_pages" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="21722-22748" /><button type="submit" title="Does the include plugin respect ACLs of the included pages?">Edit</button></div></form></div> <h3 class="sectionedit17" id="why_does_the_include_plugin_first_close_the_previous_section_and_opens_it_again_afterwards">Why does the include plugin first close the previous section and opens it again afterwards?</h3> <div class="level3"> <p> This is done because if there are headers in the included page they will close the current section. As the include plugin has its own container div this would produce strange results and possibly invalid <abbr title="HyperText Markup Language">HTML</abbr>. You can use the <code>inline</code> flag in order to avoid this (but then also all sections of the included page are removed). </p> </div> <div class="secedit editbutton_section editbutton_17"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Why does the include plugin first close the previous section and opens it again afterwards?] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="why_does_the_include_plugin_first_close_the_previous_section_and_opens_it_again_afterwards" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="22749-23180" /><button type="submit" title="Why does the include plugin first close the previous section and opens it again afterwards?">Edit</button></div></form></div> <h3 class="sectionedit18" id="has_the_include_plugin_feature_xyz_when_will_you_implement_xyz">Has the include plugin feature XYZ/when will you implement XYZ?</h3> <div class="level3"> <p> The include plugin has many feature and is very flexible and I'm willing to add more features if they fit in the general purpose of the include plugin. However there is no guarantee that I will implement a certain feature at a certain time, this depends completely on my available time and my mood. You can add your wishes to the issue tracker. </p> </div> <div class="secedit editbutton_section editbutton_18"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Has the include plugin feature XYZ/when will you implement XYZ?] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="has_the_include_plugin_feature_xyz_when_will_you_implement_xyz" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="23181-23601" /><button type="submit" title="Has the include plugin feature XYZ/when will you implement XYZ?">Edit</button></div></form></div> <h3 class="sectionedit19" id="how_to_avoid_inclusion_of_whole_page_content_if_section_does_not_exist">How to avoid inclusion of whole page content if section does not exist?</h3> <div class="level3"> <p> Adding the flag <code>firstsectiononly</code> could be one solution. At least in regard to avoiding very large content being displayed. Adding a header at the source page and using tools like the <a href="/plugin:hiddenheader" class="wikilink1" title="plugin:hiddenheader" data-wiki-id="plugin:hiddenheader">hiddenheader</a> might solve things at the source page, but in this case seems to conflict and break certain include flag-tasks. </p> </div> <div class="secedit editbutton_section editbutton_19"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[How to avoid inclusion of whole page content if section does not exist?] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="how_to_avoid_inclusion_of_whole_page_content_if_section_does_not_exist" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="23602-24007" /><button type="submit" title="How to avoid inclusion of whole page content if section does not exist?">Edit</button></div></form></div> <h2 class="sectionedit20" id="discussion">Discussion</h2> <div class="level2"> <p> <img src="/lib/images/smileys/exclaim.svg" class="icon smiley" alt=":!:" /> Please don't report any bugs or feature requests here but instead use the <a href="https://github.com/dokufreaks/plugin-include/issues" class="urlextern" title="https://github.com/dokufreaks/plugin-include/issues">bug tracker</a>! <img src="/lib/images/smileys/exclaim.svg" class="icon smiley" alt=":!:" /> </p> <p> If you miss a comment you've created please have a look at the <a href="#faq" title="plugin:include ↵" class="wikilink1">FAQ</a> section and the <a href="https://github.com/dokufreaks/plugin-include/issues" class="urlextern" title="https://github.com/dokufreaks/plugin-include/issues">issue tracker</a>, I might have moved them there, if you can't find a bug report anymore that bug should be solved, please try the current version and report it again if it still doesn't work. </p> </div> <div class="secedit editbutton_section editbutton_20"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Discussion] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="discussion" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="24008-24518" /><button type="submit" title="Discussion">Edit</button></div></form></div> <h3 class="sectionedit21" id="discussions_in_dw-forum">Discussions in DW-forum</h3> <div class="level3"> <ul> <li class="level1"><div class="li"> <a href="https://forum.dokuwiki.org/thread/16154" class="urlextern" title="https://forum.dokuwiki.org/thread/16154">plugin:include / Hide current page contents once user logs in</a></div> </li> <li class="level1"><div class="li"> <a href="https://forum.dokuwiki.org/thread/16235" class="urlextern" title="https://forum.dokuwiki.org/thread/16235">include plugin: development in direction to use it as a kind database tool</a>, feature inspirations.</div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_21"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Discussions in DW-forum] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="discussions_in_dw-forum" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="24519-24812" /><button type="submit" title="Discussions in DW-forum">Edit</button></div></form></div> <h3 class="sectionedit22" id="user_comments">User comments</h3> <div class="level3"> <p> <strong>footer.php</strong>: </p> <pre class="code php"><span class="co1">// author</span> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$flags</span><span class="br0">[</span><span class="st_h">'user'</span><span class="br0">]</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$author</span> <span class="sy0">=</span> <span class="re0">$meta</span><span class="br0">[</span><span class="st_h">'creator'</span><span class="br0">]</span><span class="sy0">;</span> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$author</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$userpage</span> <span class="sy0">=</span> cleanID<span class="br0">(</span><span class="re0">$this</span><span class="sy0">-></span><span class="me1">getConf</span><span class="br0">(</span><span class="st_h">'usernamespace'</span><span class="br0">)</span><span class="sy0">.</span><span class="st_h">':'</span><span class="sy0">.</span><span class="re0">$author</span><span class="br0">)</span><span class="sy0">;</span></pre> <p> replaced to include the real user name in the link: </p> <pre class="code php"><span class="co1">// author</span> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$flags</span><span class="br0">[</span><span class="st_h">'user'</span><span class="br0">]</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$author</span> <span class="sy0">=</span> <span class="re0">$meta</span><span class="br0">[</span><span class="st_h">'creator'</span><span class="br0">]</span><span class="sy0">;</span> <span class="re0">$login</span> <span class="sy0">=</span> <span class="re0">$meta</span><span class="br0">[</span><span class="st0">"last_change"</span><span class="br0">]</span><span class="br0">[</span><span class="st_h">'user'</span><span class="br0">]</span><span class="sy0">;</span> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$author</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$userpage</span> <span class="sy0">=</span> cleanID<span class="br0">(</span><span class="re0">$this</span><span class="sy0">-></span><span class="me1">getConf</span><span class="br0">(</span><span class="st_h">'usernamespace'</span><span class="br0">)</span><span class="sy0">.</span><span class="st_h">':'</span><span class="sy0">.</span><span class="re0">$login</span><span class="br0">)</span><span class="sy0">;</span></pre> </div> <h4 id="user_namespace">User Namespace</h4> <div class="level4"> <p> Hi, I'm using <a href="/plugin:userpagecreate" class="wikilink1" title="plugin:userpagecreate" data-wiki-id="plugin:userpagecreate">userpagecreate</a> plugin's to create user's namespace instead of user's page. Then, to link correctly the include's page with his last member who edit it, i rewrite the previous lines like this : </p> <pre class="code php"> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$flags</span><span class="br0">[</span><span class="st_h">'user'</span><span class="br0">]</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$login</span> <span class="sy0">=</span> <span class="re0">$meta</span><span class="br0">[</span><span class="st_h">'last_change'</span><span class="br0">]</span><span class="br0">[</span><span class="st_h">'user'</span><span class="br0">]</span><span class="sy0">;</span> <span class="re0">$author</span> <span class="sy0">=</span> <span class="re0">$auth</span><span class="sy0">-></span><span class="me1">getUserData</span><span class="br0">(</span><span class="re0">$login</span><span class="br0">)</span><span class="sy0">;</span> <span class="re0">$author</span> <span class="sy0">=</span> <span class="re0">$author</span><span class="br0">[</span><span class="st_h">'name'</span><span class="br0">]</span><span class="sy0">;</span> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$author</span> <span class="sy0">&&</span> <span class="re0">$login</span><span class="br0">)</span> <span class="br0">{</span> <span class="kw1">if</span> <span class="br0">(</span><a href="http://www.php.net/strstr"><span class="kw3">strstr</span></a><span class="br0">(</span><span class="re0">$this</span><span class="sy0">-></span><span class="me1">getConf</span><span class="br0">(</span><span class="st_h">'usernamespace'</span><span class="br0">)</span><span class="sy0">,</span> <span class="st_h">'@USER@'</span><span class="br0">)</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$userpage</span> <span class="sy0">=</span> cleanID<span class="br0">(</span><a href="http://www.php.net/str_replace"><span class="kw3">str_replace</span></a><span class="br0">(</span><span class="st_h">'@USER@'</span><span class="sy0">,</span> <span class="re0">$login</span><span class="sy0">,</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">getConf</span><span class="br0">(</span><span class="st_h">'usernamespace'</span><span class="br0">)</span><span class="br0">)</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw1">else</span> <span class="br0">{</span> <span class="re0">$userpage</span> <span class="sy0">=</span> cleanID<span class="br0">(</span><span class="re0">$this</span><span class="sy0">-></span><span class="me1">getConf</span><span class="br0">(</span><span class="st_h">'usernamespace'</span><span class="br0">)</span><span class="sy0">.</span><span class="st_h">':'</span><span class="sy0">.</span><span class="re0">$login</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> resolve_pageid<span class="br0">(</span>getNS<span class="br0">(</span><span class="re0">$ID</span><span class="br0">)</span><span class="sy0">,</span> <span class="re0">$userpage</span><span class="sy0">,</span> <span class="re0">$exists</span><span class="br0">)</span><span class="sy0">;</span> <span class="re0">$class</span> <span class="sy0">=</span> <span class="br0">(</span><span class="re0">$exists</span> ? <span class="st_h">'wikilink1'</span> <span class="sy0">:</span> <span class="st_h">'wikilink2'</span><span class="br0">)</span><span class="sy0">;</span> <span class="re0">$link</span> <span class="sy0">=</span> <a href="http://www.php.net/array"><span class="kw3">array</span></a><span class="br0">(</span> <span class="st_h">'url'</span> <span class="sy0">=></span> wl<span class="br0">(</span><span class="re0">$userpage</span><span class="br0">)</span><span class="sy0">,</span> <span class="st_h">'title'</span> <span class="sy0">=></span> <span class="re0">$userpage</span><span class="sy0">,</span> <span class="st_h">'name'</span> <span class="sy0">=></span> hsc<span class="br0">(</span><span class="re0">$author</span><span class="br0">)</span><span class="sy0">,</span> <span class="st_h">'target'</span> <span class="sy0">=></span> <span class="re0">$conf</span><span class="br0">[</span><span class="st_h">'target'</span><span class="br0">]</span><span class="br0">[</span><span class="st_h">'wiki'</span><span class="br0">]</span><span class="sy0">,</span> <span class="st_h">'class'</span> <span class="sy0">=></span> <span class="re0">$class</span><span class="sy0">.</span><span class="st_h">' url fn'</span><span class="sy0">,</span> <span class="st_h">'pre'</span> <span class="sy0">=></span> <span class="st_h">'<span class="vcard author">'</span><span class="sy0">,</span> <span class="st_h">'suf'</span> <span class="sy0">=></span> <span class="st_h">'</span>'</span><span class="sy0">,</span> <span class="br0">)</span><span class="sy0">;</span> <span class="re0">$xhtml</span><span class="br0">[</span><span class="br0">]</span> <span class="sy0">=</span> <span class="re0">$renderer</span><span class="sy0">-></span>_formatLink<span class="br0">(</span><span class="re0">$link</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> <span class="br0">}</span></pre> <p> and change my conf into : </p> <pre class="code">$conf['plugin']['include']['usernamespace'] = 'user:@USER@:start';</pre> <p> standard configuration still works. </p> <pre class="code">$conf['plugin']['include']['usernamespace'] = 'user:';</pre> <p> If the <strong>@USER@</strong> wildcard is using, replace it by the login name, otherwise, use the standard include's plugin rule. </p> <p> — <a href="https://forum.dokuwiki.org/u/garlik" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/garlik">garlik</a> <em>2011/10/24 14:10</em> </p> <p> — <a href="https://forum.dokuwiki.org/u/garlik" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/garlik">garlik</a> <em>2011/11/07 11:32</em> - Summmary : Update the code. will display the right modif author. </p> </div> <div class="secedit editbutton_section editbutton_22"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[User comments] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="user_comments" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="24813-27217" /><button type="submit" title="User comments">Edit</button></div></form></div> <h3 class="sectionedit23" id="showlink_vs_link_flag">showlink vs link flag</h3> <div class="level3"> <p> When including a page, the flag to make the first heading a link is <code>link</code>, not <code>showlink</code>. This confused me at first because I assumed the flags would have the same names as the configuration options. Example (displays the first section of a product page, with the page heading as a link): </p> <pre class="code">{{page>products:sample&firstseconly&link}}</pre> </div> <div class="secedit editbutton_section editbutton_23"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[showlink vs link flag] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="showlink_vs_link_flag" /><input type="hidden" name="codeblockOffset" value="5" /><input type="hidden" name="range" value="27218-27603" /><button type="submit" title="showlink vs link flag">Edit</button></div></form></div> <h3 class="sectionedit24" id="controlling_header_size_in_included_pages">Controlling header size in included pages</h3> <div class="level3"> <p> By default, the headers in included pages start one level lower than the last header in the current page. For example, if the section before the include is a level-three header, then a level-6 header in the included page will become a wimply little level-2. </p> <p> If you want higher-level headers, you can trick the plugin by putting an empty header above the include. In the following example, a level-6 header in the included page will show up as level-5: </p> <pre class="code">=== Some Section === Stuff ====== ====== {{page>somepage}}</pre> <p> - <a href="https://forum.dokuwiki.org/u/Zioth" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/Zioth">Zioth</a> </p> </div> <div class="secedit editbutton_section editbutton_24"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Controlling header size in included pages] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="controlling_header_size_in_included_pages" /><input type="hidden" name="codeblockOffset" value="6" /><input type="hidden" name="range" value="27604-28209" /><button type="submit" title="Controlling header size in included pages">Edit</button></div></form></div> <h3 class="sectionedit25" id="including_a_paragraph_or_excerpt_from_a_page">Including a paragraph or excerpt from a page</h3> <div class="level3"> <p> See the <a href="/plugin:hiddenheader" class="wikilink1" title="plugin:hiddenheader" data-wiki-id="plugin:hiddenheader">Hidden Header plugin</a>. -<a href="https://forum.dokuwiki.org/u/Zioth" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/Zioth">Zioth</a> </p> </div> <div class="secedit editbutton_section editbutton_25"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Including a paragraph or excerpt from a page] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="including_a_paragraph_or_excerpt_from_a_page" /><input type="hidden" name="codeblockOffset" value="7" /><input type="hidden" name="range" value="28210-28342" /><button type="submit" title="Including a paragraph or excerpt from a page">Edit</button></div></form></div> <h3 class="sectionedit26" id="angua">2012-01-25 "Angua"</h3> <div class="level3"> <p> Just tested with the current version and it works for me. — <a href="https://forum.dokuwiki.org/u/renux" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/renux">renux</a> <em>2012/02/10 12:44</em> </p> </div> <div class="secedit editbutton_section editbutton_26"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[2012-01-25 "Angua"] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="angua" /><input type="hidden" name="codeblockOffset" value="7" /><input type="hidden" name="range" value="28343-28477" /><button type="submit" title="2012-01-25 "Angua"">Edit</button></div></form></div> <h3 class="sectionedit27" id="include_from_same_page">Include from same page?</h3> <div class="level3"> <p> Using it on my knowledge wiki and it works well. However, I'd like to be able to include a section from the current page - for use with the <a href="/plugin:itemtable" class="wikilink1" title="plugin:itemtable" data-wiki-id="plugin:itemtable">ItemTable Plugin</a> (along with something to hide the inline text of course. — <a href="https://forum.dokuwiki.org/u/TotallyInformation" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/TotallyInformation">Julian Knight</a> <em>2012-03-23</em> </p> <p> Does it still work? Can't make it on my wiki page. </p> <p> — <em>Piotr</em> <em>2017-10-04</em> </p> </div> <div class="secedit editbutton_section editbutton_27"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Include from same page?] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="include_from_same_page" /><input type="hidden" name="codeblockOffset" value="7" /><input type="hidden" name="range" value="28478-28891" /><button type="submit" title="Include from same page?">Edit</button></div></form></div> <h3 class="sectionedit28" id="align_feature">Align Feature</h3> <div class="level3"> <p> It'll be great to be able to align included pages. Because a lot of people are using this feature for infobox purposes and some would love to be able to control the alignment of the </p> <pre class="code">{{page>people:obama}}</pre> <p> using the core syntax by adding spaces before of after the syntax. </p> <p> — James <em> 2014-05-13 20:38</em> </p> </div> <div class="secedit editbutton_section editbutton_28"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Align Feature] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="align_feature" /><input type="hidden" name="codeblockOffset" value="7" /><input type="hidden" name="range" value="28892-29235" /><button type="submit" title="Align Feature">Edit</button></div></form></div> <h3 class="sectionedit29" id="exclude_feature">Exclude Feature</h3> <div class="level3"> <p> It would be nice, if there would be an “exclude” option. When we use the <code>namespace</code> feature, we don't want certain pages in the included in the resulting page: for example exclude “sidebar” or “start”. </p> <p> — Manuel <em> 2014-10-30 02:42</em> </p> <p> I would appreciate that feature too. </p> <p> — Florian <em> 2015-07-18 18:43</em> </p> <p> Same here, the possibility of the exclusion of listed namespaces would be much appreciated. </p> <p> — Tommy <em> 2016-2-19 21:18</em> </p> <p> I totally agree. </p> <p> —- Chris <em> 2016-2-21 09:12</em> </p> <p> <a href="/plugin:blog" class="wikilink1" title="plugin:blog" data-wiki-id="plugin:blog">blog plugin</a> supports <strong>Exclude Feature </strong> </p> <p> — HsinTang <em> 2016-07-26 </em> </p> <p> I created <a href="https://github.com/dokufreaks/plugin-include/pull/243" class="urlextern" title="https://github.com/dokufreaks/plugin-include/pull/243">a PR</a> for an exclude option! Testing or adding tests would be appreciated. </p> <p> — <a href="https://forum.dokuwiki.org/u/sleeping" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/sleeping">sleeping</a> <em>2020-04-11 07:57</em> </p> <p> The <code>exclude</code> flag has been merged! <img src="/lib/images/smileys/smile.svg" class="icon smiley" alt=":-)" /> </p> <p> — <a href="https://forum.dokuwiki.org/u/sleeping" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/sleeping">sleeping</a> <em>2020-04-16 19:28</em> </p> </div> <div class="secedit editbutton_section editbutton_29"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Exclude Feature] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="exclude_feature" /><input type="hidden" name="codeblockOffset" value="8" /><input type="hidden" name="range" value="29236-30148" /><button type="submit" title="Exclude Feature">Edit</button></div></form></div> <h3 class="sectionedit30" id="empty_section">Empty Section</h3> <div class="level3"> <p> We are using the plugin a lot for technical documentation. If we include a named section (#title), and that section doesn't exist, the plugin includes the whole page. This really annoying. Would it be possible to change the behavior so that if a section doesn't exist it doesn't include anything (the same as when a page doesn't exist), please? </p> <p> — Simon <em> 2015-02-02 14:50 </em> </p> <blockquote><div class="no"> Just thought of asking about this issue. Is there any possibility to avoid that? — <a href="https://forum.dokuwiki.org/u/Samana Johann" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/Samana Johann">Samana Johann</a> <em>2018-08-20 19:45</em></div></blockquote> </div> <div class="secedit editbutton_section editbutton_30"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Empty Section] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="empty_section" /><input type="hidden" name="codeblockOffset" value="8" /><input type="hidden" name="range" value="30149-30702" /><button type="submit" title="Empty Section">Edit</button></div></form></div> <h3 class="sectionedit31" id="no_other_data">No Other data</h3> <div class="level3"> <p> I love this plugin but I have a question. How do I completely remove all other data included, such as user, mdate, etc.? If I do them as individual flags I still see the grey bar under the included content. There must be a flag that just excludes all the content, right? Am I just missing it somehow? </p> <p> Thanks! </p> <p> — Max <em>2017.03.21</em> </p> <p> Hi there, I think you are looking for </p> <pre class="code">{{page>ID&nouser&nodate&nofooter}}</pre> </div> <div class="secedit editbutton_section editbutton_31"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[No Other data] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="no_other_data" /><input type="hidden" name="codeblockOffset" value="8" /><input type="hidden" name="range" value="30703-31149" /><button type="submit" title="No Other data">Edit</button></div></form></div> <h3 class="sectionedit32" id="namespace_lists_using_linkonly_and_beforeeach_aftereach">Namespace lists using &linkonly and &beforeeach/&aftereach</h3> <div class="level3"> <p> I've been trying to format a list of pages generated using namespace> with &linkonly - ideally as a simple unordered list. I'm adding this paragraph to help others searching for help because it took me several hours to find out that it is not possible and this is a known issue logged as a <a href="https://github.com/dokufreaks/plugin-include/issues/130" class="urlextern" title="https://github.com/dokufreaks/plugin-include/issues/130">feature request</a>. </p> <p> — vt306 <em>2017.03.29</em> </p> <p> Thanks to Michael Hamann for the advice. The <a href="https://www.dokuwiki.org/plugin%3Apagequery" class="interwiki iw_doku" title="https://www.dokuwiki.org/plugin%3Apagequery">pagequery</a> plugin is the solution for this. </p> <p> — vt306 <em>2017.04.06</em> </p> </div> <div class="secedit editbutton_section editbutton_32"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Namespace lists using &linkonly and &beforeeach/&aftereach] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="namespace_lists_using_linkonly_and_beforeeach_aftereach" /><input type="hidden" name="codeblockOffset" value="9" /><input type="hidden" name="range" value="31150-31754" /><button type="submit" title="Namespace lists using &linkonly and &beforeeach/&aftereach">Edit</button></div></form></div> <h3 class="sectionedit33" id="option_to_pass_revision_of_main_page_to_includes_pages">Option to pass revision of main page to includes pages</h3> <div class="level3"> <p> We are currently using DokuWiki for technical documentation. Within DokuWiki we use the '<a href="/date_at" class="wikilink1" title="date_at" data-wiki-id="date_at">date_at</a>' function to go back to an old revision to see which version of the page a customer recieved. It would be very usefull if the included pages would honour the revision of the main page. To clarify: if the main page is shown at a specific revision, the included pages should also be shown at the last revision before the date of the main page. Would something like that be possible to incorporate? </p> <p> Thanks in advance! Ruud </p> </div> <div class="secedit editbutton_section editbutton_33"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Option to pass revision of main page to includes pages] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="option_to_pass_revision_of_main_page_to_includes_pages" /><input type="hidden" name="codeblockOffset" value="9" /><input type="hidden" name="range" value="31755-32345" /><button type="submit" title="Option to pass revision of main page to includes pages">Edit</button></div></form></div> <h3 class="sectionedit34" id="translations">Translations</h3> <div class="level3"> <blockquote><div class="no"> If it is of use, a paticular Translation of the Plugin's info page into German can be taken from <a href="http://accesstoinsight.eu/doku.php?id=external:index#include_plugin" class="urlextern" title="http://accesstoinsight.eu/doku.php?id=external:index#include_plugin">here</a>. — <a href="https://forum.dokuwiki.org/u/Samana Johann" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/Samana Johann">Samana Johann</a> <em>2018-08-20 12:11</em></div></blockquote> </div> <div class="secedit editbutton_section editbutton_34"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Translations] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="translations" /><input type="hidden" name="codeblockOffset" value="9" /><input type="hidden" name="range" value="32346-32608" /><button type="submit" title="Translations">Edit</button></div></form></div> <h3 class="sectionedit35" id="display_search_results_on_a_page">Display search results on a page?</h3> <div class="level3"> <p> Hi, I was wondering if it is possible to display the search result of a term or phrase on a page? </p> <p> - OYMYO </p> </div> <div class="secedit editbutton_section editbutton_35"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Display search results on a page?] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="display_search_results_on_a_page" /><input type="hidden" name="codeblockOffset" value="9" /><input type="hidden" name="range" value="32609-32760" /><button type="submit" title="Display search results on a page?">Edit</button></div></form></div> <h3 class="sectionedit36" id="passing_parameters_arguments">Passing parameters/arguments</h3> <div class="level3"> <p> I think it would be cool if this plugin supported <a href="https://www.mediawiki.org/wiki/Help:Templates#Parameters" class="urlextern" title="https://www.mediawiki.org/wiki/Help:Templates#Parameters">options/arguments like in MediaWiki</a>. </p> <p> Something like this: </p> <dl class="file"> <dt><a href="/_export/code/plugin:include?codeblock=9" title="Download Snippet" class="mediafile mf_txt">page1.txt</a></dt> <dd><pre class="file">Test by {{{1}}}</pre> </dd></dl> <dl class="file"> <dt><a href="/_export/code/plugin:include?codeblock=10" title="Download Snippet" class="mediafile mf_txt">page2.txt</a></dt> <dd><pre class="file">{{page>:page1|Me}}</pre> </dd></dl> <p> And <code>page2</code> would be parsed into: </p> <pre class="code">Test by Me</pre> <p> — <a href="https://forum.dokuwiki.org/u/hasha2982" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/hasha2982">hasha2982</a> <em>2020-08-19 17:12</em> </p> <blockquote><div class="no"> Sorry, didn't know about the <a href="/plugin:templater" class="wikilink1" title="plugin:templater" data-wiki-id="plugin:templater">Templater Plugin</a> — <a href="https://forum.dokuwiki.org/u/hasha2982" class="interwiki iw_user" title="https://forum.dokuwiki.org/u/hasha2982">hasha2982</a> <em>2020-08-19 17:25</em></div></blockquote> <blockquote><div class="no"> <blockquote><div class="no"> <a href="/plugin:templater" class="wikilink1" title="plugin:templater" data-wiki-id="plugin:templater">Templater</a> and <a href="/plugin:wst" class="wikilink1" title="plugin:wst" data-wiki-id="plugin:wst">WST</a> plugins mess up with footnotes. Also they can break the content when using the edit buttons on sections. Your suggestion/request on passing params is still up-to-date! — <em>2025-01-31 23:36</em></div></blockquote> </div></blockquote> </div> <div class="secedit editbutton_section editbutton_36"><form class="button btn_secedit" method="post" action="/plugin:include"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1738578855" /><input type="hidden" name="summary" value="[Passing parameters/arguments] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="passing_parameters_arguments" /><input type="hidden" name="codeblockOffset" value="9" /><input type="hidden" name="range" value="32761-" /><button type="submit" title="Passing parameters/arguments">Edit</button></div></form></div>  </div> <div class="docInfo"><bdi>plugin/include.txt</bdi> · Last modified: <time datetime="2025-02-03T11:34:15+0100">2025-02-03 11:34</time> by <bdi>Aleksandr</bdi></div> <hr class="a11y" /> </div></main>  <nav id="dokuwiki__pagetools" aria-labelledby="dokuwiki__pagetools__heading"> <h3 class="a11y" id="dokuwiki__pagetools__heading">Page Tools</h3> <div class="tools"> <ul> <li class="edit"><a href="/plugin:include?do=edit" title="Edit this page [e]" rel="nofollow" accesskey="e"><span>Edit this page</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg></a></li><li class="revs"><a href="/plugin:include?do=revisions" title="Old revisions [o]" rel="nofollow" accesskey="o"><span>Old revisions</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M11 7v5.11l4.71 2.79.79-1.28-4-2.37V7m0-5C8.97 2 5.91 3.92 4.27 6.77L2 4.5V11h6.5L5.75 8.25C6.96 5.73 9.5 4 12.5 4a7.5 7.5 0 0 1 7.5 7.5 7.5 7.5 0 0 1-7.5 7.5c-3.27 0-6.03-2.09-7.06-5h-2.1c1.1 4.03 4.77 7 9.16 7 5.24 0 9.5-4.25 9.5-9.5A9.5 9.5 0 0 0 12.5 2z"/></svg></a></li><li class="backlink"><a href="/plugin:include?do=backlink" title="Backlinks" rel="nofollow"><span>Backlinks</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10.59 13.41c.41.39.41 1.03 0 1.42-.39.39-1.03.39-1.42 0a5.003 5.003 0 0 1 0-7.07l3.54-3.54a5.003 5.003 0 0 1 7.07 0 5.003 5.003 0 0 1 0 7.07l-1.49 1.49c.01-.82-.12-1.64-.4-2.42l.47-.48a2.982 2.982 0 0 0 0-4.24 2.982 2.982 0 0 0-4.24 0l-3.53 3.53a2.982 2.982 0 0 0 0 4.24m2.82-4.24c.39-.39 1.03-.39 1.42 0a5.003 5.003 0 0 1 0 7.07l-3.54 3.54a5.003 5.003 0 0 1-7.07 0 5.003 5.003 0 0 1 0-7.07l1.49-1.49c-.01.82.12 1.64.4 2.43l-.47.47a2.982 2.982 0 0 0 0 4.24 2.982 2.982 0 0 0 4.24 0l3.53-3.53a2.982 2.982 0 0 0 0-4.24.973.973 0 0 1 0-1.42z"/></svg></a></li><li class="top"><a href="#dokuwiki__top" title="Back to top [t]" rel="nofollow" accesskey="t"><span>Back to top</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg></a></li> </ul> </div> </nav> </div>  <footer id="dokuwiki__footer"><div class="pad"> <div class="license">Except where otherwise noted, content on this wiki is licensed under the following license: <bdi><a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license" class="urlextern">CC Attribution-Share Alike 4.0 International</a></bdi></div> <div class="buttons"> <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license"><img src="/lib/images/license/button/cc-by-sa.png" alt="CC Attribution-Share Alike 4.0 International" /></a> <a href="https://www.dokuwiki.org/donate" title="Donate" ><img src="/lib/tpl/dokuwiki/images/button-donate.gif" width="80" height="15" alt="Donate" /></a> <a href="https://php.net" title="Powered by PHP" ><img src="/lib/tpl/dokuwiki/images/button-php.gif" width="80" height="15" alt="Powered by PHP" /></a> <a href="//validator.w3.org/check/referer" title="Valid HTML5" ><img src="/lib/tpl/dokuwiki/images/button-html5.png" width="80" height="15" alt="Valid HTML5" /></a> <a href="//jigsaw.w3.org/css-validator/check/referer?profile=css3" title="Valid CSS" ><img src="/lib/tpl/dokuwiki/images/button-css.png" width="80" height="15" alt="Valid CSS" /></a> <a href="https://dokuwiki.org/" title="Driven by DokuWiki" ><img src="/lib/tpl/dokuwiki/images/button-dw.png" width="80" height="15" alt="Driven by DokuWiki" /></a> </div> <div style="margin-top: 2em; font-size:90%" class="dokuwiki"><div style="float:right"><a href="http://www.splitbrain.org/personal#imprint" style="float:right; text-decoration: none; color:#333">Imprint</a></div></div> <style type="text/css"> @media screen { body { padding-top: 30px; } #global__header { position: absolute; top: 0; left: 0; text-align: left; vertical-align: middle; line-height: 1.5; background-color: #333; box-shadow: 0 0 8px rgba(0,0,0,0.5); width: 100%; margin: 0; padding: 5px 20px; -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; white-space: nowrap; overflow: hidden; } #global__header h2 { position: absolute; left: -99999em; top: 0; overflow: hidden; display: inline; } #global__header ul, #global__header li { margin: 0; padding: 0; list-style: none; display: inline; line-height: 1.5; } #global__header a { color: #bbb; text-decoration: none; margin-right: 20px; font-size: 14px; font-weight: normal; } #global__header a:hover, #global__header a:active, #global__header a:focus { color: #fff; text-decoration: underline; } #global__header form { float: right; margin: 0 0 0 20px; } #global__header input { background-color: #333; background-image: none; border: 1px solid #bbb; color: #fff; box-shadow: none; border-radius: 2px; margin: 0; line-height: normal; padding: 1px 0 1px 0; height: auto; } #global__header input.button { border: none; color: #bbb; } #global__header input.button:hover, #global__header input.button:active, #global__header input.button:focus { color: #fff; text-decoration: underline; } } /* /@media */ @media only screen and (min-width: 601px) { /* changes specific for www.dokuwiki.org */ #dokuwiki__header { padding-top: 3em; } #dokuwiki__usertools { top: 3em; } /* changes specific for bugs.dokuwiki.org */ div#container div#showtask { top: 40px; } } /* /@media */ @media only screen and (max-width: 600px) { body { padding-top: 0; } #global__header { position: static; white-space: normal; overflow: auto; } #global__header form { float: none; display: block; margin: 0 0 .4em; } } /* /@media */ @media print { #global__header { display: none; } } /* /@media */ </style> <div id="global__header"> <h2>Global DokuWiki Links</h2> <form method="get" action="https://search.dokuwiki.org/" target="_top"> <input type="text" name="q" title="Search all DokuWiki sites at once" class="input" /> <input type="submit" title="Search all DokuWiki sites at once" value="Search" class="button" /> </form> <ul> <li><a href="https://download.dokuwiki.org" title="Download the latest release" target="_top">Download</a></li> <li><a href="https://www.dokuwiki.org" title="Read the DokuWiki documentation" target="_top">Wiki</a></li> <li><a href="https://forum.dokuwiki.org" title="Ask questions in the DokuWiki forum" target="_top">Forum</a></li> <li><a href="https://irc.dokuwiki.org" title="Check IRC chat logs or join the chat" target="_top">IRC</a></li> <li><a href="https://github.com/splitbrain/dokuwiki/issues" title="Report and track bugs" target="_top">Bugs</a></li> <li><a href="https://translate.dokuwiki.org/" title="Help translating the DokuWiki interface" target="_top">Translate</a></li> <li><a href="https://github.com/splitbrain/dokuwiki" title="Access the most recent git commits" target="_top">Git</a></li> <li><a href="https://xref.dokuwiki.org/reference/dokuwiki/" title="Cross-Reference of the DokuWiki source code" target="_top">XRef</a></li> <li><a href="https://codesearch.dokuwiki.org/" title="Search through the sources of DokuWiki, plugins and templates" target="_top">Code Search</a></li> </ul> </div>  </div></footer> </div></div> <div class="no"><img src="/lib/exe/taskrunner.php?id=plugin%3Ainclude&1742125060" width="2" height="1" alt="" /></div> <div id="screen__mode" class="no"></div></body> </html>

CINXE.COM

plugin:include [DokuWiki]