Differences

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

--- wiki:documentation [2025/05/01 04:05] – [Snippets and Templates] scumsuck
+++ wiki:documentation [2025/06/01 02:30] (current) – [Snippets and Templates] scumsuck
@@ Line 1: / Line 1: @@
 ====== Documentation ======
-I'll try to document how I've made my wiki function.  POG
+I'll try to document how I've made my wiki function.  :pog:
-Since I was a young lad, I knew I wanted to write a wiki.  Ya know how sometimes if you have a disorder that deficits you of attention, you often get sucked into Wikipedia rabbitholes and have 500 tabs open from one page?  I feel like that method of storing and relaying information works really well for me, especially so I can add notes when I think of them and not have to wait to get home and update a page..
+Since I was a young lad, I knew I wanted to write a wiki.  Ya know how sometimes if you have a disorder that deficits you of attention, you often get sucked into Wikipedia rabbitholes and have 500 tabs open from one page?  I feel like that method of storing and relaying information works really well for me, especially so I can add notes when I think of them and not have to wait to get home and update a page.
-====== DokuWiki ======
+===== DokuWiki =====
 I currently use [[wiki:dokuwiki|DokuWiki]] as my wiki software.
@@ Line 34: / Line 34: @@
   * **[[https://www.dokuwiki.org/template:white|White]]** - nice and clean, no dark toggle
-===== Plugins =====
+=====Plugins=====
+Here's some specific notes for [[plugins]] I'm using.
-Here is a list of my plugins generated by the [[https://www.dokuwiki.org/plugin:info|info plugin]].  I may have stuff I am not using that is still installed cuz I'm playing with things.
-<WRAP group>
-<WRAP half column>
-==== Syntax Plugins ====
-~~INFO:syntaxplugins~~
-==== Renderer Plugins ====
-~~INFO:rendererplugins~~
-</WRAP>
-<WRAP half column>
-==== Admin Plugins ====
-~~INFO:adminplugins~~
-==== Helper Plugins ====
-~~INFO:helperplugins~~
-</WRAP>
-</WRAP>
 ==== Advanced Config ====
@@ Line 73: / Line 47: @@
 As of April 30th, 2025, [[https://github.com/issues/recent?issue=nicolasprigent%7CDokuwiki-Kiwiki-Theme%7C39|the issue with Kiwiki and Advanced plugin has been fixed.]]
-You can use [[https://www.dokuwiki.org/entities|Entities]] as emotes.  For example, typing <code>:pog: , :hulk: , :misery:</code> will summon :pog:, :hulk: and :misery:.  Thank you [[https://analori.com/|analori]] for the :misery: emote!
+You can use [[https://www.dokuwiki.org/entities|Entities]] as emotes.  The emotes I currently have are:
-  * Admins may add emotes by uploading them via the [[https://wiki.scumsuck.com/wiki:documentation?do=media&ns=wiki|media manager]], and then going into [[https://wiki.scumsuck.com/wiki:dokuwiki?do=admin&page=advanced_config&tab=config&file=entities&sectok=198c1de1f4fbf36f745fdbcef5e644bd|Entities]] and adding the string you wish to convert into an HTML <img>
+  *:pog: %% :pog: %%
+  *:hulk: %%:hulk:%%
+  *:misery: %%:misery:%%
+Use the emotes by typing the name you see after the image.  :pog:  Thank you [[https://analori.com/|analori]] for the :misery: emote!
+Admins may add emotes by uploading them via the [[https://wiki.scumsuck.com/wiki:documentation?do=media&ns=wiki|media manager]], and then going into [[https://wiki.scumsuck.com/wiki:dokuwiki?do=admin&page=advanced_config&tab=config&file=entities&sectok=198c1de1f4fbf36f745fdbcef5e644bd|Entities]] and adding the string you wish to convert into an HTML <img>
 ==== Avatars ====
 [[https://www.dokuwiki.org/plugin:avatar|Avatars]] on discussion-enabled pages are provided via the email address you entered, if it is linked to a [[https://gravatar.com/|Gravatar account]].  Otherwise, the user's avatar defaults to a preset icon provided by the avatar plugin.
@@ Line 89: / Line 70: @@
 ====Snippets and Templates====
 The [[https://www.dokuwiki.org/plugin%3Asnippets|Snippets]] and [[https://www.dokuwiki.org/plugin:wst|Wikimedia Style Templates]] plugin lets you reuse templates that you've written.
+It's kinda confusing that Wiki Style Templates are called //templates//, but the styled theme is also called a //template//.  Please bear with me.  In this section I will use the term **WST** to refer to **Wiki Style Templates**, in order to differentiate it from the //theme template//.
+=== What is a Snippet? ===
+Snippets allow you to insert pre-written text.
+WST allow you to create a page, and re-use the exact layout on other pages.
+There is a difference between them - which I am not smart enough to articulate.  The way I'm currently using them is using Snippets to insert a skeleton for a page I will immediately edit, and "Templates" for parts I want to look the same on every page (like menus and navigation).  The documentation of WST seems to say that you can replace parts of the templates, but IDK how to read the documentation lol.
 For my wiki, I have created [[snippets:characters|a rough template for character pages]], which I have inserted into the [[:Snippets]] namespace (I call it a folder in my head lol).
 === How to use Snippets ===
   - Navigate to the page you want to create or edit.
@@ Line 103: / Line 93: @@
 To make more snippets, add another linked item to the list in the [[:Snippets]] folder.  Whatever you write in that page will become a snippet you can select the next time you press the "Insert Templates" button.
+=== How to use Wiki Style Templates ===
+  - Create a page in the [[:template]] namespace.  Name it for its function.  For example, I have named the navigation for the character pages "character_nav".
+  - Edit the page with what you need.