Difference between revisions of "PCGen Tag Dictionary Conversion to XML"

From PCGen Wiki
Jump to: navigation, search
 
(13 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
The purpose of this effort is to convert the current LST Tag Dictionary from the HTML based format to an XML format more suitable to regular maintenance and automated processing in support of the DTP Initiative.
 
The purpose of this effort is to convert the current LST Tag Dictionary from the HTML based format to an XML format more suitable to regular maintenance and automated processing in support of the DTP Initiative.
  
The Tag Dictionary itself will be developed for two purposes:
+
The Tag Dictionary itself will be developed for three purposes:
 
* LST Tag Dictionary for LST Monkeys
 
* LST Tag Dictionary for LST Monkeys
* LST Token Dictionary for PCGen Developers
+
* OS Token Dictionary for OS Monkeys
 +
* LST/OS Token Dictionary for PCGen Developers
  
 
==Proposed (Eventual) Products==
 
==Proposed (Eventual) Products==
 
* XML Based LST Tag Dictionary File(s)
 
* XML Based LST Tag Dictionary File(s)
* Java Based LST Tag Dictionary Entry Editor
+
* XML Based OS Token Dictionary File(s)
 +
* Java Based LST Tag/OS Token Dictionary Entry Editor
  
 
==Roadmap==
 
==Roadmap==
The LST Tag Dictionary to XML Project Roadmap is under development:
+
The LST Tag/OS Token Dictionary to XML Project Roadmap is under development:
  
* Develop Tag Dictionary Specification
+
* Develop [[PCGen Data Tag and OS Token XML Dictionaries Concept of Operations | Concept of Operations (In-work)]] for the Tag/Token XML Dictionaries
* Develop XML Schema for Tag/Token Dictionary
+
* Develop Tag/Token Dictionary Specification
 +
* XML Schema for Tag/Token Dictionary
 
* Develop Java based Tag/Token Editor
 
* Develop Java based Tag/Token Editor
 
* Convert Existing HTML Based Dictionary to XML
 
* Convert Existing HTML Based Dictionary to XML
Line 31: Line 34:
 
* [[PCGen Documentation HTML Compliance Project]]
 
* [[PCGen Documentation HTML Compliance Project]]
 
* [[PCGen Documentation Style Guide]]
 
* [[PCGen Documentation Style Guide]]
 +
* [[PCGen Documentation DTP Initiative]]
  
 
==Tools==
 
==Tools==
 
Tools to be used in this effort will be added as they are identified.
 
Tools to be used in this effort will be added as they are identified.
  
 +
==Prior Discussion==
 +
* [[http://tech.groups.yahoo.com/group/pcgen_experimental/message/9667| PCGen Experimental]]
  
 
=Tasks and Status=
 
=Tasks and Status=
Line 46: Line 52:
 
|-
 
|-
 
|  ||  ||  ||  
 
|  ||  ||  ||  
 +
|}
 +
 +
=Specifications and Requirements=
 +
 +
==LST Tag Elements==
 +
 +
{| border=1
 +
|-
 +
! Doc Element !! Data Example || Data Type || Data Description
 +
|-
 +
| Tag Status || New/Updated/Deprecated ||  ||
 +
|-
 +
| LST Tag Syntax || <lst tag>:<parameter list> ||  ||
 +
|-
 +
| Variables Used ||  ||  ||
 +
|-
 +
| Tag Description ||  ||  ||
 +
|-
 +
| Example LST Code ||  ||  ||
 +
|-
 +
| .MOD Consolidation ||  ||  ||
 +
|-
 +
| .MOD Example From ||  ||  ||
 +
|-
 +
| .MOD Example To ||  ||  ||
 +
|-
 +
| Deprecated Syntax ||  ||  ||
 +
|-
 +
| Where Used ||  ||  ||
 
|}
 
|}

Latest revision as of 12:42, 14 December 2014

Introduction

Welcome to the LST Tag Dictionary Conversion Initiative page!

Purpose

The purpose of this effort is to convert the current LST Tag Dictionary from the HTML based format to an XML format more suitable to regular maintenance and automated processing in support of the DTP Initiative.

The Tag Dictionary itself will be developed for three purposes:

  • LST Tag Dictionary for LST Monkeys
  • OS Token Dictionary for OS Monkeys
  • LST/OS Token Dictionary for PCGen Developers

Proposed (Eventual) Products

  • XML Based LST Tag Dictionary File(s)
  • XML Based OS Token Dictionary File(s)
  • Java Based LST Tag/OS Token Dictionary Entry Editor

Roadmap

The LST Tag/OS Token Dictionary to XML Project Roadmap is under development:

  • Develop Concept of Operations (In-work) for the Tag/Token XML Dictionaries
  • Develop Tag/Token Dictionary Specification
  • XML Schema for Tag/Token Dictionary
  • Develop Java based Tag/Token Editor
  • Convert Existing HTML Based Dictionary to XML


Resources

Related Efforts

Tools

Tools to be used in this effort will be added as they are identified.

Prior Discussion

Tasks and Status

No tasks have been identified at this time.

Task Description Tracker Number Doc Monkey Status

Specifications and Requirements

LST Tag Elements

Doc Element Data Example Data Type Data Description
Tag Status New/Updated/Deprecated
LST Tag Syntax <lst tag>:<parameter list>
Variables Used
Tag Description
Example LST Code
.MOD Consolidation
.MOD Example From
.MOD Example To
Deprecated Syntax
Where Used