Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
hyperimage_scripts/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
22 lines (17 sloc)
1.06 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Scripts for handling Hyperimage insertions | |
The most important scripts are in `hyperimage_insertion`: | |
* histandoff.py | |
* update_hi.py | |
Some additional helper scripts are in `misc`: | |
* graphicchecker.py | |
* teichecker.py | |
## hyperimage_insertion | |
### histandoff.py | |
This script is used to extract Hyperimage code from an enriched Django file. It is most likely that this workflow is not a very common case in the future. However, it creates a CSV file that can store Hyperimage code in a standoff fashion. In a later step, the information can be inserted again into the file that is to be published. It also stores human readable version of the Hyperimage code as JSON files. | |
### update_hi.py | |
The JSON files can be edited manually, if needed (the recommended way would be of course to use Hyperimage's own annotation tool). This script will recode the information and write it back into the CSV file. | |
## misc | |
### graphicchecker.py | |
A checker if images referenced in the XML file are present in the `images` directory. | |
### teichecker.py | |
A checker if Hyperimage markup is handled correctly. |