Oracc Text Format (OTF)

This page explains how to create OTF (Oracc Text Format) files in order to generate OpenOffice documents from ATF files and other text, in order to write books, articles, etc., that draw on Oracc transliterations and translations. OpenOffice (.odt) files can then be saved as Word (.docx) or other word-processing or typesetting formats. There is also a more technical description here.

Basic principles

Work in Emacs or another text editor. Save your file in your project's /00atf/ directory as [FILENAME].otf.

Structural elements begin on a new line and start with the @ sign. New paragraphs start after an empty line Inline elements start with @ and are enclosed in { }.

When you have finished, run the Oracc Command oracc odt to generate an OpenOffice file called [FILENAME].odt. You can then copy it off the Oracc server and edit and format it further if you wish.

Example

Here is a very simple example, consisting of an introduction, catalogue and edition of a text from the CAMS/GKAB corpus.

@document
@project cams/gkab
@section introduction
@h1 Rituals to obtain an oracular decision
This composition from Neo-Assyrian Huzirina contains incantations and rituals. 

It was copied by the @i{šamallû ṣeḫru} (junior apprentice) Nabu-šabši.
@end section

@section catalog
@catalog
@record
@:copy	 STT 1, 73
@:exc_no SU 51/1 + SU 51/25
@:prov	 Huzirina
@:period Neo-Assyrian
@:lit	 Reiner 1960; Hunger 1968: no. 380 (colophon); Butler 1998: 349-77 (ms A); CAMS http://oracc.org/cams/gkab/stt_1_73/
@:edit	 Greta Van Buylaere
@end record
@end catalog
@end section

@section edition
@h2 STT 1, 73
@atffile stt_1_073.atf
@end section
@end document

Structural elements

Structural elements begin on a new line and start with the @ sign.

@document
@end document
Every OTF file must begin and end with these lines.
@project [PROJECT NAME]
Mandatory. After the @document element, you need to declare the project and, if relevant, subproject which the document belongs to: e.g., @project rinap/rinap4 or @project etcsri.
@title [TEXT]
Mandatory. This single-line element gives the title of your document. It can be whatever you like.
@atffile [FILENAME].atf
Optional. Inserts and formats the contents of an ATF file in your document. If the ATF file is not in the same Oracc directory as your OTF file, you will need to specify the path too. For instance, if your OTF file is in /00any/ and the ATF file gilgamesh.atf is in /00atf, write @atffile ../00atf/gilgamesh.atf.
All the appropriate italics, superscripts, subscripts, etc. will be formatted into the transliteration when the file is converted to ODT format.
@h1 [TEXT]
@h2 [TEXT]
etc.
Optional. You can use these single-line elements to mark different levels of heading in your document.
@section [STYLE NAME]
@end section
Optional. If you like, you can define different types of section in a style file [http://oracc.museum.upenn.edu/doc/developer/opendocument/], so that they are formatted differently. For instance, you may want to distinguish @section introduction from @section bibliography. If not, then Oracc will generate the OpenOffice document with a default paragraph style throughout. Each section must end with an @end section line.
You can put @h1 headings, etc., within a section.
# [COMMENT TEXT]
You can add a comment line, starting with a # sign, anywhere in the file. It will be ignored during the conversion to ODT format.

Catalogue entries

@catalog
@end catalog
Optional. Use this pair of tags if you want to include formally structured catalogue data in your document. It must be enclosed in a @section catalog element and must comprise one or more @record elements.
@record
@end record
Use this pair of tags to delimit @catalog entries. Each @record comprises onr or more of the following single-line entries in any order of your choosing. (Here they are listed in alphabetical order.) Note the colon after the @ sign.
@:acc_no
Museum accession number of the tablet, e.g., @:ass_no K 3459.
@:copy [TEXT]
Place of publication of the copy, e.g., @:copy STT 1, 72.
@:cpn [TEXT]
Used by the RINAP project to mark entries as c, p, or n.
@:dimen [TEXT]
Dimensions of the object, e.g., @:dimen 34 × 56 × 24 mm.
@:edit [TEXT]
Editor of the atf file, e.g., @:edit Graham Cunningham.
@:exc_no [TEXT]
Excavation number of the tablet, e.g., @:exc_no ND 4536.
@:exemplar [TEXT]
Sigla of manuscripts in an edition or composite text, e.g., @:exemplar N1.
@:lit [TEXT]
Short list of relevant bibliography (but note you can also use a @section bibliography for longer ones).
@:mus no [TEXT]
Museum number of the tablet, e.g., @:mus_no BM 79862.
@:period [TEXT]
Historical period of the tablet, e.g., @:period Old Babylonian.
@:prov [TEXT]
Provenance/provenience of the tablet, e.g., @:prov Nimrud NT Room 12.

Inline formatting

@b{TEXT}
Use to mark bold text.
@i{TEXT}
Use to mark italic text, e.g., The Akkadian word @akk{šamallû} @i{originally} meant "merchant's assitant"..
@r{TEXT}
Use to mark roman (non-italic) text.
@sub{TEXT}
Use to mark subscript text.
@sup{TEXT}
Use to mark superscript text, e.g., 100 m@sup{2}..
@u{TEXT}
Use to mark underlined text.
@akk{TEXT}
Use to mark Akkadian text in transliteration or normalisation, e.g., The Akkadian word @akk{šamallû} means "apprentice"..
@sux{TEXT}
Use to mark Sumerian text in transliteration or normalisation, e.g., The Sumerian word @sux{lugal} means "king"..

You can define further inline formatting styles in the style file [http://oracc.museum.upenn.edu/doc/developer/opendocument/].

23 Jul 2014 osc at oracc dot org

Eleanor Robson

Eleanor Robson, 'Oracc Text Format (OTF)', Oracc: The Open Richly Annotated Cuneiform Corpus, Oracc, 2014 [http://oracc.museum.upenn.edu/doc/help/convertingatf/otf/]

 
Back to top ^^
 

Released under a Creative Commons Attribution Share-Alike license 3.0, 2014. [http://www.facebook.com/opencuneiform] [http://oracc.blogspot.com] [http://www.twitter.com/oracctivity]
Oracc uses cookies only to collect Google Analytics data. Read more here; see the stats here [http://www.seethestats.com/site/oracc.museum.upenn.edu]; opt out here.

http://oracc.museum.upenn.edu/doc/help/convertingatf/otf/