Differences

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

--- dokuwiki_annoyances [2023.08.23 16:45] – [Using the Gallery Plugin] Steve Isenberg
+++ dokuwiki_annoyances [2024.12.29 13:09] (current) – [1. RSS/Atom Feeds (Built-in Feature)] Steve Isenberg
@@ Line 2: / Line 2: @@
 =====Dokuwiki Annoyances=====
+//These are notes for Dokuwiki functions that I find helpful and that I've used throughout this wiki.  This information is not intended to replace the plugin and Dokuwiki documentation, as that is the basis for what I've extracted here.//
 ====The dropdowns in upper-right don't work====
@@ Line 28: / Line 29: @@
 Using | in a table\\
-Normally, when you use a | inside a table, it's treated as start-next-column.  If you want it to be treated as a regular character (for example: ''ls | more'' in Linux, where the | is part of the command sequence, then surround the | in two pair of % or use nowiki.
+Normally, when you use a ''|'' inside a table, it's treated as start-next-column.  If you want it to be treated as a regular character (for example: ''ls | more'' in Linux, where the | is the pipe command, then surround the | with a double ''%'' or surround it with %%<%%nowiki%%>%%.
-|paging file listing|ls -lt %%|%% more|ls -lt <nowiki>|</nowiki> more|
+<code>
+|paging file listing | ls -lt %%|%% more | ls -lt <nowiki>|</nowiki> more |
+</code>
+|paging file listing | ls -lt %%|%% more | ls -lt <nowiki>|</nowiki> more |
 ===Coloring a cell===
-<nowiki>|@palegreen:cell1|@:cell2|@#FF00FF:cell3|</nowiki>\\
+<code>
-|@palegreen:cell1|@:cell2|@#FF00FF:cell3|
+| @palegreen:cell1 | @:cell2 | @#FF00FF:cell3 |
+</code>
+| @palegreen:cell1 | @:cell2 | @#FF00FF:cell3 |
 ===Coloring text===
-<nowiki><color /#ccccff>text1 background</color> <color green>text2</color> <color #00FFFF>text3</color> <color red/green>text4</color></nowiki>\\
+<code>
-<color /#ccccff>text1 background</color> <color green>text2</color> <color #00FFFF>text3</color> <color red/green>text4</color>
+<color /#ccccff> text-1 </color> <color green> text-2 </color> <color #00FFFF> text-3 </color> <color red/green> text-4 </color>
+</code>
+<color /#ccccff> text-1 </color> <color green> text-2 </color> <color #00FFFF> text-3 </color> <color red/green> text-4 </color>
 ===Specifying column widths====
-Put this on the line before the start of the table.  This example shows a spec for a 4-column table. 100% means you're dealing with the entire table width. 14%, 10%, and 1% specify the relative width for those three columns; the - means the rest of the width goes into that table.\\
+Put this on the line before the start of the table.  This example shows a spec for a 4-column table. 100% means the table will fill the page horizontally.  The 14%, 10%, and 1% specify the relative width for those three columns; the ''-'' means to use whatever is left in that column (in this case it will be 100-14-10-1 or about 75%).
-<nowiki>|< 100% 14% - 10% 1%>|</nowiki>
+<code>
 |< 100% 14% - 10% 1%>|
 |Col1|Column 2, the wordy column.|Column 3|4th|
-\\
+</code>
+|< 100% 14% - 10% 1%>|
+|Col1|Column 2, the wordy column.|Column 3|4th|
 This example is for a 3-column table, that's only using 3/4 of page width.  The first two columns are smaller and the remainder of the table is taken by the contents of the 3rd column.
-<nowiki>|< 75% 10% 13% ->|</nowiki>
+<code>
+|< 75% 10% 13% ->|
+|July 4, 2023|watch fireworks|Now is the time for all good people to view fireworks. From a safe distance.|
+</code>
 |< 75% 10% 13% ->|
 |July 4, 2023|watch fireworks|Now is the time for all good people to view fireworks. From a safe distance.|
@@ Line 53: / Line 74: @@
 The Hidden plugin does the job.
-If you use: ''<nowiki><hidden click to show>the text to be shown or hidden</hidden></nowiki>'' it works like this:\\
+<code>
+<hidden click to show>the text to be shown or hidden</hidden>
+</code>
 <hidden click to show>the text to be shown or hidden</hidden>
-\\ \\
-If you want to control initial state visible/not and change text shown depending on visible/not, use:\\
-''<nowiki><hidden initialState="visible" onVisible="Click to hide" onHidden="click to show ">Text to be seen or not seen</hidden></nowiki>'' and it works like this:\\
-<hidden initialState="visible" onVisible="Click to hide" onHidden="click to show ">Text to be seen or not seen</hidden>
 \\
+If you want to control initial state visible/not and change text shown depending on visible/not, use:
+<code>
+<hidden initialState="visible" onVisible="Click to hide" onHidden="click to show ">Text initially visible</hidden>
+<hidden initialState="hidden" onVisible="Click to hide" onHidden="click to show ">Text starts off hidden</hidden>
+</code>
+<hidden initialState="visible" onVisible="Click to hide" onHidden="click to show ">Text initially visible</hidden>
+<hidden initialState="hidden" onVisible="Click to hide" onHidden="click to show ">Text starts off hidden</hidden>
 ----
@@ Line 107: / Line 136: @@
 {{gallery>:namespace}}
 </code>
-All image files in that namespace will be added to the gallery.  Don't forget the '':''
+All image files in that namespace will be added to the gallery.  Don't forget the colon, '':''
 ==Options of note==
+Aligning the pictures
 <code>
-{{gallery> :namespace?options go here}} (right aligned)
+{{gallery> :namespace?options go here}}    (right aligned)
-{{gallery>:namespace?options go here }} (left aligned)
+{{gallery>:namespace?options go here }}    (left aligned)
-{{gallery> :namespace?options go here }}  (centered)
+{{gallery> :namespace?options go here }}   (centered)
 </code>
-^Option name   ^example^
+^Option name   ^example^note^
-|thumbnail size     |150x150|
+|thumbnail size     |150x150 |lower-case x|
-|lightbox size      |1600X1200|
+|lightbox size      |1024X768|capital X|
 |limit to 10 images |=10|
 |sort pix randomly  |random|
@@ Line 125: / Line 155: @@
 |sort by create date|datesort|
 |show filename below thumbnails|showname|
+|don't crop pix     |nocrop|cropping is enabled by default|
+|don't search subdirs|norecursive|recursive search enabled by default|
+Example: Photos with name, not cropped, reasonable expanded size, landscape thumbnails:
 <code>
-{{gallery>:namespace?80x80&500X600&random&showname }}
+{{gallery>:namespace?showname&nocrop&1024X768&200x150}}
 </code>
+====Add text from a file with wrapping====
+You have text you want to add to a wiki page, and you want to make sure that it's inserted with line wraps.
+For example if you have the text
+<code>
+:29:43 message to everyone:
+	Sabine Hossenfelder (born 1976) is a German professional YouTuber, theoretical physicist, science communicator, author, musician, and singer. She is the author of Lost in Math: How beauty leads physics astray, which explores the concept of elegance in fundamental physics and cosmology, and of Existential Physics: A scientist’s guide to life’s biggest questions.
+</code>
+But you want it to look like this, note that you don't have to scroll left and right to read the whole line:
+<WRAP prewrap>
+<code>
+:29:43 message to everyone:
+	Sabine Hossenfelder (born 1976) is a German professional YouTuber, theoretical physicist, science communicator, author, musician, and singer. She is the author of Lost in Math: How beauty leads physics astray, which explores the concept of elegance in fundamental physics and cosmology, and of Existential Physics: A scientist’s guide to life’s biggest questions.
+</code>
+</WRAP>
+You surround the lines as follows:
+<file>
+<WRAP prewrap>
+<code>
+:29:43 message to everyone:
+	Sabine Hossenfelder (born 1976) is a German professional YouTuber, theoretical physicist, science communicator, author, musician, and singer. She is the author of Lost in Math: How beauty leads physics astray, which explores the concept of elegance in fundamental physics and cosmology, and of Existential Physics: A scientist’s guide to life’s biggest questions.
+</code>
+</WRAP>
+</file>
+When the wiki processes this, it'll do the line wrapping on the Sabine line.
+====Change the wiki logo====
+The logo is a 128x128 pixel file named wiki:logo.png
+Consider using https://looka.com to create your logo then use your photo editing software (e.g., Photoscape X) to fine-tune and save it as a 128x128 pixel .png.
+====== How to Detect Changes to a Doku Wiki ======
+Doku wiki offers several ways for users to be notified when changes are made:
+==== 1. RSS/Atom Feeds (Built-in Feature) ====
+DokuWiki automatically generates RSS or Atom feeds for tracking changes.
+  * **Recent Changes Feed**: Users can subscribe to the feed to see all recent changes across the wiki.
+    - URL: `https://yourwiki.com/feed.php`  (for this wiki: `https://wiki.toku.us/feed.php`)
+  * **Page-Specific Feed**: For updates on a single page, append `?do=recent` to the page URL.
+Make sure RSS feeds are enabled in the wiki settings.\\
+Users can use any RSS reader to subscribe.
+  * Examples: [[https://Feedly.com|Feedly]], [[https://www.Inoreader.com|Inoreader]], or desktop readers like NetNewsWire.
+  * Users subscribe to a website’s RSS feed by providing the feed URL as above
+==== 2. Email Notification (Subscription Feature) ====
+Users can subscribe to specific pages or the entire wiki to receive email updates when changes are made.
+  * To subscribe, click the **"Subscribe"** link in the page toolbar.
+  * Notifications will be sent whenever subscribed pages are edited.
+Make sure email notifications are enabled in the wiki settings (`$conf['notify']` in `conf/dokuwiki.php`).
+==== 3. Using the Watch Plugin ====
+The [Watch Plugin](https://www.dokuwiki.org/plugin:watch) provides advanced notification options:
+  * Users can "watch" specific pages or entire namespaces.
+  * Notifications are sent automatically when watched pages are updated.
+==== 4. ChangeLog or Recent Changes Page ====
+Users can manually check the **"Recent Changes"** page to see a log of recent edits.
+  * Add a link to the Recent Changes page in your navigation for easy access.
+==== 5. Webhooks or Custom Scripts ====
+For advanced integrations, you can use webhooks or custom scripts to send notifications to services like Slack or Discord. This requires additional setup by the administrator.
+---
+These options make it easy to stay informed about updates to a Doku wiki.