Skip to content

Commit

Permalink
Merge pull request #7 from TEIC/ebb-fix
Browse files Browse the repository at this point in the history
Ebb fix: updates Customization page and fixes bad links
  • Loading branch information
ebeshero authored Sep 8, 2024
2 parents f7feef5 + 558f637 commit b4aed7c
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 32 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
dist
node_modules
.idea/
1 change: 1 addition & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{
"name": "website-11ty",
"version": "1.0.0",
"description": "",
"description": "This repository contains the sources for the TEI website and the configuration to run it locally if you need to. If you are editing the website's content, you will only need to be focused on the contents of the `src/` directory, which is laid out something like this:",
"main": "index.js",
"scripts": {
"dev": "npx @11ty/eleventy --serve",
"build": "npx @11ty/eleventy",
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
Expand Down
17 changes: 9 additions & 8 deletions src/about/mission.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tags: page
TEI pursues a number of important goals and activities:

Development of the TEI Guidelines
* + The TEI Guidelines by their nature require ongoing development and research. Because
* The TEI Guidelines by their nature require ongoing development and research. Because
they seek to describe a textual domain that is still being explored, and because they
seek to support discipline-specific analysis and research approaches that are steadily
evolving, they must adapt in order to remain vital and useful. The TEI sponsors working
Expand All @@ -28,33 +28,34 @@ tags: page


Dissemination of the TEI Guidelines
* + The TEI Guidelines are the most significant output of the TEI Consortium's work, and
* The TEI Guidelines are the most significant output of the TEI Consortium's work, and
the TEI is committed to disseminating them widely. They are published online at the
TEI web site as HTML, PDF, and XML source. The Guidelines are published in English,
but their central components are translated into a number of languages including French,
Spanish, German, Chinese, and Japanese.


Training and outreach
* + As part of its effort to increase and support broad usage of the TEI Guidelines, the
* As part of its effort to increase and support broad usage of the TEI Guidelines, the
consortium supports a variety of training and outreach efforts, and with the completion
of P5 these will become even more central to the TEI's work. Training programs are
held at intervals by various groups within the TEI community, and specific projects
also make their internal training and documentation available to the public. The TEI
maintains a selected list of [materials for learning the TEI](../Support/Learn/), including tutorials, project documentation, and training events. In addition, the
maintains a selected list of [materials for learning the TEI](../../Support/Learn/), including tutorials, project documentation, and training events. In addition, the
TEI encourages user communities and projects to develop documentation and TEI schemas
that are specific to particular disciplinary or thematic areas. These may be disseminated
by the TEI through its [customizations](../Guidelines/Customization/) page and through the [TEI wiki](/wiki/index.php/Category:Customization).
by the TEI through its [customizations](../../Guidelines/Customization/) page and through the [TEI wiki](https://wiki.tei-c.org/).


Cultivation of a TEI research community
* The thriving research community surrounding the TEI is one of its greatest assets
and also the reason for its ongoing vitality. This community is loosely bound together
through a variety of forums, virtual and actual. Of these the oldest and most inclusive
is the TEI-L discussion list, which serves as a clearing house for TEI questions,
is [the TEI-L discussion list](../../Support/) which serves as a clearing house for TEI questions,
debates, opinion, and information of all kinds. It includes TEI users at all levels
of expertise and its archive (at [http://listserv.brown.edu/archives/tei-l.html](https://listserv.brown.edu/archives/tei-l.html)) contains a record of discussion on text encoding and TEI usage going back nearly
two decades. The TEI also sponsors an annual members meeting and conference that is
of expertise and [its archive](https://lists.psu.edu/cgi-bin/wa?A0=TEI-L)
contains a record of discussion on text encoding and TEI usage going back to January 1990.
* The TEI also sponsors an annual members meeting and conference that is
attended by participants from around the world, representing TEI projects of every
type. The program includes papers on theoretical and practical topics, reports on
work in progress, posters, meetings of the TEI special interest groups, and updates
Expand Down
4 changes: 2 additions & 2 deletions src/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The Guidelines are designed to be customized, and specific projects and discipli
We collect here well-documented TEI customizations, such as the popular [TEI Lite](Customization/Lite/), that may be of use as models or for projects wishing to follow their practice. We
also provide information on creating TEI customizations.

[Internationalization](./tools/I18N/)
[Internationalization](../Tools/index.html#I18N)
The Guidelines are currently being translated into languages other than English; we
provide here details of this process and information on how to get internationalized
versions of the Guidelines.
Expand All @@ -53,7 +53,7 @@ The TEI maintains a GitHub repository where it manages the development and distr
development; it also contains archived materials from earlier versions of the TEI
web site.

[Getting Involved](https://tei-c.org/guidelines/getting-involved/)
[Getting Involved](../Support/)

The TEI welcomes participation in the development of the Guidelines; we detail here
the various ways in which the TEI community (members and non-members) can contribute.
Expand Down
33 changes: 21 additions & 12 deletions src/guidelines/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,31 @@ Because the TEI Guidelines must cover such a broad domain and user community, it
The TEI provides a number of basic, general-purpose customizations. One of the best-known of these is [TEI Lite](Lite/), which was originally designed as a demonstration of the customization mechanism, but has become popular as a simple TEI schema for basic encoding. Other basic customizations are listed below. To create your own customization, you can do one of the following:

* Use the [Roma](https://roma.tei-c.org) web tool to select TEI modules, add and delete elements, and make other choices; see [Creating TEI Customizations with Roma](https://tei-c.org/guidelines/customization/customizing-the-tei-with-roma/) for more detailed information on using Roma.
* Write your own customization by hand using the TEI ODD language; see [Getting Started with P5 ODDs](https://tei-c.org/guidelines/customization/getting-started-with-p5-odds/) and [Using the TEI (Chapter 23 of the Guidelines)](/release/doc/tei-p5-doc/en/html/USE.html) for more detailed information on how to do this.
* Write and maintain your own customization by hand using the TEI ODD language. For tutorials and guidance on how to do this, see
* [TEI Customization Primer](https://www.wwp.neu.edu/outreach/resources/customization.html) by Syd Bauman and Julia Flanders, Women Writers Project
* [Module 8: Customising the TEI, ODD, Roma](https://teibyexample.org/exist/tutorials/TBED08v00.htm) in TEI by Example.
* Lou Burnard's resources:
* [How to make an ODD automagically](https://teic.github.io/PDF/howtoGenerate.pdf)
* [How to Update your ODD](https://teic.github.io/PDF/purifyDoc.pdf) (especially for older ODDs produced before version 3.0 of the TEI Guidelines)
* [ODD chaining for Beginners](https://teic.github.io/PDF/howtoChain.pdf)
* [“Customizing the TEI”](https://books.openedition.org/oep/692) in <i>What Is the Text Encoding Initiative?</i>, OpenEdition Press, 2014,
* [Using the TEI (Chapter 23 of the Guidelines)](/release/doc/tei-p5-doc/en/html/USE.html)


## Customizations provided by the TEI Consortium

| Customization | Description | Formats |
| --- | --- | --- |
| [Lite](Lite/) | TEI Lite, the most widely used TEI customization; includes basic elements for simple documents | [ODD](../../release/xml/tei/custom/odd/tei_lite.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_lite.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_lite.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_lite.xsd), [HTML](../../release/doc/tei-p5-exemplars/html/tei_lite.doc.html), [PDF](../../release/doc/tei-p5-exemplars/pdf/tei_lite.doc.pdf) |
| TEI Tite | A constrained customization designed for use by keyboarding vendors | [ODD](../../release/xml/tei/custom/odd/tei_tite.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_tite.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_tite.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_tite.xsd), [HTML](../../release/doc/tei-p5-exemplars/html/tei_tite.doc.html), [PDF](../../release/doc/tei-p5-exemplars/pdf/tei_tite.doc.pdf) |
| Customization | Description | Formats |
|-------------------------------------------------------------------------------------| --- | --- |
| [Lite](../../release/doc/tei-p5-exemplars/html/tei_lite.doc.html) | TEI Lite, the most widely used TEI customization; includes basic elements for simple documents | [ODD](../../release/xml/tei/custom/odd/tei_lite.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_lite.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_lite.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_lite.xsd), [HTML](../../release/doc/tei-p5-exemplars/html/tei_lite.doc.html), [PDF](../../release/doc/tei-p5-exemplars/pdf/tei_lite.doc.pdf) |
| [TEI Tite](../../release/doc/tei-p5-exemplars/html/tei_tite.doc.html) | A constrained customization designed for use by keyboarding vendors | [ODD](../../release/xml/tei/custom/odd/tei_tite.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_tite.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_tite.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_tite.xsd), [HTML](../../release/doc/tei-p5-exemplars/html/tei_tite.doc.html), [PDF](../../release/doc/tei-p5-exemplars/pdf/tei_tite.doc.pdf) |
| [TEI simplePrint](../../release/doc/tei-p5-exemplars/html/tei_simplePrint.doc.html) | An entry-level customization, focused primarily on the needs of those encoding Western European early modern printed material | [ODD](../../release/xml/tei/custom/odd/tei_simplePrint.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_simplePrint.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_simplePrint.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_simplePrint.xsd), [HTML](../../release/doc/tei-p5-exemplars/html/tei_simplePrint.doc.html), [PDF](../../release/doc/tei-p5-exemplars/pdf/tei_simplePrint.doc.pdf) |
| [jTEI Article](jTEI/) | A highly-constrained customization intended for creating journal articles, in particular for submission to the Journal of the Text Encoding Initiative | [ODD](../../release/xml/tei/custom/odd/tei_jtei.odd) | | [RNG](../../release/xml/tei/custom/schema/relaxng/tei_jtei.rng) | [XSD](../../release/xml/tei/custom/schema/xsd/tei_jtei.xsd) | [HTML](../../release/doc/tei-p5-exemplars/html/tei_jtei.doc.html) | [PDF](../../release/doc/tei-p5-exemplars/pdf/tei_jtei.doc.pdf) |
| Bare | TEI Absolutely Bare, a very barebones schema with the absolute minimum of elements | [ODD](../../release/xml/tei/custom/odd/tei_bare.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_bare.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_bare.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_bare.xsd) |
| All | TEI with all modules included | [ODD](../../release/xml/tei/custom/odd/tei_all.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_all.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_all.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_all.xsd) |
| Corpus | TEI for Linguistic Corpora, includes the modules for encoding linguistic corpora, [ODD](../../release/xml/tei/custom/odd/tei_corpus.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_corpus.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_corpus.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_corpus.xsd) |
| MS | TEI for Manuscript Description, includes the elements for describing manuscripts and complex physical aspects of documents | [ODD](../../release/xml/tei/custom/odd/tei_ms.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_ms.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_ms.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_ms.xsd) |
| Drama | TEI with Drama, includes the TEI drama module | [ODD](../../release/xml/tei/custom/odd/tei_drama.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_drama.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_drama.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_drama.xsd) |
| Speech | TEI for Speech Representation, includes the TEI module for spoken language | [ODD](../../release/xml/tei/custom/odd/tei_speech.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_speech.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_speech.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_speech.xsd) |
| [jTEI Article](../../release/doc/tei-p5-exemplars/html/tei_jtei.doc.html) | A highly-constrained customization intended for creating journal articles, in particular for submission to the Journal of the Text Encoding Initiative | [ODD](../../release/xml/tei/custom/odd/tei_jtei.odd) | | [RNG](../../release/xml/tei/custom/schema/relaxng/tei_jtei.rng) | [XSD](../../release/xml/tei/custom/schema/xsd/tei_jtei.xsd) | [HTML](../../release/doc/tei-p5-exemplars/html/tei_jtei.doc.html) | [PDF](../../release/doc/tei-p5-exemplars/pdf/tei_jtei.doc.pdf) |
| Bare | TEI Absolutely Bare, a very barebones schema with the absolute minimum of elements | [ODD](../../release/xml/tei/custom/odd/tei_bare.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_bare.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_bare.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_bare.xsd) |
| All | TEI with all modules included | [ODD](../../release/xml/tei/custom/odd/tei_all.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_all.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_all.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_all.xsd) |
| Corpus | TEI for Linguistic Corpora, includes the modules for encoding linguistic corpora, [ODD](../../release/xml/tei/custom/odd/tei_corpus.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_corpus.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_corpus.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_corpus.xsd) |
| MS | TEI for Manuscript Description, includes the elements for describing manuscripts and complex physical aspects of documents | [ODD](../../release/xml/tei/custom/odd/tei_ms.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_ms.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_ms.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_ms.xsd) |
| Drama | TEI with Drama, includes the TEI drama module | [ODD](../../release/xml/tei/custom/odd/tei_drama.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_drama.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_drama.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_drama.xsd) |
| Speech | TEI for Speech Representation, includes the TEI module for spoken language | [ODD](../../release/xml/tei/custom/odd/tei_speech.odd), [DTD](../../release/xml/tei/custom/schema/dtd/tei_speech.dtd), [RNG](../../release/xml/tei/custom/schema/relaxng/tei_speech.rng), [XSD](../../release/xml/tei/custom/schema/xsd/tei_speech.xsd) |

The following customizations use features which are not available in the DTD and XSD schema formats.

Expand Down
19 changes: 10 additions & 9 deletions src/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,16 @@ tags: page



Generation of schemas and documentation: Roma
## Generation of schemas and documentation: Roma

[Roma](https://roma2.tei-c.org/) is a web-based application which allows TEI users to
generate P5-compatible schemas and documentation. Roma is useful for all TEI customization
[Roma](https://roma.tei-c.org/) is a web-based application which allows TEI users to
generate their own customized P5-compatible schemas and documentation. Roma is useful for all TEI customization
development, whether you want to create a simple TEI schema by selecting a few of
the most relevant TEI modules for your project, or want to do a more complex customization
involving modifications to specific elements. Roma can also help you generate TEI
documentation in languages other than English (for more detail, see the section on
internationalization below). For detailed instructions on using Roma, see [Customizing the TEI with Roma](../Guidelines/Customization/use_roma.xml). A command-line version of Roma (called roma) is also available and can be installed
documentation in languages other than English (for more detail, see the [section on
internationalization below](#I18N)). For detailed instructions on using Roma, see [Customizing the TEI with Roma](../Guidelines/Customization/use_roma.xml).
A command-line version of Roma (called roma) is also available and can be installed
and run locally; a description and instructions for use can be found [here](../Guidelines/Customization/odds.xml#romacommandline). The source code for Roma
is available from the [TEI Sourceforge site](https://sourceforge.net/project/showfiles.php?group_id=106328&package_id=141128). Roma is the P5 equivalent of the
older
Expand All @@ -50,7 +51,7 @@ tags: page



Stylesheets for converting TEI documents to various formats
## Stylesheets for converting TEI documents to various formats

The TEI maintains a library of [XSL stylesheets](./Stylesheets/) developed by Sebastian Rahtz,
which can convert TEI XML files to HTML, LaTeX, or XSL:FO documents. These stylesheets
Expand All @@ -62,17 +63,17 @@ tags: page



Conversion to and from TEI:
## Conversion to and from TEI:

[OxGarage](https://oxgarage2.tei-c.org/) is a web, and RESTful, service to manage the transformation of documents between
[TEIGarage](https://teigarage.tei-c.org/) is a web, and RESTful, service to manage the transformation of documents between
a variety of formats. The majority of transformations use the Text Encoding Initiative
format as a pivot format. It is a good tool for conversion from TEI to Word (.docx),
or Word (.docx) to TEI, but also does many other formats.




Internationalization of the TEI
<h2 id="I18N">Internationalization of the TEI</h2>

One important tool developed by the TEI is the system for generating versions of the
Guidelines in languages other than English. This initiative, funded in part by the
Expand Down

0 comments on commit b4aed7c

Please sign in to comment.