From 7f647a811bdf40de168428faeccb549ccf56804c Mon Sep 17 00:00:00 2001
From: "simon.hengel" <simon.hengel@wiktory.org>
Date: Mon, 12 Apr 2010 19:09:16 +0000
Subject: Add documentation for interactive examples

---
 doc/haddock.xml | 38 ++++++++++++++++++++++++++++++++------
 1 file changed, 32 insertions(+), 6 deletions(-)

(limited to 'doc/haddock.xml')

diff --git a/doc/haddock.xml b/doc/haddock.xml
index 680f7980..b779f835 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -1409,12 +1409,15 @@ module A where
 	one of these special characters, precede it with a backslash
 	(<literal>\</literal>).</para>
 
-	<para>Additionally, the character <literal>&gt;</literal> has
-	a special meaning at the beginning of a line, and the
-	following characters have special meanings at the beginning of
-	a paragraph:
-	<literal>*</literal>, <literal>-</literal>.  These characters
-	can also be escaped using <literal>\</literal>.</para>
+	<para>Additionally, the character <literal>&gt;</literal> and
+	the character sequence <literal>ghci&gt;</literal> have special
+	meanings at the beginning of a line.  The following characters
+	have special meanings at the beginning of a paragraph:
+	<literal>*</literal>, <literal>-</literal>.  The single
+	characters can also be escaped using <literal>\</literal>.  To
+	get a literal <literal>ghci&gt;</literal> at the beginning of a
+	line, prefix the <literal>&gt;</literal> with a
+	backslash.</para>
       </section>
 
       <section>
@@ -1465,6 +1468,29 @@ module A where
         interprets markup as normal inside the code block.</para>
       </section>
 
+      <section>
+	<title>Interactive Examples</title>
+
+	<para> Haddock has markup support for interactive examples, that
+	illustrate the use of source constructs in a
+	<emphasis>read-eval-print loop (REPL)</emphasis>.  An
+	interactive example is introduced with
+	<literal>ghci&gt;</literal> followed by an expression followed
+	by zero or more result lines:</para>
+
+<programlisting>
+-- | Two examples are given bellow:
+--
+-- ghci&gt; fib 10
+-- 55
+--
+-- ghci&gt; putStrLn "foo\nbar"
+-- foo
+-- bar
+</programlisting>
+      </section>
+
+
       <section>
 	<title>Hyperlinked Identifiers</title>
 
-- 
cgit v1.2.3