95b8f925c8b2e05d9a298dc7120f228eff9e69b7 - lora-sp/bunc2tei

commit	95b8f925c8b2e05d9a298dc7120f228eff9e69b7	[log] [tgz]
author	lora-sp <lora.spassova@swhk.ids-mannheim.de>	Thu Apr 06 11:28:19 2023 +0200
committer	lora-sp <lora.spassova@swhk.ids-mannheim.de>	Thu Apr 06 11:28:19 2023 +0200
tree	3af594ac77b263c2edef25069949a48bf958d45a
parent	52f1a295b8c4f92ab8544631868dc9ffeccdd7b3 [diff]

tree: 3af594ac77b263c2edef25069949a48bf958d45a

readme.md

Creating a TEI corpus file out of xml documents

This tool is to be used on data from the Bulgarian National Corpus. It contains two script files,bunc2tei.py and escape_amp.py.

Usage

Converting the xml files and storing them into one corpus file

The script bunc2tei.py can be executed with the command bunc2tei.py *.xml inside a directory containing the data.

A new xml file is created in the main function, with the element teiCorpus as its root.
The corpus file parsed as such and saved into the file tree_structure in a new folder called input. This file will serve as the tree from which the new corpus will be built.
To build the corpus, each xml file is first passed to the function convert. Convert tries parsing the xml file. If the parsing fails, the xml file is faulty and needs to be cleaned first. This is done by the script escape_amp.py and will be explained in the next section. If the parsing succeeds, the file is converted and appended to the corpus:
1. To convert the file, the data (text metadata, text elements) is first stored in a list.
2. The tree structure of the xml file is then deleted.
3. The new tree structure is built and the data is inserted into the correct position.

The resulting corpus file is stored in the file corpus.p5.xml inside the folder output.

Additional preprocessing for unescaped symbols

The script escape_amp.py aims at fixing xml files that cannot be processed due to unescaped symbols. In the Bulgarian National Corpus, this was the case for ampersand symbols inside text elements. The script can be executed using escape_amp.py *.xml inside a directory containing the data.

The script tries to parse the xml files. If the parsing fails, the file is passed to the function escape.
Escape looks for all &-symbols that are not yet escaped and that are not themselves used to escape another symbol using a regular expression.
The unescaped &-symbols are replaced by their escaped variant inside the file.