Resource Container Structure¶
Resource containers (RCs) exist as directories. They may be optionally compressed or packaged so long as the compressed file follows standard naming conventions for the file extension. For example:
- a zipped RC would end in
- a tarred RC would end in
- a tarred+bzip2 RC would end in
A git repository is also a valid way to store RCs.
When naming an RC directory or repository the best practice is to use a combination of the resource and
project identifiers e.g.
If the RC contains more than one project just use the resource identifier with an optional Slug formatted qualifier
nt is the custom qualifier denoting the New Testament.
RCs have a folder structure like the following:
my_resource_container/ |-.git/ |-.apps/ |-LICENSE.md |-manifest.yaml |-content/
.git: only exists when the RC is stored in a git repository.
.apps: is where applications can store custom meta data about the RC. See App Meta for more information.
LICENSE.md: contains the appropriate license information for the RC.
manifest.yaml: is the RC Manifest File.
content: contains the project files. The name of this directory is subject to the Manifest File. It is also possible for there to be multiple directories or excluded altogether.
The folder structure of the project directory in RCs is mostly the same across RC types. The most common structure is indicated below:
content/ |-config.yaml |-toc.yaml |-front/ |-01/ | |-title.txt | |-sub-title.txt | |-intro.txt | |-01.txt | |-02.txt | ... | |-reference.txt | |-summary.txt ... |-back/
Where a .txt extension is shown above, the proper extension should be used according to the format
indicated in the Manifest File. For example
The directories within
content shown above indicate chapters.
There are two special chapters named
back that contain, if applicable, the front and back matter.
The files within each chapter represent the chunks of the chapter.
Often the chunk file names will be numeric (e.g.
01.txt) but that is not required.
The following reserved chunk names have special meaning:
title.txt- the title of the chapter
sub-title.txt- the sub title of the chapter
intro.txt- the introduction to the chapter
reference.txt- a reference displayed at the end of a chapter
summary.txt- a summary displayed at the end of a chapter
In the case of front and back matter, the above named chunks apply to the project, such as the project title, project summary, etc.
This specification makes no distinction between condensed and expanded forms. This is simply shown as an alternative style. Client applications should be prepared to support your chosen style.
Most Container Types support a condensed form in which content in each folder is stored in a single file. e.g.
content/ |-config.yaml |-toc.yaml |-front/ |-01/ | |-01.txt ... |-back/
Where the file
01.txt may contain the title, sub-title, intro, chunks etc.
Content Sort Order¶
When utilizing content in an RC the order is very important. The content sorting rules are defined as:
- front matter directory
- numeric chapter directories sorted numerically in ascending order
- non-numeric chapter directories sorted alphabetically
- back matter directory
- numeric chunks sorted numerically in ascending order
- non-numeric chunks sorted alphabetically
Table of Contents¶
Keys must always be represented even when the value is optional. If the key is not needed/available the value may be empty.
Chapter directories and chunk files are often named with padded integers.
A side effect of this is the natural file order often represents the appropriate order.
However, you may also indicate the order of chapters and frames by providing a table of contents,
toc.yaml, within the content directory.
If no such file exists then the integer order followed by the natural order of the files will be used.
The table of contents is built with small blocks as shown below. All of the fields in the blocks are optional:
--- title: "My Title" sub-title: "My sub-title" link: "my-link" sections: 
The sections field allows you to nest more blocks. The link fields may accept the chunk that should be linked to. Alternatively, you may provide a fully qualified link as defined in Linking.
Here is an example
toc.yaml from translationAcademy.
Generally speaking the title and sub-title fields in this file should be the same as what is found in the subsequently named chunks.
However, the TOC is allowed to deviate as necessary.
--- title: "translationAcademy Table of Contents" sub-title: "" link: "" sections: - title: "Introduction to translationAcademy" sub-title: "This page answers the question: What is in the Introduction?" link: "" sections: - title: "Introduction" sub-title: "" link: "" sections: - title: "" sub-title: "" link: "ta-intro" sections:  - title: "" sub-title: "" link: "uw-intro" sections:  - title: "Table Of Contents - Process Manual Vol 1" sub-title: "This page answers the question: What is in the process manual volume 1?" sections: - title: "Process Manual Volume 1" sub-title: "" link: "" sections: - title: "1. Getting Started" sub-title: "" link: "" sections: - title: "" sub-title: "" link: "process-manual" sections:  - title: "" sub-title: "" link: "getting-started" sections:  - title: "2. Setting Up a Translation Team" sub-title: "" link: "" sections: - title: "" sub-title: "" link: "setup-team" sections:  - title: "Table Of Contents - Translation Manual Volume 1" sub-title: "This page answers the question: What is in Volume 1 of the translation manual?" sections: 
Alternatively you can choose to use a simplified table of contents as shown below.
We may deprecate this form due to the addition of content sorting instructions describe above. Since sorting is defined this form may not provide anything useful.
--- - chapter: '01' chunks: - title - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - reference - chapter: '02' chunks: - title - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - reference
The simple version will rely on the available content (titles, references, etc.) to generate the table of contents (readable titles will be retrieved from the content itself).