.. include:: /_static/inc_styles.txt Text Metadata ============= All key translation project metadata is provided in a DBL **text release bundle** within a file named ``metadata.xml``. The format of this file is described below. .. note:: **Documentation Syntax Notes** Information about individual elements and attributes for XML files within DBL bundles is provided with the following components. Not every component is needed or supplied for each element. * **Element Description Table:** * Required is indicated using a red asterisk (|req|). A plus (+) sign indicates that multiple elements are allowed. * Element attributes are indicated by an "at" symbol **@** * Element or attribute values which are supplied by Paratext are marked with a green checkmark (|ico_Cg|). Any values supplied for these elements through an external metadata.xml file will be overwritten by Paratext during the DBL submission. * **Diagram:** A schema diagram is supplied wherever it will assist with clarity; not for every element. * **Notes:** Other relevant information not visible in the element description table. * **Sample:** An XML sample for the element. * **Child Elements:** A list of child elements. Values for some metadata elements are restricted by the metadata schema to a pattern or a specific vocabulary. These named patterns (vocabularies) are listed at the end of this document. .. _text-metadata_DBLMetadata: ------------- :Element: DBLMetadata |req| |br| *empty* :Added: 1.1 :Use: Root element for the DBL metadata container. :@type: DBL release bundle type. |req| |ico_Cg| |br| ``text | print | audio | video`` :@typeVersion: Version of the release bundle type. |req| |ico_Cg| |br| xsd:decimal |br| Only the specific revision number for the bundle data being encoded is allowed. (1.1, 1.2, 2.0 etc.) :@id: Unique ID for the DBL entry. |req| |ico_Cg| |br| A unique 16 character hex digit. :@revision: Revision of the data for the entry contained within this bundle. |req| |ico_Cg| |br| xsd:integer :Parent: **ROOT** The following schema diagram displays the basic structure of the text metadata file. Diagram """"""" .. image:: images/metadata_DBLMetadata.png .. note:: The @typeVersion attribute is used to define a specific layout and file syntax for a specific bundle type. Bundles with an identical typeVersion will contain the same layout and file syntax. Publishers who are creating tools to consume DBL bundles can use the @typeVersion attribute to verify that their toolset is capable of handling a downloaded bundle. A new data upload for a project already present in the DBL will generate a new @revision for the entry. Metadata only uploads to the DBL do not generate a new @revision. Sample """""" .. code-block:: xml Child Elements (DBLMetdata) ^^^^^^^^^^^^^^^^^^^^^^^^^^^ * :ref:`text-metadata_identification` * :ref:`text-metadata_confidential` * :ref:`text-metadata_agencies` * :ref:`text-metadata_language` * :ref:`text-metadata_country` * :ref:`text-metadata_type` * :ref:`text-metadata_bookNames` * :ref:`text-metadata_contents` * :ref:`text-metadata_progress` * :ref:`text-metadata_contact` * :ref:`text-metadata_copyright` * :ref:`text-metadata_promotion` * :ref:`text-metadata_archiveStatus` * :ref:`text-metadata_format` .. _text-metadata_identification: ---------------- :Element: identification |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying the primary metadata used for identifying and naming the scripture project text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_identification.png Sample """""" .. code-block:: xml Good News Translation Good News Translation eng-GNT GNT Bible with Deuterocanon English Good News Translation Bible with Deuterocanon 1992-10-01 401d0abc-018b-4036-81b7-13845ace8612 66f69e2e951292b7d66582d3e2444332f641775b Paratext/7.3.500.122 .. _text-metadata_identification-children: Child Elements (identification) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :Element: name |req| |br| xsd:string :Added: 1.1 :Use: Preferred/common name used to refer to the scripture text (English) :Parent: :ref:`text-metadata_identification` ----- :Element: nameLocal |br| xsd:string :Added: 1.1 :Use: Preferred/common name used to refer to the scripture text (vernacular). Defaults to :t:`name`. :Parent: :ref:`text-metadata_identification` ----- :Element: abbreviation |req| |br| xsd:string of pattern ``[A-Za-z0-9\-]{2,8}`` :Added: 1.1 :Use: Preferred/common abbreviation used to refer to the scripture text (English) :Parent: :ref:`text-metadata_identification` ----- :Element: abbreviationLocal |req| |br| xsd:string of pattern ``[A-Za-z0-9\-]{2,8}`` :Added: 1.1 :Use: Preferred/common abbreviation used to refer to the scripture text (vernacular). Defaults to :t:`abbreviation`. :Parent: :ref:`text-metadata_identification` ----- :Element: scope |req| |br| ``Bible with Deuterocanon`` | |br| ``Bible without Deuterocanon`` | |br| ``New Testament and Psalms`` | |br| ``New Testament and Shorter Old Testament`` | |br| ``New Testament only`` | |br| ``Old Testament only`` | |br| ``Old Testament with Deuterocanon`` | |br| ``Shorter Old Testament only`` | |br| ``Study Bible`` | |br| ``Portion only`` | |br| ``Selection only`` :Added: 1.1 :Use: Coverage of the canon of scripture :Parent: :ref:`text-metadata_identification` ----- :Element: description |req| |br| xsd:string :Added: 1.1 :Use: Free form description of the scripture text. :Parent: :ref:`text-metadata_identification` ----- :Element: dateCompleted |br| xsd:date | xsd:gYear | xsd:gYearMonth | xsd:dateTime :Added: 1.1 :Use: Date of completion or initial publication of the scripture translation. :Parent: :ref:`text-metadata_identification` ----- :Element: systemId |req| |ico_Cg| |br| xsd:string :Use: A unique ID used to refer to the scripture text resource within a specific organizational database or software system. :@type: System type |req| |br| ``tms`` | ``paratext`` |ico_Cg| | ``reap`` | ``biblica`` :Parent: :ref:`text-metadata_identification` ----- :Element: bundleProducer |req| |ico_Cg| |br| xsd:string :Use: Software or process used to produce the text release bundle. :Parent: :ref:`text-metadata_identification` .. _text-metadata_confidential: -------------- :Element: confidential |req| |br| xsd:boolean (``true`` | ``false``) :Added: 1.1 :Use: Indicates whether the scripture text should be visible within the general DBL catalog (false), OR only visible to its owning organization users, or to licensee organization users with the DBL Publisher role. (true) :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_confidential.png Sample """""" .. code-block:: xml false .. _text-metadata_agencies: ---------- :Element: agencies |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for identifying the agencies involved in developing and publishing the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_agencies.png Sample """""" .. code-block:: xml UBS American Bible Society United Bible Societies American Bible Society American Bible Society .. _text-metadata_agencies-children: Child Elements (agencies) ^^^^^^^^^^^^^^^^^^^^^^^^^ :Element: etenPartner |br| xsd:string :Added: 1.1 :Use: The “Every Tribe Every Nation” (ETEN) partner known as the primary creator or authorized publisher of the scripture text. :Parent: :ref:`text-metadata_agencies` ----- :Element: contributor |req| + |br| xsd:string :Added: 1.1 :Modified: 1.4 :Use: One or more agencies partnering in the development and publication of the scripture text. :@type: Area of the agency's contribution |req| ``content`` | ``finance`` | ``management`` | ``publication`` | ``qa`` :Parent: :ref:`text-metadata_agencies` .. _text-metadata_language: ---------- :Element: language |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying language related information about the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_language.png .. note:: scriptDirection is supplied by Paratext. Any value supplied for this element through an external metadata.xml file for a submission to DBL will be overwritten by Paratext. Sample """""" .. code-block:: xml eng English en-US LTR Arabic .. _text-metadata_language-children: Child Elements (language) ^^^^^^^^^^^^^^^^^^^^^^^^^ :Element: iso |req| |br| xsd:string of pattern ``[a-z]{3}`` :Added: 1.1 :Use: ISO 639-3 3-letter code for the language of the scripture text. |br| **References:** |br| http://www.sil.org/iso639-3/codes.asp :Parent: :ref:`text-metadata_language` ----- :Element: name |req| |br| xsd:string :Added: 1.1 :Use: ISO 639-3 full written name for the language of the scripture text. |br| **References:** |br| http://www.sil.org/iso639-3/codes.asp :Parent: :ref:`text-metadata_language` ----- :Element: ldml |ico_Cg| |br| xsd:string of pattern ``[A-Za-z]{2,3}([\-_][A-Za-z0-9]+){0,3}`` :Added: 1.1 :Use: Unicode language identifier. Not required, but may be needed in order to distinguish the language of the scripture text from a text in the same language,but from another region, or using another writing system (e.g. en-US vs en-GB). Paratext generated DBL text bundles are supplied this value from the ‘Language Identifier’ field of the selected project’s properties. |br| **References:** |br| http://unicode.org/reports/tr35/#Unicode_Language_and_Locale_Identifiers |br| http://unicode.org/cldr/utility/languageid.jsp |br| http://www.w3.org/International/questions/qa-choosing-language-tags :Parent: :ref:`text-metadata_language` ----- :Element: rod |br| xsd:string of pattern ``[0-9]{5}`` :Added: 1.1 :Use: Dialect code taken from the Harvest Information Sysyems (HIS) Registry of Dialects (ROD). |br| A ROD code may be needed (in addition to language/ldml) in order to distinguish the specific dialect of the language of the scripture text from others within the DBL. |br| **References:** |br| http://globalrecordings.net/research/rod :Parent: :ref:`text-metadata_language` ----- :Element: script |req| |br| *empty* | ``Arabic`` | ``Arabic (Modified)`` | ``Armenian`` | ``Assamese`` | ``Bengali`` | ``Burmese`` | ``Chinese (Simplified)`` | ``Chinese (Traditional)`` | ``Cyrillic`` | ``Cyrillic (Modified)`` | ``Devanagari`` | ``Ethiopic`` | ``Georgian`` | ``Greek`` | ``Gurmukhi`` | ``Hebrew`` | ``Japanese`` | ``Khmer`` | ``Korean`` | ``Latin`` | ``Persian`` | ``Persian (Modified)`` | ``Pollard`` | ``Syllabic`` | ``Syriac`` | ``Syriac`` | ``Thai`` | ``Tibetan`` :Added: 1.1 :Use: Name of the script used for composing the scripture text. Presently the names are taken from a UBS TMS listing of script names. (Script names should be migrated to ISO 15924 4 letter script codes in a future text bundle specification update.) :Parent: :ref:`text-metadata_language` ----- :Element: scriptDirection |req| |br| ``LTR`` (Left to Right) | ``RTL`` (Right to Left) :Added: 1.1 :Use: Script direction :Parent: :ref:`text-metadata_language` ----- :Element: numerals |req| |br| *empty* | one of :ref:`numeralSystem ` :Added: 1.1 :Use: Preferred numbering system to use for rendering digits in the scripture text. Publishers should use this information for providing the correct presentation of chapter and verse numbers, which are always provided in USX and ‘num’ attributes in Arabic script. :Parent: :ref:`text-metadata_language` .. _text-metadata_country: --------- :Element: country |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying country related information about the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_country.png Sample """""" .. code-block:: xml USA United States .. _text-metadata_country-children: Child Elements (country) ^^^^^^^^^^^^^^^^^^^^^^^^ :Element: iso |req| |br| xsd:string of pattern ``[a-z]{2,3}`` :Added: 1.1 :Use: ISO 3166 2-letter code for the/a primary country where the language of the scripture text is used. In cases where the language is a primary language used in more than one country, the code for the country where the creator or publisher is located should be supplied. |br| **References:** http://www.iso.org/iso/country_codes/iso_3166_code_lists.htm :Parent: :ref:`text-metadata_country` ----- :Element: name |req| |br| xsd:string :Added: 1.1 :Use: ISO 3166 full written name for the/a primary country where the language of the scripture text is used. In cases where the language is a primary language used in more than one country, the name for the country where the creator or publisher is located should be supplied. |br| **References:** http://www.iso.org/iso/country_codes/iso_3166_code_lists.htm :Parent: :ref:`text-metadata_country` .. _text-metadata_type: ------ :Element: type |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying translation type related information for the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_type.png Sample """""" .. code-block:: xml Revision Common .. _text-metadata_type-children: Child Elements (type) ^^^^^^^^^^^^^^^^^^^^^ :Element: translationType |req| |br| *empty* | one of :ref:`translationType ` :Added: 1.1 :Use: Translation type :Parent: :ref:`text-metadata_type` ----- :Element: audience |req| |br| *empty* | one of :ref:`translationLevel ` :Added: 1.1 :Use: Language level :Parent: :ref:`text-metadata_type` .. _text-metadata_bookNames: ----------- :Element: bookNames |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying vernacular Biblical book naming information for the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_bookNames.png .. note:: :ref:`bookNames ` and the child :ref:`book ` elements provide information on the vernacular text to use for various forms of the Biblical books names found in the scripture text. books are listed in a default order, and do not necessarily represent a valid publication order. |br| |br| The contents element provides bookLists in which the 3-letter book codes are supplied in the correct order for one or more known publications of the scripture text. Sample """""" .. code-block:: xml GENESIS Genesis Gn … other book elements … THE REVELATION to John Revelation Rev .. _text-metadata_bookNames-children: Child Elements (bookNames) ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_bookNames_book: :Element: book |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying long, short, and abbr (abbreviation) vernacular names for Biblical books in the scripture text. :@code: The 3-letter book code for for which vernacular names are being supplied in the child elements. |req| |br| one of :ref:`bookCode ` :Parent: :ref:`text-metadata_bookNames` .. _text-metadata_bookNames_book-children: Child Elements (book) ^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_bookNames_book_long: :Element: long |req| |ico_Cg| |br| *empty* | xsd:string :Added: 1.1 :Use: Vernacular text for the long form of the name for the Biblical book. :Parent: :ref:`text-metadata_bookNames` ----- .. _text-metadata_bookNames_book_short: :Element: short |req| |ico_Cg| |br| *empty* | xsd:string :Added: 1.1 :Use: Vernacular text for the shorter form of the name for the Biblical book. This is the text typically used for the running header reference text in a printed volume, or for the text to appear for the book name in a digital navigation (menu) system. :Parent: :ref:`text-metadata_bookNames` ----- .. _text-metadata_bookNames_book_abbr: :Element: abbr |req| |ico_Cg| |br| *empty* | xsd:string :Added: 1.1 :Use: Vernacular text for the abbreviated form of the name for the Biblical book. This is the text typically used within reference lists found in cross references, indexes, or concordances. :Parent: :ref:`text-metadata_bookNames` .. note:: `Paratext `_ will supply :ref:`long `, :ref:`short `, and :ref:`abbr ` strings to the metadata if they have been configured for the project using the Project > Scripture Reference Settings dialog. If the scripture text had already included \toc1, \toc2, and/or \toc3 markers, the content for these will be gathered into the corresponding Scripture Reference Settings fields on its initial use. .. _text-metadata_contents: ---------- :Element: contents |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying one or more bookList elements in which divisions and book codes are supplied in the correct order for known publications of the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_contents.png .. hint:: **General Explanation of the text bundle section:** One or more contents/bookList elements are used to provide a table of contents listing for specific publications (or "canons") which can be generated from the text bundle contents. The sequence of the divisions and book elements within each division indicates the correct sequential order for books within a specific publication. The name, nameLocal, abbreviation, and abbreviationLocal elements within a bookList are used to provide the same type of content information as they are within the :ref:`text-metadata_identification` element context. Every bookList contains a unique integer @id. If an entry contains multuple bookLists, the description fields should also be unique among them. description can be used to praticually distinguish (for an end-user) bookLists which may possibly use the same name and abbreviation -- for example GNT "Protestant Edition" and GNT "Catholic Edition". There should always be one bookList with the attribute @default="true", which is the content which should be published if only one bookList is selected from many. Sample """""" .. code-block:: xml Good News Translation Good News Translation eng-GNT GNT Western Protestant Bible Protestant Bible (66 books) Western Protestant order … remaining list of OT elements … … remaining list of NT elements … Good News Translation with Deuterocanonicals/Apocrypha Good News Translation with Deuterocanonicals/Apocrypha eng-GNTD GNTD Ecumenical Bible with combined Catholic DCs + Anglican KJV Apocrypha Interconfessional Bible with DC/ Apocrypha section Bible with Catholic DCs + 3 KJV Apocryphal books … list of OT elements … … list of DC elements … … list of NT elements … .. _text-metadata_contents-children: Child Elements (contents) ^^^^^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_bookList: :Element: booklist |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying one or more division elements, within which book codes are supplied in the correct order for a known specific publication of the scripture text. :@id: Set id="default" for the bookList which should be published by default, if only one of multiple bookLists (publications) supplied in the contents element is published. |br| *none* | ``default`` :Parent: :ref:`text-metadata_contents` .. _text-metadata_bookList-children: Child Elements (bookList) ^^^^^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_bookList_name: :Element: name |req| |br| *empty* | ``xsd:string`` :Added: 1.1 :Use: Preferred/common name used to refer to the scripture text (English) :Parent: :ref:`

` ----- .. _text-metadata_bookList_nameLocal: :Element: nameLocal |req| |br| *empty* | ``xsd:string`` :Added: 1.1 :Use: Preferred/common name used to refer to the scripture text (vernacular). Defaults to :ref:`name `. :Parent: :ref:`

` ----- .. _text-metadata_bookList_abbreviation: :Element: abbreviation |req| |br| *empty* | ``xsd:string`` :Added: 1.1 :Use: Preferred/common abbreviation used to refer to the scripture text (English) :Parent: :ref:`

` ----- .. _text-metadata_bookList_abbreviationLocal: :Element: abbreviationLocal |req| |br| *empty* | ``xsd:string`` :Added: 1.1 :Use: Preferred/common abbreviation used to refer to the scripture text (vernacular). Defaults to :ref:`abbreviation `. :Parent: :ref:`

` ----- .. _text-metadata_bookList_tradition: :Element: tradition |req| |br| *empty* | ``xsd:string`` :Added: 1.1 :Use: Description of the church tradition for which this :ref:`bookList ` is commonly in use. :Parent: :ref:`

` ----- .. _text-metadata_bookList_division: :Element: division |req| |br| *empty* :Added: 1.1 :Use: Contains a single child :ref:`books ` element within which :ref:`book ` elements are supplied in the correct order for a specific portion (the current division) of the scripture text. :@id: Identifies which portion of the scripture canon the list of books is for. |req| |br| ``OT`` | ``NT`` | ``DC`` :Parent: :ref:`

` .. _text-metadata_bookList_division-children: Child Elements (division) +++++++++++++++++++++++++ .. _text-metadata_bookList_division_books: :Elenent: books |req| |br| *empty* :Added: 1.1 :Use: Contains one or more child book elements in the correct order for the current division of the scripture text. :Parent: :ref:`

` .. _text-metadata_bookList_division_books-children: Child Elements (books) ++++++++++++++++++++++ .. _text-metadata_bookList_division_books_book: :Element: book |req| |br| *empty* :Added: 1.1 :Use: One or more book elements are supplied in publication order for the current division of the scripture text. :@code: 3-letter book code. |req| |br| one of :ref:`bookCode ` :Parent: :ref:`

` .. _text-metadata_progress: ---------- :Element: progress |br| *empty* :Added: 1.1 :Use: Contains child book elements for supplying information on text development progress using one of 4 stage values. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_progress.png .. note:: **Background on project progress**: The :ref:`progress ` element is optional. It is not yet clear how this metadata might be used by publishers. It has been included in the DBL text release bundle specification to provide basic support for the concept of “incremental publishing”. In this mode a translation project may wish to release text for review (in digital or print publication format) as a work in progress. A completion stage could be used to identify which text(s) within a text bundle archive are ready for trial publication, and possibly to which audience. `Paratext `_ provides a project progress tracking utility which assist teams with managing and reporting on translation progress. Within a typical translation project, each book passes through multiple “stages”. The project progress tracking utility defines 4 commonly-used default stages. Sample """""" .. code-block:: xml ... .. _text_metadata-progress-children: Child Elements (progress) ^^^^^^^^^^^^^^^^^^^^^^^^^ .. _text_metadata_progress_book: :Element: book |req| |ico_Cg| |br| *empty* :Added: 1.1 :Use: One or more book elements are supplied in publication order for the current division of the scripture text. :@code: 3-letter book code |req| |ico_Cg| |br| one of :ref:`bookCode ` :@stage@: Translation stage completed for book. |req| |ico_Cg| |br| one of :ref:`translationStage ` :Parent: :ref:`text-metadata_DBLMetadata` .. _text-metadata_contact: --------- :Element: contact |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying contact information for the agency responsible for publication rights related to the scripture text. :Parext: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_contact.png Sample """""" .. code-block:: xml American Bible Society American Bible Society ABS http://www.americanbible.org http://www.facebook.com/americanbible .. _text-metadata_contact-children: Child Elements (contact) ^^^^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_contact_rightsHolder: :Element: rightsHolder |req| |br| ``xsd:string`` :Added: 1.1 :Use: Agency responsible for publication rights related to the scripture text (English). Often the same as creator and/or publisher. :Parent: :ref:`text-metadata_contact` .. _text-metadata_contact_rightsHolderLocal: ----- :Element: rightsHolderLocal |br| ``xsd:string`` :Added: 1.1 :Use: Agency responsible for publication rights related to the scripture text (vernacular). :Parent: :ref:`text-metadata_contact` .. _text-metadata_contact_rightsHolderAbbreviation: ----- :Element: rightsHolderAbbreviation |br| ``xsd:string`` :Added: 1.1 :Use: Preferred/common abbreviation used to refer to the rightsHolder agency. :Parent: :ref:`text-metadata_contact` .. _text-metadata_contact_rightsHolderURL: ----- :Element: rightsHolderURL |br| ``xsd:anyURI`` :Added: 1.1 :Use: Public Internet website address for the rightsHolder agency. :Parent: :ref:`text-metadata_contact` .. _text-metadata_contact_rightsHolderFacebook: ----- :Element: rightsHolderFacebook |br| ``xsd:anyURI`` :Added: 1.1 :Use: Public Facebook address for the rightsHolder agency. :Parent: :ref:`text-metadata_contact` .. _text-metadata_copyright: ----------- :Element: copyright |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying copyright information for the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_copyright.png Sample """""" .. code-block:: xml

.. _text-metadata_copyright-children: Child Elements (copyright) ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_copyright_statement: :Element: statement |br| any :ref:`htmlMarkup ` :Added: 1.1 :Use: The short written copyright statement which should accompany any publication of the scripture text. :@contentType: Indicates the specific content format which this element contains. |req| |br| ``xhtml`` :Parent: :ref:`text-metadata_copyright` .. _text-metadata_promotion: ----------- :Element: promotion |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying background and promotion information related to the scripture text. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_promotion.png Sample """""" .. code-block:: xml

The Good News Translation of the Bible is a translation which seeks to state clearly and accurately the meaning of the original texts in words and forms that are widely accepted by people who use English as a means of communication. This translation does not follow the traditional vocabulary and style found in the historic English Bible versions. Rather it attempts for our time to set forth the biblical content and message in the standard, everyday, natural form of English.

The aim of this Bible is to give today's reader best possible understanding of the content of the original texts. The Preface sets forth the basic principles which the translators followed in their work and explains the nature of special aids for readers.

The bk Good News Translation was translated and published by the United Bible Societies for use throughout the world. The Bible Societies trust that the reading and study of this translation will result in a better understanding of the meaning of the Bible. We also earnestly pray that readers will discover the message of saving faith and hope for all people, which the Bible announces anew to each generation.

This is where we place the text to be emailed to the user after downloading an offline version. .. _text-metadata_promotion-children: Child Elements (promotion) ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_promotion_promoVersionInfo: :Element: promoVersionInfo |br| any :ref:`htmlMarkup ` :Added: 1.1 :Use: Introductory (promotional/background) information about the scripture text translation. :@contentType: Indicates the specific content format which this element contains. |req| |br| ``xhtml`` :Parent: :ref:`text-metadata_promotion` ----- .. _text-metadata_promotion_promoEmail: :Element: promoEmail |br| any :ref:`htmlMarkup ` :Added: 1.1 :Use: A promotional email message text which can be used to send to a new user of the text (for example - when the text is downloaded within a publishing application for offline use). :@contentType: Indicates the specific content format which this element contains. |req| |br| ``xhtml`` :Parent: :ref:`text-metadata_promotion` .. _text-metadata_archiveStatus: --------------- :Element: archiveStatus |req| |br| *empty* :Added: 1.1 :Use: Contains child elements for supplying a record of the submissions of the scripture text to the DBL. :Parent: :ref:`text-metadata_DBLMetadata` Diagram """"""" .. image:: images/metadata_archiveStatus.png Sample """""" .. code-block:: xml ... archivist name ... 2011-04-19T00:00:00 2011-06-24T00:00:00 Initial submission to DBL. .. _text-matadata_archiveStatus-children: Child Elements (archiveStatus) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _text-metadata_archiveStatus_archivistName: :Element: archivistName |req| |ico_Cg| |br| ``xsd:string`` :Added: 1.1 :Use: Name of the person making the submission to DBL. The "Registration Name" for the current user in Paratext is supplied automatically. :Parent: :ref:`text-metadata_archiveStatus` ----- .. _text-metadata_archiveStatus_dateArchived: :Element: dateArchived |req| |ico_Cg| |br| ``xsd:dateTime`` :Added: 1.1 :Use: Date of the original submission of this text to DBL. :Parent: :ref:`text-metadata_archiveStatus` ----- .. _text-metadata_archiveStatus_dateUpdated: :Element: dateUpdated |req| |ico_Cg| |br| ``xsd:dateTime`` :Added: 1.1 :Use: Date of the last update to this text within DBL. :Parent: :ref:`text-metadata_archiveStatus` ----- .. _text-metadata_archiveStatus_comments: :Element: dateUpdated |req| |ico_Cg| |br| ``xsd:string`` (maximum 255 characters) :Added: 1.1 :Use: Date of the last update to this text within DBL. :Parent: :ref:`text-metadata_archiveStatus` .. _text-metadata_format: -------- :Element: format |req| |ico_Cg| |br| ``text/xml`` :Added: 1.1 :Use: The file format (mime type) of the scripture text within the text bundle. :Parent: :ref:`text-metadata_DBLMetadata` .. == VOCABULARIES ============================================= .. _vocabularies: List of Named Patters (Vocabularies) ------------------------------------ .. note:: For each pattern, text in quotes are valid vocabulary selections. .. _vocab-htmlMarkup: :htmlMarkup: .. _vocab-htmlCharMarkup: :htmlCharMarkup: .. _vocab-numeralSystem: :numeralSystem: ``Arabic`` (a.k.a. 'Hindu') = 0123456789, ``Bengali``, ``Burmese``, ``Devanagari``, ``Ethiopic``, ``Farsi``, ``Gujarati``, ``Gurmukhi``, ``Hindi`` (i.e. 'Arabic' as used in Egypt), ``Kannada``, ``Khmer``, ``Malayalam``, ``Oriya``, ``Tamil``, ``Telugu``, ``Thai``, ``Tibetan`` .. _vocab-translationType: :translationType: ``First``, ``New``, ``Revision`` .. _vocab-translationLevel: :translationLevel: ``Basic``, ``Common``, ``Common - Literary``, ``Literary``, ``Liturgical`` .. _vocab-translationStage: :translationStage: ``1``, ``2``, ``3``, ``4`` |br| These numbers indicate a text being complete to the level of one of four commonly understood translation progress stages: * 1 = First draft (individual) * 2 = Team draft (following internal review) * 3 = Revised draft (following external review) * 4 = Check draft (following translation consultant checking and data format validation) .. _vocab-bookCode: :bookCode: **Old Testament** ``GEN`` - Genesis, ``EXO`` - Exodus, ``LEV`` - Leviticus, ``NUM`` - Numbers, ``DEU`` - Deuteronomy, ``JOS`` - Joshua, ``JDG`` - Judges, ``RUT`` - Ruth, ``1SA`` - 1 Samuel, ``2SA`` - 2 Samuel, ``1KI`` - 1 Kings, ``2KI`` - 2 Kings, ``1CH`` - 1 Chronicles, ``2CH`` - 2 Chronicles, ``EZR`` - Ezra, ``NEH`` - Nehemiah, ``EST`` - Esther (Hebrew), ``JOB`` - Job, ``PSA`` - Psalms, ``PRO`` - Proverbs, ``ECC`` - Ecclesiastes, ``SNG`` - Song of Songs, ``ISA`` - Isaiah, ``JER`` - Jeremiah, ``LAM`` - Lamentations, ``EZK`` - Ezekiel, ``DAN`` - Daniel (Hebrew), ``HOS`` - Hosea, ``JOL`` - Joel, ``AMO`` - Amos, ``OBA`` - Obadiah, ``JON`` - Jonah, ``MIC`` - Micah, ``NAM`` - Nahum, ``HAB`` - Habakkuk, ``ZEP`` - Zephaniah, ``HAG`` - Haggai, ``ZEC`` - Zechariah, ``MAL`` - Malachi |br| **New Testament** ``MAT`` - Matthew, ``MRK`` - Mark, ``LUK`` - Luke, ``JHN`` - John, ``ACT`` - Acts, ``ROM`` - Romans, ``1CO`` - 1 Corinthians, ``2CO`` - 2 Corinthians, ``GAL`` - Galatians, ``EPH`` - Ephesians, ``PHP`` - Philippians, ``COL`` - Colossians, ``1TH`` - 1 Thessalonians, ``2TH`` - 2 Thessalonians, ``1TI`` - 1 Timothy, ``2TI`` - 2 Timothy, ``TIT`` - Titus, ``PHM`` - Philemon, ``HEB`` - Hebrews, ``JAS`` - James, ``1PE`` - 1 Peter, ``2PE`` - 2 Peter, ``1JN`` - 1 John, ``2JN`` - 2 John, ``3JN`` - 3 John, ``JUD`` - Jude ``REV`` - Revelation |br| **Deuterocanon** ``TOB`` - Tobit, ``JDT`` - Judith, ``ESG`` - Esther Greek, ``WIS`` - Wisdom of Solomon, ``SIR`` - Sirach (Ecclesiasticus), ``BAR`` - Baruch, ``LJE`` - Letter of Jeremiah, ``S3Y`` - Song of 3 Young Men, ``SUS`` - Susanna, ``BEL`` - Bel and the Dragon, ``1MA`` - 1 Maccabees, ``2MA`` - 2 Maccabees, ``3MA`` - 3 Maccabees, ``4MA`` - 4 Maccabees, ``1ES`` - 1 Esdras (Greek), ``2ES`` - 2 Esdras (Latin), ``MAN`` - Prayer of Manasseh, ``PS2`` - Psalm 151, ``ODA`` - Odes, ``PSS`` - Psalms of Solomon, ``EZA`` - Apocalypse of Ezra, ``5EZ`` - 5 Ezra, ``6EZ`` - 6 Ezra, ``DAG`` - Daniel Greek, ``PS3`` - Psalms 152-155, ``2BA`` - 2 Baruch (Apocalypse), ``LBA`` - Letter of Baruch, ``JUB`` - Jubilees, ``ENO`` - Enoch ``1MQ`` - 1 Meqabyan, ``2MQ`` - 2 Meqabyan, ``3MQ`` - 3 Meqabyan, ``REP`` - Reproof ``4BA`` - 4 Baruch, ``LAO`` - Laodiceans |br| **Non scripture** ``XXA`` - Extra A, e.g. a hymnal, ``XXB`` - Extra B, ``XXC`` - Extra C, ``XXD`` - Extra D, ``XXE`` - Extra E, ``XXF`` - Extra F, ``XXG`` - Extra G, ``FRT`` - Front Matter, ``BAK`` - Back Matter, ``OTH`` - Other Matter, ``INT`` - Introduction, ``CNC`` - Concordance, ``GLO`` - Glossary, ``TDX`` - Topical Index, ``NDX`` - Names Index