XML Editor
Sign up for a WebBoard account Sign Up Keyword Search Search More Options... Options
Chat Rooms Chat Help Help News News Log in to WebBoard Log in Not Logged in
Show tree view Topic
Topic Page 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Go to previous topicPrev TopicGo to next topicNext Topic
Postnext
Adam Van den HovenSubject: Alternate Documentation Stylesheets
Author: Adam Van den Hoven
Date: 05 Nov 2002 01:11 PM
As Minollo pointed out in "SS 4.5 103i bug?: Can't access xhtml DTD" it is apparently possible to create new, custom transforms for generating schema data.

A few things would be nice (but not as new feature of SS):
1) A repository of alternate layouts.
2) The existing stylesheet broken out (grouped) into more reusable components. We can then use these components as a starting point for creating libraries of different themes.

In addition, it would nice if SS could:
1) manage multiple documentation transform. Perhaps allow selection of the transform on a project or schema basis.
2) Allow for post-processing (via FOP, or perhaps Batik)
3) Along the same lines, provide some mechanism where we can create (and deploy) the images used in the documentation (via SVG and Batik). This is rather complex because you'd have to run it a large number of times. Perhaps an XPath (relative to the root) to determine which nodes to generate an image for and an XPath (relative to the previous XPath) to generate the name of the results.
4) Allow for batch processing where I might create and store two documents, an HTML version and a PDF Version (along with all the graphics I produced).
5) Provide a way to "Edit this Schema Documentation Transform" which would do the obvious thing, only having a default scenario where the source document is a exhaustively complete stylesheet.

In my case, I typically don't write documentation for my consumption. Usually its for people who can't (shouldn't) come find me to ask questions. We always produce both electronic and dead-tree versions of our documentation so I need to produce both. It would be nice to have a way for me to, assuming that I've been good about annotating my schema, to produce all the documentation quickly and easily.

Adam

Postnext
Minollo I.Subject: Re: Alternate Documentation Stylesheets
Author: Minollo I.
Date: 05 Nov 2002 01:20 PM
Adam,
thanks for your input; we knew when we added the XML schema
documentation functionality in 4.5 that we would have stimulated a lot of
feedback; and we are actually getting it.

We hear you; all you are suggesting makes a lot of sense; we now need to
understand what we can do by when. We'll keep you all posted.

Thanks,
Minollo

Posttop
Lee HumphriesSubject: Alternate Documentation Stylesheets
Author: Lee Humphries
Date: 05 Nov 2002 06:22 PM
Hi Adam,

To add to your comments/wishlist.

>A few things would be nice (but not as new
>feature of SS):
>1) A repository of alternate layouts.
I'll second that.

>2) The existing stylesheet broken out
>(grouped) into more reusable components. We
>can then use these components as a
>starting point for creating libraries of
>different themes.
I've already done that to a degree. I wanted to generate documentation for my XSLTs and BizTalk XLangs (don't ask) based on what xs3p does. So I generated two XSLTs, one that builds the style element and one that builds the script. I can now modify them at will.
Having said that though, the ability to add your own layouts to such a repository as you described above would be great. Hmmm, maybe a WYSIWYG XSLT editor would come in handy here.

>In addition, it would nice if SS could:
>1) manage multiple documentation transform.
>Perhaps allow selection of the transform on
>a project or schema basis.
Yes, me too.
>2) Allow for post-processing (via FOP, or
>perhaps Batik)
Yep.
>3) Along the same lines, provide some
>mechanism where we can create (and deploy)
>the images used in the documentation (via
>SVG and Batik). This is rather complex
>because you'd have to run it a large number
>of times. Perhaps an XPath (relative to the
>root) to determine which nodes to generate
>an image for and an XPath (relative to the
>previous XPath) to generate the name of the
>results.
Yes, especially the bit about SVG and the bit about generating the name (I'm assuming you mean file path name) of the results.
>4) Allow for batch processing where I might
>create and store two documents, an HTML
>version and a PDF Version (along with all
>the graphics I produced).
Similarly, I would love it if I could drive the documentation generation process from an external script. At the very least open up access to the image generation.
>5) Provide a way to "Edit this Schema
>Documentation Transform" which would do the
>obvious thing, only having a default
>scenario where the source document is a
>exhaustively complete stylesheet.
(I'm assuming you mean 'exhaustively complete set of schemas'). That would be really handy because you could drop it straight into the WYSIWYG editor.

>It would be nice to have a way for me to,
>assuming that I've been good about
>annotating my schema, to produce all the
>documentation quickly and easily.
I annotate every last little bit (although why you're not allowed to stick an annotation inside a Group is beyond me), so I've got everything ready to go. But, like you, I just want some way of kicking off the whole thing in one go.

Lee

 
Topic Page 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Go to previous topicPrev TopicGo to next topicNext Topic
Download A Free Trial of Stylus Studio 6 XML Professional Edition Today! Powered by Stylus Studio, the world's leading XML IDE for XML, XSLT, XQuery, XML Schema, DTD, XPath, WSDL, XHTML, SQL/XML, and XML Mapping!  
go

Log In Options

Site Map | Privacy Policy | Terms of Use | Trademarks
Stylus Scoop XML Newsletter:
W3C Member
Stylus Studio® and DataDirect XQuery ™are from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2016 All Rights Reserved.