summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYoni Rabkin <yoni@rabkins.net>2020-12-16 09:27:06 -0500
committerYoni Rabkin <yoni@rabkins.net>2020-12-16 09:27:06 -0500
commitb3f34ab05e5d44a16e4085431cf5bdaac2c65bb6 (patch)
treeda7bf6a261a9025afcf997037b05120ca37c3c8b /doc
parent33761234843f1c24c57b80db7f4c87dad82d3a53 (diff)
update documentation across the board
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-release.txt6
-rw-r--r--doc/rt-liber.texinfo74
2 files changed, 28 insertions, 52 deletions
diff --git a/doc/developer-release.txt b/doc/developer-release.txt
index 81b275e..14c4096 100644
--- a/doc/developer-release.txt
+++ b/doc/developer-release.txt
@@ -17,6 +17,12 @@ Update the NEWS file to tell all of the people the Good News.
Update the manual, compile it, and update the copy of the info file in
the root directory so that ELPA can install it.
+Compile an HTML version of the manual and update it on the Website:
+
+ $ cvs commit -m "update manual" rt-liber.html
+
+ $ cvs commit -m "update website" index.html
+
* push
Push these updates to the git repo.
diff --git a/doc/rt-liber.texinfo b/doc/rt-liber.texinfo
index 0436425..bc2a095 100644
--- a/doc/rt-liber.texinfo
+++ b/doc/rt-liber.texinfo
@@ -48,7 +48,8 @@ This is the Manual for the rt-liberation system
@menu
* Introduction:: Introduction to rt-liberation.
-* Installation:: Setup rt-liberation to work on the system.
+* Installation:: Install rt-liberation on the system.
+* Configuration:: Setup rt-liberation to work on the system.
Using rt-liberation
* Queries:: Retrieve particular tickets from the server.
@@ -117,10 +118,12 @@ operations on the tickets.
@chapter Installation
@cindex installation
-rt-liberation is available via GNU ELPA.
+rt-liberation is available via GNU ELPA. Invoke @kbd{M-x
+list-packages} and choose to install the rt-liberation package.
-If you install rt-liberation manually instead you'll need to tell
-Emacs where to find it, and tell Emacs to load the package:
+If you install rt-liberation manually, by copying the code to your
+machine, instead you'll need to tell Emacs where to find it, and then
+tell Emacs to load the package:
@lisp
(add-to-list 'load-path "/PATH/TO/rt-liberation/")
@@ -131,6 +134,11 @@ Emacs where to find it, and tell Emacs to load the package:
@end lisp
+@c --------------------------------------------------
+@node Configuration
+@chapter Configuration
+@cindex configuration
+
rt-liberation needs to be configured in your ~/.emacs, an ~/.rt-liber
file, or similar.
@@ -622,10 +630,8 @@ buffers will be created displaying the query results and named
@chapter Ticket Viewer
@cindex ticket viewer
-The ticket viewer is an interface for viewing the contents of a
-ticket. It provides font-locking to make reading the contents easier
-via @var{rt-liber-viewer-font-lock-keywords} and a number of
-key-bindings.
+The ticket viewer is an interface for viewing the contents of a ticket
+and for sending answers.
The ticket viewer provides key-bindings to help compose emails to send
to the RT email interface. The key-bindings for composing email
@@ -634,34 +640,26 @@ them depends on the email-backend system you have installed into
rt-liberation. @file{rt-liberation-gnus.el} provides integration with
Gnus, @xref{Gnus Integration}.
-Setting @var{rt-liber-jump-to-latest} to `t' will cause the viewer to
-automatically scroll to the latest comment in a ticket when that
-ticket is visited. By default @var{rt-liber-jump-to-latest} is set to
-`nil'.
-
-When in the ticket viewer buffer, invoking
-@dfn{rt-liber-viewer-take-ticket} will ``take'' the ticket.
-
@table @kbd
@item q
@kindex q (ticket viewer)
-@findex rt-liber-viewer-mode-quit
+@findex rt-liber-viewer2-mode-quit
Bury the ticket viewer buffer.
@item n
@kindex n (ticket viewer)
-@findex rt-liber-next-section-in-viewer
-Move point to the next section in ticket.
+@findex rt-liber-viewer2-next-section-in
+Move to the next section in ticket.
@item N
@kindex N (ticket viewer)
-@findex rt-liber-jump-to-latest-correspondence
-Move point to the newest correspondence section, if any.
+@findex rt-liber-viewer2-last-section-in
+Move to the last section.
@item p
@kindex p (ticket viewer)
-@findex rt-liber-previous-section-in-viewer
+@findex rt-liber-viewer2-previous-section-in
Move point to the previous section in ticket.
@item V
@@ -669,43 +667,15 @@ Move point to the previous section in ticket.
@findex rt-liber-viewer-visit-in-browser
Visit the current ticket in a Web browser.
-@item m
-@kindex m (ticket viewer)
-@findex rt-liber-viewer-answer
-Compose an answer to the current ticket.
-
@item M
@kindex M (ticket viewer)
-@findex rt-liber-viewer-answer-this
+@findex rt-liber-viewer2-answer
Compose an answer to the current ticket. The content section around
point will be inserted into the email body and commented out.
-@item t
-@kindex t (ticket viewer)
-@findex rt-liber-viewer-answer-provisionally
-Compose a provisional answer to the current ticket.
-
-@item T
-@kindex t (ticket viewer)
-@findex rt-liber-viewer-answer-provisionally-this
-Compose a provisional answer to the current ticket. The content
-section around point will be inserted into the email body and
-commented out.
-
-@item F
-@kindex F (ticket viewer)
-@findex rt-liber-viewer-answer-verbatim-this
-Compose an answer to the current ticket. The content section around
-point will be inserted into the email body verbatim.
-
-@item c
-@kindex c (ticket viewer)
-@findex rt-liber-viewer-comment
-Compose a comment for the current ticket.
-
@item C
@kindex C (ticket viewer)
-@findex rt-liber-viewer-comment-this
+@findex rt-liber-viewer2-comment
Comment on the ticket using the current context
@item g