ikiwiki-transition(1)

🌸 NAME 🌸

ikiwiki-transition — the lil glow-up machine that transitions your ikiwiki pages to new syntaxes and all that, plus it handles the other transitions too (the ones that aren't even about wiki pages, iconic behavior honestly)

and yes bestie this is ikiwiki-transition(1), straight out of the General Commands Manual 💅

✨ SYNOPSIS ✨

ikiwiki-transition type ...

💖 DESCRIPTION 💖

okay so here's the vibe: ikiwiki-transition is your girl for converting wiki pages whenever ikiwiki goes through a major syntax change. and she doesn't stop there — she also handles the other transitions, the ones that don't involve wiki pages at all. versatile queen 🫶

🎀 prefix_directives your.setup

this mode converts all your pages from the old preprocessor directive syntax — the one that needed a space — over to the new syntax, the one prefixed by !. slay.

good news: preprocessor directives that already use the new syntax stay exactly as they are, untouched. they're fine, they're thriving, leave them alone. 🦋

⚠️ but listen — if a page has wiki links with spaces in them (some older versions of ikiwiki were chill with that), the prefix_directives transition will treat those as preprocessor directives and convert them. so like, heads up. it's giving collateral damage 😭

🎀 setupformat your.setup

this one converts a setup file from using a single wrappers block to using cgi_wrapper, git_wrapper, etc. etc., you get it, one wrapper per wrapper.

🚨 real talk: all comments and any unusual stuff like perl code in the setup file will be lost, because the file gets entirely rewritten by the transition. like, gone gone. so back that up first, bestie, fr fr 💀

🎀 aggregateinternal your.setup

moves pages that were aggregated by the aggregate plugin, so that you can go ahead and enable the aggregateinternal option. that's the whole job. she's simple, she's effective. ✨

🎀 moveprefs your.setup

moves values that used to live in admin preferences into the setup file. relocating! very moving day energy 📦

🚨 same warning as before, no cap: all comments and any unusual stuff like perl code in the setup file will be lost, since it's entirely rewritten by the move. 😭

🎀 indexdb your.setup|srcdir

this mode handles converting a plain text .ikiwiki/index file into a binary .ikiwiki/indexdb. glow-up complete. 🦋

but ngl? you do not normally need to run ikiwiki-transition indexdb. ikiwiki will automatically run it as necessary. she's got it handled, let her cook 👑

🎀 hashpassword your.setup|srcdir

this mode forces any plaintext passwords stored in the .ikiwiki/userdb file to be replaced with password hashes. (the Authen::Passphrase perl module is needed to do this, so make sure it's installed, iykyk)

and if you don't do it explicitly? no worries, it still happens: a user's plaintext password will be automatically converted to a hash when a user logs in for the first time after upgrading to ikiwiki 2.48. automatic. main character energy ⭐

🎀 deduplinks your.setup

so in the past, bugs in ikiwiki allowed duplicate link information to be stored in its indexdb. yikes. 🙈 this mode removes that duplicate information, which may speed up wikis that are afflicted by it. so like, a little cleanup, a little speed boost.

💡 note that rebuilding the wiki will have the same effect. so if you were gonna rebuild anyway... you already ate 💅

👑 AUTHOR 👑

Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info> — absolute legends, we stan 🫶

and that's the whole page, bestie!! this was ikiwiki-transition(1) from the General Commands Manual, and you read the whole thing, which is honestly so iconic of you. go forth and transition. periodt. 💖✨🎀