Skip to content

Commit

Permalink
[output.rst] improve linebreaking section
Browse files Browse the repository at this point in the history
Fixes #142
  • Loading branch information
pkra committed Apr 13, 2016
1 parent 1e9e93e commit 7439aac
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,24 @@ See the :ref:`CommonHTML configuration <configure-CommonHTML>`,
:ref:`HTML-CSS configuration <configure-HTML-CSS>`, or
:ref:`SVG configuration <configure-SVG>` pages for more details.

Note that breaks occur only at operations and relations or at
explicit space, but not, for example, in the middle two consecutive
identifiers.

The line-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
may not choose the optimal breakpoints. We 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
``linebreak="goodbreak"``, ``linebreak="badbreak"``, and
``linebreak="nobreak"`` attributes on

This comment has been minimized.

Copy link
@dpvc

dpvc Apr 17, 2016

Member

Should linebreak="newline" also be listed here, now that you have added nobreak?

``<mo>`` elements to help MathJax pick the best breakpoints for your
mathematics.
mathematics; nested ``<mrow>`` elements will reduce the risk of
breaking its children apart. For TeX input, you can use MathJax's
non-standard ``mmltoken`` macro (e.g.,
``\mmlToken{mo}[linebreak="goodbreak"]{}``) to achieve the same
effect.

This comment has been minimized.

Copy link
@dpvc

dpvc Apr 17, 2016

Member

The phrase "the same result" is ambiguous here. It sounds like it is the <mrow> effect, when it is actually the line break attribute that you are talking about. This can be achieved in TeX by adding extra bracing ({...} adds an extra <mrow>...</mrow>). Perhaps you want to break these two ideas (goodbreak/badbreak versus nesting) into two separate paragraphs, and give the MathML and TeX for that idea in that paragraph. (Alternatively, do both MathML ideas in one paragraph and both TeX versions in the next).



.. _automatic-output-switch:
Expand Down

1 comment on commit 7439aac

@pkra
Copy link
Contributor Author

@pkra pkra commented on 7439aac Apr 18, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect a PR would be more efficient

Please sign in to comment.