summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorDarin Pope <darin@planetpope.com>2020-05-28 01:57:15 -0400
committerGitHub <noreply@github.com>2020-05-27 23:57:15 -0600
commit560f809b90893f030fd735bf6dfe663be0f56bac (patch)
tree5d1b6bcd976412af7b5eaf56512c0d8aca50760f /README.adoc
parent36dfc797bf8b02facf1d2f72dfe870d3bbe8d168 (diff)
fix a few spelling and grammar fixes in the README (PR #1708)
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.adoc b/README.adoc
index 6b40ae8f..b52015dc 100644
--- a/README.adoc
+++ b/README.adoc
@@ -98,7 +98,7 @@ But don't miss the <<Highlights>> to get a preview of what's possible.
* Footnotes are always displayed as endnotes (at the end of chapter for books; at the end of document for all other doctypes).
*Footnotes cannot be displayed at the bottom of the page because the PDF generator does not support content reflows* (see https://github.com/asciidoctor/asciidoctor-pdf/issues/85#issuecomment-577412975[#85] for reasoning).
-* Table cells that exceed height of a single page will be truncated (see https://github.com/prawnpdf/prawn-table/issues/41[prawn-table#41]).
+* Table cells that exceed the height of a single page will be truncated (see https://github.com/prawnpdf/prawn-table/issues/41[prawn-table#41]).
* Inline images in table cells must fit within available column width or a Prawn::Errors::CannotFit error will be thrown (see https://github.com/asciidoctor/asciidoctor-pdf/issues/1608 for workarounds).
* Columns cannot be assigned a 0% width (or a width less than the width of a single character); in the same vein, a column cannot be set to autowidth if width of all other columns meets or exceeds 100%; the result is that the converter with throw a Prawn::Errors::CannotFit error.
* An inline image in a table cell will not force the column wider if the width of the image exceeds the width of the column; either reduce the image width using `pdfwidth` or increase the width of the column using `cols`; another solution is to convert the cell to an AsciiDoc table cell (see https://github.com/asciidoctor/asciidoctor-pdf/issues/830).
@@ -203,7 +203,7 @@ You then activate syntax highlighting for a given document by adding the `source
==== Upgrade Prawn and Extensions (optional)
{project-name} uses Prawn to handle the PDF generation, which has a different release cycle.
-At times, there may are development features in Prawn and its extensions you need to use which haven't yet been released.
+At times, there may be development features in Prawn and its extensions you need to use which haven't yet been released.
No problem.
You can still gain access to these features by installing the unreleased gems directly from GitHub.
@@ -263,7 +263,7 @@ It's time to convert the AsciiDoc document directly to PDF.
IMPORTANT: You'll need the `rouge` gem installed to run this example since it uses the `source-highlighter` attribute with the value of `rouge`.
-Converting to PDF is a simple as running the `asciidoctor-pdf` script using Ruby and passing our AsciiDoc document as the first argument.
+Converting to PDF is as simple as running the `asciidoctor-pdf` script using Ruby and passing our AsciiDoc document as the first argument.
$ asciidoctor-pdf basic-example.adoc
@@ -306,7 +306,7 @@ Asciidoctor can process the full range of characters in the UTF-8 character set.
That means you can write your document in any language, save the file with UTF-8 encoding (_that's important!_), and expect Asciidoctor to convert the text properly.
But you still need a font that provides the glyphs for those characters.
-When converting a document with Asciidoctor PDF, you may notice that some of the glyphs for certain languages, such as Chinese, are missing from the PDF.
+When converting a document with Asciidoctor PDF, you may notice that some glyphs for certain languages, such as Chinese, are missing from the PDF.
PDF is a "`bring your own font`" kind of system.
In other words, the font you provide must provide glyphs for all the characters used.
There's no one font that supports all the world's languages (though some, like Noto Serif, certainly come close).
@@ -472,7 +472,7 @@ Otherwise, the SVG library will fail to process it.
As of Asciidoctor PDF 1.5.0.alpha.17 running on Asciidoctor 2 or better, Asciidoctor PDF provides better integration with Asciidoctor Diagram by setting the `data-uri` attribute by default.
When the `data-uri` attribute is set, Asciidoctor Diagram returns the absolute path to the generated image, which Asciidoctor PDF can then locate.
(This makes sense since technically, Asciidoctor Diagram must embed the image in the document, similar in spirit to the `data-uri` feature for HTML).
-This means the input directory and the output directory (and thus the imagesoutdir) can differ and Asciidoctor PDF will still be able to locate the generate image.
+This means the input directory and the output directory (and thus the imagesoutdir) can differ and Asciidoctor PDF will still be able to locate the generated image.
Prior to Asciidoctor PDF 1.5.0.alpha.17 (or prior to Asciidoctor 2), the way to solve this problem is to set the `imagesdir` attribute to an absolute path.
That way, it won't matter where the generated image is written.
@@ -572,7 +572,7 @@ If the image height exceeds the height of the page, the image will be scaled dow
In addition to the width-related attributes previously covered, cover and background images can be sized relative to the page using the `fit` attribute of the image macro.
The `fit` attribute works similarly to the `object-fit` property in CSS.
-It's value must be specified as a single keyword, chosen from the table below.
+Its value must be specified as a single keyword, chosen from the table below.
The starting size of the image is determined by the explicit width, if specified, or the implicit width.
The height is always derived from the width while respecting the implicit aspect ratio of the image.
The available space for a background image (i.e., the canvas) is the page.
@@ -784,7 +784,7 @@ You can find a list of all the special fragment parameters in the https://www.ad
=== Converting Interdocument Xrefs to Internal Xrefs
-If you're using this conveter to generate a single PDF file from multiple source documents (combined using the include directive), references between those included documents must become interal references.
+If you're using this converter to generate a single PDF file from multiple source documents (combined using the include directive), references between those included documents must become internal references.
Interdocument cross references (i.e., xrefs) will only successfully make that transition if you structure your document in accordance with the rules.
Those rules are as follows:
@@ -930,7 +930,7 @@ Here's an example of how to skip a passthrough block when converting to PDF:
\endif::[]
----
-Here's an example of how to only enable a passthrough block when convertering to HTML5:
+Here's an example of how to only enable a passthrough block when converting to HTML5:
[source,asciidoc]
----
@@ -1052,7 +1052,7 @@ This value is used as the heading of the preface and as the text of the entry in
Asciidoctor PDF supports generating an index catalog that itemizes all index terms defined in the document, allowing the reader to navigate the document by keyword.
-To get Asciidoctor PDF to generate an index, add an level-1 section annotated with the `index` style near the end of your document.
+To get Asciidoctor PDF to generate an index, add a level-1 section annotated with the `index` style near the end of your document.
The converter will automatically populate the catalog with the list of index terms in the document, organized by first letter.
[source,asciidoc]
@@ -1130,7 +1130,7 @@ You can enable this feature by setting the `compress` attribute on the document:
$ asciidoctor-pdf -a compress document.adoc
-For more thorough optimization, you can use the integrated optimizer or hexapdf.
+For a more thorough optimization, you can use the integrated optimizer or hexapdf.
Read on to learn how.
=== rghost