diff options
| author | Ludovic Courtès | 2008-01-30 18:01:55 +0100 |
|---|---|---|
| committer | Ludovic Courtès | 2008-01-30 18:01:55 +0100 |
| commit | 8ecd2364d74683c2561774c5a4edc3cf255ad13d (patch) | |
| tree | 66d00f85464ddcbc225128f82f6285c64aefcc6f | |
| parent | 92715cf0c58f41b580cab2c1a8d0e5112a230287 (diff) | |
| download | skribilo-8ecd2364d74683c2561774c5a4edc3cf255ad13d.tar.gz skribilo-8ecd2364d74683c2561774c5a4edc3cf255ad13d.tar.lz skribilo-8ecd2364d74683c2561774c5a4edc3cf255ad13d.zip | |
doc: Improve engine introduction.
| -rw-r--r-- | doc/modules/skribilo/documentation/env.scm | 1 | ||||
| -rw-r--r-- | doc/user/engine.skb | 19 |
2 files changed, 15 insertions, 5 deletions
diff --git a/doc/modules/skribilo/documentation/env.scm b/doc/modules/skribilo/documentation/env.scm index 7e481af..da4915a 100644 --- a/doc/modules/skribilo/documentation/env.scm +++ b/doc/modules/skribilo/documentation/env.scm @@ -48,3 +48,4 @@ (define-public *header-color* "#cccccc") (define-public *api-engines* (map find-engine '(html lout latex xml))) +(define-public *engine-src* "skribilo/engine.scm") diff --git a/doc/user/engine.skb b/doc/user/engine.skb index f80236e..cc3a702 100644 --- a/doc/user/engine.skb +++ b/doc/user/engine.skb @@ -20,8 +20,6 @@ ;;; USA. -(define *engine-src* "skribilo/engine.scm") - ;*---------------------------------------------------------------------*/ ;* Engine */ ;*---------------------------------------------------------------------*/ @@ -41,7 +39,7 @@ compiler instructs it to produce an HTML document using the ,(ref :text (p [This chapter describes procedures allowing the manipulation of engines in Skribilo documents or modules (creation, customization, etc.), as well as the available engines. Currently, the available -engines are:]) +engines are:] (resolve (lambda (n e env) (let* ((current-chapter (ast-chapter n)) @@ -56,7 +54,14 @@ engines are:]) (item (ref :text (markup-option s :title) :handle (handle s)))) sects))))) - + + [Engine customization provides tight control over the output produced +for each particular engine. In particular, it allows the style for each +output to be fine-tuned, be it HTML, PDF ,(it [via]) Lout, or anything +else. However, note that such fine-tuning usually requires good +knowledge of the output format (e.g., HTML/CSS, Lout, LaTeX).]) + + (section :title "Manipulating Engines" (subsection :title "Creating Engines" @@ -151,7 +156,11 @@ a custom.]) :common-args '() :skribe-source? #f :source *engine-src* - :idx *function-index*)) + :idx *function-index*) + + (p [In the documentation of available engines that follows, a +list of available customs is shown for each engine, along with each +custom's default value and a description.])) (subsection :title [Writing New Engines] |