Differences

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

--- plugin:template-fine-tune [2017-07-04 13:19] – turnermm
+++ plugin:template-fine-tune [2018-05-06 22:51] (current) – Klap-in
@@ Line 3: / Line 3: @@
 ---- plugin ----
 description: Modify template features based on acl, ip addresses, days of week.  Features include page and site tools, logos, taglines, wiki titles.
-author     :  Myron Turner
+author     : Myron Turner
-email      :  turnermm02@shaw/ca
+email      : turnermm02@shaw/ca
-type       : action
+type       :
-lastupdate : 2017-07-03
+lastupdate : 2017-07-04
-compatible : Frusterick Manners
+compatible :
 depends    :
 conflicts  :
 similar    :
-tags       : template,tools,title,logo,tagline
+tags       : !obsolete
-downloadurl: https://github.com/turnermm/tmplft/archive/master.zip
+downloadurl: #https://github.com/turnermm/tmplft/archive/master.zip
-bugtracker : https://github.com/turnermm/tmplft/issues
+bugtracker : #https://github.com/turnermm/tmplft/issues
-sourcerepo : https://github.com/turnermm/tmplft
+sourcerepo : #https://github.com/turnermm/tmplft
 donationurl:
@@ Line 24: / Line 24: @@
 ===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+This plugin has been renamed [[plugin:tplmod]]
-====== Usage ======
-This plugin enables you to modify the Dokuwiki template based on IP address, ACL level of the user, and day of the week. The wiki logo (image), tagline, and the wiki name can be rotated by day or changed based on the IP address of the user.  The links and buttons at top ((Site tools)) and side ((Page tools)) of the template can be changed based on the ACL level of the user.
-=== Some rationales ===
-Being able to make these kinds of changes based on IP address makes it possible to run a site which caters to more than one entity and to give each one its own tools, logo, etc.  Changing by date makes it possible to freshen the appearance of a page for repeat visitors.  The ability to restrict the kinds of tools users have access to can have use for sites that want to fine-tune access.
-===== Logo and Lists =====
-==== Rotating the logo ====
-When the logo image is rotated by the plugin, it is in effect replacing the default logo image.  This will be found in one of three directories, as specified here: [[template:dokuwiki#changing_the_logo]]. Your own replacement images will be assumed to be in the same directory as the default logo.  When the template loads the default logo, it also specifies the width of the image. Therefore, if your image is a different size from the default, then you will want to specify its width.  The replacement images are specified in the Configuration Options as a comma-separated list of the image names with the widths separated from the the name by a space:
-    img1.png 64,img2.png 128,img3.png 256,img4.png, . . .
-The images must be listed in the order in which they will be accessed.  That is, if you choose to rotate them by days of the week, then the first image must be the Sunday image, the second Monday, etc.   If you do not have enough images for the seven days, then the first image (Sunday) will act as the replacement.  The same principle holds true if you are rotating the logos by IP address.  The images and the IP addresses must be listed in the same order as you want them accessed.  If there are more IP addresses than images, then the first image in your list will be used.
-There is a transparent //logo.png// included in the distribution.  Using that as your default logo will eliminate the momentary lag between the appearance of the default image and its replacement.
-==== Rotating Tag Lines and Wiki Names====
-The same principle for rotation applies to rotating tag lines and wiki names, as described above for the logos.  The lists of tag lines and wiki names must be in the order in which you want them accessed by either date or IP address. Sunday will access the first tag line or wiki name, the first IP address in your list or IPs will access the first tag line or wiki name.  The default replacement tag or name will be the first in its list.
-In order to implement tagline replacement, you have to set a Dokuwiki [[config:tagline]] in Dokuwiki's configuration settings. The //template-fine-tune// plugin supports one level of HTML markup.  For instance, you can set the Configuration tagline as ''<b>My thoughts about things</b>'' and the plugin will leave the HTML in place and replace "My thoughts about things" with a new tagline.  You could in fact set the Configuration tagline as follows: ''<b></b>'', then all of the taglines will automatically be bold.
-===== ACL controls =====
-There are two major groups of template tools, treated as groups in the Configuration Manager, and two additional tools treated individually:
-  - The **Site tools**. These appear at the top of the Dokuwiki template and include Recent Changes, Media Manager, and Sitemap.
-  -  The **Page tools**.  These are displayed as icons at the right of the template and include Edit, Old Revisions, Backlinks, and Subscribe.
-  - User Profile
-  - Search Box
-If a user is not eligible to use a tool, the tool will not be displayed.
-You control access to these tools by selecting from the Configuration Manager which of these tools you want to control and by setting the cut-off ACL level using the ''acl_all'' configuration option.  If, for instance, you set ''acl_all'' at ''EDIT'' then users with ACL of ''EDIT'' or lower will not have access to the selected tools.  For tools which are not included in the Dokuwiki core and appear in the Page tools, you can add them to the Page tools input box in the form of a key word from the url of the tool.  For example, in the case of the [[plugin:overlay]], entering the word ''overlay'' in the input box would prevent the overlay window from appearing to users who do not have access.
-==== Page Tools 'All' Setting ====
-If the Page tools ''All'' option is selected, then all page tools will be hidden from users who fall under the ''acl_all'' setting.  If, however, you would like to exclude certain core tools from this blanket prohibition, you do this using the ''ptools_xcl'' option.
-===== Configuration and Settings =====
-^ Option        ^ Description                                                                                                                                                                                                                                                                               ^
-| logos         | Comma separated list of image names for home page logo: names only, not paths                                                                                                                                                                                                             |
-| ips           | Comma separated list of IPs for rotation by IP. Rotations follow sequence of IPs                                                                                                                                                                                                          |
-| sitetools     | **Site Tools** \\ Remove the selected site tools. In the Dokuwiki template Site Tools are located at the top of the template.                                                                                                                                                             |
-| pagetools     | **Page Tools** \\ Remove the selected page tools. In the Dokuwiki template these are located along the right-hand side of the template.  You can remove non-standard tools, using the input box:  enter them as a comma separated list of unique words from their query strings or urls.  |
-| profile       | Remove User Profile link                                                                                                                                                                                                                                                                  |
-| search        | Remove Search box                                                                                                                                                                                                                                                                         |
-| taglines      | Comma separated list of taglines                                                                                                                                                                                                                                                          |
-| acl_all       | The acl level at which sitetoools and pagetools removals take effect.                                                                                                                                                                                                                     |
-| dateorip      | Rotate logos, tag lines, and wiki names  by ip address or days of the week. Select  ''NEITHER'' if you do not want rotation.                                                                                                                                                              |
-| rotatewhich   | If rotating the logo and/or tagline, select which to rotate. You have a choice of NONE, LOGO,TAG, BOTH.                                                                                                                                                                                   |
-| ptools_xcl    | If pagetools is set to ''All'', you can retain selected tools by entering  a comma separated list of unique words from their urls in this text box                                                                                                                                        |
-| rotate_title  | Rotate the wiki name (title)                                                                                                                                                                                                                                                              |
-| wiki_names    | Comma separated list of wiki names                                                                                                                                                                                                                                                        |
-===== Development =====