====== Include-Plugin ======

This content is copied from [[http://www.dokuwiki.org/plugin:include]].

===== Description =====

This is a handy [[http://www.dokuwiki.org/plugin:plugins|plugin]] with which you can include another wiki page into the current one.

===== Syntax =====

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

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

^ [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 |
^ [flags] | flags delimited by ''&'', see [[#flags]] | optional |

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

Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces((This syntax is considered experimental!)).

===== Configuration =====
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.

^ ''noheader'' | Don't display the header of the inserted section |
^ ''firstseconly'' | Display only the first section of the included page |
^ ''showtaglogos'' | Show/hide an image for the first tag (if the page has tags) |
^ ''showfooter'' | Show/hide page footer below the included page |
^ ''showlink'' | Makes the first headline of a included page/section a link to the included page/section |
^ ''showpermalink'' | Show/hide a permalink to the included page in the page footer |
^ ''showdate'' | Show/hide creation date of the page in the page footer |
^ ''showuser'' | Show/hide user name of the page creator in the page footer |
^ ''showcomments'' | Show/hide number of comments in the page footer (requires the [[plugin:discussion]] plugin) |
^ ''showlinkbacks'' | Show/hide number of linkbacks in the page footer (requires the [[http://foosel.org/snippets/dokuwiki/linkback|linkback]] or [[plugin:backlinks2]] plugin) |
^ ''showtags'' | Show/hide tags in the page footer (requires the [[plugin:tag]] plugin) |
^ ''showeditbtn'' | Show/hide edit button below the included page |
^ ''usernamespace'' | Namespace for user pages (see ''showuser'' configuration) (default ''user'') |

===== 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 |
^ @DAY@   | 2-digit day |

Examples:

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

===== Flags =====

You may use flags to override default all configuration settings:

^ Setting ^ Default ^^ Alternative ^^
| ''firstseconly'' ^ ''fullpage'' | includes the whole page ^ ''firstseconly'' | includes only the first section of a wiki page |
| ''showfooter'' ^ ''footer'' | shows a footer below the page with info about the included page ^ ''nofooter'' | hides the page info footer |
| ''showeditbtn'' ^ ''editbtn'' | shows a button to edit (or create) the included page ^ ''noeditbtn'' | hides the edit (or create) button |
| etc | etc | etc ^ ''noheader'' | strips the title from the included page |

Example:

  {{page>concept&firstseconly&footer}}