Ozibug - web based bug tracking


  1. Introduction
  2. System Name
  3. Images
  4. Login Page
  5. Logout Page
  6. Common Footer
  7. Examples
Back to index
 
Many aspects of the Ozibug user interface are configurable. This howto describes the most common ones along with examples and reasons.
Note: changing the html template files can be dangerous to your application. Bad html can cause unexpected events and display problems !
Back to top
 

The system name as displayed in such places as the title of each page, mail notifications, as well as on login and logout pages can be changed by an Ozibug Administrator from within the system preferences page. This allows the corporate name and/or purpose of the Ozibug instance to be reflected.

The sequence for changing the system name can be seen below.

  1. Login as administrator and select the system preferences option.

    This is the represented by the following icon.
  2. Change the system name preference field as required.

  3. Select the update button and the changes are saved. The title seen in the title bar of your browser window should now be displaying the new system name.

Back to top
 

The images displayed at the left hand side of the top navigation panel and in the center panel on a number of pages (eg., login, welcome, logout) can be changed by setting the corresponding system preferences. The tooltip and url invoked from clicking on the header image can also be changed. This allows additional control of a corporate look and feel.

The sequence for changing the images can be seen below.

  1. Place the custom image file(s) in the images directory. Either a single image or two separate images can be used, however inappropriate sized images can adversely affect the presentation. The default Ozibug header and body images are 128x40 and 128x332 pixels respectively.

    This is the directory usually located under the servlet context directory which will have the following path OZIBUG_HOME/images where OZIBUG_HOME is the directory where the Ozibug war file was unzipped (or expanded) in.

  2. Update the required preferences as described above.

    Note: Only the relative filename of the image(s) should be specified.

Back to top
 

The header and footer of the login page can be changed by setting the corresponding system preferences. This feature allows additional information to be included and displayed on the system wide login page, such as links to other applications or projects or perhaps some company specific information.

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

The sequence for changing the login header or footer can be seen below. The example shown here will add a left hand sidebar containing hyperlinks to useful CVS sites. It will look similar to this.

  1. Create a login header file with the following contents.

    <table border="0" width="100%" cellpadding="0" cellspacing="0">
      <tr>
    
        <!-- left hand section -->
        <td class="header" align="center">
          <table border="3" cellpadding="3" cellspacing="0">
            <tr>
              <td>
                <table border="0" cellpadding="0" cellspacing="0" width="100%">
                  <tr align="left">
                    <td>
                      <p class="footer">CVS Links</p>
                    </td>
                  </tr>
                  <tr align="left">
                    <td>
                      <p class="subfooter">
                        &nbsp;
                        <a href="#topofpage" target="_blank">CVS Home</a>
                        <br>
                        &nbsp;
                        <a href="#topofpage" target="_blank">WinCVS Home</a>
                        <br>
                        &nbsp;
                        <a href="#topofpage" target="_blank">TkCVS Home</a>
                      </p>
                    </td>
                  </tr>
                </table>
              </td>
            </tr>
          </table>
        </td>
    
        <!-- spacer -->
        <td>&nbsp;</td>
    
        <!-- top right hand section -->
        <td>
          <table border="3" width="100%" cellpadding="2" cellspacing="0">
            <tr class="footer">
              <td align="center"><h3><tag.1/></h3></td>
            </tr>
          </table>
          <br>

    The tag <tag.1/> is used as a placeholder for the title "System Name Login" which defaults to Ozibug Login. This tag does not need to be present. Refer to System Name for details on how to change the system name.

  2. Create a login footer file with the following contents.

          <br>
    
          <!-- bottom right hand section -->
          <table border="3" width="100%" cellpadding="2" cellspacing="0">
            <tr class="footer">
              <td align="center">
                <p>
                  <em><tag.1/></em>
                </p>
                <p class="footer">
                  <a href="http://www.ozibug.com/">Ozibug</a>
                  Copyright <em>&#169;</em> 2001-<tag.4/>
                  <a href="#topofpage">Tortuga Technologies</a> Pty Ltd.
                  <tag.2/>
                </p>
                <p class="subfooter">
                  <tag.3/>
                </p>
              </td>
            </tr>
          </table>
    
        </td>
      </tr>
    </table>

    The footer forms the bottom of the table started in the header which encapsulate the application output. The tags in this file are used as placeholders for the following text.

    <tag.1/> - System name
    <tag.2/> - I18N phrase All rights reserved
    <tag.3/> - Served by line
    <tag.4/> - Current year

    These tags do not need to be present.

  3. Place the two files in the templates directory.

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

  4. Update the header/footer preferences as described above.

    Note: Only the relative filename of the template(s) should be specified.

  5. Now try logging out and selecting the login page. You should see your new handiwork displayed.

Back to top
 

The header and footer of the logout page can be changed by setting the corresponding system preferences. This is very similar to customizing the login page. Refer to Login Page for details.

A customized example will look similar to this.

The logout footer can contain tags which are used as placeholders for the following text.

<tag.1/> - I18N phrase login
<tag.2/> - System name
<tag.3/> - I18N phrase All rights reserved
<tag.4/> - Served by line
<tag.5/> - Current year

These tags do not need to be present.

Back to top
 

The common footer is a snippet of html that is responsible for the display of the footer while the user is actually logged in and using the Ozibug application. This can be changed by setting the corresponding system preferences, which is very similar to customizing the login page. Refer to Login Page for details.

As the user will actually be inside the Ozibug application then care should be taken to make sure that any hyperlinks included in this html open into a new browser window. This can be done by specifying the value pair target="_blank" inside the <a> element of each link.

The following example shown will add some useful CVS to useful CVS sites. This line is displayed above the standard footer information. It will look similar to this.

<br>
  <table border="3" width="100%" cellpadding="2" cellspacing="0">
    <tr class="footer">
      <td align="center">
        <p class="subfooter">
          --
          <a href="#topofpage" target="_blank">CVS Home</a>
          --
          <a href="#topofpage" target="_blank">WinCVS Home</a>
          --
          <a href="#topofpage" target="_blank">TkCVS Home</a>
          --
          <a href="#topofpage" target="_blank">jCVS Home</a>
          --
          <a href="#topofpage" target="_blank">CVS NT Home</a>
          --
        </p>
        <p>
          <em><tag.1/></em>
        </p>
        <p class="footer">
          <a href="http://www.ozibug.com/" target="_blank">Ozibug</a>
          Copyright <em>&#169;</em> 2001-<tag.4/>
          <a href="#topofpage" target="_blank">Tortuga Technologies</a> Pty Ltd.
          <tag.2/>
        </p>
        <p class="subfooter">
          <tag.3/>
        </p>
      </td>
    </tr>
  </table>
                      
Back to top
 

The following links show example pages created using the above instructions.

  1. login
  2. welcome
  3. logout
Back to top
 
Back to index