teiJournal

Journal publishing through TEI XML.

Category: Hit by a bus

22/06/10

Permalink 10:37:10 am, by mholmes, 93 words, 159 views   English (CA)
Categories: Hit by a bus; Mins. worked: 15

Appendices

Appendices are part of the back matter, so they live in the <back> element, which is a child of <text>:

<back>
 
 <div type="appendix" xml:id="appendix_01">
   <head>Appendix 1</head>
   
 </div>
 
 <div type="appendix" xml:id="appendix_02">
   <head>Appendix 2</head>
   </div>
 
    <div type="bibliogr">
        <head>References</head>
        
        <listBibl>

            <bibl>...</bibl>

        </listBibl>

    </div>
</back>
PermalinkPermalink

21/06/10

Permalink 10:46:09 am, by mholmes, 221 words, 164 views   English (CA)
Categories: Activity log, Hit by a bus; Mins. worked: 20

Basic text structure

The structure of the main document (the <text> element) looks like this:

<text>
  <body> (main text content)
  <back> (bibliography)
</text>

Inside the <body> element are one or more <div>s, which can be nested. Each <div> may begin with a <head> element containing its heading, followed by a series of paragraphs (<p> tags) or other <div>s. A typical structure looks like this:

<div>
   <head>Introduction</head>
   <p>Intro paragraph...</p>
   <p>Intro paragraph...</p>
</div>

<div>
   <head>Section 1</head>
   <div>
      <head>Section 1.1</head>
      <p>Para in section 1.1</p>
      <p>Para in section 1.1</p>
   </div>
   <div>
      <head>Section 1.2</head>
      <p>Para in section 1.2</p>
      <p>Para in section 1.2</p>
   </div>
</div>

<div>
   <head>Section 2</head>
[...]
</div>

[...]

The formatting of headings will be handled automatically, according to the APA styleguide, based on the level of nesting.

PermalinkPermalink

16/06/10

Permalink 09:25:41 am, by mholmes, 128 words, 178 views   English (CA)
Categories: Activity log, Hit by a bus; Mins. worked: 15

Marking up abbreviations

All abbreviations need to be tagged, so the system can provide an appropriate mouseover hint to help readers who aren't sure what they mean (and to help populate our abbreviation index). This is how to do it:

  • The first time a specific abbreviation appears in the text, tag it in full, with its expansion, like this: 
    <choice>
  <abbr>CAIN</abbr>
  <expan>Computer Anxiety Index</expan>
</choice>
  • Tag any subsequent instances of the abbreviation using just the abbr tag, like this: 
      <abbr>CAIN</abbr>

The system will be able to look back in the text to find the expansion for each instance of the abbreviation, taking it from the first, fully marked-up version.

PermalinkPermalink

15/06/10

Permalink 10:13:00 am, by mholmes, 1336 words, 173 views   English (CA)
Categories: Activity log, Hit by a bus; Mins. worked: 60

Marking up bibliography items

Marking up the bibliography of an article can take as much as half the entire markup time for the article. This is because the information in a biblio reference is quite detailed, and in order to be harvestable and useful it needs to be marked up carefully. The bibliography also needs to be marked up before the text itself, because the text will be full of links to items in the bibliography, so their @xml:id attributes must be known before we can mark up the text.. The bibliography of the article appears in the <back> element of the <text> element, and it looks like this:

       <back>
            <div type="bibliogr">
                <head>References</head>   
                <listBibl>
                     <bibl>[...]</bibl>
                     <bibl>[...]</bibl>
                </listBibl>
            </div>
        </back>

Each item in the bibliography is contained by a <bibl> element, which looks like this:

<bibl xml:id="aida_1994">
  <author>
    <name><surname>Aida</surname>,
  <forename>Y.</forename></name>
  </author> 
  (<date when="1994">1994</date>). 
  <title level="a">Examination of Horwitz, Horwitz, and Cope’s construct of foreign language anxiety: The case of
  students of Japanese.</title> 
  <title level="j">The Modern Language Journal</title>, 
  <biblScope  type="vol">78</biblScope>, 
  <biblScope type="pp">155-168</biblScope>.
</bibl>

The original reference in this case looked like this:

Aida, Y. (1994). Examination of Horwitz, Horwitz, and Cope’s construct of foreign language anxiety: The case of students of Japanese. The Modern Language Journal, 78, 155-168.

Key points:

  • Each <bibl> element must have a unique @xml:id attribute, created from the lower-case surname(s) of the author(s), followed by an underscore and the year of the document. In the case of multiple documents from the same year, add a suffix such as a, b, c etc. The @xml:id attribute is what will be used to link references in the text to the bibliographical items they refer to.
  • The components of the reference remain in their normal sequence. All we need to do is to apply some markup to them; we don't change the actual text, or the order of items, at all.
  • We attempt to mark up everything we can usefully mark up.
  • Titles are marked up using the <title> tag, with the @level attribute showing the kind of title it is. These are the values for the level attribute:
    • <title level="a">This is an article title</title>
    • <title level="m">This is a book or monograph title</title>
    • <title level="j">This is a journal or periodical title</title>
    • <title level="s">This is a series title</title>
    • <title level="u">This is an unpublished title</title>
    Styling for titles (quotation marks for articles, italics for monographs, etc.) will be applied automatically based on the <title> tag.
  • Authors are marked up with the <author> tag, which contains a <name> tag; inside the <name> tag, the <surname> and <forename> are tagged. For multiple forenames or initials, just use a single <forename> tag, like this: 
    <author><name><surname<Holmes</surname>, <forename>Martin David</forename></name></author>
    Any punctuation (such as a comma between surname and forenames) should be left outside the <surname> and <forename> tags.
  • Editors are tagged just like authors, but they use the <editor> tag instead.
  • Dates are wrapped in a <date> tag, and the value of the date is added in the @when attribute of the date tag. Normally, in the case of a year, this will be identical to the content of the tag: 
    <date when="1994">1994</date>
    but the @when attribute takes a formal ISO date in the form YYYY-MM-DD, with optional MM and DD, so in some cases the @when attribute will be different from the tag content, like this: 
    <date when="1994-01">January, 1994</date>
  • Enclose a publisher in the <publisher> tag.
  • Enclose the publication place in a <pubPlace> tag.
  • Edition information should be wrapped in an edition tag: 
    <edition>3rd ed.</edition>
  • For volume/issue numbers, use <biblScope> tags, with the appropriate @type attribute: 
    <biblScope type="vol">28</biblScope>
    <biblScope type="issue">3</biblScope>
  • For page numbers, use the same tag with @type="pp": 
    <biblScope type="pp">26-45</biblScope>
  • For links to external urls, use a <ref> tag, with the URL in the @target attribute; whatever you would like to show as the linked text (usually the URL itself) should be inside the <ref> tag: 
    <ref target="http://hotpot.uvic.ca/">http://hotpot.uvic.ca/</ref>

Here are some more real-life examples:

<bibl xml:id="chun_plass_2000"><author><name><surname>Chun</surname>, <forename>D. M.</forename></name></author> & <author><name><surname>Plass</surname>, <forename>J. L.</forename></name></author> (<date when="2000">2000</date>). <title level="a">Networked multimedia environments for second language acquisition.</title> In <editor><name><forename>M.</forename> <surname>Warshauer</surname></name></editor> & <editor><name><surname>Kern</surname>, <forename>R. G.</forename></name></editor> (Eds.), <title level="m">Network-Based Language Teaching: Concepts and Practice</title> (pp. <biblScope type="pp">151-170</biblScope>). <pubPlace>Cambridge</pubPlace>: <publisher>Cambridge University Press</publisher>.</bibl>

<bibl xml:id="daly_1991"><author><name><surname>Daly</surname>, <forename>J.</forename></name></author> (<date when="1991">1991</date>). <title level="a">Understanding communication apprehension: An introduction for language educators.</title> In <editor><name><forename>E. K.</forename> <surname>Horwitz</surname></name></editor> & <editor><name><forename>D. J.</forename> <surname>Young</surname></name></editor> (Eds.), <title level="m">Language Anxiety: From Theory and Research to Classroom Implications</title>. <pubPlace>Englewood Cliffs, NJ</pubPlace>: <publisher>Prentice Hall</publisher>.</bibl>

<bibl xml:id="blake_2000"><author><name><surname>Blake</surname>, <forename>R.</forename></name></author> (<date when="2000">2000</date>). <title level="a">Computer-mediated communication: A window in L2 Spanish Interlanguage.</title> <title level="j">Language Learning and Technology</title>, <biblScope type="vol">4</biblScope>, <biblScope type="pp">120-136</biblScope>. Retrieved <date notAfter="2004-03-05">March 5, 2004</date> from <ref target="http://llt.msu.edu/vol4num1/blake/default.html"></ref>.</bibl>
PermalinkPermalink

14/06/10

Permalink 09:19:39 am, by mholmes, 243 words, 152 views   English (CA)
Categories: Activity log, Hit by a bus; Mins. worked: 30

The title statement (author and title information)

The title statement (<titleStmt>) tag, in <TEI/teiHeader/fileDesc>, contains the key information about the author and title which is used to generate the document title on the page, the title in the table of contents, and the running titles. It looks like this:

<fileDesc>
  <titleStmt>
    <title level="a" type="main">The effects of Asynchronous Computer Voice Conferencing on L2 Learners’ Speaking Anxiety</title>
    <title level="a" type="sub"></title>
    <title level="a" type="runningRecto">Asynchronous Voice Conferencing and Speaking Anxiety</title>
    <title level="a" type="runningVerso">Poza</title>
    <author>
      <name>
        <forename>María Isabel Charle</forename>
        <surname>Poza</surname>
        <affiliation><name type="org">Lincoln University</name></affiliation>
      </name>
    </author>
  </titleStmt>

If there is a main title and a subtitle, enter it into the subtitle field, which is optional. The running title (Atype="runningRecto") will appear on as the running title on the recto page; by convention, this is a shortened form of the main title. The runningVerso title is the surname of the author. The author's name should be broken up into <forename> and <surname> tags, with all forenames and initials going into the <forename> tag.

PermalinkPermalink

teiJournal

teiJournal is a project to create a scholarly journal publishing system based on TEI P5 XML, using Cocoon and eXist.

Actions

Reports

Categories

May 2013
Sun Mon Tue Wed Thu Fri Sat
 << <   > >>
      1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 31  

XML Feeds