Add a little more about line breaking, and link the what's new documentation to the linebreaking and equation numbering sections

dpvc · dpvc · commit 5ef1f65b7786 · 2012-02-23T11:58:02.000-05:00
diff --git a/docs/html/_sources/output.txt b/docs/html/_sources/output.txt
@@ -188,6 +188,16 @@ can make it a fixed width, or make it a percentage of the container.
 See the :ref:`HTML-CSS configuration <configure-HTML-CSS>` or
 :ref:`SVG configuration <configure-SVG>` pages for more details.
 
+The linbe-breaking algorithm uses the nesting depth, the type of
+operator, the size of spaces, and other factors to decide on the
+breakpoints, but it does not know the meaning of the mathematics, and
+may not choose the optimal breakpoints. We will continue to work on
+the algorithm as we gain information from its actual use in the field.
+If you are using :term:`MathML` as your input format, you can use the
+``linebreak="goodbreak"`` and ``linebreak="badbreak"`` attributes on
+``<mo>`` elements to help MathJax pick the best breakpoints for your
+mathematics.
+
 
 .. _html-css-with-ie8:
 
diff --git a/docs/html/_sources/whats-new-2.0.txt b/docs/html/_sources/whats-new-2.0.txt
@@ -56,7 +56,7 @@ The TeX input jax now can be configured to add equation numbers
 (though the default is not to number equations so that existing pages
 will not change their appearance).  This is controlled through the
 ``equationNumbers`` section of the ``TeX`` block of your configuration
-(see the :ref:`TeX configuration options <configure-TeX>` page for
+(see the :ref:`equation numbering <tex-eq-numbers>` section for
 details).  You can request that the numbering follow the AMS-style
 numbering of environments, or you can request that every displayed
 equation be numbered.  There are now ``\label``, ``\ref``, and
@@ -71,15 +71,14 @@ MathJax now implements the MathML3 specification for automatic line
 breaking of displayed equations in its HTML-CSS output.  This is
 disabled by default, but can be enabled via the ``linebreaks`` section
 of the ``HTML-CSS`` or ``SVG`` block of your configuration (see the
-:ref:`HTML-CS configuration options <configure-HTML-CSS>` or :ref:`SVG
-configuration options <configure-SVG>` page for details).  Note that
-automatic line breaking only applies to displayed equations, not
-in-line equations, unless they are themselves longer than a line.  The
-algorithm uses the nesting depth, the type of operator, the size of
-spaces, and other factors to decide on the breakpoints, but it does
-not know the meaning of the mathematics, and may not choose the
-optimal breakpoints.  We will continue to work on the algorithm as we
-gain information from its actual use in the field.
+:ref:`automatic line breaking <automatic-linebreaking>` section for
+details).  Note that automatic line breaking only applies to displayed
+equations, not in-line equations, unless they are themselves longer
+than a line.  The algorithm uses the nesting depth, the type of
+operator, the size of spaces, and other factors to decide on the
+breakpoints, but it does not know the meaning of the mathematics, and
+may not choose the optimal breakpoints.  We will continue to work on
+the algorithm as we gain information from its actual use in the field.
 
 
 New AsciiMath input jax and SVG output jax
diff --git a/docs/html/output.html b/docs/html/output.html
@@ -207,6 +207,15 @@ <h2>Automatic Selection of the Output Processor<a class="headerlink" href="#auto
 can make it a fixed width, or make it a percentage of the container.
 See the <a class="reference internal" href="options/HTML-CSS.html#configure-html-css"><em>HTML-CSS configuration</em></a> or
 <a class="reference internal" href="options/SVG.html#configure-svg"><em>SVG configuration</em></a> pages for more details.</p>
+<p>The linbe-breaking algorithm uses the nesting depth, the type of
+operator, the size of spaces, and other factors to decide on the
+breakpoints, but it does not know the meaning of the mathematics, and
+may not choose the optimal breakpoints. We will continue to work on
+the algorithm as we gain information from its actual use in the field.
+If you are using <a class="reference internal" href="glossary.html#term-mathml"><em class="xref std std-term">MathML</em></a> as your input format, you can use the
+<tt class="docutils literal"><span class="pre">linebreak=&quot;goodbreak&quot;</span></tt> and <tt class="docutils literal"><span class="pre">linebreak=&quot;badbreak&quot;</span></tt> attributes on
+<tt class="docutils literal"><span class="pre">&lt;mo&gt;</span></tt> elements to help MathJax pick the best breakpoints for your
+mathematics.</p>
 </div>
 <div class="section" id="html-css-with-ie">
 <span id="html-css-with-ie8"></span><h2>HTML-CSS with IE<a class="headerlink" href="#html-css-with-ie" title="Permalink to this headline">¶</a></h2>
diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js
diff --git a/docs/html/whats-new-2.0.html b/docs/html/whats-new-2.0.html
@@ -93,7 +93,7 @@ <h2>Automatic equation numbering of TeX formulas<a class="headerlink" href="#aut
 (though the default is not to number equations so that existing pages
 will not change their appearance).  This is controlled through the
 <tt class="docutils literal"><span class="pre">equationNumbers</span></tt> section of the <tt class="docutils literal"><span class="pre">TeX</span></tt> block of your configuration
-(see the <a class="reference internal" href="options/TeX.html#configure-tex"><em>TeX configuration options</em></a> page for
+(see the <a class="reference internal" href="tex.html#tex-eq-numbers"><em>equation numbering</em></a> section for
 details).  You can request that the numbering follow the AMS-style
 numbering of environments, or you can request that every displayed
 equation be numbered.  There are now <tt class="docutils literal"><span class="pre">\label</span></tt>, <tt class="docutils literal"><span class="pre">\ref</span></tt>, and
@@ -106,15 +106,14 @@ <h2>Automatic line breaking of long displayed equations<a class="headerlink" hre
 breaking of displayed equations in its HTML-CSS output.  This is
 disabled by default, but can be enabled via the <tt class="docutils literal"><span class="pre">linebreaks</span></tt> section
 of the <tt class="docutils literal"><span class="pre">HTML-CSS</span></tt> or <tt class="docutils literal"><span class="pre">SVG</span></tt> block of your configuration (see the
-<a class="reference internal" href="options/HTML-CSS.html#configure-html-css"><em>HTML-CS configuration options</em></a> or <a class="reference internal" href="options/SVG.html#configure-svg"><em>SVG
-configuration options</em></a> page for details).  Note that
-automatic line breaking only applies to displayed equations, not
-in-line equations, unless they are themselves longer than a line.  The
-algorithm uses the nesting depth, the type of operator, the size of
-spaces, and other factors to decide on the breakpoints, but it does
-not know the meaning of the mathematics, and may not choose the
-optimal breakpoints.  We will continue to work on the algorithm as we
-gain information from its actual use in the field.</p>
+<a class="reference internal" href="output.html#automatic-linebreaking"><em>automatic line breaking</em></a> section for
+details).  Note that automatic line breaking only applies to displayed
+equations, not in-line equations, unless they are themselves longer
+than a line.  The algorithm uses the nesting depth, the type of
+operator, the size of spaces, and other factors to decide on the
+breakpoints, but it does not know the meaning of the mathematics, and
+may not choose the optimal breakpoints.  We will continue to work on
+the algorithm as we gain information from its actual use in the field.</p>
 </div>
 <div class="section" id="new-asciimath-input-jax-and-svg-output-jax">
 <h2>New AsciiMath input jax and SVG output jax<a class="headerlink" href="#new-asciimath-input-jax-and-svg-output-jax" title="Permalink to this headline">¶</a></h2>
diff --git a/docs/source/output.rst b/docs/source/output.rst
@@ -188,6 +188,16 @@ can make it a fixed width, or make it a percentage of the container.
 See the :ref:`HTML-CSS configuration <configure-HTML-CSS>` or
 :ref:`SVG configuration <configure-SVG>` pages for more details.
 
+The linbe-breaking algorithm uses the nesting depth, the type of
+operator, the size of spaces, and other factors to decide on the
+breakpoints, but it does not know the meaning of the mathematics, and
+may not choose the optimal breakpoints. We will continue to work on
+the algorithm as we gain information from its actual use in the field.
+If you are using :term:`MathML` as your input format, you can use the
+``linebreak="goodbreak"`` and ``linebreak="badbreak"`` attributes on
+``<mo>`` elements to help MathJax pick the best breakpoints for your
+mathematics.
+
 
 .. _html-css-with-ie8:
 
diff --git a/docs/source/whats-new-2.0.rst b/docs/source/whats-new-2.0.rst
@@ -56,7 +56,7 @@ The TeX input jax now can be configured to add equation numbers
 (though the default is not to number equations so that existing pages
 will not change their appearance).  This is controlled through the
 ``equationNumbers`` section of the ``TeX`` block of your configuration
-(see the :ref:`TeX configuration options <configure-TeX>` page for
+(see the :ref:`equation numbering <tex-eq-numbers>` section for
 details).  You can request that the numbering follow the AMS-style
 numbering of environments, or you can request that every displayed
 equation be numbered.  There are now ``\label``, ``\ref``, and
@@ -71,15 +71,14 @@ MathJax now implements the MathML3 specification for automatic line
 breaking of displayed equations in its HTML-CSS output.  This is
 disabled by default, but can be enabled via the ``linebreaks`` section
 of the ``HTML-CSS`` or ``SVG`` block of your configuration (see the
-:ref:`HTML-CS configuration options <configure-HTML-CSS>` or :ref:`SVG
-configuration options <configure-SVG>` page for details).  Note that
-automatic line breaking only applies to displayed equations, not
-in-line equations, unless they are themselves longer than a line.  The
-algorithm uses the nesting depth, the type of operator, the size of
-spaces, and other factors to decide on the breakpoints, but it does
-not know the meaning of the mathematics, and may not choose the
-optimal breakpoints.  We will continue to work on the algorithm as we
-gain information from its actual use in the field.
+:ref:`automatic line breaking <automatic-linebreaking>` section for
+details).  Note that automatic line breaking only applies to displayed
+equations, not in-line equations, unless they are themselves longer
+than a line.  The algorithm uses the nesting depth, the type of
+operator, the size of spaces, and other factors to decide on the
+breakpoints, but it does not know the meaning of the mathematics, and
+may not choose the optimal breakpoints.  We will continue to work on
+the algorithm as we gain information from its actual use in the field.
 
 
 New AsciiMath input jax and SVG output jax
