Metainformationen zur Seite

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Nächste Überarbeitung		Vorhergehende Überarbeitung
en:wiki:syntax [2022/09/15 11:50] – angelegt Michael Schlenstedten:wiki:syntax [2022/09/18 09:50] (aktuell) – Michael Schlenstedt
Zeile 524: Zeile 524:
 DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:
  
-~~INFO:syntaxplugins~~ 
  
 +==== Folded Plugin ====
 +
 +Full documentation: https://www.dokuwiki.org/plugin:folded
 +
 +If you want to make additional information available that is hidden by default, you have two options with this plugin:
 +
 +**Inline:**
 +
 +  This is example ++text | with some of it only shown when you unfold it++. And after that
 +  the text just continues to flow in the same paragraph.
 +  
 +This is example ++text | with some of it only shown when you unfold it++. And after that
 +the text just continues to flow in the same paragraph.
 +
 +**Block:**
 +
 +<code>
 +This is example text.
 +
 +++++ Title |
 +
 +| This table | is only shown | when you unfold the block |
 +
 +{{page>some other wiki page&inline}}
 +
 +++++
 +</code>
 +
 +^  ^ Inline ^ Block ^
 +| Syntax |  ''%%++title| formatted text ++%%''  |  ''%%++++title| any content ++++%%''  |
 +| HTML |  ''%%<span>%%'' tag  |  ''%%<div>%%'' tag  |
 +| Can contain formatting |  :-)  |  :-)  |
 +| Can contain block elements((like tables, lists, new paragraphs, included files, etc.)) |  ---  |  :-)  |
 +| Can be used within a paragraph, table, list, etc. |  :-)  |  ---  |
 +
 +You can see in the image below.
 +
 +{{https://mekineer.com/folded.jpg|Folded plugin in action}}
 +
 +^ Note: As of version 2005-09-02 the syntax has changed to allow linked titles to unfold and fold the section. The pipe char between title and text is mandatory. ^
 +
 +
 +==== Wrap Plugin ====
 +
 +Full documentation: https://www.dokuwiki.org/plugin:wrap
 +
 +This plugin gives you the ability to wrap wiki text inside containers (divs or spans) and give them
 +  - a certain class (with loads of useful preset classes)
 +  - a width
 +  - a language with its associated text direction
 +
 +Basic Syntax:
 +  <WRAP classes #id width :language>
 +  "big" content
 +  </WRAP>
 +  
 +  **or**
 +  <block classes #id width :language>
 +  "big" content
 +  </block>
 +  
 +  or
 +  <div classes #id width :language>
 +  "big" content
 +  </div>
 +An uppercase **%%<WRAP>%%** (or alternatively **%%<block>%%** or **%%<div>%%**) creates a **''div''** and should be used for **"big"** containers, **surrounding** paragraphs, lists, tables, etc.
 +  
 +  <wrap classes #id width :language>"small" content</wrap>
 +  
 +  or
 +  <inline classes #id width :language>"small" content</inline>
 +  
 +  or
 +  <span classes #id width :language>"small" content</span>
 +A lowercase **%%<wrap>%%** (or alternatively **%%<inline>%%** or **%%<span>%%**) creates a **''span''** and should be used for **"small"** containers, **inside** paragraphs, lists, tables, etc.
 +
 +Since version 2013-06-13 there is also a shorthand syntax (for wraps without content):
 +
 +  <WRAP classes #id /> or <block classes #id /> or <div classes #id />
 +
 +and
 +
 +  <wrap classes #id /> or <inline classes #id /> or <span classes #id />
 +
 +:!: Please note, some things **won't work with spans**: **alignments** (including alignments generated by changing the text direction), **multi-columns** and **widths** if the according wrap isn't floated as well.
 +
 +=== Examples ===
 +
 +The plugin comes with an example page, which should explain a lot and looks like this in the default template, see https://demo.selfthinker.org/plugin:wrap
 +
 +=== Classes ===
 +
 +The following classes are currently available:
 +
 +{{ :plugin:wrap_plugin_example10.png?300&direct}}
 +
 +
 +^ class name  ^ description/notes  ^
 +^ __columns__ -- similar to [[columns]], [[side_note]], [[styler]], [[tip]]  ||
 +| **''column''**  | same as ''left'' in LTR languages and same as ''right'' in RTL languages  |
 +| **''left''**  | same as ''column'', will let you float your container on the left  |
 +| **''right''**  | will let the container float right  |
 +| **''center''**  | will position the container in the horizontal center of the page  |
 +| **''col2''**..**''col5''**  | will show the text in multiple columns determined by their amount (2, 3, 4 or 5), only works in modern browsers (no IE9 and below)  |
 +| **''colsmall''**, **''colmedium''**, **''collarge''**  | will also show the text in multiple columns but determined by their width (small, medium or large), only works in modern browsers (no IE9 and below)  |
 +^ __widths__ -- :!: **experimental**, might not work as expected, includes mobile support  ||
 +| **''half''**  | fits two columns in a row, should be used in pairs  |
 +| **''third''**  | fits three or two columns in a row, should be used in triplets or together with ''twothirds''  |
 +| **''twothirds''**  | fits two columns in a row when used together with ''third'', one 1/3 wide and another 2/3 wide  |
 +| **''quarter''**  | fits four columns in a row, should be used in quads  |
 +^ __alignments__ -- similar to [[divalign]], [[columns]], [[styler]] -- :!: don't work with spans!  ||
 +| **''leftalign''**  | aligns text on the left  |
 +| **''rightalign''**  | aligns text on the right  |
 +| **''centeralign''**  | centers the text  |
 +| **''justify''**  | justifies the text  |
 +^ __boxes and notes__ -- similar to [[box]], [[note]], [[tip]]  ||
 +| **''box''**  | creates a box around the container (uses colours from ''style.ini'')  |
 +| **''info''** (was ''information'' in first version)  | creates a blue box with an info icon  |
 +| **''important''**  | creates an orange box with an important icon  |
 +| **''alert''** (:!: was ''warning'' in previous versions)  | creates a red box with an alert icon  |
 +| **''tip''**  | creates a yellow box with a tip icon  |
 +| **''help''**  | creates a violet box with a help icon  |
 +| **''todo''**  | creates a cyan box with an todo icon  |
 +| **''download''**  | creates a green box with a download icon  |
 +| **''round''**  | adds rounded corners to any container with a background colour or a border (only works in modern browsers, i.e. no IE)  |
 +| **''danger''**  | creates a red danger safety note  |
 +| **''warning''**  | creates an orange warning safety note  |
 +| **''caution''**  | creates a yellow caution safety note  |
 +| **''notice''**  | creates a blue notice safety note  |
 +| **''safety''**  | creates a green safety note  |
 +^ __marks__ -- similar to [[emphasis]], [[important_paragraf]], [[importanttext]]  ||
 +| **''hi''**  | marks text as highlighted  |
 +| **''lo''**  | marks text as less significant  |
 +| **''em''**  | marks text as especially emphasised  |
 +^ __miscellaneous__  ||
 +| **''clear''**  | similar to [[clearfloat]], should preferably be used with divs, i.e. uppercase ''%%<WRAP>%%''s  |
 +| **''tabs''**  | if wrapped around a list of links, will show those as tabs  |
 +| **''hide''**  | hides the text per CSS (the text will still appear in the source code, in non-modern browsers and is searchable)  |
 +| **''noprint''**  | displays text on the screen, but not in print, similar to [[noprint]]  |
 +| **''onlyprint''**  | displays text only in print, but not on the screen  |
 +| **''pagebreak''**  | forces a new page in printouts (not visible on the screen), similar to [[pagebreak]]  |
 +| **''nopagebreak''**  | tries to avoid a pagebreak in printouts (not visible on the screen)  |
 +| **''spoiler''**  | shows white text on a white background, only to be revealed by highlighting it; similar to [[hide]]  |
 +| **''button''**  | when wrapped around a link, styles it like a button  |
 +| **''tablewidth''**  | sets widths of tables inside to whichever width the wrap gets, partly replaces [[tablewidth]]  |
 +| **''indent''**  | indents the text, could be used instead of [[tab]]  |
 +| **''outdent''**  | "outdents" the text, could partly be used instead of [[outdent]]  |
 +| **''prewrap''**  | wraps text inside pre-formatted code blocks, similar to [[wpre]]  |
 +
 +==== Indexmenu Plugin ====
 +
 +Full documentation: https://www.dokuwiki.org/plugin:indexmenu
 +
 +This plugin allows you to insert a fully customizable index or a list of pages starting from a specified namespace.
 +It should be useful in DokuWiki sites where pages are organized by [[:namespaces]].
 +Main features are:
 +  * Fully customizable with a lot of [[.:indexmenu#syntax|flexible options]], but easy to use and configure for standard needs.
 +  * Built-in support of Navigation features like highlighting the current location or dynamically displaying the tree of the current namespace.
 +  * Easily themeable with prebuilt [[.:indexmenu#JavaScript themes]].
 +  * Assign [[.:indexmenu#Namespaces title and link (headpages)]] to namespaces.
 +  * Sortable by date, title and custom metadata information.
 +  * AJAX support to speed up sites with many pages.
 +  * Customizable [[.:indexmenu#The context menu|context mouse menu]] for usual namespace/page actions.
 +  * TOC pages preview.
 +  * [[.:indexmenu#page_index|Replace]] the DokuWiki page index.
 +  * Hide namespaces/pages according to [[ACLs]] and plugin [[.indexmenu#skip_index|settings]].
 +
 +**Minimum syntax:**
 +
 +  * ''**%%{{indexmenu>.}}%%**''
 +  * ''**%%{{indexmenu>:}}%%**''
 +  * ''**%%{{indexmenu>|}}%%**''
 +
 +That means this ''**%%{{indexmenu}}%%**'' and this ''**%%{{indexmenu>}}%%**'' do not work.
 +
 +**Basic syntax usage:**
 +
 +^ Main                                                         ^ Options                                                       ^
 +| **%%{{%%indexmenu>ns[#n]** <sub>[ns1[#n] ns2[#n] ...]</sub>  | **%%|%%** //<sub>[js[#theme]] [tsort] ...</sub> //**%%}}%%**  |
 +Arguments inside ''[]'' parenthesis are optional. The ''#'' char is always required with related options.
 +
 +:!: All the syntax options can be easily accessed with the indexmenu picker in the [[:edit window]] [[:toolbar]].
 +
 +
 +=== Full syntax ===
 +
 +Settings **before the "|"** separator:
 +^Main ^Action ^Note|
 +^ //''ns''//     | //**Main namespace**// name. Index starts from here. Syntax complies with DokuWiki [[:namespaces#creating namespaces|namespaces]] paths.| "**.**" refers to the namespace of the page containing the indexmenu syntax and **not** to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) (see the **//context//** option for this feature). "**..**" or an empty value shows the root site namespace.|
 +^ //''#n''//             | **n** is a number that specifies how many namespace levels to display open under the //**main namespace**//.| If it's not defined then the whole tree, till the deeper node, will be open. If ''//0//'' or ''//1//'' it'll display only nodes under the main namespace. For example: "#2" will display "root:myns1:myns2" but will keep myns2 closed thus hiding "root:myns1:myns2:myns3". Optional.|
 +^ //''ns1[#n] %%...%% nsn[#n]''// | A list //**of optional namespaces**// inside the //**main namespace**//. Every namespace will be opened or closed at the specified //**n**// level. Syntax complies with DokuWiki [[:namespaces#creating namespaces|namespaces]].| If **n** is not defined then all namespaces are open, if ''//0//'' they are closed. "**.**" refers to the namespace of the page containing the indexmenu syntax and **not** to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) (see the **//context//** option for this feature). "**..**" or an empty value shows the root site namespace. Optional.|
 +
 +Optional settings **after the "|"** separator (separated by spaces):
 +^Option ^Action ^Note|
 +^ ''js'' \\ undo: ''nojs''          | JavaScript render method: the index is an expandable tree menu. Without the ''js'' option DokuWikis index renderer is used | Without //**n**//, all nodes are open, with it, nodes are open till //**n**// level.|
 +^ //''#theme''// \\ undo: ''#default''          | Theme name for indexmenu icons | A theme is a set of icons inside ''//images//'' directory as described in [[.:indexmenu#Theme tutorial]]. Admins can download and share themes in admin panel. It works only in //**js**// e.g. //**js#tango**// |
 +| Next options are available with or without //**js**// option. |||
 +^ ''navbar'' \\ undo: ''nonavbar''         | The tree opens itself automatically at the current page namespace. Useful in a navigation sidebar.| Without //**js**// option, the indexmenu page is never cached (just like the default DokuWiki index page) and the DokuWiki loading could be slower depending on the amount of child nodes displayed. |
 +^ ''context''  \\ undo: ''nocontext''   | [[:namespaces#creating namespaces|Relative]] //**main namespace**// and //**optional namespaces**// will refer to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) instead of to the namespace of the page containing the indexmenu syntax. Useful in a navigation sidebar.| The indexmenu page is now never cached so the DokuWiki loading could be slower depending on the amount of child nodes displayed (In //**js**// mode, when a lot of nodes are usually displayed, the //''max''// option is recommended). It automatically enable the //**nocookie**// option.|
 +^ ''tsort''   \\ undo: ''notsort'' | Sort (only) pages by title. | Useful when [[config:useheading]] is on. By default namespaces are **not** sorted, you need the **//nsort//** option for this.|
 +^ ''dsort''   \\ undo: ''nodsort''  | Sort (only) pages by date creation (first the oldest). | By default namespaces are **not** sorted, you need the **//nsort//** option for this.|
 +^ ''msort[#meta]''   \\ undo: ''nomsort''  | Sort (only) pages by a custom [[:devel:metadata]] information. Without the ''#meta'' parameter, i.e. ''msort'', it looks for the custom sorting number specified with the ''%%{{indexmenu_n>N}}%%'' syntax  (see the below [[.indexmenu#metadata tag syntax]]).\\ With ''#meta'' parameter you can refer to the [[:devel:metadata#data structure|meta data structure]] (Array values are managed through the ":" separator, for example: ''msort#date:modified''). |By default, pages without metadata tag are sorted by page name (the default DokuWiki way), but you can override this behaviour adding also the tsort or dsort option in the indexmenu syntax. By default namespaces are **not** sorted, you need the **//nsort//** option for this.|
 +^ ''hsort''   \\ undo: ''nohsort'' | Sort the headpages as defined by config setting [[config:startpage]] to the top |msort overrules hsort |
 +^ ''rsort''   \\ undo: ''norsort'' | Reverse the sorting of pages (change between ascending and descending). |By default namespaces are **not** sorted, you need the **//nsort//** option for this. |
 +^ ''nsort''   \\ undo: ''nonsort'' | Also sort namespaces according to page sort options but grouped separately. | To use in //addition// to the above sort options. tsort, dsort, msort, hsort apply only for namespaces when using [[#namespaces_title_and_link_headpages|headpages]]. rsort is applicable always together with nsort.  |
 +^ ''nons''   \\ undo: ''ns''  | Exclude namespaces nodes from index. It shows only the pages. | Without **//js//**, the closing **//n//** namespace option prevents to display nodes below the **//n//** namespace level.|
 +^ ''nopg''  \\ undo: ''pg''  | Exclude pages nodes from index. It shows only the namespaces. | All namespace nodes will link to the start pages (as defined by [[config:startpage]] setting) |
 +^ ''skipfile[+|=]/regexp/'' | Skip files matching the regexp. | ''skipfile**+**/../'' skips files defined with this regexp additional to [[#skip_files_in_index|global skip]] config. ''skipfile**=**/../'' replace the global skip config with regexp from this syntax. See the global config explanation for some regexp [[#skip_namespaces_in_index|examples]].|
 +^ ''skipns[+|=]/regexp/'' | Skip namespaces matching the regexp. | Just like skipfile, but [[#skip_namespaces_in_index|namespaces]].|
 +| Next options are //only// available with //**js**// option. |||
 +^ ''max#n//[#m]//'' \\ undo: ''nomax''  | If initially closed, the node at //**n**// level will retrieve all its child nodes through the AJAX mechanism when opened for the first time. Optionally, the nodes after the //**n**// level can be retrieved with AJAX every //**m**// sublevels instead of in one go.| It affects the server loading and speeds up the loading of pages in DokuWiki with an high amount of pages. It works only in //**js**//. Cookie are automatically disabled, just like with //**nocookie**//. |
 +^ ''maxjs#//n//''  \\ undo: ''nomaxjs''   | It sets how many js tree levels to render when page loads. Remaining nodes are rendered (slightly slower) only when they are open by users, by  //**optional namespaces**// option, by cookies or by //**navbar**// option. | Default //**n**// is 1 so that it will speed up the page loading, above all with an high amount of pages. It affects only the user-client CPU speed, not the webserver load. It works only in //**js**// |
 +^ ''id#[random|ns|//number//]''   \\ undo: ''id#random''     | [[wp>HTTP_cookie|Cookie]] Identifier for a js indexmenu where the previously opened/closed nodes by a user are stored. | Useful when a page is uncached and you like the tree state is stored in cookie. (See //**nocookie**// for disabling cookies.)  Default the option ''//id#random//'' is active, also when the option is not specified in the syntax. You can apply self a number as unique identifier for your indexmenu  ( e.g. ''//id#20//'' ) or let generate a number unique for requested namespace with ''//id#ns//''. Read the [[.:indexmenu#Js does not remember its previous state]] section. **ATTENTION:** ID must be unique for every indexmenu in your DokuWiki site or you'll get strange js behaviors. Tree state storage with cookie only in //**js**// |
 +^ ''nocookie''  \\ undo: ''cookie'' | Disable [[wp>HTTP_cookie|cookies]]. By default js indexmenu remember selected,open and closed nodes by user during navigation. With this option it doesn't remember them and the tree is blocked to its start status. | Tree state storage with cookie only in //**js**//|
 +^ ''noscroll''   \\ undo: ''scroll''    | Disable the JavaScript scrolling feature when it doesn't fit the container width. It could solve visualization problems. | It works only in //**js**//|
 +^ ''notoc''  \\ undo: ''toc''        | Disable the TOC-preview feature. | ToC preview only available in //**js**//|
 +^ ''nomenu''  \\ undo: ''menu''       | Disable the contextmenu feature. | Context menu only available in //**js**//|
 +
 +
 +=== Examples ===
 +
 +A sample of an indexmenu JS index that could be used inside a navigation sidebar. Its initial status is blocked by the nocookie option, so, when the page is reloaded, it doesn't remember the open and closed nodes by the user.:
 +<code>
 +{{indexmenu>..#1|js navbar nocookie}}
 +</code>
 +
 +JS navigation index with "thread" theme where nodes after the third level are retrieved with Ajax every 2 sublevels. Pages are sorted by title and [[.indexmenu#Metadata tag syntax|custom sort]] number:
 +<code>
 +{{indexmenu>..#1|js#thread navbar max#3#2 tsort msort}}
 +</code>
 +
 +Standard DokuWiki index showing only pages inside wiki:plugins and lower namespaces (max two levels):
 +<code>
 +{{indexmenu>:wiki:plugins#2|nons}}
 +</code>
 +
 +Js tree showing pages and namespaces both sorted by reverse title. For example,if "archive" contains stuff ("news","oldnews",etc) that you need to quickly organize by time, you could create numbered [[.:indexmenu#Namespaces title and link (headpages)|headpages]] for every namespace (i.e renaming "oldnews" in "news 2006", "news" in "news 2010" and so on) and sort them from new to older:
 +<code>
 +{{indexmenu>:archive#1|js tsort nsort rsort}}
 +</code>
 +
 +Standard index showing the tree of the current context ((the namespace of the page displayed by a user who is navigating your site)) opened at the second level .
 +<code>
 +{{indexmenu>playground#2|context}}
 +</code>
 +
 +Show all current namespace pages .
 +<code>
 +{{indexmenu>.:#1|context}}
 +</code>
 +
 +JS tree showing all (and only) the namespaces of the "private" namespace sorted by date creation. "private" is relative and refers to the private namespace under the page containing the indexmenu syntax.
 +<code>
 +{{indexmenu>private|js nopg dsort}}
 +</code>
 +
 +=== Metadata tag syntax ===
 +
 +By default nodes on the same tree level are sorted by name (or by title/date if you use the tsort/dsort syntax), but you can also specify a custom sort number for every page inserting a metadata tag in the pages with this syntax:
 +<code>
 +{{indexmenu_n>N}}
 +</code>
 +
 +Where ''N'' is a number.
 +Then you need to use the "msort" option in your indexmenu tree syntax.
 +If you have the ''show_sort'' option enabled in the Configuration Manager, a notice is displayed to admins (only) on every page with this metadata tag (the text defaults to "Indexmenu sort number: N").
 +
 +**Examples:**
 +
 +You can change the order of this tree containing a mix of standard and [[config:useheading]] pages:
 +
 +<file>
 +-Root
 +  |_don
 +  |_Mirror sessions         (headline title of the ":mirror" page)
 +  |_pachuco
 +  |_At the radar station    (headline title of the ":radar" page)
 +  |_van
 +  |_vliet
 +</file>
 +
 +in this way:
 +<code>
 +{{indexmenu>..#1|msort}}
 +</code>
 +<file>
 +-Root
 +  |_vliet                   {{indexmenu_n>1}}
 +  |_van                     {{indexmenu_n>2}}
 +  |_don                     {{indexmenu_n>3}}
 +  |_Mirror sessions         (headline title of the ":mirror" page)
 +  |_pachuco
 +  |_At the radar station    (headline title of the ":radar" page)
 +</file>
 +
 +Pages without sort number, like the last three pages, are sorted by page name as default, but you can force a different sort:
 +<code>
 +{{indexmenu>..#1|tsort msort}}
 +</code>
 +<file>
 +-Root
 +  |_vliet                   {{indexmenu_n>1}}
 +  |_van                     {{indexmenu_n>2}}
 +  |_don                     {{indexmenu_n>3}}
 +  |_At the radar station    (headline title of the ":radar" page)
 +  |_Mirror sessions         (headline title of the ":mirror" page)
 +  |_pachuco
 +</file>
 +
 +
 +==== Video Share Plugin ====
 +
 +Full documentation: https://www.dokuwiki.org/plugin:vshare
 +
 +This plugin allows you to embed video players from various video sharing sites. New services can be added by just editing a config file. This is **not** for displaying local video files.
 +
 +=== Usage/Syntax ===
 +
 +The basic syntax looks like this: ''%%{{%%//videosite//>//videoid//?//parameter1&parameter2//|title%%}}%%''
 +  * Where ''//videosite//'' is one of the identifiers listed in [[#Supported Services]] chapter
 +  * and ''//videoid//'' is the identifier of the video at the respective site
 +  * The ''//parameters//'' are optional. You start these with a ''?'' and separate more of them by a ''&''. Look in [[#Parameters]] chapter
 +  * The title is optional as well. Look in [[#Examples]] chapter
 +  * The video can be aligned by adding spaces on the left or right inside the curly brackets (like in the image syntax). Look in [[#Examples]] chapter
 +
 +A toolbar button pops up a prompt where you can simply paste the full URL to the page of the video you want to embed. The plugin will then try to figure out the video ID by itself. For some services you may need to paste a special URL. See the table below.
 +
 +=== Parameters ===
 +
 +When embedding a video you should add a size parameter.
 +
 +You can either give it in the form:
 +
 +    * ''//width//x//height//'' like ''500x300''
 +    * or use the keywords ''small'', ''medium'' or ''large''
 +    * you can also use the keywords ''full'' or ''half'' to have the video adjust to the available screen width (either 100% or 50% width)
 +
 +
 +All additional parameters will be passed on as-is to the video service. Refer to their documentation for what is available. There are also hints in the table below.
 +
 +=== Examples ===
 +
 +Display a YouTube Video:
 +
 +  {{youtube>L-WM8YxwqEU}}
 +
 +Show a larger player:
 +
 +  {{youtube>L-WM8YxwqEU?large}}
 +
 +Right-align the player:
 +
 +  {{ youtube>L-WM8YxwqEU}}
 +
 +Show a small, centered player:
 +
 +  {{ youtube>L-WM8YxwqEU?small }}
 +
 +Show a small, centered player with a title (look for right space!):
 +
 +  {{ youtube>L-WM8YxwqEU?small |Some funny video}}
 +
 +Some other additional parameters are supported (depending on video service) as well:
 +
 +  {{youtube>L-WM8YxwqEU?small&start=30&end=45|A random segment of 15 seconds}}
 +
 +=== Supported Services ===
 +
 +Copy paste the video url in the toolbar pop-up prompt to generate the syntax
 +^ Identifier   ^ Website                                        ^ Comments                         ^ Supported parameters       ^
 +| youtube      | [[https://www.youtube.com/|YouTube]]           |                                  | start, end, rel, autoplay  |
 +| vimeo        | [[https://www.vimeo.com/|Vimeo]]               |                                  | autoplay                   |
 +| slideshare   | [[https://www.slideshare.com|Slideshare]]      | paste the Wordpress shortcode    | startSlide                 |
 +| dailymotion  | [[https://www.dailymotion.com/|Daily Motion]]  |                                  | start                      |
 +| twitchtv     | [[https://www.twitch.tv|Twitch.tv]]            |                                  | chapter_id, initial_time   |
 +| archiveorg   | [[https://archive.org/|Archive.org]]           |                                  |                            |
 +| soundcloud   | [[https://soundcloud.com|SoundCloud]]          |                                  |                            |
 +| niconico     | [[https://www.nicovideo.jp|NicoNico]]          |                                  |                            |
 +| break        | [[https://www.break.com|Break]]                |                                  |                            |
 +| bitchute     | [[https://www.bitchute.com|BitChute]]          |                                  |                            |
 +| coub         | [[https://coub.com|Coub]]                      |                                  |                            |
 +| odysee       | [[https://odysee.com/|Odysee LBRY]]            | paste the embed or download URL  |                            |
 +| youku        | [[https://youku.com|Youku]]                    | unclear if working               |                            |
 +| bilibili     | [[https://www.bilibili.com|bili bili]]         |                                  |                            |
 +| msoffice     |                                                | unclear if working               |                            |
 +| msstream     |                                                | unclear if working               |                            |
 +
 +==== Include Plugin ====
 +
 +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.
 +
 +=== Examples ===
 +
 +''%%{{page>wiki:syntax#Tables}}%%'' will include the section about tables of the syntax page.
 +
 +''%%{{namespace>project_foo}}%%'' will include all pages in the ''project_foo'' namespace.
 +
 +''%%{{page>blog:mypage&tags&comments}}%%'' will include the page ''blog:mypage'' and show the tags from the [[tag]] plugin and the number of comments from the [[discussion]] plugin. Both plugins need to be installed for this example.
 +
 +''%%{{tagtopic>testtag}}%%'' will include all pages with the tag ''testtag'', the [[tag]] plugin needs to be installed for this example.
 +
 +=== Syntax ===
 +
 +Simply enclose the ID of the page to be included in double curly brackets:
 +
 +  {{page>[id]&[flags]}}
 +  {{section>[id]#[section]&[flags]}}
 +  {{namespace>[namespace]#[section]&[flags]}}
 +  {{tagtopic>[tag]&[flags]}}
 +
 +^ [id] | page ID of the page to include; some [[#macros]] are possible; shortcuts are resolved ('':'', ''.'', ''..'') | required |
 +^ [section] | limits the included page to a specific section and its subsections | optional; default is the whole page , this can be used with namespace (if matches)|
 +^ [tag]|include pages with tag topic tag, requires [[plugin:tag]] |required |
 +^ [flags] | flags delimited by ''&'', see [[#Configuration and Flags|flags]] | optional |
 +
 +The plugin offers four syntaxes, ''%%{{page>...}}%%'' , ''%%{{section>...}}%%'' , ''%%{{namespace>...}}%%'' and ''%%{{tagtopic>...}}%%''.
 +
 +Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces. Tagtopic includes all pages with a ''tagtopic'' ''tag''.
 +
 +=== Configuration and Flags ===
 +
 +The plugin can be configured in the DokuWiki configuration manager available in the admin menu. These settings also affect the [[plugin:blog]] 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.
 +
 +^ Configuration option  ^ Flags                                                            ^ Description                                                                                                                                                                                                                                                                                                                                                                      ^
 +^ ''noheader''          | ''noheader''/ (''show'')''header''                               | Don't display the header of the inserted section                                                                                                                                                                                                                                                                                                                                 |
 +^ ''firstseconly''      | ''firstsec''(''tion'')''only''/ ''fullpage''                     | Display only the first section of the included page                                                                                                                                                                                                                                                                                                                              |
 +^ ''readmore''          | ''readmore''/''noreadmore''                                      | Show "read more" link in case of firstsection only                                                                                                                                                                                                                                                                                                                               |
 +^ ''showtaglogos''      | -                                                                | Show/hide an image for the first tag (if the page has tags)                                                                                                                                                                                                                                                                                                                      |
 +^ ''showfooter''        | ''footer''/''nofooter''                                          | Show/hide page footer below the included page                                                                                                                                                                                                                                                                                                                                    |
 +^ ''showlink''          | ''link''/''nolink''                                              | Makes the first headline of a included page/section a link to the included page/section                                                                                                                                                                                                                                                                                          |
 +^ ''showpermalink''     | ''permalink''/ ''nopermalink''                                   | Show/hide a permalink to the included page in the page footer                                                                                                                                                                                                                                                                                                                    |
 +^ ''showdate''          | ''date''/''nodate''                                              | Show/hide creation date of the page in the page footer                                                                                                                                                                                                                                                                                                                           |
 +^ ''showmdate''         | ''mdate''/''nomdate''                                            | Show/hide modification date of the page in the page footer                                                                                                                                                                                                                                                                                                                       |
 +^ ''showuser''          | ''user''/''nouser''                                              | Show/hide user name of the page creator in the page footer                                                                                                                                                                                                                                                                                                                       |
 +^ ''showcomments''      | ''comments''/''nocomments''                                      | Show/hide number of comments in the page footer (requires the [[plugin:discussion]] plugin)                                                                                                                                                                                                                                                                                      |
 +^ ''showlinkbacks''     | ''linkbacks''/''nolinkbacks''                                    | Show/hide number of linkbacks in the page footer (requires the [[plugin:linkback|linkback]] or [[plugin:backlinks2]] plugin)                                                                                                                                                                                                                                                     |
 +^ ''showtags''          | ''tags''/''notags''                                              | Show/hide tags in the page footer (requires the [[plugin:tag]] plugin)                                                                                                                                                                                                                                                                                                           |
 +^ ''showeditbtn''       | ''editbtn'' or ''editbutton''/''noeditbtn'' or ''noeditbutton''  | Show/hide edit buttons (section edit buttons, edit button below the included page)                                                                                                                                                                                                                                                                                               |
 +^ ''doredirect''        | ''redirect''/''noredirect''                                      | Redirect back to original page after an edit                                                                                                                                                                                                                                                                                                                                     |
 +^ ''usernamespace''     | -                                                                | Namespace for user pages (see ''showuser'' configuration) (default ''user'')                                                                                                                                                                                                                                                                                                     |
 +^ ''doindent''          | ''indent''/''noindent''                                          | Indent included pages relative to the section of the page they get included in                                                                                                                                                                                                                                                                                                   |
 +^ ''linkonly''          | ''linkonly''/''nolinkonly'' or ''include_content''               | Display only a link instead of the whole page content                                                                                                                                                                                                                                                                                                                            |
 +^ '' title''            | ''title''/''notitle''                                            | Show the title instead of the page id                                                                                                                                                                                                                                                                                                                                            |
 +^ ''pageexists''        | ''pageexists''/ ''nopageexists''                                 | Only list page ids of existing pages (see ''existlink'')                                                                                                                                                                                                                                                                                                                         |
 +^ -                     | ''existlink''                                                    | Display a link and do so only if page page-id exists (combination of ''linkonly'' and ''pageexists'')                                                                                                                                                                                                                                                                            |
 +^ ''parlink''           | ''parlink''/''noparlink''                                        | (Don't) put the link into a paragraph environment (for inline lists)                                                                                                                                                                                                                                                                                                             |
 +^ ''order''             | ''order=OPTION''                                                 | Ordering criteria for namespace includes, possible options: page ID (''id''), title (''title''), date created (''created''), date modified (''modified''), [[plugin:indexmenu#metadata_tag_syntax|indexmenu sort order]] (''indexmenu''), custom sort order using the ''%%{{include_n>[number]}}%%'' on the pages that are included similar to the indexmenu tags (''custom'').  |
 +^ ''rsort''             | ''rsort''/''sort''                                               | Reverse the sort order in namespace includes.                                                                                                                                                                                                                                                                                                                                    |
 +^ ''depth''             | ''depth=DEPTH''                                                  | The maximum depth of subnamespaces of which pages are included in namespace includes, default is ''1'' for only the specified namespace, ''0'' is for unlimited depth.                                                                                                                                                                                                           |
 +^ -                     | ''inline''                                                       | 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.                                                                                                                                                                                       |
 +^ -                     | ''beforeeach=ENTITY''/ ''aftereach=ENTITY''                      | Display an [[:entities|entity]] before/after each included page. The entity is printed outside the section/include environment, this is mainly for adding custom HTML code (when the text isn't recognized as entity it is directly displayed but escaped so you can't directly use HTML code here).                                                                             |
 +^ ''safeindex''         | -                                                                | 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.                                                                                                                    |
 +^ -                     | ''exclude=/REGEX/''                                              | Regular expression to exclude certain pages, will match on full page ID. E.g. to exclude ''ns:page_name'' use ''/ns:page_name/'' as value. Use a [[https://regex101.com/|regex tester]] to debug complicated patterns.                                                                                                                                                           |
 +
 +Examples:
 +
 +  {{page>concept&firstseconly&footer}}
 +  {{page>mypage&noindent}}
 +  {{namespace>myns&order=modified}}
 +  {{namespace>myns&exclude=/myns:subns:.+|myns:page/}}
 +
 +=== Macros ===
 +
 +Simple macros are possible to serve a page on a per user or per date base. These are:
 +
 +^ @USER@  | username |
 +^ @NAME@  | full name of user |
 +^ @GROUP@ | first group the user belongs to |
 +^ @YEAR@  | 4-digit year |
 +^ @MONTH@ | 2-digit month |
 +^@WEEK@ |2-digit ISO week number |
 +^ @DAY@   | 2-digit day |
 +^ @DATE<expr>@ | use a calculated date instead of today in date macros |
 +
 +<expr> in **''@DATE<expr>@''** can be one of:
 +
 +^ PYEAR | previous year |
 +^ NYEAR | next year |
 +^ PMONTH | previous month |
 +^ NMONTH | next month |
 +^ PWEEK | previous week |
 +^ NWEEK | next week |
 +^ YESTERDAY | yesterday's date |
 +^ TOMORROW | tomorrow's date |
 +
 +Examples:
 +
 +  {{page>@MONTH@:@DAY@:birthdays}}
 +includes the page ''birthdays'' in namespace <month>:<day>: eg. ''10:15: birthdays'' for the 15th of october.
 +
 +  {{page>@USER@:message}}
 +includes the page ''message'' from the namespace <user> of the logged in user
 +
 +  {{page>foo@DATENWEEK@@YEAR@:@WEEK@}}
 +includes the page <weekno> from the namespace ''foo<year>'' with next week's date  e.g.  foo2012:01 for the 27th of december 2011
 +
 +==== (To)Do Plugin ====
 +
 +The do plugin allows users to create simple tasks in wiki pages. Those tasks may be assigned to other users and have a due date. Tasks can be listed in pages as well. 
 +
 +=== Syntax ===
 +
 +There are two syntax elements.
 +
 +== Task ==
 +
 +  <do USER DATE>TEXT</do>
 +
 +Create a new task TEXT, optionally assign it to USER or mark it as due on DATE; there is a toolbar button for this as well.
 +
 +
 +^ Part  ^ Details                                                                                              ^
 +| USER  | User id as accepted by current authentication backend                                                |
 +| DATE  | Date in format ''yyyy-mm-dd''                                                                        |
 +| TEXT  | Description of task. Task texts needs to be **unique at a page**. Duplicates are seen as same task.  |
 +
 +== Listing ==
 +
 +  {{dolist>NAMESPACE?id=ID&status=(DONE|UNDONE)&limit=COUNT&md5=MD5&user=ASSIGNEE&creator=CREATOR&from=YYYY-MM-DD&to=YYYY-MM-DD}}
 +
 +List tasks in NAMESPACE with optional additional filtering
 +
 +^Part        ^Details ^
 +|NAMESPACE   |Namespace to search for tasks |
 +|''id''      |Page to search for tasks |
 +|''status''  |Can have value ''DONE'' or ''UNDONE''. Case insensitive. |
 +|''limit''   |Maximum number of items to display.  |
 +|''md5''     |Show only task with this MD5 value|
 +|''user''    |User id of assigned person or ''@USER@''|
 +|''creator'' |User id of creator |
 +|''from''    | Date YYYY-MM-DD |
 +|''to''      | Date YYYY-MM-DD |