aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Court`es2006-11-28 12:40:13 +0000
committerLudovic Court`es2006-11-28 12:40:13 +0000
commit9f08ec317436acb62fb0f47c1ea3f1a1460f88e1 (patch)
treea1a250a54d1af66815077616e4b1425e0d931e1d
parent56bd1e10d39a97f53f0c8ebefcdef909d99260bb (diff)
downloadskribilo-9f08ec317436acb62fb0f47c1ea3f1a1460f88e1.tar.gz
skribilo-9f08ec317436acb62fb0f47c1ea3f1a1460f88e1.tar.lz
skribilo-9f08ec317436acb62fb0f47c1ea3f1a1460f88e1.zip
doc: Documented `eq' and the `:div-style' option.
* doc/user/char.skb (Symbols): Added an ident. * doc/user/eq.skb (Equation Formatting)[Summary]: New section. Use `doc-markup' as should have already been the case and document `:div-style'. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-81
-rw-r--r--doc/user/char.skb1
-rw-r--r--doc/user/eq.skb26
2 files changed, 24 insertions, 3 deletions
diff --git a/doc/user/char.skb b/doc/user/char.skb
index 16c4625..b2f94e2 100644
--- a/doc/user/char.skb
+++ b/doc/user/char.skb
@@ -67,6 +67,7 @@ are replaced with the actual values of the arguments ,(param 'node).])
;*--- Symbols ---------------------------------------------------------*/
(subsection :title "Symbols"
+ :ident "symbols"
(p [The function ,(code "symbol") introduces special symbols in the
produced file. Note that the rendering of symbols is unportable. It depends
diff --git a/doc/user/eq.skb b/doc/user/eq.skb
index a611f88..455832b 100644
--- a/doc/user/eq.skb
+++ b/doc/user/eq.skb
@@ -57,7 +57,7 @@ much like any other kind of markup. However, the resulting syntax
is very verbose and hard to read.])
(p [Fortunately, the ,(tt [eq]) package allows for the use of a
-much simple syntax. ]
+much simpler syntax. ]
(example-produce
(example :legend "Example of a simple equation"
@@ -69,10 +69,30 @@ may have already recognized its ,(emph [prefix notation]). Note that,
unlike in the previous example, the equation itself if ,(emph [quoted]),
that is, preceded by the ,(tt [']) sign. Additionally, when referring
to a symbol (such as the Greek letter ,(symbol "phi")), you no longer
-need to use the ,(tt [symbol]) markup (,(ref :text [see subsection]
-:subsection "Symbols")).]))
+need to use the ,(tt [symbol]) markup (,(numref :text [see Section]
+:ident "symbols")).]))
+ ;; FIXME: Write this.
(section :title [Rendering])
+
+ (section :title [Summary]
+
+ (p [The options available for the top-level ,(code [eq]) markup
+are summarized here:])
+
+ (doc-markup 'eq
+ `((:inline? [A boolean indicating whether the equation
+is to appear "inline", i.e., within a paragraph. If the engine supports
+it, it may adjust various parameters such as in-equation spacing
+accordingly.])
+ (:renderer [The engine that should be used to render
+the equation. This allows, for instance, to use the Lout engine to
+render equations in HTML.])
+ (:div-style [A symbol denoting the default style for
+divisions. This should be one of ,(code [over]), ,(code [fraction]),
+,(code [div]) and ,(code [slash]). Per-,(code [eq:/]) ,(code
+[:div-style]) options override this setting.]))
+ :source "skribilo/package/eq.scm"))
)