diff options
author | Ludovic Courtès | 2008-04-21 23:22:16 +0200 |
---|---|---|
committer | Ludovic Courtès | 2008-04-21 23:22:16 +0200 |
commit | 2621b52339e7553db09e9f0e1cae24b695439439 (patch) | |
tree | bae3ca0328a67a841e5b46d487f2e5cb03d4412c | |
parent | 93b5f21b4a524fc07ea60f20ec363a6c5cfbcdf7 (diff) | |
download | skribilo-2621b52339e7553db09e9f0e1cae24b695439439.tar.gz skribilo-2621b52339e7553db09e9f0e1cae24b695439439.tar.lz skribilo-2621b52339e7553db09e9f0e1cae24b695439439.zip |
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.
-rw-r--r-- | doc/modules/skribilo/documentation/env.scm | 2 | ||||
-rw-r--r-- | doc/user/contexte.skb | 58 | ||||
-rw-r--r-- | doc/user/engine.skb | 1 | ||||
-rw-r--r-- | src/guile/skribilo/engine/context.scm | 38 |
4 files changed, 76 insertions, 23 deletions
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")) diff --git a/src/guile/skribilo/engine/context.scm b/src/guile/skribilo/engine/context.scm index 970b35f..110431f 100644 --- a/src/guile/skribilo/engine/context.scm +++ b/src/guile/skribilo/engine/context.scm @@ -1,6 +1,6 @@ ;;; context.scm -- ConTeXt engine. ;;; -;;; Copyright 2007 Ludovic Courtès <ludo@chbouib.org> +;;; Copyright 2007, 2008 Ludovic Courtès <ludo@chbouib.org> ;;; Copyright 2004 Erick Gallesio - I3S-CNRS/ESSI <eg@essi.fr> ;;; ;;; @@ -44,26 +44,6 @@ ;;; ====================================================================== -;;; context-customs ... -;;; ====================================================================== -(define context-customs - '((source-comment-color "#ffa600") - (source-error-color "red") - (source-define-color "#6959cf") - (source-module-color "#1919af") - (source-markup-color "#1919af") - (source-thread-color "#ad4386") - (source-string-color "red") - (source-bracket-color "red") - (source-type-color "#00cf00") - (index-page-ref #t) - (image-format ("jpg")) - (font-size 11) - (font-type "roman") - (user-style #f) - (document-style "book"))) - -;;; ====================================================================== ;;; context-encoding ... ;;; ====================================================================== (define context-encoding @@ -418,7 +398,21 @@ :delegate (find-engine 'base) :filter (make-string-replace context-encoding) :symbol-table (context-symbol-table (lambda (m) (format #f "$~a$" m))) - :custom context-customs))) + :custom '((source-comment-color "#ffa600") + (source-error-color "red") + (source-define-color "#6959cf") + (source-module-color "#1919af") + (source-markup-color "#1919af") + (source-thread-color "#ad4386") + (source-string-color "red") + (source-bracket-color "red") + (source-type-color "#00cf00") + ;;(index-page-ref #t) + (image-format ("jpg")) + (font-size 11) + (font-type "roman") + (user-style #f) + (document-style "book"))))) ;;; ====================================================================== ;;; document ... |