Stylesheets

Tom Elliott Elli Mylonas BODARD Gabriel

XSLT for transformation of EpiDoc XML files into HTML or text versions in Leiden. Includes various XML files containing parameters and other options.

License:

These scripts are copyright Zaneta Au, Gabriel Bodard and all other contributors. See LICENSE.txt for license details.

To cite these stylesheets in a conventional bibliography, please include the following information:

Tom Elliott, Zaneta Au, Gabriel Bodard, Hugh Cayless, Carmen Lanz, Faith Lawrence, Scott Vanderbilt, Raffaele Viglianti, et al. (2008-2014), EpiDoc Example Stylesheets (version 8). Available: https://sourceforge.net/p/epidoc/wiki/Stylesheets/

Technical requirements:

These scripts are written in XSLT 2.0 and may be transformed using any conformant XSLT processor.

To our knowledge at the time of writing, the only freely available XSLT processors that support the 2.0 specifications are the Saxon 9 series processors (the earlier 6 series only supports XSLT 1.0). Saxon comes in several "editions" (as distinct from "series"). Any of the editions (home = HE, professional = PE, or enterprise = EE) should work with these stylesheets, provided their version number starts with "9". The browser based Saxon Client Edition (= CE) also works. The Stylesheets were last tested with Saxon-HE™ 9.2.0.6.

Using a processor other than the Saxon 9 series, therefore, will likely result in error messages and unpredictable or missing output.

How to obtain the stylesheets:

Method 1: check out from the EpiDoc Subversion repository.

On a Mac or Linux machine with Subversion installed, simply create a directory into which you want to check out the xslt, and then on the command-line enter:

svn checkout \
    https://epidoc.svn.sourceforge.net/svnroot/epidoc/trunk/example-p5-xslt \
    your_directory

On Windows, using a client such as TortoiseSVN or Oxygen's SynchroSVN, check out the repo from https://epidoc.svn.sourceforge.net/svnroot/epidoc/trunk/example-p5-xslt to your local repository.

Method 2: download the latest packaged, stable release from the SourceForge repository

at https://sourceforge.net/projects/epidoc/files/epidoc-xsl/

How to use it:

XSLT may be run on an individual EpiDoc XML file, creating a single file output (e.g. via a command-line Saxon™ call or an Oxygen™ transformation scenario) or batch-run upon a large collection of files via some other process (e.g. an Oxygen™ project, set of batch files, etc.). Call the start-edition.xsl stylesheet to create a HTML version of the output (this xsl calls both generic and specialized files needed), or start-txt.xsl to create a version that contains the inscription text and apparatus only.

(add specific commandline and Oxygen scenario help. Maybe even create a downloadable .xpr?)

Transformations are parameterised so that they may be used by different projects with only a change in local parameters, the scripts themselves being identical for all users. Change the parameters either by (a) changing the global-parameters.xml in your local copy (please do not commit these changes to SVN), or (b) setting local variables in your Saxon command-line, Oxygen scenario, etc.

The parameters currently defined include:

(add some explanation of what these changes do.)

$apparatus-style:
    supported values are 'default' (generate apparatus from tei:div[@type='apparatus'])
    and 'ddbdp' (generate apparatus from tei:app, tei:subst, tei:choice,
    tei:hi etc. elements in the text).
$css-loc
    default value is '../xsl/global.css'. Path of CSS file referenced in
    the resulting HTML file.
$docroot
    default value is '../output/data'
$edition-type:
    supported values are 'interpretive' (default) and 'diplomatic' (prints edition
    in uppercase, no restored, corrected, expanded characters, etc.)
$edn-structure
    supported values are 'default', 'inslib', 'iospe'
$hgv-gloss
    default value is '../../../xml/idp.data/trunk/HGV_trans_EpiDoc/glossary.xml'.
    Location of HGV glossary file relative to the current file.
$leiden-style:
    supported values include 'panciera' (default), 'ddbdp', 'dohnicht',
    'edh-web' (and 'edh-itx', 'edh-names'), 'ila', 'london',
    'petrae', 'rib', 'seg', and 'sammelbuch'. These change minor
    variations in local Leiden usage; brackets for corrected text,
    display of previously read text, illegible characters, etc.
$line-inc:
    default value = 5, may be locally defined to any integer value
$topNav
    values are 'default' and 'ddbdp'
$verse-lines:
    values are 'off' (default), and 'on' (when a text of section of
    text is tagged using <lg> and <l> elements [instead of <ab>] then
    edition is formatted and numbered in verse lines rather than
    epigraphic lines)

Limitations:

Please note that the Epidoc Stylesheets are based on stylesheets that were originally written for the Inscriptions of Aphrodisias and Duke Databank projects. They handle and display most Epidoc features, but the output will reflect the requirements and interface choices of those projects. There is a great deal of control available via the parameters listed above, especially for managing the display of inscription text. However, metadata and other supporting material may need to be modified for your project. If you are mainly using the Epidoc stylesheets to output the text of your inscription(s), then run the stylesheets using start-txt.xsl, as noted above.


Related

Home: Guidelines
Home: Home
Home: ReleaseProc

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks