How To Contribute

Before getting started

We are happy that you want to contribute to extending this collection! First, please ask yourself a few questions:

Is the data you can contribute pertinent to this project?
Perhaps it is already included in the collection? Conduct a search to check on this.
If you are uncertain, send us an inquiry by E-Mail to Prof. Dr. Cornelia Horn.

Requirements

Github-Account
XML-Editor

In order to contribute

clone the repository https://github.com/cobdh/collection
create a separate branch
add a file with your data in data/editors/xxx.xml
add your contribution to data/bibl and data/persons
run formatter and checks
create a pull request to integrate your changes
wait for feedback and resolve the requested changes

Templates

<TEI xml:lang="en">
    <teiHeader>
        <fileDesc>
            <titleStmt>
                <editor xml:id="XXXXXX" ref="https://cobdh.org/editors/XXXXXX" role="creator"></editor>
            </titleStmt>
        </fileDesc>
        <encodingDesc>
            <classDecl>
                <taxonomy>
                    <category xml:id="XXXXXX"></category>
                </taxonomy>
            </classDecl>
        </encodingDesc>
    </teiHeader>
    <body>
        <biblStruct corresp="XXXXXX" xml:id="XXXXXX" type="book">
            <monogr>
                <title level="m">XXXXXX</title>
                <author xml:id="XXXXXX" ref="https://cobdh.org/persons/XXXXXX">
                    <forename>XXXXXX</forename>
                    <forename>XXXXXX</forename>
                    <surname>XXXXXX</surname>
                </author>
                <imprint>
                    <pubPlace>XXXXXX</pubPlace>
                    <publisher>XXXXXX</publisher>
                    <date>XXXXXX</date>
                </imprint>
            </monogr>
            <series>
                <title level="s">XXXXXX</title>
            </series>
        </biblStruct>
    </body>
</TEI>

templates/bookSection

<TEI xml:lang="en">
    <teiHeader>
        <fileDesc>
            <titleStmt>
                <editor xml:id="XXXXXX" ref="https://cobdh.org/editors/XXXXXX" role="general"></editor>
                <editor xml:id="XXXXXX" ref="https://cobdh.org/editors/XXXXXX" role="creator"></editor>
            </titleStmt>
        </fileDesc>
    </teiHeader>
    <body>
        <biblStruct xml:id="XXXXXX" type="bookSection">
            <analytic>
                <title level="a">XXXXXX</title>
                <author xml:id="XXXXXX" ref="https://cobdh.org/persons/XXXXXX">
                    <forename>XXXXXX</forename>
                    <surname>XXXXXX</surname>
                </author>
            </analytic>
            <monogr>
                <title level="m">XXXXXX</title>
                <editor xml:id="XXXXXX" ref="https://cobdh.org/persons/XXXXXX">
                    <forename>XXXXXX</forename>
                    <surname>XXXXXX</surname>
                </editor>
                <imprint>
                    <pubPlace>XXXXXX</pubPlace>
                    <biblScope unit="page">XXXXXX</biblScope>
                    <publisher>XXXXXX</publisher>
                    <date>XXXXXX</date>
                </imprint>
            </monogr>
        </biblStruct>
    </body>
</TEI>

templates/article

<TEI xml:lang="en">
    <teiHeader>
        <fileDesc>
            <titleStmt>
                <editor xml:id="XXXXXX" ref="https://cobdh.org/editors/XXXXXX" role="creator"></editor>
            </titleStmt>
        </fileDesc>
        <encodingDesc>
            <classDecl>
                <taxonomy>
                    <category xml:id="XXXXXX"></category>
                </taxonomy>
            </classDecl>
        </encodingDesc>
    </teiHeader>
    <body>
        <biblStruct xml:id="XXXXXX" type="journalArticle">
            <analytic>
                <title level="a">XXXXXX</title>
                <author xml:id="XXXXXX" ref="https://cobdh.org/persons/XXXXXX">
                    <forename>XXXXXX</forename>
                    <surname>XXXXXX</surname>
                </author>
            </analytic>
            <monogr>
                <title level="j">XXXXXX</title>
                <imprint>
                    <biblScope unit="volume">XXXXXX</biblScope>
                    <biblScope unit="page">XXXXXX</biblScope>
                    <date>XXXXXX</date>
                </imprint>
            </monogr>
        </biblStruct>
    </body>
</TEI>

Tools

The following tools make working with xml-files inside cobdh-project easier. These tools require python. Use `python -mpip install cob_dev` to install the dev- package.

cob_persons

Generate entries for persons based on the bibliographic database.

cd to data/persons
run cob_persons data/bibl to generate new persons

cob_format

Run formatter to ensure standarized source code.

cd to project directory
cob_format . --ext html --ext xml to format html and xml files

cob_split

Split a single xml file into separate xml-files by node-name.

cd to data/bibl
cob_split --src base.xml --node .//biblStruct

cob_enrich

Inject TEI-Header into a single file or multiple files inside a directory.

cob_enrich [file or directory]

cob_bibl

Fix invalid xml ids of bibl data.

cob_bibl data/bibl

cob_crawl

List all hyperlinks which are provided by cobdh.org.

cob_craw