Generated: June 1, 2002, 16:56:51Copyright ©2002, Kurt NørmarkThe local LAML software home page

Manual of the LAML Article Style

Kurt Nørmark ©    normark@cs.auc.dk    Department of Computer Science    Aalborg University    Denmark    

Source file: styles/article/article.scm
LAML Version 17.10 (June 1, 2002) full

An LAML Article page style. This style is for authoring a relatively simple scientific paper in LAML. The article style is modelled after LaTeX, but it is still incomplete and ad hoc. I include stuff when I need it. Simple formatting can be done via HTML tags mirrored in LAML. The alternative style, article-latex, generates LaTeX instead of HTML.

Table of Contents:
1. Colors and other settings.2. Top level function.3. Target specific insertions.

Alphabetic index:
article-abstract(article-abstract abstract)Define the article abstract
article-author-and-affiliation(article-author-and-affiliation . author-and-affiliation)Define the article author and affiliation.
article-background-colorarticle-background-colorThe background color of the article
article-bibliography(article-bibliography . bib-items)Define the bibliograph items of the article.
article-figure(article-figure id relative-file-path caption . unsed-rest)Define an article figure (gif or jpg) in terms of an id, a relative file path, and a caption.
article-foreground-colorarticle-foreground-colorThe foreground color of the article
article-header-colorarticle-header-colorThe color of header lines in the article
article-index-colorarticle-index-colorThe color of index entries in the table of contents
article-items(article-items . items)Define a number of items.
article-link-colorarticle-link-colorThe color of links from the article
article-named-issue-list(article-named-issue-list . issue-list)Define a number of name issues, which are rendered as titled items in a list.
article-paragraphs(article-paragraphs . paragraph-list)Define a number of paragraphs.
article-section(article-section id title section-body)Define a section in this article.
article-subsection(article-subsection id title section-body)Define a subsection in this article.
article-title(article-title title)Define the article title
article-title-colorarticle-title-colorThe color of the article title
article-vlink-colorarticle-vlink-colorThe color of visited links from the article
begin-article(begin-article)The clause which starts the article proper.
bib-item(bib-item key formatted-bib)The individual bibliograph items of the article-bibliography.
cite(cite . key-list)This form returns a list of links to citations of this article.
end-article(end-article)The clause which ends the article.
figure-ref(figure-ref id)This form returns a link to a figure of the article.
index-columnsindex-columnsIn case of show-index, this variable gives the number of columns in the table of contents
issue(issue issue-title issue-body)Define an issue of an article-named-issue-list.
item(item i)Define an item in an article-items form.
section-ref(section-ref id)This form returns a link (anchor tag) to a section or subsection of the article.
show-index?show-index?A boolean variable which controls generation of table of contents (index).

 

1.   COLORS AND OTHER SETTINGS.
In this section we find the background, foreground, linking, and title colors of the article style. Furthermore, additional settings are provided for.


article-background-color


Form
article-background-color

Description
The background color of the article


article-foreground-color


Form
article-foreground-color

Description
The foreground color of the article


article-link-color


Form
article-link-color

Description
The color of links from the article


article-vlink-color


Form
article-vlink-color

Description
The color of visited links from the article


article-title-color


Form
article-title-color

Description
The color of the article title


article-header-color


Form
article-header-color

Description
The color of header lines in the article


article-index-color


Form
article-index-color

Description
The color of index entries in the table of contents


show-index?


Form
show-index?

Description
A boolean variable which controls generation of table of contents (index).


index-columns


Form
index-columns

Description
In case of show-index, this variable gives the number of columns in the table of contents


 

2.   TOP LEVEL FUNCTION.
In this section the important top level functions of the article style are presented.


article-title


Form
(article-title title)

Description
Define the article title


article-author-and-affiliation


Form
(article-author-and-affiliation . author-and-affiliation)

Description
Define the article author and affiliation. The first of the parameters is usually the author name. The remaining parameters represent affiliation information.


article-abstract


Form
(article-abstract abstract)

Description
Define the article abstract


article-section


Form
(article-section id title section-body)

Description
Define a section in this article. The first parameter, id, is a symbol which identifies the section. The seconde parameter, title, is a title string. The last parameter is the body of a section, typically and article-paragraph.


article-subsection


Form
(article-subsection id title section-body)

Description
Define a subsection in this article. The first parameter, id, is a symbol which identifies the section. The seconde parameter, title, is a title string. The last parameter is the body of a section, typically and article-paragraph.


article-paragraphs


Form
(article-paragraphs . paragraph-list)

Description
Define a number of paragraphs. Paragraphs are separated by a p tag.


article-figure


Form
(article-figure id relative-file-path caption . unsed-rest)

Description
Define an article figure (gif or jpg) in terms of an id, a relative file path, and a caption. The first parameter, id, is a symbol which identifies the figure. The second parameter, relative-file-path, is the relative file path to the jpg or gif file. The third parameter is the caption of the figure (a string).


article-named-issue-list


Form
(article-named-issue-list . issue-list)

Description
Define a number of name issues, which are rendered as titled items in a list. The parameters are supposed to be issue forms.


issue


Form
(issue issue-title issue-body)

Description
Define an issue of an article-named-issue-list. An issue is defined in terms of a title and a body.


article-items


Form
(article-items . items)

Description
Define a number of items. The parameters are supposed to be item forms.


item


Form
(item i)

Description
Define an item in an article-items form.


begin-article


Form
(begin-article)

Description
The clause which starts the article proper. This clause must be ended by end-article. Put article-title, article-author-and-affiliation, article-abstract, the sections, and the article-bibliography between begin-article and end-article.


end-article


Form
(end-article)

Description
The clause which ends the article.


section-ref


Form
(section-ref id)

Description
This form returns a link (anchor tag) to a section or subsection of the article. The reference is resolved via the aux file.


figure-ref


Form
(figure-ref id)

Description
This form returns a link to a figure of the article.


cite


Form
(cite . key-list)

Description
This form returns a list of links to citations of this article. key-list is a list of strings, which identify bibliograph items.


article-bibliography


Form
(article-bibliography . bib-items)

Description
Define the bibliograph items of the article. It is assumed that the constituents are bib-item forms.


bib-item


Form
(bib-item key formatted-bib)

Description
The individual bibliograph items of the article-bibliography. A bib-item is defined in terms of a key and a string, which represents the formatted bib information.


 

3.   TARGET SPECIFIC INSERTIONS.
Do only use these in special situations.


Generated: June 1, 2002, 16:56:51
This documentation has been extracted automatically from the Scheme source file by means of the Schemedoc tool