Skip to content

Generates documentation for a functional subset of TEI elements

Notifications You must be signed in to change notification settings

wsalesky/teiDocs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 

Repository files navigation

teiDocs

###Goal

The goal of this project is to generate documentation for the subset of TEI elements used in any given TEI document.

###Technology

The code consists of an XQuery module along with the TEI XML Schema ( tei_all.xsd). The code has been tested in eXist. The formatting of the ouput comes from a slightly modified version of the Bootstrap Basic Template.

###Installation

Create a collection "/db/apps/teiDocs" in eXist and add teiDocs.xqm and tei_all.xsd to the collection. You can invoke the module from eXide with the following function:

xquery version "3.0";

import module namespace teiDocs = "http://nullable.net/teiDocs" at "/db/apps/teiDocs/teiDocs.xqm";

declare option exist:serialize "method=html5 media-type=text/html";

teiDocs:generate-docs("PATH_TO_YOUR_TEI_FILE_IN_EXIST")

###Credits

Created during Hack Nashville 5 on May 2-4, 2014.

About

Generates documentation for a functional subset of TEI elements

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • XQuery 100.0%