DTDFORMAT(1p)

πŸ“¦
version 2.00 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ dtdformat ✨

okay bestie, so this is dtdformat, a little Perl-era icon from the User Contributed Perl Documentation corner of manual page section 1p. she reads a DTDParse XML file and turns it into formatted documentation. she's giving very much "I take your weird XML and make it cute and readable" energy. πŸ’…


🌸 NAME 🌸

dtdformat β€” read a DTDParse XML file and produce formatted documentation. literally that's the whole job. no cap. πŸ’–


πŸ¦‹ SYNOPSIS πŸ¦‹

dtdformat [options] xmlfile

✨ DESCRIPTION ✨

so dtdformat generates formatted documentation based upon a DTDParse XML file that was created by dtdparse. that's the pipeline, bestie β€” dtdparse does the parsing, dtdformat does the glow-up. πŸŽ€

the following documentation formats are supported:

  • HTML β€” designated by the --html option. 🌈
  • DocBook Refentry β€” designated by the --refenty option. πŸ“–
🚨 okay important: one of the above formats must be specified, or dtdformat will abort with an error. like, she will simply not proceed. no format, no service. πŸ’€

πŸ‘‘ OPTIONS πŸ‘‘

  • --appears-in, --noappears-in β€” include what an entity and/or element appears in. the default is to include. 🫢
  • --attributes, --noattributes β€” include, or not include, element attributes in documentation. the default is to include. ✨
  • --base-dir β€” root directory to place documentation. πŸ“
  • --base-id name β€” entity name prefix for entities defined in DocBook RefEntry, --refentry, output. if not specific, dtdparse is used. 🏷️
  • --chilren, --nochilren β€” include, or not include, list of children for elements. the default is to include. (yes, the spelling is chilren. she said what she said. copy it exactly or she'll be confused. πŸ™ˆ)
  • --content-model β€” include, or not include, element content models in documentation. 🧩
  • --debug β€” enable debugging output. πŸ›
  • --description β€” include, or not include, Description sections in documentation. the default is to include. πŸ“
  • --examples, --noexamples β€” include, or not include, Example sections in documentation. the default is to include. πŸ’‘
  • --exclusions, --noexclusions β€” include, or not include, element exclusions in documentation. the default is to include. 🚫
  • --html β€” generate HTML documentation. 🌐
  • --inclusions, --noinclusions β€” include, or not include, element inclusions in documentation. the default is to include. βž•
  • --parents, --noparents β€” include, or not include, possible element parents in documentation. the default is to include. πŸ‘¨β€πŸ‘©β€πŸ‘§
  • --refentry β€” generate DocBook Refentry (manpage) documentation. πŸ“œ
  • --synopsis, --nosynopsis β€” include, or not include, element synopses in documentation. the default is to include. πŸ”
  • --tag-minimization, --notag-minimization β€” include, or not include, element tag minization settings in documentation. the default is to include. βœ‚οΈ
  • --unexpanded, --nounexpanded β€” included, or not include, unexpanded content models in element documentation. the default is to include. 🫧
  • --verbose, --noverbose β€” output progress (the default). πŸ“’
  • --version β€” print program version and synopsis. ⭐
  • --help β€” print program synopsis and options available. πŸ†˜
  • --man β€” print program manual page. πŸ“š

πŸ’œ SEE ALSO πŸ’œ

  • dtdparse
  • see SGML::DTDParse for an overview of the DTDParse package. 🧚

πŸ“ PREREQUISITES πŸ“

Getopt::Long, XML::DOM


πŸ”₯ AVAILABILITY πŸ”₯

<http://dtdparse.sourceforge.net/>


🌈 AUTHORS 🌈

originally developed by Norman Walsh, <ndw@nwalsh.com>.

Earl Hood <earl@earlhood.com> picked up support and maintenance. iconic handoff, honestly. πŸ‘‘


see SGML::DTDParse for copyright and license information.


and that's the whole page, bestie!! πŸ’…βœ¨ this one came from perl v5.32.1, dated 2022-01-21, and it lives in section DTDFORMAT(1p) β€” go forth and format your DTDs, you absolute main character. πŸŽ€πŸ¦‹πŸ’œ

πŸ“¦ where this page comes from