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 - A plugin for user-associated data that is required forโ€ฆ
  • CAPTCHA Plugin - Bots are fun, but they do get tiring after a while. :(
  • Cleanup Plugin - Deletes old files. I mostly use this before making a backup to save space.
  • CMSMode Plugin - Disables some actions from non-logged in users, namely bots.
  • Color Plugin - A basic tool for highlighting and colored text.
  • HTMLOK Plugin - Some articles use this, namely the articles with badges and page-specific CSS.
    • ๐Ÿ›‘ Warning: Do NOT use this for public wikis. Look into CSS and the Wrap plugin.
  • IP Banning Plugin - This is mostly used against bots, cheap VPNs, and some underage kids.
  • Folded Plugin - Hides text behind a toggle.
  • 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 - For moving pages. Watch the backlinks. Disabled, due to loops and log spam.
    • ๐Ÿ“ Note: I only recommend using this for short periods of time, and immediately disabling it after.
  • Pagelist Plugin - This will allow you to generate a list of articles if you haveโ€ฆ
    • Tag Plugin - A plugin for adding tags to articles, seen at the bottom of certain pages.
  • Ruby Plugin - Ruby is for CJK pronunciation, but I've found other use cases.
  • Upgrade Plugin - A simple tool for upgrading the wiki software. It may try to install 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 - Removes all of the 'recently visited pages' (trace) junk.
  • dformat: %Y-%m-%d %H:%M:%S - ISO 8601 format, UTC time.
  • macseclevel: 5 - Enables editing of smaller subsections. Makes it easier to edit from my end.
  • usewordblock: 0 - It's a personal wiki. I'm going to write what I want to write.
  • dnslookups: 0 - This wiki does not currently use a DNS server.

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 just recently added to Unicode 13.0 in 2020, so you may have to install โ€œUnifont Upperโ€ to render them.
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: 2025-04-21 10:23:17 by namelessrumia