Table of Contents

  1. About
  2. Demo
  3. Troubleshooting
  4. Appearance
    1. Wiki Pages
    2. Tickets & Milestones
    3. Node Properties
  5. Navigation
    1. Click and Drag
    2. Go To
    3. Overview
  6. Configure
    1. Map Colours
    2. Filters
    3. Link to this page

WikiNavMap Help

About

WikiNavMap visualises the Tickets, Wiki Pages and Milestones in the Trac environment. You can configure the appearance and what will be displayed by using the configuration interface. WikiNavMap aims to be a quick way for you to get both an overall picture of what is happening in the Trac environment and specific information about what individual users have been working on.

WikiNavMap is a Masters project by Adam Ullman, a student at the University of Sydney, School of Information Technologies.

Demo

Below are links to some pre-built configurations of WikiNavMap using wiki data from Adam's personal wiki which was created while working on this project.

Troubleshooting

WikiNavMap has been tested on IE 7, Firefox 2 and Safari 2. If you are not using one of these browsers then you may not be experiencing WikiNavMap as it is intended. Try downloading Firefox from http://www.mozilla.com.

If you are using one of the above browsers and you are still having trouble loading the maps, or if the overview image isn't appearing correctly then try refreshing the WikiNavMap. The best way to do this without losing your settings is to click on the Link to this Page link.

If you are having any other problems with WikiNavMap please contact Adam Ullman at adam@it.usyd.edu.au and describe the error that you are getting.

Appearance

The WikiNavMap appears as a directed graph, with each node representing either a wiki page or a ticket and each grey arrow representing the hyperlinks between these nodes. Wiki pages are all grouped together within a grey border and tickets are grouped within a red border representing milestones.

Wiki Pages

Wiki pages appear as a square box with the title of the page inside it.

Tickets & Milestones

  • Tickets appear as a box with the Ticket number on the left and the username of the person who has been assigned the ticket on the right. If the ticket has been completed then it will be bordered in red, otherwise it will be bordered in white.
  • Milestones appear as a red border around tickets. If the milestone has been completed it will have a grey background.


Node Properties

Nodes are one of Wiki pages, Tickets or Milestones. Nodes have certain properties:

  • Colour -- The colour of the wiki pages and tickets indicates the time at which it was last edited within the given date range, according to the colour key. This colour key can be customised by using the Configure interface.
  • Font Size -- The font size of the text inside the tickets and wiki pages indicate the number of times they have been edited within the given date range. The larger the font size, the more times the wiki page or ticket has been edited, or commented on.
  • Links -- Every node in the WikiNavMap including milestones is a link to the respective page in Trac. So for example clicking on the WikiStart node in the map will bring you to the WikiStart page in the Trac wiki.
  • Popups -- Hovering over nodes will bring up a popup that displays more information about a node. This information varies depending on the type of node.

There are three different ways to navigate around the WikiNavMap.

Click and Drag

Clicking and dragging on the map scrolls the map around. This is similar to what you would find in applications such as Adobe Acrobat Reader and Google Maps.

Go To

If you know what node you are looking for you can scroll straight to it by selecting it from the Go To pull down menu and pressing the Go To button. You will be immediately scrolled to the position of the node and a popup will appear displaying more information. If you click on the WikiNavMap link from a node (Wiki page, ticket or milestone) that is in the Go To list then this node will be selected when you first load the map.

Overview

The overview map in the top right hand corner also allows you to navigate around the map. The overview map shows you a smaller version of the whole map, the blue square indicates the part of the map that is currently visible in the larger window. Dragging this blue square around to different positions on the overview will move you to this location on the larger map. If you find that the overview appears to be squished or not appearing correctly you may need to refresh the page, the best way to do this is to click on Link to this page. This seems to happen particularly with Internet Explorer.

If the overview gets in the way you can hide it by clicking on in the top right hand corner. Clicking on this a second time will reveal the overview.

Configure

The real power of WikiNavMap lies in the ability to customise what is visualised by using the configuration interface. To access the configuration interface you click on in the top right hand corner of the page. Once inside the configuration interface there are two separate Tabs which allow you to customise different elements of the map.

Map Colours

This menu allows you to select the colours that will be used in the map and what time ranges those colours represent.

  • The first pull down menu allows you to select the base colour for the nodes. This is the first colour in a colour gradient that is automatically generated.
  • The number of colours in the gradient can be selected using the slide bar.
  • Each colour gradient represents a date range. There is a default date range which goes back in time from the current date however you can set the date range to be whatever you want. Clicking on the "show dates" link will reveal the date input boxes. Dates in these boxes must be going back in time starting from left to right and entered in the format DD/MM/YYYY. So the farthest left is the most recent and the farthest right is the oldest.

Filters

The filters menu allows you to specify which Tickets and Wiki Pages will be displayed.

  • You can choose whether to display Tickets and Wiki Pages by checking or unchecking the checkboxes.
  • You can select which Tickets and wiki pages to display from the pull down menu. If you choose an option that has a ... (missing username) in it then you can specify a user using the Username input field.

Link to this page

Once you have made changes to the configuration of the WikiNavMap, the URL in your address bar will no longer be valid. If you want to email the link to a WikiNavMap that you have configured or add it to a Wiki Page then you will need to:

  1. Right click on
  2. Select Copy Link.
  3. Paste the link into the location of your choice
Clicking on the Link to this page link is also a good way to refresh the page without losing your settings.