From fceb29c23b63e9d08e58f6e817f67b6bd1d420e5 Mon Sep 17 00:00:00 2001 From: Jeff Klassen Date: Tue, 13 Feb 2018 16:41:44 -0500 Subject: [PATCH] Documentation for #21 and #22 (support for peripheral content) --- docs/elements.rst | 2 +- docs/peripherals/back.rst | 327 +++++++++++++++++++++++++++++++++++- docs/peripherals/front.rst | 274 +++++++++++++++++++++++++++++- docs/peripherals/intros.rst | 90 +++++++++- docs/peripherals/other.rst | 20 ++- 5 files changed, 695 insertions(+), 18 deletions(-) diff --git a/docs/elements.rst b/docs/elements.rst index afad7d6..1ea0ee3 100644 --- a/docs/elements.rst +++ b/docs/elements.rst @@ -509,7 +509,7 @@ Galatians 3 ----- -.. index:: element;
, attribute; periph@id, attribute; periph@alt +.. index:: element; , attribute; periph@id, attribute; periph@alt .. _usx-element_periph: diff --git a/docs/peripherals/back.rst b/docs/peripherals/back.rst index cefd1bc..77a99f0 100644 --- a/docs/peripherals/back.rst +++ b/docs/peripherals/back.rst @@ -1,39 +1,350 @@ .. include:: /_static/inc_styles.txt -.. index:: book@code; BAK, peripherals; Back Matter +.. index:: book@code; BAK, peripherals; Back Matter, back matter .. _usx-book_BAK: Back Matter =========== -```` +The BAK :ref:`book ` and its :ref:`divisions ` can be used for storing material which is typically presented at the end of a scripture publication. In practice some back matter content is large enough to require storing it in its own book file (:ref:`Concordance `, :ref:`Glossary `, :ref:`Topical Index `, :ref:`Names Index `). -The BAK book and its divisions can be used for storing material which is typically presented at the end of a scripture publication. In practice some back matter content is large enough to require storing it in its own book file (Concordance, Glossary, Topical Index, Names Index). +**General** + +Use the following :doc:`elements ` (or other appropriate USX elements and :doc:` ` or :doc:` ` @style types, as required) to create back matter information or introductory content for specific :ref:`divisions `. + +.. index:: periph@id; chron, peripherals; Chronology, chronology + +Chronology +^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`ip ` - Introduction paragraph. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:`` - For any tabular data. + +.. index:: periph@id; measures, peripherals; Weights and Measures, weights and measures + +Weights and Measures +^^^^^^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`ip ` - Introduction paragraph. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:`
` - For any tabular data. + +.. index:: periph@id; maps, peripherals; Map Index, map index + +Map Index +^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`ip ` - Introduction paragraph. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:`
` - For any tabular data. +* :ref:` ` @style type :ref:`xt ` - Index target references. + +**Text Sample** + +In the following example, the variable # represents the location of a page number, to be inserted during the typesetting process. + +.. code-block:: xml + :name: usx-peripherals_maps_example + :emphasize-lines: 4,55 + + + + English: Good News Translation 2nd Ed. 1992 + + Map Index + ... + This atlas contains the following maps. Since a number of these maps + are especially helpful when reading specific books of the Bible, some have also been + placed within the text of the Bible. The page number indicated below will help you find + these maps both within the text and within this atlas. +
+ + Map + Page + + + Ancient World + # + + + Egypt and Sinai + # + + + Division of Canaan + # + + + United Israelite Kingdom + # + + ... +
+ Index to Places + A + + + A + Baal Zephon + [B] + + + A + Babylon + [E] + + + B + Babylonia + [E] + + ... +
+ ... + + + +.. index:: periph@id; lxxquotes, peripherals; NT Quotes from LXX, NT quotes from LXX + +NT Quotes from LXX +^^^^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:` ` @style :ref:`s# ` - Paragraph. +* :ref:` ` @style :ref:`k ` - Keyword. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_lxxquotes_example + :emphasize-lines: 4,16 + + + + English: Good News Translation 2nd Ed. 1992 + + The writers of the New Testament generally quoted or paraphrased the + ancient Greek translation of the Old Testament, commonly known as the Septuagint + Version (LXX), made some two hundred years before the time of Christ. + ... + Matthew 1.23 (Isaiah 7.14) A virgin will become + pregnant and have a son. + Matthew 3.3 (Isaiah 40.3) Someone is shouting in + the desert, “Prepare a road for the Lord; make a straight path for our God to travel!” + Matthew 12.21 (Isaiah 42.4) And on him all people + will put their hope. + ... + + ----- -The following back matter content should each be created within their own book file. +The following back matter content should each be created within their own :ref:`book ` file. .. _usx-book_CNC: -.. index:: concordance, book@code; CNC +.. index:: book@code; CNC, peripherals; concordance, concordance Concordance ^^^^^^^^^^^ +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`ip ` - Introduction paragraph. +* :ref:` ` @style :ref:`s# ` - Section heading (e.g. headings of alphabetical divisions - "A", "B", "C" etc.) +* :ref:` ` @style :ref:`p ` - Main entry + example "cut string" *(required)*. +* :ref:` ` @style :ref:`k ` - Main entry keyword *(required)*. +* :ref:` ` @style :ref:`d ` - Keyword description. +* :ref:` ` @style type :ref:`xt ` - Entry target reference(s) *(required)*. Use of :ref:` ` elements in the text sample is optional. +* :ref:` ` @style :ref:`bd ` - Highlight of the main entry within the cut string (bold). +* :ref:` ` @style :ref:`pi# ` - Sub-entries, or secondary paragraph(s) (if indentation is preferred). +* :ref:` ` @style :ref:`add ` - Grammar abbreviation (optional). +* :ref:`` - For any tabular data. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_cnc_example + :emphasize-lines: 3 + + + + + Concordance + The entries in this concordance have been carefully selected by a team of + editors. They have aimed to include all of the verses most likely to be looked up. + A concordance of this size cannot include every occurrence of each + individual word. + ... + A + Abandon + Lev 19.4Do not + abandon me and worship idols. + Deu 31.6He will not fail you + or abandon you.” + Deu 32.15They + abandoned God their Creator + ... + Able + Exo 31.3 understanding, skill, + and ability + Dan 3.17 If the God whom we + serve is able + Mat 26.61 and said, “This man said, + ‘I am able + ... + B + ... + + .. _usx-book_GLO: -.. index:: glossary, book@code; GLO +.. index:: book@code; GLO, peripherals; Glossary, glossary Glossary ^^^^^^^^ +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`ip ` - Introduction paragraph. +* :ref:` ` @style :ref:`s# ` - Section heading (e.g. headings of alphabetical divisions - "A", "B", "C" etc.) +* :ref:` ` @style :ref:`p ` - Main entry *(required)*. May also be used for any additional paragraphs in the definition entry (optional). +* :ref:` ` @style :ref:`k ` - Main entry keyword *(required)*. +* :ref:` ` @style :ref:`pi# ` - Sub-entries, or secondary paragraph(s) (if indentation is preferred). +* :ref:` ` @style :ref:`li# ` - List item. +* :ref:` ` @style :ref:`tl ` - National idiom word(s). + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_glo_example + :emphasize-lines: 3 + + + + + Glossary + This dictionary is divided into 21 sections. The indexes below list all of the + sections, and all of the entries in alphabetical order, so that you can find what you + are looking for more easily. + A + AngelA supernatural being who tells God's + messages to people or protects those who belong to God. + ... + C + Council(1) A group of leaders who meet and make decisions + for their people. + (2) The Old Testament refers to God's council as a group of angels who meet and + talk with God in heaven. + ... + + .. _usx-book_TDX: -.. index:: topical index, book@code; TDX +.. index:: book@code; TDX, peripherals; Topical Index, topical index Topical Index ^^^^^^^^^^^^^ +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`ip ` - Introduction paragraph. +* :ref:` ` @style :ref:`s# ` - Section heading (e.g. headings of alphabetical divisions - "A", "B", "C" etc.) +* :ref:` ` @style :ref:`p ` - Main entry *(required)*. May also be used for any additional paragraphs in the definition entry (optional). +* :ref:` ` @style :ref:`k ` - Main entry keyword *(required)*. +* :ref:` ` @style type :ref:`xt ` - Entry target reference(s) *(required)*. More than one ... element can be provided to create logical groupings of references (per chapter; per book etc.). Use of :ref:` ` elements in the text sample is optional. +* :ref:` ` @style :ref:`pi# ` - Sub-entries, or secondary paragraph(s) (if indentation is preferred). +* :ref:` ` @style :ref:`li# ` - Use for simple lists, where more complex tabular layout is not required. +* :ref:`
` - For any tabular data. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_tdx_example + :emphasize-lines: 3 + + + + + Topical Index + Introductory paragraph(s) + ... + A + Aaron + Act 7.40 + Heb 5.4; 7.11; + 9.4 + + ... + Angels + (a) messengers and agents of God + Mat 1.20-24; 4.11; + 13.39,41, + 49; 16.27; + 34.31; 25.31; + 28.2-7 + Luk 1.11-19; + 26-38; 2.9-21 + Jhn 1.51 + + ... + (b) in heaven + Mat 22.30 + Luk 12.8-9; 15.10; + 20.36 + + ... + + + .. _usx-book_NDX: -.. index:: names index, book@code; NDX +.. index:: book@code; NDX, peripherals; Names Index, names index Names Index ^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`is# ` - Introduction heading. +* :ref:` ` @style :ref:`ip ` - Introduction paragraph. +* :ref:` ` @style :ref:`s# ` - Section heading (e.g. headings of alphabetical divisions - "A", "B", "C" etc.) +* :ref:` ` @style :ref:`p ` - Main entry *(required)*. May also be used for any additional paragraphs in the definition entry (optional). +* :ref:` ` @style :ref:`k ` - Main entry keyword *(required)*. +* :ref:` ` @style type :ref:`xt ` - Entry target reference(s) *(required)*. More than one ... element can be provided to create logical groupings of references (per chapter; per book etc.). Use of :ref:` ` elements in the text sample is optional. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_ndx_example + :emphasize-lines: 3 + + + + + Names Index + Introductory paragraph(s) ... + ... + A + Aaron + Exo 4.14-30 (x5) + Exo 5.1-21 (x5) + + ... + Abraham + See Also + Abram + Gen 17.5-27 (x8) + Gen 18.1-33 (x15) + + ... + B + Baal + Num 22.41 + Num 25.3-5 (x2) + + \ No newline at end of file diff --git a/docs/peripherals/front.rst b/docs/peripherals/front.rst index c8c2967..050ab83 100644 --- a/docs/peripherals/front.rst +++ b/docs/peripherals/front.rst @@ -1,7 +1,275 @@ .. include:: /_static/inc_styles.txt -.. index:: book@code; FRT, peripherals; Front Matter +.. index:: book@code; FRT, peripherals; Front Matter, front matter .. _usx-book_FRT: -Front Matter ( @code FRT) -=============================== +Front Matter +============ + +The FRT :ref:`book ` and its :ref:`divisions ` can be used for storing material which is typically presented at the start of a scripture publication, before the first book of scripture. + +**General** + +Use the following :doc:`elements ` (or other appropriate USX elements and :doc:` ` or :doc:` ` @style types, as required) to create front matter information or introductory content for specific :ref:`divisions `. + +.. index:: periph@id; title, peripherals; Title Page, title page + +Title Page +^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`pc ` - Centered paragraph. +* :ref:`
` - Figure. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_title_example + :emphasize-lines: 4,16 + + + + + + Holy Bible + with + Deuterocanonicals/Apocrypha + Good News Translation + +
+ + +
+ + American Bible Society + + + +.. index:: periph@id; halftitle, peripherals; Half Title Page, half title page + +Half Title Page +^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`pc ` - Centered paragraph. +* :ref:`
` - Figure. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_halftitle_example + :emphasize-lines: 4,10 + + + + + + Holy Bible + Good News Translation + +
+ + + + +.. index:: periph@id; promo, peripherals; Promotional Page, promotional page + +Promotional Page +^^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:` ` @style :ref:`p ` - Paragraph. +* :ref:` ` @style :ref:`m ` - Flush left (margin) paragraph. +* :ref:` ` @style :ref:`pi# ` - Indented paragraph. +* :ref:` ` @style :ref:`li# ` - List item. +* :ref:` ` @style :ref:`q# ` - Poetic line. + +.. index:: periph@id; imprimatur, peripherals; Imprimatur, imprimatur + +Imprimatur +^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`pc ` - Centered paragraph. +* :ref:` ` @style :ref:`p ` - Paragraph. +* :ref:`
` - For any tabular data. +* :ref:`
` - Figure. + +.. index:: periph@id; pubdata, peripherals; Publication Data, publication data + +Publication Data +^^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`pc ` - Centered paragraph. +* :ref:` ` @style :ref:`p ` - Paragraph. +* :ref:`
` - For any tabular data. + +.. index:: periph@id; foreword, peripherals; Foreword, foreword + +Foreword +^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:` ` @style :ref:`p ` - Paragraph. +* :ref:` ` @style :ref:`m ` - Flush left (margin) paragraph. +* :ref:` ` @style :ref:`pi# ` - Indented paragraph. +* :ref:` ` @style :ref:`li# ` - List item. +* :ref:` ` @style :ref:`q# ` - Poetic line. +* :ref:`
` - For any tabular data. +* :ref:` ` @style :ref:`bk `, :ref:`qt `, :ref:`tl ` or other @style types. +* :ref:`
` - Figure. + +.. index:: periph@id; preface, peripherals; Preface, preface + +Preface +^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:` ` @style :ref:`p ` - Paragraph. +* :ref:` ` @style :ref:`m ` - Flush left (margin) paragraph. +* :ref:` ` @style :ref:`pi# ` - Indented paragraph. +* :ref:` ` @style :ref:`li# ` - List item. +* :ref:` ` @style :ref:`q# ` - Poetic line. +* :ref:`
` - For any tabular data. +* :ref:` ` @style :ref:`bk `, :ref:`qt `, :ref:`tl ` or other @style types. +* :ref:`
` - Figure. + +.. index:: periph@id; contents, peripherals; Contents, contents + +Table of Contents +^^^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:`
` - For any tabular data. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_contents_example + :emphasize-lines: 4,50 + + + + + + Contents + Old Testament +
+ + Name + Page + Name + Page + + + Genesis + # + Ecclesiastes + # + + + Exodus + # + Song of Songs + # + + + Leviticus + # + Isaiah + # + + ... +
+ New Testament + + + Name + Page + Name + Page + + + Matthew + # + 1 Timothy + # + + ... +
+ + + +.. index:: periph@id; alphacontents, peripherals; Alphabetical Content, alphabetical contents + +Alphabetical Contents +^^^^^^^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:`` - For any tabular data. + +.. index:: periph@id; abbreviations, peripherals; Table of Abbreviations, table of abbreviations + +Table of Abbreviations +^^^^^^^^^^^^^^^^^^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:`
` - For any tabular data. + +**Text Sample** + +.. code-block:: xml + :name: usx-peripherals_abbreviations_example + :emphasize-lines: 4,43 + + + + + + Alphabetical List of Biblical Books and Abbreviations +
+ + Name + Abbrev. + Page + + + Acts + Ac + # + + + Amos + Am + # + + ... +
+ Other Abbreviations + + + Term + Abbrev. + Page + + + Circa (around) + c + # + + + Old Testament + OT + # + + ... +
+ + \ No newline at end of file diff --git a/docs/peripherals/intros.rst b/docs/peripherals/intros.rst index 202bfcb..47df57b 100644 --- a/docs/peripherals/intros.rst +++ b/docs/peripherals/intros.rst @@ -1,7 +1,91 @@ .. include:: /_static/inc_styles.txt -.. index:: book@code; INT, peripherals; Introductions +.. index:: book@code; INT, peripherals; Introductions, introductions .. _usx-book_INT: -Introductions ( @code INT) -================================ +Introductions +============= + +The INT :ref:`book ` and its :ref:`divisions ` can be used for storing introductory material related to the various book groupings within a scripture publication. This material has also been referred to as “mid-matter”. + +**General** + +Use the following :doc:`elements ` (or other appropriate USX elements and :doc:` ` or :doc:` ` @style types, as required) to create introduction content for specific :ref:`divisions `. + +* :ref:` ` @style :ref:`mt# ` - Main title. +* :ref:` ` @style :ref:`s# ` - Section heading. +* :ref:` ` @style :ref:`p ` - Paragraph. +* :ref:` ` @style :ref:`m ` - Flush left (margin) paragraph. +* :ref:` ` @style :ref:`pi# ` - Indented paragraph. +* :ref:` ` @style :ref:`li# ` - List item. +* :ref:` ` @style :ref:`q# ` - Poetic line. +* :ref:`` - For any tabular data. +* :ref:` ` @style :ref:`bk `, :ref:`qt `, :ref:`tl ` or other @style types. +* :ref:`
` - Figure. + +**Text Samples** + +.. code-block:: xml + :name: usx-peripherals_intot_example + :emphasize-lines: 4,12 + + + + + + Introduction to the Old Testament + The Old Testament is a record of Israel's experience of what God is like + and what the people who worship God should be like. It proclaims the LORD God as the + creator of the world and it tells how God blesses people and establishes relations with + people through special agreements called covenants. + + ... + + + +.. code-block:: xml + :name: usx-peripherals_intpent_example + :emphasize-lines: 4,11 + + + + + + The Pentateuch + “Pentateuch” is a term that means “five scrolls (books)” and is used to + describe the five books that are positioned at the beginning of both Jewish and + Christian Bibles. + + ... + + + +.. code-block:: xml + :name: usx-peripherals_intnt_example + :emphasize-lines: 4,10 + + + + + + Introduction to the New Testament + The books of the New Testament were written by the followers of + Jesus Christ... + + ... + + + +.. code-block:: xml + :name: usx-peripherals_intgospels_example + :emphasize-lines: 4,8 + + + + + + Gospels and Acts + ... + ... + + diff --git a/docs/peripherals/other.rst b/docs/peripherals/other.rst index df9126f..f1588b6 100644 --- a/docs/peripherals/other.rst +++ b/docs/peripherals/other.rst @@ -1,7 +1,21 @@ .. include:: /_static/inc_styles.txt -.. index:: book@code; OTH, peripherals; Other Matter +.. index:: book@code; OTH, peripherals; Other Matter, other matter .. _usx-book_OTH: -Other Matter ( @code OTH) -=============================== +Other Matter +============ + +.. index:: periph@id; cover, peripherals; Cover, cover + +Cover +^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Cover main title (required). + +.. index:: periph@id; spine, peripherals; Spine, spine + +Spine +^^^^^ + +* :ref:` ` @style :ref:`mt# ` - Spine book title (required) and language name title.