remote-help-assistant team mailing list archive

[Andrew Sayers <andrew-bugs.launchpad.net@xxxxxxxxxxxxxxx>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

As non-promised, I've now pushed a version with documentation and an
"establish a connection" page.  The documentation is currently designed
to work with GNOME's help system, which might be a problem if you
haven't got a full GNOME install.  Doing things the GNOME way lets us
make beautiful and flexible documentation, but at the cost of being hard
to learn.  As always, better ideas are very much welcome :)

GNOME documentation has to be written in a format called "DocBook",
which is a distant relative of HTML.  The benefit of DocBook is that you
can use it to generate documentation in just about every other format
imaginable - HTML, PDF, man pages, info pages...

The DocBook source code is available in
share/doc/remote-help-assistant/manual.xml, and the relevant buttons in
the assistant will open it in the GNOME help viewer.  If that doesn't
work for you, you convert the documentation to HTML by installing the
"xsltproc" and "docbook-xsl" packages, then doing `make html-doc` in the
"0.2" directory.  The final 0.2 release should include HTML
documentation, but I'd rather keep generated docs out of bazaar, in case
it goes out of sync with the DocBook version.


By the way, since you guys are touring the assistant lately, I thought I
should point how easy it is to try out different revisions.  You can
look at the complete list of revisions to the assistant here:

http://bazaar.launchpad.net/~andrew-bugs-launchpad-net/remote-help-assistant/0.2/changes

When you see a revision that looks interesting, you can reset your copy
of the assistant to that revision by going to the "0.2" directory, then
doing:

bzr revert -r <number>

After that, all the files in the assistant will be the same as they were
in revision <number>.  So for example, you might do `bzr revert -r 122`,
then run the assistant to see how you like it with a much busier page 3.

When you want to get back to the most-recently-pulled version of the
assistant, you can do:

bzr revert

Right now, the only revisions I think you'll find interesting are
numbers 122 (maximum use of page 3), 123 ("share control" option moved
to page 2) and the latest revision (progress bar moved to page 4).

	- Andrew
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFJz1dsGRQTxegE/G4RAtFJAJwLL1FhV5tvsYsIL7aUxAPj9YCZ6wCfZOUq
EdH1wBSTxzBQqDA/OGdMifA=
=ms96
-----END PGP SIGNATURE-----