diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/modules/Makefile.am | 3 | ||||
-rw-r--r-- | doc/modules/skribilo/Makefile.am | 3 | ||||
-rw-r--r-- | doc/modules/skribilo/documentation/Makefile.am | 3 | ||||
-rw-r--r-- | doc/modules/skribilo/documentation/api.scm (renamed from doc/skr/api.skr) | 26 | ||||
-rw-r--r-- | doc/modules/skribilo/documentation/env.scm | 47 | ||||
-rw-r--r-- | doc/modules/skribilo/documentation/extension.scm (renamed from doc/skr/extension.skr) | 9 | ||||
-rw-r--r-- | doc/modules/skribilo/documentation/manual.scm (renamed from doc/skr/manual.skr) | 33 | ||||
-rw-r--r-- | doc/skr/Makefile.am | 3 | ||||
-rw-r--r-- | doc/skr/env.skr | 43 | ||||
-rw-r--r-- | doc/user/Makefile.am | 3 | ||||
-rw-r--r-- | doc/user/user.skb | 18 |
12 files changed, 127 insertions, 66 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 23ca4ec..871a842 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1 +1 @@ -SUBDIRS = user skr img dir +SUBDIRS = user modules img dir diff --git a/doc/modules/Makefile.am b/doc/modules/Makefile.am new file mode 100644 index 0000000..1daf926 --- /dev/null +++ b/doc/modules/Makefile.am @@ -0,0 +1,3 @@ +SUBDIRS = skribilo + +## arch-tag: 9c90dd7b-0ee7-44b9-ab41-5283d1bf1fb9 diff --git a/doc/modules/skribilo/Makefile.am b/doc/modules/skribilo/Makefile.am new file mode 100644 index 0000000..71e8c64 --- /dev/null +++ b/doc/modules/skribilo/Makefile.am @@ -0,0 +1,3 @@ +SUBDIRS = documentation + +## arch-tag: af599d8d-2e67-49b3-afdf-aa2dba5a7c4a diff --git a/doc/modules/skribilo/documentation/Makefile.am b/doc/modules/skribilo/documentation/Makefile.am new file mode 100644 index 0000000..1562b0a --- /dev/null +++ b/doc/modules/skribilo/documentation/Makefile.am @@ -0,0 +1,3 @@ +EXTRA_DIST = api.scm env.scm extension.scm manual.scm + +## arch-tag: 171ec210-e895-42ce-b068-da10ed5c2551 diff --git a/doc/skr/api.skr b/doc/modules/skribilo/documentation/api.scm index d014fbd..d27d074 100644 --- a/doc/skr/api.skr +++ b/doc/modules/skribilo/documentation/api.scm @@ -1,4 +1,4 @@ -;;; api.skr -- The style for documenting Scheme APIs. +;;; api.scm -- The style for documenting Scheme APIs. ;;; ;;; Copyright 2003, 2004 Manuel Serrano ;;; Copyright 2005, 2006 Ludovic Courtès <ludovic.courtes@laas.fr> @@ -19,10 +19,28 @@ ;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, ;;; USA. -(use-modules (ice-9 match) - (skribilo reader) ;; `make-reader' - (skribilo utils syntax)) ;; `%skribilo-module-reader' +(define-module (skribilo documentation api) + :use-module (skribilo reader) + :use-module (skribilo engine) + :use-module (skribilo writer) + :use-module (skribilo ast) + :use-module (skribilo output) + :use-module (skribilo lib) ;; `define-markup' + :use-module (skribilo utils keywords) + :use-module (skribilo utils compat) + :use-module (skribilo utils syntax) ;; `%skribilo-module-reader' + :use-module (skribilo package base) + :use-module (skribilo documentation manual) ;; `*markup-index*' + :use-module (skribilo documentation env) ;; `*api-engines*' + + :use-module (srfi srfi-1) + :use-module (ice-9 match) + :use-module (ice-9 optargs)) + +(fluid-set! current-reader (make-reader 'skribe)) + + ;*---------------------------------------------------------------------*/ ;* Html configuration */ ;*---------------------------------------------------------------------*/ diff --git a/doc/modules/skribilo/documentation/env.scm b/doc/modules/skribilo/documentation/env.scm new file mode 100644 index 0000000..569f194 --- /dev/null +++ b/doc/modules/skribilo/documentation/env.scm @@ -0,0 +1,47 @@ +;;; env.scm -- The environment variables for the documentation. +;;; +;;; Copyright 2003, 2004 Manuel Serrano +;;; Copyright 2005, 2006 Ludovic Courtès <ludovic.courtes@laas.fr> +;;; +;;; +;;; 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. + +(define-module (skribilo documentation env) + :use-module (skribilo config) + :use-module (skribilo engine)) + +(define-public *serrano-url* "http://www.inria.fr/mimosa/Manuel.Serrano") +(define-public *serrano-mail* "Manuel.Serrano@sophia.inria.fr") +(define-public *courtes-mail* "ludovic.courtes@laas.fr") +(define-public *html-url* "http://www.w3.org/TR/html4") +(define-public *html-form* "interact/forms.html") +(define-public *emacs-url* "http://www.gnu.org/software/emacs") +(define-public *xemacs-url* "http://www.xemacs.org") +(define-public *texinfo-url* "http://www.texinfo.org") +(define-public *r5rs-url* "http://www.inria.fr/mimosa/fp/Bigloo/doc/r5rs.html") +(define-public *bigloo-url* "http://www.inria.fr/mimosa/fp/Bigloo") +(define-public *skribe-user-doc-url* (string-append (skribe-doc-dir) "/user.html")) +(define-public *skribe-dir-doc-url* (string-append (skribe-doc-dir) "/dir.html")) + +(define-public *prgm-width* 97.) +(define-public *prgm-skribe-color* "#ffffcc") +(define-public *prgm-default-color* "#ffffcc") +(define-public *prgm-xml-color* "#ffcccc") +(define-public *prgm-example-color* "#ccccff") +(define-public *disp-color* "#ccffcc") +(define-public *header-color* "#cccccc") + +(define-public *api-engines* (map find-engine '(html latex xml))) diff --git a/doc/skr/extension.skr b/doc/modules/skribilo/documentation/extension.scm index f611b5a..e012cb2 100644 --- a/doc/skr/extension.skr +++ b/doc/modules/skribilo/documentation/extension.scm @@ -1,4 +1,4 @@ -;;; extension.skr -- The Skribe package for documenting extensions +;;; extension.scm -- The Skribe package for documenting extensions ;;; ;;; Copyright 2003, 2004 Manuel Serrano ;;; @@ -18,6 +18,13 @@ ;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, ;;; USA. +(define-module (skribilo documentation extension) + :use-module (skribilo reader) + :use-module (skribilo utils compat)) + +(fluid-set! current-reader (make-reader 'skribe)) + + ;*---------------------------------------------------------------------*/ ;* extension */ ;*---------------------------------------------------------------------*/ diff --git a/doc/skr/manual.skr b/doc/modules/skribilo/documentation/manual.scm index 643772e..f2a6cdd 100644 --- a/doc/skr/manual.skr +++ b/doc/modules/skribilo/documentation/manual.scm @@ -1,4 +1,4 @@ -;;; manual.skr -- Skribe manuals and documentation pages style +;;; manual.scm -- Skribe manuals and documentation pages style ;;; ;;; Copyright 2003, 2004 Manuel Serrano ;;; @@ -18,6 +18,37 @@ ;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, ;;; USA. +(define-module (skribilo documentation manual) + :use-module (skribilo reader) + :use-module (skribilo engine) + :use-module (skribilo writer) + :use-module (skribilo ast) + :use-module (skribilo lib) ;; `define-markup' + :use-module (skribilo resolve) + :use-module (skribilo output) + :use-module (skribilo utils keywords) + :use-module (skribilo utils compat) + :use-module (skribilo utils syntax) ;; `when' + + :use-module (skribilo documentation env) + :use-module (skribilo package base) + :use-module (skribilo prog) + :use-module (skribilo coloring lisp) + :use-module (skribilo coloring xml) + + :use-module (ice-9 optargs)) + +(fluid-set! current-reader (make-reader 'skribe)) + + +;*---------------------------------------------------------------------*/ +;* The various indexes */ +;*---------------------------------------------------------------------*/ +(define-public *markup-index* (make-index "markup")) +(define-public *custom-index* (make-index "custom")) +(define-public *function-index* (make-index "function")) +(define-public *package-index* (make-index "package")) + ;*---------------------------------------------------------------------*/ ;* Base configuration */ ;*---------------------------------------------------------------------*/ diff --git a/doc/skr/Makefile.am b/doc/skr/Makefile.am deleted file mode 100644 index 7b8b369..0000000 --- a/doc/skr/Makefile.am +++ /dev/null @@ -1,3 +0,0 @@ -EXTRA_DIST = api.skr env.skr extension.skr manual.skr - -## arch-tag: 171ec210-e895-42ce-b068-da10ed5c2551 diff --git a/doc/skr/env.skr b/doc/skr/env.skr deleted file mode 100644 index 0eabdff..0000000 --- a/doc/skr/env.skr +++ /dev/null @@ -1,43 +0,0 @@ -;;; env.skr -- The environment variables for the documentation. -;;; -;;; Copyright 2003, 2004 Manuel Serrano -;;; Copyright 2005, 2006 Ludovic Courtès <ludovic.courtes@laas.fr> -;;; -;;; -;;; 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. - -(define *serrano-url* "http://www.inria.fr/mimosa/Manuel.Serrano") -(define *serrano-mail* "Manuel.Serrano@sophia.inria.fr") -(define *courtes-mail* "ludovic.courtes@laas.fr") -(define *html-url* "http://www.w3.org/TR/html4") -(define *html-form* "interact/forms.html") -(define *emacs-url* "http://www.gnu.org/software/emacs") -(define *xemacs-url* "http://www.xemacs.org") -(define *texinfo-url* "http://www.texinfo.org") -(define *r5rs-url* "http://www.inria.fr/mimosa/fp/Bigloo/doc/r5rs.html") -(define *bigloo-url* "http://www.inria.fr/mimosa/fp/Bigloo") -(define *skribe-user-doc-url* (string-append (skribe-doc-dir) "/user.html")) -(define *skribe-dir-doc-url* (string-append (skribe-doc-dir) "/dir.html")) - -(define *prgm-width* 97.) -(define *prgm-skribe-color* "#ffffcc") -(define *prgm-default-color* "#ffffcc") -(define *prgm-xml-color* "#ffcccc") -(define *prgm-example-color* "#ccccff") -(define *disp-color* "#ccffcc") -(define *header-color* "#cccccc") - -(define *api-engines* (map find-engine '(html latex xml))) diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am index 3428ad5..f3c6620 100644 --- a/doc/user/Makefile.am +++ b/doc/user/Makefile.am @@ -12,7 +12,8 @@ BUILT_SOURCES = doc-config.scm html_DATA = user.html skribilo = $(top_srcdir)/src/skribilo -load_path = $(top_srcdir)/src/guile:$(top_srcdir)/src/guile/skribilo/package +load_path = $(top_srcdir)/src/guile:$(top_srcdir)/src/guile/skribilo/package:$(top_builddir)/src/guile:$(top_srcdir)/doc/modules + %.html: %.skb GUILE_LOAD_PATH=$(load_path):$$GUILE_LOAD_PATH \ diff --git a/doc/user/user.skb b/doc/user/user.skb index 13fae63..5cfe209 100644 --- a/doc/user/user.skb +++ b/doc/user/user.skb @@ -1,6 +1,7 @@ ;;; user.skb -- The Skribilo user manual. ;;; ;;; Copyright 2001, 2002, 2003, 2004 Manuel Serrano +;;; Copyright 2005, 2006 Ludovic Courtès <ludovic.courtes@laas.fr> ;;; ;;; ;;; This program is free software; you can redistribute it and/or modify @@ -21,10 +22,11 @@ ;*---------------------------------------------------------------------*/ ;* The Skribe documentation style */ ;*---------------------------------------------------------------------*/ -(skribe-load "web-book.skr") -(skribe-load "skr/env.skr") -(skribe-load "skr/manual.skr") -(skribe-load "skr/api.skr") +(use-modules (skribilo package web-book) + (skribilo documentation env) + (skribilo documentation manual) + (skribilo documentation api)) + ;*---------------------------------------------------------------------*/ ;* Packages */ @@ -51,14 +53,6 @@ (let ((le (find-engine 'lout))) (engine-custom-set! le 'document-type 'doc)) -;*---------------------------------------------------------------------*/ -;* The various indexes */ -;*---------------------------------------------------------------------*/ -(define *markup-index* (make-index "markup")) -(define *custom-index* (make-index "custom")) -(define *function-index* (make-index "function")) -(define *package-index* (make-index "package")) - ;*---------------------------------------------------------------------*/ ;* The document */ |