From 2621b52339e7553db09e9f0e1cae24b695439439 Mon Sep 17 00:00:00 2001
From: Ludovic Courtès
Date: Mon, 21 Apr 2008 23:22:16 +0200
Subject: Document the `context' engine.

* doc/modules/skribilo/documentation/env.scm (*api-engines*): Add
  `context'.

* doc/user/contexte.skb: New file.

* doc/user/engine.skb: Include it.

* src/guile/skribilo/engine/context.scm (context-customs): Moved to the
  `make-engine' call so that automatic documentation extraction works.
---
 doc/modules/skribilo/documentation/env.scm |  2 +-
 doc/user/contexte.skb                      | 58 ++++++++++++++++++++++++++++++
 doc/user/engine.skb                        |  1 +
 3 files changed, 60 insertions(+), 1 deletion(-)
 create mode 100644 doc/user/contexte.skb

(limited to 'doc')

diff --git a/doc/modules/skribilo/documentation/env.scm b/doc/modules/skribilo/documentation/env.scm
index e49898c..6dc2955 100644
--- a/doc/modules/skribilo/documentation/env.scm
+++ b/doc/modules/skribilo/documentation/env.scm
@@ -48,5 +48,5 @@
 (define-public *disp-color* "#ccffcc")
 (define-public *header-color* "#cccccc")
 
-(define-public *api-engines* (map find-engine '(html lout latex xml)))
+(define-public *api-engines* (map find-engine '(html lout latex context xml)))
 (define-public *engine-src* "skribilo/engine.scm")
diff --git a/doc/user/contexte.skb b/doc/user/contexte.skb
new file mode 100644
index 0000000..3804356
--- /dev/null
+++ b/doc/user/contexte.skb
@@ -0,0 +1,58 @@
+;;; context.skb  --  Documentation of the ConTeXt engine.
+;;;
+;;; Copyright 2008  Ludovic Courtès <ludo@gnu.org>
+;;;
+;;;
+;;; This program is free software; you can redistribute it and/or modify
+;;; it under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 2 of the License, or
+;;; (at your option) any later version.
+;;;
+;;; This program is distributed in the hope that it will be useful,
+;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with this program; if not, write to the Free Software
+;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+;;; USA.
+
+
+;*---------------------------------------------------------------------*/
+;*    Document                                                         */
+;*---------------------------------------------------------------------*/
+(section :title "ConTeXt Engine" :file #t
+   (mark "context-engine")
+   (index "ConTeXt" :note "Engine")
+   
+   (p [The ,(tt [context]) engine produces documents for the ,(ref :text
+[ConTeXt] :url "http://www.pragma-ade.nl/") document layout system,
+which can then be used to produce high-quality PostScript or PDF
+output.])
+   
+   (section :title [ConTeXt Customization]
+      
+      (doc-engine 'context
+	 `((document-style ,[A string describing the document style.])
+	   (user-style     ,[A string denoting a the name of a file
+                             specifying user customization])
+	   (font-type      ,[A string denoting the default font family.])
+	   (font-size      ,[An integer representing the default font size.])
+	   (image-format   ,[A list of supported image formats.])
+
+	   (source-comment-color "The source comment color.")
+	   (source-error-color "The source error color.")
+	   (source-define-color "The source define color.")
+	   (source-module-color "The source module color.")
+	   (source-markup-color "The source markup color.")
+	   (source-thread-color "The source thread color.")
+	   (source-string-color "The source string color.")
+	   (source-bracket-color "The source bracket color.")
+	   (source-type-color "The source type color."))
+	 :source "skribilo/engine/context.scm")))
+
+;;; Local Variables:
+;;; coding: latin-1
+;;; ispell-local-dictionary: "american"
+;;; End:
diff --git a/doc/user/engine.skb b/doc/user/engine.skb
index cc3a702..d075ebc 100644
--- a/doc/user/engine.skb
+++ b/doc/user/engine.skb
@@ -196,6 +196,7 @@ This is all it takes to extend Skribilo's set of engines!])))
    (include "htmle.skb")
    (include "loute.skb")
    (include "latexe.skb")
+   (include "contexte.skb")
    (include "xmle.skb"))
 
 
-- 
cgit v1.2.3