Nameless Rumia's Wiki

I'm tired of the internet!

User Tools

Site Tools


dokuwiki

DokuWiki

DokuWiki is a mostly PHP-based1) wiki software that began around June 2004.2) It's a lightweight engine, that doesn't require a database for their core features, and maintains some popularity.3) I do not expect anyone reading this to be interested in its history, so let's skip to the details.

List of default licenses

Upon installation, you will be asked to select a public copyright license or not have one. This might be a bit intimidating since it's not really explained to you, so I've provided a somewhat useful chart below:

License Shorthand Symbols4)
CC0 1.0 Universal CC0 1.0 🅭🄍
Public Domain 🅮
CC Attribution 4.0 International CC BY 4.0 🅭🅯
CC Attribution-Share Alike 4.0 International CC BY-SA 4.0 🅭🅯🄎
GNU Free Documentation License 1.3 GFDL 1.3 🅯🄎
CC Attribution-Noncommercial 4.0 International CC BY-NC 4.0 🅭🅯🄏
CC Attribution-Noncommercial-Share Alike 4.0 International CC BY-NC-SA 4.0 🅭🅯🄏🄎

This wiki's setup

This personal wiki uses the latest stable version of DokuWiki, at the time of this writing, and makes use of numerous configurations and extension. In this section, I've included all the relevant extensions, minus the bundled or pre-packaged ones, and configurations for anyone who finds it useful. There's also some personal explanations, if you're privy to those sorts of minor details.

Extensions and plugins

  • Attribute Plugin - This is a plugin for user-associated data that is required for:
  • CAPTCHA Plugin - I think bots and CAPTCHAs are both fun, but they don't mix. :(
  • Cleanup Plugin - This deletes old files. I mainly use this before making a backup to save space.
  • CMSMode Plugin - Disables actions from logged-out users, namely bots.
  • Color Plugin - This is mostly used for colored text on this wiki, but it can be used as a highlighter.
  • HTMLOK Plugin - Some articles use this, namely the 'badge' and 'page-specific CSS' stuff.
    • 🛑 Warning: Do NOT use this for a public wiki! Look into CSS and the Wrap plugin instead.
  • IP Banning Plugin - This is mostly used against bots, cheap VPNs, and underage kids.
  • Folded Plugin - This hides text and some charts behind a toggle. It does not work with Mermaid.
  • Mermaid Plugin - Mermaid is a diagram and charting tool. Helps add a little flair.
    • 📝 Note: Requires PHP 8.0+.5) You may want 11.2 or older, if you want PHP 7.3 compatibility.
  • Move Plugin - A tool for moving pages, their revision history, and tries to fix backlinks.
    • 📝 Note: I only recommend using this for short periods of time, and immediately disabling it after. It seems that the plugin doesn't know when to 'stop' and runs endlessly, spamming your logs.
  • Pagelist Plugin - This is a plugin that allows you to generate a list of articles, especially if you have:
    • Tag Plugin - A plugin for adding tags to articles, at the bottom of pages on this wiki.
  • Page Redirect Plugin - This tool is self-explanatory. Initially, I hesitated to make redirect pages.
  • Ruby Plugin - Ruby is for CJK pronunciation, but I've found other use cases.
  • Upgrade Plugin - A tool for upgrading the wiki software, though it will try to reinstall every language.
  • Wrap Plugin - An all-in-one plugin with pretty basic features. I mostly use the columns, note boxes, and spoilers on this wiki, but it offers a bunch of other neat little things as well.

Configurations

  • breadcrumbs: 0 - This removes all of the 'recently visited pages' (trace) junk.
  • dformat: %Y-%m-%d %H:%M:%S - ISO 8601 format. It appears to use UTC by default.
  • macseclevel: 5 - This makes editing smaller subsections a bit easier.
  • usewordblock: 0 - It's a personal wiki. Obviously, I'll write what I want to write about.
  • locktime: 60*45 - 45 minutes. Technically, the 'page lock' feature is meaningless on a personal wiki, but I've sorta repurposed this as a reminder since I have a lot of tabs open.

How to get the dark theme

This wiki's dark theme is the base DokuWiki Template, with a custom style.ini.6) If you want these exact colors, replace the values in style.ini using the code shown below, then go into 'Template Style Settings' under the Admin window, and click 'Revert styles back to template's default' to use said values. If you have the Wrap plugin, do make sure that the darkTpl configuration is actually checked.

;--------------------------------------------------------------------------
;------ guaranteed dokuwiki color placeholders that every plugin can use

; main text and background colors (main text and inner window)
__text__            = "#EEE"            ; @ini_text
__background__      = "#222"            ; @ini_background
; alternative text and background colors (inner text and chart header)
__text_alt__        = "#DDD"            ; @ini_text_alt
__background_alt__  = "#444"            ; @ini_background_alt
; neutral text and background colors (numbered list and media thumbs idk)
__text_neu__        = "#CCC"            ; @ini_text_neu
__background_neu__  = "#444"            ; @ini_background_neu
; border color
__border__          = "#777"            ; @ini_border

; highlighted text (e.g. search snippets)
__highlight__       = "#FF9"            ; @ini_highlight

; default link color
__link__            = "#499"            ; @ini_link

;--------------------------------------------------------------------------

; background and code boxes (two are tied together unfortunately)
__background_site__ = "#222"            ; @ini_background_site

; these are used for wiki links
__existing__        = "#6C0"            ; @ini_existing
__missing__         = "#D30"            ; @ini_missing

In the past, this wiki used to have the Adora Dark template, which used an awful orange, then I decided to switch back to the base template and coded a bloated userstyle.css file since I wasn't going to mess with 'Template Style Settings' or figure out what the style.ini file did. After December 2022, the wiki now uses the above settings, cutting the aforementioned userstyle.css file in half.

Some custom CSS

There's a bunch of other CSS code that isn't listed here, which are mostly cosmetic or unused. I don't have the energy to dig through the code.

This wiki's userstyle.css file is mostly filled with CSS rules that adds more styles to the Wrap plugin, as well as fallback fonts and very minor tweaks to the theme that isn't covered by the dark theme section. I will only be showing the CSS rules below, since this is what people are mostly interested in anyways, and provide a list of explanations if my self-explanatory comments aren't clear enough.

  • .wrap_hatnote: This just imitates the Wikipedia hatnote by adding an indent.
  • .wrap_spoiler: Replaces the default spoiler with a mobile-friendly blurry spoiler (example).
  • .wrap_round: Reduces the Corner Radii on boxes and notes to be less 'modern' or obnoxious.
  • .wrap_jascii: This allows usage of the Japanese ASCII font, not always used for ASCII. (・∀・ )
  • .wrap_twatts: This allows a text block to be formatted like Twitter, only used for one specific page.
  • .wrap_narrow: This allows usage of a condensed or narrow font. On a wiki that already tries to condense information.
  • .wrap_shake: This creates a weird shaking effect (example), not currently used.
  • .wrap_cs: This allows usage of the infamous Comic Sans font (example).
  • .wrap_mspa: A shortcut to use dark monospace text on a light background (example).
  • .wrap_big: This just makes the CJK characters bigger, only used for one specific page so far.

Toggle code block.

Notes

  • /conf/ and /data/ are the only relevant folders when importing.
4)
The following Creative Commons license symbols might not render properly as they were recently added to Unicode 13.0 in 2020, so you may have to install a font like Unifont Upper, Code2001, etc.
6)
The style.ini file (for the DokuWiki template) will be under /lib/tpl/dokuwiki. Do save local copies, including one under conf/tpl/dokuwiki, since the upgrade plugin will try to overwrite your settings.
dokuwiki.txt · Last modified: by namelessrumia