Skip to content

Commit 13eb712

Browse files
author
Richard Jones
committed
images for user guide
1 parent 4f36765 commit 13eb712

File tree

2 files changed

+17
-23
lines changed

2 files changed

+17
-23
lines changed

doc/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ all: ${COMPILED} ${WEBHT}
1414

1515
website: ${WEBHT}
1616
cp *.ht ${WEBDIR}
17+
cp -r images ${WEBDIR}
1718

1819
%.html: %.txt
1920
${STXTOHTML} --report=warning -d $< $@

doc/user_guide.txt

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
User Guide
33
==========
44

5-
:Version: $Revision: 1.35 $
5+
:Version: $Revision: 1.36 $
66

77
.. contents::
88

@@ -261,26 +261,24 @@ The first thing you'll see when you log into Roundup will be a list of
261261
open (ie. not resolved) issues. This list has been generated by a bunch
262262
of controls `under the covers`_ but for now, you can see something like:
263263

264-
.. img: images/index_logged_out.png
264+
.. image:: images/index_logged_out.png
265265

266-
The screen is divided up into three sections:
266+
The screen is divided up into three sections. There's a title which tells
267+
you where you are, a sidebar which contains useful navigation tools and a
268+
body which usually displays either a list of items or a single item from
269+
the tracker.
267270

268-
.. img: images/page_layout.png
271+
You may either register or log in. Registration takes you to:
269272

270-
you may either register or log in. Registration takes you to:
273+
.. image:: images/registration.png
271274

272-
.. img: images/registration.png
275+
Once you're logged in, the sidebar changes to:
273276

274-
Once you're logged in, the screen changes slightly to:
277+
.. image:: images/index_logged_in.png
275278

276-
.. img: images/index_logged_in.png
279+
You can now get to your "My Details" page:
277280

278-
Note that the sidebar menu has changed slightly, so you can now get to
279-
your "My Details" page:
280-
281-
.. img: images/my_details.png
282-
283-
Note the new information on this page - the history.
281+
.. image:: images/my_details.png
284282

285283

286284
Display, edit or entry of an item
@@ -289,17 +287,12 @@ Display, edit or entry of an item
289287
Create a new issue with "create new" under the issue subheading. This
290288
will take you to:
291289

292-
.. img: images/new_issue.png
293-
294-
The `nosy list`_ is explained below. Enter some information and click
295-
"submit new entry" and you'll be rewarded with:
296-
297-
.. img: images/new_issue_created.png
290+
.. image:: images/new_issue.png
298291

299-
or, if you don't enter all the required information (or some other error
300-
occurs) you'll get something like:
292+
Editing an issue uses the same form, though now you'll see attached files
293+
and messages, and the issue history at the bottom of the page:
301294

302-
.. img: images/new_issue_error.png
295+
.. image:: images/edit_issue.png
303296

304297

305298
Searching Page

0 commit comments

Comments
 (0)