summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2011-01-11 02:43:54 +0100
committerJose Antonio Ortega Ruiz <jao@gnu.org>2011-01-11 02:43:54 +0100
commit96ebbac008223f93e5c2ea796e38170d8e8e73f3 (patch)
tree892845e10802ee5e2c060ecde5d02c7cbca0a548
parentb3dd88e1379767c79941a39b4b5bc4f02c9b5be6 (diff)
downloadgeiser-96ebbac008223f93e5c2ea796e38170d8e8e73f3.tar.gz
geiser-96ebbac008223f93e5c2ea796e38170d8e8e73f3.tar.bz2
More documentation fixes
-rw-r--r--doc/install.texi7
-rw-r--r--doc/macros.texi9
-rw-r--r--doc/parens.texi52
-rw-r--r--doc/repl.texi17
4 files changed, 58 insertions, 27 deletions
diff --git a/doc/install.texi b/doc/install.texi
index 38703e0..05fe9c4 100644
--- a/doc/install.texi
+++ b/doc/install.texi
@@ -78,7 +78,12 @@ its moral equivalents):
@noindent
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
-@alt{@ref{quick-start,,go}., go (@pxref{The REPL}).}
+@ifhtml
+@ref{quick-start,,go}.
+@end ifhtml
+@ifnothtml
+go (@pxref{The REPL}).
+@end ifnothtml
@ifnotinfo
If you obtained the Geiser source tree from a release tarball, you can
diff --git a/doc/macros.texi b/doc/macros.texi
index 950c81f..6a138d0 100644
--- a/doc/macros.texi
+++ b/doc/macros.texi
@@ -24,15 +24,6 @@
@vblurb{@value{GUILE_VERSION}, @value{RACKET_VERSION}, \DATE\}
@end macro
-@macro alt{HTML, NOHTML}
-@ifhtml
-\HTML\
-@end ifhtml
-@ifnothtml
-\NOHTML\
-@end ifnothtml
-@end macro
-
@macro altr{LINK, TXT, TLINK, TRAIL}
@ifhtml
@ref{\LINK\,,\TXT\}\TRAIL\
diff --git a/doc/parens.texi b/doc/parens.texi
index 65e6554..374444f 100644
--- a/doc/parens.texi
+++ b/doc/parens.texi
@@ -6,8 +6,14 @@ hacking environment. Well, perhaps a bit more than a half; but, at any
rate, one surely needs also a pleasant way of editing source code. Don't
pay attention to naysayers: Emacs comes with an excellent editor
included for about any language on Earth, and just the best one when
-that language is sexpy (especially if you use @alt{@ref{paredit,,Paredit}).,Paredit).}
-Geiser's support for writing Scheme code adds to Emacs'
+that language is sexpy (especially if you use
+@ifhtml
+@ref{paredit,,Paredit}).
+@end ifhtml
+@ifnothtml
+Paredit).
+@end ifnothtml
+ Geiser's support for writing Scheme code adds to Emacs'
@code{scheme-mode}, rather than supplanting it; and it does so by means
of a minor mode (unimaginatively dubbed @code{geiser-mode}) that defines
a bunch of new commands to try and, with the help of the same Scheme
@@ -52,8 +58,13 @@ tried to make Geiser as self-documenting as any self-respecting Emacs
package should be. If you follow this route, make sure to take a look at
Geiser's customization buffers (@kbd{M-x customize-group @key{RET}
geiser}): there's lot of fine-tuning available there. You might also
-want to take a glance at @alt{@ref{Cheat sheet}., the tables in
-@pxref{Cheat sheet, the cheat sheet}.}
+want to take a glance at
+@ifhtml
+our @ref{Cheat sheet,,cheat sheet}.
+@end ifhtml
+@ifnothtml
+the tables in @pxref{Cheat sheet, our cheat sheet}.
+@end ifnothtml
Since @i{geiser-mode} is a minor mode, you can toggle it with
@kbd{M-x geiser-mode}, and control its activation in hooks with the
@@ -82,9 +93,14 @@ how to make sure that that's actually the case.
As i've already mentioned a couple of times, @i{geiser-mode} needs a
running REPL to be operative. Thus, a common usage pattern will be
-for you to first call @code{run-geiser} or one of its variants
-(@pxref{choosing-impl,choosing implementations}), and then open
-some Scheme files;
+for you to first call @code{run-geiser}
+@ifhtml
+(or @ref{choosing-impl,,one of its variants}),
+@end ifhtml
+@ifnothtml
+(or one of its variants, e.g. @code{run-guile}),
+@end ifnothtml
+and then open some Scheme files;
but there's nothing wrong in first opening a couple Scheme buffers and
then starting the REPL (you can even find it more convenient, since
pressing @kbd{C-c C-z} in a Scheme buffer will start the REPL for
@@ -117,8 +133,14 @@ surrounded by @code{-*-} marks, as in:
@item
If you've customized @code{geiser-active-implementations} so that it's a
-single-element list (as explained @ref{choosing-impl,,here}), that
-element is used as the chosen implementation.
+single-element
+@ifnotinfo
+list (as explained in @ref{choosing-impl,,here}),
+@end ifnotinfo
+@ifinfo
+list,
+@end ifinfo
+that element is used as the chosen implementation.
@item
The contents of the file is scanned for hints on its associated
implementation. For instance, files that contain a @code{#lang}
@@ -188,7 +210,7 @@ If you use a numeric prefix, as in @kbd{C-u C-c C-z}, besides being
teleported to the REPL, the latter will switch to the namespace of the
Scheme source file (as if you had used @kbd{C-c C-m} in the REPL, with
the source file's module as argument; cf. discussion in
-@altr{Switching context,,Switching context,)}. This command is also
+@altr{Switching context,,Switching context,).}This command is also
bound to @kbd{C-c C-Z}, with a capital zed.
Once you're in the REPL, the same @kbd{C-c C-z} shortcut will bring
@@ -200,8 +222,14 @@ really handy, if you ask me.
@cindex switching schemes
If for some reason you're not happy with the Scheme implementation that
Geiser has assigned to your file, you can change it with @kbd{C-c C-s},
-and you probably should take a look at @alt{@ref{repl-association,,the
-previous subsection}, the previous subsection} to make sure that Geiser
+and you probably should take a look at
+@ifhtml
+@ref{repl-association,,the previous subsection}
+@end ifhtml
+@ifnothtml
+the previous subsection
+@end ifnothtml
+to make sure that Geiser
doesn't get confused again.
@subsubheading A note about context
diff --git a/doc/repl.texi b/doc/repl.texi
index 9d2194d..5a88b76 100644
--- a/doc/repl.texi
+++ b/doc/repl.texi
@@ -1,7 +1,7 @@
@node The REPL, Between the parens, Installation, Top
@chapter The REPL
@anchor{quick-start}
-If you've followed the indications in @ref{Setting it up}, your Emacs is
+If you've followed the instructions in @ref{Setting it up}, your Emacs is
now ready to start playing. Otherwise, i'll wait for you: when you're
ready, just come back here and proceed to the following sections.
@@ -133,8 +133,14 @@ The remaining commands are meatier, and deserve sections of their own.
@cindex current module, in REPL
@cindex ,enter vs. enter!
-In tune with Geiser's @alt{@ref{current-module,,modus operandi},modus
-operandi}, evaluations in the REPL take place in the namespace of the
+In tune with Geiser's
+@ifhtml
+@ref{current-module,,modus operandi},
+@end ifhtml
+@ifnothtml
+@i{modus operandi},
+@end ifnothtml
+evaluations in the REPL take place in the namespace of the
current module. As noted above, the REPL's prompt tells you the name of
the current module. To switch to a different one, you can use the
command @command{switch-to-geiser-module}, bound to @kbd{C-c C-m}.
@@ -245,8 +251,9 @@ name.
The list of exported bindings is shown, again, in a buffer belonging to
Geiser's documentation browser, where you have at your disposal a bunch
of navigation commands listed in @altr{Documentation browser,our
-cheat-sheet,Documentation browser,.} We'll have a bit more to say about
-the documentation browser in
+cheat-sheet,Documentation browser,.}
+
+We'll have a bit more to say about the documentation browser in
@altr{doc-browser,a later section,Documentation helpers,.}
@cindex jump, at the REPL