EclipseLink Documentation Requirements
This page captures the requirements for future versions of the EclipseLink User Guide (ELUG). This is a work in progress. See Release 1.0 Doc Plan for background on the original ELUG plan.
These requirements are for the consumers of the EclipseLink documentation which includes both the community using EclipseLink from eclipse.org as well as companies who redistribute EclipseLink and want to include or link to the ELUG.
U1. Version Specific
Each release and patch-set of EclipseLink should be able to offer ELUG content that is version specific.
- Provide links to ELUG for a specific version that navigates only to pages with content for this version
- Each release notes page (wiki) will link to the main
U2. Technology Specific Documents/Books
The documentation must be organized into technology (persistence service) specific document sets/books.
- JPA: Content focused on using EclipseLink JPA along with its advanced features
- Native API usage shown only in the
- MOXy: Content focused on EclipseLink MOXy usage including JAXB annotations, native eclipselink-oxm.xml and native API configuration and usage
- SDO: Content focused on EclipseLink SDO
- May make sense to combine with MOXy
- DAS (SDO-JPA bridge using MOXy) should be covered and can link to JPA content as necessary
Common Requiresments for all sets/books:
- The content of each set/book can share content but should be presented in the context of the technology being covered and avoid generic content containing links to its use in a variety of technologies - we should discuss this one
It would be nice to enable the version specific ELUG content to be consumable into other documentation sets. Products and other projects that include EclipseLink should be able to consume the specific version of the ELUG matching the version they include.
Example: Oracle TopLink, Oracle WebLogic, GlassFish, and SAP NetWeaver do or will ship EclipseLink. Ideally these projects/products want to embed the version specific ELUG into their overall documentation set so that their end users have a consistent experience using their documentation.
- Support producing an HTML and/or PDF documentation output for a specific EclipseLink version that consumers can use
- License the content under a license that enable consumers to include--the Eclipse Foundation has endorsed a Creative Commons license for non-code artifacts--need to use approved license.
Nice to Have:
- Enable consumers to skin the documentation for their own Look & Feel
- Enable consumers to include and cross-link into the content from their own content that wraps the ELUG
- Enable packaging as Eclipse IDE on-line help for inclusion with distributions that include EclipseLink components.
- Support producing an HTML and/or PDF documentation for a specific EclipseLink functional area.
This section captures the requirements of the content producers. The goal is to streamline content development addressing the complex nature of the software spanning multiple technologies with shared infrastructure and thus common functionality.
The content must be developed in an open fashion so that any interested party can participate in the development and ongoing maintenance of the ELUG.
- Content must be developed in a repository that is generally accessible over the internet
- Content stored in an "open" format (i.e., XML)
- Content format conforms to an established standard (DITA or Docbook?)
- Approved content developers from any organization must be able to have write access to the repository. Generally this involves contributors providing documentation fixes and enhancements through bugs and the document authors being project committers having write access to the content repository
- Alternative is to allow project committers to provide doc updates directly to the the repository, similar to how we currently allow any committer to update the end-user wiki content.
The content authors need to be able to manage the content in an efficient manor.
Nice To Have:
- Single repository where all content is managed and authors simply add and enhance without duplication of effort
- Content is tagged with the versions it is relevant to. This enables new content to be added for older functionality and have it picked up in all applicable versions of ELUG when next generated.
- Also allows end users to dynamically query the repository and build "custom" deliverables on-the-fly
- Content is stored by topic (i.e., information-centric) rather than by page or chapter (i.e., book-centric)
- Content authors (contributors) should be able to use any tool that can produce valid XML for storage in the repository.
- Need a tool that can query the repository and "build" end-user deliverables
Open Source tools
- EclipseLink User Guide (ELUG) documentation will be stored in SVN as XML files.
- Files should conform to DocBook DTD.
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
Contributors can use any application to edit or update the documentation files, as long as the application's XSLT is compatible with the DTD. The recommended tool is OpenOffice.
- Install the necessary import and export XSLT stylesheets (available from OpenOffice.org).
- Obtain the OpenOffice.org Template required for DocBook Article and Chapter documents from OpenOffice.org.
- Create a new DocBook filter:
- Go to Tools -> XML Filter Settings...
- Set Filter Name and Name of File Type to DocBook (Chapter)
- Go to the Transformation tab
- Set DocType to <chapter>
- For XSLT for Export browse to the chapter export stylesheet (sofftodocbookheadings_chapter.xsl).
- For XSLT for Import browse to the chapter import stylesheet (docbooktosoffheadings.xsl).
- For Template for Import browse to the style template (DocBookTemplate.stw).
- Click OK and close the XSLT Filter Setting dialog
- Obtain the need XML files from SVN (i.e., the chapters).
- Create a new OpenOffice Master Document (.ODM).
- Add the chapters to the Master Document.
- Edit the individual chapters, including the styles, as necessary. When saving the chapter files, OpenOffice may display the following message:
Be sure to select Keep Current Format.
- Alternatively, you can select Save As... and select DocBookXML from the Save As dialog.
- Check-in the XML files to SVN.
Do not check-in your Master Document file (.ODM)