diff options
| author | Ludovic Courtes | 2006-12-02 10:45:56 +0000 |
|---|---|---|
| committer | Ludovic Courtes | 2006-12-02 10:45:56 +0000 |
| commit | 67142b1e7b350765ce68cb0b89668d5b3abc034b (patch) | |
| tree | 5e3ac2ab26ae447d589bc2cf174ff94cb563e845 /doc/user/eq.skb | |
| parent | 362047ce067c665d7f7e63de362a9e9f5dd50dbf (diff) | |
| download | skribilo-67142b1e7b350765ce68cb0b89668d5b3abc034b.tar.gz skribilo-67142b1e7b350765ce68cb0b89668d5b3abc034b.tar.lz skribilo-67142b1e7b350765ce68cb0b89668d5b3abc034b.zip | |
doc: Augmented the `eq' doc, documented `eq-display'.
git-archimport-id: skribilo@sv.gnu.org--2006/skribilo--devo--1.2--patch-27
Diffstat (limited to 'doc/user/eq.skb')
| -rw-r--r-- | doc/user/eq.skb | 25 |
1 files changed, 23 insertions, 2 deletions
diff --git a/doc/user/eq.skb b/doc/user/eq.skb index 455832b..1ef0208 100644 --- a/doc/user/eq.skb +++ b/doc/user/eq.skb @@ -70,7 +70,16 @@ 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 (,(numref :text [see Section] -:ident "symbols")).])) +:ident "symbols")).]) + + (p [It is possible to create ,(emph [equation display blocks]), +where several equations are displayed and aligned according to a +particular operator. ] + + (example-produce + (example :legend "Inlined, displayed, and aligned equations" + (prgm :file "src/eq3.skb")) + (disp (include "src/eq3.skb"))))) ;; FIXME: Write this. (section :title [Rendering]) @@ -91,7 +100,19 @@ 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.])) +[:div-style]) options override this setting.]) + (:align-with [Within a ,(code [eq-display]) block, +this should be a symbol specifying according to which operator equations +are to be aligned with one another.])) + :source "skribilo/package/eq.scm") + + (p [Equation display blocks can be defined using ,(code +[eq-display]). Display blocks define the scope of the alignment among +equations as specified by the ,(code [:align-with]) options of ,(code +[eq]).]) + + (doc-markup 'eq-display + `() :source "skribilo/package/eq.scm")) ) |