DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:tplinc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:tplinc [2018-05-27 00:36] – [Installation] Klap-inplugin:tplinc [2024-01-08 15:54] (current) Aleksandr
Line 6: Line 6:
 email      : dokuwiki@cosmocode.de  email      : dokuwiki@cosmocode.de 
 type       : admin, helper type       : admin, helper
-lastupdate : 2017-03-28+lastupdate : 2023-01-03
 compatible : Greebo compatible : Greebo
 depends    :  depends    : 
Line 21: Line 21:
 ---- ----
  
-[[http://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]+[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
  
 This plugin allows template authors to define areas in the template where additional content can be included. Users of that template can then use this plugin to define which logic should be used to determine the content (pages) that should be included depending on the current page. This plugin allows template authors to define areas in the template where additional content can be included. Users of that template can then use this plugin to define which logic should be used to determine the content (pages) that should be included depending on the current page.
Line 29: Line 29:
 ===== Installation ===== ===== Installation =====
  
-Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 :!: The plugin needs a suitable template to provide hooks to which it can include the pages! So far, the following templates include such hooks: :!: The plugin needs a suitable template to provide hooks to which it can include the pages! So far, the following templates include such hooks:
 +
   * [[template:sprintdoc]]   * [[template:sprintdoc]]
 +
 +You can use this plugin with templates that use traditional include hooks, by calling the plugin from within those hook files. For the [[template:dokuwiki|DokuWiki Template]] you can simply use the hookfiles distributed with this plugin. To do so copy all the files within the ''dokuwiki'' directory of this plugin to your wiki's ''conf'' directory. This will make all the [[template:dokuwiki#supported Include Hooks]] available as hooks within this plugin.
 +
 +  cp lib/plugins/tplinc/dokuwiki/* conf/
  
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
Line 42: Line 47:
   * **Location** -- this is where the page will be shown in the template, the available areas are set by the used template   * **Location** -- this is where the page will be shown in the template, the available areas are set by the used template
   * **Skip ACL** -- unless this box is ticked, only page the current user may read are included   * **Skip ACL** -- unless this box is ticked, only page the current user may read are included
- 
  
 As pattern you can use the following: As pattern you can use the following:
Line 61: Line 65:
 ==== Announcing available Include Locations ==== ==== Announcing available Include Locations ====
  
-You need to announce which locations are available in your template by registering a ''BEFORE'' handler for the ''PLUGIN_TPLINC_LOCATIONS_SET''. The ''$event->data'' is an associative array with location identifiers and their user readable descriptions.+You need to announce which locations are available in your template by registering a ''BEFORE'' handler for the ''PLUGIN_TPLINC_LOCATIONS_SET''. The ''%%$event->data%%'' is an associative array with location identifiers and their user readable descriptions.
  
 Please refer to [[devel:action_plugins|Action Plugins]] to learn more. Please refer to [[devel:action_plugins|Action Plugins]] to learn more.
Line 114: Line 118:
 **Releases:** **Releases:**
 {{rss>https://github.com/cosmocode/dokuwiki-plugin-tplinc/releases.atom description author}} {{rss>https://github.com/cosmocode/dokuwiki-plugin-tplinc/releases.atom description author}}
- 
- 
  
  
plugin/tplinc.1527374176.txt.gz · Last modified: 2018-05-27 00:36 by Klap-in

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki