Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the exscribe Reference Manual, version 0.96.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:42:13 2022 GMT+0.
Next: Systems, Previous: The exscribe Reference Manual, Up: The exscribe Reference Manual [Contents][Index]
Exscribe is a programmable document generation system written as an extension to Common Lisp. It is designed after Manuel Serrano's Scribe (itself based on Bigloo Scheme).
See the web page on: http://www.cliki.net/Exscribe
I use Exscribe for my personal website, but it is also used by the other editor at Bastiat.org: https://github.com/fare/bastiat.org
Exscribe is written and Copyright (c) 2005-2016 by François-René Rideau.
Exscribe is available under the terms of the bugroff license: http://tunes.org/legalese/bugroff.html
You may at your leisure use the MIT license instead: https://opensource.org/licenses/MIT
All dependencies for Exscribe are in Quicklisp except fare-scripts (as of 2016-05-03).
Exscribe depends on: alexandria, cl-launch, fare-memoization, fare-quasiquote, fare-scripts, fare-utils, meta, trivia, and scribble.
If compiled with the PDF backend, then Exscribe also depends on CL-Typesetting for generating documents. The PDF backend was written by Denis Mashkevich. However, the PDF backend isn't fully featured enough to be very useful at this time. Contributions welcome.
For projects regarding the extension of Exscribe, see http://fare.tunes.org/computing/term-project-proposal.html
You need CL-Launch to be already installed: http://www.cliki.net/CL-Launch
Create and install an exscribe binary by editing the Makefile
to suit your installation paths and then running make install:
mkdir ~/lib
make LISPS=sbcl INSTALL_LIB=~/lib install
The Lisp implementations are listed there in faster-to-slower order with respect to running my Exscribe document set (the largest one in the world!)
You may compile files your former Scribe files or new Exscribe documents with:
`exscribe -I ${INCLUDE_DIR1} -I ${INCLUDE_DIR2} -v -o foo.html foo.scr`
where INCLUDE_DIR1, etc., is where you store your style files.
Options:
-h -? --help show some help
-v --verbose output some information along the way
-I --include /PATH/to/style/ add directory to include path
-o --output destination-file which file to create
-H --html select the html backend
-P --pdf select the PDF backend
-M --many src dst files... compile files from src to dst
-D --debug enable the Lisp debugger
--repl provide the user a REPL
If you have trouble running your Scribe documents, tell me and I'll either add features to Exscribe or tell you how to tweak your document to make it compatible with both Scribe and Exscribe.
If you are debugging Exscribe or integrating it with your code, you may:
(asdf:load-system :exscribe) (in-package :exscribe)
And then you can compile a file with:
(add-exscribe-path "/home/fare/fare/www/")
(exscribe-load-document "/home/fare/fare/www/liberty/microsoft_monopoly.scr")
Or compile it as PDF with:
(add-exscribe-path "/home/fare/fare/www/")
(setf *exscribe-mode* 'pdf)
(with-open-file (*standard-output* "/home/fare/microsoft_monopoly.pdf"
:direction :output
:if-exists :rename-and-delete :if-does-not-exist :create
#+sbcl :element-type #+sbcl :default)
(exscribe-load-document "/home/fare/fare/www/liberty/microsoft_monopoly.scr"))
Exscribe is unhappily vastly under-documented.
Exscribe was originally modeled after Manuel Serrano's Scribe, and is indeed mostly compatible with it as far as the supported basic primitives go. You may read Scribe's documentation to get familiar with these basics: http://www-sop.inria.fr/members/Manuel.Serrano/scribe/
However, bear in mind the following differences and limitations:
Exscribe is based on Common Lisp rather than Scheme. A simple Scheme compatibility layer is provided in simple case only, but you should assume Common Lisp for any advanced programming.
My websites used to work equivalently with either Exscribe and Scribe based on a compatibility layer. But this compatibility layer has probably bitrotted, since Scribe hasn't being used since 2005 or so (and indeed it can't be compiled anymore from unmodified sources).
Error checking and reporting is minimal.
I use my Common Lisp's backtrace to locate and identify errors (with option --debug).
Only those Scribe features that I use have been implemented.
The HTML backend is used and well-maintained.
There is a proof-of-concept PDF backend, but it's not very featureful.
If you wonder about how some feature works, you may contact me. If you require more features, you may contact me, or even contract me. The source is also open for you to inspect and modify.
Also note that Manuel Serrano's Scribe is not directly related to Brian Reid's original Scribe, although it obviously sports some of the concepts originally developed in it. When pointed to this fact, Manuel Serrano's called his subsequent rewrite Skribe, but Skribe is somewhat incompatible with Manuel Serrano's Scribe, and is now just as unmaintained.
The website Bastiat.org makes extensive use of Exscribe, and its source code is available on github:
I used to have a small tarball of examples,
that included one essay that stresses most of the features of exscribe,
as well as a cl-compat.scr file for Manuel Serrano's Scribe, that shows you
(together with the cl-compat.scr file included in exscribe) how to write
programs that display correctly in both Scribe and Exscribe.
If you are interested in more, contact me.
I use SBCL, and it is the only implementation that I extensively and regularly test Exscribe with. But Exscribe should be portable and work on whichever is your favorite CL implementation. Earlier versions have been tested wit CMUCL, CLISP, Clozure CL, Allegro. The PDF backend depends on cl-typesetting that is not completely portable, but works at least on SBCL.
If you're interested in improving performance, here are the main issues.
Improve the cl-typesetting backend: add styles, boxes, real footnotes, etc.
Implement pictures and/or embedded cl-typesetting rendering code that appears correctly on both PDF and HTML output.
Use Matthias Koeppe's cl-bibtex and/or Cyrus Harmon's smarkup-latex.
Share and enjoy
Next: Files, Previous: Introduction, Up: The exscribe Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Programmatically create HTML documents from a high-level syntax
Francois-Rene Rideau
MIT
Exscribe helps you author documents and produce HTML output,
using a high-level syntax (Scribble) completely integrated with the CL syntax.
It notably features proper support for footnotes, table-of-contents, bibliography.
0.96.1
Next: Packages, Previous: Systems, Up: The exscribe Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: exscribe/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
exscribe (system).
Next: exscribe/macros.lisp, Previous: exscribe/exscribe.asd, Up: Lisp [Contents][Index]
exscribe (system).
Next: exscribe/specials.lisp, Previous: exscribe/packages.lisp, Up: Lisp [Contents][Index]
packages.lisp (file).
exscribe (system).
Next: exscribe/scheme-compat.lisp, Previous: exscribe/macros.lisp, Up: Lisp [Contents][Index]
macros.lisp (file).
exscribe (system).
*exscribe-directory* (special variable).
Next: exscribe/exscribe.lisp, Previous: exscribe/specials.lisp, Up: Lisp [Contents][Index]
specials.lisp (file).
exscribe (system).
Next: exscribe/exscribe-data.lisp, Previous: exscribe/scheme-compat.lisp, Up: Lisp [Contents][Index]
scheme-compat.lisp (file).
exscribe (system).
Next: exscribe/bibliography.lisp, Previous: exscribe/exscribe.lisp, Up: Lisp [Contents][Index]
exscribe.lisp (file).
exscribe (system).
Next: exscribe/html-dumper.lisp, Previous: exscribe/exscribe-data.lisp, Up: Lisp [Contents][Index]
exscribe-data.lisp (file).
exscribe (system).
Next: exscribe/exscribe-html.lisp, Previous: exscribe/bibliography.lisp, Up: Lisp [Contents][Index]
packages.lisp (file).
exscribe (system).
Next: exscribe/exscribe-txt.lisp, Previous: exscribe/html-dumper.lisp, Up: Lisp [Contents][Index]
exscribe (system).
Previous: exscribe/exscribe-html.lisp, Up: Lisp [Contents][Index]
exscribe-data.lisp (file).
exscribe (system).
Next: Definitions, Previous: Files, Up: The exscribe Reference Manual [Contents][Index]
Packages are listed by definition order.
HTML dumping functions
common-lisp.
Next: exscribe-data, Previous: html-dumper, Up: Packages [Contents][Index]
core infrastructure for exscribe
Next: exscribe-user, Previous: exscribe, Up: Packages [Contents][Index]
internal data representation for exscribe
Next: scheme-compat, Previous: exscribe-data, Up: Packages [Contents][Index]
Next: exscribe-html, Previous: exscribe-user, Up: Packages [Contents][Index]
innards of the Scheme in CL emulation
set-scheme-macro-characters (function).
Next: scheme-makeup, Previous: scheme-compat, Up: Packages [Contents][Index]
HTML backend for exscribe
Next: exscribe-txt, Previous: exscribe-html, Up: Packages [Contents][Index]
a poor emulation of Scheme in CL.
Meant to leverage simple code with Scheme syntax,
not to actually implement deep Scheme semantics.
common-lisp.
Previous: scheme-makeup, Up: Packages [Contents][Index]
Text backend for exscribe
Next: Indexes, Previous: Packages, Up: The exscribe Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Symbol macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
main text background color
The current document
The current document’s title
The current output mode used by exscribe
The search path for exscribe style files
footer for the current document body
counter for footnotes
place-holder for footnotes being currently processed
main text foreground color
counter for various generated labels
header for the current document body
functions to run after a first pass on the document
counter for sections
name of current section
section title background color
mapping from names to sections
counter for subsections
name of current subsection
counter for subsubsections
name of current subsubsection
header title background color
table of contents
Next: Macros, Previous: Special variables, Up: Public Interface [Contents][Index]
Next: Ordinary functions, Previous: Symbol macros, Up: Public Interface [Contents][Index]
Previous: Macros, Up: Public Interface [Contents][Index]
Extract text strings from a node.
Print supplied argument as HTML.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Symbol macros, Previous: Internals, Up: Internals [Contents][Index]
has exscribe already been initialized?
Next: Macros, Previous: Special variables, Up: Internals [Contents][Index]
Next: Ordinary functions, Previous: Symbol macros, Up: Internals [Contents][Index]
compiles and load specified SOURCE file, if either required by keyword
argument FORCE-RECOMPILE, or not yet existing, or not up-to-date.
Keyword argument VERBOSE specifies whether to be verbose.
Returns two values: the fasl path, and T if the file was (re)compiled
Returns true if NEW-FILE is strictly newer than OLD-FILE.
Previous: Definitions, Up: The exscribe Reference Manual [Contents][Index]
| Jump to: | *
A B C D E F G H I K L M N O P R S T U W X Z |
|---|
| Jump to: | *
A B C D E F G H I K L M N O P R S T U W X Z |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | *
C E S |
|---|
| Jump to: | *
C E S |
|---|
| Jump to: | B E F H M P S |
|---|
| Jump to: | B E F H M P S |
|---|