changeset 7278:e2f257ef737f

alt text for images; captions for tables; RESt/XMLRPC reference Grammar fix. Add height/width alt text keeping width under 700 for all images. Separate two tables and add captions for them. Reference REST/XMLRPC for automation/advanced use in web interface section.
author John Rouillard <rouilj@ieee.org>
date Tue, 25 Apr 2023 02:09:52 -0400
parents 41b2a0e12899
children 0bf616cfa178
files doc/user_guide.txt
diffstat 1 files changed, 67 insertions(+), 23 deletions(-) [+]
line wrap: on
line diff
--- a/doc/user_guide.txt	Mon Apr 24 23:26:18 2023 -0400
+++ b/doc/user_guide.txt	Tue Apr 25 02:09:52 2023 -0400
@@ -42,7 +42,7 @@
 Accessing the Tracker
 ---------------------
 
-You may access your tracker through one of three ways:
+You may access your tracker in three ways:
 
 1. through the `web interface`_,
 2. through the `e-mail gateway`_, or
@@ -68,28 +68,37 @@
 
 The full set of **priority** and **status** values are:
 
-=========== =====================================
-Priority    Description
-=========== =====================================
-"critical"  panic: work is stopped!
-"urgent"    important, but not deadly
-"bug"       lost work or incorrect results
-"feature"   want missing functionality
-"wish"      avoidable bugs, missing conveniences
-=========== =====================================
+.. table:: Default priorities defined for the classic template.
+   :name: priority table
+   :widths: auto
+
+   =========== =====================================
+   Priority    Description
+   =========== =====================================
+   "critical"  panic: work is stopped!
+   "urgent"    important, but not deadly
+   "bug"       lost work or incorrect results
+   "feature"   want missing functionality
+   "wish"      avoidable bugs, missing conveniences
+   =========== =====================================
+
 
-============= =====================================
-Status        Description
-============= =====================================
-"unread"      submitted but no action yet
-"deferred"    intentionally set aside
-"chatting"    under review or seeking clarification
-"need-eg"     need a reproducible example of a bug
-"in-progress" understood; development in progress
-"testing"     we think it's done; others, please test
-"done-cbb"    okay for now, but could be better
-"resolved"    fix has been released
-============= =====================================
+.. table:: Default statuses defined for the classic template.
+   :name: status table
+   :widths: auto
+
+   ============= =====================================
+   Status        Description
+   ============= =====================================
+   "unread"      submitted but no action yet
+   "deferred"    intentionally set aside
+   "chatting"    under review or seeking clarification
+   "need-eg"     need a reproducible example of a bug
+   "in-progress" understood; development in progress
+   "testing"     we think it's done; others, please test
+   "done-cbb"    okay for now, but could be better
+   "resolved"    fix has been released
+   ============= =====================================
 
 
 .. _query-tracker:
@@ -258,6 +267,12 @@
 2. `display, edit or entry of an item`_, and
 3. `searching page`_.
 
+In addition to the graphical web interface, Roundup has `REST`_ and
+`XMLRPC`_ interfaces. These can be used by advanced users and
+programmers to automate tasks and integrate with other programs.
+
+.. _REST: rest.html
+.. _XMLRPC: xmlrpc.html
 
 Lists of Items
 --------------
@@ -267,6 +282,10 @@
 of controls `under the covers`_ but for now, you can see something like:
 
 .. image:: images/index_logged_out.png
+   :width: 675
+   :height: 450
+   :alt: Image of the classic Roundup tracker showing a list of issues
+         that one would see before logging in.
 
 The screen is divided up into three sections. There's a title which tells
 you where you are, a sidebar which contains useful navigation tools and a
@@ -277,11 +296,19 @@
 you to:
 
 .. image:: images/registration.png
+   :width: 675
+   :height: 450
+   :alt: A registration form with fields for name, login name,
+         password etc.
 
 Clicking on the "Lost your login?" link allows you to reset your
 password. Resetting your password takes you to:
 
 .. image:: images/reset.png
+   :width: 605
+   :height: 495
+   :alt: A form with email address and username fields that will
+         trigger a password reset when submitted.
 
 You can enter your username to get a reset email sent to your primary
 E-mail address. Otherwise you can enter your primary E-mail address or
@@ -292,11 +319,18 @@
 Once you're logged in, the sidebar changes to:
 
 .. image:: images/index_logged_in.png
+   :width: 182
+   :height: 399
+   :alt: Navigation sidebar after login showing multiple links. It now
+         includes a link labeled "My Details" for the user's settings.
 
 You can now get to your "My Details" page:
 
 .. image:: images/my_details.png
-
+   :width: 667
+   :height: 558
+   :alt: A form allowing the user to change username, real name, email
+         address and it also shows activity done by the user.
 
 Display, edit or entry of an item
 ---------------------------------
@@ -305,11 +339,21 @@
 will take you to:
 
 .. image:: images/new_issue.png
+   :width: 648
+   :height: 277
+   :alt: A form for entering a new issue with title, priority, status
+         and other fields. All fields are empty. It also includes an
+         entry box for typing free form text to describe the issue.
 
 Editing an issue uses the same form, though now you'll see attached files
 and messages, and the issue history at the bottom of the page:
 
 .. image:: images/edit_issue.png
+   :width: 650
+   :height: 535
+   :alt: A form for editing an issue with title, priority, status
+         and other fields filled in. It also includes an entry box for
+	 typing free form text to describe the issue.
 
 The "Make a copy" link duplicate the current issue copying most of the
 properties to a new issue. This is useful for splitting am issue into

Roundup Issue Tracker: http://roundup-tracker.org/