3. Skribilo User Manual — Standard Markups |
This chapter describes the forms composing Skribilo texts that use the Skribe syntax (see Section 2.1). In XML/HTML jargon these forms are called markups. In LaTeX they are called macros. In Skribilo these forms are called functions. In this manual, we will say that we call a function when a function is used in a form. The values used in a function call are named the actual parameters of the function or parameters in short. When calling a function with parameters we say that we are passing arguments to the function.
In this document function names are typeset in boldface. We call
keyword argument a named argument, i.e., an argument whose
name, starting with a colon (:), must be specified when the
function is called. Other arguments are called plain
arguments or arguments for short. An optional
argument is represented by a list, starting with the character "[" and ending with the character "]", whose first
element is a keyword argument and the optional second (#f
when
not specified) element is the default value used if the optional
argument value is not provided on a function call. Arguments that are
not optional are said mandatory. If a plain argument is
preceded by a . character, this argument may be used to
accumulate several values. There are two ways to pass actual arguments
to a function:
body
is preceeded with a
. character so it may receive several values. All the following
calls are legal section calls:
(section :title "A title" "This is the body of the section") (section :title "A title" "This" " is" " the body of the section") (section :title "A title" :number 3 "This" " is" " the body of the section") (section :title "A title" :toc #f :number 3 "This" " is" " the body of the section") (section :title "A title" :number 3 :toc #f "This" " is" " the body of the section")
The remainder of this chapter describes ``standard'' markups or functions that are commonly used in documents. By ``standard'', we mean two things: first, you will quickly notice that they look familiar if you have ever written, say, HTML or LaTeX documents; second, they are standard because these markups are always available by default to Skribilo documents, unlike those bundled in separate packages such as [?ident pie-charts: ./markup.skb:74:2:], slides, etc. In fact, these markups are also bundled in a package, called base, but this package is always available to Skribilo documents1.
(use-modules (skribilo package
base))
.