Commit 0d814aad authored by Dan Allen's avatar Dan Allen
Browse files

resolves #8 correct the term "STEM interpreter" to "STEM notation" (PR #54)

parent a3cff33a
......@@ -9,6 +9,7 @@ https://github.com/asciidoctor/asciidoc-docs/commits/main[commit history].
Fixed::
* Rewrite much of link-macro-attribute-parsing.adoc to reflect the simplified parsing behavior implemented in https://github.com/asciidoctor/asciidoctor/issues/2059.
* Clarify that a negated tag selects all lines except for those lines containing a tag directive (not simply all lines as it previously suggested)
* Correct the term "STEM interpreter" to "STEM notation" (#8)
Added::
* Add example of how to select all lines outside of tagged regions and lines inside a specific tagged region
......
......@@ -16,29 +16,29 @@ To activate equation and formula support, simply set the `stem` attribute in the
----
include::example$stem.adoc[tag=base-co]
----
<.> The default interpreter value, `asciimath`, is assigned implicitly.
<.> The default notation value, `asciimath`, is assigned implicitly.
By default, Asciidoctor's stem support assumes all equations are AsciiMath if not specified explicitly.
The HTML backend supports stem content written in {url-asciimath}[Asciimath^] and {url-latexmath}[TeX and LaTeX^] math notation.
The HTML backend supports STEM content written in {url-asciimath}[Asciimath^] and {url-latexmath}[TeX and LaTeX^] math notation.
The DocBook backend only supports AsciiMath notation.
If you want to use the LaTeX interpreter by default, assign `latexmath` to the stem attribute.
If you want to use the LaTeX notation by default, assign `latexmath` to the stem attribute.
.Assigning an alternative interpreter to the stem attribute
.Assigning an alternative notation to the stem attribute
[source]
----
include::example$stem.adoc[tag=base-alt]
----
TIP: You can use both interpreters in the same document.
The value of the `stem` attribute merely sets the default interpreter.
To set the interpreter explicitly for a given block or inline span, just use `asciimath` or `latexmath` in place of `stem` as explained in <<multiple-interpreters>>.
TIP: You can use both notations in the same document.
The value of the `stem` attribute merely sets the default notation.
To set the notation explicitly for a given block or inline span, just use `asciimath` or `latexmath` in place of `stem` as explained in <<mixing-notations>>.
Stem content can be displayed inline with other content or as discrete blocks.
No substitutions are applied to the content within a stem macro or block.
[#inline]
== Inline stem content
== Inline STEM content
The best way to mark up an inline formula is to use the `stem` macro.
......@@ -48,7 +48,7 @@ The best way to mark up an inline formula is to use the `stem` macro.
include::example$stem.adoc[tag=in-co]
----
<.> The inline stem macro contains only one colon (`:`).
<.> Place the content you want interpreted within the square brackets (`[ ]`) of the macro.
<.> Place the expression within the square brackets (`[ ]`) of the macro.
The result of <<ex-inline>> is displayed below.
......@@ -74,7 +74,7 @@ A stem macro is an implicit passthrough macro.
That's why, despite the fact that the x expression matches the syntax of an attribute reference, you don't have to escape it.
[#block]
== Block stem content
== Block STEM content
Block formulas are marked up by assigning the `stem` style to a delimited passthrough block.
......@@ -93,12 +93,12 @@ include::example$stem.adoc[tag=bl]
TIP: You don't need to add special delimiters around the expression as the {url-mathjax-docs}[MathJax documentation^] suggests.
Asciidoctor handles that for you automatically!
[#multiple-interpreters]
== Using multiple STEM interpreters
[#mixing-notations]
== Mixing STEM notations
You can use multiple interpreters for stem content within the same document by using the interpreter's name instead of the default `stem` name.
You can use multiple notations for STEM content within the same document by using the notation's name instead of the keyword `stem`.
For example, if you want LaTeXMath to interpret an inline equation, name the macro `latexmath`.
For example, if you want to write an inline equation using the LaTeX notation, name the macro `latexmath`.
.Inline latexmath macro syntax
[source#ex-latexmath]
......@@ -110,7 +110,7 @@ The result of <<ex-latexmath>> is displayed below.
include::example$stem.adoc[tag=multi-l]
The name that maps to the interpreter you want to use can also be applied to block stem content.
The name that maps to the notation you want to use can also be applied to block STEM content.
.Delimited asciimath block syntax
[source]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment