erc-dharma / tfb-ec-epigraphy

DHARMA project Task Force B, Epigraphy Carnatica corpus.

tfb-ec-epigraphy

DHARMA project Task Force B, Epigraphy Carnatica corpus. For more information, see the website description.

Repository Static page

You can consult the current state of the work on this repository at https://erc-dharma.github.io/tfb-ec-epigraphy/.

Help and Guides

• A Guide for Git is provided in the project documentation repository at DHARMA_Git_guide_v01.md
• DHARMA encoding guide is available under encoding-diplomatic, but we recommend you to use the google doc version to access the latest edits.
• Encoding templates are also provided under templates
• Feel free to use issues to ask questions to other members of the project. To Get started with issue, see the guide.

Validation

All DHARMA XML are validated against Epidoc schema in its latest version as well as against DHARMA ones. You can declare those schemas in the processing instructions of every XML files. To use it with Oxygen, you might need to change the default configuration. In the toolbar, go to the Options > Preferences, a window will open, select XML > XML Parser > RelaxNG. The check box for "Add default attributes values" must be unchecked. Click on Apply. You might need to restart Oxygen for it to be taken into account.

• DHARMA validation schemas
  • a RelaxNG with embedded Schematron code is available here.
  • a Schematron with embedded Schematron Quick Fixes to complete the first schema is available here

Note that both schemas are needed to a complete validation of DHARMA encoding rules

If you use an online validation processing, the processing instructions should be as followed

<?xml-model href="https://raw.githubusercontent.com/erc-dharma/project-documentation/master/schema/latest/DHARMA_Schema.rng" type="application/xml" schematypens="http://relaxng.org/ns/structure/1.0"?>
<?xml-model href="https://raw.githubusercontent.com/erc-dharma/project-documentation/master/schema/latest/DHARMA_Schema.rng" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
<?xml-model href="https://raw.githubusercontent.com/erc-dharma/project-documentation/master/schema/latest/DHARMA_SQF.sch" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
<?xml-model href="http://www.stoa.org/epidoc/schema/latest/tei-epidoc.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<?xml-model href="http://www.stoa.org/epidoc/schema/latest/tei-epidoc.rng" schematypens="http://purl.oclc.org/dsdl/schematron"?>

However, if you need to do it locally, you can access all DHARMA RelexNG and Schematron in their latest version in the projection-documentation repository under schema/latest. In this case, you will need to update the @href and provide the path between you current file and the schema itself (either as a standalone file or either as a part of the project-documentation repository if you have cloned it)

Workflow

• Before working with this repository, make sure you always the latest version through a git pull

• Create a XML file or edit an existing one.

• Once, you are done use git to add, commit and push it on the repository.

• Once you have done your git push, the XML files are validated against the Epidoc and Dharma RelaxNG with a CI service called Travis. This process is made possible with the existing .travis.yml file. Do not delete or modify this file on your own. You can access the resulting log here

• On the git push, we are also using github Actions service to transforme automatically the XML into a HTML version. We are using Ant in a java environment to do this batch transformation. The steps are declare in the build.xml file, while the automated scenario is provided under .github/workflows/editorial.yml Do not delete or modify those files on your own.

  • Step 1: it will editorially edit all the XMLs in the repository.
  • Step 2: from those edited XMLs, it will create a HTML output and retrieve Zotero data as well.
  • Step 3: it will push those files in the repository under editedxml and htmloutput folders.
  • Step 4: to access those newly created files, make a git pull
  • Step 5: all the HTML are available as a static website thanks to GitHub pages service. Note that the README is the by default page if no XMLs are stored in the repository: https://erc-dharma.github.io/tfb-ec-epigraphy/

  Please note that this process can break easily and requires high quality data. The content log of the pipeline are available under Actions tab of the repository, if you need to find the reason behind an error.

License & Attribution

All the edited XML files of this repository are available under the Creative Commons CC-BY 4.0 License, meaning you are free to use it for any purpose, commercial or non-commercial! However, we ask you to mention the project name, funder as well as the members involved in the XML edition of the inscriptions. Feel free to contact the project for more infos at [email protected].

Contributing to this repository

Thanks for your interest in contributing! Currently only members of the project are allowed to contribute to this repository. Contact the researchers in charge of this corpus if you are interested in working with them.