From 401d6f8f681e758c7cf391475d758db32135b1bd Mon Sep 17 00:00:00 2001
From: Ludovic Courtès
Date: Tue, 29 May 2012 23:30:10 +0200
Subject: doc: Add a `lout-illustration' example.

* doc/modules/skribilo/documentation/api.scm (le)[inline-definitions-proc]:
  Add @TeX and @LaTeX definitions.

* doc/user/src/lout-illustration.skb: New file.
* doc/user/Makefile.am (EXTRA_DIST): Add it.

* doc/user/loute.skb (Additional Markup): Add
  `src/lout-illustration.skb' as an example.
---
 doc/user/loute.skb | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'doc/user/loute.skb')

diff --git a/doc/user/loute.skb b/doc/user/loute.skb
index d26b0ed..ecfef34 100644
--- a/doc/user/loute.skb
+++ b/doc/user/loute.skb
@@ -220,7 +220,17 @@ is ,(tt [#f]).]))
                   :common-args '()
 		  :source #f
                   :def '(define-markup (lout-illustration :rest
-		  illustration :key (file #f) ident alt) ...))))
+		  illustration :key (file #f) ident alt) ...))
+      
+      (p [The following example shows a simple diagram.  When using the
+,(tt [lout]) engine, the diagram is integrated in-line in the document.
+When using other engines, it is integrated using ,(markup-ref
+"image").])
+      
+      (example-produce
+        (example :legend "A Lout illustration"
+          (prgm :file "src/lout-illustration.skb"))
+        (disp (include "src/lout-illustration.skb")))))
 
 ;;; Local Variables:
 ;;; ispell-local-dictionary: "american"
-- 
cgit v1.2.3