From 7838371bba6e76848ff03df76c9fd428bbd05ddf Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Sun, 12 Sep 2010 19:20:47 +0200 Subject: Docs: include images only in HTML pages --- doc/fun.texi | 8 ++++---- doc/geiser.texi | 3 ++- doc/macros.texi | 11 ++++++++--- doc/repl.texi | 8 ++++---- 4 files changed, 18 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/fun.texi b/doc/fun.texi index 0b6e215..746b608 100644 --- a/doc/fun.texi +++ b/doc/fun.texi @@ -1,4 +1,4 @@ -@node Fun between the parens +@node Fun between the parens, Index, The REPL, Top @chapter Fun between the parens A good @repl{} is a must, but just about half the story of a good Scheme @@ -294,7 +294,7 @@ information about the identifier, including its docstring (if any; unfortunately, that an implementation supports docstrings doesn't mean that they're used everywhere). -@image{img/docstring} +@imgc{docstring} Pressing @kbd{q} in the documentation buffer will bring you back, enlightened, to where you were. There's also a handful of other @@ -393,7 +393,7 @@ jump to the offending spot; or invoke Emacs' stock commands @code{next-error} and @code{previous-error}, bound to @kbd{M-g n} and @kbd{M-g p} by default). -@image{img/eval-error} +@imgc{eval-error} The Racket backtrace also highlights the exception type, making it clickable. Following the link will open the documentation corresponding @@ -409,7 +409,7 @@ there you have the debugger at your disposal, with the REPL's current module set to that of the offender, and a host of special debugging commands that are described in Guile's fine documentation. -@image{img/guile-eval-error} +@imgc{guile-eval-error} In addition, Guile will sometimes report warnings for otherwise successful evaluations. In those cases, it won't enter the debugger, and diff --git a/doc/geiser.texi b/doc/geiser.texi index 61e99fb..9f95d9b 100644 --- a/doc/geiser.texi +++ b/doc/geiser.texi @@ -92,7 +92,8 @@ Fun between the parens * Activating Geiser:: * The source and the REPL:: * Documentation helpers:: -* Evaluating Scheme code:: +* To eval or not to eval:: +* To err perchance to debug:: * Jumping around:: * Geiser writes for you:: diff --git a/doc/macros.texi b/doc/macros.texi index b38d170..712370a 100644 --- a/doc/macros.texi +++ b/doc/macros.texi @@ -8,8 +8,13 @@ @end html @end ifhtml -@ifnothtml -@image{img/\FILE\} -@end ifnothtml +@end macro + +@macro imgc{FILE} +@ifhtml +@html + +@end html +@end ifhtml @end macro diff --git a/doc/repl.texi b/doc/repl.texi index ce0eaff..9b7b688 100644 --- a/doc/repl.texi +++ b/doc/repl.texi @@ -27,7 +27,7 @@ asking: see @ref{active-implementations,,below}). Tabbing for completion will offer you, as of this writing, @code{guile} and @code{racket}. Just choose your poison, and a new @repl{} buffer will pop-up. -@image{img/repls} +@imgc{repls} If all went according to plan, you'll be facing an implementation-dependent banner, followed by an interactive prompt. @@ -116,7 +116,7 @@ is available when introducing the new module name, using the @kbd{@key{TAB}} key. Pressing it at the command's prompt will offer you a prefix-aware list of available module names. -@image{img/mod-completion} +@imgc{mod-completion} Which brings me to the next group of @repl{} commands. @@ -163,7 +163,7 @@ notice that @i{A} in the mode-line?), Geiser's gerbils will be scanning what you type and showing (unless you silent them with @kbd{C-c C-a}) information about the identifier nearest to point. -@image{img/repl-autodoc} +@imgc{repl-autodoc} If that identifier corresponds to a variable visible in the current namespace, you'll see the module it belongs to and its value. For @@ -195,7 +195,7 @@ Finally, Geiser can produce for you a list, classified by kind, of the identifiers exported by a given module: all you need to do is press @kbd{C-c C-d m}, and type or complete the desired module's name. -@image{img/repl-mod} +@imgc{repl-mod} The list of exported bindings is shown in a buffer belonging to Geiser's documentation browser, of which more details are given in forthcoming -- cgit v1.2.3