aboutsummaryrefslogtreecommitdiff
path: root/doc/user/loute.skb
diff options
context:
space:
mode:
authorLudovic Courtès2012-05-29 23:30:10 +0200
committerLudovic Courtès2012-05-29 23:30:10 +0200
commit401d6f8f681e758c7cf391475d758db32135b1bd (patch)
treefd1bad9daaf710965989e9e003071c4db143a214 /doc/user/loute.skb
parent979fc843a85ef8445c11cadc7d093184090f30c7 (diff)
downloadskribilo-401d6f8f681e758c7cf391475d758db32135b1bd.tar.gz
skribilo-401d6f8f681e758c7cf391475d758db32135b1bd.tar.lz
skribilo-401d6f8f681e758c7cf391475d758db32135b1bd.zip
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.
Diffstat (limited to 'doc/user/loute.skb')
-rw-r--r--doc/user/loute.skb12
1 files changed, 11 insertions, 1 deletions
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"