Differences

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

--- blog:dokuwiki [2020/01/06 13:51]
tom [Abbreviations]
+++ blog:dokuwiki [2020/01/13 23:25]
tom [DokuWiki Tips]
@@ Line 1: / Line 1: @@
 ====== DokuWiki ======
-This blog was created using [[http://dokuwiki.org|DokuWiki]]
+This blog was created using [[doku>|DokuWiki]] (DW).
 ----
 ===== DokuWiki Tips =====
-==== Admin Tips ====
+=== Cache ===
+  * Adding [&|?]purge=true to the end of a DokuWiki URL will refresh the DW cache. This is often needed to make the page recognize a recent change to a wiki setting.
+  * Saving the Configuration Settings page (at yourwiki.com/doku.php?id=doku.php&do=admin&page=config) will also refresh the DW cache.
 === Comments ===
-  * If you include the [[https://www.dokuwiki.org/plugin:comment|comment]] plugin in your wiki, then you can create "documentation" that only editors can see. For example, my sidebar has this wiki markup:
+  * If you include the [[doku>plugin:comment|comment]] plugin in your wiki, then you can create "documentation" that only editors can see. For example, my sidebar has this wiki markup:
-<code>{{indexmenu>:#2|js#wb.png navbar skipns=/wiki|playground/ skipfile=/sidebar|topbar/}}
+<code>/* https://www.dokuwiki.org/plugin:indexmenu */</code>
-/* https://www.dokuwiki.org/plugin:indexmenu */</code>
 The comment links to the documentation for the plugin. I will only see the comment while editing the page.
-==== Cache ====
+=== Dark Themes ===
-  * adding [&|?]purge=true to the end of a DokuWiki URL will refresh the DW cache
+I like dark themes. Please note that a theme is not the same thing as a template. A theme only changes the colors of a website. A template changes the look and feel (the <abbr title="User Interface">UI</abbr>), and may include several themes to choose from.
-==== Groups, Creating User Groups ====
+== Sites that use dark themes ==
+TODO
+=== Groups, Creating User Groups ===
   * They get created when the first user gets added to a new group
-==== Namespaces ====
+=== Namespaces ===
   * A "namespace" is just a folder structure. Just like folders on your computer, a namespace can contain another namespaces.
   * To create a new namespace, create a page with a colon in the name (namespace:pagename)
-==== Plugins ====
+=== Plugins ===
   * Plugins are enabled by default (i.e., there is no "enable" option for newly-installed plugins)
   * there is a "disabled" list in dokuwiki\conf\plugins.local.php
-==== Troubleshooting ====
+=== Settings ===
-  * Use [[https://www.dokuwiki.org/tips:findbadphp.php|this script]] to find corrupted PHP files. Place it in your wiki root and call it from your browser.
+  * Settings are viewed or changed via the Configuration Settings page (at yourwiki.com/doku.php?id=doku.php&do=admin&page=config). Those settings get stored in conf/local.php.
+=== Troubleshooting ===
+  * Use [[doku>tips:findbadphp.php|this script]] to find corrupted PHP files. Place it in your wiki root and call it from your browser.
 ----
 ===== Templates =====
-The [[https://www.dokuwiki.org/template:bootstrap3|bootstrap3]] template provides the UI for this blog. It is a highly customizable Bootstrap-based template for DokuWiki. The template is responsive and is designed for all devices (mobile, tablet, desktop, etc).
+The [[doku>template:bootstrap3|bootstrap3]] template provides the UI for this blog. It is a highly customizable Bootstrap-based template for DokuWiki. The template is responsive and is designed for all devices (mobile, tablet, desktop, etc).
 ----
-===== Theme =====
+===== Themes =====
-The [[https://www.dokuwiki.org/template:bootstrap3|bootstrap3]] template has built-in support for several themes. Currently, this blog uses the [[https://bootswatch.com/3/|bootswatch]] theme called [[https://bootswatch.com/3/darkly/|darkly]].
+The [[doku>template:bootstrap3|bootstrap3]] template has built-in support for several themes. Currently, this blog uses the [[https://bootswatch.com/3/|bootswatch]] theme called [[https://bootswatch.com/3/darkly/|darkly]].
 ----
 ===== Plugins =====
-DokuWiki has a huge number of [[https://www.dokuwiki.org/plugins|plugins]]. Below are the plugins used by this blog. If the plugin enables specific wiki markup, I include both a sample of the markup itself, and a sample of the output of that markup.
+DokuWiki has a huge number of [[doku>plugins|plugins]]. Plugins provide a system of extending DokuWiki's features without the need to hack the original code.
-==== Abbreviations ====
+Most plugins can be installed with the push of a button by searching for and installing the plugin via the [[doku>plugin:extension|extension manager]].
+There are so many plugins available that there are often several plugins that do similar functions. So if you find one that doesn't quite work the way you want it to work, look for a different one. And because there are so many plugins, they often conflict with each other. For example, one of my usage requirements is a color-coded editor, such as the [[doku>plugin:codemirror|CodeMirror]] plugin (see [[dokuwiki#CodeMirror Plugin|screenshots]] below). Since that plugin conflicts with [[doku>plugin:fastwiki|fastwiki]], I can't use fastwiki in this blog.
+Below are the plugins used by this blog. If the plugin enables specific wiki markup, I include both a sample of the markup itself, and a sample of the output of that markup.
+----
+=== Abbreviations ===
 DokuWiki has built-in support for tooltip-style definitions. For example, rest your cursor over any these words: BTW, FAQ, HTML, WYSIWYG, EOF. The downside to this approach is that you have to edit a text file that lives on the DW server to add new entries to the list. As Captain Hook would say, "bad form!"
-There are several plugins that make tooltips easier to use, but none of them have a toolbar button. That means you (or your users) will have to remember the syntax.
+There are several plugins that make tooltips easier to use, but only [[doku>plugin:abbr|abbr]] appears to have a toolbar button.
+<dtable>
 ^ Plugin ^ Syntax ^ Example ^
-|[[https://www.dokuwiki.org/plugin:acronym|plugin:acronym]]|Type <nowiki><acronym title=“explanation”>acronym</acronym> to create a text “acronym” with an explanation “explanation”.</nowiki>|<acronym title="Go Blue!">U of M</acronym>|
+|[[doku>plugin:acronym|plugin:acronym]]|Type <nowiki><acronym title=“explanation”>acronym</acronym> to create a text “acronym” with an explanation “explanation”.</nowiki>|<acronym title="Go Blue!">U of M</acronym>|
-|[[https://www.dokuwiki.org/plugin:tooltip|plugin:tooltip]]|Simple form: <nowiki>{!word:tooltip_text}}</nowiki> This plugin also supports a more detailed/complex form that lets you use custom styles.|{!simple:a simple example}}|
+|[[doku>plugin:tooltip|plugin:tooltip]]|Simple form: <nowiki>{!word:tooltip_text}}</nowiki> This plugin also supports a more detailed/complex form that lets you use custom styles.|{!simple:a simple example}}|
+|[[doku>plugin:abbr|plugin:abbr]]|<nowiki><abbr>Put popup text here (Option 1)</abbr></nowiki>\\ <nowiki><abbr>Option 2 [Put popup text here]</abbr></nowiki>\\ <nowiki><abbr title="Put popup text here">Option 3</abbr></nowiki>|<abbr>Put popup text here (Option 1)</abbr>\\ <abbr>Option 2 [Put popup text here]</abbr>\\ <abbr title="Put popup text here">Option 3</abbr>|
+</dtable>
 ----
-==== Code Enhancement Plugin ====
+=== Code Syntax Plugin ===
-The [[https://www.dokuwiki.org/plugin:code|code]] plugin provides enhancements for the normal <nowiki><code></nowiki> syntax.
+The [[doku>plugin:code2|code]] plugin provides enhancements for the normal <nowiki><code></nowiki> syntax.
 This wiki markup:
-<code><code php| php sample>
-function getType(){ return 'protected';}
+<nowiki><code php| php sample></nowiki>\\
-function getPType(){ return 'block';}
+<nowiki>function getType(){ return 'protected';}</nowiki>\\
-</code></code>
+<nowiki>function getPType(){ return 'block';}</nowiki>\\
+<nowiki><code></nowiki>
 Creates this:
@@ Line 60: / Line 77: @@
 </code>
-Note that this plugin merely enables the "php sample" heading for the above code. The syntax highlighting is a built-in function of DokuWiki.
+FIXME - finish updating the comments/notes/usage
 ----
-==== CodeMirror Plugin ====
+=== CodeMirror Plugin ===
-The [[https://www.dokuwiki.org/plugin:codemirror|CodeMirror]] plugin provides enhancements for the wiki editor.
+The [[doku>plugin:codemirror|CodeMirror]] plugin provides enhancements for the wiki editor, such as syntax highlighting, and searching via CTRL+F (CMD+F on a Mac).
 Without CodeMirror, the editor looks like this:
-{{ :blog:codemirror-without.png?400 |}}
+{{ :codemirror-without.png?600 |}}
 With CodeMirror, it looks like this:
-{{ :blog:codemirror-with.png?400 |}}
+{{ :codemirror-with.png?600 |}}
 ----
-==== Discussion Plugin ====
+=== Discussion Plugin ===
-The [[https://www.dokuwiki.org/plugin:discussion|discussion]] plugin is used by the [[https://www.dokuwiki.org/template:bootstrap3|bootstrap3]] template.
+The [[doku>plugin:discussion|discussion]] plugin is used by the [[doku>template:bootstrap3|bootstrap3]] template.
+----
+=== iFrame Plugin ===
-==== iFrame Plugin ====
-The [[https://www.dokuwiki.org/plugin:iframe|iframe]] plugin allows external URLs to be loaded into an iframe in your DokuWiki page.
+The [[doku>plugin:iframe|iframe]] plugin allows external URLs to be loaded into an iframe in your DokuWiki page.
 <code | wiki markup>
@@ Line 85: / Line 101: @@
 This sample shows the iframe plugin's documentation page:
-{{url>https://www.dokuwiki.org/plugin:iframe}}
+{{url>doku>plugin:iframe}}
 ----
-==== Linkback Plugin ====
+=== Linkback Plugin ===
+The [[doku>plugin:linkback|Linkback]] plugin is used by the [[doku>template:bootstrap3|bootstrap3]] template. It adds Trackback and Pingback support to DokuWiki.
+----
+=== Pagelist Plugin ===
+The [[doku>plugin:pagelist|pagelist]] plugin is used by other plugins.
+=== Tip Plugin ===
+	<tip>
+		right aligned text
+	</tip>
+	<tip l>
+		left aligned text
+	</tip>
+	<tip c>
+		some centered text
+	</tip>
+	<tip d>
+		down text, right aligned
+	</tip>
+	<tip u>
+		up text, right aligned
+	</tip>
+	<tip h>
+		right aligned hint text
+	</tip>
+	<tip i>
+		right aligned information text
+	</tip>
-The [[https://www.dokuwiki.org/plugin:linkback|Linkback]] plugin is used by the [[https://www.dokuwiki.org/template:bootstrap3|bootstrap3]] template. It adds Trackback and Pingback support to DokuWiki.
+	<tip n>
+		right aligned note text
+	</tip>
-==== Pagelist Plugin ====
+	<tip w>
+		right aligned warning text
+	</tip>
-The [[https://www.dokuwiki.org/plugin:pagelist|pagelist]] plugin is used by other plugins.
+	<tip l n d>
+		left aligned note down
+	</tip>
+{{tag>wiki dokuwiki plugin}}