Forrest
  1. Forrest
  2. FOR-487

generate announcement text from the status.xml

    Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.7
    • Fix Version/s: 0.7
    • Labels:
      None

      Description

      By adding some attributes to the "actions" in status.xml we would be able to use certain entries for the announcement text.

        Issue Links

          Activity

          Hide
          David Crossley added a comment -
          Moving Ross' suggestion over from task FOR-454 ...

          I would like to make a suggestion for this issue which will save us time on future releases.

          If we add an attribute to the action element in skinconfig called "announce" with a value of true or false (default to false) we can auto generate the announcement of new features..

          Furthermore, if we add an element "upgrade" which contains a textual description of how to upgrade from the previous version we can generate the upgrade document too.

          These documents, being auto generated would build during the developmentof the project making it easier for someone to return to the project after a while away.

          I would therefore suggest that in fixing this issue for the 0.7 release we focus on adding this information to status.xml and writing the necessary stylesheets. Remember we only need to produce XDoc as Forrest will give us a neat text version of the document.
          Show
          David Crossley added a comment - Moving Ross' suggestion over from task FOR-454 ... I would like to make a suggestion for this issue which will save us time on future releases. If we add an attribute to the action element in skinconfig called "announce" with a value of true or false (default to false) we can auto generate the announcement of new features.. Furthermore, if we add an element "upgrade" which contains a textual description of how to upgrade from the previous version we can generate the upgrade document too. These documents, being auto generated would build during the developmentof the project making it easier for someone to return to the project after a while away. I would therefore suggest that in fixing this issue for the 0.7 release we focus on adding this information to status.xml and writing the necessary stylesheets. Remember we only need to produce XDoc as Forrest will give us a neat text version of the document.
          Hide
          David Crossley added a comment -
          This would be a good ability and would also encourage us to use status.xml more. Perhaps the highlevel doc "upgrading*.xml" is still needed, as it mentions some other general upgrade tasks.
          Show
          David Crossley added a comment - This would be a good ability and would also encourage us to use status.xml more. Perhaps the highlevel doc "upgrading*.xml" is still needed, as it mentions some other general upgrade tasks.
          Hide
          Juan Jose Pablos added a comment -
          What about using impact or importance on the status.xml

          see:

          http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=107883804715745&w=2
          Show
          Juan Jose Pablos added a comment - What about using impact or importance on the status.xml see: http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=107883804715745&w=2
          Hide
          Juan Jose Pablos added a comment -
          I think that this could be resolved using a tag on status.xml
          Show
          Juan Jose Pablos added a comment - I think that this could be resolved using a tag on status.xml
          Hide
          Juan Jose Pablos added a comment -
          dtd changed needed
          Show
          Juan Jose Pablos added a comment - dtd changed needed
          Hide
          Ross Gardler added a comment -
          To generate release notes for a particular version request "**/release_VERSION_NUMBER.*
          Show
          Ross Gardler added a comment - To generate release notes for a particular version request "**/release_VERSION_NUMBER.*
          Hide
          Cyriaque Dupoirieux added a comment -
          This improvement of changes page is nice.

          I have my own version based on xsl:key definition in order to be able to simply manage as many contexts as you can define (My Dtd is not limited to "build|docs|code|admin|design".

          The advantage - on my opinion - is that my own contexts are very various and not developpement oriented nor language dependant.
          here a short example - using releaseNote... :
                  http://cyriaque.dupoirieux.free.fr/changes_6.2.1.html

          The following code replace the 5 blocks <xsl:if test="action[@context='build']"> :

             <title>Version <xsl:value-of select="@version"/> (<xsl:value-of select="@date"/>)</title>
          + <xsl:for-each select="action[generate-id()=generate-id(key('contextes',concat(../@version, '_', @context)))]">
          + <xsl:sort select="@context"/>
          + <section>
          + <title><xsl:value-of select="@context"/></title>
          + <ul>
          + <xsl:apply-templates select="key('contextes',concat(../@version, '_', @context) )">
          + <xsl:sort select="@type"/>
          + </xsl:apply-templates>
          + </ul>
          + </section>
          + </xsl:for-each>

          Hope you'll like the idea...

          Regards,
          Cyriaque,
          Show
          Cyriaque Dupoirieux added a comment - This improvement of changes page is nice. I have my own version based on xsl:key definition in order to be able to simply manage as many contexts as you can define (My Dtd is not limited to "build|docs|code|admin|design". The advantage - on my opinion - is that my own contexts are very various and not developpement oriented nor language dependant. here a short example - using releaseNote... :          http://cyriaque.dupoirieux.free.fr/changes_6.2.1.html The following code replace the 5 blocks <xsl:if test="action[@context='build']"> :    <title>Version <xsl:value-of select="@version"/> (<xsl:value-of select="@date"/>)</title> + <xsl:for-each select="action[generate-id()=generate-id(key('contextes',concat(../@version, '_', @context)))]"> + <xsl:sort select="@context"/> + <section> + <title><xsl:value-of select="@context"/></title> + <ul> + <xsl:apply-templates select="key('contextes',concat(../@version, '_', @context) )"> + <xsl:sort select="@type"/> + </xsl:apply-templates> + </ul> + </section> + </xsl:for-each> Hope you'll like the idea... Regards, Cyriaque,
          Hide
          Ross Gardler added a comment -
          I've moved this to a new issue as this one has been closed, see FOR-514.
          Show
          Ross Gardler added a comment - I've moved this to a new issue as this one has been closed, see FOR-514 .

            People

            • Assignee:
              Ross Gardler
              Reporter:
              David Crossley
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development