XML_SPELLCHECK(1)

📦
version 3.530.0 · 7 versions
, in opensuse-leap 16.0

💖 XML_SPELLCHECK(1) — the girlies' guide to spellchecking XML ✨

ok so first things first, this is a User Contributed Perl Documentation page for xml_spellcheck, and it's genuinely one of those little tools that just does the thing 🎀 grab a snack, we're going in.

✨ NAME ✨

xml_spellcheck — spellcheck XML files, bestie. that's it, that's the vibe 💅

🦋 SYNOPSIS 🦋

xml_spellcheck [options] <files>

options go first, then your files. iconic. no notes. ⭐

🌸 DESCRIPTION 🌸

okay so xml_spellcheck lets you spell check the content of an XML file. like, the actual words inside your markup, not the markup itself 🫶

here's the little routine it does, in order:

  1. it extracts the text — the content of elements, and optionally of attributes
  2. it calls a spell checker on that text
  3. it recreates the XML document for you

that's the whole personality and honestly? we love a single-purpose icon 👑

💅 OPTIONS 💅

heads up bestie: all options can be abbreviated to the first letter. yes, all of them. iykyk 🙈
  • --conf <configuration_file> — gets the options from a configuration file. NOT IMPLEMENTED YET 😭 so don't come for me if it doesn't work.
  • --spellchecker <spellchecker> — the command to use for spell checking, including any option you want to pass it. by default aspell -c is used ✨
  • --backup-extension <extension> — by default the original file is saved with a .bak extension, and this option changes the extension. protect the original, always 🫶
  • --attributes — spell check attribute content. by default attribute values are NOT spell checked. also NOT YET IMPLEMENTED 💀
  • --exclude_elements <list_of_excluded_elements> — a list of elements that should not be spell checked. leave them alone, they're fine 🙈
  • --include_elements <list_of_included_elements> — a list of elements that should be spell checked (by default all elements are spell checked). very "you're in the group chat" of you 💜
  • --pretty_print <optional_pretty_print_style> — a pretty print style for the document, as defined in XML::Twig. if you provide the option with no value, then the indented style is used. make it cute 🌈
  • --version — display the tool version and exit 🎀
  • --help — display help message and exit
  • --man — display longer help message and exit (the deluxe edition 💅)
lowkey important: --exclude_elements and --include_elements are mutually exclusive. pick a lane bestie, you cannot have both 😤

🧚 EXAMPLES 🧚

ok so this section is literally empty in the original. nothing here. a blank canvas. the examples are left as an exercise for the reader, and honestly? main character energy ✨

💀 BUGS 💀

also empty. no bugs documented, which is either slay or suspicious and we're choosing slay 🫶

⭐ TODO ⭐

the to-do list, periodt:

  • --conf option
  • --attribute option

(yeah, both of those are the not-yet-implemented ones from up top. it's giving "coming soon" 🎀)

🍓 PRE-REQUISITE 🍓

you're gonna need these bestie:

  • XML::Twig
  • Getopt::Long
  • Pod::Usage
  • File::Temp

and heads up — XML::Twig requires XML::Parser. so like, install accordingly 🔥

🌟 SEE ALSO 🌟

  • XML::Twig — go read it, it's the whole foundation of this little operation 👑

This program is Copyright 2003 by Michel Rodriguez 💜

This program is free software; you can redistribute it and/or modify it under the terms of the Perl Artistic License or the GNU General Public License as published by the Free Software Foundation either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 😭 (yes the original breaks "MER-CHANTABILITY" across lines, that's a hyphenation artifact, the word is MERCHANTABILITY, we're not out here inventing new words 💀)

If you do not have a copy of the GNU General Public License write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 📬

💖 AUTHOR 💖

Michel Rodriguez <mirod@xmltwig.com>

xml_spellcheck is available at http://www.xmltwig.com/xmltwig/ 🌸

and that's the page!! mwah 💋 this was rendered by perl v5.42.0, dated 2025-01-16 — go forth and spellcheck your XML, bestie, you're gonna ate 🫶✨

📦 where this page comes from