Bug 215127 - [xslt][doc] XSL user documentation
Summary: [xslt][doc] XSL user documentation
Status: CLOSED FIXED
Alias: None
Product: WTP Source Editing
Classification: WebTools
Component: wst.xsl (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.1   Edit
Assignee: David Carver CLA
QA Contact: David Williams CLA
URL:
Whiteboard:
Keywords: noteworthy
Depends on:
Blocks:
 
Reported: 2008-01-12 14:50 EST by Doug CLA
Modified: 2009-04-30 14:28 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Doug CLA 2008-01-12 14:50:04 EST
We need to contribute some help documentation for the XSL project describing the various ways to launch and debug a transformation, adding XSLT processors, changing feature and output preferences etc.
Comment 1 David Carver CLA 2008-01-20 11:42:44 EST
There are a couple of different ways we can do this, that would allow a good test of the editor and launch configurations in general.   Create and store the Documents in either DocBook or DITA format.  Docbook provides a simple set of XSLTs that already convert to Eclipse Help format including generating the necessary plugin.xml information.   Either format would work, but personally I find Docbook easier to understand and use.

Targeting for 0.5M5
Comment 2 David Carver CLA 2008-02-27 18:30:34 EST
I have a general question when it comes to generating documentation, which I think is what is done for the Web Tools Documentation using DITA and DITAMAP files.

Docbook has a set of XSLTs that are used to convert Docbook files into eclipse documentation files (along with the appropriate toc.xml, xhtml files, and plugin.xml files).   The question being, are the DITA scripts and supporting files kept in a seperate project, or are they version controled outside of the Web Tools project.

I would like to have all supporting files needed for the Docbook generation in one plugin that we can use.   I'd also like to have the appropriate files generated during the build process so that they always have the most current information, and the HTML files don't necessarily need to be versioned controlled.

The issue with version controlling the HTML documentation, is that you can easily get the docbook files and the generated files out of synch.

I have no problem with submitting the appropriate CQs for the docbook xslts, as we have an open request to have support for these in the xsl tooling as an example project.  The same with DITA support.
Comment 3 David Carver CLA 2008-03-22 19:28:37 EDT
Added documentation for XSL Preferences and XSL Editing.   The docbook stylesheets have been submitted for IP Review.  Once these clear IP, I can start to include the stylesheets in the documentation project so all committers can use these stylesheets.
Comment 4 David Carver CLA 2008-03-22 21:08:54 EDT
added noteworthy for 0.5m6
Comment 5 David Carver CLA 2008-03-23 17:49:31 EDT
Added sections for the editor, launching, debugging, and samples.  Many of these are stub sections that are to be filled later.
Comment 6 David Carver CLA 2008-03-28 21:27:43 EDT
Resolving this as the base documentation is in place.   Bugs/enhacements for specific documentation for specific features should be opened as needed.
Comment 7 Doug CLA 2008-04-06 04:59:27 EDT
Closing
Comment 8 David Carver CLA 2008-06-05 21:40:36 EDT
Mass Migration to wtp.inc.xsl
Comment 9 David Carver CLA 2009-04-30 14:28:45 EDT
mass update to 3.1 target due to movement from wtp incubator to wtp source editing lost the original milestones.