• If it is a research paper, position paper, south-north dialogue item or research summary ...
  1. The Editor validates the XML code via the editor tool.
  2. The Compendium editor uploads a TEI encoded text file to the Compendium server via the editor tool.
  3. The text file is run through the TAPoR Extract Text tool to create an untagged text file.
  4. The untagged text file is used with XIndice to add document terms to the master index.
  5. The TEI-encoded text file is placed in a directory for nightly indexing via Lucene.
  6. The TAPoRWare Tagger is used to find glossary items in a document and to tag them with references to the glossary item.
  7. Lucene walks through the directory document by document extracting title, author, category, date and other meta data to add to the index.
  8. The original document is storied in the ori* directory and the transformed XML is storied in a directory based on its entry type.

1. 1. The untagged text file is used with XIndice to add document terms to the master index.

1. 1. The editor verifies that the entry has not been previsouly entered.
   2. Bibliographic entries are made directly into the MySQL database by the Compendium editor
   3. A flatfile export of the MySQL bibliography database is created and called bibl_data.txt.

1. 1. These are managed manually by the editor working with the system administrator.
   2. They are oded directly into the XML file and are stored in a figures directory for access by the compendium when serving an entry.

1. 1. An archive of the complete tomcat directory is stored here.
   2. An explanation of the individual files and directories comprising the Compendium is available on this page^?.

1. The server consults the index and retrieves the XML file from the appropriate directory.
2. An XSL Transformation is applied to retrieve appropriate titles, glossary entries and these are is output as an fully formed HTML document.
3. To the top of each entry page is added three options: Print (display light HTML version), PDF (processed using FOP) and XML (which displays the source XML of the document). These options are triggered via the appropriate .jsp file depending on the entry type.

• List of code files, what they do, what they interact with
• File structure of code and content
• Technical description with specifications and dependencies^?

To Do

• List of code files, what they do, what they interact with
• File structure of code and content
• Technical description with specifications and dependencies

Compendium Code Archiving

1. 1. Lucene walks through the directory document by document extracting title, author, category, date and other meta data to add to the index.

1. 1. Bibliographic entries are made directly into the MySQL database by the Compendium editor
   2. A flatfile export of the MySQL bibliography database is created and called bibl_data.txt.

1. The server consults the index and retrieves the XML file from the directory,
2. An XSL Transformation is applied to retrieve appropriate titles, glossary entries and this is output as an HTML document
3. To the top of each HTML page is added three options: Print (display light HTML version), PDF (processed using FOP) and XML (which displays the source XML of the document)

Adding Documents to the Compendium

1. 1. The Compendium editor uploads a TEI encoded text file to the Compendium server.
   2. The text file is run through the TAPoR Extract Text tool to create an untagged text file.
   3. The untagged text file is used with XIndex to add document terms to the master index.
   4. The TEI-encoded text file is placed in a directory for nightly indexing via Lucene.
   5. The TAPoRWare Tagger is used to find glossary items in a document and to tag them with references to the glossary item.
   6. Lucene walks the directory document by document extracting title, author, category, date and other meta data to add to the index.

1. 1. The Compendium editor uploads a TEI encoded textfile to the Compendium server.
   2. The textfile is run through the TAPoR Extract Text tool to create an untagged textfile.
   3. The untagged text file is used with XIndex to add document terms to the master index.
   4. The TAPoRWare Tagger is used to find glossary items in a document and to tag them with references to the glossary item, in this specific case excluding the glossary term of the document itself.
   5. The Glossary item is merged into the master glossary document.

1. 1. Bibliographic entries are made directly into the MySQL^? database by the Compendium editor
   2. A flatfile export of the MySQL^? bibliography database is created and called bibl_data.txt.

• Images and Figures

1. The server consults the index and retrieves the text file from the directory,
2. AN XSL is applied to retrieve appropriate titles, glossary entries and this is output as an HTML document
3. To the top of each HTML page is added three options: print (display untagged text), PDF (sent using FOP) and XML (which displays the source of the document)

Appendix

• Minutes from Meeting with Lian

• If it is a research paper, position paper, or research summary ...

Documentation

The Globalization Compendium currently resides on a server. It receives TEI encoded articles from the Compendium editor. See Content section for more info on the document's pre-server life. This document describes the nature of the code itself and best practises for archiving it.

Input

Output

Best Archiving Practise

Printing

Digital Storage

-- ShawnDay - 19 May 2007