Conventions Install Learn Advanced Alphabetical
Fake FAQ TODO File List

pabulumba

The manual

Conventions used in this manual

A word or phrase that is in this style represents text/input to be supplied by the user.

A word that is in this style represents the name of an XML tag.

A word that is in this style represents an XML attribute.

A word or phrase that is in this style represents the alternatives which can be used as parameters to an XML attribute.

A word or phrase in XML that is [ enclosed in square brackets ] is optional. Everywhere else, it indicates a button, a link, or clickable text (called a switch in pabulumba) to be clicked, e.g.: Please click [Help].

A word or phrase that is { enclosed in curly brackets (braces) } is mandatory. Where it is obvious from the context that something should be included, the brackets may not always be included - it would not be very readable to put curly brackets around most things in the next example because nearly everything is required.

Explanation using a very simple XML document:

<doc>
	<page heading="ExampleOnly">
	<form name="example1" [showDuplicate="y|n"] />
</doc>

doc , page , and form are XML tag names. Tag names can also be identified by the angle brackets surrounding them and their attributes. The attribute names here are heading , name , and showDuplicate. "ExampleOnly" and "example1" are two examples of text which the user must complete - usually the heading of something, or the name of a field in the database.