Re: [xsl] XSLT documentation

Subject: Re: [xsl] XSLT documentation
From: "W. Hugh Chatfield I.S.P." <csi2000@xxxxxxxxxxxxxxx>
Date: Thu, 24 Dec 2009 20:33:22 -0500
Quoting Brian Newman <brian.newman@xxxxxxxxxxx>:
What are best practices for documenting XSLT?
I've tried to do it using UML, but it seems like putting a square peg in a round
hole - not a real good fit (I think because UML, at least in my mind, is for
imperative code and perhaps even more specifically for OOP).

Have you ever been tasked to describe _graphically_ what a transform is doing
and, if so, how have you done it?

I have had in mind for some while a notion to try to illustrate the dynamics of an XSLT stylesheet being executed by means of some sort of 3D representation of the process (perhaps as opposed to Ken's XSLStyle mechanism for documenting the structure of the XSLT) .

In Robin Cover's latest email there is a reference to


3D Media and the Semantic Web
Michela Spagnuolo and Bianca Falcidieno, IEEE Intelligent Systems

the article leads of with -

"3D content is widely recognized as the next wave of digital media. The
success of 3D communities and mapping applications (for example, Second
Life and GoogleEarth) and the decreasing costs of producing 3D
environments are leading analysts to predict a dramatic shift in how
people see and navigate the Internet..."

I would add - perhaps see and navigate problems in general. Roger Shank's Socratic Arts [] is coming up with interesting ideas about e-learning and the notion of embedding learners in a simulation of the problem.

It is one of the reasons I went back to college (at age 67) to get a degree in Documentary Production - which happens to be all about "story telling" using visuals. This would be part of the overall methodology I would need to show the dynamics of XSLT. I still have a way to go before I can get these images out of my head and onto the screen. 3D content will be a significant part of this as you want to demonstrate a dynamic process, not static code.

Cheers.... Hugh

CyberSpace Industries 2000 Inc. Multimedia Production
XML Training and Consulting

CyberSpace Industries 2000 Inc. Multimedia Production
XML Training and Consulting

Current Thread