aboutsummaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorLudovic Court`es2007-01-16 17:17:40 +0000
committerLudovic Court`es2007-01-16 17:17:40 +0000
commite3d0d2d69fe98177edf8a67080f2812aecc4fa43 (patch)
treefe354487eac420fefa53b74a069ccc1cd569ebd4 /doc/user
parent9395c1b3be80daa14c6f9e3de0aca8aa9670fc16 (diff)
downloadskribilo-e3d0d2d69fe98177edf8a67080f2812aecc4fa43.tar.gz
skribilo-e3d0d2d69fe98177edf8a67080f2812aecc4fa43.tar.lz
skribilo-e3d0d2d69fe98177edf8a67080f2812aecc4fa43.zip
Updated the LaTeX engine doc, mention `class-has-chapters?'.
* doc/modules/skribilo/documentation/manual.scm: When customizing the LaTeX engine to use the `book' class, set `class-has-chapters?' to `#t'. * doc/user/latexe.skb (LaTeX Customization): Documented `class-has-chapters?'. (LaTeX Document Class): Likewise. git-archimport-id: lcourtes@laas.fr--2006-libre/skribilo--devo--1.2--patch-2
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/latexe.skb34
1 files changed, 20 insertions, 14 deletions
diff --git a/doc/user/latexe.skb b/doc/user/latexe.skb
index feca728..c9fc50b 100644
--- a/doc/user/latexe.skb
+++ b/doc/user/latexe.skb
@@ -1,6 +1,7 @@
-;;; latexe.skb -- The documentation of the html engine
+;;; latexe.skb -- Documentation of the LaTeX engine.
;;;
;;; Copyright 2003, 2004 Manuel Serrano
+;;; Copyright 2007 Ludovic Courtès <ludovic.courtes@laas.fr>
;;;
;;;
;;; This program is free software; you can redistribute it and/or modify
@@ -22,16 +23,20 @@
;*---------------------------------------------------------------------*/
;* Document */
;*---------------------------------------------------------------------*/
-(section :title "LaTeX engine" :file #t
+(section :title "The LaTeX Engine" :file #t
(mark "latex-engine")
(index "LaTeX" :note "Engine")
(p [The LaTeX engine...])
- (subsection :title "The LaTeX customization"
+ (subsection :title "LaTeX Customization"
(doc-engine 'latex
- `((documentclass ,[A string declaring The LaTeX document class.])
+ `((documentclass ,[A string declaring the LaTeX document class.])
+ (class-has-chapters? ,[A boolean indicating whether the
+document class has a ,(code [chapter]) markup. If ,(code "#f"), then
+Skribilo's ,(code [chapter]) is mapped to LaTeX' ,(code [section]), and
+so on.])
(usepackage ,[The boolean ,(code "#f") if no package is used or a string declaring The LaTeX packages.])
(predocument ,[The boolean ,(code "#f") or a string to be written before the \\begin{document} statement.])
(postdocument ,[The boolean ,(code "#f") or a string to be written after the \\begin{document} statement.])
@@ -56,14 +61,15 @@
(index-page-ref "Indexes use page references."))
:source "skribilo/engine/latex.scm"))
- (subsection :title "LaTeX documentclass"
+ (subsection :title "LaTeX Document Class"
- (p [The default setting of the Skribe LaTeX engine is to produce
-a document using the ,(code "article") document class. In order to
-generate a document using ,(code "chapter") this must be changed because
-this LaTeX style does not define any ,(code "\\chapter") function. For
-instance, one may use the LaTeX ,(code "book") document class. Changing
-this setting can be done with expressions such as:
-,(prgm :language skribe [
-(let ((le (find-engine 'latex)))
- (engine-custom-set! le 'documentclass "\\\\documentclass{book}"))])])))
+ (p [The default setting of the Skribilo LaTeX engine is to produce
+a document using the ,(code "article") document class. In order to
+produce a document that uses a document class defining the ,(code
+"chapter") command (unlike the ,(code "article") class), the engine must
+be customized. Changing this setting can be done with expressions such
+as:
+
+,(prgm :language skribe [ (let ((le (find-engine 'latex)))
+ (engine-custom-set! le 'documentclass "\\\\documentclass{book}")
+ (engine-custom-set! le 'class-has-chapters? #t))])])))