Other tags
- Web links are created with
<xptr>tags:<xptr to="http://scancan.net/"/>
The URL will be used to create the link (in PDF and XHTML output) and will serve as the clickable text as well. During PDF rendering, invisible spaces are inserted into long URLs rendered as clickable links, so that the rendering engine can create soft linebreaks when wrapping is required. - Footnotes are included immediately inline where the footnote number should appear. They will be automatically rendered as endnotes or popups during the output process:
This sentence ends with a footnote.<note>This is the footnote.</note>
- Titles are handled everywhere with the
<title>tag, using the@levelattribute to designate what kind of title they are (m = monograph or standalone, a = analytic or component of a larger work, s = series, u = unpublished, j = journal or periodical). These attributes will automatically get you the formatting you need; for instance, this will be italicized:
<title level="m">Hedda Gabler</title>
and this will acquire double quotes around it:
<title level="a">Dover Beach</title>
In the latter case, remember that you'll have to include any punctuation that needs to appear in the quotes inside the<title>tag. This is annoying but basically unavoidable (without lots of costly rendering processing). - Glosses are handled using the
<gloss>tag, which will generate square brackets during rendering. - Titles with glosses need careful attention. There are two types. The first is where the gloss title is simply a translation of the original title:
<title level="m">Hiroshima Mon Amour</title> <gloss>Hiroshima My Love</gloss>
which will come out looking like this:
Hiroshima Mon Amour [Hiroshima My Love]
The second is where a work has been released in translation, and the gloss title is the title of the published translation:
<title level="m">Ivo Caprino’s Flåklypa Grand Prix</title> <gloss><title level="m">Pinchcliffe Grand Prix</title></gloss>
which will render like this:
Ivo Caprino’s Flåklypa Grand Prix [Pinchcliffe Grand Prix] - So-called (scare quotes): Anything which is in "scare quotes" (see Wikipedia for a definition) should be marked up with the
<soCalled>tag, which generates the quotes automatically during rendering. - mentioned (words mentioned rather than used): There is some inconsistency here in the editorial practice. This is an example of a word being mentioned rather than used:
The Japanese word mizu means water.
In this case, as in many others in the ScanCan documents, the word is italicized. The TEI tag<mentioned>is used here, and will result in italicized output. However, there are also many instances of a word being mentioned rather than used where the original writed supplied it in quotation marks rather than italicized, and the editor prefers to keep it that way in the output. Therefore these words must be marked up differently so that they appear in quotation marks. In most instances, it's possible to make a plausible case that the word is also being quoted from somewhere else, so it can be marked up using<cit><q>. This is not ideal, but it's a predictable outcome of the need to blend a real-world editorial policy, which is flexible and tends to honour a writer's idiosyncratic style rather than trying to impose a rigorous set of rules, and the more unforgiving categorization that markup demands. -
Images in the text: Images are inserted using a
<figure>element, with<xref>pointing to the image file by name. The image files themselves are located in the/images/directory inside the Cocoon site, and are named based on the filename of the XML document, with an appended underscore followed by the number of the figure. The XSLT takes care of building the link correctly. The caption is encoded in a<head>tag.
<figure rend="ImageLink"> <head>Genocide victims are loaded into the back of a truck in Andersson’s award-winning short film <title level="m">Härlig är Jorden</title> <gloss><title level="m">World of Glory</title></gloss> (1991). Photo courtesy of Studio24. </head> <p><xref>lindqvist_1_18_1.jpg</xref></p> </figure>
Minor quirks and idiosyncratic practices
- Ellipses are always done like this:
<hi rend="Garamond">…</hi>
The ellipsis is the real ellipsis character (u+2026), and the rend attribute invokes the use of the Garamond font (at least when rendering for PDF). The editor dislikes the spacing of the ellipsis character in the main Gentium font used for PDFs, so this character is rendered differently. A space is used both before and after the ellipsis.