transcript ZiG html5 production guideline v2

general standards

• Please deliver a ZIP archive per issue containing all HTML files, the cover, images and the manifest file.
• There’s no need for a specific structure regarding images. They can reside inside a subdirectory or in the directory root (as long as they’re embedded properly from within the HTML files). Except the cover which has to reside within the project root.
• The HTML files may have a clean HTML5 head. There’s only need for 4 mandatory entries (see example files):
  • <meta charset="UTF-8">
  • <title> … </title> (containing the book/chapter title)
  • <meta name="dc.title" ...> (containing the book/chapter title)
  • <link href="styles.css" type="text/css" rel="stylesheet">
• Please insert an additional attribute for the link to the cover page (toc.html):
  <a epub:type="cover" href="9783732826902.html">Cover</a>
• Please place footnotes within the referring chapters; keep original numbering; place before “Literatur” with additional h2 “Anmerkungen” inside the <section class=”notes”>
• Please make sure that naming remains consistent across the project and that file names match the URLs
• !NEW!: There were some errors regarding the correct German spelling in the last issues - e.g.:
  Zeit(En) Des Anderen (wrong)
  Zeit(en) Des Anderen (correct because it’s just alternative plural within the parentheses)

metadata

• Title > document head and manifest.yml
• Publication date > document head and manifest.yml (take the date of the ebook-PDF)
• Language > document head and manifest.yml
• License information > manifest.yml
• Description > manifest.yml (see ebook-PDF Metadata)
• Creators (author/s, editor/s) > manifest.yml
• Contributors > manifest.yml
  

(see example files for format/s and placement)

titlepage/imprint

• !Attention!: Please note that all volumes are licensed under CC BY-SA - this has to be correct in imprint.html and manifest.yml for all volumes.
• Make sure to include the correct CC logo in imprint.html - this should be by-sa.png (including the correct img tag
  <img src="by-sa.png" alt="Creative Commons BY SA">)

Table of contents (toc.html)

• !NEW!: Please keep the formatting (e.g. bold, italic, ...) of the headings and subheadings (toc.html only - not manifest.yml).
• Please don’t list every sub chapter @ every level. Use the table of contents of the PDF as a reference for the toc.html and manifest.yml instead.
• Include Cover, Title page, imprint and table of contents itself only within the manifest.yml file - not in toc.html
• Book parts should be parents of the topmost chapter level.

manifest.yml

We’ve set up a commented example file. We assume that you’re familiar with YAML files. A few notes:

• Please note that indention is critical
• A colon as “key: value” delimiter (to map label, source_path, …) has to be followed by a space (critical)
• Please single quote (text)strings (headings, names, …) that contain “ : ” colon(s)
• Please give attention to the correct indention of nested elements (e.g. children - look at the example file in our example project)
• Please make sure to make titlepage.html the start section like so:
  - label: Titelseite

source_path: titlepage.html

start_section: true

• Please make sure to include the link to imprint.html in manifest.yml
• Please include the contributors' names with the chapter titles in round brackets - like so:
  »Die Hand einer Farbigen« Theodor Storms Von Jenseit des Meeres im literatur- und diskursgeschichtlichen Kontext (Melanie Rohner)
  Note: You may also do this in toc.html or keep those in separate lines (like in the PDF) - whatever is easier for you.
• !NEW!: Please use a full stop as a divider between heading and subheading in the manifest.yml like so:
  »Vor einem halben Jahr hätten wir Deutschland noch verlassen können«. Ablaufende Zeit in Fluchtromanen von Ulrich Alexander Boschwitz und Erich Maria Remarque (Alexander Košenina)
  Note: You may also do so in toc.html - or keep those in seperate lines without any divider (like in the PDF) - whatever is easier for you.
• A comment mark (“#”) must be followed by a space (else it wouldn’t be identified as a comment)

Tags and classes to use

h1.part (bookpart)

h1.chapter-title

h1.chapter-subtitle

h2...h5.section

h2...h5

p

p.author

p.abstract

p.title

section.imprint

p.cc-logo

p.keywords

<blockquote>

section.toc

section.bibliography

p.literature

p.motto

p.motto-source

<ul>

<ol>

p.verse

p.table-caption

p.table-source

span.note-anchor (+id)

section.notes

p.footnote

<em>, <strong>, <underline>, <sup>, <sub>

img.cover

figure (+id)

figcaption

titlepage

section.title-page

img.logo (logo transcript)

h1.title

h1.subtitle

p.author

miscellaneous

• book-parts as separate chapters
• entire italic-tagged paragraphs or <figcaption>: please remove italics but keep the emphasized parts inside (non-italic or “normal”) and tag them as <em>
• Mottos: please merge single paragraphs (caused by soft returns in ID) into one paragraph
• ordered/unordered lists: please keep all paragraphs (including blockquotes) belonging to a <li> element together (see the indents in the PDF)
• images: please take images off the corresponding ebook-PDF
• covers: cover.eps
• create the title.html and imprint.html with the content of the ebook-PDFs
• We are aware that reformatting the content with the small amount of styles/classes requires a great reduction of complexity. This doesn’t matter! Please notify us in really important cases, where these styles aren’t sufficient.
• We’ve set up an example project for loose reference - but that might not be complete or perfect.
• Please make sure to avoid non UTF8 characters - we’ve fixed a few occurrences in the manifest file: