Spine, Doc Reform - SiSU Markup
Ralph Amissah (2008-05-22)

SiSU Markup

2. Markup of Headers

The document header is based on yaml, and is the part of the document preceeding the document root marked by “A~ [Document title & author]”

The document header contains either: semantic meta-data about the document, 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 within the header section are the hash symbol at the start of a line (and as the first character in a line of text) followed by a space and the comment:

# in the header section of a document, this would be a comment  

2.1. Sample Header

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

# SiSU 8.0

title:
  main: "SiSU"
  subtitle: "Markup"

creator:
  author: "Amissah, Ralph"

date:
  created: "2002-08-28"
  issued: "2002-08-28"
  available: "2002-08-28"
  published: "2008-05-22"
  modified: "2020-04-11"

rights:
  copyright: "Copyright (C) Ralph Amissah 2007, 2020"
  license: "AGPL 3 (part of SiSU Spine documentation)"

classify:
  topic_register: "electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup"
  subject = "ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search"  

Looking back a bit:

# SiSU master 8.0

title:
  main: "SiSU"
  subtitle: "Markup"

creator:
  author: "Amissah, Ralph"

date:
  created: "2002-08-28"
  issued: "2002-08-28"
  available: "2002-08-28"
  published: "2008-05-22"
  modified: "2020-04-11"

rights:
  copyright: "Copyright (C) Ralph Amissah 2007, 2020"
  license: "AGPL 3 (part of SiSU Spine documentation)"

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

make:
  auto_num_top_at_level: "1"
  substitute: [
    [ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
  ]
  bold: "Debian|SiSU"
  italics: "Linux|GPL|LaTeX|SQL"
  breaks: "new=:B; break=1"
  home_button_text: "{SiSU}http://sisudoc.org; {sources / git}http://git.sisudoc.org/gitweb/"
  footer: "{SiSU}http://sisudoc.org; {git}http://git.sisudoc.org"  

2.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 two spaces subheadername: All Dublin Core meta tags are available

@identifier: information or instructions

where the “identifier” is a tag recognised by the program, and the “information” or “instructions” belong to the tag/identifier 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 8.0  

title:
  main: "SiSU"
  subtitle: "Markup"
  language: "English"  

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

date:
  created: [year or yyyy-mm-dd]
  issued: [year or yyyy-mm-dd]
  available: [year or yyyy-mm-dd]
  published: [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: "[Name, Year]"
  translation: "[Name, Year]"
  illustrations: "[Name, Year]"

# check rest  

classify:
  topic_register: "electronic documents;SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup"
  subject: "ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search"
  keywords: "list"
  loc: "[Library of Congress classification]"
  dewey: "[Dewey classification]"  

identifier:
  isbn: "[ISBN]"
  oclc: ""  

links: [
  "{SiSU }http://www.sisudoc.org",
  "{ FSF }http://www.fsf.org",
]  

make:
  auto_num_top_at_level: "1"
  substitute: [
    [ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
  ]
  bold: "Debian|SiSU" # [regular expression of words/phrases to be made bold]
  italics: "Linux|GPL|LaTeX|SQL" # [regular expression of words/phrases to italicise]
  breaks: "new=:B; break=1"
  home_button_text: "{SiSU}http://sisudoc.org; {sources / git}http://git.sisudoc.org/gitweb/"
  footer: "{SiSU}http://sisudoc.org; {git}http://git.sisudoc.org"
  headings: text to match for each level
    (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;)  



License: GPL 3 (part of SiSU documentation)


SiSU Spine (object numbering & object search) 2022