Documentatie genereren voor xml schema definitions?

Op www.xml.com liep ik tegen een vermelding aan van een nieuwe documentatie generatietool voor xsd-documentatie (xsd staat voor xml schema definition, een w3c recommendation, een 'update' van het dtd-formalisme, dat onderdeel is van de xml 1.0 spec). Wie ben ik dan om niet even een kijkje te nemen naar deze tool.

Het gaat om xsddoc; beschikbaar op de site http://xframe.sourceforge.net/xsddoc/index.html. Eenvoudige installatie, gewoon uitpakken in je favoriete map. In de bin-directory staat een batchfile, xsd.bat. Die doet het gewoon meteen, geen nare foutmeldingen over verkeerd een classpath of missende bestanden.
Dus ik denk, ik ga een stuk documentatie genereren. In de samples-map zie ik de xsd staan van de xhtml-strict spec. Het werkt: je runt xsd.bat met als parameter de xsd-file.

Het resultaat? Helaas geen diagrammen (ik ben nog steeds op zoek naar een gratis tool om mooie diagrammen te genereren uit dtd's of xsd's inclusief documentatie!). Maar wel een aardige navigatieomgeving die veel doet denken aan de javadoc-omgeving.

Conclusie: als je graag een xsd snel gebruikersvriendelijk toegankelijk wil maken voor jezelf of voor andere ontwikkelaars, dan is xsddoc zeer geschikt. Ik mis alleen de mooie platen van de hiërarchische structuur die door een xsd gedefinieerd wordt!

Reacties

Een reactie posten

Populaire posts van deze blog

Exploring advanced DOM interop with Blazor WebAssembly

Afbeelding
With the establishment of WebAssembly in the browser space, JavaScript is not the only option anymore to run code in the browser. You can start building your modern web applications in any language of choice. Recently Microsoft has released the first version of Blazor WebAssembly. It enables you as a .NET developer to run .NET code through WebAssembly. Blazor also comes with a websocket based server model. You can check out Blazor on Microsoft Docs: https://docs.microsoft.com/en-us/aspnet/core/blazor I have been building a couple of Blazor experiments myself, of which the following two stand out: Real-time Blazor server web app. I have added a second SignalR hub to this app in order to communicate signals from one Blazor session to another. [ Blogged ] [ Source code ] [ Try it online ] Deep zoom (perturbation based!) Mandelbrot with Blazor Source code . If I find time I will blog about all my adventures to getting this deep zoom Mandelbrot to work! Try it online It was the latt...
Meer lezen

Extend Azure DevOps with Azure Functions

Afbeelding
With Azure DevOps, Microsoft provides a rich platform for building your continuous integration and continuous delivery (CI/CD) workflows. Refer to https://azure.microsoft.com/en-us/services/devops/ Our CI/CD design Lately we came up with the following CI/CD design: Notice the following features: When a feature branch is created, an app service slot is created and the feature workload is deployed to this slot; When a feature is merged with master, the slot gets removed and the master workload gets deployed to the production slot. Learn more about Azure App Services and its deployment slot feature here: https://docs.microsoft.com/en-us/azure/app-service/deploy-staging-slots Implementation In order to learn how to set up the above workflow you can read the following excellent blog post of Lucas Caljé: https://levelup.gitconnected.com/manage-appservice-slots-with-azure-yaml-pipelines-3fb2a2e5da9a Interestingly, Lucas' solution does not require any external integratio...
Meer lezen

Azure Custom Role Definitions and Assignment Scopes

Afbeelding
Working with custom Role Definitions in Azure can be a funny thing. Interestingly, when reviewing the Azure Active Directory user interface in Azure Portal you will not find a way to query all available role definitions. If you query the Roles and Administrators view you will only see administrator roles: With a PowerShell cmdlet you are able to list all. Get-AzRoleDefinition | select name | sort name | ft results in something like the following: Name ---- AcrDelete AcrImageSigner AcrPull AcrPush AcrQuarantineReader AcrQuarantineWriter API Management Service Contributor API Management Service Operator Role API Management Service Reader Role App Configuration Data Owner ... But are these really all the role definitions out there? Obviously not! This list is scoped to the subscription you are currently targeting with your current Azure Context. In order for you to try out yourself, just create a couple of role definitions with various assignment scopes. Assuming you have owne...
Meer lezen