From 93f86132988ec2c3bf5bfdf85e996e52d812924f Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Wed, 23 Jun 2010 22:52:32 +0200 Subject: Documentation tweaks --- README | 8 ++++---- doc/geiser.css | 4 ++++ doc/geiser.texi | 2 ++ doc/index.texi | 2 +- doc/install.texi | 8 +++++++- doc/intro.texi | 5 +++-- doc/tutorial.texi | 4 +++- 7 files changed, 24 insertions(+), 9 deletions(-) diff --git a/README b/README index 5b29dcb..9d65bac 100644 --- a/README +++ b/README @@ -140,11 +140,11 @@ |----------------+----------------------------------------------------| | C-c C-k, C-c k | Nuke REPL: use it if the REPL becomes unresponsive | |----------------+----------------------------------------------------| - | C-c l | Load scheme file | + | C-c C-m, C-c m | Set current module + | C-c C-l, C-c l | Load scheme file | |----------------+----------------------------------------------------| - | C-c d | See documentation for identifier at point | - | C-c m | See module documentation | - | C-c a | Toggle autodoc mode | + | C-c C-d, C-c d | See module documentation | + | C-c C-a, C-c a | Toggle autodoc mode | |----------------+----------------------------------------------------| *** In the documentation browser: diff --git a/doc/geiser.css b/doc/geiser.css index 96f1801..a172f4e 100644 --- a/doc/geiser.css +++ b/doc/geiser.css @@ -78,3 +78,7 @@ div.navigation { /* color: white; */ } +.index-cp { + line-height:120%; + font-size: smaller; +} \ No newline at end of file diff --git a/doc/geiser.texi b/doc/geiser.texi index 8c9cce8..6232b4f 100644 --- a/doc/geiser.texi +++ b/doc/geiser.texi @@ -50,6 +50,8 @@ It draws inspiration (and a bit more) from environments such as Common Lisp's Slime, Factor's FUEL, Squeak or Emacs itself, and does its best to make Scheme hacking inside Emacs (even more) fun. +@cindex derailment +@cindex corpses Or, to be precise, what @uref{http://hacks-galore.org/jao, i} consider fun. Geiser is thus my humble contribution to the dynamic school of expression, and a reaction against what i perceive as a derailment, in diff --git a/doc/index.texi b/doc/index.texi index 57a7441..408f780 100644 --- a/doc/index.texi +++ b/doc/index.texi @@ -4,7 +4,7 @@ @node Index @unnumbered Index - +@cindex recursion @printindex cp diff --git a/doc/install.texi b/doc/install.texi index e297cd3..ef25536 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -10,6 +10,7 @@ @node Must needs, Setting it up, Installation, Installation @section Must needs +@cindex supported versions If Geiser came with any guarantees, you'd break all of them by not using GNU Emacs 23 (or better, if there actually @i{is} anything better) and at least one of the supported schemes, which right now are @@ -20,6 +21,7 @@ directly compiled from a recent checkout of branch}. Since Geiser supports multiple REPLs, having both of them will just add to the fun. +@cindex use the source, Luke You'll also need Geiser itself. Until version 0.1 is out (which will happen shortly after i finish writing a decent manual), your best bet is grabbing Geiser from its Git repository over at @@ -57,6 +59,7 @@ or simply evaluate that form inside Emacs (you wouldn't kill a friend just to start using Geiser, would you?). That's it: you're ready to @ref{quick-start,,go}. +@cindex byte-compilation What? You still here? I promise the above is all that's needed to start using Geiser. But, in case you are missing your @t{configure/make all install} routine, by all means, you can go through those motions to byte @@ -102,7 +105,10 @@ the next chapter! Although Geiser does not need them, it plays well with (and is enhanced by) the following Emacs packages: -@itemize +@cindex paredit +@cindex company +@cindex quack +@itemize @bullet @item @uref{http://www.emacswiki.org/emacs/ParEdit, Paredit}. Regardless of whether you use Geiser or not, you shouldn't be coding in any Lisp dialect without the aid of Taylor Campbell's structured diff --git a/doc/intro.texi b/doc/intro.texi index 2f83325..2bc134d 100644 --- a/doc/intro.texi +++ b/doc/intro.texi @@ -22,6 +22,7 @@ library implementing that API, together with some wee shims in Elisp allowing the reuse of the Emacs-side framework, which constitutes the bulk of the code. +@cindex current module While being as generic as possible, the Scheme-Elisp interface makes some assumptions about the capabilities and interaction mode of the corresponding REPL. In particular, Geiser expects the latter to support @@ -46,7 +47,7 @@ my knowledge) introspection capabilities, namely, Guile and Racket. @node Showing off, , Modus operandi, Introduction @section Showing off - +@cindex swanking When working with a fully conniving Scheme, Geiser can offer the following functionality: @@ -79,7 +80,7 @@ and error navigation. Support for multiple, simultaneous REPLs. @end itemize -In the following sections, i'll try to explain what these features +In the following pages, i'll try to explain what these features actually are (i'm just swanking here), and how to use them for your profit. But, before that, let's see how to install Geiser. diff --git a/doc/tutorial.texi b/doc/tutorial.texi index c27e4fe..a98ebae 100644 --- a/doc/tutorial.texi +++ b/doc/tutorial.texi @@ -2,7 +2,9 @@ @chapter Tutorial @anchor{quick-start} - +I'm working on it... perhaps the +@uref{http://git.savannah.gnu.org/cgit/geiser.git/plain/README, README} +file will work for you in the meantime? @c Local Variables: @c mode: texinfo -- cgit v1.2.3