Skip to content

Commit

Permalink
Build USFM 3.0.1 HTML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
klassenjm committed Jan 10, 2020
1 parent a39c076 commit dfdad3e
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 25 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Change Log

## [v3.0.1](https://github.com/ubsicap/usfm/tree/v3.0.1) (2020-01-10)

[Full Changelog](https://github.com/ubsicap/usfm/compare/v3.0.0...v3.0.1)

**Fixed bugs:**

- Wrong link landing for characters in syntax notes/general syntax [\#94](https://github.com/ubsicap/usfm/issues/94)
- Fix trivial typo in release notes \(3.0\) [\#92](https://github.com/ubsicap/usfm/issues/92)
- Fix USFM docs for \esb - should not occur after \v [\#91](https://github.com/ubsicap/usfm/issues/91)
- XXA-XXG in Identification section. [\#90](https://github.com/ubsicap/usfm/issues/90)
- Small typo \(scrloc\) [\#88](https://github.com/ubsicap/usfm/issues/88)
- Correct docs for \fe [\#74](https://github.com/ubsicap/usfm/issues/74)

**Closed issues:**

- Allow broader use of \xt \(update xt OccursUnder list\) [\#96](https://github.com/ubsicap/usfm/issues/96)
- Using \rem in context anywhere in a USFM file? [\#83](https://github.com/ubsicap/usfm/issues/83)
- Update color values in stylesheets to match PT UI updates [\#39](https://github.com/ubsicap/usfm/issues/39)

## [v3.0.0](https://github.com/ubsicap/usfm/tree/v3.0.0) (2018-05-14)
[Full Changelog](https://github.com/ubsicap/usfm/compare/v3.0.rc1...v3.0.0)

Expand Down
55 changes: 31 additions & 24 deletions docs/_build/html/about/releasenotes.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">About USFM</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Release Notes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#about-release-3-0-1">3.0.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#about-release-3-0">3.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#rc1">3.0rc1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#about-release-2-5">2.5</a></li>
Expand Down Expand Up @@ -195,23 +196,29 @@
<span id="index-0"></span><h1>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline"></a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#about-release-3-0" id="id13">3.0</a></li>
<li><a class="reference internal" href="#rc1" id="id14">3.0rc1</a></li>
<li><a class="reference internal" href="#about-release-2-5" id="id15">2.5</a></li>
<li><a class="reference internal" href="#about-release-2-4" id="id16">2.4</a></li>
<li><a class="reference internal" href="#about-release-2-35" id="id17">2.35</a></li>
<li><a class="reference internal" href="#about-release-2-3" id="id18">2.3</a></li>
<li><a class="reference internal" href="#about-release-2-2" id="id19">2.2</a></li>
<li><a class="reference internal" href="#about-release-2-1" id="id20">2.1</a></li>
<li><a class="reference internal" href="#about-release-2-05" id="id21">2.05</a></li>
<li><a class="reference internal" href="#about-release-2-04" id="id22">2.04</a></li>
<li><a class="reference internal" href="#about-release-2-03" id="id23">2.03</a></li>
<li><a class="reference internal" href="#about-release-2-0" id="id24">2.0</a></li>
<li><a class="reference internal" href="#about-release-3-0-1" id="id14">3.0.1</a></li>
<li><a class="reference internal" href="#about-release-3-0" id="id15">3.0</a></li>
<li><a class="reference internal" href="#rc1" id="id16">3.0rc1</a></li>
<li><a class="reference internal" href="#about-release-2-5" id="id17">2.5</a></li>
<li><a class="reference internal" href="#about-release-2-4" id="id18">2.4</a></li>
<li><a class="reference internal" href="#about-release-2-35" id="id19">2.35</a></li>
<li><a class="reference internal" href="#about-release-2-3" id="id20">2.3</a></li>
<li><a class="reference internal" href="#about-release-2-2" id="id21">2.2</a></li>
<li><a class="reference internal" href="#about-release-2-1" id="id22">2.1</a></li>
<li><a class="reference internal" href="#about-release-2-05" id="id23">2.05</a></li>
<li><a class="reference internal" href="#about-release-2-04" id="id24">2.04</a></li>
<li><a class="reference internal" href="#about-release-2-03" id="id25">2.03</a></li>
<li><a class="reference internal" href="#about-release-2-0" id="id26">2.0</a></li>
</ul>
</div>
<hr class="docutils" />
<div class="section" id="about-release-3-0-1">
<span id="id1"></span><h2><a class="toc-backref" href="#id14">3.0.1</a><a class="headerlink" href="#about-release-3-0-1" title="Permalink to this headline"></a></h2>
<p><em>January 2020</em></p>
<p>This update is prmarily for providing documentation fixes, as well as minor updates to Paratext stylesheets (enable PT9 ColorNames feature; allow <cite>xt</cite> in more contexts)</p>
</div>
<div class="section" id="about-release-3-0">
<span id="id1"></span><h2><a class="toc-backref" href="#id13">3.0</a><a class="headerlink" href="#about-release-3-0" title="Permalink to this headline"></a></h2>
<span id="id2"></span><h2><a class="toc-backref" href="#id15">3.0</a><a class="headerlink" href="#about-release-3-0" title="Permalink to this headline"></a></h2>
<p>USFM 3.0 additions or revisions are highlighted throughout this documentation using the badge <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" 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="110"><text x="195" y="140" transform="scale(.1)" textLength="270">usfm</text><text x="495" y="140" transform="scale(.1)" textLength="170">3.0</text></g> </svg></p>
<p><em>April 2018</em></p>
<p><strong>Marker Additions</strong></p>
Expand Down Expand Up @@ -253,7 +260,7 @@
</ul>
</div>
<div class="section" id="rc1">
<span id="about-release-3-0rc1"></span><h2><a class="toc-backref" href="#id14">3.0rc1</a><a class="headerlink" href="#rc1" title="Permalink to this headline"></a></h2>
<span id="about-release-3-0rc1"></span><h2><a class="toc-backref" href="#id16">3.0rc1</a><a class="headerlink" href="#rc1" title="Permalink to this headline"></a></h2>
<p><em>October 2016</em></p>
<p><strong>Marker Additions</strong></p>
<ul class="simple">
Expand Down Expand Up @@ -311,12 +318,12 @@
</ul>
</div>
<div class="section" id="about-release-2-5">
<span id="id3"></span><h2><a class="toc-backref" href="#id15">2.5</a><a class="headerlink" href="#about-release-2-5" title="Permalink to this headline"></a></h2>
<span id="id4"></span><h2><a class="toc-backref" href="#id17">2.5</a><a class="headerlink" href="#about-release-2-5" title="Permalink to this headline"></a></h2>
<p><em>October 2013</em></p>
<p>Validation (stylesheet) configuration update for ParaTExt 7.5 release.</p>
</div>
<div class="section" id="about-release-2-4">
<span id="id4"></span><h2><a class="toc-backref" href="#id16">2.4</a><a class="headerlink" href="#about-release-2-4" title="Permalink to this headline"></a></h2>
<span id="id5"></span><h2><a class="toc-backref" href="#id18">2.4</a><a class="headerlink" href="#about-release-2-4" title="Permalink to this headline"></a></h2>
<p><em>June 2013</em></p>
<p><strong>Marker Additions</strong></p>
<ul class="simple">
Expand All @@ -325,7 +332,7 @@
<p>Full support for the nested character markup syntax has been included in Paratext &gt;=7.4, Publishing Assistant &gt;=4.1, and the XML export format from Paratext known as “USX”.</p>
</div>
<div class="section" id="about-release-2-35">
<span id="id5"></span><h2><a class="toc-backref" href="#id17">2.35</a><a class="headerlink" href="#about-release-2-35" title="Permalink to this headline"></a></h2>
<span id="id6"></span><h2><a class="toc-backref" href="#id19">2.35</a><a class="headerlink" href="#about-release-2-35" title="Permalink to this headline"></a></h2>
<p><em>February 2012</em></p>
<p>Primarily a documentation update.</p>
<p>Paratext 7.3 and beyond provides support for study Bible content authoring, within a single project text, through an enhanced multi-pane editing window. Earlier USFM documentation releases discussed study Bible content markup using one or two additional related project texts. This multi-project authoring configuration is no longer recommended now that there is workable authoring environment supporting a single-project study Bible text. Information relating to study Bible content markup and authoring practice in this documentation supersedes any reference to separate notes or sidebar projects in the earlier release notes (below).</p>
Expand All @@ -334,7 +341,7 @@
</ul>
</div>
<div class="section" id="about-release-2-3">
<span id="id6"></span><h2><a class="toc-backref" href="#id18">2.3</a><a class="headerlink" href="#about-release-2-3" title="Permalink to this headline"></a></h2>
<span id="id7"></span><h2><a class="toc-backref" href="#id20">2.3</a><a class="headerlink" href="#about-release-2-3" title="Permalink to this headline"></a></h2>
<p><em>July 2010</em></p>
<p>Version numbers for the base USFM stylesheet and the study Bible notes and sidebars stylesheets have been synchronized to 2.3. This reflects the readiness of the ParaTExt 7.1 editor to support study Bible authoring.</p>
<p><strong>Marker Additions</strong></p>
Expand All @@ -349,7 +356,7 @@
</ul>
</div>
<div class="section" id="about-release-2-2">
<span id="id7"></span><h2><a class="toc-backref" href="#id19">2.2</a><a class="headerlink" href="#about-release-2-2" title="Permalink to this headline"></a></h2>
<span id="id8"></span><h2><a class="toc-backref" href="#id21">2.2</a><a class="headerlink" href="#about-release-2-2" title="Permalink to this headline"></a></h2>
<p><em>October 2008</em></p>
<p><strong>Marker Additions</strong></p>
<ul class="simple">
Expand All @@ -363,7 +370,7 @@
</ul>
</div>
<div class="section" id="about-release-2-1">
<span id="id8"></span><h2><a class="toc-backref" href="#id20">2.1</a><a class="headerlink" href="#about-release-2-1" title="Permalink to this headline"></a></h2>
<span id="id9"></span><h2><a class="toc-backref" href="#id22">2.1</a><a class="headerlink" href="#about-release-2-1" title="Permalink to this headline"></a></h2>
<p><em>April 2007</em></p>
<p><strong>Marker Additions</strong></p>
<ul>
Expand All @@ -389,23 +396,23 @@
</ul>
</div>
<div class="section" id="about-release-2-05">
<span id="id9"></span><h2><a class="toc-backref" href="#id21">2.05</a><a class="headerlink" href="#about-release-2-05" title="Permalink to this headline"></a></h2>
<span id="id10"></span><h2><a class="toc-backref" href="#id23">2.05</a><a class="headerlink" href="#about-release-2-05" title="Permalink to this headline"></a></h2>
<p><em>June 2006</em></p>
<p><strong>Marker Additions</strong></p>
<ul class="simple">
<li>Added <a class="reference internal" href="../titles_headings/index.html#usfmc-rq"><span class="std std-ref">\rq</span></a> for marking inline quotation references.</li>
</ul>
</div>
<div class="section" id="about-release-2-04">
<span id="id10"></span><h2><a class="toc-backref" href="#id22">2.04</a><a class="headerlink" href="#about-release-2-04" title="Permalink to this headline"></a></h2>
<span id="id11"></span><h2><a class="toc-backref" href="#id24">2.04</a><a class="headerlink" href="#about-release-2-04" title="Permalink to this headline"></a></h2>
<p><em>October 2005</em></p>
<p><strong>Marker Additions</strong></p>
<ul class="simple">
<li>Added <a class="reference internal" href="../identification/index.html#usfmp-toc"><span class="std std-ref">\toc3</span></a> for providing the standard abbreviation for a book.</li>
</ul>
</div>
<div class="section" id="about-release-2-03">
<span id="id11"></span><h2><a class="toc-backref" href="#id23">2.03</a><a class="headerlink" href="#about-release-2-03" title="Permalink to this headline"></a></h2>
<span id="id12"></span><h2><a class="toc-backref" href="#id25">2.03</a><a class="headerlink" href="#about-release-2-03" title="Permalink to this headline"></a></h2>
<p><em>August 2005</em></p>
<p><strong>Marker Additions</strong></p>
<ul class="simple">
Expand All @@ -415,7 +422,7 @@
</ul>
</div>
<div class="section" id="about-release-2-0">
<span id="id12"></span><h2><a class="toc-backref" href="#id24">2.0</a><a class="headerlink" href="#about-release-2-0" title="Permalink to this headline"></a></h2>
<span id="id13"></span><h2><a class="toc-backref" href="#id26">2.0</a><a class="headerlink" href="#about-release-2-0" title="Permalink to this headline"></a></h2>
<p><em>October 2004</em></p>
<p>The following sections outline changes in USFM from 1.53 to 2.0.</p>
<p><strong>Marker Revisions</strong></p>
Expand Down
Binary file modified docs/_build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/about/releasenotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ Release Notes

-----

.. _about_release_3.0.1:

3.0.1
^^^^^

*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)

.. _about_release_3.0:

3.0
Expand Down

0 comments on commit dfdad3e

Please sign in to comment.