diff --git a/COSMOS.md b/COSMOS.md new file mode 100644 index 0000000..526b1dd --- /dev/null +++ b/COSMOS.md @@ -0,0 +1,74 @@ +# The EOA cosmos + +An inventory of all programs related to EOA and how they play together + +## EOASkripts +Contains the most important programs for the whole document conversion workflow. + + - `create_tmpbib.py` : A helper script that creates a temporary bibtex file from a formatted list of references. + - `eoatex2imxml.py` : Converts Latex files into a customized DocBook XML file. + - `fix_tei.py` : This program is a processing step after the conversion from docx to TEI. + - `imxml2django.py` : Create an XML file that can be inserted into the Django database of an EOAv1 installation. + - `imxml2epub.py` : Convert a customized DocBook XML file into a set of files that constitute the contents of an EPUB file. + - `imxml2tei.py` : Unfinished program to convert a customized DocBook XML to TEI-XML. + - `libeoabibitem.py`: A library for the formatting of bibliographical references. + - `libeoaconvert.py` : A collection of functions for the different conversion steps + - `mkimage.py` : Create an automatically generated dummy cover to be used during testing. + - `tei2eoatex.xsl` : An XSL converter from TEI-XML to EOATeX + - `tei2imxml.py` : A converter from TEI to customized DocBook XML. + +## chapterdownload_frontmatter +A program for generating LaTeX frontmatters for chapter downloads. In +fact, it provides functions for a general query on book metadata. A +variant creates ONIX type XML. + +The main functionality has been built into the new eoa-django platform +and can be run via `manage.py`. A recent addition is +`find_chapters.py` which uses data from the LaTeX auxiliary files to +determine the chapter breakpoints and splits the book pdf into the +single chapters that are made available for download, as well. + +## eoa-csl +A nearly-abandoned version of a CSL configuration for EOA. Currently +slightly customized version of `chicago-author-date.csl` is used. + +## eoa-django +Contains the Django platform which is currently re-developed. The +functionality offered via the `manage.py` interface is currently +expanded and offers + - `bib2tei` : Converts a bibtex bibliography file to a TEI-XML `listBibl` structure + - `check_tei_output` + - `publication_add_chapter_frontpages` + - `publication_export_tei` : Exports a publication from the database as an TEI-XML file + - `publication_list` + - `publicationimport` + - `statistic` + +## eoa-django2-gitlab +A prototype for the new EOA2 platform. It accepts TEI-XML documents as input. + +## eoa-opds-module +A proof-of-concept to create files for an OPDS catalogue service. + +## eoa-tei-schema +Contains the RELAX NG schema for the EOA publications. + +## eoa-umbrellapage +A small Django-CMS platform for the umbrella page. + +## eoa-utilities +A collection of small tools and files + +## eoa_sample_project +A EOATeX sample project that contains all the possible markup +possibilities. Also a testing ground for new features. The text markup +is congruent with the example file found in `eoa-tei-schema` + +## eoa_skeleton +Provides the basic structure for an EOATeX project. + +## latex2eoa +A tool to convert common LaTeX markup into EOATeX markup. + +## rssfixer +A small tool to correct the links in the rssfeeds.