summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/stocksize/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/stocksize/README.md')
-rw-r--r--macros/latex/contrib/stocksize/README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/macros/latex/contrib/stocksize/README.md b/macros/latex/contrib/stocksize/README.md
index 778a7c186d..48852a2660 100644
--- a/macros/latex/contrib/stocksize/README.md
+++ b/macros/latex/contrib/stocksize/README.md
@@ -1,7 +1,7 @@
# stocksize
This package provides a flexible and easy interface to change the paper (stock) dimensions in LaTeX documents.
-Multiple user defined stock sizes are allowed in the same document, and sock sizes can be nested (in a LIFO order).
+Multiple user defined stock sizes are allowed in the same document, and stock sizes can be nested (in a LIFO order).
## About
@@ -13,7 +13,7 @@ Multiple user defined stock sizes are allowed in the same document, and sock siz
## Introduction
-The package [geometry](https://github.com/LaTeX-Package-Repositories/geometry) is excellent for customuzing the page layout. However, changing the page size in the middle of the document only changes the typing area and does not affect the real paper (sock) size. This package circunvents this situation, by resizing the paper (stock) size to the given size.
+The package [geometry](https://github.com/LaTeX-Package-Repositories/geometry) is excellent for customising the page layout. However, changing the page size in the middle of the document only changes the typing area and does not affect the real paper (stock) size. This package circumvents this situation by resizing the paper (stock) size to the given size.
## User Interface
@@ -29,18 +29,20 @@ Simply load the package with (with no options):
To start a new page with a different page/stock size use the \verb!\newstocksize! and \verb!restorestocksize! commands.
```latex
-\newstocksize{options} — This command starts a new stock (and paper) size. The `options` are passed straight to the \newgeometry command form the `geometry` package.
-\restorestocksize — This command ends trhe current stock size and restores the previous one (in a LIFO fashion).
+\newstocksize{options} — This command starts a new stock (and paper) size. The `options` may include:
+ `keepmargins` — The current (left, right, top, and bottom) margins will be prreseved in the new page layout;
+ `other_options` — The `other_options` are passed straight to the \newgeometry command form the`geometry` package.
+\restorestocksize — This command ends the current stock size and restores the previous one (in a LIFO fashion).
```
### Nesting Different Page/Stock Sizes
- Multiple paper/stock sizes can be nested. With each `\restorestocksize` command, the previous size is resmued.
+ Multiple paper/stock sizes can be nested. With each `\restorestocksize` command, the previous size is resumed.
```latex
This page has the default size (e.g., a4paper).
- \newstocksize[margin=0pt]{layoutsize={15cm,10cm},margin=1.5cm}
+ \newstocksize{layoutsize={15cm,10cm},margin=1.5cm}
This page size is 15cm wide x 10cm high, with margins of 1.5cm.
\newstocksize{layoutsize={20cm,20cm},margin=4.0cm}