> > <changelog> > > <changedparameter> > > <parameter>length</parameter> > > <version>4.2.0</version> > > <para> > > Became optional with a default value of 1024. > > </para> > > </changedparameter> > > ... > > </changelog> > > > > Maybe it's not generic enough, could we cover every condition? > > <changedbehavior>, <newparameter>, etc. Thoughts? > > As the TODO suggests we planned to introduce roles, and not new tags. In > fact we are currently not using any nonDocBook tags. It would be good to > investigate the available docbook tags to mark up a changelog. BTW I > think the detail of the changelog you provided above is too much. We > only need filtering for versions IMHO. The, like > > <somesecttag id=".....changes"> > <para role="changed-parameter" version="4.2.0"> > The length parameter became optional with a default value of 1024. > </para> > </somesecttag> > > This exact tagging would of course mean that the rendering system need > to handle the 4.2.0 version mark, and need to prepend it before the > paragraph (at least :). Otherwise we are unable to do it with the > current DSSSL sheets. I am not completely unable to tweak DSSSL sheets > in such a simple situation copying and customizing existing stuff :)
Okay this sounds good, let's do it! The following would go right along with our new refsect1 style, does it appear doable? <refsect1> &reftitle.changelog; <para role="changed-behavior" version="4.3.0"> foo() is binary safe. </para> <para role="changed-parameter" version="4.2.0"> The length parameter is optional with a default value of 1024. </para> <para role="new-parameter" version="4.1.0"> length </para> </refsect1> The above would output something similar to: CHANGELOG ------------------------------------------------------- |Version | Role | Description | ------------------------------------------------------- |4.3.0 | .... |foo() is binary safe. | ------------------------------------------------------- |4.2.0 | .... |The length parameter is optional | | | .... |with a default value of 1024 | ------------------------------------------------------- |4.1.0 | .... |length | ------------------------------------------------------- Also, the changelog would go below the return value refsect. If the above format won't work please provide a specific style so we can implement ASAP! Through time we may add additional roles. The use of present tense seems appropriate here although one could debate using past tense. Regards, Philip
