Data Dictionary Generator (DDG)

From TEIWiki

Jump to: navigation, search


Contents

Synopsis

Aimed at the TEI editing community and intended to be run inside oXygen, the Data Dictionary Generator (DDG) generates profiles of every element and attribute appearing in a TEI file. Each entry includes a definition from the TEI Guidelines, a local, project-specific definition (if provided), and a brief snapshot of how the element or attribute is actually being used. By making it easy to compare these three things, the DDG aims to help project editors reflect on current practice within their projects and quickly create stronger encoding guidelines for their collaborators.

Ddg example.png

Features

  • profiles every element and attribute in a TEI file, including definitions from the P5 Guidelines
  • one-click operation inside oXygen, using its Transformation Scenarios feature.
  • project-specific definitions, example code, and more

User commentary

Please sign all comments. (please leave the above note about signing comments, and add signed comments here below it)

System requirements

Any operating system that supports the Saxon XSLT processor and/or oXygen will work with the DDG. This script has been tested on Mac OS X 10.9 and 10.10, Windows 7 & 8, Red Hat 4.4, and Ubuntu 14.04

Source code and licensing

The Data Dictionary Generator is free and open-source software, and is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Support for TEI

This tool is designed with TEI in mind, but could be modified to work with any kind of XML document. The DDG expects a local copy of the P5subset.xml definitions file. While this file is bundled with the DDG, it is best to download an updated copy from tei-c.org.

Language(s)

The DDG was written in XSLT 2.0, and outputs an XHTML file.

Documentation

https://github.com/rochester-rcl/data-dictionary

Sample implementations

(links to demo sites running the tool or successful implementations of it)

Current version number and date of release

2.0

History of versions

Version 2.0 (September 2015) is the first publicly-released version.

How to download or buy

https://github.com/rochester-rcl/data-dictionary

Branches, modifications and bug fixes from the user community are encouraged.

Personal tools