diff options
| author | Kian Meng, Ang <kianmeng.ang@gmail.com> | 2021-12-24 14:46:04 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-23 23:46:04 -0700 |
| commit | de54df6307c2b1ad6db5a7f0b305b730b7afb096 (patch) | |
| tree | 12e5c4cc24b55e00d78df272eb7c1a33dd22d36c /docs | |
| parent | 633d5fee1f7cc40b87a3b74d2c379621099e3ef0 (diff) | |
Fix typos and misspellings in docs and code (PR #4222)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/html-backend/pages/custom-stylesheet.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/manpage-backend/pages/index.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/migrate/pages/asciidoc-py.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/stem/pages/asciimath-gem.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/stem/pages/mathematical.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/syntax-highlighting/pages/custom.adoc | 2 |
6 files changed, 9 insertions, 9 deletions
diff --git a/docs/modules/html-backend/pages/custom-stylesheet.adoc b/docs/modules/html-backend/pages/custom-stylesheet.adoc index 18591039..6bb57137 100644 --- a/docs/modules/html-backend/pages/custom-stylesheet.adoc +++ b/docs/modules/html-backend/pages/custom-stylesheet.adoc @@ -95,7 +95,7 @@ You can achieve the same result by including the directory in the value of the ` If you set the value of `stylesdir` to an absolute directory, then Asciidoctor would still locate the stylesheet and embed it into the HTML. But this can create problems if you've configured the converter to link to the stylesheet instead. -Let's look at thoses problem and ways to work through them. +Let's look at those problem and ways to work through them. [#stylesdir-and-linkcss] == Styles directory and linkcss diff --git a/docs/modules/manpage-backend/pages/index.adoc b/docs/modules/manpage-backend/pages/index.adoc index 65a6d6b9..9962a357 100644 --- a/docs/modules/manpage-backend/pages/index.adoc +++ b/docs/modules/manpage-backend/pages/index.adoc @@ -22,7 +22,7 @@ That makes the source of the man page reusable. == manpage doctype The `manpage` doctype declares that the AsciiDoc structure serves as the source of a man page and conforms to the man page structure. -Notice the absense of the space in the doctype value. +Notice the absence of the space in the doctype value. By declaring the `manpage` doctype, the AsciiDoc processor expects the document to conform to the following structure. @@ -66,7 +66,7 @@ In this example, the output filename is [.path]_eve.1_. Asciidoctor provides a built-in converter to generate {url-man-7}[roff-formatted^] man pages for AsciiDoc documents that declare and conform to the manpage doctype. This converter is bound to the `manpage` backend (not to be confused with the `manpage` doctype). -Notice the absense of the space in the backend value. +Notice the absence of the space in the backend value. The man page converter is used to generate man pages that accompany software on Unix-like operating systems. In fact, Asciidoctor's own man page (i.e., `man asciidoctor`) is generated in this way from {url-asciidoctor-1-raw}[this AsciiDoc source]. diff --git a/docs/modules/migrate/pages/asciidoc-py.adoc b/docs/modules/migrate/pages/asciidoc-py.adoc index f3f11c88..8c108a50 100644 --- a/docs/modules/migrate/pages/asciidoc-py.adoc +++ b/docs/modules/migrate/pages/asciidoc-py.adoc @@ -42,7 +42,7 @@ If you require more advanced theming, you can inject additional resources using [#migrate-stylesheet] === Default HTML stylesheet -The Asciidoctor and AsciiDoc.py stylesheets look quite different, but they're mostly interchangable since the underlying HTML structure of the two processors is nearly identical. +The Asciidoctor and AsciiDoc.py stylesheets look quite different, but they're mostly interchangeable since the underlying HTML structure of the two processors is nearly identical. If you prefer the AsciiDoc.py stylesheet, you can use it by copying it from the AsciiDoc.py [.path]_stylesheets_ directory and instructing Asciidoctor to apply it using: @@ -316,7 +316,7 @@ ifdef::compat-mode[Compat mode is on!] ---- When compat mode is enabled, Asciidoctor adapts some of its behavior and its interpretation of AsciiDoc to more closely align with AsciiDoc.py. -The most noticable difference is that backticks now only indicate monospace text as oppossed to literal monospace. +The most noticeable difference is that backticks now only indicate monospace text as opposed to literal monospace. Literal monospace is signified using a compound markup that combines an inline passthrough with monospace formatting. [cols=3*,width=75%] diff --git a/docs/modules/stem/pages/asciimath-gem.adoc b/docs/modules/stem/pages/asciimath-gem.adoc index 760692f6..a8e1213f 100644 --- a/docs/modules/stem/pages/asciimath-gem.adoc +++ b/docs/modules/stem/pages/asciimath-gem.adoc @@ -60,7 +60,7 @@ The DocBook converter will emit the following XML into the generated document: <inlineequation><mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML"><mml:msqrt><mml:mn>4</mml:mn></mml:msqrt></mml:math></inlineequation> ---- -It's now up to the DocBook toolchain to convert the MathML embeded in the DocBook into a displayable format. +It's now up to the DocBook toolchain to convert the MathML embedded in the DocBook into a displayable format. Here's the result you should see: ==== diff --git a/docs/modules/stem/pages/mathematical.adoc b/docs/modules/stem/pages/mathematical.adoc index c662628f..8e9974fd 100644 --- a/docs/modules/stem/pages/mathematical.adoc +++ b/docs/modules/stem/pages/mathematical.adoc @@ -19,7 +19,7 @@ All the converter sees are image nodes that reference the generated images. Upon visiting each STEM node, the extension first extracts the expression source. If the expression is written in AsciiMath, the extension uses the AsciiMath library to convert that expression to LaTeX. The extension then passes the expression to Mathematical to render it as an image. -The image is sized automatically to accomodate the rendered expression and, if necessary, resized to fit within the line. +The image is sized automatically to accommodate the rendered expression and, if necessary, resized to fit within the line. Once the image is generated, the extension replaces the STEM node in the parsed document with an image node that references the generated image. When the extension finishes processing all the STEM nodes, it unsets the `stem` attribute on the document to indicate no further STEM processing should be performed on the document. @@ -30,7 +30,7 @@ Since Asciidoctor Mathematical replaces all STEM nodes with image nodes, it serv All converters know how do deal with image nodes. The extension can be used with the built-in converters as well as add-on converters such as PDF and EPUB3. -The main drawback of Asciidoctor Mathmatical when compared to MathJax is that you don't have a lot of control over the size and resolution of the images it generates. +The main drawback of Asciidoctor Mathematical when compared to MathJax is that you don't have a lot of control over the size and resolution of the images it generates. It also lacks the interactivity with the expression that MathJax provides. So when your converting to HTML, MathJax is going to give you a better result. diff --git a/docs/modules/syntax-highlighting/pages/custom.adoc b/docs/modules/syntax-highlighting/pages/custom.adoc index 141804cb..9c390d14 100644 --- a/docs/modules/syntax-highlighting/pages/custom.adoc +++ b/docs/modules/syntax-highlighting/pages/custom.adoc @@ -62,4 +62,4 @@ You can do so by overriding the `highlight` method, setting the `:number_lines` include::example$always-number-lines.rb[] ---- -To study the logic you may be interesting in overridding, browse the code for the https://github.com/asciidoctor/asciidoctor/tree/{page-origin-refname}/lib/asciidoctor/syntax_highlighter[built-in syntax highlighter adapters]. +To study the logic you may be interesting in overriding, browse the code for the https://github.com/asciidoctor/asciidoctor/tree/{page-origin-refname}/lib/asciidoctor/syntax_highlighter[built-in syntax highlighter adapters]. |
