XSDDIAGRAM(1)

πŸ“¦ version 1.0, in debian bookworm, ubuntu jammy, ubuntu noble

🌸 XSDDIAGRAM(1) β€” bestie's guide to xsddiagram 🌸

okay so. you know how XML Schema Definition files are like... a LOT? like a whole tree of elements that goes on forever and ever? bestie, this is the tool that draws it for you. it's the Xml Schema Definition (XSD) diagram viewer, and it's genuinely iconic. we're in the XSDDIAGRAM(1) manual page, User Commands section, and I'm gonna walk you through every single flag. no skips. no "eh you'll figure it out." we go through all of it. πŸ’…


✨ SYNOPSIS ✨

XSDDiagram.exe [-o output.svg] [-os EXTENSION] [-r RootElement]* [-e N]
[-z N] [-y] [-u USERNAME] [-p PASSWORD] [file.xsd or URL]

like yes, that's a lot of brackets. breathe. it's fine. we're gonna take it one option at a time. 🫢


πŸ’– DESCRIPTION πŸ’–

XSD Diagram, version 0.16.0.0 β€” she's grown, she's evolved, she's serving diagrams. πŸ’…

  • -o FILE β€” this is how you say "bestie, put the picture here instead of opening a window." you name the output image. allowed formats are '.png', '.jpg', '.svg', and also '.emf' on Windows. and if you don't pass it? then you get the GUI. a whole window. very main character. ✨
  • -os EXTENSION β€” the "stream it" option. this one says the output image gets streamed through the standard output. EXTENSION can be: png, jpg, svg. and same deal as above β€” if it's not present, the GUI is shown. 🌈
  • -r ELEMENT β€” picks the root element of the tree. and here's the cute part: you can put several -r options and that gives you several root elements in the tree. stacking roots. we love to see it. πŸ‘‘
  • -e N β€” the expand level, and it goes from 0 to what you want. literally anything. and listen, I have to be dramatic here because the manual is dramatic: be careful, the result image can be huge. 😭 like genuinely huge. don't say I didn't warn you.
  • -z N β€” zoom percentage, from 10% to 1000%. and this one is picky: it's only for .png image, and it only works with the -o, -os png or -os jpg option. no -o? no zoom for you. πŸŽ€
  • -y β€” the "yes I'm sure" button. it forces huge image generation without user prompt. so when your expand level is unhinged and the tool wants to double-check with you, this flag is you saying "I know. do it anyway." πŸ”₯
  • -u USERNAME β€” a username to authenticate with when an xsd dependency (an import or an include) is a secured url. yes, your schema can reach out to the internet. yes, sometimes that door is locked. πŸ™ˆ
  • -p PASSWORD β€” the matching password for that same situation, when a xsd dependency (import or include) is a secured url. the username and password are a duo. it's giving dynamic duo energy. πŸ’œ

🌟 EXAMPLES 🌟

these are the exact commands from the manual, copied character for character, because I do NOT play with your commands. πŸ’–

Example 1: > XSDDiagramConsole.exe -o file.png -r TotoRoot -e 3 -z 200 ./folder1/toto.xsd

> XSDDiagramConsole.exe -o file.png -r TotoRoot -e 3 -z 200 ./folder1/toto.xsd

will generate a PNG image from a diagram with a root element 'TotoRoot' and expanding the tree from the root until the 3rd level.

Example 2: > XSDDiagram.exe ./folder1/toto.xsd

> XSDDiagram.exe ./folder1/toto.xsd

will load the xsd file in the GUI window. no flags, no stress, just vibes. 🌸

Example 3: > XSDDiagram.exe -r TotoRoot -e 2 ./folder1/toto.xsd

> XSDDiagram.exe -r TotoRoot -e 2 ./folder1/toto.xsd

will load the xsd file in the GUI window with a root element 'TotoRoot' and expanding the tree from the root until the 2nd level.

Example 4: > XSDDiagramConsole.exe -os svg -r TotoRoot -e 3 ./folder1/toto.xsd

> XSDDiagramConsole.exe -os svg -r TotoRoot -e 3 ./folder1/toto.xsd

will write a SVG image in the standard output from a diagram with a root element 'TotoRoot' and expanding the tree from the root until the 3rd level.


heads up bestie: the -z zoom only plays nice with .png (and -o, -os png or -os jpg), and cranking -e too high will hand you a massive image β€” that's exactly what -y is there for. 🫢

and that's the whole page!! every flag, every example, every default. nothing skipped, nothing invented. ate and left no crumbs. πŸ’…

this has been xsddiagram 0.16, from way back in January 2013 β€” yeah, she's vintage, she's still slaying, and honestly? iconic behavior. go draw some diagrams, bestie. πŸ¦‹βœ¨

πŸ“¦ where this page comes from