summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Court`es2007-06-11 14:36:24 +0000
committerLudovic Court`es2007-06-11 14:36:24 +0000
commit1f48b0b69eda0e6b4262d69a77c6adbc13887159 (patch)
tree21a231da00aa6a9592b00762fe4b71388e4fb03f
parent9de369aeabb484175f8784c41dbad0592b5db91e (diff)
downloadskribilo-1f48b0b69eda0e6b4262d69a77c6adbc13887159.tar.gz
skribilo-1f48b0b69eda0e6b4262d69a77c6adbc13887159.tar.lz
skribilo-1f48b0b69eda0e6b4262d69a77c6adbc13887159.zip
Updated the top-level documentation files.
* configure.ac: Changed the bug report address to `skribilo-users@nongnu.org'. git-archimport-id: lcourtes@laas.fr--2006-libre/skribilo--devo--1.2--patch-73
-rw-r--r--README94
-rw-r--r--README.Skribe69
-rw-r--r--TODO32
-rw-r--r--configure.ac10
4 files changed, 158 insertions, 47 deletions
diff --git a/README b/README
index db68b22..596d75a 100644
--- a/README
+++ b/README
@@ -1,69 +1,79 @@
-What is Skribe
-**************
+Skribilo
+========
-Skribe is programming language design for the production of electronic
-documents. With Skribe one can:
-
- - Produce HTML web pages.
- - Produce PS files.
- - ...
+Skribilo is a document authoring system allowing users to produce
+documents in a variety of formats (HTML, PostScript, PDF, XML, etc.)
+from a single source document, while still retaining fine-grain control
+over the output.
-One may also:
+Beside rudimentary features provided by the `base' package, Skribilo
+provides packages for the production of colored program source code,
+bibliographies, pie charts, mathematical equations, and more.
- - Translate Texinfo files into HTML.
+Skribilo is based on the Scheme programming language and is highly
+extensible: it is easy to define new documentation primitives (called
+"markups") and their rendering in each output format.
- - re-use BibTex bibliography databases.
+Skribilo's core is written in mostly-portable Scheme (i.e., uses
+standard APIs such as SRFIs rather than Guile-specific APIs whenever
+that is possible), making it intelligible and hackable for most Scheme
+programmers.
+For more information, see:
-Obtaining Skribe
-****************
+ http://www.nongnu.org/skribilo/
-New versions of Skribe may downloaded from:
- ftp://ftp-sop.inria.fr/mimosa/fp/Skribe
+Requirements
+............
+You need at least:
-Skribe distrubtion
-******************
+ * GNU Guile >= 1.8.x
+ http://www.gnu.org/software/guile/
-The Skribe distribution consists of several directories:
+ * Guile-Reader >= 0.3
+ http://www.nongnu.org/guile-reader/
- INSTALL installation instructions.
+ * Guile-Lib (any version)
+ http://home.gna.org/guile-lib/
- Makefile the Makefile to compile Skribe.
+Optionally, you may want to install one of the following document layout
+programs to produce PS/PDF files:
- README this document.
+ * Lout
+ http://lout.sourceforge.net/
- README.java specific information regarding the JVM port of Skribe.
+ * LaTeX
+ http://www.latex-project.org/
- etc private directory.
+ * ConTeXt
+ http://www.pragma-ade.nl/
- bin the directory where binary files are compiled to.
+Optionally, to produce pie charts, you may want to use:
- lib the directory where Skribe libraries are compiled to.
+ * Ploticus
+ http://ploticus.sourceforge.net/
- configure configuration driver script.
-
- emacs Skribe emacs mode.
+This is it!
- examples Various example of Skribe texts.
- doc the Skribe sources for Skribe manuals.
+History
+.......
- src the Scheme source code for Skribe.
+Skribilo is based on the Skribe code base, written by Manuel Serrano and
+Erick Gallesio. See `README.Skribe' for the original Skribe `README'
+file, or visit:
- skr the Skribe source code for the Skribe engines and styles.
+ http://www-sop.inria.fr/mimosa/fp/Skribe/
- tools the Bigloo source code for the Texi->Skribe and BibTex->Skribe
- compilers.
+I am thankful to them for implementing Skribe!
-Acknowledgements
-****************
+June 2007,
+Ludovic Courtès <ludo@chbouib.org>.
-We thank all the people who helped me while writing Skribe. My first
-though goes to Frederic Boussinot who's the first pre-alpha-tester of
-Skribe always volunteering for new testing new features ;-) I then
-thanks all the people that send me fixes, suggestions and
-improvements, that is, all the people that appear in the ChangeLog
-file. Many thanks to all of you.
+;;; Local Variables:
+;;; mode: text
+;;; coding: utf-8
+;;; End:
diff --git a/README.Skribe b/README.Skribe
new file mode 100644
index 0000000..db68b22
--- /dev/null
+++ b/README.Skribe
@@ -0,0 +1,69 @@
+What is Skribe
+**************
+
+Skribe is programming language design for the production of electronic
+documents. With Skribe one can:
+
+ - Produce HTML web pages.
+ - Produce PS files.
+ - ...
+
+One may also:
+
+ - Translate Texinfo files into HTML.
+
+ - re-use BibTex bibliography databases.
+
+
+Obtaining Skribe
+****************
+
+New versions of Skribe may downloaded from:
+
+ ftp://ftp-sop.inria.fr/mimosa/fp/Skribe
+
+
+Skribe distrubtion
+******************
+
+The Skribe distribution consists of several directories:
+
+ INSTALL installation instructions.
+
+ Makefile the Makefile to compile Skribe.
+
+ README this document.
+
+ README.java specific information regarding the JVM port of Skribe.
+
+ etc private directory.
+
+ bin the directory where binary files are compiled to.
+
+ lib the directory where Skribe libraries are compiled to.
+
+ configure configuration driver script.
+
+ emacs Skribe emacs mode.
+
+ examples Various example of Skribe texts.
+
+ doc the Skribe sources for Skribe manuals.
+
+ src the Scheme source code for Skribe.
+
+ skr the Skribe source code for the Skribe engines and styles.
+
+ tools the Bigloo source code for the Texi->Skribe and BibTex->Skribe
+ compilers.
+
+
+Acknowledgements
+****************
+
+We thank all the people who helped me while writing Skribe. My first
+though goes to Frederic Boussinot who's the first pre-alpha-tester of
+Skribe always volunteering for new testing new features ;-) I then
+thanks all the people that send me fixes, suggestions and
+improvements, that is, all the people that appear in the ChangeLog
+file. Many thanks to all of you.
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..f98b32c
--- /dev/null
+++ b/TODO
@@ -0,0 +1,32 @@
+-*- Outline -*-
+
+* Important Items (Release Blockers)
+
+** Have both a Skribe compat module and a "native"
+In `(skribilo module)', it should be possible to create either a Skribe
+compatibility module that pulls all the compatibility bindings, or a
+Skribilo "native" module, with fewer bindings. This should translate
+into a `--compat=XXX' command-line option.
+
+** Update the documentation, remove Skribe legacy stuff
+** Have a PS/PDF version of the documentation (preferably using Lout)
+** Remove calls to `skribe-error', use SRFI-35 exceptions
+** Fix the HTML engine for `html-left-margin'
+Left margin doesn't display well when CSS is being used.
+
+
+* Longer-Term Items
+
+** Add a `if-engine' markup to avoid hacks with `engine-format?'
+Expressions like `(if (engine-format? "lout") xxx yyy)' are wrong,
+because they look at the value of `*current-engine*' rather than the
+engine actually used during resolution and output.
+
+** Write an Info engine based on Scribe's one
+** Write an XHTML engine
+** Write a nice GUI based on Andy's STexi browser
+** Render equations using MathML when rendering to HTML
+** Add stand-alone tools
+Such as `skribilo-to-bibtex', `bibtex-to-skribilo', etc.
+** Provide better internationalization
+
diff --git a/configure.ac b/configure.ac
index 52f0b7b..21a73fc 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2,7 +2,7 @@
# Process this file with autoconf to produce a configure script.
AC_PREREQ(2.59)
-AC_INIT(skribilo, 1.2, ludovic.courtes@laas.fr)
+AC_INIT(skribilo, 1.2, skribilo-users@nongnu.org)
AM_INIT_AUTOMAKE(skribilo, 1.2)
AC_CONFIG_SRCDIR([src/guile/skribilo/reader.scm])
@@ -27,12 +27,12 @@ GUILE_MODULE_REQUIRED([system reader])
GUILE_MODULE_REQUIRED([srfi srfi-35])
# Look for Lout.
-AC_PATH_PROG([LOUT], [lout], [not-found])
-AM_CONDITIONAL([HAVE_LOUT], [test "x$LOUT" != "xnot-found"])
+AC_PATH_PROG([LOUT], [lout])
+AM_CONDITIONAL([HAVE_LOUT], [test "x$LOUT" != "x"])
# Look for Ploticus.
-AC_PATH_PROGS([PLOTICUS], [ploticus pl], [not-found])
-AM_CONDITIONAL([HAVE_PLOTICUS], [test "x$PLOTICUS" != "xnot-found"])
+AC_PATH_PROGS([PLOTICUS], [ploticus pl])
+AM_CONDITIONAL([HAVE_PLOTICUS], [test "x$PLOTICUS" != "x"])
AC_SUBST([SKRIBILO_DOC_DIR], ["$datadir/doc/skribilo"])