Skip to content

Commit

Permalink
Fix spelling in docs & stylesheet
Browse files Browse the repository at this point in the history
  • Loading branch information
James Chen-Smith committed Mar 14, 2021
1 parent 167c20a commit 8f6f763
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/about/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The diverging use of SFMs led to various problems – most notably the challenge

In March 2002 a working group was established within the `United Bible Societies <http://unitedbiblesocieties.org>`_ with the mandate of producing a unified specification for SFM use across 4 UBS areas.

Ideally an SFM standard would seek to identify and mark all common scriptural element types, and avoid markup primarily for formatting (presentation) information. USFM has attempted to unify a long history of SFM scripture markup implementations, some of which were more or less strict in their tolerance for format-oriented markers. USFM development focuseed primarily on unification, not new markup creation. Practically speaking, this means is that USFM inherits support for both the positive, and some negative, aspects of pre-existing SFM marker use.
Ideally an SFM standard would seek to identify and mark all common scriptural element types, and avoid markup primarily for formatting (presentation) information. USFM has attempted to unify a long history of SFM scripture markup implementations, some of which were more or less strict in their tolerance for format-oriented markers. USFM development focused primarily on unification, not new markup creation. Practically speaking, this means is that USFM inherits support for both the positive, and some negative, aspects of pre-existing SFM marker use.

.. _about_usfm_unification:
.. index:: USFM; unification notes
Expand Down
4 changes: 2 additions & 2 deletions docs/about/releasenotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Release Notes

*January 2020*

This update is prmarily for providing documentation fixes, as well as minor updates to Paratext stylesheets (enable PT9 ColorNames feature; allow ``\xt`` in more contexts)
This update is primarily for providing documentation fixes, as well as minor updates to Paratext stylesheets (enable PT9 ColorNames feature; allow ``\xt`` in more contexts)

.. _about_release_3.0:

Expand Down Expand Up @@ -47,7 +47,7 @@ USFM 3.0 additions or revisions are highlighted throughout this documentation us
* Added default ``link-href`` :doc:`linking attribute </linking/index>` for :ref:`\\xt ...\\xt\* <usfmc_xt-attr>`
* Changed common :ref:`attributes for milestones <milestones_attributes>`:

* Replace single ``id`` with separate start ``sid`` and end ``eid`` milestone attributes. |br| This update aligns USFM with the corresponding single `<ms> <https://ubsicap.github.io/usx/elements.html#ms>`_ milestone element in USX, where the ``id`` attrubute content would not be unique for `<ms> <https://ubsicap.github.io/usx/elements.html#ms>`_.
* Replace single ``id`` with separate start ``sid`` and end ``eid`` milestone attributes. |br| This update aligns USFM with the corresponding single `<ms> <https://ubsicap.github.io/usx/elements.html#ms>`_ milestone element in USX, where the ``id`` attribute content would not be unique for `<ms> <https://ubsicap.github.io/usx/elements.html#ms>`_.

* Changed name of :doc:`linking attribute </linking/index>` ``link-name`` to ``link-id``.
* *Restored* :ref:`\\pr <usfmp_pr>` for use as "text refrain".
Expand Down
6 changes: 3 additions & 3 deletions docs/about/syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ USFM processors should treat the single CR (U+000D) or LF (U+000A) characters,

All **paragraph markers** should be preceded by a single newline.

As a *recommended best practice* for USFM editors, **inline markup** (:doc:`character styles </characters/index>`, :doc:`footnotes </notes_basic/fnotes>`, or :doc:`cross references </notes_basic/xrefs>`) should *not* be preceeded by a newline. It would be acceptable for a :ref:`whitespace normalization <syntax_whitespace_normalization>` process to replace a newline and any preceding space (multiple spaces) before this inline markup with a single space (#3), but it should not remove all whitespace.
As a *recommended best practice* for USFM editors, **inline markup** (:doc:`character styles </characters/index>`, :doc:`footnotes </notes_basic/fnotes>`, or :doc:`cross references </notes_basic/xrefs>`) should *not* be preceded by a newline. It would be acceptable for a :ref:`whitespace normalization <syntax_whitespace_normalization>` process to replace a newline and any preceding space (multiple spaces) before this inline markup with a single space (#3), but it should not remove all whitespace.

In the following example, the footnote ``\f ...\f*`` at MAT 6:27:

Expand Down Expand Up @@ -158,10 +158,10 @@ could be removed:
v 7 \x - \xo 2.7: \xt 1 Co 15.45.\x*Then the \nd Lord\nd* God took some soil
from the ground and formed a man
Yet, a normalization process cannot *generally* remove ALL whitespace preceeding and following note marker pairs. In many cases a single whitespace is expected between the texts which preceed and follows a note. As suggested and recommended earlier:
Yet, a normalization process cannot *generally* remove ALL whitespace preceding and following note marker pairs. In many cases a single whitespace is expected between the texts which precede and follows a note. As suggested and recommended earlier:

* USFM validation tools may flag suspicious whitespace
* USFM editors can takes steps to discourage ambigous whitespace wherever possible
* USFM editors can takes steps to discourage ambiguous whitespace wherever possible
* USFM normalization tools can identify and handles special contexts (examples above)
* USFM publication tools and other post processors can identify and handle special contexts in the manner which is most suitable for the intended output.

Expand Down
2 changes: 1 addition & 1 deletion docs/paragraphs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Paragraphs
:Use: Closure of an epistle/letter. |br|
Similar to "With love," or "Sincerely yours,".

**Text and Formatting Sample** - Colossians 4.18 (GNT - *markup adapated*)
**Text and Formatting Sample** - Colossians 4.18 (GNT - *markup adapted*)

.. code-block:: text
:name: usfm-paragraph_cls_example
Expand Down
2 changes: 1 addition & 1 deletion docs/peripherals/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Peripheral Books and Divisions
+===============================+==================================+======================================+
| **Divisions** | **Divisions** | **Divisions** |
+-------------------------------+----------------------------------+--------------------------------------+
| ``\periph Title Page`` | ``\periph Bible Intorduction`` | ``\periph Chronology`` |
| ``\periph Title Page`` | ``\periph Bible Introduction`` | ``\periph Chronology`` |
| |br| ``|id="title"`` | |br| ``|id="intbible"`` | |br| ``|id="chron"`` |
+-------------------------------+----------------------------------+--------------------------------------+
| ``\periph Half Title Page`` | ``\periph Old Testament | ``\periph Weights and |
Expand Down
2 changes: 1 addition & 1 deletion docs/titles_headings/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Introduction to John (GNT)
:Use: Major title at ending. |br|
May be used in texts which repeat the main title at the end of the introduction, or to mark a major title indicating the end of the introduction. |br|
The content is not typically identical to :ref:`\\mt# <usfmp_mt#>`. |br|
Th variable # represents a portion of the title, with the lesser emphasis (relative weighting) being on the higher numbers. |br|
The variable # represents a portion of the title, with the lesser emphasis (relative weighting) being on the higher numbers. |br|
**\\mte = \\mte1** (see :ref:`syntax notes <syntax_numberedMarkers>` on numbered markers)

**Text and Formatting Sample** - John
Expand Down
4 changes: 2 additions & 2 deletions sty/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
A USFM stylesheet is a text file named using an `.sty` extension which contains a collection of definitions and properties for USFM markers. These properties are typically used for expressing information about marker identification and description, the location and order in which markers can occur withn a USFM file, and for expressing formatted display preferences. Stylesheets were originally developed for use by the Paratext scripture translation editor, but they could be of use in other contexts as well. They provide a rudimentary grammar to USFM and as such are also maintained in this repository.
A USFM stylesheet is a text file named using an `.sty` extension which contains a collection of definitions and properties for USFM markers. These properties are typically used for expressing information about marker identification and description, the location and order in which markers can occur within a USFM file, and for expressing formatted display preferences. Stylesheets were originally developed for use by the Paratext scripture translation editor, but they could be of use in other contexts as well. They provide a rudimentary grammar to USFM and as such are also maintained in this repository.

## Stylesheet Properties

Expand Down Expand Up @@ -127,7 +127,7 @@ If a character style marker does not have a “publishable” value (Publishable

**Property:** `\TextType`
**Example:** `\TextType VerseText`
**Description:** May only contain one of the folllowing values:
**Description:** May only contain one of the following values:
* `Title`: Title for a book.
* `Section`: Section heading.
* `VerseText`: Normal verse body text.
Expand Down
8 changes: 4 additions & 4 deletions sty/USFMSty-ChangeLog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
** Updated by Jeff Klassen Aug 23, 2005
- Added sp to OccursUnder for v
- Added \fl - Footnote Label Text (see description for Marker fl)
- Added \toc1 and \toc2 for specfying the long and short text for the table of contents.
- Added \toc1 and \toc2 for specifying the long and short text for the table of contents.
** Updated by Jeff Klassen July 19, 2005
- Added peripheral material extensions \p1, \p2, \k1, \k2
** Updated by Jeff Klassen June 28, 2005
Expand All @@ -160,8 +160,8 @@
- Fixed \bdit to display Bold and Italic (was configured for Bold only)
** Updated by Jeff Klassen Dec 8, 2004
- Changed space before for \d from 8 to 4
- Changed desciption for \sls to "Special Text - Secondary Language or Text Source"
to reflect need for exapanded scope in the use of this marker.
- Changed description for \sls to "Special Text - Secondary Language or Text Source"
to reflect need for expanded scope in the use of this marker.
** Updated by Jeff Klassen Nov 4, 2004
- Added character style marker for words of Jesus \wj...\wj*
** Updated by Jeff Klassen Oct 27, 2004
Expand Down Expand Up @@ -229,7 +229,7 @@ Added \FirstLineIndent .125 to \ps; added \ms
** Updated by Jeff Klassen May 28, 2003
- added \pn...\pn*
** Updated by Jeff Klassen May 26, 2003
- \v may be preceeded by \d - see RSV, CEV ZEC 9.1; 12.1
- \v may be preceded by \d - see RSV, CEV ZEC 9.1; 12.1
** Updated by Nathan Miles May 23, 2003
- Extensive changes made to enhance consistency of use of character
- style markers in VerseText and Section
Expand Down
10 changes: 5 additions & 5 deletions sty/usfm.sty
Original file line number Diff line number Diff line change
Expand Up @@ -852,7 +852,7 @@

\Marker pi
\Name pi - Paragraph - Indented - Level 1 - First Line Indent
\Description Paragraph text, level 1 indent (if sinlge level), with first line indent; often used for discourse (basic)
\Description Paragraph text, level 1 indent (if single level), with first line indent; often used for discourse (basic)
\OccursUnder c
\Rank 4
\TextType VerseText
Expand Down Expand Up @@ -1179,7 +1179,7 @@

\Marker mt4
\Name mt4 - Title - Major Title level 4
\Description A small secondary title sometimes occuring within parentheses
\Description A small secondary title sometimes occurring within parentheses
\OccursUnder id
\Rank 3
\TextProperties paragraph publishable vernacular level_4
Expand Down Expand Up @@ -1979,7 +1979,7 @@
\Marker liv1
\Endmarker liv1*
\Name liv1...liv1* - Structured List Entry - Value 1
\Description Structured list entrt value 1 content (if multiple values)
\Description Structured list entry value 1 content (if multiple values)
\OccursUnder li li1 li2 li3 li4 lim lim1 lim2 lim3 lim4 NEST
\TextType VerseText
\TextProperties publishable vernacular
Expand Down Expand Up @@ -2646,7 +2646,7 @@

\Marker periph
\Name periph - Peripherals - Content Division Marker
\Description Periheral content division marker which should be followed by an additional division argument/title.
\Description Peripheral content division marker which should be followed by an additional division argument/title.
\TextType Section
\TextProperties paragraph publishable vernacular
\StyleType Paragraph
Expand Down Expand Up @@ -2781,7 +2781,7 @@
#!\Marker ts-s
#!\Endmarker ts-e
#!\Name Translator's section start/end milestone
#!\Description Translators's section start/end milestone
#!\Description Translator's section start/end milestone
#!\OccursUnder id
#!\StyleType Milestone
#!\Attributes ?sid ?eid
Expand Down
10 changes: 5 additions & 5 deletions sty/usfm_sb.sty
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@

\Marker pi
\Name pi - Paragraph - Indented - Level 1 - First Line Indent
\Description Paragraph text, level 1 indent (if sinlge level), with first line indent; often used for discourse (basic)
\Description Paragraph text, level 1 indent (if single level), with first line indent; often used for discourse (basic)
\OccursUnder c esb ms ms1 ms2 s s1 s2 s3 s4 ip
\Rank 4
\TextType VerseText
Expand Down Expand Up @@ -1181,7 +1181,7 @@

\Marker mt4
\Name mt4 - Title - Major Title level 4
\Description A small secondary title sometimes occuring within parentheses
\Description A small secondary title sometimes occurring within parentheses
\OccursUnder id
\Rank 3
\TextProperties paragraph publishable vernacular level_4
Expand Down Expand Up @@ -2240,7 +2240,7 @@
\Marker liv1
\Endmarker liv1*
\Name liv1...liv1* - Structured List Entry - Value 1
\Description Structured list entrt value 1 content (if multiple values)
\Description Structured list entry value 1 content (if multiple values)
\OccursUnder li li1 li2 li3 li4 lim lim1 lim2 lim3 lim4 NEST
\TextType VerseText
\TextProperties publishable vernacular
Expand Down Expand Up @@ -2977,7 +2977,7 @@

\Marker periph
\Name periph - Peripherals - Content Division Marker
\Description Periheral content division marker which should be followed by an additional division argument/title.
\Description Peripheral content division marker which should be followed by an additional division argument/title.
\TextType Section
\TextProperties paragraph publishable vernacular
\StyleType Paragraph
Expand Down Expand Up @@ -3112,7 +3112,7 @@
#!\Marker ts-s
#!\Endmarker ts-e
#!\Name Translator's section start/end milestone
#!\Description Translators's section start/end milestone
#!\Description Translator's section start/end milestone
#!\OccursUnder id
#!\StyleType Milestone
#!\Attributes ?sid ?eid
Expand Down

0 comments on commit 8f6f763

Please sign in to comment.