Differences

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

--- plugin:footer [2020-10-07 08:11] – juergen-aus-zuendorf
+++ plugin:footer [2023-12-27 12:57] (current) – Jack Jackrum 77.3.121.168
@@ Line 6: / Line 6: @@
 email      : H-J-Schuemmer@Web.de
 type       : syntax
-lastupdate : 2020-10-06
+lastupdate : 2020-12-17
-compatible : Frusterick Manners, Greebo, Hogfather
+compatible : Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum
 depends    :
 conflicts  :
@@ Line 13: / Line 13: @@
 tags       : header, footer, annotations, embed, include, template
-downloadurl: https://github.com/Juergen-aus-Zuendorf/dokuwiki-plugin-footer/archive/V20201006.2.zip
+downloadurl: https://github.com/Juergen-aus-Zuendorf/dokuwiki-plugin-footer/archive/main.zip
 bugtracker : https://github.com/Juergen-aus-Zuendorf/dokuwiki-plugin-footer/issues
 sourcerepo : https://github.com/Juergen-aus-Zuendorf/dokuwiki-plugin-footer
 donationurl:
-screenshot_img : [[https://github.com/Juergen-aus-Zuendorf/dokuwiki-plugin-footer/blob/main/example%20for%20footer%20plugin.png]]
+screenshot_img : https://raw.githubusercontent.com/Juergen-aus-Zuendorf/dokuwiki-plugin-footer/main/footer01.png
 ----
@@ Line 38: / Line 38: @@
 And to add footer text to pages in the namespace directory and its subdirectories create a file named ''%%__%%footer.txt'' in the namespace directory.
-Files beginning with "%%_%%" cannot be created or changed within dokuwiki. Instead you have to create a file and upload it into the wanted namespace. If you don't want this behaviour and you want to maintain data from within dokuwiki you have to define prefixes in the plugin settings, e.g. "hf" and "hfu". In this case you have to create the pages ''hf_footer'' and ''hfu_footer'' in the namespace directory.
+Files beginning with "%%_%%" cannot be created or changed within DokuWiki. Instead, you have to create a file and upload it into the wanted namespace. If you don't want this behavior and you want to maintain data from within DokuWiki you have to define prefixes in the plugin settings, e.g. "hf" and "hfu". In this case, you have to create the pages ''hf_footer'' and ''hfu_footer'' in the namespace directory.
 ==== Additional syntax ====
-To avoid a certain page from the footer template (e.g. the start page) you can insert the command ''%%~~NOFOOTER~~%%'' to the content of this page.
+To avoid a certain page from the footer template (e.g. the start page) you can insert this special command
+  ~~NOFOOTER~~
+to the content of this page. Please note that this command is only replaced from the page text if there is a footer template exactly for the namespace of this page.
+==== Example ====
+{{https://raw.githubusercontent.com/Juergen-aus-Zuendorf/dokuwiki-plugin-footer/main/footer01.png}}
+The screenshot above shows this syntax:
+a) The content of the page "mynamespace:example" is:
+<code>
+====== Example ======
+This is an example of the footer plugin.\\
+Up to the line you see the text of the Wiki page.
+----
+</code>
+b) The content of the page "mynamespace:_footer" in the same namespace is:
+<code>
+And below the line comes the footer text :-D
+</code>
+This footer text is shown on each page of the namespace "mynamespace".
 ==== Some tips ====
@@ Line 54: / Line 80: @@
 Why don't my pages react with this plugin?
   * The most common reason is that due to the page cache, your page will delay to correctly display the newest version. A convenient way is that closing the plugin in plugin management and reopen it again. It'll refresh the cache. Another way to refresh a page is to add the parameter purge to the URL. Example:<code>http://www.example.com/namespace/page?purge=true</code>
+  * Or use [[plugin:toucher|Toucher Plugin]]
   * Be sure that your pages and ''%%_%%footer.txt'' are in the same level directory.
-  * If the content of a page ends with special syntax e.g. with a table, put a linebreak at the beginning of the footer template to avoid corrupting this syntax.
+  * If the content of a page ends with special syntax e.g. with a table (no return after the table), put a linebreak at the beginning of the footer template to avoid corrupting this syntax.
 ===== Configuration and Settings =====
-The default behaviour is managed by the wiki admin through the [[#configuration_settings|Configuration Settings]].
+The default behavior is managed by the wiki admin through the [[#configuration_settings|Configuration Settings]].
 ^ Name  ^  Value  ^  Description  ^
-^ separation  | paragraph  |(default) using a blank line as a split between the origin text and header/footer text.(it means new paragraph).|
+^ separation  | paragraph  |(default) using a blank line as a split between the original text and header/footer text. (it means a new paragraph).|
-^ :::  | nothing  | using nothing as split, which means you have to deal with the border between the origin text and header/footer text.|
+^ :::  | nothing  | using nothing as split, which means you have to deal with the border between the original text and header/footer text.|
 ^ prefix namespace  |  | Prefix for the footer template of the current namespace  |
 ^ prefix subnamespace  |  | Prefix for the footer template of the sub-namespaces     |
@@ Line 73: / Line 99: @@
 ==== Previous versions ====
-The footer plugin is a clone of the [[headerfooter]] plugin which isn't maintained since a long time. It also includes the enhancements of [[https://github.com/masakik/headerfooter2|HeaderFooter2]]. But there are some special aspects to this:
+The footer plugin is a clone of the [[headerfooter]] plugin which isn't maintained for a long time. It also includes the enhancements of [[https://github.com/masakik/headerfooter2|HeaderFooter2]]. But there are some special aspects to this:
-  * The header functionality of the original plugin is no longer supported because it breaks the section editing. If someone has an idea how to enhance that feel free to add this function again.
+  * The header functionality of the original plugin is no longer supported because it breaks the section editing. If someone has an idea of how to enhance that feel free to add this function again.
   * Now there is a possibility to define a prefix for the footer templates.
   * You can exclude special pages with the command ''%%~~NOFOOTER~~%%''
@@ Line 83: / Line 109: @@
   * **2020-10-06**
     * Initial release, copied from [[headerfooter]] plugin with its forks
+  * **2020-12-17**
+    * Improved cache handling (I hope it's sufficient now)