3.1 Standard Markups -- Document


main page
top:Skribe User Manual
index:Index
markups:Standard Markups


Standard Markups
Markup index
3.1Document
3.2Sectioning
3.3Table of contents
3.4Ornaments
3.5Line breaks
3.6Font
3.7Justification
3.8Enumeration
3.9Frame and color
3.10Figure
3.11Image
3.12Table
3.13Footnote
3.14Characters, Strings and Symbols


Chapters
1Getting Started
2Syntax & Values
3Standard Markups
4References and Hyperlinks
5Indexes
6Bibliography
7Computer programs
8Standard Library
9Engines
10Editing Skribe Programs
11Skribe compiler
12Compiling Texi documents
13List of examples
14Table of contents

3.1.1 Document

The document function defines a Skribe document.

prototype
(document [:ident] [:class] [:title] [:html-title] [:author] [:ending] [:env '()] node...)
optionenginesdescription
:identhtml latex The node identifier.
:classhtml latex The node class.
:titlehtml latex The title of the document.
:html-titlehtml The title of window of the HTML browser.
:authorhtml latex The authors of the document.
:endinghtml latex An ending text.
:envhtml latex A counter environment.
argumentdescription
node...The document nodes.
See also
author chapter toc
Example:
(document :title "This is a Scribe document"
          :author (list (author :name "Foo" :email (mailto "foo@nowhere.org"))
                        (author :name "Bar" :email (mailto "bar@anywhere.org"))
                        (author :name "Gee" :email (mailto "gee@nowhere.org")))
  "A body...")
Ex. 1: The document markup
Produces:
This is a Scribe document
Foo
foo@nowhere.org
Bar
bar@anywhere.org
Gee
gee@nowhere.org
A body...

3.1.2 Author

The author function is used to specify the authors of a Skribe document.

prototype
(author :name [:class] [:ident] [:title] [:affiliation] [:email] [:url] [:address] [:phone] [:photo] [:align 'center])
optionenginesdescription
:identhtml latex The node identifier.
:classhtml latex The node class.
:namehtml latex The name of the author.
:titlehtml latex His title.
:affiliationhtml latex His affiliation.
:emailhtml latex His email.
:urlhtml latex His web page.
:addresshtml latex His address.
:phonehtml latex His phone number.
:photohtml latex His photograph.
:alignhtml latex The author item alignment.
See also
mailto ref
Example:
(author :name "Manuel Serrano"
        :affiliation "Inria Sophia-Antipolis"
        :url (ref :url "http://www.inria.fr/mimosa/Manuel.Serrano")
        :email (mailto "Manuel.Serrano@inria.fr")
        :address `("2004 route des Lucioles - BP 93"
                   "F-06902 Sophia Antipolis, Cedex"
                   "France")
        :phone "phone: (+33) 4 92 38 76 41")
Ex. 2: The author markup
Produces:
Manuel Serrano
Inria Sophia-Antipolis
2004 route des Lucioles - BP 93
F-06902 Sophia Antipolis, Cedex
France
phone: (+33) 4 92 38 76 41
Manuel.Serrano@inria.fr
http://www.inria.fr/mimosa/Manuel.Serrano

This Html page has been produced by Skribe.
Last update Mon Oct 16 22:52:27 2006.