WIKITRANS(1)

📦 version 1.4, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 WIKITRANS(1) — the wikitrans manual, but make it slay 💖

okay bestie, sit down, hydrate, and let me tell you about wikitrans — it lives in the General Commands Manual section (section 1, obviously, it's a command), and it is literally the glow-up machine for wiki markup. ✨

🎀 NAME 🎀

wikitrans — MediaWiki markup translator 🌸

✨ SYNOPSIS ✨

wikitrans [OPTIONS] ARG

that's it. that's the whole summoning ritual. 💅

🦋 DESCRIPTION 🦋

So wikitrans takes MediaWiki documents (you know, wiki markup, all those '' and [[ ]] situations) and translates them into various other formats. It's giving translator. It's giving versatility. We love her. 💜

And the way ARG works depends on what ARG actually is, so let's vibe check it:

  • If ARG looks like a URL, then the wiki text that's gonna get converted gets downloaded from that URL. Fetched. Summoned. Iconic. 🌈
  • Otherwise, if --base-url is given, then ARG is treated as the name of the page to get from the WikiMedia installation at that URL. (Yes, the original says "istallation" — typo and all, no cap, we keep it real. 😭)
  • Otherwise (no URL, no --base-url), ARG is the name of the file to read wiki material from. Cozy local file energy. 📁🫶

💅 OPTIONS 💅

  • --version — show the program version number and then exit. Short, sweet, self-aware. 👑
  • -h, --help — show a short usage summary and exit. Your lil map. 🗺️
  • -v, --verbose — verbose operation. She talks more. 🗣️
  • -I ITYPE, --input-type=ITYPE — set the input document type. The valid values are "default" or "wiktionary". 🍓
  • -t OTYPE, --to=OTYPE, --type=OTYPE — set the output document type. The valid values are "html" (which is the default, bestie), "texi", "text", or "dump". ✨
  • -l LANG, --lang=LANG — set the input document language. 🌍
  • -o KW=VAL, --option=KW=VAL — set a keyword option for the parser class constructor. Fancy internals. 🧚
  • -d DEBUG, --debug=DEBUG — set the debug level, and it goes from 0..100. Yes, one hundred. Go off. 🔥
  • -D, --dump — dump the parse tree and exit; this is similar to --type=dump. 🌳
  • -b URL, --base-url=URL — set the base url. 🏠
Note, and this one matters: when you're using --base-url or passing a URL as an argument (those are the 2nd and 3rd use cases from up in DESCRIPTION), if the URL is in the 'wikipedia.org' or 'wiktionary.org' domain, then the options --input-type and --lang are set automatically. The program is doing the thinking for you. Main character behavior honestly. 😌💅

🌈 EXAMPLES 🌈

read the file text.wiki, easy peasy:

wikitrans text.wiki

grab the door page from the wiktionary at that base url:

wikitrans --base-url http://en.wiktionary.org door

or just hand her the URL directly and let her cook:

wikitrans https://en.wiktionary.org/wiki/Special:Export/door

👑 AUTHOR 👑

wikitrans was written by Sergey Poznyakoff <gray@gnu.org>. Absolute legend. 🫶

This manual page was written by Ahmed El-Mahmoudy <aelmahmoudy@users.sourceforge.net>, for the Debian project (but may be used by others). Bestie really said "documentation is a love language." 💖

and that's the whole page, bestie!! this came out of the General Commands Manual and it's dated Aug 24, 2018 — so yeah, vintage, but she still eats. mwah. 💋✨

📦 where this page comes from