3. Scribe Programming Manual -- Common Classes

3. Scribe Programming Manual -- Common Classes

Home: Scribe Programming Manual

Previous chapter: Fontification

Next chapter: Scribe Library

Common Classes

3.1 %Node

3.2 %Text

3.3 %Container

3.4 %Document

3.5 %Block

3.6 %Chapter

3.7 %Section

3.8 %Subsection

3.9 %Subsubsection

3.10 %Paragraph

3.11 %Toc

3.12 %Ornament

3.13 %Font

3.14 %Reference

3.15 %Unknown-ref

3.16 %Numbered-ref

3.17 %Chapter-ref

3.18 %Section-ref

3.19 %Subsection-ref

3.20 %Subsubsection-ref

3.21 %Mark-ref

3.22 %Biblio-ref

3.23 %Hook

3.24 %Footnote

3.25 %Figure

3.26 %Mailto

3.27 %Special

3.28 %Atom

3.29 %Character

3.30 %Hrule

3.31 %Linebreak

3.32 %Image

3.33 %Author

3.34 %List

3.35 %Box

3.36 %Color

3.37 %Frame

3.38 %Table

3.39 %Table-row

3.40 %Table-cell

3.41 %Table-header

3.42 %Table-data

3.43 %Layout

3.44 %Pre

3.45 %Margin

3.46 %Center

3.47 %Flush

3.48 %Anchor

3.49 %Mark

3.50 %Index

Chapters

1. Defining new functions

2. Fontification

3. Common Classes

4. Scribe Library

5. Container numbering

6. Target format

7. Programming Back-ends

8. The HTML back end

9. The LaTeX back end

10. The MAN back end

11. Bibliography

12. Embedding Scribe into Bigloo

13. Scribe Apache module

14. Classes, Functions and Variables

15. Bibliography

Scribe

Home page: Scribe

Documentation: user

expert

styles

This chapter presents the Scribe common classes. They are not accessible by Scribe programs. They are only needed when a new Scribe back-end is to be implemented. It is recommended not to instantiate these classes directly. Instead it is recommended to use the Scribe construction functions described in the Scribe User Manual.

The convention used in Scribe is that to avoid collision between Scribe classes and user classes, all Scribe class identifiers are prefixed with the character %.

3.1 %Node

(abstract-class %node ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%anchor
    |  |
    |  +--%mark
    |     |
    |     +--%index
    |
    +--%list
    |
    +--%special
    |  |
    |  +--%atom
    |  |
    |  +--%author
    |  |
    |  +--%character
    |  |
    |  +--%hrule
    |  |
    |  +--%linebreak
    |
    +--%table
    |
    +--%text
       |
       +--%box
       |  |
       |  +--%color
       |  |
       |  +--%frame
       |
       +--%container
       |  |
       |  +--%block
       |  |  |
       |  |  +--%chapter
       |  |  |
       |  |  +--%paragraph
       |  |  |
       |  |  +--%section
       |  |  |
       |  |  +--%subsection
       |  |  |
       |  |  +--%subsubsection
       |  |  |
       |  |  +--%toc
       |  |
       |  +--%document
       |
       +--%figure
       |
       +--%font
       |
       +--%footnote
       |
       +--%hook
       |
       +--%image
       |
       +--%layout
       |  |
       |  +--%center
       |  |
       |  +--%flush
       |  |
       |  +--%margin
       |  |
       |  +--%pre
       |
       +--%mailto
       |
       +--%ornament
       |
       +--%reference
       |  |
       |  +--%biblio-ref
       |  |
       |  +--%mark-ref
       |  |
       |  +--%numbered-ref
       |  |  |
       |  |  +--%chapter-ref
       |  |  |
       |  |  +--%section-ref
       |  |  |
       |  |  +--%subsection-ref
       |  |  |
       |  |  +--%subsubsection-ref
       |  |
       |  +--%unknown-ref
       |
       +--%table-cell
       |  |
       |  +--%table-data
       |  |
       |  +--%table-header
       |
       +--%table-row

3.2 %Text

(abstract-class %text ::%node ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%box
        |  |
        |  +--%color
        |  |
        |  +--%frame
        |
        +--%container
        |  |
        |  +--%block
        |  |  |
        |  |  +--%chapter
        |  |  |
        |  |  +--%paragraph
        |  |  |
        |  |  +--%section
        |  |  |
        |  |  +--%subsection
        |  |  |
        |  |  +--%subsubsection
        |  |  |
        |  |  +--%toc
        |  |
        |  +--%document
        |
        +--%figure
        |
        +--%font
        |
        +--%footnote
        |
        +--%hook
        |
        +--%image
        |
        +--%layout
        |  |
        |  +--%center
        |  |
        |  +--%flush
        |  |
        |  +--%margin
        |  |
        |  +--%pre
        |
        +--%mailto
        |
        +--%ornament
        |
        +--%reference
        |  |
        |  +--%biblio-ref
        |  |
        |  +--%mark-ref
        |  |
        |  +--%numbered-ref
        |  |  |
        |  |  +--%chapter-ref
        |  |  |
        |  |  +--%section-ref
        |  |  |
        |  |  +--%subsection-ref
        |  |  |
        |  |  +--%subsubsection-ref
        |  |
        |  +--%unknown-ref
        |
        +--%table-cell
        |  |
        |  +--%table-data
        |  |
        |  +--%table-header
        |
        +--%table-row

3.3 %Container

(abstract-class %container ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
            |  |
            |  +--%chapter
            |  |
            |  +--%paragraph
            |  |
            |  +--%section
            |  |
            |  +--%subsection
            |  |
            |  +--%subsubsection
            |  |
            |  +--%toc
            |
            +--%document

3.4 %Document

(class %document ::%container ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*authors*	`pair-nil`	yes	no	`_`	An author list.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*chapters*	`obj`	no	no	`#unspecfied`	The list of chapters contained by this document. This list is automatically computed when the Scribe function `document` is called.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*foonotes*	`pair-nil`	no	no	`'()`	The list of footnotes of the document. This list does not include the footnotes defined in *chapters*. These notes are pointed to by the chapter the belong to.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*mark-table*	`hashtable`	no	no	`(make-hashtable)`	The hashtable used by the document to store marks.
*sections*	`obj`	no	no	`#unspecfied`	The list of sections contained by this document. As for *chapters*, this value is automatically computed.
sections*	`obj`	no	no	`#unspecfied`	The whole sections contained by this document (this contains the value of *sections* and all the sections contained in the *chapters*). This value is automatically computed.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*title*	`string`	yes	no	`_`	The title of the document.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%document

3.5 %Block

(abstract-class %block ::%container ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`#t`	A non false value controls the number of that block. A value of `#t` impose to the Scribe compiler to automatically set a number that block. An integer value set the block counter number.
*parent*	`obj`	no	no	`_`	The `%node` this block belongs to.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*tmp-footnotes-list*	`obj`	no	no	`'()`	A private field used to temporarily store document footnotes.
*tmp-marks-list*	`obj`	no	no	`'()`	A private field used to temporarily store document marks.
*toc*	`obj`	yes	no	`#t`	Indicates if this block must appear in the `table-of-contents`.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
                |
                +--%chapter
                |
                +--%paragraph
                |
                +--%section
                |
                +--%subsection
                |
                +--%subsubsection
                |
                +--%toc

3.6 %Chapter

(class %chapter ::%block ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*footnotes*	`obj`	yes	no	`'()`
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`#t`	A non false value controls the number of that block. A value of `#t` impose to the Scribe compiler to automatically set a number that block. An integer value set the block counter number.
*parent*	`obj`	no	no	`_`	The `%node` this block belongs to.
*sections*	`obj`	yes	no	`#unspecified`	The automatically computed list of sections contained in this chapter.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*subtitle*	`obj`	yes	no	`_`	The subtitle of the chapter. When not `#f`, the rendering of the chapter title, we use the `%document` title and the chapter *subtitle*.
*title*	`obj`	yes	no	`_`	The title of the chapter.
*tmp-footnotes-list*	`obj`	no	no	`'()`	A private field used to temporarily store document footnotes.
*tmp-marks-list*	`obj`	no	no	`'()`	A private field used to temporarily store document marks.
*toc*	`obj`	yes	no	`#t`	Indicates if this block must appear in the `table-of-contents`.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
                |
                +--%chapter

3.7 %Section

(class %section ::%block ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`#t`	A non false value controls the number of that block. A value of `#t` impose to the Scribe compiler to automatically set a number that block. An integer value set the block counter number.
*parent*	`obj`	no	no	`_`	The `%node` this block belongs to.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*subsections*	`obj`	no	no	`#unspecified`	The automatically computed list of subsections contained in that section.
*title*	`obj`	yes	no	`_`	The title of that section.
*tmp-footnotes-list*	`obj`	no	no	`'()`	A private field used to temporarily store document footnotes.
*tmp-marks-list*	`obj`	no	no	`'()`	A private field used to temporarily store document marks.
*toc*	`obj`	yes	no	`#t`	Indicates if this block must appear in the `table-of-contents`.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
                |
                +--%section

3.8 %Subsection

(class %subsection ::%block ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`#t`	A non false value controls the number of that block. A value of `#t` impose to the Scribe compiler to automatically set a number that block. An integer value set the block counter number.
*parent*	`obj`	no	no	`_`	The `%node` this block belongs to.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*subsubsections*	`obj`	no	no	`#unspecified`	The automatically computed list of subsubsections contained in that subsection.
*title*	`obj`	yes	no	`_`	The title of that subsection.
*tmp-footnotes-list*	`obj`	no	no	`'()`	A private field used to temporarily store document footnotes.
*tmp-marks-list*	`obj`	no	no	`'()`	A private field used to temporarily store document marks.
*toc*	`obj`	yes	no	`#t`	Indicates if this block must appear in the `table-of-contents`.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
                |
                +--%subsection

3.9 %Subsubsection

(class %subsubsection ::%block ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`#t`	A non false value controls the number of that block. A value of `#t` impose to the Scribe compiler to automatically set a number that block. An integer value set the block counter number.
*parent*	`obj`	no	no	`_`	The `%node` this block belongs to.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*title*	`obj`	yes	no	`_`	The title of that subsubsection.
*tmp-footnotes-list*	`obj`	no	no	`'()`	A private field used to temporarily store document footnotes.
*tmp-marks-list*	`obj`	no	no	`'()`	A private field used to temporarily store document marks.
*toc*	`obj`	yes	no	`#t`	Indicates if this block must appear in the `table-of-contents`.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
                |
                +--%subsubsection

3.10 %Paragraph

(class %paragraph ::%block ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`#t`	A non false value controls the number of that block. A value of `#t` impose to the Scribe compiler to automatically set a number that block. An integer value set the block counter number.
*parent*	`obj`	no	no	`_`	The `%node` this block belongs to.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*tmp-footnotes-list*	`obj`	no	no	`'()`	A private field used to temporarily store document footnotes.
*tmp-marks-list*	`obj`	no	no	`'()`	A private field used to temporarily store document marks.
*toc*	`obj`	yes	no	`#t`	Indicates if this block must appear in the `table-of-contents`.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
                |
                +--%paragraph

3.11 %Toc

(class %toc ::%block ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*chapter*	`obj`	yes	no	`#t`	A list of chapters title to display or `#t` to display all chapters.
*children*	`pair-nil`	no	no	`'()`	The list of children in the instance.
*file*	`obj`	no	no	`#f`	The file where to output the container when processed file.¹.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`#t`	A non false value controls the number of that block. A value of `#t` impose to the Scribe compiler to automatically set a number that block. An integer value set the block counter number.
*parent*	`obj`	no	no	`_`	The `%node` this block belongs to.
*section*	`obj`	yes	no	`#t`	A list of sections title to display or `#t` to display all chapters.
*stamp*	`symbol`	yes	no	`(gensym)`	A mark used when referencing to that container.
*tmp-footnotes-list*	`obj`	no	no	`'()`	A private field used to temporarily store document footnotes.
*tmp-marks-list*	`obj`	no	no	`'()`	A private field used to temporarily store document marks.
*toc*	`obj`	yes	no	`#t`	Indicates if this block must appear in the `table-of-contents`.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%container
            |
            +--%block
                |
                +--%toc

3.12 %Ornament

(abstract-class %ornament ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*kind*	`obj`	yes	no	`_`	The kind of ornament that can be: `bold`, `code`, `emph`, `it`, `kbd`, `samp`, `sc`, `tt`, `underline`, and `var`.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%ornament

3.13 %Font

(class %font ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*face*	`obj`	yes	no	`_`	The font face of that text.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*size*	`obj`	yes	no	`_`	The font size of that text.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%font

3.14 %Reference

(abstract-class %reference ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%biblio-ref
            |
            +--%mark-ref
            |
            +--%numbered-ref
            |  |
            |  +--%chapter-ref
            |  |
            |  +--%section-ref
            |  |
            |  +--%subsection-ref
            |  |
            |  +--%subsubsection-ref
            |
            +--%unknown-ref

3.15 %Unknown-ref

(class %unknown-ref ::%reference ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%unknown-ref

3.16 %Numbered-ref

(abstract-class %numbered-ref ::%reference ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*numberp*	`obj`	yes	no	`#f`	Enables or disables the rendering of a number in the reference.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%numbered-ref
                |
                +--%chapter-ref
                |
                +--%section-ref
                |
                +--%subsection-ref
                |
                +--%subsubsection-ref

3.17 %Chapter-ref

(class %chapter-ref ::%numbered-ref ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*numberp*	`obj`	yes	no	`#f`	Enables or disables the rendering of a number in the reference.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%numbered-ref
                |
                +--%chapter-ref

3.18 %Section-ref

(class %section-ref ::%numbered-ref ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*numberp*	`obj`	yes	no	`#f`	Enables or disables the rendering of a number in the reference.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%numbered-ref
                |
                +--%section-ref

3.19 %Subsection-ref

(class %subsection-ref ::%numbered-ref ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*numberp*	`obj`	yes	no	`#f`	Enables or disables the rendering of a number in the reference.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%numbered-ref
                |
                +--%subsection-ref

3.20 %Subsubsection-ref

(class %subsubsection-ref ::%numbered-ref ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*numberp*	`obj`	yes	no	`#f`	Enables or disables the rendering of a number in the reference.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%numbered-ref
                |
                +--%subsubsection-ref

3.21 %Mark-ref

(class %mark-ref ::%reference ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%mark-ref

3.22 %Biblio-ref

(class %biblio-ref ::%reference ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*anchor*	`obj`	yes	no	`#f`	The anchor the reference points to.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%reference
            |
            +--%biblio-ref

3.23 %Hook

(class %hook ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*after*	`obj`	no	no	`#f`	`#f` or a function of zero argument that will be called by the back-end after processing the *body* of that text.
*before*	`obj`	no	no	`#f`	`#f` or a function of zero argument that will be called by the back-end before processing the *body* of that text.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*process*	`bool`	yes	no	`_`	When `#t` the result of *before* and *after* are processed, by the back-end, as usual Scribe expressions. The results are included in the target document.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%hook

3.24 %Footnote

(class %footnote ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
id	`symbol`	no	no	`(gensym 'footnote)`	An internal identifier used to point to that footnote.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*note*	`obj`	no	no	`_`	The text of the footnote. Note that the text the footnote is associated with is the value of the *body*.
*number*	`integer`	no	no	`0`	The footnote number. This value is automatically computed by Scribe upon footnote construction.
*parent*	`obj`	no	no	`#f`	The `%block` containing the footnote. This value is automatically computed by Scribe upon block construction.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%footnote

3.25 %Figure

(class %figure ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*legend*	`obj`	no	no	`_`	The legend of the figure.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*number*	`obj`	no	no	`0`	If `#f` no numbering is used for this figure. A value of `0` impose to the Scribe compiler to automatically compute the figure number. An positive integer sets the Scribe figure counter.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%figure

3.26 %Mailto

(class %mailto ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*email*	`obj`	yes	no	`#f`	The address to post.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%mailto

3.27 %Special

(abstract-class %special ::%node ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%special
        |
        +--%atom
        |
        +--%author
        |
        +--%character
        |
        +--%hrule
        |
        +--%linebreak

3.28 %Atom

(class %atom ::%special ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*value*	`obj`	yes	no	`_`	The value of the atom.

Inheritance Tree:

 %node
    |
    +--%special
        |
        +--%atom

3.29 %Character

(class %character ::%special ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*value*	`obj`	yes	no	`_`	The character value.

Inheritance Tree:

 %node
    |
    +--%special
        |
        +--%character

3.30 %Hrule

(class %hrule ::%special ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*height*	`integer`	yes	no	`1`	The thickness of the horizontal rule.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*width*	`number`	yes	no	`1.`	The width of the horizontal rule. A floating point represents a relative size. An integer value represents a pixel size.

Inheritance Tree:

 %node
    |
    +--%special
        |
        +--%hrule

3.31 %Linebreak

(class %linebreak ::%special ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*repetition*	`integer`	yes	no	`1`	The number of line breaks to introduce.

Inheritance Tree:

 %node
    |
    +--%special
        |
        +--%linebreak

3.32 %Image

(class %image ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*file*	`obj`	yes	no	`_`	The Url where the image is located.
*height*	`obj`	yes	no	`_`	An number that specifies how much vertical space this image should fill in.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*width*	`obj`	yes	no	`_`	An number that specifies how much horizontal space this image should fill in.
*zoom*	`obj`	yes	no	`_`	A zoom factor.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%image

3.33 %Author

(class %author ::%special ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*address*	`obj`	yes	no	`#f`	The surface address of the author.
*affiliation*	`obj`	yes	no	`#f`	The affiliation of the author.
*email*	`obj`	yes	no	`#f`	The email of the author.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*name*	`obj`	yes	no	`_`	The name of the author.
*phone*	`obj`	yes	no	`#f`	The phone number of the author.
*photo*	`obj`	yes	no	`#f`	A picture representing of the author.
*url*	`obj`	yes	no	`#f`	The url of the author.

Inheritance Tree:

 %node
    |
    +--%special
        |
        +--%author

3.34 %List

(abstract-class %list ::%node ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*items*	`pair-nil`	yes	no	`_`	The items of the list.
*kind*	`symbol`	yes	no	`_`	The kind of list (either `itemize`, `enumerate` or `description`).
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%list

3.35 %Box

(abstract-class %box ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*margin*	`obj`	yes	no	`#f`	The margin size of the box.
*width*	`obj`	yes	no	`#f`	The width of the box. A floating point value represents the percentage of horizontal space filled out by the box on the file. An integer value represent a fixed dimension. The `#f` value means that the box should only fill out the space it needed.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%box
            |
            +--%color
            |
            +--%frame

3.36 %Color

(class %color ::%box ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
bg	`obj`	yes	no	`_`	The background of the `%box` or `#f`.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
fg	`obj`	yes	no	`_`	The foreground of the `%box` or `#f`.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*margin*	`obj`	yes	no	`#f`	The margin size of the box.
*width*	`obj`	yes	no	`#f`	The width of the box. A floating point value represents the percentage of horizontal space filled out by the box on the file. An integer value represent a fixed dimension. The `#f` value means that the box should only fill out the space it needed.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%box
            |
            +--%color

3.37 %Frame

(class %frame ::%box ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*border-width*	`integer`	no	no	`1`	The size of the border of the frame.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*margin*	`obj`	yes	no	`#f`	The margin size of the box.
*width*	`obj`	yes	no	`#f`	The width of the box. A floating point value represents the percentage of horizontal space filled out by the box on the file. An integer value represent a fixed dimension. The `#f` value means that the box should only fill out the space it needed.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%box
            |
            +--%frame

3.38 %Table

(class %table ::%node ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*border*	`obj`	yes	no	`#f`	The border size of the table.
*cellpadding*	`obj`	yes	no	`0`	The padding of the table cells.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*nbcols*	`obj`	yes	yes	`_`	The number of columns in the table. Fetching the value virtual slot actually computes the number of columns.
*rows*	`pair`	yes	no	`_`	The rows of the table. Each elements of this list is a `%table-row`.
*width*	`obj`	yes	no	`#f`	The width of the table. See boxes for the documentation of the *width* possible values.

Inheritance Tree:

 %node
    |
    +--%table

3.39 %Table-row

(class %table-row ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
bg	`obj`	yes	no	`#f`	The background color of the row or the `#f` value.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*cells*	`pair-nil`	yes	no	`_`	The cells of that row. Each element is a `%table-cell`.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%table-row

3.40 %Table-cell

(abstract-class %table-cell ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*align*	`obj`	yes	no	`center`	The horizontal alignment of the cell. The possible values are `left`, `center` and `right`.
bg	`obj`	yes	no	`#f`	The background color of the cell.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*colspan*	`obj`	yes	no	`1`	The number of columns the cell expands to.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*rowspan*	`obj`	yes	no	`1`	The number of rows the cell expands to.
*valign*	`obj`	yes	no	`top`	The vertical alignment of the cell. The possible values are `top`, `center` and `bottom`.
*width*	`obj`	yes	no	`#f`	The width of the column. A floating point value represent a percentage, with respect to the entire table width. An integer value represent a absolute width.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%table-cell
            |
            +--%table-data
            |
            +--%table-header

3.41 %Table-header

(class %table-header ::%table-cell ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*align*	`obj`	yes	no	`center`	The horizontal alignment of the cell. The possible values are `left`, `center` and `right`.
bg	`obj`	yes	no	`#f`	The background color of the cell.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*colspan*	`obj`	yes	no	`1`	The number of columns the cell expands to.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*rowspan*	`obj`	yes	no	`1`	The number of rows the cell expands to.
*valign*	`obj`	yes	no	`top`	The vertical alignment of the cell. The possible values are `top`, `center` and `bottom`.
*width*	`obj`	yes	no	`#f`	The width of the column. A floating point value represent a percentage, with respect to the entire table width. An integer value represent a absolute width.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%table-cell
            |
            +--%table-header

3.42 %Table-data

(class %table-data ::%table-cell ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*align*	`obj`	yes	no	`center`	The horizontal alignment of the cell. The possible values are `left`, `center` and `right`.
bg	`obj`	yes	no	`#f`	The background color of the cell.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*colspan*	`obj`	yes	no	`1`	The number of columns the cell expands to.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*rowspan*	`obj`	yes	no	`1`	The number of rows the cell expands to.
*valign*	`obj`	yes	no	`top`	The vertical alignment of the cell. The possible values are `top`, `center` and `bottom`.
*width*	`obj`	yes	no	`#f`	The width of the column. A floating point value represent a percentage, with respect to the entire table width. An integer value represent a absolute width.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%table-cell
            |
            +--%table-data

3.43 %Layout

(abstract-class %layout ::%text ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%layout
            |
            +--%center
            |
            +--%flush
            |
            +--%margin
            |
            +--%pre

3.44 %Pre

(class %pre ::%layout ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%layout
            |
            +--%pre

3.45 %Margin

(class %margin ::%layout ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
bg	`obj`	yes	no	`#f`	The background color of the margin.
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*tbg*	`obj`	yes	no	`#f`	The background color of the title rendered in the margin.
*tfg*	`obj`	yes	no	`#f`	The foreground color of the title rendered in the margin.
*width*	`obj`	yes	no	`#f`	The width of the margin. A floating point number represents a percentage of the line width. An integer value is an absolute dimension.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%layout
            |
            +--%margin

3.46 %Center

(class %center ::%layout ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%layout
            |
            +--%center

3.47 %Flush

(class %flush ::%layout ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
*body*	`obj`	no	no	`_`	The body of the text represented by the node.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*side*	`symbol`	yes	no	`_`	How to flush the text. The three legal values are `left`, `right` and `center`. Note that a centered `flush` is equivalent to a `%center` instance.

Inheritance Tree:

 %node
    |
    +--%text
        |
        +--%layout
            |
            +--%flush

3.48 %Anchor

(abstract-class %anchor ::%node ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
id	`obj`	yes	no	`#f`	The identifier of the anchor.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*parent*	`obj`	no	no	`#f`	the `%container` the anchor belongs to. This value is value is automatically computed upon instantiation by the `mark` Scribe function.

Inheritance Tree:

 %node
    |
    +--%anchor
        |
        +--%mark
           |
           +--%index

3.49 %Mark

(class %mark ::%anchor ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
id	`obj`	yes	no	`#f`	The identifier of the anchor.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*parent*	`obj`	no	no	`#f`	the `%container` the anchor belongs to. This value is value is automatically computed upon instantiation by the `mark` Scribe function.

Inheritance Tree:

 %node
    |
    +--%anchor
        |
        +--%mark
            |
            +--%index

3.50 %Index

(class %index ::%mark ... ) Scribe class

Fields:

field	Type	Read-only	Virtual	Default	description
id	`obj`	yes	no	`#f`	The identifier of the anchor.
*loc*	`obj`	yes	no	`_`	The source location of the instance. This information is used to display user source errors.
*name*	`obj`	yes	no	`#f`	The name of the index entry.
*note*	`obj`	yes	no	`#f`	The note of the index entry.
*parent*	`obj`	no	no	`#f`	the `%container` the anchor belongs to. This value is value is automatically computed upon instantiation by the `mark` Scribe function.
*shape*	`obj`	yes	no	`#f`	The shape to be used to render the index entry.

Inheritance Tree:

 %node
    |
    +--%anchor
        |
        +--%mark
            |
            +--%index

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

¹: Currently, only the HTML back-end supports this facility.

This page has been generated by Scribe.
Last update Wed Dec 18 09:23:03 2002