Getting started

Important:

At the end of each page, in order to read the remaining, by clicking its title (the next one one its right) on the top navigational tab banner.

Enough talked about the philosophy and so on. Now we need to evaluate the solution, to see it working For that, there are prerequisites like any system.

Warning:

Open your developing environment, which should consist of: a advanced XML editor if possible, or at least an advanced and text (XML-highlighted) visual editor, your Java JRE (V1.3+) is ensured to work (some port on other platform is not simple, but possible), your Ant V1.5+ (Ant V1.4 will not work) runtime (Maven should be pat of the story not so late), an XSLT implementation jar file present in Ant lib directory: Saxon and Xalan are supported at the moment, a working Versionning Control System where all your sources should be kept and versioned, except if you consider using this release notes framework for something very volatile;-, your component development in mind.

Our goal

An important matter: we are trying to define a release notes for a precise version of a component. What do we call "component"? A program, a library, a project, some activity that yields delivery artifacts (the framework could have been named "Artifact", indeed).

This component is about to be released because some new needs have been expressed, designed and developed for that new release, the name of the release, the version, has been identified and name. Bugs have been solved by the same way.

What would be great now, is to present and remember those changes, the release notes. Of course, you can write a plain text file, version and save it, but this is kind of a poor solution. If you have a tool that enables to enhance this information without wasting time to use it, you'll get happy.

Read on

If you want to spare some time, we advise you to read on the rest of this section, by visiting each tab from left to right. We are going to see how to use the XRN framework.

Note:

The current documentation is present in the XRN zip devliery package file, under XMLRelaseNotes-M.m.p/guide/index.html.