Permalink
Browse files

Added documentation for milestones. Various fixes and updates.

  • Loading branch information...
klassenjm committed Sep 26, 2016
1 parent d66c6c1 commit 90a95d3f541b27c6bdba359543275c904b79ab34
Showing with 650 additions and 127 deletions.
  1. +4 −1 docs/_build/html/about/index.html
  2. +17 −6 docs/_build/html/about/releasenotes.html
  3. +4 −1 docs/_build/html/about/syntax.html
  4. +19 −28 docs/_build/html/{characters/attributes.html → attributes/index.html}
  5. +4 −1 docs/_build/html/chapters_verses/index.html
  6. +8 −9 docs/_build/html/characters/index.html
  7. +6 −5 docs/_build/html/characters/nesting.html
  8. +94 −17 docs/_build/html/genindex.html
  9. +4 −1 docs/_build/html/identification/books.html
  10. +4 −1 docs/_build/html/identification/index.html
  11. +8 −2 docs/_build/html/index.html
  12. +4 −1 docs/_build/html/introductions/index.html
  13. +16 −25 docs/_build/html/{characters/linking.html → linking/index.html}
  14. +4 −1 docs/_build/html/lists/index.html
  15. +369 −0 docs/_build/html/milestones/index.html
  16. +4 −1 docs/_build/html/notes_basic/fnotes.html
  17. +4 −1 docs/_build/html/notes_basic/xrefs.html
  18. +7 −1 docs/_build/html/notes_study/categories.html
  19. +4 −1 docs/_build/html/notes_study/efnotes.html
  20. +4 −1 docs/_build/html/notes_study/exrefs.html
  21. +6 −3 docs/_build/html/notes_study/index.html
  22. +4 −1 docs/_build/html/notes_study/intros_book.html
  23. +4 −1 docs/_build/html/notes_study/intros_div.html
  24. +4 −1 docs/_build/html/notes_study/sidebars.html
  25. BIN docs/_build/html/objects.inv
  26. +4 −1 docs/_build/html/paragraphs/index.html
  27. +4 −1 docs/_build/html/peripherals/back.html
  28. +4 −1 docs/_build/html/peripherals/front.html
  29. +7 −4 docs/_build/html/peripherals/index.html
  30. +4 −1 docs/_build/html/peripherals/intros.html
  31. +4 −4 docs/_build/html/peripherals/other.html
  32. +4 −1 docs/_build/html/poetry/index.html
  33. +4 −1 docs/_build/html/search.html
  34. +1 −1 docs/_build/html/searchindex.js
  35. +4 −1 docs/_build/html/tables/index.html
  36. +4 −1 docs/_build/html/titles_headings/index.html
@@ -106,8 +106,11 @@
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/fnotes.html">Footnotes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/xrefs.html">Cross References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../characters/index.html">Words and Characters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
<li class="toctree-l1"><a class="reference internal" href="../attributes/index.html">Word Level Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../linking/index.html">Linking Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../milestones/index.html">Milestones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_study/index.html">Extended Study Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
</ul>
@@ -120,8 +120,11 @@
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/fnotes.html">Footnotes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/xrefs.html">Cross References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../characters/index.html">Words and Characters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
<li class="toctree-l1"><a class="reference internal" href="../attributes/index.html">Word Level Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../linking/index.html">Linking Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../milestones/index.html">Milestones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_study/index.html">Extended Study Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
</ul>
@@ -188,7 +191,7 @@
<hr class="docutils" />
<div class="section" id="about-release-3-0">
<span id="id1"></span><h2><a class="toc-backref" href="#id12">3.0</a><a class="headerlink" href="#about-release-3-0" title="Permalink to this headline">¶</a></h2>
<p><em>September 2016</em></p>
<p><em>October 2016</em></p>
<p>USFM 3.0 additions or revisions are highlighted throughout this documentation using the badge <svg xmlns="http://www.w3.org/2000/svg" width="64" height="20"><g shape-rendering="crispEdges"><path fill="#555" d="M0 0h37v20H0z"/><path fill="#6ab0de" d="M37 0h27v20H37z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="19.5" y="14">usfm</text><text x="49.5" y="14">3.0</text></g></svg></p>
<p><strong>Marker Additions</strong></p>
<ul class="simple">
@@ -204,31 +207,39 @@
<li>Structured list items: <a class="reference internal" href="../lists/index.html#usfmc-lik"><span class="std std-ref">\lik ...\lik*</span></a> and <a class="reference internal" href="../lists/index.html#usfmc-liv"><span class="std std-ref">\liv# ...\liv#*</span></a></li>
<li>List item total: <a class="reference internal" href="../lists/index.html#usfmc-litl"><span class="std std-ref">\litl ...\litl*</span></a></li>
<li>Semantic division: <a class="reference internal" href="../titles_headings/index.html#usfmp-sd"><span class="std std-ref">\sd#</span></a></li>
<li>Link text: <a class="reference internal" href="../characters/linking.html#usfmc-jmp"><span class="std std-ref">\jmp ...\jmp*</span></a></li>
<li>Link text: <a class="reference internal" href="../linking/index.html#usfmc-jmp"><span class="std std-ref">\jmp ...\jmp*</span></a></li>
<li>Common peripheral <a class="reference internal" href="../peripherals/index.html#periph-div"><span class="std std-ref">identifiers</span></a>.</li>
<li>Ruby annotations (CJK texts): <a class="reference internal" href="../characters/index.html#usfmc-rb"><span class="std std-ref">\rb ...\rb*</span></a> and <a class="reference internal" href="../characters/index.html#usfmc-rt"><span class="std std-ref">\rt ...\rt*</span></a></li>
<li>Quotation start / end milestones: <a class="reference internal" href="../milestones/index.html#usfmm-qt-s"><span class="std std-ref">\qt#-s\* and \qt#-e\*</span></a>.</li>
</ul>
<p><strong>Marker Revisions</strong></p>
<ul class="simple">
<li>Support citation form for wordlist / glossary text (update <a class="reference internal" href="../characters/index.html#usfmc-w"><span class="std std-ref">\w ...\w*</span></a>).</li>
<li>Support for explicit <a class="reference internal" href="../tables/index.html#usfmc-tc"><span class="std std-ref">table cell</span></a> column <a class="reference internal" href="../tables/index.html#usfmc-table-colspan"><span class="std std-ref">spanning</span></a>.</li>
<li>Revised syntax for figures / illustrations applying descriptive <a class="reference internal" href="../characters/attributes.html"><span class="doc">attributes</span></a>: <a class="reference internal" href="../characters/index.html#usfmc-fig-attr"><span class="std std-ref">\fig ...\fig*</span></a></li>
<li>Revised syntax for figures / illustrations applying descriptive <a class="reference internal" href="../attributes/index.html"><span class="doc">attributes</span></a>: <a class="reference internal" href="../characters/index.html#usfmc-fig-attr"><span class="std std-ref">\fig ...\fig*</span></a></li>
<li><em>Deprecate</em> cross reference and footnote DC content markers: <a class="reference internal" href="../notes_basic/xrefs.html#usfmc-xdc"><span class="std std-ref">\xdc ...\xdc*</span></a> and <a class="reference internal" href="../notes_basic/fnotes.html#usfmc-fdc"><span class="std std-ref">\fdc ...\fdc*</span></a></li>
<li><em>Deprecate</em> combined marker for proper name within translator&#8217;s addition: <a class="reference internal" href="../characters/index.html#usfmc-addpn"><span class="std std-ref">\addpn ...\addpn*</span></a></li>
<li><em>Deprecate</em> numbered running header: <a class="reference internal" href="../identification/index.html#usfmp-h"><span class="std std-ref">\h#</span></a></li>
<li><em>Deprecate</em> pronunciation info marker: <a class="reference internal" href="../characters/index.html#usfmc-pro"><span class="std std-ref">\pro ...\pro*</span></a> in favour of <a class="reference internal" href="../characters/index.html#usfmc-rb"><span class="std std-ref">ruby annotations</span></a> proposal.</li>
</ul>
<p><strong>Syntax and Features</strong></p>
<ul>
<li><p class="first">Syntax for assigning word-level descriptive <a class="reference internal" href="../characters/attributes.html"><span class="doc">attributes</span></a>.</p>
<li><p class="first">Syntax for assigning word-level <a class="reference internal" href="../attributes/index.html"><span class="doc">descriptive attributes</span></a>.</p>
<blockquote>
<div><ul class="simple">
<li>Descriptive attributes for <a class="reference internal" href="../characters/index.html#usfmc-w-attr"><span class="std std-ref">\w ...\w*</span></a></li>
<li>Descriptive attributes for <a class="reference internal" href="../characters/index.html#usfmc-fig-attr"><span class="std std-ref">\fig ...\fig*</span></a></li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Syntax for assigning word-level linking <a class="reference internal" href="../characters/linking.html"><span class="doc">attributes</span></a>.</p>
<li><p class="first">Syntax for assigning word-level <a class="reference internal" href="../linking/index.html"><span class="doc">linking attributes</span></a>.</p>
</li>
<li><p class="first">Syntax for <a class="reference internal" href="../milestones/index.html"><span class="doc">milestones</span></a>.</p>
<blockquote>
<div><ul class="simple">
<li>Quotation start / end milestones: <a class="reference internal" href="../milestones/index.html#usfmm-qt-s"><span class="std std-ref">\qt#-s\* and \qt#-e\*</span></a>.</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Syntax for peripheral (<a class="reference internal" href="../peripherals/index.html"><span class="doc">\periph</span></a>) <a class="reference internal" href="../peripherals/index.html#periph-id"><span class="std std-ref">identifiers</span></a>.</p>
</li>
@@ -119,8 +119,11 @@
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/fnotes.html">Footnotes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/xrefs.html">Cross References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../characters/index.html">Words and Characters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
<li class="toctree-l1"><a class="reference internal" href="../attributes/index.html">Word Level Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../linking/index.html">Linking Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../milestones/index.html">Milestones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_study/index.html">Extended Study Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
</ul>
@@ -33,9 +33,8 @@
<link rel="top" title="Unified Standard Formal Markers 3.0.rc1 documentation" href="../index.html"/>
<link rel="up" title="Words and Characters" href="index.html"/>
<link rel="next" title="Linking Attributes" href="linking.html"/>
<link rel="prev" title="Character Marker Nesting" href="nesting.html"/>
<link rel="next" title="Linking Attributes" href="../linking/index.html"/>
<link rel="prev" title="Character Marker Nesting" href="../characters/nesting.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -96,26 +95,20 @@
<li class="toctree-l1"><a class="reference internal" href="../tables/index.html">Tables</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/fnotes.html">Footnotes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/xrefs.html">Cross References</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Words and Characters</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nesting.html">Character Marker Nesting</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Word Level Attributes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#general-syntax">General Syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="#default-attribute">Default Attribute</a></li>
<li class="toctree-l3"><a class="reference internal" href="#multiple-attribute-values">Multiple Attribute Values</a></li>
<li class="toctree-l3"><a class="reference internal" href="#backward-compatibility">Backward Compatibility</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-defined-attributes">User Defined Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#character-markers-providing-attributes">Character Markers Providing Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../characters/index.html">Words and Characters</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Word Level Attributes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#general-syntax">General Syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="#default-attribute">Default Attribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="#multiple-attribute-values">Multiple Attribute Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="#backward-compatibility">Backward Compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-defined-attributes">User Defined Attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#character-markers-providing-attributes">Character Markers Providing Attributes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="linking.html">Linking Attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#special-text">Special Text</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#character-styling">Character Styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#spacing-and-breaks">Spacing and Breaks</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#special-features">Special Features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
<li class="toctree-l1"><a class="reference internal" href="../linking/index.html">Linking Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../milestones/index.html">Milestones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_study/index.html">Extended Study Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
</ul>
@@ -146,13 +139,11 @@
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">Words and Characters</a> &raquo;</li>
<li>Word Level Attributes</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/characters/attributes.txt" rel="nofollow"> View page source</a>
<a href="../_sources/attributes/index.txt" rel="nofollow"> View page source</a>
</li>
@@ -191,7 +182,7 @@
<div class="highlight-text"><div class="highlight"><pre><span></span>\w gracious|strong=&quot;H01234,G05485&quot;\w*
</pre></div>
</div>
<p><a class="reference internal" href="../_images/icon-arrow_see.png"><img alt="ico_See" src="../_images/icon-arrow_see.png" style="width: 24px; height: 24px;" /></a> See the attributes for <a class="reference internal" href="index.html#usfmc-w-attr"><span class="std std-ref">\w ...\w*</span></a> for additional examples.</p>
<p><a class="reference internal" href="../_images/icon-arrow_see.png"><img alt="ico_See" src="../_images/icon-arrow_see.png" style="width: 24px; height: 24px;" /></a> See the attributes for <a class="reference internal" href="../characters/index.html#usfmc-w-attr"><span class="std std-ref">\w ...\w*</span></a> for additional examples.</p>
<span class="target" id="attributes-backward"></span></div>
<div class="section" id="backward-compatibility">
<span id="index-4"></span><h2>Backward Compatibility<a class="headerlink" href="#backward-compatibility" title="Permalink to this headline">¶</a></h2>
@@ -210,8 +201,8 @@
<div class="section" id="character-markers-providing-attributes">
<span id="index-6"></span><h2>Character Markers Providing Attributes<a class="headerlink" href="#character-markers-providing-attributes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="index.html#usfmc-w-attr"><span class="std std-ref">\w ...\w*</span></a> (lemma, strong)</li>
<li><a class="reference internal" href="index.html#usfmc-fig-attr"><span class="std std-ref">\fig ...\fig*</span></a> (alt, src, size, loc, copy, ref) - harmonizing the USFM 2.x syntax for this marker with this attribute specification</li>
<li><a class="reference internal" href="../characters/index.html#usfmc-w-attr"><span class="std std-ref">\w ...\w*</span></a> (lemma, strong)</li>
<li><a class="reference internal" href="../characters/index.html#usfmc-fig-attr"><span class="std std-ref">\fig ...\fig*</span></a> (alt, src, size, loc, copy, ref) - harmonizing the USFM 2.x syntax for this marker with this attribute specification</li>
</ul>
</div>
</div>
@@ -223,10 +214,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="linking.html" class="btn btn-neutral float-right" title="Linking Attributes" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../linking/index.html" class="btn btn-neutral float-right" title="Linking Attributes" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="nesting.html" class="btn btn-neutral" title="Character Marker Nesting" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="../characters/nesting.html" class="btn btn-neutral" title="Character Marker Nesting" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -106,8 +106,11 @@
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/fnotes.html">Footnotes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_basic/xrefs.html">Cross References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../characters/index.html">Words and Characters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
<li class="toctree-l1"><a class="reference internal" href="../attributes/index.html">Word Level Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../linking/index.html">Linking Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../milestones/index.html">Milestones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes_study/index.html">Extended Study Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peripherals/index.html">Peripherals</a></li>
</ul>
Oops, something went wrong.

0 comments on commit 90a95d3

Please sign in to comment.