monodocs2html(1)

✨ monodocs2html — the "turn Monodoc XML into HTML" girlie ✨

okay so bestie, we're in the General Commands Manual section, and the star of the show is monodocs2html. Let's get into it 💖

🌸 NAME 🌸

monodocs2html — translate Monodoc XML to HTML, no cap 🦋

🎀 SYNOPSIS 🎀

monodocs2html -source:SOURCE_DIR -dest:DEST_DIR [OPTIONS]*

💅 DESCRIPTION 💅

ngl, the headline here is a lil sad: monodocs2html has been obsoleted by mdoc(1). 😭 like, it's retired, it's living its cottagecore era now. the man page literally says to go look at the mdoc-export-html(1) man page instead, so if you're here for current stuff, slay, go read that one.

but for the record: monodocs2html is a program that creates HTML documentation from the Monodoc documentation XML files. that's the whole vibe. periodt.

✨ OPTIONS ✨

• -dest:DEST_DIR — write the HTML files into the directory DEST_DIR. this is where the output goes, bestie, pick a good home for it 🏡
• -dumptemplate — dump the default page template to standard output, so you can use it as a base for a new template for use with the -template option. it's giving "starter kit" 🎀
• -ext:FILE_EXTENSION — FILE_EXTENSION is the file extension for generated files. it defaults to html. so if you don't say anything, it's html, simple as.
• -?, -help — show program argument information. the classic "help me pls" 💀
• -onlytype:TYPE — only generate HTML for the type TYPE. just the one type, nothing else, main character energy 👑
• -source:SOURCE_DIR — SOURCE_DIR is the base directory containing the Monodoc XML documentation. this directory should contain an index.xml file, the namespace-name.xml files (one for each namespace), and namespace-name directories (one for each namespace), which will contain the type.xml files holding the monodoc documentation. so like, it's a whole little ecosystem in there 🌈
• -template:TEMPLATE — generate HTML using the page template TEMPLATE. your template, your rules 💜
• -V, -version — display version and licensing information. receipts! 🧾

🦋 TEMPLATE FORMAT 🦋

the template file is an XSLT which needs to process the following input XML document:

<Page>
  <CollectionTitle>Collection Title</CollectionTitle>
  <PageTitle>Page Title</PageTitle>
  <Summary>Page Summary</Summary>
  <Signature>Type Declaration</Signature>
  <Remarks>Type Remarks</Remarks>
  <Members>Type Members</Members>
  <Copyright>Documentation Copyright</Copyright>
</Page>

and the generated HTML also makes use of the following CSS classes, which should be defined so that output is nicely formatted. like, define them or your page is gonna look a mess, fr fr:

• .CollectionTitle
• .PageTitle
• .Summary
• .Signature
• .Remarks
• .Members
• .Copyright
• .Section
• .SectionBox
• .NamespaceName
• .NamespaceSummary
• .MemberName
• .MemberSignature
• .MemberBox
• .Subsection
• .SubsectionBox
• .SignatureTable
• .EnumerationsTable
• .CodeExampleTable
• .MembersListing
• .TypesListing
• .InnerSignatureTable
• .TypePermissionsTable

🔗 HTML LINKS 🔗

all members within the HTML file have a id attribute to permit linking to a specific member. the value of the id attribute is the String ID of the specified member. wanna know more about that? see the STRING ID FORMAT section of the monodocer man page. iykyk 😌

📬 MAILING LISTS 📬

visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.

🌐 WEB SITE 🌐

visit http://www.mono-project.com for details.

and that's the whole page, bestie!! 🫶 this lil cutie came out under the General Commands Manual section, filed as monodocs2html(1). mwah, go forth and document 💖✨🎀