Skip to content

Commit

Permalink
docs(manual): Touchup minor details in copy-editing
Browse files Browse the repository at this point in the history
Co-authored-by: Omikhleia <didier.willis@gmail.com>
  • Loading branch information
alerque and Omikhleia committed Mar 23, 2023
1 parent 7b083cd commit 5d21a3e
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 18 deletions.
5 changes: 3 additions & 2 deletions documentation/c01-whatis.sil
Expand Up @@ -96,7 +96,8 @@ alter the behaviour of the SILE typesetter.

For instance, one of the things that TeX can’t do particularly well is
typesetting on a grid. This a must-have feature for anyone
typesetting bibles and other complicated documents. Typesetting on a grid means that each line of text will
typesetting bibles and other documents to be printed on thin paper.
Typesetting on a grid means that each line of text will
line up between the front and back of each piece of paper producing much less
visual bleed-through when printed on thin paper. This is virtually impossible
to accomplish in TeX. There are various hacks to try to make it happen, but
Expand Down Expand Up @@ -163,7 +164,7 @@ SILE.
\section{Conclusion}

SILE\footnote{In case you’re wondering, the author pronounces it
\font[family=Gentium Plus]{/saɪəl/}, to rhyme with “trial.”} {}takes some textual
\font[family=Gentium Plus]{/saɪəl/}, to rhyme with “trial”.} {}takes some textual
instructions and turns them into PDF output. It has
features inspired by TeX and InDesign, but seeks to be more flexible,
extensible and programmable than either of them. It’s useful both for
Expand Down
6 changes: 3 additions & 3 deletions documentation/c08-language.sil
Expand Up @@ -61,7 +61,7 @@ To describe this, SILE uses the concept of a \em{writing direction,}
which denotes the way each individual line appears on the page—left
to right for Latin scripts, right to left for Arabic, Hebrew and so on,
top to bottom for traditional Japanese—and a \em{page advance direction,}
which denotes the way the lines “stack up.” Each of these directions can
which denotes the way the lines “stack up”. Each of these directions can
take one of four values: \code{LTR}, \code{RTL}, \code{TTB}, or \code{BTT}.
A \em{direction specification} is made up of either a writing direction
(\code{LTR} or \code{RTL}), in which case the page advance direction is
Expand Down Expand Up @@ -180,9 +180,9 @@ or \code{centered} to control which style is used. The default is \code{left}.
Esperanto typesetting is quite straight forward; however one feature of the language is unique:
the requirement that \em{all} adjectives, including numerals, have the suffix “\eo{ª}”.
This includes numbers standing on their own.
For example, “the 15th of March” is, in Esperanto, “\eo{la 15ª de marto}.”
For example, “the 15th of March” is, in Esperanto, “\eo{la 15ª de marto}”.
As there is lack of agreement%
\footnote{Wikipedia prefers “\eo{15-a}” while most professional books and posters prefer “\eo{15ª}.” Some authors even write “\eo{15a},” as the underlying word is “\eo{dekkvina}.”}
\footnote{Wikipedia prefers “\eo{15-a}” while most professional books and posters prefer “\eo{15ª}”. Some authors even write “\eo{15a}”, as the underlying word is “\eo{dekkvina}”.}
on how to typeset this, you have options:
\autodoc:setting[check=false]{languages.eo.ordinal.raisedsuffix} when made true will use \eo{ª} (as in “\eo{Ĉapitro 1ª}”) while
\autodoc:setting[check=false]{languages.eo.ordinal.hyphenbefore} will prepend a hyphen (as in “\eo{Ĉapitro 15-a}”).
Expand Down
2 changes: 1 addition & 1 deletion documentation/c09-concepts.sil
Expand Up @@ -88,7 +88,7 @@ output queue, the other new vertical content can be processed. At any point you
can force the current queue of horizontal content (the node queue) to be shaped
into lines and added to the vertical output queue by calling the function
\code{SILE.typesetter:leaveHmode()}. This is handy when for writing custom
functions, but it is a fairly low level control. (Tt is unlikely to be
functions, but it is a fairly low level control. (It is unlikely to be
useful while writing a document.) A related but higher level command,
\code{\\par}, is more frequently used when writing a document and embedded in
the content. The \code{\\par} command first calls
Expand Down
2 changes: 1 addition & 1 deletion documentation/c10-classdesign.sil
Expand Up @@ -247,7 +247,7 @@ The other way is to export functions that get added to the class itself and can

For examples check out the \code{tableofcontents} package for the hooks it sets, but also the \autodoc:command{\tocentry} command it registers that gets called manually in the \code{book} class.

Let’s demonstrate roughly how the \code{tableofcontents} package works.
Let’s demonstrate roughly how the \autodoc:package{tableofcontents} package works.
We’ll be using the \code{infonodes} package to collect the information about which pages contain table of content items.

First, we set up our infonodes by creating a command that can be called by sectioning commands.
Expand Down
4 changes: 2 additions & 2 deletions documentation/c11-xmlproc.sil
Expand Up @@ -13,10 +13,10 @@ In addition, options such as paper size could be set; for example, \code{-O pape
The class initalization for DocBoox isn’t too fancy; it just loads up a couple packages that will get used later.

\begin{note}
Much of the example code in this chapter is in SILE format using macros.
Much of the example code in this chapter is in SIL format using macros.
The actual \code{docbook} class currently uses Lua functions to specify these commands.
The functionality is the same, but the Lua syntax is more flexible and recommended for most use cases.
The SILE \code{\\define} macros shown here can still be used in a preamble file if desired.
The SILE \autodoc:command{\define} macros shown here can still be used in a preamble file if desired.
\end{note}

Now we can start defining SILE commands to render XML elements.
Expand Down
4 changes: 2 additions & 2 deletions documentation/c12-tricks.sil
Expand Up @@ -164,7 +164,7 @@ end
At the end of the document, we will use the
emergency \code{chuck} method. Where \code{leaveHmode} means “call the
page builder and see there’s enough material to build a page,” \code{chuck}
means “you must get rid of everything on your queue \em{now.”} We add some infinitely
means “you must get rid of everything on your queue \em{now}.” We add some infinitely
tall glue to the other typesetter’s queue to help the process along:

\begin{verbatim}
Expand Down Expand Up @@ -385,7 +385,7 @@ end
on the default typesetter. If we wanted to make things cleaner, we could swap
typesetters by assigning \code{discovery.innerTypesetter} to \code{SILE.typesetter}
and then calling ordinary commands, rather than doing the settings and glue
insertion “by hand.”}
insertion “by hand”.}

In the future it may make sense for there to be a standard \code{sidenotes}
package in SILE, but it has been instructive to see a couple of “non-standard”
Expand Down
3 changes: 2 additions & 1 deletion packages/date/init.lua
Expand Up @@ -32,7 +32,8 @@ end

package.documentation = [[
\begin{document}
The \autodoc:package{date} package provides the \autodoc:command{\date} command, which simply outputs the current date using the system’s date function.
The \autodoc:package{date} package provides the \autodoc:command{\date} command, which simply outputs a date using the system’s date function.
It defaults to the current date and time, but can be used to format any other input time as well using the \autodoc:parameter{time} parameter.
You can customize the format by passing the \autodoc:parameter{format} parameter, following the formatting codes in the Lua manual
(\url{https://www.lua.org/pil/22.1.html}).
\end{document}
Expand Down
2 changes: 1 addition & 1 deletion packages/math/init.lua
Expand Up @@ -180,7 +180,7 @@ Its main difference from the SILE syntax is that \code{\\mycommand\{arg1\}\{arg2
If it’s more convenient, you can use these Unicode characters directly.
The symbol shorthands are the same as in the TeX package \href[src=https://www.ctan.org/pkg/unicode-math]{\code{unicode-math}}.
\code{\\\{formula\}} is a shorthand for \code{\\mrow\{formula\}}.
\code{\{formula\}} is a shorthand for \code{\\mrow\{formula\}}.
Since parentheses—among other glyphs—stretch vertically to the size of their englobing \code{mrow}, this is useful to typeset parentheses of different sizes on the same line:
\begin[type=autodoc:codeblock]{raw}
Expand Down
3 changes: 1 addition & 2 deletions packages/tableofcontents/init.lua
Expand Up @@ -230,8 +230,7 @@ At the end of the document another hook function (\code{writeToc}) will write th
The next time the document is built, any use of the \autodoc:command{\tableofcontents} (typically near the beginning of a document) will be able to read that index data and output the TOC.
Because the toc entry and page data is not available until after rendering the document,
the TOC will not render until at least the second pass.
If by chance rendering the TOC itself changes the document pagination (e.g., the TOC spans more than one page) it might be necessary to run SILE three times to get accurate page numbers shown in the TOC.
If by chance rendering the TOC itself changes the document pagination (e.g., the TOC spans more than one page) it will be necessary to run SILE a third time to get accurate page numbers shown in the TOC.
The \autodoc:command{\tableofcontents} command accepts a \autodoc:parameter{depth} option to
control the depth of the content added to the table.
Expand Down
6 changes: 3 additions & 3 deletions packages/twoside/init.lua
Expand Up @@ -144,9 +144,9 @@ If so, it ejects another page to assure content starts on an odd page.
The \autodoc:command{\open-spread} is similar but a bit more tailored to use in book layouts.
By default, headers and folios will be suppressed automatically on any empty pages ejected, making them blank.
It can also accept three parameters.
The \autodoc:parameter{odd} parameter (default \code{false}) can be used to disable the opening page being odd, hence opening an even page spread.
The \autodoc:parameter{double} parameter (default \code{false}) can be used to always output at least one empty even page before the starting an odd page.
The \autodoc:parameter{blank} parameter (default \code{false}) can be used to not suppress headers and folios on otherwise empty pages.
The \autodoc:parameter{odd} parameter (default \code{true}) can be used to disable the opening page being odd, hence opening an even page spread.
The \autodoc:parameter{double} parameter (default \code{true}) can be used to always output at least one empty even page before the starting an odd page.
The \autodoc:parameter{blank} parameter (default \code{true}) can be used to not suppress headers and folios on otherwise empty pages.
Lastly the \autodoc:command{\open-spread-eject} command can be overridden to customize the output of blank pages.
By default it just runs \autodoc:command{\supereject}, but you could potentially add decorative content or other features in the otherwise empty space.
Expand Down

0 comments on commit 5d21a3e

Please sign in to comment.