XLingPaper User Documentation
H. Andrew Black
Cheryl A. Black
SIL International

9 May 2024
Version: 3.15.0

Contents

1 Introduction

NOTE: We highly recommend that you read the companion documentation, XLingPaper User Documentation Using the XMLmind XML Editor. It has much more current and relevant information in it. We maintain this documentation for legacy purposes.

The XLingPaper package is designed to aid the linguist in writing linguistic papers.

Linguists commonly face three obstacles in formatting papers. First, all examples are numbered in a paper. If during the writing process the author discovers a need to insert an example, then the numbering of all following examples and all references to those examples within the text need to be re-adjusted. This mechanical change can be both time-consuming and prone to error. Similarly, if the author decides to reorder some examples, then the numbering needs to be adjusted appropriately. XLingPaper provides an automatic way to facilitate such numbering and renumbering.

Secondly, linguists cite the work of other researchers using a standard citation format. This format functions essentially as an abbreviation or reference to the full citation entry which appears in the references section of the paper. The burden of maintaining consistency between citation and reference typically falls totally on the author. Many a reader has been disappointed to find a citation to a paper in the body of a paper for which there is no entry in the references section. XLingPaper provides an automatic means for a writer to maintain consistency; all citations in the text must have a corresponding entry in the references. Conversely, XLingPaper will include only those entries in the references section which are cited in the text. This latter characteristic implies that one can maintain one master list of references and merely include it in any given paper. Only those references actually cited in the given paper will appear in the references section.

Thirdly, linguists commonly use a set of abbreviations while glossing examples. They usually include either a list of the abbreviations and their definitions in a footnote, in a special front-matter page, or in a back-matter page. As for citations and references, the burden of maintaining consistency between the abbreviations used in the text and the abbreviations defined in the list typically falls totally on the author. Many a reader has been disappointed to find an abbreviation in a gloss for which there is no corresponding entry in the list of abbreviations. XLingPaper provides an automatic means for a writer to maintain consistency; the author can make it so all abbreviations in the text must have a corresponding entry in the list of abbreviations. Conversely, XLingPaper will include only those abbreviations in the list of abbreviations which are actually used in the text. This latter characteristic implies that one can maintain one master list of abbreviations and merely include it in any given paper. Only those abbreviations actually cited in the given paper will appear in the list of abbreviations. By the way, XLingPaper also creates a hyperlink between the abbreviation in the text and the abbreviation in the list of abbreviations. Thus, a reader can click on the abbreviation and see what it means.

In addition, in some formatting systems such as HTML, headers (i.e., h1, h2, etc.) are not automatically numbered. XLingPaper will automatically number all parts, chapters, and sections. Furthermore, one may create references to parts, chapters, or sections and these will display as hyperlinks to them, using the appropriate number.

Since XLingPaper is in XML, it also can serve as an archiving format.

1.1 Major Components

XLingPaper has several major components:

  1. Front matter
  2. Sections
  3. Back matter

The front matter contains items like the title, author, date, contents, and abstract.

The sections contain the main body of the paper. The main body can be as large as book parts which contain chapters (which in turn contain sections) or be a series of chapters or just a series of sections.

The back matter contains items like appendices, endnotes, and references.

1.2 Language Definitions

Besides the main text of the paper, one may also define the languages used within the paper. One can then tag individual data items as belonging to one of these languages. Each language definition has font-related information associated with it, so one can set the font, size, color, etc., for each language. When the paper is formatted, each data item tagged with a given language will consistently be shown in the specified way.

1.3 Using XLingPaper

This section describes how to use XLingPaper. There are two basic steps involved.

The first consists of entering the appropriate element tags into an XML document. That is, the writer needs to key the correct tags in the file(s) to enable XLingPaper to recognize them. To do this, one may use a plain text editor (e.g., Notepad or even Word), but it is extremely error-prone and hard to use. One could also use some (free) XML-aware editor, but our personal preference is to use the freely available XMLmind XML Editor. See section 12 for a description of the many advantages it offers and also information on how to get it. Let me emphasize that you will be much better off using the XMLmind XML Editor than any other method.

The second step in using XLingPaper is to process the document file(s) to show the output in some form. Currently there are ways to produce these kinds of outputs:

Another reason we prefer to use the XMLmind XML Editor is that it makes it easier to produce these outputs, too.

If you need to key the XML itself (i.e., you are not going to use the XMLmind XML Editor), you'll need to create the elements in a particular way. The syntax of the element tags follows the syntax of the XML elements. The basic syntax for an XML element is given in (1), where parentheses delimit optional elements.

(1)
<element (attribute1="value1") (attribute2="value2") (...) (attributen="valuen")>(element content)</element>

That is, an element begins with the opening wedge < character, the element tag name, any optional attribute names and their values, the closing wedge > character, the content of the element, and a closing element tag. Some elements have required attributes. Others do not.

Example (2) below shows the minimum you need to start.[1]

(2)
<!DOCTYPE lingPaper SYSTEM "XLingPap.dtd">
<?xml-stylesheet type="text/xsl" href="XLingPap1.xsl"?>
<lingPaper>
</lingPaper>

1.4 Organization of this Documentation

This user documentation is organized first by the major components: front matter, sections, and then back matter. There also are sections on examples, on tables, charts, and trees, on citations, and also on producing special effects. Appendix A contains a reference listing of all the elements that XLingPaper uses, with a brief description of each.

When we give examples of what elements to use to get a particular effect, we will show the XML itself. As we seek to note in section 12, the XMLmind XML Editor actually makes this much, much easier to key. The choice of editor you use to key an XLingPaper document, of course, is still up to you.

2 Front Matter

This section delineates the elements that can appear in the front matter of a paper. They are presented in the order in which they must occur.

2.1 Title

The title element is required in a frontmatter. A title may include language data and endnotes, as well as other elements.[2]

2.2 Subtitle

The subtitle element is optional. Like a title element, it may include language data and endotes, among other elements.

2.3 Author

One or more author elements must be included.

2.4 Author Contact Information

One or more authorContactInfo elements may optionally be included. Each one refers to an authorContact element via its author attribute.

These are typically only used for some publications. You probably will only need to insert one when you are about to publish your XLingPaper document and your publisher requires it.

See also section 11.2.

2.5 Affiliation

Each author name may be followed by the affiliation of that author or the preceding authors, using an affiliation element. These are optional elements.

2.6 PresentedAt

One may add this line in the front matter indicating that the paper had been presented at some conference. This is an optional element.

2.7 Date

The date of the paper may also be included as a date element. This is an optional element.

2.8 Version

The version element may be included to provide a version number for the document. It is also optional.

2.9 Table of Contents

One may optionally include a table of contents by merely including the contents element. Including this tag will instruct XLingPaper to automatically generate a table of contents.

The default situation is for the table of contents to include sections up to three levels deep (i.e., it will include the titles for all of the following: part, chapter, appendix, section1, section2, and section3). You can control how many section levels will be included in the table of contents by changing the value of the showLevel attribute. Its value can be any of the integer numbers between "1" and "6".

The table of contents will also include acknowledgements (if any), the abstract (if present), endnotes, and references.

XLingPaper will use a title of "Table of Contents" for the contents. If you wish to use some other title, set the label attribute to the title you want to use.

2.10 Acknowledgements

Acknowledgements for the paper may be included by using the acknowledgements element. The content of the acknowledgements may be a sequence of any "chunk" elements.[3]

XLingPaper will use a title of "Acknowledgements" for the acknowledgements. If you wish to use some other title, set the label attribute to the title you want to use.

2.11 Abstract

An abstract for the paper or book may be included by using the abstract element. The content of the abstract may be a sequence of any "chunk" elements. (See endnote [3] for what the "chunk" elements are.)

XLingPaper will use a title of "Abstract" for the abstract. If you wish to use some other title, set the label attribute to the title you want to use.

2.12 Preface

A preface for a book may be included by using the preface element. The content of the preface may be a sequence of any "chunk" elements. (See endnote [3] for what the "chunk" elements are.)

XLingPaper will use a title of "Preface" for the preface. If you wish to use some other title, set the label attribute to the title you want to use.

Note that if one has a preface element, then one may not also have an abstract element.

2.13 Front Matter Example

Here is an example of the front matter using most of the possibilities. If one keys the elements so they look like this:

(3)
<frontMatter>
<title>Sample XLingPaper Paper</title>
<author>Cheryl A. Black</author>
<author>H. Andrew Black</author>
<affiliation>SIL International</affiliation>
<date>21 June, 2001</date>
<version>1.0</version>
<contents showLevel="4"/>
<abstract>
<p>This paper illustrates the various elements available in the XML/XSLT-based linguistic paper markup scheme called XLingPap. It provides examples of the various markups and shows how they can be rendered in HTML.</p>
</abstract>
</frontMatter>

Then it might come out looking like what is shown in example (4).

(4)
Sample XLingPaper Paper
Cheryl A. Black
H. Andrew Black
SIL International

21 June, 2001
Version: 1.0

Table of Contents


Abstract

This paper illustrates the various elements available in the XML/XSLT-based linguistic paper markup scheme called XLingPap. It provides examples of the various markups and shows how they can be rendered in HTML.


Please note that if one uses the XMLmind XML Editor, then rather than keying what we show above in example (3),one would key it so it looks more like this:

(5)

Perhaps you can see why we prefer to use the XMLmind XML Editor.

3 Sections

Sections may be nested up to six levels deep. Each level is an element tag consisting of the word "section" followed by the level number. For example, a third level section is section3.

3.1 Section Title

Every section element has a required secTitle element which gives the section title. The title may contain language data and an endnote, if one so desires.[4]

3.2 Section Content

Sections may contain a sequence of any of the following elements:

3.3 Section Referencing

Every section element also has a required id attribute which is used to uniquely identify the section. One can use the sectionRef element to refer to a particular section via its sec attribute.[5] A hyperlink is made between the reference and the section header.

Note that if you wish to refer to an appendix, you should use the appendixRef element and set its app attribute to the id attribute of the appendix element.

3.4 Section Example

Here is an example of some sections, including some section references.

(6)
<section1 id="sIntr">
<secTitle>Introduction <langData lang="lCar">to this paper</langData>
</secTitle>
<p>This is the first section and it is an introduction.</p>
</section1>
<section1 id="sSecWithSubs">
<secTitle>Section with subsections</secTitle>
<p>This section has subsections.</p>
<section2 id="sSub1">
<secTitle>First subsection</secTitle>
<p>This is the first subsection. It has its own subsection.</p>
<section3 id="sSub12">
<secTitle>A sub-sub-section</secTitle>
<p>This is a subsubsection.</p>
<section4 id="sSub4">
<secTitle>Fourth level section</secTitle>
<p>This is a section, nested four levels deep.</p>
<section5 id="sSub5">
<secTitle>Fifth level section</secTitle>
<p>This is a section, nested five levels deep.</p>
<section6 id="sSub6">
<secTitle>Sixth level section</secTitle>
<p>This is a section, nested six levels deep. Six levels is the maximum allowed.</p>
</section6>
</section5>
</section4>
</section3>
</section2>
<section2 id="sSub2">
<secTitle>Second subsection</secTitle>
<p>This is the second subsection.</p>
</section2>
</section1>
<section1 id="sSampleReferences">
<secTitle>Section references</secTitle>
<p>One can refer to sections by using a <object class="element">sectionRef</object> element tag. For example, we could say, See section <sectionRef sec="sSub12"/> or see section <sectionRef sec="sIntr"/>.</p>
</section1>

Example (6) comes out as shown in example (7).

(7)

1 Introduction

This is the first section and it is an introduction.

2 Section with subsections

This section has subsections.

2.1 First subsection

This is the first subsection. It has its own subsection.

2.1.1 A sub-sub-section

This is a subsubsection.

2.1.1.1 Fourth level section

This is a section, nested four levels deep.

2.1.1.1.1 Fifth level section

This is a section, nested five levels deep.

2.1.1.1.1.1 Sixth level section

This is a section, nested six levels deep. Six levels is the maximum allowed.

2.2 Second subsection

This is the second subsection.

3 Section references

One can refer to sections by using a element tag. For example, we could say, See section 2.1.1 or see section 1.

3.5 Chapters

Instead of starting a paper with a top level section, one may use chapters instead. Each chapter then may have up to six levels of sections and subsections. Use the chapter element as the first element after any front matter.

3.6 Parts

If one is working on a larger project and the paper has not only chapters, but also parts (each of which contains chapters), then one should use the part element as the first element after any front matter.

4 Back Matter

Back matter consists of acknowledgements, appendices, glossary, endnotes, references, and indexes. All of these are optional.

4.1 Acknowledgements

Acknowledgements for the paper may be included either in the front matter or in the back matter. See section 2.10 for more on this.

4.2 Appendices

Appendices are similar to chapters. One merely adds an appendix element. It has its title and one may include sections and subsections. The appendix will automatically be given a letter. Its sections and subsections will be numbered like other sections, only they will begin with the appropriate appendix letter. See the example back matter section (4.8) below.

4.3 Glossary

A glossary for the paper may be included by using the glossary element. The content of the glossary may be a sequence of any "chunk" elements,[3] although including either a table or a definition list is the most likely.

XLingPaper will use a title of "Glossary" for the glossary. If you wish to use some other title, set the label attribute to the title you want to use.

4.4 Endnotes

HTML does not readily allow for footnotes, since the entire paper may be rendered on one HTML page. Therefore we use endnotes instead of footnotes. It is now possible for some outputs like PDF or Microsoft Word 2003 to use footnotes. Nonetheless, we still use endnote elements for this. That is, use an endnote element whether or not you plan to have endnotes or footnotes. The process that converts XLingPaper from XML to HTML or one of the other formats will take care of whether these elements show up as endnotes or as footnotes.

One keys an endnote in the text at the point where the reference to the endnote should go (i.e., the "endnote number", usually rendered in superscript). Create the endnote element, give it its required id attribute, type the content of the endnote, and then give the /endnote closing tag. The content of the endnote normally begins with a paragraph tag p, although one may use a sequence of any "chunk" elements.[3]

Note that an endnotes/ element is required in the back matter section in order to get endnotes to come out properly.

4.5 References

The references section begins by using the references element. One then creates a sequence of refAuthor elements within it. The refAuthor elements should be ordered alphabetically by the author's last name. Note that XLingPaper has you group the references by author, not by work.

Each refAuthor element has two required attributes: name and citename. The name attribute is how you want the author's name to appear in the references (usually last name first for single authors; see the examples below 4.8). You may also include a refAuthorInitials element for those cases where you need to use initials for the author(s) first, etc., names. The citename attribute is how you want the author's name to be shown in a citation within the body of the paper.

Within each refAuthor element, one lists one or more refWork elements, each of which describes a work by that author. They should be ordered by date, oldest first. Each refWork element has a required id attribute which can be referred to by citation elements within the body of the paper.

Every refWork element has both a refDate element and a refTitle element. The refDate element contains the date (i.e., year) of the work. If there is more than one work by the same author within a given year, merely list the year for each such work. XLingPaper will automatically append a letter after the year as appropriate. The refWork element may also optionally end with a url element (for indicating the address of a page on the World Wide Web if the work happens to be stored on the World Wide Web).

The refTitle element contains the title of the work. The title should not include any formatting (such as surrounding quotes) as these will be added automatically by XLingPaper. The title may, however, include any "embedded" elements.[6] You may also include a refTitleLowerCase element for those cases where you need to use titles which are lower case (except for the first word and proper nouns).

Any refWork element may optionally contdain a url element. This allows you to provide the URL where the work is available online. In addition, any refWork element may have one or more iso639-3code elements. These indicate the ISO 639-3 code for the language(s) discussed in the work.

The rest of the information about the citation depends on the type of citation it is. XLingPaper allows the types given in the following sections:

4.5.1 article

This is for an article published in a journal. Besides the date and the title, an article also has jTitle, jVol, and jPages elements (for the journal title, the journal volume number, and the page numbers of the article in the journal). It may also have optional location and publisher elements.

4.5.2 book

This is for a book. Besides the date and the title, a book also has optional translatedBy, editor, edition, series, and bVol (book volume) elements, a recommended location element and a recommended publisher element.

4.5.3 collection

This is for a paper included in a volume or collection of papers. Besides the date and the title, a collection paper also has:

  1. an optional collEd (collection volume editor(s)) element,
  2. a required collTitle (collection volume title) element,
  3. an optional collVol (collection volume number) element,
  4. an optional collPages (page numbers in the volume) element,
  5. an optional location element, and
  6. an optional publisher element.

The collEd element also has a plural attribute to indicate whether there is more than one editor. Use the value of yes if there are more than one editor; otherwise, use the value of no.

4.5.4 dissertation

This is for a Ph.D. dissertation. Besides the date and the title, a dissertation also has an optional location element, a required institution element, and an optional published element. The latter is for the case where the dissertation has also been published. A published element consists of recommended location and publisher elements, and a required pubDate element.

4.5.5 fieldNotes

This is for unpublished field note materials. Besides the date and the title, field notes also hav an optional location element and a required institution element.

4.5.6 ms

This is for an unpublished manuscript. Besides the date and the title, a manuscript also has either an optional location element followed by a required institution element or it has a required empty element.

4.5.7 paper

This is for a paper presented at a conference. Besides the date and the title, a paper also has a required conference element and an optional location element.

4.5.8 proceedings

This is for a paper included in a conference proceedings volume. Besides the date and the title, a proceedings paper also has:

  1. a required procEd (proceedings volume editor(s)) element,
  2. a required procTitle (proceedings volume title) element,
  3. an optional procVol (proceedings volume number) element,
  4. an optional procPages (page numbers in the volume) element,
  5. an optional location element, and
  6. an optional publisher element.

The procEd element also has a plural attribute to indicate whether there is more than one editor. Use the value of yes if there are more than one editor; otherwise, use the value of no.

4.5.9 thesis

This is for an M.A. thesis. Besides the date and the title, a thesis also has an optional location element, a required institution element, and an optional published element. The latter is for the case where the thesis has also been published. A published element consists of recommended location and publisher elements, and a required pubDate element.

4.5.10 webPage

This is for a paper that has been posted on the World Wide Web. Besides the date and the title, a web paper also has:

  1. an optional edition element,
  2. an optional location element,
  3. an optional institution element or publisher element,
  4. a required url element, and
  5. an optional dateAccessed element.

The url element is, of course, the address of the page on the World Wide Web. The URL will contain an HTML link to it, so you should be able to click on it within your web browser and link to it.

4.5.11 Using a Selected Bibliography

There are certain situations when you may find that you want more than just the cited references to appear. Some possible scenarios include an abstract that is to be submitted for a conference and proposals for theses and dissertations. The references in such situations are often referred to as “Selected References” or "Selected Bibliography.”

XLingPaper allows you to do this via a selectedBibliography element. It can appear immediately after a references element. It contains one or more citation elements which indicate the additional or “selected” references you want to have appear in your references. Any references cited in the document will appear just like they usually do.

Whenever you use a selectedBibliography element, the default label for the references section becomes “Selected Bibliography.” To change it to something else, use the label attribute of the selectedBibliography element.

Please note that the output will either have a “References” section or a “Selected Bibliography” section, but not both.

4.6 Indexes

Beginning with version 1.11.0 of XLingPaper, one may add one or more indexes to an XLingPaper document. There are four basic kinds of indexes allowed:

That is, one normally either has a single, common index or one has two to three specialized indexes.

To get an idea of what is involved in producing an index with XLingPaper, consider the following portion of an index taken from the output of an XLingPaper document:

(8)

Notice several things:

This implies that building an index in an XLingPaper document involves three steps:

  1. Creating the set of terms to be included in the index, including their relative hierarchical structure and any cross-referencing. This set of terms is what will show in the index section(s) in the output.
  2. Marking the document body for indexed items (i.e., tagging the places in the text that correspond to one of the index terms in the set of terms). If the indexed item covers a range of the document, then the beginning and ending points need to be marked.
  3. Adding one or more index elements to the back matter.

The following sections outline each of these steps in more detail.

4.6.1 Index Terms

The set of index terms is the potential content of the index(es). You may want to nest certain terms under other terms, if they are related. With XLingPaper, there is no enforced limit to the depth of nesting. In addition, you may want to include terms which then refer to another term elsewhere in the index. This, of course, is because a reader may look under some similar topic than the main one you have chosen.

There are three main elements used in describing the set of index terms:

  1. indexTerms: this contains a set of indexTerm elements.
  2. indexTerm: this is a single index term. Each indexTerm element contains one or more term elements and may also end with an indexTerms element (this is how one nests index terms).
  3. term: this is the actual description of the term. It can be associated with a given language (so you can potentially maintain one set of index terms that can be output in, say, English or Spanish or French). It also may contain any sequence of “embedded” elements. See [6].

As implied in the last point, it is possible to create some kind of a master set of index terms and then use that master set in more than one XLingPaper document.

The top-level indexTerms element goes as the last top-level element in the file (i.e., just before the closing /lingPaper element). You may have more than one of them (in order to include the master set and any document-specific ones). XLingPaper will sort them appropriately when producing the output.[7]

XLingPaper will only output those index terms which are actually tagged within the document. So one may define more index terms than are actually used in a given document. This is similar to how XLingPaper handles the references section.

The indexTerms elements have one attribute: version. It is used to indicate the version of the set of index terms. For example, one might create one set of terms and call them Master while another might be Syntax or Morphology.

An indexTerm element may have up to three attributes as shown in (9). Only the id attribute is required.

(9)
Attribute Possible Values Meaning
kind name, language, or subject (the default is subject) This indicates the kind of index. The name value is used for an index of names (for authors, e.g.). The language value is used for an index of languages (possibly including language families). The subject value is for a subject index.
id (user control) An ID to uniquely identify this index term. See [5].
see (user control) Reference to an ID used in the id attribute of another indexTerm element. This is how to refer to another index term.

A term element has an optional lang attribute which refers to a language element. This is a way to tag the term as being for a particular language (e.g., English or Spanish or French). The index element also has a lang attribute one can use to indicate which term elements to use.

4.6.2 Tagging the Document for Indexed Items

After setting up the set of index terms, the second step in producing an index is to tag the places in the document that correspond to index terms. Recall from example (8) that there are two main kinds of index references: singleton and a range. You use the indexedItem element to tag a singleton reference. For a range, you use two elements: indexRangeBegin to mark the beginning of the range and indexRangeEnd to mark the end of the range.

To mark a singleton index item, insert an indexedItem element at the point in the text where the material begins and set the term attribute of the inserted indexedItem element to the appropriate index term. XLingPaper will create a hyperlink to this location from the index term in the index.

To mark a range, first insert an indexRangeBegin element at the point in the text where the material begins. Set its term attribute to the appropriate index term and give it a unique id attribute. Then insert an indexRangeEnd element at the point in the text where the material ends. Set its begin attribute to refer to the id of its corresponding indexRangeBegin element. XLingPaper will create a hyperlink to both the begin location and the end location for the index term referred to in the term attribute of the indexRangeBegin element.

The indexedItem element has the attributes shown in (10). Only the term attribute is required.

(10)
Attribute Possible Values Meaning
main yes or no (the default is no) This indicates if the indexed item is the main instance of the index term in the document.
term (user control) Reference to an ID used in the id attribute of an indexTerm element.

The indexRangeBegin element has the attributes shown in (11). Both the id and term attributes are required.

(11)
Attribute Possible Values Meaning
id (user control) An ID to uniquely identify this indexRangeBegin element. See [5].
main yes or no (the default is no) This indicates if the indexed item is the main instance of the index term in the document.
term (user control) Reference to an ID used in the id attribute of an indexTerm element.

The indexRangeEnd element has one required attribute: begin. It refers to an ID of its matching indexRangeBegin element.

Whenever the main attribute of either an indexedItem or an indexRangeBegin element is set to yes, the hyperlink created in the output will be in bold. The exception to this is if there is only one instance in the entire document of either an indexedItem or an indexRangeBegin element that refers to this index term. In such a case, there will only be one hyperlink associated with the term, so it will not be output in bold.

4.6.3 The index Element

The third step in producing an index is to create one or more index elements as the last element within the backMatter element.

It is possible to have some prefatory text before the actual index material. This is so you could include some explanations if so desired. Such prefatory material is not required. If you wish to include some beginning text, you use a sequence of any "chunk" elements. See [3]

The index element has three optional attributes as shown in (12).

(12)
Attribute Possible Values Meaning
kind common, name, language, or subject (the default is common) This indicates the kind of index. The common value is used for a single, common index. The name value is used for an index of names (for authors, e.g.). The language value is used for an index of languages (possibly including language families). The subject value is for a subject index.
label (user control) A title to use for this index instead of the default title.
lang (user control) Reference to an ID used in the id attribute of a language element.

The kind attribute indicates one of four kinds of indexes. If you wish to have only one, common, index for your paper, then set the value to common. All index terms referred to in the document will then be included in this one index, regardless of the values of the kind attribute of any indexTerm elements. This allows you to have a master set of index terms which are tagged according to kind, but still have them all appear when you want a common index.

If you wish to have two or three indexes, then create two or three separate index elements and set the kind attribute to the appropriate value for each index. XLingPaper will produce a separate index for each one. Only those index terms which match the kind of the index will be included in each index.

The table in example (13) shows the default titles that XLingPaper will use.

(13)
When kind is set to: The default title is
common Index
name Name Index
language Language Index
subject Subject Index

If you wish to use some other title, set the label attribute of the index element to the title you want to use.

Finally, the lang attribute may be used to indicate which of several term elements to use for indexTerm elements (see 4.6.1). The default is to use the first term element.

4.7 Author Contact Information

See section 2.4 for this. If you insert an authorContactInfo element in the back matter, then the contact information will appear in the back matter of your document.

4.8 Back Matter Example

Here is an example of the back matter using all possibilities except indexes. If one keys the following

(14)
<backMatter>
<appendix id="aa">
<secTitle>First Appendix</secTitle>
<p>This is an appendix. It has all possible number of section nesting.</p>
<section1 id="a1">
<secTitle>First appendix section</secTitle>
<p>One can also add sections to appendices. They will be numbered like sections, except using initial capital letters.</p>
<section2 id="a12">
<secTitle>Subsection in an appendix</secTitle>
<p>One can have subsections, too. They may be nested up to six levels, just like regular sections.</p>
<section3 id="a123">
<secTitle>Sub-sub-section of an appendix</secTitle>
<section4 id="a1234">
<secTitle>Fourth level section in appendix</secTitle>
<section5 id="a12345">
<secTitle>Fifth level section in appendix</secTitle>
<section6 id="a123456">
<secTitle>Sixth level section in appendix</secTitle>
</section6>
</section5>
</section4>
</section3>
</section2>
</section1>
</appendix>
<appendix id="aA2">
<secTitle>Second Appendix</secTitle>
<p>This is the beginning of the second appendix. And it has a reference to example <exampleRef equal="no" num="x103d"/>.</p>
<section1 id="a2">
<secTitle>Second appendix</secTitle>
<p>This is an example of a section within an appendix.</p>
</section1>
</appendix>
<!--
ENDNOTES
-->
<endnotes/>
<!--
REFERENCES
-->
<references>
<refAuthor citename="Akinlabi" name="Akinlabi, Akinbiyi">
<refWork id="rAkinlabi1984">
<refDate>1984</refDate>
<refTitle>Tonal underspecification and Yoruba tone</refTitle>
<ms>
<institution>Univeristy of Ibadan</institution>
</ms>
</refWork>
</refAuthor>
<refAuthor citename="Alfonso et al." name="Alfonso, P., K. Honda, T. Baer, and K. Harris">
<refWork id="rAlfonsoEtAl1982">
<refDate>1982</refDate>
<refTitle>Multi-channel study of tongue EMG during vowel production</refTitle>
<paper>
<conference>103rd Meeting of the Acoustical Society of America</conference>
</paper>
</refWork>
</refAuthor>
<refAuthor name="Antworth, Evan" citename="Antworth">
<refWork id="rAntworth95">
<refDate>1995</refDate>
<refTitle>User's Guide to PC-KIMMO Version 2</refTitle>
<webPage>
<location>Dallas, Texas</location>
<publisher>SIL International</publisher>
<url>http://www.sil.org/pckimmo/v2/doc/guide.html</url>
</webPage>
</refWork>
</refAuthor>
<refAuthor citename="Dixon" name="Dixon, Robert">
<refWork id="rDixon1977a">
<refDate>1977</refDate>
<refTitle>A grammar of Yidin<object class="super">y</object>
</refTitle>
<book>
<location>Cambridge</location>
<publisher>Cambridge University Press</publisher>
</book>
</refWork>
<refWork id="rDixon1977b">
<refDate>1977</refDate>
<refTitle>Some phonological rules in Yidin<object class="super">y</object>
</refTitle>
<article>
<jTitle>Linguistic Inquiry</jTitle>
<jVol>8</jVol>
<jPages>1-34</jPages>
</article>
</refWork>
<refWork id="rDixon1977c">
<refDate>1977</refDate>
<refTitle>Something made up to test year-letter</refTitle>
<article>
<jTitle>Linguistic Inquiry</jTitle>
<jVol>8</jVol>
<jPages>185-86</jPages>
</article>
</refWork>
<refWork id="rDixon1988">
<refDate>1988</refDate>
<refTitle>A grammar of Boumaa Fijian</refTitle>
<book>
<location>Chicago</location>
<publisher>University of Chicago Press</publisher>
</book>
</refWork>
</refAuthor>
<refAuthor citename="Itô" name="Itô, Junko">
<refWork id="rIto1986">
<refDate>1986</refDate>
<refTitle>Syllable theory in prosodic phonology</refTitle>
<dissertation>
<location>Amherst</location>
<institution>University of Massachusetts</institution>
<published>
<location>New York</location>
<publisher>Garland Press</publisher>
<pubDate>1988</pubDate>
</published>
</dissertation>
</refWork>
<refWork id="rIto1989">
<refDate>1989</refDate>
<refTitle>A prosodic theory of epenthesis</refTitle>
<article>
<jTitle>Natural Language and Linguistic Theory</jTitle>
<jVol>7</jVol>
<jPages>217-59</jPages>
</article>
</refWork>
<refWork id="rIto1990">
<refDate>1990</refDate>
<refTitle>Prosodic minimality in Japanese</refTitle>
<proceedings>
<procEd plural="yes"> Michael Ziolkowski, Manuela Noske, and Karen Deaton</procEd>
<procTitle>CLS 26-II: Papers from the parasession on the syllable in phonetics and phonology</procTitle>
<procVol>26</procVol>
<procPages>213-39</procPages>
<location>Chicago</location>
<publisher>Chicago Linguistics Society, University of Chicago</publisher>
</proceedings>
</refWork>
</refAuthor>
<refAuthor citename="Mester" name="Mester, Armin">
<refWork id="rMester1990">
<refDate>1990</refDate>
<refTitle>Patterns of truncation</refTitle>
<article>
<jTitle>Linguistic Inquiry</jTitle>
<jVol>21</jVol>
<jPages>478-85</jPages>
</article>
</refWork>
</refAuthor>
<refAuthor name="Selkirk, E.O." citename="Selkirk">
<refWork id="rSelkirk84">
<refDate>1984</refDate>
<refTitle>On the major class features and syllable theory</refTitle>
<collection>
<collEd plural="yes">M. Aronoff and R. Oehrle</collEd>
<collTitle>Language Sound Structure</collTitle>
<location>Cambridge</location>
<publisher>MIT Press</publisher>
</collection>
</refWork>
</refAuthor>
<refAuthor citename="Spencer" name="Spencer, Andrew">
<refWork id="rSpencer1991">
<refDate>1991</refDate>
<refTitle>Morphological Theory</refTitle>
<book>
<location>Cambridge, Massachusetts</location>
<publisher>Basil Blackwell</publisher>
</book>
</refWork>
</refAuthor>
<refAuthor citename="E.Willett" name="Willett, Elizabeth">
<refWork id="rEWillett81">
<refDate>1981</refDate>
<refTitle>Word Shortening in Southeastern Tepehuan</refTitle>
<thesis>
<location>Grand Forks, N.D.</location>
<institution>University of North Dakota</institution>
</thesis>
</refWork>
</refAuthor>
</references>
</backMatter>

Then it might come out looking like what is shown in example (15).

(15)

A First Appendix

This is an appendix. It has all possible number of section nesting.

A.1 First appendix section

One can also add sections to appendices. They will be numbered like sections, except using initial capital letters.

A.1.1 Subsection in an appendix

One can have subsections, too. They may be nested up to six levels, just like regular sections.

A.1.1.1 Sub-sub-section of an appendix

A.1.1.1.1 Fourth level section in appendix

A.1.1.1.1.1 Fifth level section in appendix
A.1.1.1.1.1.1 Sixth level section in appendix

B Second Appendix

This is the beginning of the second appendix. And it has a reference to example (4).

B.1 Second appendix

This is an example of a section within an appendix.


Endnotes

[1]

This is the first endnote. It can contain just text or paragraphs or other main items.

[2]

This has two paragraphs with a chart in between.

This is a chart

This is the second paragraph.

[3]

Eph. 2:14-16, NASB


References

Akinlabi, Akinbiyi. 1984. "Tonal underspecification and Yoruba tone." Univeristy of Ibadan ms.

Alfonso, P., K. Honda, T. Baer, and K. Harris. 1982. "Multi-channel study of tongue EMG during vowel production." Paper presented at the 103rd Meeting of the Acoustical Society of America.

Antworth, Evan. 1995. "User's Guide to PC-KIMMO Version 2." Dallas, Texas: SIL International (http://www.sil.org/pckimmo/v2/doc/guide.html).

Dixon, Robert. 1977a. "Some phonological rules in Yidiny." Linguistic Inquiry 8:1-34.

Dixon, Robert. 1977b. "Something made up to test year-letter." Linguistic Inquiry 8:185-86.

Dixon, Robert. 1988. A grammar of Boumaa Fijian. Chicago: University of Chicago Press.

Itô, Junko. 1986. Syllable theory in prosodic phonology. Amherst: University of Massachusetts Ph.D. dissertation. Published by Garland Press, New York, 1988.

Itô, Junko. 1989. "A prosodic theory of epenthesis." Natural Language and Linguistic Theory 7:217-59.

Itô, Junko. 1990. "Prosodic minimality in Japanese." In Michael Ziolkowski, Manuela Noske, and Karen Deaton, eds. CLS 26-II: Papers from the parasession on the syllable in phonetics and phonology 26:213-39. Chicago Linguistics Society, University of Chicago, Chicago.

Selkirk, E.O. 1984. "On the major class features and syllable theory." In M. Aronoff and R. Oehrle, eds. Language Sound Structure Cambridge: MIT Press.

Willett, Elizabeth. 1981. Word Shortening in Southeastern Tepehuan. Grand Forks, N.D.: University of North Dakota M.A. thesis.

5 Examples

XLingPaper has several types of examples. All types will be automatically numbered. If you are going to refer to an example, then you will need to specify the num attribute of the example element tag and also give it a unique value.

The various types are illustrated in the following sections. Each section shows what to type and how it would appear.

5.1 Word examples

Word examples consist of one or more words, usually with their glosses. They come in two varieties: single and lists.

5.1.1 Single word examples

Single word examples consist of a single word and its gloss, usually. A single word example is given below. If you type what is shown in (16), you'll get the result in (17) (assuming that this is the second example in the paper).

(16)
<example num="xW1">
<word>
<langData lang="lNah">nikita</langData>
<gloss lang="lEng">"I saw it."</gloss>
</word>
</example>
(17)
(2) nikita "I saw it."

Notice that one uses the num attribute of the example element for these.

5.1.2 List of Words examples

The second kind of word example is a list of words. These consist of a list of words and their glosses, usually. A list of words example is given below. If you type what is shown in (18), then you'll get the result shown in (19) (assuming that this is the third example in the paper).

(18)
<example num="xLW2">
<listWord letter="xLW2d">
<langData lang="lNah">nikita</langData>
<gloss lang="lEng">"I see it."</gloss>
</listWord>
<listWord letter="xLW2s">
<langData lang="lNah">tikita</langData>
<gloss lang="lEng">"You(sg) see it."</gloss>
</listWord>
<listWord letter="xLW2e">
<langData lang="lNah">kita</langData>
<gloss lang="lEng">"He/she/it sees it."</gloss>
</listWord>
<listWord letter="xLW2g">
<langData lang="lNah">tikitah</langData>
<gloss lang="lEng">"We see it."</gloss>
</listWord>
<listWord letter="xLW2t">
<langData lang="lNah">ankitah</langData>
<gloss lang="lEng">"You(pl) see it."</gloss>
</listWord>
<listWord letter="xLW2u">
<langData lang="lNah">kitah</langData>
<gloss lang="lEng">"They see it."</gloss>
</listWord>
</example>
(19)
(3) a. nikita "I see it."
b. tikita "You(sg) see it."
c. kita "He/she/it sees it."
d. tikitah "We see it."
e. ankitah "You(pl) see it."
f. kitah "They see it."

Notice that one uses the num attribute of the example element for these. In addition, one uses the letter attribute of the listWord element. One does not need to label these letter attributes in any particular order. XLingPaper will correctly assign the letters.

5.2 Line examples

Line examples consist of but one line. There is no gloss (one would use an interlinear to include glosses). There are two varieties of line examples: single and list.

5.2.1 Single line examples

Single line examples consist of but one line. An English example is given below. If you type what is shown in (20), you'll get the result in (21) (assuming that this is the fourth example in the paper).

(20)
<example num="x102">
<single>
<langData lang="lEng">This is an example of a single line.</langData>
</single>
</example>
(21)
(4)This is an example of a single line.

Notice that one uses the num attribute of the example element for these.

5.2.2 List of single line examples

A list of single line examples consist of but one line each. The key difference between just a single example and a list of single examples is that the latter are indented and each line is prefixed by an alphabetic letter. The following is an English example. If you type what is shown in (22), you'll get the result in (23) (assuming that this is the fifth example in the paper).

(22)
<example num="x103">
<listSingle letter="x103d">
<langData lang="lEng">This is the first example.</langData>
</listSingle>
<listSingle letter="x103g">
<langData lang="lEng">Which is the second example?</langData>
</listSingle>
<listSingle letter="x103a">
<langData lang="lEng">If you'd like, this is the third example.</langData>
</listSingle>
</example>
(23)
(5) a. This is the first example.
b. Which is the second example?
c. If you'd like, this is the third example.

Notice that one uses the num attribute of the example element for these. In addition, one uses the letter attribute of the listSingle element. One does not need to label these letter attributes in any particular order. XLingPaper will correctly assign the letters.

5.3 Interlinear examples

Interlinear examples consist of several lines of aligned text along with one or more lines of an unaligned free translation. Like word and line examples, there are two varieties of interlinear: single and list. In addition, a given interlinear example may be created in one of three ways. Any one of these three may be included in a single interlinear or in any interlinear example included in a list of intelinear examples. These three ways are described in sections 5.3.1.1, 5.3.1.2, and 5.3.1.3.

5.3.1 Single interlinear examples

Single interlinear examples contain only one interlinear example. The following sub-sections delineate the three ways one may key an interlinear example. The first two align the words in the interlinear. The third also aligns the morphemes.

5.3.1.1 Word-aligned, using a space between words

The easiest way to key an interlinear example is to merely type a space between each of the words in the interlinear. You do this for both the language data itself and also for the glosses.

The following is a Nahuatl/English example. If you type what is shown in (24), you'll get the result in (25) (assuming that this is the sixth example in the paper).

(24)
<example num="x10">
<interlinear>
<lineGroup>
<line>
<langData lang="lNah">In Wan onikitak in kowat.</langData>
</line>
<line>
<langData lang="lNah">in Wan o-ni-k-ita-k in kowa-t</langData>
</line>
<line>
<gloss lang="lEng">the John PST-1-3O-see-PRET the snake-ABS</gloss>
</line>
</lineGroup>
<free>
<gloss lang="lEng">"John saw the snake."</gloss>
</free>
</interlinear>
</example>
(25)
(6) In Wan onikitak in kowat.
in Wan o-ni-k-ita-k in kowa-t
the John PST-1-3O-see-PRET the snake-ABS
"John saw the snake."

Notice that one uses the num attribute of the example element for these. In addition, notice how the line elements are grouped together under a lineGroup element.

Also note that XLingPaper does all that is needed to do the aligning (with the exception that it will not be able to automatically break long lines; see 5.3.3 below).

5.3.1.2 Word-aligned, marking certain words or morphemes

If you want the words to align, but you also want to, say, emphasize a certain word or some morpheme or if you want a gloss to show in small caps, then you need to use the second method for keying interlinear examples.

The following is an example from Lachixio Zapotec/Spanish. If you type what is shown in (26), you'll get the result in (27) (assuming that this is the fourth example in the paper).

(26)
<example num="xSustantivos.3">
<interlinear>
<lineGroup>
<line>
<wrd lang="lLZ">Nze'ta</wrd>
<wrd lang="lLZ">
<object class="emphasized" format="fEmphasized">bee</object>
</wrd>
<wrd lang="lLZ">
<object class="emphasized" format="fEmphasized">nze'e</object>
</wrd>
<wrd lang="lLZ">runa'</wrd>
<wrd lang="lLZ">
<object class="emphasized" format="fEmphasized">(bee)</object>
</wrd>
<wrd lang="lLZ">
<object class="emphasized" format="fEmphasized">nze'e</object>
</wrd>
<wrd lang="lLZ">equiella.</wrd>
</line>
<line>
<gloss lang="lGloss">viene plural esto llora plural esto sobre-él</gloss>
</line>
<line>
<wrd>
<gloss lang="lGloss">
<object type="tGrammaticalCategory">es</object>-venir</gloss>
</wrd>
<wrd>
<gloss lang="lGloss">
<object type="tGrammaticalCategory">pl</object>
</gloss>
</wrd>
<wrd>
<gloss lang="lGloss">esto</gloss>
</wrd>
<wrd>
<gloss lang="lGloss">
<object type="tGrammaticalCategory">h</object>-llorar</gloss>
</wrd>
<wrd>
<gloss lang="lGloss">
<object type="tGrammaticalCategory">pl</object>
</gloss>
</wrd>
<wrd>
<gloss lang="lGloss">esto</gloss>
</wrd>
<wrd>
<gloss lang="lGloss">sobre-<object type="tGrammaticalCategory">3r</object>
</gloss>
</wrd>
</line>
</lineGroup>
<free>
<gloss lang="lExample">‘Estos (sus parientes) vienen y lloran sobre él (porque está muerto)’</gloss>
</free>
</interlinear>
</example>
(27)
(4)
Nze'ta bee nze'e runa' (bee) nze'e equiella.
viene plural esto llora plural esto sobre-él
es-venir pl esto h-llorar pl esto sobre-3r
‘Estos (sus parientes) vienen y lloran sobre él (porque está muerto)’

Notice that one uses the num attribute of the example element for these. In addition, notice how the line elements are grouped together under a lineGroup element. Furthermore, also notice the use of type attributes to tag the grammatical categories (which are to be shown as small caps) and to tag the emphasized words in the example. See section 10.1 for more on this.

Also note that XLingPaper does all that is needed to do the aligning (with the exception that it will not be able to automatically break long lines; see 5.3.3 below).

5.3.1.3 Morpheme-aligned

If you want to have not only the words align, but also the morphemes within the words to align, you will need to key the interlinear examples in a special, more complicated way.[8] Some interlinearizing programs may automatically produce this kind of format. The SIL FieldWorks Language Explorer program is one that allows one to automatically generate this kind of interlinear. One can then merely copy and paste the results into an XLingPaper file. See http://www.sil.org/computing/fieldworks/flex/.

Besides aligning the morphemes within words, this kind will also automatically wrap long interlinear examples when viewed in a webpage. It will not automatically wrap in PDF or Microsoft Word 2003 format, though.[9]

The following is an example from Orizaba Nahuatl/English. If you type what is shown in (28), you'll get the result in (29) (assuming that this is the second example in the paper).

(28)
<example num="x2.1.">
<interlinear>
<phrase>
<words>
<iword>
<item lang="nlv" type="txt">oniknekiskia</item>
<morphemes>
<morphset>
<morph type="prefix">
<item lang="nlv" type="txt">o-</item>
<item lang="nlv" type="cf">o-</item>
<item lang="en" type="gls">PAST</item>
<item lang="en" type="msa">Intransitive verb:Past</item>
</morph>
<morph type="prefix">
<item lang="nlv" type="txt">ni-</item>
<item lang="nlv" type="cf">ni-</item>
<item lang="en" type="gls">SUBJ:1.SG</item>
<item lang="en" type="msa">Verb:(Subject)</item>
</morph>
<morph type="prefix">
<item lang="nlv" type="txt">k-</item>
<item lang="nlv" type="cf">k-</item>
<item lang="en" type="gls">OBJ:3</item>
<item lang="en" type="msa">Verb:Object</item>
</morph>
<morph type="bound root">
<item lang="nlv" type="txt">neki</item>
<item lang="nlv" type="cf">neki</item>
<item lang="en" type="gls">to want</item>
<item lang="en" type="msa">Transitive verb (II)</item>
</morph>
<morph type="suffix">
<item lang="nlv" type="txt">-skia</item>
<item lang="nlv" type="cf">-skia</item>
<item lang="en" type="gls">COND</item>
<item lang="en" type="msa">Verb:Conditional/Pluperfect</item>
</morph>
<morph type="suffix">
<item lang="nlv" type="txt">-*0</item>
<item lang="nlv" type="cf">-*0<object type="tHomographNumber">1</object>
</item>
<item lang="en" type="gls">IMPFV.SUBJ:SG</item>
<item lang="en" type="msa">Verb:Imperfective/Number</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">I would want</item>
<item lang="en" type="pos">V</item>
</iword>
<iword>
<item lang="nlv" type="txt">nimitzillis</item>
<morphemes>
<morphset>
<morph type="prefix">
<item lang="nlv" type="txt">ni-</item>
<item lang="nlv" type="cf">ni-</item>
<item lang="en" type="gls">SUBJ:1.SG</item>
<item lang="en" type="msa">Verb:(Subject)</item>
</morph>
<morph type="prefix">
<item lang="nlv" type="txt">mitz-</item>
<item lang="nlv" type="cf">mitz-</item>
<item lang="en" type="gls">OBJ:2.SG</item>
<item lang="en" type="msa">Verb:Object</item>
</morph>
<morph type="bound root">
<item lang="nlv" type="txt">lli</item>
<item lang="nlv" type="cf">llia</item>
<item lang="en" type="gls">to tell</item>
<item lang="en" type="msa">Ditransitive verb (III)</item>
</morph>
<morph type="suffix">
<item lang="nlv" type="txt">-s</item>
<item lang="nlv" type="cf">-s</item>
<item lang="en" type="gls">Fut</item>
<item lang="en" type="msa">Verb:Future</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">I'll tell you</item>
<item lang="en" type="pos">V</item>
</iword>
<iword>
<item lang="nlv" type="txt">miek</item>
<morphemes>
<morphset>
<morph type="root">
<item lang="nlv" type="txt">miek</item>
<item lang="nlv" type="cf">miek</item>
<item lang="en" type="gls">many</item>
<item lang="en" type="msa">Quantifier</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">many</item>
<item lang="en" type="pos">Quant</item>
</iword>
<iword>
<item lang="nlv" type="txt">tlamantli</item>
<morphemes>
<morphset>
<morph type="root">
<item lang="nlv" type="txt">tlaman</item>
<item lang="nlv" type="cf">tlaman</item>
<item lang="en" type="gls">thing</item>
<item lang="en" type="msa">Native noun</item>
</morph>
<morph type="suffix">
<item lang="nlv" type="txt">-tli</item>
<item lang="nlv" type="cf">-tl</item>
<item lang="en" type="gls">ABS</item>
<item lang="en" type="msa">Native noun:Abs/Plural</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">things</item>
<item lang="en" type="pos">NNat</item>
</iword>
<iword>
<item lang="nlv" type="punct">,</item>
</iword>
<iword>
<item lang="nlv" type="txt">noso</item>
<morphemes>
<morphset>
<morph type="particle">
<item lang="nlv" type="txt">noso</item>
<item lang="nlv" type="cf">noso</item>
<item lang="en" type="gls">then</item>
<item lang="en" type="msa">Adverb</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">but</item>
<item lang="en" type="pos">Adv</item>
</iword>
<iword>
<item lang="nlv" type="txt">ayemo</item>
<morphemes>
<morphset>
<morph type="particle">
<item lang="nlv" type="txt">ayemo</item>
<item lang="nlv" type="cf">ayemo</item>
<item lang="en" type="gls">still no, not</item>
<item lang="en" type="msa">Particle</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">not</item>
<item lang="en" type="pos">Prt</item>
</iword>
<iword>
<item lang="nlv" type="txt">tikahsikamati</item>
<morphemes>
<morphset>
<morph type="prefix">
<item lang="nlv" type="txt">ti-</item>
<item lang="nlv" type="cf">ti-<object type="tHomographNumber">1</object>
</item>
<item lang="en" type="gls">SUBJ:2.SG</item>
<item lang="en" type="msa">Verb:(Subject)</item>
</morph>
<morph type="prefix">
<item lang="nlv" type="txt">k-</item>
<item lang="nlv" type="cf">k-</item>
<item lang="en" type="gls">OBJ:3</item>
<item lang="en" type="msa">Verb:Object</item>
</morph>
<morph type="stem">
<item lang="nlv" type="txt">ahsikamati</item>
<item lang="nlv" type="cf">ahsikamati</item>
<item lang="en" type="gls">to understand</item>
<item lang="en" type="msa">Transitive verb (II)</item>
</morph>
<morph type="suffix">
<item lang="nlv" type="txt">-*0</item>
<item lang="nlv" type="cf">-*0<object type="tHomographNumber">1</object>
</item>
<item lang="en" type="gls">IMPFV.SUBJ:SG</item>
<item lang="en" type="msa">Verb:Imperfective/Number</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">you(sg) understand</item>
<item lang="en" type="pos">V</item>
</iword>
<iword>
<item lang="nlv" type="txt">tlen</item>
<morphemes>
<morphset>
<morph type="particle">
<item lang="nlv" type="txt">tlen</item>
<item lang="nlv" type="cf">tlen</item>
<item lang="en" type="gls">that which</item>
<item lang="en" type="msa">Relativizer</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">that which</item>
<item lang="en" type="pos">Rel</item>
</iword>
<iword>
<item lang="nlv" type="txt">nikihtova</item>
<morphemes>
<morphset>
<morph type="prefix">
<item lang="nlv" type="txt">ni-</item>
<item lang="nlv" type="cf">ni-</item>
<item lang="en" type="gls">SUBJ:1.SG</item>
<item lang="en" type="msa">Verb:(Subject)</item>
</morph>
<morph type="prefix">
<item lang="nlv" type="txt">ki-</item>
<item lang="nlv" type="cf">k-</item>
<item lang="en" type="gls">OBJ:3</item>
<item lang="en" type="msa">Verb:Object</item>
</morph>
<morph type="bound stem">
<item lang="nlv" type="txt">ihtova</item>
<item lang="nlv" type="cf">ihtova</item>
<item lang="en" type="gls">to say</item>
<item lang="en" type="msa">Transitive verb (III)</item>
</morph>
<morph type="suffix">
<item lang="nlv" type="txt">-*0</item>
<item lang="nlv" type="cf">-*0<object type="tHomographNumber">1</object>
</item>
<item lang="en" type="gls">IMPFV.SUBJ:SG</item>
<item lang="en" type="msa">Verb:Imperfective/Number</item>
</morph>
</morphset>
</morphemes>
<item lang="en" type="gls">I say</item>
<item lang="en" type="pos">V</item>
</iword>
<iword>
<item lang="nlv" type="punct">.</item>
</iword>
</words>
<item lang="en" type="gls">I would like to tell you many things, but you won't understand what
I'm saying.</item>
</phrase>
</interlinear>
</example>
(29)
(2)
oniknekiskia 
o- 
o- 
PAST 
Intransitive verb:Past 
ni- 
ni- 
SUBJ:1.SG 
Verb:(Subject) 
k- 
k- 
OBJ:3 
Verb:Object 
neki 
neki 
to want 
Transitive verb (II) 
-skia 
-skia 
COND 
Verb:Conditional/Pluperfect 
-*0 
-*01 
IMPFV.SUBJ:SG 
Verb:Imperfective/Number 
I would want 

nimitzillis 
ni- 
ni- 
SUBJ:1.SG 
Verb:(Subject) 
mitz- 
mitz- 
OBJ:2.SG 
Verb:Object 
lli 
llia 
to tell 
Ditransitive verb (III) 
-s 
-s 
Fut 
Verb:Future 
I'll tell you 

miek 
miek 
miek 
many 
Quantifier 
many 
Quant 
tlamantli 
tlaman 
tlaman 
thing 
Native noun 
-tli 
-tl 
ABS 
Native noun:Abs/Plural 
things 
NNat 
,
noso 
noso 
noso 
then 
Adverb 
but 
Adv 
ayemo 
ayemo 
ayemo 
still no, not 
Particle 
not 
Prt 
tikahsikamati 
ti- 
ti-1 
SUBJ:2.SG 
Verb:(Subject) 
k- 
k- 
OBJ:3 
Verb:Object 
ahsikamati 
ahsikamati 
to understand 
Transitive verb (II) 
-*0 
-*01 
IMPFV.SUBJ:SG 
Verb:Imperfective/Number 
you(sg) understand 

tlen 
tlen 
tlen 
that which 
Relativizer 
that which 
Rel 
nikihtova 
ni- 
ni- 
SUBJ:1.SG 
Verb:(Subject) 
ki- 
k- 
OBJ:3 
Verb:Object 
ihtova 
ihtova 
to say 
Transitive verb (III) 
-*0 
-*01 
IMPFV.SUBJ:SG 
Verb:Imperfective/Number 
I say 

.

I would like to tell you many things, but you won't understand what I'm saying.

Notice that one uses the num attribute of the example element for these. In addition, notice the use of the various elements and attributes. If you are producing such an interlinear example by hand, you may want to read Hughes, Bird, and Bow (2003) which is available online at http://eprints.unimelb.edu.au/archive/00000455/.

5.3.2 List of interlinear examples

Besides single interlinear examples, one may also produce a list of interlinear examples. Such a list consists of individual interlinear examples. The key difference between just a single interlinear example and a list of interlinear examples is that the latter are indented and each interlinear unit is prefixed by an alphabetic letter. You may use any of the three kinds of interlinear examples shown in sections 5.3.1.1, 5.3.1.2, and 5.3.1.3 above. We will illustrate using the first method for simplicity's sake.

The following is a Nahuatl/ English example. If you type what is shown in (30), you'll get the result in (31) (assuming that this is the seventh example in the paper).

(30)
<example num="x16">
<listInterlinear letter="x16d">
<lineGroup>
<line>
<langData lang="lNah">In Wan onikitak in kowat.
</langData>
</line>
<line>
<langData lang="lNah">in Wan o-ni-k-ita-k in kowa-t</langData>
</line>
<line>
<langData lang="lEng">the John PST-1-3O-see-PRET the snake-ABS</langData>
</line>
</lineGroup>
<free>
<gloss lang="lEng">"John saw the snake."</gloss>
</free>
</listInterlinear>
<listInterlinear letter="x16g">
<lineGroup>
<line>
<langData lang="lNah">Onikitak in Wan in kowat.</langData>
</line>
<line>
<langData lang="lNah">o-ni-k-ita-k in Wan in kowa-t</langData>
</line>
<line>
<langData lang="lEng">PST-1-3O-see-PRET the John the snake-ABS</langData>
</line>
</lineGroup>
<free>
<gloss lang="lEng">"John saw the snake."</gloss>
</free>
</listInterlinear>
</example>
(31)
(7) a.
In Wan onikitak in kowat.
in Wan o-ni-k-ita-k in kowa-t
the John PST-1-3O-see-PRET the snake-ABS
"John saw the snake."
b.
Onikitak in Wan in kowat.
o-ni-k-ita-k in Wan in kowa-t
PST-1-3O-see-PRET the John the snake-ABS
"John saw the snake."

5.3.3 Handling long interlinear examples

As mentioned in sections 5.3.1.1, 5.3.1.2, and 5.3.1.3 above, XLingPaper does not automatically break lengthy interlinear examples (except for the morpheme-aligned ones when the output is a webpage). You have to break long lines yourself. This is not necessarily a negative thing. By breaking the interlinear examples by hand, you are able to control where the break occurs. For example, you may choose to only have an interlinear example break at a phrase boundary.

You insert these manual breaks by embedding an interlinear element within either another interlinear element or within a llistInterlinear element.

Example (32) shows one way this could be done. The result is given in (33). (We use the word-aligned, using a space method for simplicity.)

(32)
<example num="x10">
<interlinear>
<lineGroup>
<line>
<langData lang="lNah">In Wan onikitak</langData>
</line>
<line>
<langData lang="lNah">in Wan o-ni-k-ita-k</langData>
</line>
<line>
<gloss lang="lEng">the John PST-1-3O-see-PRET</gloss>
</line>
</lineGroup>
<free>
<gloss lang="lEng">"John saw"</gloss>
</free>
<interlinear>
<lineGroup>
<line>
<langData lang="lNah">in kowat.</langData>
</line>
<line>
<langData lang="lNah">in kowa-t</langData>
</line>
<line>
<gloss lang="lEng">the snake-ABS</gloss>
</line>
</lineGroup>
<free>
<gloss lang="lEng">"the snake."</gloss>
</free>
</interlinear>
</interlinear>
</example>
(33)
(8)
In Wan onikitak
in Wan o-ni-k-ita-k
the John PST-1-3O-see-PRET
"John saw"
in kowat.
in kowa-t
the snake-ABS
"the snake."

5.3.4 Citing the source of the interlinear

Another characteristic of interlinear examples is that they may be taken from an interlinear text. In such cases, one may well want to indicate the text and line number from where the interlinear was taken. One convention is to include an abbreviated name of the text, a colon, and the line number. XLingPaper provides two ways to do this, depending on whether the source interlinear text is included within the XLingPaper document or not.

5.3.4.1 Interlinear text included in the XLingPaper document

If the source interlinear text is included in the XLingPaper document (most likely as an interlinear-text element within an appendix; see section 9), then you can create an interlinear example that will refer to the appropriate portion of the interlinear text. You can do so by following these steps:

  1. Find the portion of the interlinear text you want to use.
  2. Select its interlinear element .
  3. Copy the element.
  4. Go to where you want to create an example for this portion.
  5. Create an interlinear example
  6. Select the interlinear element.
  7. Paste the interlinear element you just copied.
  8. Unless it is already there,[10] set the textref attribute to the text ID attribute of that portion (if it does not have one yet, you will need to add one in the interlinear text itself; see section 9.2).
  9. Note that you do not want to have a text ID attribute in the copied portion..

For example, if you key what is shown in (34) (and you have the interlinear text shown in (78) in your XLingPaper document), it will come out as shown in (37) (assuming this is the second example in the document).

(34)
<example num="xLife2">
<interlinear textref="TLIQ2">
<lineGroup>
<line>
<langData lang="lVernacular">Bi tap ra noo molin.</langData>
</line>
<line>
<langData lang="lVernacular">bi tap r-a noo molin</langData>
</line>
<line>
<gloss lang="lGloss">at four H-go 1ex mill</gloss>
</line>
</lineGroup>
<free>At four I would go to the grinder.</free>
</interlinear>
</example>
(35)
(2)
Bi tap ra noo molin.    [LifeInQ:2]
bi tap r-a noo molin
at four H-go 1ex mill
At four I would go to the grinder.

Please note several things:

.

5.3.4.2 Interlinear text not in the XLingPaper document

If the source interlinear text is not included in the XLingPaper document, then you can use the interlinearSource element to type in a reference to the text.

For example, if you key what is shown in (36), it will come out as shown in (37) (assuming this is the second example in the document).

(36)
<example num="xQuestion">
<interlinear>
<lineGroup>
<line>
<langData lang="lVernacular">pa go r-laa de</langData>
</line>
<line>
<gloss lang="lGloss">what thing H-do 2</gloss>
</line>
</lineGroup>
<free>‘What are you doing?’</free>
<interlinearSource>Gringo:34</interlinearSource>
</interlinear>
</example>
(37)
(2)
pa go r-laa de    [Gringo:34]
what thing H-do 2
‘What are you doing?’

Please note several things:

.

5.4 Tables

Table examples consist of a table (of course). See section 6.1 for more on dealing with tables.

5.5 Charts

Chart examples consist of a chart (of course). See section 6.2 for more on this.

5.6 Trees

Tree examples consist of a tree diagram or image (of course). See section 6.3 for more on this.

5.7 Definitions

Definition examples merely consist of a definition, optionally including its key term. They come in two varieties: single and lists.

5.7.1 Single definition examples

A single definition example merely consists of a definition, including its key term. A definition example is given below. If you type what is shown in (38), you'll get the result in (39) (assuming that this is the second example in the paper).

(38)
<example num="xReferentialNP">
<definition>A noun phrase is <keyTerm>referential</keyTerm> when it is used to speak of an object as an object, with continuous identity over time.</definition>
</example>
(39)
(2)
A noun phrase is referential when it is used to speak of an object as an object, with continuous identity over time.

5.7.2 List of Definitions examples

The second kind of definition example is a list of definitions. As an example, if you type in the values as shown in (40), you'll get the result shown in (41) (assuming that this is the third example in the paper).

(40)
<example num="xMarkedness">
<listDefinition letter="xStructuralComplexity">
<definition><keyTerm>Structural complexity:</keyTerm> An element X is marked with respect to another element Y if X is more complex, morphologically or syntactically, than Y</definition>
</listDefinition>
<listDefinition letter="xContextulMarkedness">
<definition><keyTerm>Contextual markedness:</keyTerm> An environment ER is a marked one for an element X if E is not a member of the largest subset of environments X where X displays the greatest number of common properties</definition>
</listDefinition>
</example>
(41)
(3)
a. Structural complexity: An element X is marked with respect to another element Y if X is more complex, morphologically or syntactically, than Y
b. Contextual markedness: An environment ER is a marked one for an element X if E is not a member of the largest subset of environments X where X displays the greatest number of common properties

Notice that one uses the num attribute of the example element for these. In addition, one uses the letter attribute of the listDefinition element. One does not need to label these letter attributes in any particular order. XLingPaper will correctly assign the letters.

5.8 Headings on Examples

Sometimes one wishes to tag an interlinear example or a list of interlinear examples with a title or heading or label. One uses the exampleHeading element for this. Insert an exampleHeading element within the example element, just before the interlinear or listInterlinear element. One may also put an exampleHeading element within a listInterlinear element before a lineGroup element. This way, you can label or tag each interlinear within the list as needed.

5.9 References to Examples

Example numbering involves two aspects: an example number declaration and an example number reference. The example number declaration "declares" the existence of an example number and its unique name. The example number reference refers to an example number that is "declared" elsewhere within the file(s). Consider the following example:

(42)
<p>...Several monosyllabic stems are shown in <exampleRef num="xMonosyllabicStems"/>.
</p>
<example num="xMonosyllabicStems">
<listWord letter="xMonosyllabicStemVoi">
<langData lang="lSET">voi</langData>
<gloss lang="lEng">'trail'</gloss>
</listWord>
<listWord letter="xMonosyllabicStemTai">
<langData lang="lSET">tai</langData>
<gloss lang="lEng">'fire'</gloss>
</listWord>
<listWord letter="xMonosyllabicStemDui">
<langData lang="lSET">dui</langData>
<gloss lang="lEng">'plum'</gloss>
</listWord>
<listWord letter="xMonosyllabicStemGaa">
<langData lang="lSET">gaa</langData>
<gloss lang="lEng">'cornfield'</gloss>
</listWord>
</example>
<p>Notice that while <exampleRef letter="xMonosyllabicStemVoi" punct="-" paren="initial"/><exampleRef letter="xMonosyllabicStemDui" paren="final" letterOnly="yes"/> contain diphthongs,
<exampleRef letter="xMonosyllabicStemGaa"/> has a final long vowel.<
>
...<
>
Now consider the following forms, some repeated from earlier.
</p>
<example num="xIamb">
<listWord letter="xIambGaa">
<langData lang="lSET">gaa</langData>
<gloss lang="lEng">'cornfield' <exampleRef equal="yes" letter="xMonosyllabicStemGaa"/></gloss>
</listWord>
<listWord letter="xIambTopaa">
<langData lang="lSET">topaa</langData>
<gloss lang="lEng">'pestle'</gloss>
</listWord>
<listWord letter="xIambKasio">
<langData lang="lSET">kasio</langData>
<gloss lang="lEng">'fox'</gloss>
</listWord>
</example>

If example example num="xMonosyllabicStems" turned out to be the third example in the document and example num="xIamb" was the twenty-first, the output of (42) would be:

(43)

...Several monosyllabic stems are shown in (3).

(3) a. voi 'trail'
b. tai 'fire'
c. dui 'plum'
d. gaa 'cornfield'

Notice that while (3a-c) contain diphthongs, (3d) has a final long vowel.
...
Now consider the following forms, some repeated from earlier.

(21) a. gaa 'cornfield' (=3d)
b. topaa 'pestle'
c. kasio 'fox'

The example element declares a new example. Two basic types of example references were used. One, exampleRef num="x...", becomes the number enclosed in parentheses. The other, exampleRef letter="x..." adds a letter. Notice that one can also create example references which contain a sequence of letters. One does this by using the paren, punct, and letterOnly attributes.

Also note that a hyperlink is made between the reference and the example in the text.

The equal attribute can be used to insert an equals sign in the reference. This, of course, indicates that the particular example has been given earlier in the paper. Example reference elements can be used anywhere within a document. They do not need to immediately precede or follow their respective example declaration.

The attributes of the exampleRef element are summarized in the table in (44).

(44)
Attribute Possible Values Meaning
num (user control) Reference to an ID used in the num attribute of an example element.
letter (user control) Reference to an ID used in the letter attribute of a listWord, listSingle, or listInterlinear element.
equal yes or no (the default is no) Whether to include an equals sign before the number (yes) or not (no).
punct (user control) Any punctuation that should follow the number or letter. Typically, this will be a hyphen or a comma.
paren both, none, initial, or final (the default is both) This controls the appearance of opening and closing parentheses around the example number and/or letter. An opening parenthesis appears if either both or initial are set. A closing parenthesis appears if either both or initial are set. No parentheses appear if none is set.
letterOnly yes or no (the default is no) If this is set to yes, then only the letter will appear, not the number and the letter. Of course, this only makes sense if one is using the letter attribute.

6 Tables, Charts, and Trees

One may also create tables, charts, and trees.

6.1 Tables

In defining tables, one defines the rows and column elements, etc. Consider the following example:[12]

(45)
<table border="1">
<headerRow>
<headerCol>
<langData lang="lEng">Column1</langData>
</headerCol>
<headerCol>
<langData lang="lEng">Column2</langData>
</headerCol>
<headerCol>
<langData lang="lEng">Column3</langData>
</headerCol>
</headerRow>
<row>
<col>
<langData lang="lEng">Row1, Col1</langData>
</col>
<col>
<langData lang="lEng">Row1, Col2</langData>
</col>
<col>
<langData lang="lEng">Row1, Col3</langData>
</col>
</row>
<row>
<col>
<langData lang="lEng">Row2, Col1</langData>
</col>
<col>
<langData lang="lEng">Row2, Col2</langData>
</col>
<col>
<langData lang="lEng">Row2, Col3</langData>
</col>
</row>
<row>
<col colspan="3">This spans all three columns.</col>
</row>
<row>
<col rowspan="2">This spans two rows.</col>
<col>Row4, Col2</col>
<col>Row4, Col3</col>
</row>
<row>
<col>Row5, Col2</col>
<col>Row5, Col3</col>
</row>
</table>

This could come out as shown in (46).

(46)
Column1 Column2 Column3
Row1, Col1 Row1, Col2 Row1, Col3
Row2, Col1 Row2, Col2 Row2, Col3
This spans all three columns.
This spans two rows. Row4, Col2 Row4, Col3
Row5, Col2 Row5, Col3

Tables can also be numbered like examples. For example, if you key what is in (47), it could come out as in (48).

(47)
<example>
<table>
<caption>
<gloss lang="lEng">Orthographic vowel symbols in Carolinian</gloss>
</caption>
<row class="exampleTableHeaderRow">
<col>
<gloss lang="lEng"> </gloss>
</col>
<col class="CarolinianVowelChartCol">
<gloss lang="lEng">Front</gloss>
</col>
<col class="CarolinianVowelChartCol">
<gloss lang="lEng">Central</gloss>
</col>
<col class="CarolinianVowelChartCol">
<gloss lang="lEng">Back</gloss>
</col>
</row>
<row>
<col>
<gloss lang="lEng">High</gloss>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">i</langData>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">ú</langData>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">u</langData>
</col>
</row>
<row>
<col>
<gloss lang="lEng">Mid</gloss>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">e</langData>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">é</langData>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">o</langData>
</col>
</row>
<row>
<col>
<gloss lang="lEng">Low</gloss>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">á</langData>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">a</langData>
</col>
<col class="CarolinianVowelChartCol">
<langData lang="lCar">ó</langData>
</col>
</row>
</table>
</example>
(48)
(5)
Orthographic vowel symbols in Carolinian
Front Central Back
High i ú u
Mid e é o
Low á a ó

6.2 Charts

One can also create charts. These currently simply have whatever content you put in them. One such possiblity is to use a reference to an image file. See the input in (49) and the corresponding output in (50).[13]

(49)
<chart>
<img src="ParseC.gif"/>
</chart>
(50)

Charts can also be used as numbered example merely by enclosing them within an example element.

6.3 Trees

One can also create tree diagrams. You can type plain text to try and format the tree (by using a lot of non-breaking spaces, for example) or you can use some tool to produce a tree image file (e.g., LingTree). The following tree uses the latter.

Trees may be included as numbered examples. The input in (51) might produce what is in (52).

(51)
<tree>
<img src="rikaykaamaanaykipaq.png"/>
</tree>
(52)

A tree may also just be inserted by not enclosing it within an example element.

6.4 Floats (Numbered Tables and Figures)

Some publishers require one to put tables, charts and trees in special formatting items sometimes called “floats.” The idea is that where these items will appear in the published document will “float" depending on what is best as determined by the typesetter.[14] Personally, I am not a fan of floats. Whenever I am reading an article or book that has these, it is often the case that when a figure or table is referenced in the text, it is very hard to know where to look for the figure or table. Even though they are numbered, they typically do not appear very often so one does not know whether to look ahead or behind nor how far. It also is often the case that no list of figures or list or tables were provided, making it even more challenging to find the correct float.[15] Therefore, I am only reluctantly providing floats for XLingPaper. Please be nice to your readers and not use them unless absolutely necessary.

XLingPaper provides two kinds of floats: figures and numbered tables.

6.4.1 Figures

Figures consist of a required chart element and an optional caption element. XLingPaper will automatically number the figures in your document. (Figures are numbered independently of numbered tables.) For papers, each figure is numbered consecutively. For books (i.e., documents containing chapter elements), the numbering for figures starts over with each chapter and appendix. The chapter number and appendix letter are prepended to the figure number.

Whether the caption appears before or after the chart is determined by the figureLabelAndCaptionLocation attribute of the lingPaper element. The default is set to after.

Like other elements which can be referred to, figures have an id attribute. I suggest that you begin all figure id attributes with the letter "f."[5]

As an example, if you had the appropriate image file, then you could create a figure like what is in example (53).

(53)
<figure id="fLattice">
<chart>
<img src="resources/lattice.png"/>
</chart>
<caption>Pronominal reference inclusion</caption>
</figure>

If this is the first figure in the document, it will come out as in example (54).

(54)

Figure 1 Pronominal reference inclusion

The word "Figure" before the number is used by default. If you wish to use some other label, then you will need to change the figureLabel attribute of the lingPaper element.

One can also produce an automatically generated list of figures for one's XLingPaper document. One does this by inserting a listOfFiguresShownHere element within a preface or glossary element. The list of figures will include the figure label, figure number and any caption.[16]

The attributes of the figure element are summarized in the table in (55).

(55)
Attribute Possible Values Meaning
align left, center, right, or justify Horizontal alignment for the fgure.
cssSpecial (user control) This is a way to allow the user to add Cascading Style Sheet attributes which are not defined in other attributes of a figure element. CSS attributes only work for webpage output. Click here to see one webpage that defines these attributes. Note that each Cascading Style Sheet attribute needs to end with a semicolon (;) and should be followed by a space.
id (user control) The unique identifier for this figure to be used in this document. This identifer should contain only letters and digits; no spaces.
location here, bottomOfPage or topOfPage (the default is here) This is a hint to the program that produces PDF output about where you would like the figure to appear. The formatting program makes the final decision. The webpage output process ignores this attribute.
type (user control) A way to add special effects. See section 10.1.
XeLaTeXSpecial (user control) This is a way to allow the user to add special attributes for the included XeLaTeX processor that produces PDF. It is intended to be used only for attributes which are not defined in other attributes of a type element. XeLaTeX attributes only work for the “default” PDF output. Each one needs to be followed by a space.
xsl‑foSpecial (user control) This is a way to allow the user to add XSL-FO attributes which are not defined in other attributes of a figure element. XSL-FO attributes only work for the RenderX XEP way of producing PDF and Microsoft Word 2003 output. Each one needs to be followed by a space.

6.4.2 References to Figures

As noted in section 6.4.1, you should give each figure a unique identifier name (that begins with a lower case f). This is so you can refer to the figure elsewhere in the paper. When your document is processed, a hyperlink is made between the reference and the figure.

6.4.2.1 Controlling Text before a Reference to a Figure

One can also control what text precedes a figure reference, if one so chooses. Some people like to use a word such as “figure,” whereas others prefer to not have anything. One challenge with actually keying or not keying such words is that some publishers may want the author to do it one way or the other. In fact, some publications want authors to use capitalized "Figure" while others want authors to use lower case "figure".

In an effort to minimize an author's effort in dealing with this situation, XLingPaper provides you with the option of never keying such words, but rather to have them be inserted automatically when the paper (or book) is formatted. That is, if you so choose, you can never key words such as “figure” before a figureRef element. Which word or symbol will appear before them, if any, is controlled by setting various attributes of the figureRef element and the lingPaper element.[17] Please note that the default situation is for XLingPaper to not automatically insert these words; but if you wish, you can have XLingPaper insert them for you.

Example (56) lists the attributes of the lingPaper element that are relevant to this discussion. Note that the key attribute is figureRefDefault. The other four are there so you can change the default text to what you need. There are four cases for whether the text needs to be capitalized or not and for whether there is only one reference or several. The default is to use the English words “figure,” “figures,” “Figure,” and “Figures” as appropriate. The “label” attributes are there so if you are writing in a non-English language, you can use the appropriate terms for that language.

(56)
Attribute Possible Values Meaning
figureRefCapitalizedPluralLabel (user control) This is the text to use before a plural figureRef element when the inserted text needs to be capitalized. If it is empty and the figureRef element is tagged for using capitalizedPlural (or capitalizedPlural is the default), then the word “Figures” will be inserted before the figure reference in the output.
figureRefCapitalizedSingularLabel (user control) This is the text to use before a single figureRef element when the inserted text needs to be capitalized. If it is empty and the figureRef element is tagged for using capitalizedSingular (or capitalizedSingular is the default), then the word “Figure” will be inserted before the figure reference in the output.
figureRefDefault none, capitalizedPlural, capitalizedSingular, plural, or singular. This sets the default behavior for inserting text before a figureRef element. The normal value for this is none which means that no text will be inserted. If you set it to, say, singular, then whenever the textBefore attribute of the figureRef element is set to useDefault, the text for the “singular” label will be used. See figureRefSingularLabel.
figureRefPluralLabel (user control) This is the text to use before a plural figureRef element. If it is empty and the figureRef element is tagged for using plural (or plural is the default), then the word “figures” will be inserted before the figure reference in the output.
figureRefSingularLabel (user control) This is the text to use before a single figureRef element. If it is empty and the figureRef element is tagged for using singular (or singular is the default), then the word “figure” will be inserted before the figure reference in the output.

There is only one relevant attribute for the figureRef element. It is given in example (57).

(57)
Attribute Possible Values Meaning
textBefore none, capitalizedPlural, capitalizedSingular, plural, singular, or useDefault.
This indicates what text, if any, should be inserted in the output before the section reference. The normal value for this is useDefault which means that what text is inserted depends on the value of the figureRefDefault attribute of the lingPaper element. See figureRefDefault. All of the other values override this default. Each one is listed below.
none No text will be inserted. This is useful for when you have a list of figure references and you do not want to insert any text before the second, third, etc., references.
capitalizedPlural The word “Figures” will be inserted before the figure reference unless you have keyed text in the figureRefCapitalizedPluralLabel attribute of the lingPaper element. In this case that text will be used instead of “Figures” (see figureRefCapitalizedPluralLabel). This is useful for when you have a list of figure references and the first one begins a sentence. Mark the first figureRef with capitalizedPlural and then mark all the other figureRef elements in the list with none.
capitalizedSingular The word “Figure” will be inserted before the figure reference unless you have keyed text in the figureRefCapitalizedSingularLabel attribute of the lingPaper element. In this case that text will be used instead of “Figure” (see figureRefCapitalizedSingularLabel). This is useful for when you have a figure reference that begins a sentence.
plural The word “figures” will be inserted before the figure reference unless you have keyed text in the figureRefPluralLabel attribute of the lingPaper element. In this case that text will be used instead of “figures” (see figureRefPluralLabel). This is useful for when you have a list of figure references and the first one is in the middle of a sentence. Mark the first figureRef with plural and then mark all the other figureRef elements in the list with none.
singular The word “figure” will be inserted before the figure reference unless you have keyed text in the figureRefSingularLabel attribute of the lingPaper element. In this case that text will be used instead of “figure” (see figureRefSingularLabel). If you have set the figureRefDefault attribute of the lingPaper element to singular, then you should not need to ever set this value. This is normally only useful for when you have set the figureRefDefault attribute to something other than singular.

6.4.3 Numbered Tables

Numbered tables consist of a required tablenumbered element[18] and a required table element. XLingPaper will automatically number the tables in your document. (These tables are numbered independently of figures.) For papers, each numbered table is numbered consecutively. For books (i.e., documents containing chapter elements), the numbering for numbered tables starts over with each chapter and appendix. The chapter number and appendix letter are prepended to the table number.

Like other elements which can be referred to, numbered tables have an id attribute. I suggest that you begin all numbered table id attributes with the letters "nt."[5] The patches are for where you key your caption.

Whether the caption appears before or after the table is determined by the tablenumberedLabelAndCaptionLocation attribute of the lingPaper element. The default is set to before.

As an example, you could create a numbered table like what is in example (58).

(58)
<tablenumbered id="ntLatinDeclension">
<table border="1">
<caption>Some Latin declension classes</caption>
<tr>
<th>Declension</th>
<th>Citation Form</th>
<th>Gloss</th>
<th>Dative Plural</th>
</tr>
<tr>
<td>I</td>
<td>causa</td>
<td>reason</td>
<td>caus-is</td>
</tr>
<tr>
<td>II</td>
<td>annus</td>
<td>year</td>
<td>ann-is</td>
</tr>
<tr>
<td>III</td>
<td>civis</td>
<td>citizen</td>
<td>civ-ibus</td>
</tr>
<tr>
<td>IV</td>
<td>manus</td>
<td>hand</td>
<td>man-ibus</td>
</tr>
<tr>
<td>V</td>
<td>dies</td>
<td>day</td>
<td>di-ebus</td>
</tr>
</table>
</tablenumbered>

If this is the first numbered table in the document, it will come out as in example (59).

(59)

Table 1 Some Latin declension classes

Declension Citation Form Gloss Dative Plural
I causa reason caus-is
II annus year ann-is
III civis citizen civ-ibus
IV manus hand man-ibus
V dies day di-ebus

The word "Table" before the number is used by default. If you wish to use some other label, then you will need to change the tablenumberedLabel attribute of the lingPaper element.

One can also produce an automatically generated list of numbered tables for one's XLingPaper document. One does this by inserting a listOfTablesShownHere element within a preface or glossary element. The list of numbered tables will include the table label, table number and any caption.[19]

The attributes of the tablenumbered element are summarized in the table in (60).

(60)
Attribute Possible Values Meaning
cssSpecial (user control) This is a way to allow the user to add Cascading Style Sheet attributes which are not defined in other attributes of a tablenumbered element. CSS attributes only work for webpage output. Click here to see one webpage that defines these attributes. Note that each Cascading Style Sheet attribute needs to end with a semicolon (;) and should be followed by a space.
id (user control) The unique identifier for this numbered table to be used in this document. This identifer should contain only letters and digits; no spaces.
location here, bottomOfPage or topOfPage (the default is here) This is a hint to the program that produces PDF output about where you would like the numbered table to appear. The formatting program makes the final decision. The webpage output process ignores this attribute.
type (user control) A way to add special effects. See section 10.1.
XeLaTeXSpecial (user control) This is a way to allow the user to add special attributes for the included XeLaTeX processor that produces PDF. It is intended to be used only for attributes which are not defined in other attributes of a type element. XeLaTeX attributes only work for the “default” PDF output. Each one needs to be followed by a space.
xsl‑foSpecial (user control) This is a way to allow the user to add XSL-FO attributes which are not defined in other attributes of a tablenumbered element. XSL-FO attributes only work for the RenderX XEP way of producing PDF and Microsoft Word 2003 output. Each one needs to be followed by a space.

6.4.4 References to Numbered Tables

As noted in section 6.4.3, you should give each numbered table a unique identifier name (that begins with lower case nt). This is so you can refer to the numbered table elsewhere in the paper.

To make such a reference to a numbered table, you use the tablenumberedRef element.

6.4.4.1 Controlling Text before a Reference to a Numbered Table

One can also control what text precedes a numbered table reference, if one so chooses. Some people like to use a word such as “table,” whereas others prefer to not have anything. One challenge with actually keying or not keying such words is that some publishers may want the author to do it one way or the other. In fact, some publications want authors to use capitalized "Table" while others want authors to use lower case "table".

In an effort to minimize an author's effort in dealing with this situation, XLingPaper provides you with the option of never keying such words, but rather to have them be inserted automatically when the paper (or book) is formatted. That is, if you so choose, you can never key words such as “table” before a tablenumberedRef element. Which word or symbol will appear before them, if any, is controlled by setting various attributes of the tablenumberedRef element and the lingPaper element.[17] Please note that the default situation is for XLingPaper to not automatically insert these words; but if you wish, you can have XLingPaper insert them for you.

Example (61) lists the attributes of the lingPaper element that are relevant to this discussion. Note that the key attribute is tablenumberedRefDefault. The other four are there so you can change the default text to what you need. There are four cases for whether the text needs to be capitalized or not and for whether there is only one reference or several. The default is to use the English words “table,” “tables,” “Table,” and “Tables” as appropriate. The “label” attributes are there so if you are writing in a non-English language, you can use the appropriate terms for that language.

(61)
Attribute Possible Values Meaning
tablenumberedRefCapitalizedPluralLabel (user control) This is the text to use before a plural tablenumberedRef element when the inserted text needs to be capitalized. If it is empty and the tablenumberedRef element is tagged for using capitalizedPlural (or capitalizedPlural is the default), then the word “Tables” will be inserted before the numbered table reference in the output.
tablenumberedRefCapitalizedSingularLabel (user control) This is the text to use before a single tablenumberedRef element when the inserted text needs to be capitalized. If it is empty and the tablenumberedRef element is tagged for using capitalizedSingular (or capitalizedSingular is the default), then the word “Table” will be inserted before the numbered table reference in the output.
tablenumberedRefDefault none, capitalizedPlural, capitalizedSingular, plural, or singular. This sets the default behavior for inserting text before a tablenumberedRef element. The normal value for this is none which means that no text will be inserted. If you set it to, say, singular, then whenever the textBefore attribute of the tablenumberedRef element is set to useDefault, the text for the “singular” label will be used. See tablenumberedRefSingularLabel.
tablenumberedRefPluralLabel (user control) This is the text to use before a plural tablenumberedRef element. If it is empty and the tablenumberedRef element is tagged for using plural (or plural is the default), then the word “tables” will be inserted before the numbered table reference in the output.
tablenumberedRefSingularLabel (user control) This is the text to use before a single tablenumberedRef element. If it is empty and the tablenumberedRef element is tagged for using singular (or singular is the default), then the word “table” will be inserted before the numbered table reference in the output.

There is only one relevant attribute for the tablenumberedRef element. It is given in example (62).

(62)
Attribute Possible Values Meaning
textBefore none, capitalizedPlural, capitalizedSingular, plural, singular, or useDefault.
This indicates what text, if any, should be inserted in the output before the section reference. The normal value for this is useDefault which means that what text is inserted depends on the value of the tablenumberedRefDefault attribute of the lingPaper element. See tablenumberedRefDefault. All of the other values override this default. Each one is listed below.
none No text will be inserted. This is useful for when you have a list of numbered table references and you do not want to insert any text before the second, third, etc., references.
capitalizedPlural The word “Tables” will be inserted before the numbered table reference unless you have keyed text in the tablenumberedRefCapitalizedPluralLabel attribute of the lingPaper element. In this case that text will be used instead of “Tables” (see tablenumberedRefCapitalizedPluralLabel). This is useful for when you have a list of numbered table references and the first one begins a sentence. Mark the first tablenumberedRef with capitalizedPlural and then mark all the other tablenumberedRef elements in the list with none.
capitalizedSingular The word “Table” will be inserted before the numbered table reference unless you have keyed text in the tablenumberedRefCapitalizedSingularLabel attribute of the lingPaper element. In this case that text will be used instead of “Table” (see tablenumberedRefCapitalizedSingularLabel). This is useful for when you have a numbered table reference that begins a sentence.
plural The word “tables” will be inserted before the numbered table reference unless you have keyed text in the tablenumberedRefPluralLabel attribute of the lingPaper element. In this case that text will be used instead of “tables” (see tablenumberedRefPluralLabel). This is useful for when you have a list of numbered table references and the first one is in the middle of a sentence. Mark the first tablenumberedRef with plural and then mark all the other tablenumberedRef elements in the list with none.
singular The word “table” will be inserted before the numbered table reference unless you have keyed text in the tablenumberedRefSingularLabel attribute of the lingPaper element. In this case that text will be used instead of “table” (see tablenumberedRefSingularLabel). If you have set the tablenumberedRefDefault attribute of the lingPaper element to singular, then you should not need to ever set this value. This is normally only useful for when you have set the tablenumberedRefDefault attribute to something other than singular.

7 Lists

Lists come in three varieties:

Each one is explained and illustrated in the following sections.

7.1 Unordered or Bulleted Lists

Unordered or bulleted lists consist of items, each of which is tagged with a bullet. For example, if you type what is shown in (63), the corresponding output will be as in (64).

(63)
<ul>
<li>This is the fist item in the list.</li>
<li>Here is the second item.</li>
<li>This is the final item.</li>
</ul>
(64)
  • This is the first item in the list.
  • Here is the second item
  • This is the final item.

One can embed lists within lists. Normally, one uses the same kind of list for both the outside and inside lists, but one can mix the varieties. To embed a list, merely insert the embedded list within an li element.

7.2 Ordered or Numbered Lists

Ordered or numbered lists consist of items, each of which is tagged with a number or letter in sequence. For example, if you type what is shown in (65), the corresponding output will be as in (66).

(65)
<ol>
<li>This is the fist item in the list.</li>
<li>Here is the second item.</li>
<li>This is the final item.</li>
</ol>
(66)
  1. This is the first item in the list.
  2. Here is the second item
  3. This is the final item.

One can embed lists within lists. Normally, one uses the same kind of list for both the outside and inside lists, but one can mix the varieties. To embed a list, merely insert the embedded list within an li element.

7.3 Definition Lists

Definition lists are lists whose items have two parts: a term and its definition. Appendix A in this document has such a list in it.

For example, if you type what is shown in (67), the corresponding output will be as in (68).

(67)
<dl>
<dt>CP</dt>
<dd>Complementizer phrase</dd>
<dt>DP</dt>
<dd>Determiner phrase</dd>
<dt>NP</dt>
<dd>Noun phrase</dd>
</dl>
(68)
CP
Complementizer phrase
DP
Determiner phrase
NP
Noun phrase

8 Citations

Reference citations involve two aspects: the declaration of a label and citations to that label. As with example number names, the label is chosen by the user. A label can be any sequence of characters the user wishes to use (such as rChomsky81 or rLGB, for example). The id attribute of the refWork element declares the unique label. The citation element refers to the label and XLingPaper will insert the author name(s)[20] and date in an appropriate fashion.

8.1 Basic Examples

Consider the examples shown in (69) which come out as shown in (70).

(69)
<p>QZ has consonant clusters which violate the normal sonority sequencing patterns given as universals by <citation ref="rGreenberg78"/> and further discussed in <citation ref="rBellSaka83"/> and <citation ref="rSelkirk84"/>, among others.
QZ exhibits many reversed onset clusters consisting of a sonorant or glide followed by an obstruent (data are from
<citation ref="rRegnier89" paren="none"/>).</p>
<p>...</p>
</section1>
<backMatter>
<endnotes/>
<!--
REFERENCES
-->
<references>
<refAuthor citename="Bell & Saka" name="Bell, Alan and Mohamad M. Saka.">
<refWork id="rBellSaka83">
<refDate>1983</refDate>
<refTitle>Reversed sonority in Pashto initial clusters</refTitle>
<article>
<jTitle>Journal of Phonetics</jTitle>
<jVol>11</jVol>
<jPages>259-275</jPages>
</article>
</refWork>
</refAuthor>
<refAuthor name="Greenberg, J." citename="Greenberg">
<refWork id="rGreenberg78">
<refDate>1978</refDate>
<refTitle>Some generalizations concerning initial and final consonant clusters</refTitle>
<collection>
<collEd plural="no">J. Greenberg</collEd>
<collTitle>Universals of Human Language Vol. 2</collTitle>
<publisher>Stanford University Press</publisher>
</collection>
</refWork>
</refAuthor>
<refAuthor name="Regnier, Sue" citename="Regnier">
<refWork id="rRegnier89">
<refDate>1989</refDate>
<refTitle>Quiegolani Zapotec phonology</refTitle>
<ms>
<institution>Summer Institute of Linguistics, Mexico Branch</institution>
</ms>
</refWork>
</refAuthor>
<refAuthor name="Selkirk, E.O." citename="Selkirk">
<refWork id="rSelkirk84">
<refDate>1984</refDate>
<refTitle>On the major class features and syllable theory</refTitle>
<collection>
<collEd plural="yes">M. Aronoff and R. Oehrle</collEd>
<collTitle>Language Sound Structure</collTitle>
<location>Cambridge</location>
<publisher>MIT Press</publisher>
</collection>
</refWork>
</refAuthor>
</references>
(70)

QZ has consonant clusters which violate the normal sonority sequencing patterns given as universals by Greenberg (1978) and further discussed in Bell & Saka (1983) and Selkirk (1984), among others. QZ exhibits many reversed onset clusters consisting of a sonorant or glide followed by an obstruent (data are from Regnier 1989).

...


References

Bell, Alan and Mohamad M. Saka. 1983. "Reversed sonority in Pashto initial clusters." Journal of Phonetics 11:259-275.

Greenberg, J. 1978. "Some generalizations concerning initial and final consonant clusters." In J. Greenberg, ed. Universals of Human Language Vol. 2 Stanford University Press.

Regnier, Sue. 1989. "Quiegolani Zapotec phonology." Summer Institute of Linguistics, Mexico Branch ms.

Selkirk, E.O. 1984. "On the major class features and syllable theory." In M. Aronoff and R. Oehrle, eds. Language Sound Structure Cambridge: MIT Press.

8.2 Controlling the Date

Recall that XLingPaper only includes those reference entries which have a corresponding citation somewhere in the file(s). Suppose that there are two refWork elements for a particular refAuthor element, both of which are for the same year as in (71)

(71)
<refAuthor name="Clements, G.N." citename="Clements">
<refWork id="rClements85a">
<refDate>1985</refDate>
<refTitle>The Problem of Transfer in Nonlinear Phonology</refTitle>
<article>
<jTitle>Cornell Working Papers in Linguistics</jTitle>
<jVol>5</jVol>
<jPages>38-73</jPages>
</article>
</refWork>
<refWork id="rClements85b">
<refDate>1985</refDate>
<refTitle>The Geometry of Phonological Features</refTitle>
<article>
<jTitle>Phonology Yearbook</jTitle>
<jVol>2</jVol>
<jPages>223-250</jPages>
</article>
</refWork>
</refAuthor>

If only the second such entry is cited in the text (i.e., via a citation element), then the date should be produced as 1985, not as 1985b or even as 1985a. XLingPaper formats this correctly. It adjusts the value of the letter in the date for such entries to correspond to the appropriate value. If there were three dates (such as 1985a, 1985b, and 1985c) and only two were cited (such as 1985b and 1985c), then XLingPaper will output these as 1985a and 1985b, respectively.

The content of the refDate element can be any text, so one can also use strings such as in prep., to appear, or forthcoming as the date.

The placement of the parentheses around the date in the citation within the text can be controlled by the user. The default option is to enclose the date in parentheses. In (69)-(70) above, notice how citation ref="rRegnier89" paren="none"/ becomes Regnier 1989. The paren attribute with a value of none outputs the date without any parentheses. The table in (72) delineates the various options.

(72)
Attribute Value Meaning
paren both use both opening and closing parentheses around the date
none use neither opening nor closing parentheses around the date
initial use only an opening parenthesis before the date
final use only a closing parenthesis after the date

In addition, one can control whether or not the author name appears. The default action is for the name to appear. If you do not want the author name to appear, use the author attribute and give it a value of no. This is useful when listing several works by the same author(s). For example, the commands in (73) will give the results in (74).

(73)
<p>This Uto-Aztecan language, spoken in the state of Durango,
Mexico, has been described in <citation ref="rEWillett81" paren="initial"/>,
<citation ref="rEWillett82" author="no" paren="none"/>,
<citation ref="rEWillett85" author="no" paren="final"/>, and
<citation ref="rTWillett91"/>.</p>
...
<!--
REFERENCES
-->
<references>
<refAuthor citename="E.Willett" name="Willett, Elizabeth">
<refWork id="rEWillett81">
<refDate>1981</refDate>
<refTitle>Word Shortening in Southeastern Tepehuan</refTitle>
<thesis>
<location>Grand Forks, N.D.</location>
<institution>University of North Dakota</institution>
</thesis>
</refWork>
<refWork id="rEWillett82">
<refDate>1982</refDate>
<refTitle>Reduplication and Accent in
Southeastern Tepehuan</refTitle>
<article>
<jTitle>IJAL</jTitle>
<jVol>48</jVol>
<jPages>168-184</jPages>
</article>
</refWork>
<refWork id="rEWillett85">
<refDate>1985</refDate>
<refTitle>Palatalization in Southeastern Tepehuan</refTitle>
<article>
<jTitle>IJAL</jTitle>
<jVol>51</jVol>
<jPages>618-620</jPages>
</article>
</refWork>
</refAuthor><refAuthor name="Willett, Thomas Leslie" citename="T.Willett">
<refWork id="rTWillett91">
<refDate>1991</refDate>
<refTitle>A Reference Grammar of Southeastern Tepehuan</refTitle>
<book>
<series>Summer Institute of Linguistics and The University of Texas at Arlington Publications in Linguistics No. 100</series>
<location>Dallas, Texas</location>
<publisher>The Summer Institute of Linguistics and the University of Texas at Arlington</publisher>
</book>
</refWork>
</refAuthor>
</references>
(74)

This Uto-Aztecan language, spoken in the state of Durango, Mexico, has been described in E.Willett (1981, 1982, 1985), and T.Willett (1991).

...

References

Willett, Elizabeth. 1981. Word Shortening in Southeastern Tepehuan. Grand Forks, N.D.: University of North Dakota M.A. thesis.

Willett, Elizabeth. 1982. "Reduplication and Accent in Southeastern Tepehuan." IJAL 48:168-184.

Willett, Elizabeth. 1985. "Palatalization in Southeastern Tepehuan." IJAL 51:618-620.

Willett, Thomas Leslie. 1991. A Reference Grammar of Southeastern Tepehuan. Summer Institute of Linguistics and The University of Texas at Arlington Publications in Linguistics No. 100. Dallas, Texas: The Summer Institute of Linguistics and the University of Texas at Arlington.

8.3 Controlling Page Numbers

Sometimes a writer wishes to include a page number with the citation. XLingPaper provides a means for doing this. Suppose the references section for (75) below is the same as that in (69)-(70) above. Then the result of giving (75) to XLingPaper is shown in (76).

(75)
<p>As <citation ref="rGreenberg78" page="251"/> notes,
a voiced consonant may not appear outside of a voiceless obstruent within a single syllable.
(76)

As Greenberg (1978:251) notes, a voiced consonant may not appear outside of a voiceless obstruent within a single syllable.

The contents of the page attribute of the citation element is inserted after the date with an intervening colon. Any string of characters (not just digits) can be used as a page number.

8.4 Attribute Summary

The reference citation attributes are summarized in (77).

(77)
Attribute Value Meaning
ref (user determined) refers to the id attribute of the refWork element that corresponds to this citation
page (user determined) the page number(s) of the citation
author yes show the author name
no do not show the author name
paren both use both opening and closing parentheses around the date
none use neither opening nor closing parentheses around the date
initial use only an opening parenthesis before the date
final use only a closing parenthesis after the date

9 Interlinear Text

Some linguistic papers and books include one or more complete interlinear glossed texts, often in one or more appendices. XLingPaper allows you to include such texts. The form of the interlinear within the interlinear text may be the same as any of those described for interlinear examples (see section 5.3).

Occasionally, such interlinear text is preceded by the same text in paragraph form.[21] In such cases, use a prose-text element to key the text. Set the lang attribute of the prose-text element to the id attribute value of the language element the text is written in. The text will then be formatted in the output per the information contained in that language element.

9.1 Importing a text from SIL FieldWorks Language Explorer

One possible way to include an interlinear text is to use the SIL FieldWorks Language Explorer program to interlinearize a text and then export the text in XLingPaper format.[22] One can then merely copy and paste the resulting text into an XLingPaper document. See http://www.sil.org/computing/fieldworks/flex/ for more on the SIL FieldWorks Language Explorer program.

Note that if you use this option, then most of what is described in the next section has already been done for you.

9.2 Entering an interlinear text by hand

One can also key an entire interlinear text by hand.

For example, if you key what is in (78),[23] it will look like what is shown in (79).

(78)
<interlinear-text>
<textInfo>
<textTitle>Life in Quiegolani</textTitle>
<shortTitle>LifeInQ</shortTitle>
</textInfo>
<interlinear>
<lineGroup>
<line>
<langData lang="lVernacular">Tempran ra xee noo yrup noo xnaa noo.</langData>
</line>
<line>
<langData lang="lVernacular">tempran r-a xee noo y-chup noo xnaa noo</langData>
</line>
<line>
<gloss lang="lGloss">early H-go rise 1ex P-two 1ex mother 1ex</gloss>
</line>
</lineGroup>
<free>Early my mother and I would get up.</free>
</interlinear>
<interlinear text="TLIQ2">
<lineGroup>
<line>
<langData lang="lVernacular">Bi tap ra noo molin.</langData>
</line>
<line>
<langData lang="lVernacular">bi tap r-a noo molin</langData>
</line>
<line>
<gloss lang="lGloss">at four H-go 1ex mill</gloss>
</line>
</lineGroup>
<free>At four I would go to the grinder.</free>
</interlinear>
<interlinear>
<lineGroup>
<line>
<langData lang="lVernacular">Tsano noo nil molin.</langData>
</line>
<line>
<langData lang="lVernacular">ts-a-no noo nil molin</langData>
</line>
<line>
<gloss lang="lGloss">P-go-take 1ex nixtamal mill</gloss>
</line>
</lineGroup>
<free>I would take the nixtamal to the grinder.</free>
</interlinear>
</interlinear-text>
(79)
Life in Quiegolani
LifeInQ:1
Tempran ra xee noo yrup noo xnaa noo.
tempran r-a xee noo y-chup noo xnaa noo
early H-go rise 1ex P-two 1ex mother 1ex
Early my mother and I would get up.
LifeInQ:2
Bi tap ra noo molin.
bi tap r-a noo molin
at four H-go 1ex mill
At four I would go to the grinder.
LifeInQ:3
Tsano noo nil molin.
ts-a-no noo nil molin
P-go-take 1ex nixtamal mill
I would take the nixtamal to the grinder.

Notice how XLingPaper uses the shortened title and automatically assigns a line number.

If you will want to make reference to a portion, then you should give a unique text ID attribute[5] to the interlinear element in such a portion. In the example in (78), we did this for the second portion, using a text ID of TLIQ2. You can now make reference to this in an interlinear example. See section 5.3.4.1 for more on this.

10 Special Effects

XLingPaper allows for two types of special effects.

10.1 Text

Within a paragraph or other text, you may want to create some special effects (such as we do here for the word XLingPaper and for element and attribute names). Normally you will use an object element for these, although there is also the langData element. The latter is to be used for all language data in order to provide a consistent rendering for language data. It also tags all instances of such language data within the document. This is important for archiving purposes.

If you wish to produce some special effect for any non-language data item, follow these steps.

  1. Unless you already have one, create a types element as the last top-level element in the file (i.e., just before the closing /lingPaper element).[24]
  2. Define a type element within this types element. Give it a unique id attribute.[5] Set its attributes to perform the special effects you want.
  3. In your text, use an object element.
  4. Set its type attribute to the id value of the type element that defines the special effect.

The attributes of the type element are summarized in the table shown in (80).

(80)
Attribute Possible Values Meaning
after (user control) Text that is to appear after the element. This is what we do here for the XLingPaper object: we never have to type “XLingPap”. We just create an instance of an object whose type has the after attribute set to XLingPap.[25]
before (user control) This is the same as the after attribute, except the text appears before the object. Note that by using both the before and the after attributes, it is possible to surround the content of the object element with some text.
cssSpecial (user control) This is a way to allow the user to add Cascading Style Sheet attributes which are not defined in other attributes of a type element. CSS attributes only work for webpage output. Click here to see one webpage that defines these attributes.
font-family (user control) This is the font name to use (e.g., Times New Roman or Courier New).
font-size (user control) This is the font size. If it is expressed in points, it should have the value followed by pt.
font-style normal, italic, oblique, backslant, or inherit You can use this to set the font style. The most common usage will be to set it to italic.
font-variant normal, small-caps, or inherit You can use this to set the font variant. The most common usage will be to set it to small-caps.
font-weight normal, bold, bolder, lighter, 100, ... 900, or inherit You can use this to set the font weight. The most common usage will be to set it to bold.
types One or more references to other type elements. This is a way to define some basic special effects and then to combine them in another type..
xsl‑foSpecial (user control) This is a way to allow the user to add XSL-FO attributes which are not defined in other attributes of a type element. XSL-FO attributes only work for PDF and Microsoft Word 2003 output.

You can also add highlights or other effects to a language data item by embedding an object element within a langData element.

10.2 HyperText Links

It is also possible to create a special hyperlink by using the genericRef element within text. The genericRef element has one attribute: gref which should be the id attribute of some section, appendix, example, or endnote element. Type some text between the begin genericRef element and its endtag. The result will be a hyperlink on that text that will link to the appropriate section, appendix, example, or endnote.

One can also use the link element within text or other constructs to link to a media object (for example, a sound file). The link element has one attribute: href which should be the URI of the media object you wish to link to. Type some text or imbed an image (via the img element) between the begin link element and its endtag. The result will be a hyperlink on that text and/or image that will link to the media object.

Here are two examples of a link element:

  1. Click here to hear some Mandarin Chinese.
  2. Click on this icon to hear some Mandarin Chinese:

11 Publishing Information

When your document is ready for publication, sometimes one needs to include a blurb containing particulars about the publication and also sometimes one needs to include contact information for the authors. One includes this kind of information via the optional publishingInfo element. The publishingInfo element has two optional parts: the blurb and author contacts.

11.1 Publishing Blurb

The optional publishingBlurb element can be used to indicate the particulars of a publication, such as the particular issue of journal a paper is a part of, copyright notice, links to online versions of the paper, etc. The content of a publishingBlurb element is plain text and any of the embedded elements.[6] When you need multiple lines in the blurb, separate each part by a br element.

11.2 Author Contact Information

Some publications include more than merely an author's name and affiliation. They want to show the author's contact information, including things like full name (perhaps including degree initials, professor title, etc.), mail address, phone number, and/or a web site or other electronic contact information.

Like references, the authorContacts element can be used for multiple XLingPaper documents. It contains one or more authorContact elements. Each authorContact element can contain any combination of one or more of the elements given in (81). In addition, it has a required id attribute.[5]

(81)
Element Description
contactName The full name of the author. This may include Dr., PhD, Associate Professor, etc.
contactAffilation The full name of the affiliation.
contactAddress The full address whereby the author may be contacted. Use separate contactAddress elements for each line.
contactPhone The phone number where the author may be reached.
contactEmail The email address of the author.
contactElectronic Any non-email electronic contact such as a web page, Skype name, instant messaging handle, Facebook name, Twitter handle, etc.

All of the elements listed in (81) contain plain text plus any embedded elements,[6] except contactEmail (which uses just plain text).

The contactElectronic element also has a show attribute. When it is set to no, the content of the contactElectronic element will not be included in the output. When it is set to yes (which is the default), the content of the contactElectronic element will be included in the output.

12 Our Preferred Editor: the XMLmind XML Editor

The XMLmind XML Editor is a freely downloadable editor that makes it quite easy to create not only XLingPaper documents, but also XHTML documents, among others. This editor is a structured editor and has at least the following very nice features:

You can download the XMLmind XML Editor from this website: http://www.xmlmind.com/xmleditor/. As of March 19, 2010, you can download a version from http://www.xmlmind.com/xmleditor/download.shtml. Windows users should download the installer that comes with the bundled Java runtime. Note that SIL members can use the Personal Edition. Others should carefully read the licenses to determine which version is appropriate for them.

In order to use XLingPaper with the XMLmind XML Editor, one must have the XLingPaper configuation files. See http://www.sil.org/~blacka/xlingpap/index.htm to obtain these.

Since the XMLmind XML Editor is a structured editor, it is probably a bit different than other editors you have used. We recommend following the tutorial included with XMLmind XML Editor documentation as a way of becoming familiar with this tool. It is in the User's Guide or you may point your web browser to http://www.xmlmind.com/xmleditor/_distrib/doc/user/tutorial_basics.html. Once you have done the tutorial, then you can start creating an XLingPaper file. In XMLmind XML Editor, use File / New, find the XLingPaper section, and then select the kind of document you want to create. There are six types:

Choose the type you wish to create.

If you selected the Paper one, it will look something like this:

(82)

You can immediately start typing the content of the title element. Pressing the tab key or the right arrow key will move you on to the author element. You can click on the plus sign inside a box to open up what is inside the element. If you also install the “sample customize.xxe” add-on, then you can press the Esc key followed by the / key to open up an element. This same sequence of keys will close an element.

You are now on your way to creating your document.


A. XLingPaper Element Reference Guide

This appendix lists the various elements available with XLingPaper and briefly explains their usage. They are listed in alphabetical order.

abbrDefinition
The definition of an abbreviation
abbrInLang
Abbreviation information for a particular language; it has both an abbrTerm and an abbrDefinition
abbrRef
A reference to an abbreviation; used in glossing within an example
abbrTerm
The abbreviation itself (as you want it to appear)
abbreviation
The information for an abbreviation, possibly in more than one language
abbreviations
The set of abbreviations
abbreviationsShownHere
This indicates where the list of abbreviations are to appear
abstract
Paper abstract definition
acknowledgements
The acknowledgements section of a paper or book
affiliation
The affiliation of one of the authors of the paper
afterTerm
Text used after a “see” or “see also“ term in indexes
annotatedBibliographyType
A type of an annotated bibliography item
annotatedBibliographyTypes
A set of annotated bibliography types
annotation
An annotation for an annotated bibliography
annotationRef
A reference to an annotation in an annotated bibliography
annotations
A set of annotations
appendix
An appendix section of the paper
appendixLabelContentChoices
Used for controlling label of appendices in endnotes in a book when using endnotes instead of footnotes
appendixRef
A reference to an appendix in the paper
article
Reference information for an article in a journal
author
An author of the paper
authorContact
Contact information for an author
authorContacts
A list of author contact information
authorRole
The role of the author in the paper (e.g., editor, illustrator, etc.)
backMatter
The back matter section of the paper (it includes appendices, endnotes, and references)
beforeTerm
Text used before a “see” or “see also“ term in indexes
blockquote
A quotation that is to be set off as a block
book
Reference information for a book
bookTotalPages
Total page count for a book
bookversion
The version number of a book
br
Forces a line break in the text
bVol
The volume number of a book
caption
A caption on a table which precedes the table
chapter
A chapter section or portion of the paper
chapterBeforePart
A chapter section which occurs before a part
chapterInCollection
A chapter in a collection volume
chapterLabelContentChoices
Used for controlling label of chapters in endnotes in a book when using endnotes instead of footnotes
chart
A chart in the text; may also be included in an example
citation
A citation to a reference
citeName
A way to create custom formatting of a citation name for a reference.
col
A column entry within a table. Deprecated. Use td
collCitation
Reference information for citing a collection volume for a paper that is part of a collection volume
collEd
Reference information for an editor of a collection of papers volume
collEdInitials
Reference information for an editor of a collection of papers volume; using initials instead of author's first (etc.) name(s)
collEdSurnameGivenName
Reference information for an editor of a collection of papers volume, using the "surname, given name" form for all author names
collPages
Reference information for page numbers in a paper that is part of a collection volume
collTitle
Reference information for the title of a collection volume
collTitleLowerCase
Reference information for the title of a collection volume; lower case version
collVol
Reference information for the volume number of a collection volume
collection
Reference information for a paper included in a collection volume
comment
A way to add a comment in the text; it will not be shown in the HTML form of the paper
conference
Reference information for a conference (for a paper presented at a conference)
conflatedLine
An interlinear line which conflates two or more lines at some point in it (not fully implemented)
conflation
A conflation of two or more lines within an interlinear "line" (not fully implemented)
contactAddress
Contact address for an author
contactAffiliation
Contact affiliation for an author
contactElectronic
Contact electronic information for an author
contactEmail
Contact email for an author
contactName
Contact name for an author
contactPhone
Contact phone number for an author
contentControl
Way to control (exclude) content
contentControlChoice
An instance of a way to control content
contentControlChoices
A collection of contentControlChoice elements
contentControlType
A type for controlling content
contentControlTypes
A collection of contentControlType elements
contents
Includes a table of contents
counter
When placed in a td element, it counts the number of counter elements in this table; useful for automatically numbering table rows for class handouts, poster sessions, etc.
date
Date of the paper
dateAccessed
The date that a webpage was accessed.
dd
A definition list definition
definition
A definition of some key term. Used in either a paragraph or as an example.
dissertation
Reference information for a Ph.D. dissertation
dl
A definition list
doi
Reference information for a DOI (Digital Object Identifier)
dt
A definition list term
edition
The edition of the book or webpage
editor
The editor of a book that has authors and is not a collection
editorInitials
The editor of a book that has authors and is not a collection, using initials instead of author's first (etc.) name(s)
editorSurnameGivenName
The editor of a book that has authors and is not a collection, using the "surname, given name" form for all author names
emailAddress
The email address of an author
empty
Reference information for a manuscript where there is neither an institution nor a location
endCaption
A caption on a table which follows the table
endnote
An endnote definition
endnoteRef
A reference to an endnote
endnotes
Includes endnotes in the back matter of the paper
example
An example, which may be numbered or unnumbered
exampleHeading
A “heading” in an example; this is a way to label or tag what is being shown in an example; e.g., a language or a construction
exampleRef
A reference to an example
fieldNotes
Reference information for a linguist's field notes
figure
A numbered figure display
figureRef
A reference to a figure
framedType
Formatting information for framed units of this type
framedTypes
The set of framedType elements
framedUnit
A framed unit such as a sample output or an exercise which is typically framed by a line and offset from the normal text position and may have a special background color
free
A free translation field within an interlinear example
frontMatter
Defines the front matter of the paper
genericRef
A generic reference to a section, appendix, example, or endnote
genericTarget
A generic target which can be embedded almost anywhere and then linked to via a genericRef
genre
A genre (classification) for an interlinear text..
genres
A collection of genre elements for an interlinear text..
gloss
A gloss field in an interlinear example
glossary
A glossary section in the back matter
glossaryTermDefinition
The definition of a glossary term
glossaryTermInLang
glossary term information for a particular language; it has both a glossaryTermTerm and a glossaryTermDefinition
glossaryTermRef
A reference to a glossary term
glossaryTermTerm
The glossary term itself (as you want it to appear, by default)
glossaryTerm
The information for a glossary term, possibly in more than one language
glossaryTerms
The set of glossary terms
glossaryTermsShownHere
This indicates where the table of glossary terms is to appear
glossaryTermsShownHereAsDefinitionList
This indicates where the list of glossary terms is to appear as a series of hanging indent paragraphs
hangingIndent
A hanging indent paragraph
headerCol
A heading column within a table. Deprecated. Use th
headerRow
A heading row within a table. Deprecated. Use tr
img
A simple-minded HTML img element; it only includes the src attribute
index
An index in the back matter
indexedItem
A tag in the text flow which associates the text with an index term
indexedRangeBegin
A tag in the text flow which associates the text with an index term; it also marks the beginning position of a range for this topic in the index.
indexedRangeEnd
A tag in the text flow which marks the ending position of a range for this topic in the index.
indexTerm
A term to be included in an index in the back matter
indexTerms
A collection of index terms
institution
Reference information for the institution of a manuscript, dissertation or thesis
interlinear
An interlinear text example
interlinearRef
A reference to an interlinear within an interlinear text that is included in the document; the output copies the interlinear
interlinearRefCitation
A reference to an interlinear within an interlinear text that is included in the document; the output cites the interlinear by showing the short name of the text and the line number of the referred-to interlinear
interlinearSource
An indication of the source of an interlinear example; typically it consists of an abbreviated text name, a colon, and the line number of this interlinear example within that text.
interlinear-text
An interlinear text
iso639-3code
The ISO 639-3 code for a language included in a work in the references
iso6393-codeRef
A reference to an ISO 639-3 code (via the language element ID)
iso639-3codesShownHere
Show a list or table of the ISO 639-3 codes used in the document
item
An item within an interlinear per Hughes, Bird, and Bow (2003); the type attribute may have any of these values:
iword
A word within a phrase within an interlinear a la Hughes, Bird, and Bow (2003)
jArticleNumber
Reference information for the number of an article in an online journal
jIssueNumber
Reference information for the issue number of a journal
jPages
Reference information for the page numbers of an article in a journal
jTitle
Reference information for the title of a journal
jVol
Reference information for the volume number of a journal
keyTerm
A key term which is being defined within a definition element.
keyword
A keyword used to classify a reference work
keywords
A set of keywords
keywordsShownHere
This indicates where the list of keywords is to appear
labelContent
Content to use for an element's label given a content choice
labelContentChoices
Two or more content items (labelContent) controlled by content control
landscape
In the PDF output, format the enclosed material in landscape instead of portrait mode; will start a new page in the output
langData
Tags some text as belonging to a particular language
language
A language (to be used with langData or gloss)
languages
A collection of languages
li
A list item
lineGroup
A group or set of lines within an interlinear; the contents of the lines are aligned
line
A line in an interlinear example
lineSet
A conflated set of lines (not fully implemented)
lineSetRow
A row within a set of conflated lines (not fully implemented)
lingPaper
The main element of the paper
link
A link to a media file
listDefinition
A list of definitions in an example
listInterlinear
A list of interlinear examples
listOfFiguresShownHere
An indication of where to produce a list of the figures in the document
listOfTablesShownHere
An indication of where to produce a list of the numered tables in the document
listSingle
A list of single line examples
listWord
A list of word, gloss examples
literal
A literal translation field within an interlinear example
location
Reference information for the location of a publication
mediaObject
Used to embed a sound or movie file. Only works with the RenderX XEP way of producing PDF.
morph
A morph within an interlinear per Hughes, Bird, and Bow (2003)
morphemes
A collection of morpheme items in an interlinear per Hughes, Bird, and Bow (2003)
morphset
A set of of morph items in an interlinear a la Hughes, Bird, and Bow (2003)
ms
Reference information for a manuscript
msVersion
Version information for a manuscript
multivolumeWork
Reference information for a volume in a multivolume work
object
An user-defined "object"
ol
An ordered list
p
A paragraph
paper
Reference information for a paper presented at a conference
part
A part section which contains chapters
partLabelContentChoices
Used for controlling label of parts in endnotes in a book when using endnotes instead of footnotes
pc
A continuation paragraph (which never has an indented initial line)
phrase
A phrase within an interlinear text or example per Hughes, Bird, and Bow (2003)
phrases
A collection of phrase elements per Hughes, Bird, and Bow (2003)
presentedAt
A line in the front matter indicating that the paper had been presented at some conference
procEd
Reference information for the editor(s) of a proceedings volume
procEdInitials
Reference information for the editor(s) of a proceedings volume, using initials instead of author's first (etc.) name(s)
procEdSurnameGivenName
Reference information for the editor(s) of a proceedings volume, using the "surname, given name" form for all author names
procPages
Reference information for the pages of an article in a proceedings volume
procTitle
Reference information for the title of a proceedings volume
procTitleLowerCase
Reference information for the title of a proceedings volume; lower case version
procVol
Reference information for the volume number of a proceedings volume
proceedings
Reference information for a paper included within a conference proceedings volume
prose-text
Text which is in a language, but is prose, not interlinear
pubDate
Reference information for the publication date of a dissertation or thesis
published
Reference information for a published dissertation or thesis
publisher
Reference information for the publisher of a book, collection volume, Ph.D. dissertation, conference proceedings volume, or M.A. thesis
publishingBlurb
The publisher's blurb about a published document such as copyright, link to online version, etc.
publishingInfo
Information about a published document such as copyright, link to online version, etc.
q
An inline quote
refAuthor
Reference information for an author
refAuthorInitials
Reference information for an author, using initials instead of author's first (etc.) name(s)
refAuthorLastName
An author's last name
refAuthorName
An author's name
refAuthorSurnameGivenName
Reference information for an author, using the "surname, given name" form for all author names
refDate
Reference information for the date of a publication or manuscript
refTitle
Reference information for title of a publication or manuscript
refTitleLowerCase
Reference information for title of a publication or manuscript, lower case version
refWork
Reference information for a work by an author that is included in the references section
references
The references section of the back matter
reprintInfo
Reference information for reprint information of a publication
row
A row in a table. Deprecated. Use tr
section1
A level one section of the paper
section2
A level two section of the paper (i.e., a sub-section)
section3
A level three section of the paper
section4
A level four section of the paper
section5
A level five section of the paper
section6
A level six section of the paper
sectionRef
A reference to a section in the paper
seeAlsoTerm
A definition for a “see also“ term in indexes (language dependent)
seeDefinition
A definition for “see” or “see also“ terms in indexes (language dependent)
seeDefinitions
The set of definition for “see” or “see also“ terms in indexes (language dependent)
seeTerm
A definition for a “see“ term in indexes (language dependent)
selectedBibliography
A selected bibliography section of the back matter; used instead of references
series
Reference information for a book that is published within a series
seriesEd
Reference information for the editor(s) of a book that is published within a series
seriesEdInitials
Reference information for the editor(s) (using just the initials for editor first names) of a book that is published within a series
seriesEdSurnameGivenName
Reference information for the editor(s) (using the "surname, given name" form for all author names) of a book that is published within a series
secTitle
The title of a section within the paper
shortAuthor
A shortened form of an author. This is for aiding in publishing when the real author names are too long to appear in headers or footers
shortCaption
A shortened form of a caption in a figure or numbered table. This is for aiding in publishing when the real caption is deemed too long to appear in the list of figures or numbered tables
shortTitle
A shortened form of a title. This is for aiding in publishing when the real title is too long to appear in headings. Within an interlinear text, it is used as the abbreviated name of the text.
single
A single line example
source
The source information of an interlinear text (e.g., who gave the text, where, when, etc.)
styles
Embedded Cascading Style Sheet
table
A table
tablenumbered
A numbered table display
tablenumberedRef
A reference to a numbered table
td
A cell in a table. This is the same as col, but is included for use in the XMLmind XML Editor. See section 12.
term
A term in a particular language for an index in the back matter
textInfo
Information about an interlinear text.
textTitle
The title of an interlinear text.
th
A header cell in a table. This is the same as headerCol, but is included for use in the XMLmind XML Editor. See section 12.
thesis
Reference information for an M.A. thesis
title
The title of the paper
titleContent
Content to use for an element's title given a content choice
titleContentChoices
Two or more content items (titleContent) controlled by content control
tr
A row in a table. This is the same as headerRow or row, but is included for use in the XMLmind XML Editor. See section 12.
translatedBy
Reference information for a book that has been translated.
tree
A tree in the text; may also be included in an example
ul
An unordered list
url
The URL for a webpage
validation
Control the level of validation performed on the current document
version
The version number of the paper
volume
Indicates the beginning of a volume in a multi-volume book
webPage
A reference to a page on the Internet (aka web)
word
A word, gloss example
words
Words within a phrase within an interlinear per Hughes, Bird, and Bow (2003)
wrd
A single word item within a line of an interlinear example; use these when you need to highlight some word(s) within the line (via an object element)

B. XLingPaper Publisher Style Sheet Element Reference Guide

This appendix lists the various elements available for an XLingPaper publisher style sheet and briefly explains their usage. They are listed in alphabetical order.

abbreviationsInFootnoteLayout
Layout info for showing abbreviations used in a footnote
abbreviationsInTableLayout
Layout info for showing abbreviations used in a table
abbrRefLinkLayout
Layout info for special link formatting for abbrRef hyperlinks
abstractLayout
Layout info for an abstract
abstractTextFontInfo
Layout info for text within an abstract
acknowledgementsLayout
Layout info for acknowledgements
affiliationLayout
Layout info for affiliation
appendicesTitlePageLayout
Layout info for an appendices title page
appendixLayout
Layout info for an appendix
appendixRefLayout
Layout info for an appendix reference element
appendixRefLinkLayout
Layout info for special link formatting for appendixRef hyperlinks
appendixRefTitleLayout
Layout info for an appendix reference element that outputs the appendix title
appendixTitleLayout
Layout info for the title of an appendix
articleLayout
Layout info for an article within references
articleLayouts
Collection of layouts for articles within references
authorContactInfoLayout
Layout info for author contact information
authorLayout
Layout info for author
authorRoleItem
Layout info for an author role item within references
backMatterLayout
Collection of layouts relating to back matter
basicPointSize
The basic point size to use within the document
blockQuoteIndent
The indent to use on both the left and right sides of a block quote
blockQuoteLayout
Vertical space layout info for a blockquote element
bodyLayout
Collection of layouts relating to the body of the paper
bookLayout
Layout info for a book within references
bookLayouts
Collection of layouts for books within references
bookTotalPagesItem
Layout info for the total pages of a book (within references)
bookversionItem
Layout info for the version number of a book (within references)
bVolItem
Layout info for the volume number of a book (within references)
centerHeaderFooterItem
Layout info for an item that will appear in the center/middle of a header or footer
chapterInCollectionBackMatterLayout
Layout info for the back matter contained in a chapter in a collection volume
chapterInCollectionFrontMatterLayout
Layout info for the front matter contained in a chapter in a collection volume
chapterInCollectionLayout
Layout info for a chapter in a collection volume
chapterLayout
Layout info for a chapter
chapterNumber
Indicates to use the last chapter number in a header or footer
chapterTitle
Indicates to use the last chapter title in a header or footer
chapterTitleLayout
Layout info for a chapter
citationLayout
Layout info for a citation
citationLinkLayout
Layout info for special link formatting for citation hyperlinks
collCitationItem
Layout info for the citation to a collection volume (within references)
collEdItem
Layout info for a collection editor(s) element within references
collPagesItem
Layout info for the pages in a collection (within references)
collTitleItem
Layout info for a title of collection (within references)
collVolItem
Layout info for a collection volume (within references)
collectionLayout
Layout info for a collection within references
collectionLayouts
Collection of layouts for collections (within references)
conferenceItem
Layout info for a conference (within references)
contactAddressLayout
Layout info for a contact address
contactAffiliationLayout
Layout info for a contact affiliation
contactElectronicLayout
Layout info for a contact electronic information
contactEmailLayout
Layout info for a contact email
contactNameLayout
Layout info for a contact name
contactPhoneLayout
Layout info for a contact phone number
contentLayout
Collection of specialized layout info relating to certain items in the content of a document
contentsLayout
Layout info for a table of contents
contentsLinkLayout
Layout info for special link formatting for table of contents hyperlinks
copyrightPageLayout
(not implemented yet)
dateAccessedItem
Layout info for a date accessed element (within references)
dateLayout
Layout info for the date of the document
defaultFontFamily
The default font to use in the document
dissertationLabelItem
Layout info for a dissertation label (within references)
dissertationLayout
Layout info for a dissertation reference
dissertationLayouts
Collection of dissertation layouts (within references)
doiItem
Layout info for a doi element (within references)
doiLinkLayout
Layout info for special link formatting for doi hyperlinks
emailAddressLayout
Layout info for the email address of an author
editionItem
Layout info for edition information (within references)
editorItem
Layout info for editor information (within references)
endnoteRefLayout
Layout info for an endnote reference; in particular you can override the default text of “See footnote ”
endnoteRefLinkLayout
Layout info for special link formatting for endnoteRef hyperlinks
exampleLayout
Layout info for examples and references to examples within the document
exampleRefLinkLayout
Layout info for special link formatting for exampleRef hyperlinks
fieldNotesLayout
Layout info for a linguist's field notes (within references)
fieldNotesLayouts
Collection of linguist's field notes layouts (within references)
figureLayout
Layout info for a figure
figureCaptionLayout
Layout info for a figure caption
figureLabelLayout
Layout info for a figure label
figureNumberLayout
Layout info for a figure number
figureRefCaptionLayout
Layout info for a figure reference to a figure caption
figureRefLayout
Layout info for a figure reference
figureRefLinkLayout
Layout info for special link formatting for figureRef hyperlinks
footer
Layout info for a footer
footerMargin
Margin to use for the footer
footnoteIndent
The indent to use in the footnote text at the bottom of the page. This is the space from the left margin to the (superscript) footnote number
footnoteLine
Layout info for what comes between text and the first footnote on a page
footnotePointSize
Default point size to use within footnotes
freeLayout
Layout info for free elements
frontMatterLayout
Collection of layouts relating to front matter
genericRefLinkLayout
Layout info for special link formatting for genericRef hyperlinks
glossInExampleLayout
Layout info for gloss elements which are in example elements
glossInListWordLayout
Layout info for gloss elements which are in listWord or word elements
glossInProseLayout
Layout info for gloss elements which are in prose (i.e., non-example and non-table elements
glossInTableLayout
Layout info for gloss elements which are in table elements
glossLayout
Layout info for gloss elements
glossaryLayout
Layout info for a glossary
glossaryTermDefinitionInDefinitionListLayout
Layout info for showing a glossary term definition when using a definition list
glossaryTermTermInDefinitionListLayout
Layout info for showing a glossary term when using a definition list
glossaryTermRefLinkLayout
Layout info for special link formatting for glossaryTermRef hyperlinks
glossaryTermsInDefinitionListLayout
Layout info for showing glossary terms used in a series of hanging indent paragraphs
glossaryTermsInTableLayout
Layout info for showing glossary terms used in a table
hangingIndentInitialIndent
The indent to use for the first line of a hanging indent paragraph
hangingIndentNormalIndent
The indent to use for all non-initial lines of a hanging indent paragraph
header
Layout info for a header
headerFooterEvenPage
Layout info for a header or a footer on an even page within a document
headerFooterFirstPage
Layout info for a header or footer on the first page of a document
headerFooterOddEvenPages
Collection of layout info for headers or footers on odd and even pages within a document
headerFooterOddPage
Layout info for a header or footer on an odd page within a document
headerFooterPage
Layout info for a header or footer for all pages within a document (unless a headerFooterFirstPage element is present in which case it is the header or footer layout for all non-initial pages)
headerFooterPageStyles
Collection of header and footer layouts for the document
headerMargin
Margin to use for the header
imageBorderLayout
Layout for a border on an image
indexLayout
Layout info for an index
indexLinkLayout
Layout info for special link formatting for index hyperlinks
institutionItem
Layout info for an institution within references
interlinearMultipleLineGroupLayout
Layout info for indent for and spacing between non-initial interlinear line groups
interlinearRefLinkLayout
Layout info for special link formatting for interlinearRef hyperlinks
interlinearRefCitationTitleLayout
Layout info for special link formatting for interlinearRef hyperlinks when they refer to a title
interlinearSourceStyle
Where the source information for an interlinear example should appear
interlinearTextLayout
Formatting information for an interlinear text
iso639-3codeItem
Formattiing information for ISO 639-3 language codes (within references)
iso639-3codeItemRef
A reference place holder to the formattiing information for ISO 639-3 language codes (within references)
iso639-3codeRefLinkLayout
Layout info for special link formatting for iso639-3CodeRef hyperlinks
iso639-3CodesInTableLayout
Layout info for showing ISO 639-3 codes used in a table
jArticleNumberItem
Layout info for a journal article number within references
jIssueNumberItem
Layout info for a journal issue number (within references)
jPagesItem
Layout info for the pages of an article in a journal (within references)
jTitleItem
Layout info for the title of a journal (within references)
jVolItem
Layout info for a journal volume number (within references)
keywordLayout
Layout info for listing individual keywords of a document
keywordsLayout
Layout info for keywords of a document
langDataInExampleLayout
Layout info for langData elements which are in example elements
langDataInProseLayout
Layout info for langData elements which are in prose (i.e., non-example and non-table elements
langDataInTableLayout
Layout info for langData elements which are in table elements
langDataLayout
Layout info for langData elements
leftHeaderFooterItem
Layout info for a item that will appear at the left edge of a header or footer
lineSpacing
Line spacing layout (single, space and a half, or double)
linkLayout
Layout info for hyperlinks
linkLinkLayout
Layout info for special link formatting for link hyperlinks
listLayout
Layout info for lists
literalLayout
Layout info for literal elements
locationItem
Layout info for a location item within references
locationPublisherLayout
Layout info for a combination of location and publisher items (within references)
locationPublisherLayouts
Collection of layouts for location/publisher combinations (within references)
locationPublisherLayoutsRef
A reference place holder to the collection of location/publisher combinations (within references)
magnificationFactor
The factor by which all text is to be enlarged for the document. The default is 1.
missingItem
Used within locationPublisherLayout and/or urlDateAccessedLayout elements to indicate that the pattern does not contain any of the possible items within that layout (within references)
msLayout
Layout info for a manuscript (within references)
msLayouts
Collection of manuscript layouts (within references)
msVersionItem
Layout info for a version information of a manuscript (within references)
multivolumeWorkItem
Reference information for a volume in a multivolume work item within references
nothing
Indicates that the left/center/right cell of a header or footer should be blank
numberLayout
Layout info for a section, part, chapter or appendix number
pageBottomMargin
Margin to use at the bottom of the page
pageHeight
The height of a page
pageInsideMargin
Margin to use on the inside of a page (right-hand margin for even pages; left-hand margin for odd pages)
pageLayout
Collection of layouts relating to the page in general
pageNumber
Indicates that the page number is to show in a header or footer.
pageOutsideMargin
Margin to use on the outside of a page (left-hand margin for even pages; right-hand margin for odd pages)
pageTopMargin
Margin to use at the top of a page
pageWidth
Width of the page
paperAuthor
Indicates to use the author of the paper in the header or footer
paperLabelItem
Layout info for a paper label (within references)
paperLayout
Layout info for a paper within references
paperLayouts
Collection of paper layouts
paperPublishingBlurb
Indicates to use the content of the publishing blurb in a header or footer
paperTitle
Indicates to use the title of the paper in a header or footer
paragraphAlignment
Alignment to use for paragraphs
paragraphIndent
Indent to use at the beginning of a paragraph
paragraphLayout
Layout info for paragraphs
partLayout
Layout info for a part
partTitleLayout
Layout info for the title of a part
prefaceLayout
Layout info for a preface
presentedAtLayout
Layout info for the presentedAt element
procCitationItem
Layout info for the citation to a proceedings volume (within references)
procEdItem
Layout info for the editor(s) of a proceedings volume (within references)
procPagesItem
Layout info for the pages within a proceedings volume (within references)
procTitleItem
Layout info for a title of a proceedings volume (within references)
procVolItem
Layout info for a volume number of a proceedings volume (within references)
proceedingsLayout
Layout info for a proceedings item (within references)
proceedingsLayouts
Collection of proceedings layouts
prose-textTextLayout
Layout info for a prose-text element
pubDateItem
Layout info for the date of when a thesis or dissertation was published (within references)
publishedLayout
Layout info for a published thesis or dissertation (within references)
publishedLayoutRef
A reference place holder to the published layout info (within references)
publisherItem
Layout info for a publisher (within references)
publisherStyleSheet
The element containing the style sheet information
publisherStyleSheetDate
A date for the style sheet
publisherStyleSheetDateAccessed
The date when the url was accessed (see publisherStyleSheetUrl below)
publisherStyleSheetName
A name for the publisher style sheet
publisherStyleSheetReferencesName
A name for the layout info for reference items
publisherStyleSheetReferencesVersion
A version number for the layout info for reference items
publisherStyleSheetPublisher
The name of the publisher for which this is a style sheet
publisherStyleSheetUrl
A URL indicating where the style sheet information came from
publisherStyleSheetVersion
A version number for the style sheet
publishingBlurbLayout
Layout info for the publishing blurb
quoteLayout
Layout info for a q (quote) element
refAuthorItem
Layout info for an author within references
refAuthorLastNameLayout
Layout info for an author's last name within references
refAuthorLayout
Layout info for author-related info (including date) within references
refAuthorLayouts
Collection of author layouts
refAuthorNameChange
Change needed for author name and citation name
refDateItem
Layout info for a date (within references)
referencedInterlinearText
A reference to an interlinear text which is in a different XLingPaper document
referencedInterlinearTexts
A set of references to interlinear in a different XLingPaper document
refTitleItem
Layout info for a title within references
referencesLayout
Collection of reference-related layout information
referencesTitleLayout
Layout info for the title of a references section in the document
reprintInfoItem
Layout info for reprint information within references
rightHeaderFooterItem
Layout info for a item that will appear at the right edge of a header or footer
section1Layout
Layout info for a section1 element
section2Layout
Layout info for a section2 element
section3Layout
Layout info for a section3 element
section4Layout
Layout info for a section4 element
section5Layout
Layout info for a section5 element
section6Layout
Layout info for a section6 element
sectionNumber
Indicates to use the last section number in a header or footer
sectionRefLayout
Layout info for a section reference element
sectionRefLinkLayout
Layout info for special link formatting for sectionRef hyperlinks
sectionRefTitleLayout
Layout info for a section reference element that outputs the section title
sectionTitle
Indicates to use the section title in a header or footer
sectionTitleLayout
Layout info for a section title
seriesEdItem
Layout info for a series editor item (within references)
seriesItem
Layout info for a series item (within references)
shortSubsectionLayout
Layout info for a short subsection
subtitleLayout
Layout info for a subtitle
tablenumberedLayout
Layout info for a numbered table (tablenumbered element)
tablenumberedCaptionLayout
Layout info for a numbered table caption
tablenumberedLabelLayout
Layout info for a numbered table label
tablenumberedNumberLayout
Layout info for a numbered table number
tablenumberedRefCaptionLayout
Layout info for a numbered table reference to a numbered table caption
tablenumberedRefLayout
Layout info for a numbered table reference
tablenumberedRefLinkLayout
Layout info for special link formatting for tablenumberedRef hyperlinks
thesisLabelItem
Layout info for a thesis label (within references)
thesisLayout
Layout info for a thesis within references
thesisLayouts
Collection of thesis layouts
titleHeaderFooterPageStyles
Collection of header and footer layouts for the title pages of a book
titleLayout
Layout info for a title
translatedByItem
Layout info for a “translated by” element (within references)
urlDateAccessedLayout
Layout info for a combination of url and date accessed items (within references)
urlDateAccessedLayouts
Collection of layouts for url/date accessed combinations (within references)
urlDateAccessedLayoutsRef
A reference place holder to the collection of url/date accessed combinations (within references)
urlItem
Layout info for a url element (within references)
urlLinkLayout
Layout info for special link formatting for url hyperlinks
useEndNotesLayout
Used to force endnotes and to give the layout info for endnotes
useThesisSubmissionStyle
Has an attribute to control whether to use single-sided output or the default of double-sided output
versionLayout
Layout info for a version element
volumeAuthorRef
Indicates to use the author(s) of the volume in a header or footer
volumeLayout
Layout info for a volume element in the table of contents
volumeTitleRef
Indicates to use the title of the volume in a header or footer
webPageLayout
Layout info for a web page with references
webPageLayouts
Collection of web page layouts

Endnotes

[1]

Note that this assumes that the XLingpap.dtd and XLingPap1.xsl files are both in the same directory as this file. If they are located somewhere else, you will need to enter the path to where they are. For example, if these files are located in the "C:\Program Files\SIL\XLingPap" directory, then the first two lines should read as shown below.

<!DOCTYPE lingPaper SYSTEM "C:\Program Files\SIL\XLingPap\XLingPap.dtd">
<?xml-stylesheet type="text/xsl" href="C:\Program Files\SIL\XLingPap\XLingPap1.xsl"?>

If you are using the XMLmind XML Editor, then you do not need to be concerned about these details. It will take care of them for you.

[2]

Technically, any sequence of “embedded” elements may occur in a section title. See [6].

[3]

The "chunk" elements are: p, pc, example, table, chart, tree, blockquote, ol, ul, and dl.

[4]

Technically, any sequence of “embedded” elements may occur in a section title. See [6].

[5]

I suggest that you use a unique prefix letter for each kind of id. That way, when you are keying a reference to that kind of element using a tool that shows all of the id values in a list, you can more easily find the possible list of ids (they will all be together since they all begin with the same letter). Here are some suggested initial letters you can use:

Letter Element
a appendix
b indexBeginRange
c chapter
f figure
g genericTarget
i indexTerm
l language
n endnote
nt tablenumbered
p part
r refWork
s section[1,2,3,4,5,6]
t type
T interlinear
v abbreviation
x example
z authorContact
[6]

The "embedded" elements are: langData, gloss, exampleRef, sectionRef, appendixRef, citation, comment, object, br, endnote, endnoteRef, q, img, genericRef, and link.

[7]

Note that if any term element in a master set has an embedded object element, then the containing document will need to have the appropriate type element referred to by the embedded object element. Similarly, if there is an embedded langData or gloss element, then the appropriate language element will need to be included in the containing document.

[8]

This is a modified form of the interlinear described by Hughes, Bird, and Bow (2003). The modifications are the use of iword instead of word to avoid a conflict with XLingPap's word element and the addition of the morphset element to allow it show up nicely in the XMLmind XML Editor.

[9]

Although, it might be possible to make it work in Microsoft Word 2003 with some appropriate macros and other work.

[10]

It should be there already if you used the SIL FieldWorks Language Explorer program to export the interlinear text.

[11]

If you want to know how to manually change the setting, please contact xlingpaper_support@sil.org.

[12]

Beginning with version 1.9.0, one may use tr, th, and td instead of row, headerCol, and col. One may also use tr instead of headerRow. This is to allow one to use the XMLmind XML Editor and its very nice built-in table editing capabilities. For more information on the XMLmind XML Editor, see section 12.

[13]

Image files can be produced using tools such as Paint and Visio, among others. Use formats such as JPEG File Interchange Format (*.jpg or *.jpeg files), Graphics Interchange Format (*.gif files) or Portable Network Graphics (*.png files).

[14]

My assumption is that the goal is to save paper so they want the float to appear wherever it least affects the total number of pages of the document.

[15]

At least with hyper-linked documents, one can follow the reference link to the figure or table. But once it is printed on paper, that advantage goes away.

[16]

It is possible to include a shortened caption in the list if you wish. It comes immediately after the caption element within the figure element. The list will use the shortened caption, but the figure itself will use the full caption content.

[17]

An XLingPaper stylesheet for a particular publisher can be set to override any of these settings with the lower case or capitalized form. So if you find that a publisher requires one or the other, you will only need to use a stylesheet for their requirements.

[18]

We use tablenumbered instead of numberedtable so that when you are looking to insert a table, you will see it. Most of us will not naturally look under "n" for a table.

[19]

It is possible to include a shortened caption in the list if you wish. Insert a shortCaption element after the caption element within the table element. The list will use the shortened caption, but the numbered table itself will use the full caption content.

[20]

As declared in the citename attribute of the refAuthor element.

[21]

For example, some practical grammars are targeted at both native speakers of the language as well as linguists. The native speaker would prefer to read the text as prose rather than as interlinear.

[22]

The ability to export an interlinear text as a text (and not only as a series of examples) should be available in the October 2007 version. If you need it sooner, please contact xlingpaper_support@sil.org.

[23]

This is taken from Regnier (1989).

[24]

Note that if you also define index terms, then this types element comes just before any indexTerms elements.

[25]

This then acts rather like an XML character entity. Some XML editors (like the XMLmind XML Editor) replace XML character entities with the content of the entity.


References

Hughes, Baden, Steven Bird and Catherine Bow. 2003. Encoding and Presenting Interlinear Text Using XML Technologies. In Knott, Alistair and Dominique Estival, eds. Proceedings Australasian Language Technology Workshop, 105-113. Melbourne, Australia: University of Melbourne.

Regnier, Randy. 1989. Collection of unpublished Quiegolani Zapotec glossed texts. Summer Institute of Linguistics, Mexico Branch Manuscript.