summaryrefslogtreecommitdiff
path: root/docs/modules/migrate
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2021-07-30 23:52:15 -0600
committerDan Allen <dan.j.allen@gmail.com>2021-07-31 01:25:57 -0600
commit634d67e57ecec4a355282055e5b94dc2e6d60c2c (patch)
tree0842e12e2864f685d794aaaeb6ff8fc4a3dbcaf3 /docs/modules/migrate
parent723aad7eb5ca57ac7404981f33cb8d3c7c4352e6 (diff)
better illustrate the influence of compat-mode on the syntax for inline formatting on AsciiDoc.py migration page
Diffstat (limited to 'docs/modules/migrate')
-rw-r--r--docs/modules/migrate/pages/asciidoc-py.adoc43
1 files changed, 19 insertions, 24 deletions
diff --git a/docs/modules/migrate/pages/asciidoc-py.adoc b/docs/modules/migrate/pages/asciidoc-py.adoc
index 4b1ee214..52762091 100644
--- a/docs/modules/migrate/pages/asciidoc-py.adoc
+++ b/docs/modules/migrate/pages/asciidoc-py.adoc
@@ -71,32 +71,34 @@ This section outlines those improvements and how they different from the legacy
|Feature |AsciiDoc.py |Asciidoctor |Notes
|_italic text_
-|pass:['italic text']
+|pass:['italic text'] or pass:[_italic text_]
|pass:[_italic text_]
-|Allowed with `compat-mode`.
-See xref:asciidoc:text:italic.adoc[].
+|See xref:asciidoc:text:italic.adoc[]. +
+Reverts to AsciiDoc.py syntax when `compat-mode` is enabled.
|`monospace text`
|pass:[+monospace text+]
-|pass:[`monospace text`]
-|Allowed with `compat-mode`.
-See xref:asciidoc:text:monospace.adoc[].
+|pass:[`monospace text`] or pass:[[x-\]+monospace text+]
+|See xref:asciidoc:text:monospace.adoc[]. +
+Reverts to AsciiDoc.py syntax when `compat-mode` is enabled.
-|`+literal monospace text+`
+|`literal monospace text`
|pass:[`literal monospace text`]
-|pass:[`+literal monospace text+`]
-|Allowed with `compat-mode`.
-See xref:asciidoc:text:monospace.adoc#literal-monospace[Literal monospace].
+|pass:[`+literal monospace text+`] or pass:[[x-\]`literal monospace text`]
+|See xref:asciidoc:text:monospace.adoc#literal-monospace[Literal monospace]. +
+Reverts to AsciiDoc.py syntax when `compat-mode` is enabled.
|Curved "`double quotes`"
|pass:[``double quotes'']
-|pass:["`double quotes`"], editor keybinding, or Unicode character in numeric character reference form
-|See xref:asciidoc:text:quotation-marks-and-apostrophes.adoc[].
+|pass:["`double quotes`"]
+|See xref:asciidoc:text:quotation-marks-and-apostrophes.adoc[]. +
+Reverts to AsciiDoc.py syntax when `compat-mode` is enabled.
|Curved '`single quotes`'
|pass:[`single quotes']
-|pass:['`single quotes`'], editor keybinding, or Unicode character in numeric character reference form
-|See xref:asciidoc:text:quotation-marks-and-apostrophes.adoc[].
+|pass:['`single quotes`']
+|See xref:asciidoc:text:quotation-marks-and-apostrophes.adoc[]. +
+Reverts to AsciiDoc.py syntax when `compat-mode` is enabled.
|Sizes and overline
|`big`, `small`, `overline`
@@ -142,20 +144,13 @@ See xref:asciidoc:text:monospace.adoc#literal-monospace[Literal monospace].
|===
|Feature |AsciiDoc.py |Asciidoctor |Notes
-|Implicit document title attribute
-|First content line at document top is set as title
-|`= Title`
-|Allowed with `compat-mode`.
-See xref:asciidoc:document:title.adoc[].
-
|Two-line style (setext) document title
|`Title` +
`+=====+`
|`= Title`
-|Asciidoctor accepts the two-line heading style to set the document title.
-But, by using it, `compat-mode` is implicitly set.
-To use the new syntax, use `= Title` or explicitly unset `compat-mode`.
-See xref:asciidoc:document:title.adoc[].
+|See xref:asciidoc:document:title.adoc[]. +
+When Asciidoctor detects the two-line style document title, it switches to compat mode by implicitly setting `compat-mode`.
+To revert this behavior, explicitly unset `compat-mode`.
|Underlined section titles
|Underline length must match title length +/- 2 characters.