@@ -42,7 +42,7 @@ listings.
4242Accessing the Tracker
4343---------------------
4444
45- You may access your tracker through one of three ways:
45+ You may access your tracker in three ways:
4646
47471. through the `web interface`_,
48482. through the `e-mail gateway`_, or
@@ -68,28 +68,37 @@ reopened to the state of "chatting".
6868
6969The full set of **priority** and **status** values are:
7070
71- =========== =====================================
72- Priority Description
73- =========== =====================================
74- "critical" panic: work is stopped!
75- "urgent" important, but not deadly
76- "bug" lost work or incorrect results
77- "feature" want missing functionality
78- "wish" avoidable bugs, missing conveniences
79- =========== =====================================
80-
81- ============= =====================================
82- Status Description
83- ============= =====================================
84- "unread" submitted but no action yet
85- "deferred" intentionally set aside
86- "chatting" under review or seeking clarification
87- "need-eg" need a reproducible example of a bug
88- "in-progress" understood; development in progress
89- "testing" we think it's done; others, please test
90- "done-cbb" okay for now, but could be better
91- "resolved" fix has been released
92- ============= =====================================
71+ .. table:: Default priorities defined for the classic template.
72+ :name: priority table
73+ :widths: auto
74+
75+ =========== =====================================
76+ Priority Description
77+ =========== =====================================
78+ "critical" panic: work is stopped!
79+ "urgent" important, but not deadly
80+ "bug" lost work or incorrect results
81+ "feature" want missing functionality
82+ "wish" avoidable bugs, missing conveniences
83+ =========== =====================================
84+
85+
86+ .. table:: Default statuses defined for the classic template.
87+ :name: status table
88+ :widths: auto
89+
90+ ============= =====================================
91+ Status Description
92+ ============= =====================================
93+ "unread" submitted but no action yet
94+ "deferred" intentionally set aside
95+ "chatting" under review or seeking clarification
96+ "need-eg" need a reproducible example of a bug
97+ "in-progress" understood; development in progress
98+ "testing" we think it's done; others, please test
99+ "done-cbb" okay for now, but could be better
100+ "resolved" fix has been released
101+ ============= =====================================
93102
94103
95104.. _query-tracker:
@@ -258,6 +267,12 @@ The web interface is broken up into the following parts:
2582672. `display, edit or entry of an item`_, and
2592683. `searching page`_.
260269
270+ In addition to the graphical web interface, Roundup has `REST`_ and
271+ `XMLRPC`_ interfaces. These can be used by advanced users and
272+ programmers to automate tasks and integrate with other programs.
273+
274+ .. _REST: rest.html
275+ .. _XMLRPC: xmlrpc.html
261276
262277Lists of Items
263278--------------
@@ -267,6 +282,10 @@ open (ie. not resolved) issues. This list has been generated by a bunch
267282of controls `under the covers`_ but for now, you can see something like:
268283
269284.. image:: images/index_logged_out.png
285+ :width: 675
286+ :height: 450
287+ :alt: Image of the classic Roundup tracker showing a list of issues
288+ that one would see before logging in.
270289
271290The screen is divided up into three sections. There's a title which tells
272291you where you are, a sidebar which contains useful navigation tools and a
@@ -277,11 +296,19 @@ You may register, reset your password or log in. Registration takes
277296you to:
278297
279298.. image:: images/registration.png
299+ :width: 675
300+ :height: 450
301+ :alt: A registration form with fields for name, login name,
302+ password etc.
280303
281304Clicking on the "Lost your login?" link allows you to reset your
282305password. Resetting your password takes you to:
283306
284307.. image:: images/reset.png
308+ :width: 605
309+ :height: 495
310+ :alt: A form with email address and username fields that will
311+ trigger a password reset when submitted.
285312
286313You can enter your username to get a reset email sent to your primary
287314E-mail address. Otherwise you can enter your primary E-mail address or
@@ -292,11 +319,18 @@ complete the password reset. The verification link expires in a week.
292319Once you're logged in, the sidebar changes to:
293320
294321.. image:: images/index_logged_in.png
322+ :width: 182
323+ :height: 399
324+ :alt: Navigation sidebar after login showing multiple links. It now
325+ includes a link labeled "My Details" for the user's settings.
295326
296327You can now get to your "My Details" page:
297328
298329.. image:: images/my_details.png
299-
330+ :width: 667
331+ :height: 558
332+ :alt: A form allowing the user to change username, real name, email
333+ address and it also shows activity done by the user.
300334
301335Display, edit or entry of an item
302336---------------------------------
@@ -305,11 +339,21 @@ Create a new issue with "create new" under the issue subheading. This
305339will take you to:
306340
307341.. image:: images/new_issue.png
342+ :width: 648
343+ :height: 277
344+ :alt: A form for entering a new issue with title, priority, status
345+ and other fields. All fields are empty. It also includes an
346+ entry box for typing free form text to describe the issue.
308347
309348Editing an issue uses the same form, though now you'll see attached files
310349and messages, and the issue history at the bottom of the page:
311350
312351.. image:: images/edit_issue.png
352+ :width: 650
353+ :height: 535
354+ :alt: A form for editing an issue with title, priority, status
355+ and other fields filled in. It also includes an entry box for
356+ typing free form text to describe the issue.
313357
314358The "Make a copy" link duplicate the current issue copying most of the
315359properties to a new issue. This is useful for splitting am issue into
0 commit comments