Ozibug - web based bug tracking


  1. Introduction
  2. Templates
  3. Tags
  4. Generating release notes
Back to index
 

This howto describes what is involved in creating a custom release notes template for use by the Ozibug release notes report.

Back to top
 

All release note templates are stored in the directory usually located under the servlet context directory which will have the following path OZIBUG_HOME/WEB-INF/templates/relnotes where OZIBUG_HOME is the directory where the Ozibug war file was unzipped (or expanded) in.

The templates can be any type of text based file such as txt, html, xml or csv, the only requirement is that the characters are encoded as UTF-8 characters, ie., no binary representations of Unicode characters should be included. Unicode characters can be added to the templates by using an ascii Unicode escape sequence \uXXXX where XXXX is the character code, for example \u00AB is the escape sequence for the single character '<<' and \u00BB is the escape sequence for the single character '>>'.

Two example templates are shipped with Ozibug, default.txt and default.html. Depending on requirements, one option is to create a template for each module that release notes are to be generated for.

Note: You should never change the original template files that are shipped with Ozibug. You should create new files so that you can always fallback to the shipped files.

Back to top
 

The templates are based around replacement tags which are processed during report generation and substituted with module data from Ozibug. The tags are of the form <tag name="fieldName"/>, where the fieldName is one of those listed below.

  • Standard fields. These are available for all modules.
    • Non repeating fields. Substitution occurs for an occurrence of these fields one time only.
      • module - the name of the module
      • date - the current date and time, formatted according to the invoking user's preference
    • Repeating fields. These are bug related fields and substitution occurs for each bug. All repeating data must be placed between the <repeat> and </repeat> tags, both of which must be present on a line by themselves.
      • id - the formatted bug id
      • status - the status of the bug
      • priority - the priority of the bug
      • assignee - the assignee of the bug
      • creator - the creator of the bug
      • updated - the last updated date and time of the bug
      • notifications - the notifications of the bug
      • privacy - the privacy of the bug
      • description - the (short) description or summary of the bug
      • detail - the detailed description (or first comment) of the bug
      • resolution - the last comment (if there was one) of the bug
      • previousDetails - the formatted module/bug id of the bugs previous location in the case of a moved bug
      • linkedBugs - a comma separated list of formatted module/bug ids of linked bugs (if there are any)
  • Custom fields. These are the custom categories that are enabled for the module being reported on. They are repeating fields and the field names are the names of the categories.

Note: If an invalid fieldName is specified then no corresponding data will be able to be found for it and an error will occur when generating the release notes.

Back to top
 
Select the reports option from the top navigation panel, then select the module for which the release notes are to be generated. The template field allows selection of a template suitable for the module, and the sort fields allow the sort order to be specified. It is possible to sort on the bug id or priority fields, or any of the custom fields enabled for the module.
Back to top
 
Back to index