Hi Eric and Howard, I'm not a cocoon profi at all. Indeed it is one of the first projects I did with cocoon. But I know a little bit XML and XSL. The rest comes from tutorials found on the web, w3.org and from the examples shipped with cocoon. My XSL-Files can be downloaded from http://www.bestsolution.at/torque/db_doc.tar.bz2
I've included a small INSTALL describing step by step how to add the documentation into cocoon. I know that the XSL-Files are not the best. Many people would have made them much better. They've be a first try. The following weaknesses are known: 1) ER-Diagramm only works for tables who have no more than 2 foreign-keys. 2) I use a second config-file named table2png.xml used to control the table width's in ER-Diagramm for tables, x and y are not used at the moment. They come into consideration when creating the database-schema. Which does not work at the moment. 3) Do ***NOT*** wonder that some of the xsl-files are not used at the moment, their old stuff of trying something. Short description of files: resources/ ==> images and css-stylesheets used stylesheets/torque-doc ==> XSL to convert db-schema - common.xsl: Common functions used in more than one xsl-file - erdiagramtable.xsl: Creates ER-Diagramme for tables - erdiagram.xsl: first try not used at the moment, in later versions used to create ER-Diagramme for the database - index.xsl: Creates the startpage == database-overview - left_navi.xsl: creates the left navigation - pdfdoc.xsl: not used at the moment, will create a pdf as output - table2png.xml: Configuration file used for creation of ERs - table_info_er.xsl: HTML for ER (included by table_info.xsl) - table_info_overview.xsl: HTML for the table-overview (included by table_info.xsl) - table_info_sql.xsl: not used at the moment, will create a highlighted database create-statement - table_info.xsl: creates the mainframe of the table-doc - top.xsl: creates the top of a page Sorry but there does not exist a better documentation at the moment. Still I've people like my solution I will improve documentation and the overcome known problems. Still testers would be great to identify them. thanks tom Am Fre, 2002-11-08 um 17.08 schrieb [EMAIL PROTECTED]: > I like it.. How complex though is it to set up? Documentation is good, but > documentation is broken is terrible! I think some of the best parts about > it are the ER-Diagram. > > I would love to see some of the logic, I have never really gotton into > Cocoon... > > Eric Pugh > > -----Original Message----- > From: Tom Schindl [mailto:tom.schindl@;bestsolution.at] > Sent: Friday, November 08, 2002 10:13 AM > To: Turbine Torque Developers List > Subject: RE: project documentation > > > Well, looks nice. Still take a look at my solution which is now also > creating ER-Diagrams (pngs). Using transformation from > db-schema.xml => svg => png using cocoon. Everything is made on the fly > by cocoon, so if db-schema.xml changes, documentation changes > automatically. > > http://ferrum.bestsolution.at:8080/cocoon/torque-doc/index.html > > I've only tested the page with mozilla, still it should also work on IE. > > Please note that the connection is very slow because only my > home-computer runs cocoon. > > bye > > tom > > Am Mit, 2002-11-06 um 17.46 schrieb Howard Lin: > > Hi, I think the Velocity templates (datamodel.vm/table.vm in > src/templates/doc/anakia) can be modified to achieve your first two cases. > (Actually I modified table.vm a little bit to add foreign key column name in > the table). > > > > For SVG generation, see > http://www.mail-archive.com/turbine-torque-dev@;jakarta.apache.org/msg00821.h > tml. > > > > Howard Lin > > > > > -----Original Message----- > > > From: Tom Schindl [mailto:tom.schindl@;bestsolution.at] > > > Sent: Wednesday, November 06, 2002 9:29 AM > > > To: Turbine Torque Developers List > > > Subject: Re: project documentation > > > > > > > > > Hi Ben, > > > > > > let's see whether I've understood you. You're using the HTML > > > produced by > > > torques documentation task and process it using xdoc. Your > > > example looks > > > nice. > > > > > > My problem with this is, that to much information has been lost in the > > > html-file(s) generated by torque. > > > > > > Now you have 2 possibilities if you want to rely on this infos: > > > > > > 1) Changing the transformation-process provided by torque to include > > > them in any way > > > 2) Use the db-schema.xml and generate the documentation out of it. > > > > > > > > > Well because I need much informations to generate my idea of > > > documentation. Maybe not at this point but later on, when creating > > > database-schema.jpg showing the structure and references > > > between tables > > > in visual form instead of the linked HTML-Code. I think this > > > information > > > has not to be exported into the HTML-file generated by torque. > > > > > > I've uploaded some screen shots on my webserver because cocoon is not > > > running there at the moment. > > > > > > http://www.bestsolution.at/torque/torque1.jpg > > > This is the main-page. Already implemented by my xsl-Stylesheets. > > > > > > http://www.bestsolution.at/torque/torque2.jpg > > > This is the example for a tabel. Already implemented by my > > > xsl-Stylesheets. > > > > > > http://www.bestsolution.at/torque/torque3.jpg > > > This is an example for my database-schema.jpg which I talked about a > > > view lines above. At the moment this is a Screenshot taken from > > > DbVisualizer. > > > > > > Once more I don't want to replace the html-output generated > > > by torque. I > > > only wanted to show up another way to create a documentation based on > > > the db-schema.xml-File. > > > > > > Cheers, > > > > > > tom > > > > > > > > > Am Mit, 2002-11-06 um 08.07 schrieb Ben Walding: > > > > Did I miss something? > > > > > > > > How is this different than the anakia doc output from > > > Torque that can be > > > > processed by xdoc into a web page? > > > > eg. > > > http://montage.sourceforge.net/montage-server/montage-schema.html > > > > This is all done using only a handful of commands. If > > > anyone wants more > > > > information, let me know. > > > > > > > > Is yours an improved version? > > > > > > > > > > > > (I'm not trying to be a smart *ss or put down what you've > > > done. I'm > > > > curious to know if what you've done is better than what was > > > built into > > > > to torque) > > > > > > > > Cheers, > > > > > > > > Ben > > > > > > > > Jeffrey D. Brekke wrote: > > > > > > > > >This may be a nice addition to the maven-torque plugin. > > > You could use the > > > > >maven xdoc goals to convert the documents into reports > > > with the maven l&f > > > > >and integrate into the project docs. > > > > > > > > > > > > > > >On 5 Nov 2002, Tom Schindl wrote: > > > > > > > > > > > > > > > > > > > >>Hi, > > > > >> > > > > >>After having spent some hours thinking about a nice > > > documentation about > > > > >>my database created using torque. I thought about using cocoon and > > > > >>writing a stylesheet to convert everything into HTML as the primer > > > > >>outputformat. > > > > >> > > > > >>I've used maven.css and tigris.css so the design looks > > > like the torque > > > > >>homepage (I've learned from my faults made in the last > > > > >>documentation-patch :-)) ). > > > > >> > > > > >>I think generating the documentation using XSL and XSLT has many > > > > >>advantages against the one provided at the moment. > > > Nevertheless I don't > > > > >>want to replace the actual documentation I think my way > > > could be an > > > > >>add-on to torque. > > > > >> > > > > >>At the moment have a set of stylesheets generating the following: > > > > >>* database documentation in html > > > > >>* table document in html > > > > >> > > > > >>My first questions now are: > > > > >>* What does the community and the developers of torque > > > think about it? > > > > >>* Whom should I mail my set of xsl-stylesheets to take a > > > look at them > > > > >>and tell what has to be changed. Should I pack them up as > > > a ZIP and send > > > > >>them to the mailing list? > > > > >> > > > > >>I've also planned to implement the following things after > > > this first > > > > >>try: > > > > >>* generating a database overview very similar to the one > > > you'll get from > > > > >>tools like Access or DbVisualizer. This writing an XSL-Stylesheet > > > > >>generating a SVG-File and using Cocoons-Serialzer to > > > generate a PNG out > > > > >>of it > > > > >>* PDF as output format instead of HTML using Cocoon and FOP > > > > >> > > > > >>bye > > > > >> > > > > >>tom > > > > >> > > > > >> > > > > >> > > > > >> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -- > > > > To unsubscribe, e-mail: > > > <mailto:turbine-torque-dev-unsubscribe@;jakarta.apache.org> > > > > For additional commands, e-mail: > > > <mailto:turbine-torque-dev-help@;jakarta.apache.org> > > > > > > > -- > > > b e s t s o l u t i o n . a t EDV > > > Systemhaus GmbH > > > -------------------------------------------------------------- > > > ---------- > > > Thomas Schindl Project Management mobile > > > ++43/664/314 59 58 > > > -------------------------------------------------------------- > > > ---------- > > > Anton-Rauch-Str.6a A-6020 Innsbruck fax > > > ++43/512/935834 > > > http://www.bestsolution.at phone > > > ++43/512/935834 > > > > > > > ---- > > > > > ****** Message from InterScan E-Mail VirusWall NT ****** > > > > ** No virus found in attached file noname.htm > > > > Message has been scanned, and is virus-free. > > ***************** End of message *************** > > > > > > ---- > > > > > -- > > To unsubscribe, e-mail: > <mailto:turbine-torque-dev-unsubscribe@;jakarta.apache.org> > > For additional commands, e-mail: > <mailto:turbine-torque-dev-help@;jakarta.apache.org> > > ---- > > > > > -- > > To unsubscribe, e-mail: > <mailto:turbine-torque-dev-unsubscribe@;jakarta.apache.org> > > For additional commands, e-mail: > <mailto:turbine-torque-dev-help@;jakarta.apache.org> > -- > b e s t s o l u t i o n . a t EDV Systemhaus GmbH > ------------------------------------------------------------------------ > Thomas Schindl Project Management mobile ++43/664/314 59 58 > ------------------------------------------------------------------------ > Anton-Rauch-Str.6a A-6020 Innsbruck fax ++43/512/935834 > http://www.bestsolution.at phone ++43/512/935834 -- b e s t s o l u t i o n . a t EDV Systemhaus GmbH ------------------------------------------------------------------------ Thomas Schindl Project Management mobile ++43/664/314 59 58 ------------------------------------------------------------------------ Anton-Rauch-Str.6a A-6020 Innsbruck fax ++43/512/935834 http://www.bestsolution.at phone ++43/512/935834
signature.asc
Description: Dies ist ein digital signierter Nachrichtenteil
