10. Markup of Headers

Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions.

Note: the first line of a document may include information on the markup version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment:

  % this would be a comment

10.1 Sample Header

This current document is loaded by a master document that has a header similar to this one:

  % SiSU master 2.0

  @title: SiSU
   :subtitle: Manual

  @creator: :author: Amissah, Ralph

  @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

  @classify:
   :type: information
   :topic_register: SiSU:manual;electronic documents:SiSU:manual
   :subject: ebook, epublishing, electronic book, electronic publishing,
      electronic document, electronic citation, data structure,
       citation systems, search

  % used_by: manual

  @date:
   :published: 2008-05-22
   :created: 2002-08-28
   :issued: 2002-08-28
   :available: 2002-08-28
   :modified: 2010-03-03

  @make:
   :num_top: 1
   :breaks: new=C; break=1
   :skin: skin_sisu_manual
   :bold: /Gnu|Debian|Ruby|SiSU/
   :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search;
       synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ]
       . sisu [-Ddcv] [instruction]
       . sisu [-CcFLSVvW]
       . sisu --v2 [operations]
       . sisu --v3 [operations]

  @links:
   { SiSU Homepage }http://www.sisudoc.org/
   { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/
   { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
   { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
   { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
   { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary
   { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/
   { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
   { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org
   { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU

10.2 Available Headers

Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All header instructions take the form @headername: or on the next line and indented by once space :subheadername: All Dublin Core meta tags are available

@indentifier: information or instructions

where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified

Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: header is used to describe document structure, and can be useful to know.

This is a sample header

  % SiSU 2.0 [declared file-type identifier with markup version]

  @title: [title text] [this header is the only one that is mandatory]
    :subtitle: [subtitle if any]
    :language: English

  @creator:
   :author: [Lastname, First names]
   :illustrator: [Lastname, First names]
   :translator: [Lastname, First names]
   :prepared_by: [Lastname, First names]

  @date:
   :published: [year or yyyy-mm-dd]
   :created: [year or yyyy-mm-dd]
   :issued: [year or yyyy-mm-dd]
   :available: [year or yyyy-mm-dd]
   :modified: [year or yyyy-mm-dd]
   :valid: [year or yyyy-mm-dd]
   :added_to_site: [year or yyyy-mm-dd]
   :translated: [year or yyyy-mm-dd]

  @rights:
   :copyright: Copyright (C) [Year and Holder]
   :license: [Use License granted]
   :text: [Year and Holder]
   :translation: [Name, Year]
   :illustrations: [Name, Year]

  @classify:
   :topic_register: SiSU:markup sample:book;book:novel:fantasy
   :type:
   :subject:
   :description:
   :keywords:
   :abstract:
   :isbn: [ISBN]
   :loc: [Library of Congress classification]
   :dewey: [Dewey classification
   :pg: [Project Gutenberg text number]

  @links: { SiSU }http://www.sisudoc.org
    { FSF }http://www.fsf.org

  @make:
   :skin: skin_name [skins change default settings related to the appearance of documents generated]
   :num_top: 1
   :headings: [text to match for each level
      (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;)
   :breaks: new=:C; break=1
   :promo: sisu, ruby, sisu_search_libre, open_society
   :bold: [regular expression of words/phrases to be made bold]
   :italics: [regular expression of words/phrases to italicise]

  @original:
   :language: [language]

  @notes:
   :comment:
   :prefix: [prefix is placed just after table of contents]