Skip to content

Commit

Permalink
Update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
nevenjovanovic committed Jan 3, 2024
1 parent 4f3bc4a commit 19ec6aa
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 14 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@

TEI XML encoded Latin texts from the Croatian auctores Latini collection, freely available under a [CC-BY license](LICENSE.md).

The files edited here are published as a [PhiloLogic](https://sites.google.com/site/philologic3/) collection [CroALa](croala.ffzg.unizg.hr) (there is a [testing deployment](http://solr.ffzg.hr/philo4/croala0/) under PhiloLogic 4), and as a BaseX XML database (see an introductory analysis in [Quadrata rotundis](http://solr.ffzg.hr/dokuwiki/doku.php/z:crotyr-quadrata) paper).
The files edited here are published as a [PhiloLogic](https://sites.google.com/site/philologic3/) collection [CroALa](croala.ffzg.unizg.hr) (there is a [testing deployment](http://solr.ffzg.hr/philo4/croala0/) under PhiloLogic 4), and as a BaseX XML database (see an earlier analysis in [Quadrata rotundis](http://solr.ffzg.hr/dokuwiki/doku.php/z:crotyr-quadrata) paper).

This repository exists both in its [Git](https://git-scm.com/book/en/v2) and [Mercurial](http://hgbook.red-bean.com/read/) version.
The [BaseX](https://basex.org/) XML db will be published through own simple text publishing and searching system; see the directories [croalabro](/scripts/croalabro) and [croalabro-xqm](/scripts/croalabro-xqm).

* Git: on [Github](https://github.com/nevenjovanovic/croatiae-auctores-latini-textus)
* Mercurial: on [Bitbucket](https://bitbucket.org/nevenjovanovic/croalatxt)
* Address of this Git repo: on [Github](https://github.com/nevenjovanovic/croatiae-auctores-latini-textus)

## Contents ##

* The TEI XML texts are in [txts](/txts) directory
* The word counts for files are in [croala-wordcounts.xml](croala-wordcounts.xml)
* The scripts for a text publishing and searching system: [croalabro](/scripts/croalabro) and [croalabro-xqm](/scripts/croalabro-xqm)
* The reading versions of documents will be transformed from TEI XML source to XHTML in oXygen (with an additional XSL script) and served as static files in the local directory `basex/webapp/static/`
* The CSS framework used will be [Chota](https://jenil.github.io/chota/)
* Additional scripts for the BaseX XML database: [xq](/scripts/xq)
* The oXygen project file is [croalaproject.xpr](croalaproject.xpr)

## How to use ##
Expand All @@ -23,7 +26,6 @@ Download the files or clone the repository.

### Download the files ###

* From Mercurial repository on Bitbucket: go to [Download repository](https://bitbucket.org/nevenjovanovic/croalatxt/downloads)
* From Git repository on Github: go to [Releases](https://github.com/nevenjovanovic/croatiae-auctores-latini-textus/releases) and select the most recent one

### With Git ###
Expand All @@ -32,18 +34,15 @@ Download the files or clone the repository.
* Go to the [croatiae-auctores-latini-textus](https://github.com/nevenjovanovic/croatiae-auctores-latini-textus) Github repository
* Replicate the data on your computer with [git clone](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository)

### With Mercurial ###

* [Download](https://www.mercurial-scm.org/wiki/Download) and [Install Mercurial](http://hgbook.red-bean.com/read/a-tour-of-mercurial-the-basics.html)
* Go to the Mercurial [croalatxt](https://bitbucket.org/nevenjovanovic/croalatxt) repository on Bitbucket
* Replicate the data on your computer with [hg clone](https://bitbucket.org/nevenjovanovic/croalatxt#clone)
## Create the DB and the publishing system

TBA

### Current state of the collection ###
On 2019-02-24 the collection contains:
On 2024-01-03 the collection contains:

* *562* documents
* words *5,892,803*
* *509* TEI XML documents
* *5,674,274* words in texts (metadata and encodings are not counted)

### Editor ###

Expand Down
27 changes: 27 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Croatiae auctores Latini - scripts

## XSLT

Directory </xsl>.

* [croala-kay-wordcount.xsl](/xsl/croala-kay-wordcount.xsl) a test script for word counts, adapted from M. Kay's
* [html-add-class.xsl](/xsl/html-add-class.xsl) a script which additionally customizes standard TEI XML transformation to XHTML (as supplied with the [oXygen XML editor](https://www.oxygenxml.com/)).

## XQ

Directory </xq>.

Most important: two scripts to create the main database (`croalatextus`) and the additional word count (`croalatextus-wc`) database:

* [createCroALaDB.xq](/xq/createCroALaDB.xq)
* [createCroALaDB-wc.xq](/xq/createCroALaDB-wc.xq)

Other scripts are used in preparing the TEI XML and BaseX system functions.

## CroALaBRO

XQuery scripts for RESTXQ publishing system (web app), to be used with the BaseX web server. The scripts produce individual pages. To replicate, put them into the local `basex/webapp/apps/croalabro/` directory.

## CroALaBRO-XQM

XQuery modules for the same system. Put them into the local `basex/webapp/repo/` directory.
5 changes: 4 additions & 1 deletion txts/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# TEI XML files of the Croatiae auctores Latini collection

As of 15 May 2016, there are 467 documents.
On 2024-01-03 the collection contains:

* *509* TEI XML documents
* *5,674,274* words in texts (metadata and encodings are not counted)

The word counts can be found in [croala-wordcounts.xml](../croala-wordcounts.xml).

0 comments on commit 19ec6aa

Please sign in to comment.