-
Notifications
You must be signed in to change notification settings - Fork 5
Set Up Project Directory
Each project needs to have its own folder in the data repository's projects directory. It is highly recommended that projects be version controlled -- the data repository does not track changes to project files. Here are some examples of projects used in conjunction with the data repository that are version controlled:
The structure of your project should look something like this, assuming it is fairly standard TEI. Put your TEI files in the TEI directory as they are (no sub-directories, sorry).
project_name
|-- config
| |-- config.yml
| |-- config.example.yml
|-- html-generated
|-- tei
| |-- tei_files.xml
| |-- tei_files.xml
| |-- tei_files.xml
|-- .gitignore
You can also add the following directories to your project, depending on the materials you are working with:
- csv
- dublin_core
- vra
If you are not satisfied with the transformations done by the default XSLT (default xsl for given format to solr, default xsl for given format to HTML), then you may need to write your own. If you do, you will need to add the following directory and put your custom XSLT inside. You'll also need to specify in the config file to use your XSLT, but that's a few steps away still. Just building some hype!
projects
|-- scripts
| |-- custom_xslt.xsl
The .gitignore file prevents the config.yml file from being committed. This is because the config file may have sensitive information like URLs to development servers and server ports (like in solr URLs) that we don't want made public or stored in git. You can copy an existing project's .gitignore file or add the following:
# ignore config files except examples
**/*.yml
!**/*.example.yml
This is the most important part of the whole setup. As such, it has its own page: (TODO link to page)