Permalink
Browse files

Documentation for #35 (add \qt#s\* and \qt#e\*)

  • Loading branch information...
klassenjm committed Sep 26, 2016
1 parent 80bbef1 commit 566c6790472f7671195f8fc68f2abd4e6c6d3f16
Showing with 86 additions and 5 deletions.
  1. +86 −5 docs/milestones/index.rst
View
@@ -14,7 +14,7 @@ A milestone type markup is required when a document has two or more structures t
Another example of an overlapping structure exists when there is a need to indicate the start and end of the quotations of the "actors" who are speaking within the text. These spans of text will commonly cross paragraph boundaries.
.. _milestones_syntax:
.. index:: miletones; syntax
.. index:: milestones; syntax
General Syntax
^^^^^^^^^^^^^^
@@ -32,7 +32,7 @@ Self closing markup is indicated by immediately terminating the marker, and any
\qts\*
.. _milestones_startend:
.. index:: miletones; start and end
.. index:: milestones; start and end
Indicating Start and End Milestones
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -77,7 +77,88 @@ The unnumbered version may be used when only one level of marker exists within t
-----
.. _usfmm_qt#s:
.. index:: marker; \qt#s\*, marker; \qt#e\*, milestone; \qt#s\*, milestone; \qt1e\*
.. index:: marker; \qt#s\*, marker; \qt#e\*, milestone; \qt#s\*, milestone; \qt#e\*
\\qt#s\\*
^^^^^^^^^
\\qt#s\\* ... \\qt#e\\*
^^^^^^^^^^^^^^^^^^^^^^^
|badge_3.0|
:Syntax: ``\qt#s\*`` ... ``\qt#e\*``
:Type: milestone
:Added: 3.0
:Use: Quotation start / end milestones. |br|
Typically used for indicating the speaker of the text. |br|
The variable # represents the level of nesting of the quotation being marked (i.e. a quote within a quote). |br|
**\\qts\\* = \\qt1s\\*** |br|
**\\qte\\* = \\qt1e\\*** (see :ref:`syntax notes <syntax_numberedMarkers>` on numbered markers)
.. _usfmm_qt#s-attr:
.. index:: attributes; \qt#s\*, quotation milestones; attributes
.. rubric:: Attributes |ico_Tag|
Following the syntax for :doc:`word level attributes </attributes/index>`.
:who: The speaker of the quotation.
.. code-block:: text
\qts |id="qt123" who="Pilate"\*“Are you the king of the Jews?”\qte |id="qt123"\*
**Text Samples**
Matthew 27:11-14 (GNT) - Start and end quotation milestones using ``who`` attribute; no levels.
.. code-block:: text
:name: usfm-milestone_qt#s_example
:emphasize-lines: 2-4,6-7
\v 11 Jesus stood before the Roman governor, who questioned him. \qts |who="Pilate"\*“Are
you the king of the Jews?”\qte\* he asked.
\p \qts |who="Jesus"\*“So you say,”\qte\* answered Jesus.
\v 12 But he said nothing in response to the accusations of the chief priests and elders.
\p
\v 13 So Pilate said to him, \qts |who="Pilate"\*“Don't you hear all these things they
accuse you of?”\qte\*
\p
\v 14 But Jesus refused to answer a single word, with the result that the Governor was greatly
surprised.
Acts 17:22-31 - Start and end quotation milestones using ``who``, ``level``, and ``id`` attributes.
.. code-block:: text
:name: usfm-milestone_qt#s_example-alt
:emphasize-lines: 2-3,17,20,29
\p
\v 22 Paul stood up in front of the city council and said, \qt1s |id="qt_ACT17:22"
who="Paul"\*“I see that in every way you Athenians are very religious.
\v 23 For as I walked through your city and looked at the places where you worship,
I found an altar on which is written, ‘To an Unknown God.’ That which you worship, then,
even though you do not know it, is what I now proclaim to you.
\v 24 God, who made the world and everything in it, is Lord of heaven and earth and does
not live in temples made by human hands.
\v 25 Nor does he need anything that we can supply by working for him, since it is he
himself who gives life and breath and everything else to everyone
\v 26 From one human being he created all races of people and made them live throughout
the whole earth. He himself fixed beforehand the exact times and the limits of the places
where they would live.
\v 27 He did this so that they would look for him, and perhaps find him as they felt
around for him. Yet God is actually not far from any one of us;
\v 28 as someone has said,
\q1 \qt2s |who="someone"\*‘In him we live and move and exist.’\qt2e\*
\b
\m It is as some of your poets have said,
\q1 \qt2s |who="some poets"\*‘We too are his children.’\qt2e\*
\b
\m
\v 29 Since we are God's children, we should not suppose that his nature is anything like
an image of gold or silver or stone, shaped by human art and skill.
\v 30 God has overlooked the times when people did not know him, but now he commands all of
them everywhere to turn away from their evil ways.
\v 31 For he has fixed a day in which he will judge the whole world with justice by means of
a man he has chosen. He has given proof of this to everyone by raising that man from death!”
\qt1e |id="qt_ACT17:22"\*
The ``id`` in the above example has been formed using a combination of the milestone type and start milestone reference.

0 comments on commit 566c679

Please sign in to comment.