From zedwiki

Catalog

Explanation of Text Elements

(RNIB Catalog version 1.23)

[Main items which are optional are marked in this list with a ?. The question mark is not part of the tag. Specific items such as list which are obviously optional have not been so marked.]

catalog

This contains the whole document. The opening tag is required at the start of the document, and the closing tag at the end of the document.

ver

This element states the version of the system used to create and process the document. Such information is required for archiving purposes, but is not part of the original document, and is not usually output.

front

This contains the items before the main body of the catalogue: a banner logo for the catalogue (bannerlogo), the title, followed by a contents, and front sections (fsection) containing additional information before the main text of the publication. The contents and fsection elements are both optional.

body

This contains all the main sections in the catalogue.

back ?

This contains one or more index, and is optional.

bannerlogo ?

This is an optional element which may occur as the first item in front, indicating the presence of a banner logo to be used in the outputs where appropriate. (E.g. it may be the RNIB print logo and/or the RNIB audio logo.) It has a required attribute, type, which may have the values "RNIB" or "other". There are also optional attributes: imgsrc, for the filename of the graphic file, and sndsrc, for the filename of the audio file. If "RNIB" is chosen as the value of type, imgsrc and sndsrc can be omitted, as default values are then inserted if empty.

title

This is the title of the catalogue, and is the first item in front.

subtitle ?

This is a subtitle of the catalogue, and may occur after the title in front. This is optional, and more than one is permissible.

contents ?

This is the catalogue contents, and contains the heading (head) and different levels of entries (entry1 ... entry3).

head

This element name is used for all the headings in the catalogue, e.g. at the start of the contents, at the start of sections, etc. It is also used for the general heading of an item in the catalogue, within the item element. For a book catalogue this includes the book title (enclosed in bold tags), and such information as the reader's name, the time, and the catalogue number.

subhead ?

This is a subheading, following a head at the beginning of a section or subsection. More than one may be present, or it may be absent.

entry1

This is a main entry in the contents. It consists of the section name (secname) and the page number (pageno).

entry2

This is a second-level entry in the contents. It has the same structure as entry1.

entry3

This is a third-level entry in the contents. It has the same structure as entry1.

entry4

This is a fourth-level entry in the contents. It has the same structure as entry1.

secname

This is the name of a section or subsection, and appears in its entry (entry1, entry2 or entry3) in the contents.

pageno

This is the starting page number of a section or subsection, and appears after the section name (artname) in its entry in the contents. This number will not be known when preparing the XML file, and so should be left blank.

fsection

This is a section within in the front of the catalogue, typically containing introductory or explanatory material. It starts with a head, followed by paragraphs (p) or lists. It may contain subsections (fsubsect1).

fsubsect1

This is a subsection within a fsection in the front of the catalog. It has the same structure as a fsection, except that there are no subsections within it.

p

This is a paragraph. It can occur in a section or subsection in the front or body, possibly within an author entry (authentry) after the author, or within an item after the head, containing information about the item.

list

This is a list, and contains one or more list items (litem). A list can appear between or within a paragraph. This tag should be used for lists which are normally specially displayed, e.g. on separate lines in print, but not for listed items occurring in the normal run of a sentence, such as "he saw: dogs, cats, geese".

litem

This is an item within a list, and contains text (but not paragraphs).

body

This follows front and contains all the sections in the catalogue.

section

This is a main section in the catalogue, and starts with the head and possibly one or more subheadings (subhead), followed by items or author entries (authentry) in the catalogue. It may contain subsections (subsect1).

subsect1

This is a subsection within a section. It has the same structure as a section, except that a subsection within it is a subsect2.

subsect2

This is a subsection within a subsect1. It has the same structure as a subsect1, except that a subsection within it is a subsect3.

subsect3

This is a subsection within a subsect2. It has the same structure as a subsect2, except that there is no provision for a subsection within it.

authentry

This is used in certain catalogues of books, etc., and is a group of items (i.e. books) in the catalogue belonging to a particular author. It can occur within a section or one of its subsections. It starts with the author's name (author), followed possibly by one or more paragraphs (p), then the items relating to that author.

author

This is the author of a book, etc., and is the first element in an author entry (authentry).

item

This is an item in the catalogue, e.g. a book, etc. It can occur directly within a section or subsection in the body of the catalogue; or for catalogues of books, etc., within an authentry, after the author's name (author). It starts with a head, which is the general name of the item (e.g. the title and related information for a book), followed by paragraphs (p) or lists (list) giving a description or other information about the item.

graphic

This element is used for a picture, and can occur between paragraphs. It contains an image box (imgbox) which holds the picture, followed by a visual description (vdes).

imgbox

This element, "image box", contains a picture image (image). It occurs in a graphic element. imgbox has a position attribute which can be set to "centre" when it is required that the image is centred on a separate line, rather than appearing within a line of text.

image

This is a picture image, and occurs in a image box (imgbox). It has a source attribute which states the filename of the picture (e.g. source="house.bmp"), and a width attribute which sets the size of the picture.

vdes

This is a visual object description, i.e. a description of an image. It is used to give a description which will appear as a substitute for the image itself in media other than print. It occurs after an image box (imgbox) in a graphic (where it is used to describe that image).

i

Italics. Use this for italicised words in the normal stream of text, not for headings, etc. For italicised paragraphs, the i tags should be within the paragraph tags.

b

Bold. Use this for bold words in the normal stream of text, not for headings, etc. For bold paragraphs, the b tags should be within the paragraph tags. In book catalogues it is usually used for book titles within the head for the item.

email

Use this for e-mail addresses.

web

Use this for internet web addresses.

acronym

Acronym. Use this for acronyms like BBC and RNIB, am and pm, but not abbreviations which are parts of words, such as Mr, Rd, St. Do not use for unit abbreviations. A plural "s" should be left outside the closing tag.

flang

Foreign language. Use this for passages in a foreign language, such as book descriptions in Welsh.

iterm

This is used to identify words to be included in the index, e.g. the author names for a book catalogue. It is placed directly around the relevant text, within any other element tags which may apply to the text. (This feature may not be implemented., and so the tag may not appear.)

back ?

This contains any material which comes after the main body of the catalogue. It can contain one or more index.

index

This is an index which occurs in some catalogues, and occurs in back. It contains a head, possibly some paragraphs, then up to three levels of index entries, ientry1, ientry2, ientry3; or index sections, isect.

isect

This is an alphabetic section in an index, and contains an optional head, then up to three levels of index entries, ientry1, ientry2 and ientry3.

ientry1

This is a first level index entry, and can occur directly in an index, or within an index section (isect). It contains the text of the entry (including the page number).

ientry2

This is a second level index entry, and is similar to ientry1.

ientry3

This is a third level index entry, and is similar to ientry1.

SJP

5/1/07