plugin:include
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:include [2017-04-07 09:28] – 93.81.210.107 | plugin:include [2024-03-13 18:21] (current) – 91.89.222.218 | ||
---|---|---|---|
Line 6: | Line 6: | ||
email : freaks@dokuwiki.org | email : freaks@dokuwiki.org | ||
type : syntax, helper | type : syntax, helper | ||
- | lastupdate : 2015-06-13 | + | lastupdate : 2023-09-22 |
- | compatible : 2016-06-26, Detritus, Hrun, Binky, Weatherwax, Angua, Adora Belle, Ponder Stibbons | + | compatible : Greebo, Frusterick Manners, Hogfather, Igor, Jack Jackrum, Kaos |
depends | depends | ||
- | conflicts | + | conflicts |
- | similar | + | similar |
tags : include, embed | tags : include, embed | ||
Line 19: | Line 19: | ||
---- | ---- | ||
- | This is a handy [[plugins|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. | + | :!: 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 ACL checks in namespace includes or allow edits from users who must not see all pages, please upgrade ASAP! :!: |
+ | |||
+ | 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. | ||
===== Installation ===== | ===== Installation ===== | ||
- | Install | + | Search and install |
If you need support for older version of DokuWiki you can try the [[https:// | If you need support for older version of DokuWiki you can try the [[https:// | ||
Line 39: | Line 41: | ||
===== Syntax ===== | ===== Syntax ===== | ||
- | Simply enclose the ID of the page to be included in double curly brackets: | + | The plugin offers four syntaxes, '' |
+ | |||
+ | Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces. Tagtopic includes all pages with a '' | ||
{{page> | {{page> | ||
Line 51: | Line 55: | ||
^ [flags] | flags delimited by ''&'', | ^ [flags] | flags delimited by ''&'', | ||
- | The plugin offers four syntaxes, '' | ||
- | |||
- | Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces. Tagtopic includes all pages with a '' | ||
===== Configuration and Flags ===== | ===== Configuration and Flags ===== | ||
Line 59: | Line 60: | ||
The plugin can be configured in the DokuWiki configuration manager available in the admin menu. These settings also affect the [[plugin: | The plugin can be configured in the DokuWiki configuration manager available in the admin menu. These settings also affect the [[plugin: | ||
- | ^ Configuration option ^ Flags ^ Description ^ | + | ^ Configuration option |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ -| '' | + | ^ - |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
- | ^ - | '' | + | ^ - |
- | ^ - | '' | + | ^ - |
- | ^ '' | + | ^ '' |
+ | ^ - | '' | ||
Line 95: | Line 97: | ||
{{page> | {{page> | ||
{{namespace> | {{namespace> | ||
+ | {{namespace> | ||
Line 127: | Line 130: | ||
{{page> | {{page> | ||
- | incudes | + | includes |
{{page> | {{page> | ||
Line 136: | Line 139: | ||
FIXME There is currently no demo site available. | FIXME There is currently no demo site available. | ||
- | Use of the plugin is shown in this video here: https:// | + | Use of the plugin is shown in this video here: https:// |
+ | FIXME Video not available (2021-03-20) | ||
===== Development ===== | ===== Development ===== | ||
Line 207: | Line 211: | ||
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. | 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. | ||
+ | |||
+ | ==== How to avoid including of whole page content if section does not exist? ==== | ||
+ | |||
+ | If using the flag '' | ||
===== Discussion ===== | ===== Discussion ===== | ||
Line 212: | Line 220: | ||
If you miss a comment you've created please have a look at the [[#FAQ]] section and the [[https:// | If you miss a comment you've created please have a look at the [[#FAQ]] section and the [[https:// | ||
+ | |||
+ | ==== Discussions in DW-forum ==== | ||
+ | |||
+ | * [[https:// | ||
+ | * [[https:// | ||
+ | |||
+ | |||
==== User comments ===== | ==== User comments ===== | ||
Line 307: | Line 322: | ||
--- [[user> | --- [[user> | ||
+ | Does it still work? Can't make it on my wiki page. | ||
+ | |||
+ | --- //Piotr// // | ||
==== Align Feature ==== | ==== Align Feature ==== | ||
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 < | 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 < | ||
Line 333: | Line 351: | ||
---- Chris // 2016-2-21 09: | ---- Chris // 2016-2-21 09: | ||
+ | |||
[[plugin: | [[plugin: | ||
+ | |||
--- HsinTang // 2016-07-26 // | --- HsinTang // 2016-07-26 // | ||
+ | |||
+ | |||
+ | I created [[https:// | ||
+ | |||
+ | --- [[user> | ||
+ | |||
+ | The '' | ||
+ | |||
+ | --- [[user> | ||
==== Empty Section ==== | ==== Empty Section ==== | ||
Line 342: | Line 371: | ||
--- Simon // 2015-02-02 14:50 // | --- Simon // 2015-02-02 14:50 // | ||
+ | |||
+ | >Just thought of asking about this issue. Is there any possibility to avoid that? --- [[user> | ||
==== No Other data ==== | ==== No Other data ==== | ||
Line 359: | Line 390: | ||
--- vt306 // | --- vt306 // | ||
+ | Thanks to Michael Hamann for the advice. The [[doku> | ||
+ | |||
+ | --- vt306 // | ||
+ | |||
+ | ==== Option to pass revision of main page to includes pages ==== | ||
+ | |||
+ | We are currently using DokuWiki for technical documentation. Within DokuWiki we use the ' | ||
+ | |||
+ | Thanks in advance! | ||
+ | Ruud | ||
+ | |||
+ | ==== Translations ==== | ||
+ | |||
+ | >If it is of use, a paticular Translation of the Plugin' | ||
+ | |||
+ | ==== Display search results on a page? ==== | ||
+ | Hi, I was wondering if it is possible to display the search result of a term or phrase on a page? | ||
+ | |||
+ | - OYMYO | ||
+ | |||
+ | ==== Options/ | ||
+ | |||
+ | I think it would be cool if this plugin supported [[https:// | ||
+ | |||
+ | Something like this: | ||
+ | |||
+ | <file - page1.txt> | ||
+ | Test by {{{1}}} | ||
+ | </ | ||
+ | |||
+ | <file - page2.txt> | ||
+ | {{page>: | ||
+ | </ | ||
+ | |||
+ | And '' | ||
+ | |||
+ | Test by Me | ||
+ | |||
+ | --- [[user> | ||
+ | |||
+ | > Sorry, didn't know about the [[plugin: |
plugin/include.1491550092.txt.gz · Last modified: 2017-04-07 09:28 by 93.81.210.107