Skip to content

Commit

Permalink
DOCS: indicate top-level schemas (#201)
Browse files Browse the repository at this point in the history 
DOCS: indicate top-level schemas in the $comment field (closes #201)
  • Loading branch information
@dwhieb
dwhieb authored Oct 11, 2018
1 parent 2530024 commit 2909e97
Show file tree
Hide file tree
Showing 44 changed files with 65 additions and 43 deletions.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ The following is a list of principles and best practices to keep in mind when wo

* The schemas support both [internet date and date-time formats][12], but date-time format is strongly recommended.

* **Documents**

* The DLx format is designed to work well with _document databases_, where each item is stored as a single document (typically in JSON) rather than as records in a table. Schemas that include a comment that they are top-level database objects should be their own documents in the database. Other schemas will be subparts of those documents.

## Tests

Tests are run using [Jasmine][10] in Node.js. Run them from the command line using `npm test`.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ <h2>Maintainers</h2>
<nav>
<h1>Schemas</h1>
<ul>
<li><a href="schemas/Abbreviation.html">Abbreviation</a></li><li><a href="schemas/Access.html">Access Rights</a></li><li><a href="schemas/Address.html">Address</a></li><li><a href="schemas/Bundle.html">Bundle</a></li><li><a href="schemas/BibliographicReference.html">Bibliographic Reference</a></li><li><a href="schemas/Annotation.html">Annotation</a></li><li><a href="schemas/DatabaseReference.html">Database Reference</a></li><li><a href="schemas/Language.html">Language</a></li><li><a href="schemas/Location.html">Location</a></li><li><a href="schemas/Media.html">Media File</a></li><li><a href="schemas/Morpheme.html">Morpheme Token</a></li><li><a href="schemas/MultiLangString.html">Multi-Language Text / String</a></li><li><a href="schemas/Note.html">Note</a></li><li><a href="schemas/Person.html">Person</a></li><li><a href="schemas/Orthography.html">Orthography</a></li><li><a href="schemas/Reference.html">Bibliographic Reference</a></li><li><a href="schemas/Tags.html">Tags</a></li><li><a href="schemas/Text.html">Text</a></li><li><a href="schemas/Transcription.html">Transcription</a></li><li><a href="schemas/Translation.html">Translation</a></li><li><a href="schemas/Utterance.html">Utterance</a></li><li><a href="schemas/Word.html">Word</a></li><li><a href="schemas/Phoneme.html">Phoneme</a></li><li><a href="schemas/Lexeme.html">Lexeme</a></li>
<li><a href="schemas/Abbreviation.html">Abbreviation</a></li><li><a href="schemas/Address.html">Address</a></li><li><a href="schemas/Access.html">Access Rights</a></li><li><a href="schemas/Annotation.html">Annotation</a></li><li><a href="schemas/BibliographicReference.html">Bibliographic Reference</a></li><li><a href="schemas/DatabaseReference.html">Database Reference</a></li><li><a href="schemas/Language.html">Language</a></li><li><a href="schemas/Bundle.html">Bundle</a></li><li><a href="schemas/Location.html">Location</a></li><li><a href="schemas/Media.html">Media File</a></li><li><a href="schemas/Morpheme.html">Morpheme Token</a></li><li><a href="schemas/MultiLangString.html">Multi-Language Text / String</a></li><li><a href="schemas/Person.html">Person</a></li><li><a href="schemas/Note.html">Note</a></li><li><a href="schemas/Orthography.html">Orthography</a></li><li><a href="schemas/Reference.html">Bibliographic Reference</a></li><li><a href="schemas/Tags.html">Tags</a></li><li><a href="schemas/Text.html">Text</a></li><li><a href="schemas/Transcription.html">Transcription</a></li><li><a href="schemas/Translation.html">Translation</a></li><li><a href="schemas/Word.html">Word</a></li><li><a href="schemas/Utterance.html">Utterance</a></li><li><a href="schemas/Phoneme.html">Phoneme</a></li><li><a href="schemas/Lexeme.html">Lexeme</a></li>
</ul>
</nav>

Expand Down
2 changes: 1 addition & 1 deletion docs/schemas/Abbreviation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ <h2>Description</h2>
<h1><a href=../index.html>Home</a></h1>
<h1>Schemas</h1>
<ul>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Address.html">Address</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Note.html">Note</a></li><li><a href="Person.html">Person</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Word.html">Word</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Address.html">Address</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Person.html">Person</a></li><li><a href="Note.html">Note</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Word.html">Word</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
</ul>
</nav>

Expand Down
2 changes: 1 addition & 1 deletion docs/schemas/Access.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ <h2>Default Value</h2>
<h1><a href=../index.html>Home</a></h1>
<h1>Schemas</h1>
<ul>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Address.html">Address</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Note.html">Note</a></li><li><a href="Person.html">Person</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Word.html">Word</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Address.html">Address</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Person.html">Person</a></li><li><a href="Note.html">Note</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Word.html">Word</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
</ul>
</nav>

Expand Down
2 changes: 1 addition & 1 deletion docs/schemas/Address.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ <h2>Description</h2>
<h1><a href=../index.html>Home</a></h1>
<h1>Schemas</h1>
<ul>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Address.html">Address</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Note.html">Note</a></li><li><a href="Person.html">Person</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Word.html">Word</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Address.html">Address</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Person.html">Person</a></li><li><a href="Note.html">Note</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Word.html">Word</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
</ul>
</nav>

Expand Down
2 changes: 1 addition & 1 deletion docs/schemas/Annotation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -758,7 +758,7 @@ <h2>Description</h2>
<h1><a href=../index.html>Home</a></h1>
<h1>Schemas</h1>
<ul>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Address.html">Address</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Note.html">Note</a></li><li><a href="Person.html">Person</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Word.html">Word</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Address.html">Address</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Person.html">Person</a></li><li><a href="Note.html">Note</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Word.html">Word</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
</ul>
</nav>

Expand Down
2 changes: 1 addition & 1 deletion docs/schemas/BibliographicReference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1351,7 +1351,7 @@ <h2>Description</h2>
<h1><a href=../index.html>Home</a></h1>
<h1>Schemas</h1>
<ul>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Address.html">Address</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Note.html">Note</a></li><li><a href="Person.html">Person</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Word.html">Word</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Address.html">Address</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Person.html">Person</a></li><li><a href="Note.html">Note</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Word.html">Word</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
</ul>
</nav>

Expand Down
2 changes: 1 addition & 1 deletion docs/schemas/Bundle.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@ <h2>Description</h2>
<h1><a href=../index.html>Home</a></h1>
<h1>Schemas</h1>
<ul>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Address.html">Address</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Note.html">Note</a></li><li><a href="Person.html">Person</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Word.html">Word</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
<li><a href="Abbreviation.html">Abbreviation</a></li><li><a href="Address.html">Address</a></li><li><a href="Access.html">Access Rights</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="BibliographicReference.html">Bibliographic Reference</a></li><li><a href="DatabaseReference.html">Database Reference</a></li><li><a href="Language.html">Language</a></li><li><a href="Bundle.html">Bundle</a></li><li><a href="Location.html">Location</a></li><li><a href="Media.html">Media File</a></li><li><a href="Morpheme.html">Morpheme Token</a></li><li><a href="MultiLangString.html">Multi-Language Text / String</a></li><li><a href="Person.html">Person</a></li><li><a href="Note.html">Note</a></li><li><a href="Orthography.html">Orthography</a></li><li><a href="Reference.html">Bibliographic Reference</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Text.html">Text</a></li><li><a href="Transcription.html">Transcription</a></li><li><a href="Translation.html">Translation</a></li><li><a href="Word.html">Word</a></li><li><a href="Utterance.html">Utterance</a></li><li><a href="Phoneme.html">Phoneme</a></li><li><a href="Lexeme.html">Lexeme</a></li>
</ul>
</nav>

Expand Down
Loading

0 comments on commit 2909e97

Please sign in to comment.