Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation fixes #31

Merged
merged 3 commits into from
Apr 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This collection offers:
styling decisions with a consistent and unified approach, abstracting the complexity.
- A pretty strong “book” class, with:
- A mind-bogling choice of sound page layouts — old-fashioned or modern,
- Almost everything you may expect for such a class: parts, chapters, sections, subsection, subsubsection
- Almost everything you may expect for such a class: parts, chapters, sections, subsections, subsubsections
- Highly configurable table of contents, headers, footers, footnotes and sectioning environments,
- And other useful features, from cross-references to advanced captioned figure and table environments, and more…
- A great parity with Markdown, including many Pandoc-like extensions.
Expand Down
14 changes: 9 additions & 5 deletions examples/manual-layouts/layouts.sil
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
\section{The layout class option}

Paper sizes for printed works varied a lot across time.
Frequent ratios nowadays are 1:√2 (such as the ISO paper sizes, e.g. A4, 21 × 29.7 cm)
Frequent ratios nowadays are 1:√2 (such as the ISO paper sizes, e.g. A5, 14,8 × 21 cm)
or 2:3 (such as US trade, 6 × 9 in), though there are still plenty of other page formats
in use (e.g. French pocket books often often come in 10 × 17 cm or 10 × 18 cm format.)
in use (e.g. French pocket books often come in 10 × 17 cm or 10 × 18 cm format.)

The relation betwen the page size and the main text block also varied a lot,
The relation between the page size and the main text block also varied a lot,
depending on the aesthetic tastes of authors and designers.

The resilient document classes provide a \autodoc:parameter{layout=<string>} class
Expand Down Expand Up @@ -49,8 +49,12 @@ the binding process. Unfortunately, it cannot really be automated, as it
usually depends on many internal and external factors—notably, the number of pages,
the thickness of the selected paper, and the printer’s binding process.

The resilient document classes provide a \autodoc:parameter{offset=<dimen>}
class option. When used, it shifts the text block by the given amount.
The resilient document classes provide the \autodoc:parameter{offset=<dimen>}
class option.
When used, it shifts the text block by the given amount.\footnote{Please note that
it applies to page masters derived from a resilient layout.
If you designed your own page templates with SILE’s low-level constructs,
you are fully responsible for taking a binding offset into account there.}

Books of less than 60 pages do not normally need to include such a gutter,
but with a higher page count, you may have to consider using it,
Expand Down
2 changes: 1 addition & 1 deletion examples/manual-styling/advanced/liststyles.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ environments.
pre-defined, all of the styles inheriting from a common parent
style `lists-enumerate-base`.

When styling your lists, you have more the one option.
When styling your lists, you have more than one option.

- You may, of course, alter these styles at your convenience, whether
the "main" set, the `alternate` set, or both.
Expand Down
2 changes: 1 addition & 1 deletion examples/manual-styling/advanced/toclevels.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ toc-number-level5:

Finally, the `toc-pageno` character style is applied to page number
references, when the corresponding ToC style enabled the `pageno` option.
Its defult definition is empty. Would you want old-style page numbers,
Its default definition is empty. Would you want old-style page numbers,
you could define it as follows:

```yaml
Expand Down
6 changes: 3 additions & 3 deletions examples/manual-styling/basics/character.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The fields are all optional and define:
- The text to prepend to the number.
- The text to append to the number.
- The kerning space added before the formatted number.
- The kerning space add after the fomatted number.
- The kerning space added after the fomatted number.

The default display format, when not specified, is `arabic`.

Expand All @@ -85,12 +85,12 @@ with the following additions:
- The `thsp` thin space unit, as 1/2 fixed inter-word space.[^character-thsp]
- The `iwsp` inter-word space pseudo-unit.
The inter-word space is stretchable and shrinkable, so dimensions expressed
in this pseudo-unit cannot contain extra strech and shrink values.
in this pseudo-unit cannot contain extra stretch and shrink values.

[^character-thsp]: The term "thin space" has varying interpretations
depending on typographers. Some make it dependent on the font size (as a
portion of it, e.g. ⅙ of an "em"); others make it relative to the
inter-word (justification) space. We follow here the latter, so as two
be able to have two inter-word spacing options (`2thsp` = `1iwsp` without
streching or enlargement).
stretching or shrinking).

2 changes: 1 addition & 1 deletion examples/manual-styling/basics/lists.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## List label styles

The bullet symbol in unordered lists item, and the counter in
The bullet symbol in unordered list items, and the counter in
ordered lists, rely on extended character styles.

### Styles for unordered items
Expand Down
4 changes: 2 additions & 2 deletions examples/manual-styling/basics/paragraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ low-level paragraph formatting options (paragraph indent, etc.)[^styles-par-marg

[^styles-par-margins]: This might be considered in a future revision, but note
that it may also be addressed by defining extra alignment options.
The **resilien.book** class, for instance, defines its own `block` option
The **resilien.book** class, for instance, defines its own `block` alignment option
(used in block quotes).

Please note that changing an existing character style into a paragraph style
does not imply that the content is magically turned into paragraphs.
When classes or packages expect a character style at some point, only
that part of style definition is used. Classes and packages are responsible
that part of the style definition is used. Classes and packages are responsible
for applying the paragraph part too, depending on context.

2 changes: 1 addition & 1 deletion resilient/layouts/base.lua
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ function layout:draw (W, H, options)
outputYourself = function(node, typesetter, line)
local saveX = typesetter.frame.state.cursorX
local saveY = typesetter.frame.state.cursorY
-- Scale to line to take into account strech/shrinkability
-- Scale to line to take into account stretch/shrinkability
local outputWidth = node:scaledWidth(line)
-- Force advancing to get the new cursor position
typesetter.frame:advanceWritingDirection(outputWidth)
Expand Down