Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
wiki:documentation [2025/05/31 02:02] – [Documentation] scumsuckwiki:documentation [2025/08/11 22:50] (current) – [Discussion] scumsuck
Line 1: Line 1:
 ====== Documentation ====== ====== Documentation ======
-I'll try to document how I've made my wiki function.  +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 =====
Line 34: Line 34:
   * **[[https://www.dokuwiki.org/template:white|White]]** - nice and clean, no dark toggle   * **[[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.+==== Advanced Config ====
  
-<accordion>+The [[https://www.dokuwiki.org/plugin:advanced|Advanced plugin]] allows me to add CSS to the wiki without bothering my host about it.  I have added several small tweaks to the CSS on top of the Kiwiki template, mostly small visual things like transparent backgrounds and invisible borders..
  
 +<del>
 +For some reason, the kiwiki template can't see any options on the [[https://wiki.scumsuck.com/wiki:documentation?do=admin&page=advanced_config|advanced configuration page]].  So I have bookmarked the[[https://wiki.scumsuck.com/doku.php?id=sidebar&do=admin&page=advanced_config&tab=userstyle&file=all&sectok=198c1de1f4fbf36f745fdbcef5e644bd|link to all css styles]] for easy access lol.
 +</del>
  
-<accordion-item title="Syntax & Renderer Plugins"+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.]]
-~~INFO:syntaxplugins~~+
  
-----+You can use [[https://www.dokuwiki.org/entities|Entities]] as emotes.  The emotes I currently have are:
  
-~~INFO:rendererplugins~~ +  *:pog: %% :pog: %% 
-</accordion-item>+  *: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!
  
-<accordion-item title="Admin Helper Plugins" >+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.  
  
-~~INFO:adminplugins~~ +Avatars may be uploaded after making a comment by making a Gravatar account.  Avatars can also be changed whenever you want.
----- +
-~~INFO:helperplugins~~ +
-</accordion-item>+
  
 +==== Discussion ====
 +The [[https://www.dokuwiki.org/plugin:discussion|discussion plugin]] enables a comment section on individual pages, by typing ''%%~~DISCUSSION~~%%''in the area you want that section in.  
  
 +The default input fields are
 +  - Real Name
 +  - E-Mail
 +  - Website
 +  - Comment
 +Those fields are hard-coded, with no configuration options in the server-side admin panel.  I have done a really hacky CSS fix to replace "Real Name" with "Username" so people don't think I'm trying to doxx them.
  
-</accordion>+This code hides "Real Name" and makes it so screen readers don't read it.
  
 +<code>
 +.comment_name .block span {
 +  font-size: 0;
 +  visibility: hidden;
 +}
 +</code>
  
 +This code replaces the text with "Username" or whatever you want it to read instead.
  
 +<code>
 +.comment_name .block span::after {
 +  content: 'Username:';
 +  font-size: 18px;
 +  visibility: visible;
 +}
 +</code>
  
- +Supposedly entering your e-mail allows you to get notifications for comments, but haven'been able to get email notifications as an admin.  For nowthe e-mail just lets you have [[https://wiki.scumsuck.com/wiki:documentation#avatars|an avatar]].
-==== Advanced Config ==== +
- +
-The [[https://www.dokuwiki.org/plugin:advanced|Advanced plugin]] allows me to add CSS to the wiki without bothering my host about it.  have added several small tweaks to the CSS on top of the Kiwiki template, mostly small visual things like transparent backgrounds and invisible borders.. +
- +
-<del> +
-For some reason, the kiwiki template can'see any options on the [[https://wiki.scumsuck.com/wiki:documentation?do=admin&page=advanced_config|advanced configuration page]].  So I have bookmarked the[[https://wiki.scumsuck.com/doku.php?id=sidebar&do=admin&page=advanced_config&tab=userstyle&file=all&sectok=198c1de1f4fbf36f745fdbcef5e644bd|link to all css styles]] for easy access lol. +
-</del> +
- +
-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 exampletyping <code>:pog: , :hulk: , :misery:</code> will summon :pog:, :hulk: and :misery: 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.   +
- +
-Avatars may be uploaded after making a comment by making a Gravatar account.  Avatars can also be changed whenever you want. +
 ==== Styling ==== ==== Styling ====
 Dokuwiki has a [[https://www.dokuwiki.org/plugin:styling|styling plugin]] built in for simple color changes to templates, [[https://wiki.scumsuck.com/wiki:documentation?do=admin&page=styling|accessible via the admin panel]].   Dokuwiki has a [[https://www.dokuwiki.org/plugin:styling|styling plugin]] built in for simple color changes to templates, [[https://wiki.scumsuck.com/wiki:documentation?do=admin&page=styling|accessible via the admin panel]].  
Line 94: Line 103:
 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//. 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//.
  
-=== wtf are these ===+=== What is a Snippet? ===
  
 Snippets allow you to insert pre-written text. Snippets allow you to insert pre-written text.
Line 118: Line 127:
  
   - 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".   - 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.+  - Edit the page with what you need.