summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bxpapersize
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-02-08 22:19:00 +0000
committerKarl Berry <karl@freefriends.org>2017-02-08 22:19:00 +0000
commit6e51339ef42840e5c37785cc48d3b5ad525cead3 (patch)
treed02fe5cdd1ae504c167470fb7b95ca84a29a9f12 /Master/texmf-dist/doc/latex/bxpapersize
parent77b2f02d23f8f97c8c131011f8ce1bc82c58a360 (diff)
bxpapersize (8feb17)
git-svn-id: svn://tug.org/texlive/trunk@43169 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/bxpapersize')
-rw-r--r--Master/texmf-dist/doc/latex/bxpapersize/LICENSE8
-rw-r--r--Master/texmf-dist/doc/latex/bxpapersize/README.md81
2 files changed, 70 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/latex/bxpapersize/LICENSE b/Master/texmf-dist/doc/latex/bxpapersize/LICENSE
index 49f803e083e..8ada757fbc8 100644
--- a/Master/texmf-dist/doc/latex/bxpapersize/LICENSE
+++ b/Master/texmf-dist/doc/latex/bxpapersize/LICENSE
@@ -1,12 +1,6 @@
-$BK\%=%U%H%&%'%"$O(B MIT $B%i%$%;%s%9$N2<$GG[I[$5$l$^$9!#(B
-$BCx:n8"$O:n<T$G$"$k!VH,EP(B $B?rG7!JJLL>(B ZR$B!K!W$KB0$7$^$9!#(B
-$B$^$?K\%=%U%H%&%'%"$OL5J]>Z$G$9!#(B
-
-This software is distributed under the MIT License.
-
The MIT License
-Copyright (c) 2016 Takayuki YATO (aka. "ZR")
+Copyright (c) 2017 Takayuki YATO (aka. "ZR")
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/Master/texmf-dist/doc/latex/bxpapersize/README.md b/Master/texmf-dist/doc/latex/bxpapersize/README.md
index f884ec0f5fa..cad12f7d8ed 100644
--- a/Master/texmf-dist/doc/latex/bxpapersize/README.md
+++ b/Master/texmf-dist/doc/latex/bxpapersize/README.md
@@ -5,8 +5,14 @@ LaTeX: To synchronize output paper size with layout paper size
As is well known, in LaTeX processing layout paper size specified by
document class options is not automatically applied to output paper
-size. This package enables LaTeX authors to synchronize both kinds of
-paper sizes.
+size. By employing this package, authors can make output paper size
+be identical to layout paper size. They can also set output paper size
+to arbitrary values.
+
+It should be noted that there are many packages that try to synchronize
+paper sizes, possibly in a slightly different manner. This package
+allows authors to decide whether the setting made by this package
+should have higher or lower priority over the settings made by others.
### System requirement
@@ -42,7 +48,7 @@ The available options are described hereafter.
useful to resolve conflict caused by some packages depending on
the bxpapersize package. Note that once `disabled` is used there
is no way to enable the functionality.
-
+ * `nodvidriver`: A synonym for `disabled`.
#### Priority
@@ -51,20 +57,34 @@ The available options are described hereafter.
‘papersize’ specials issued by others.
The set of valid values is:
- `low`: Priotizes specials by others.
- - `middle` (default): Does not care about priority.
+ - `middle`/`default` (default): Does not care about priority.
- `high`: Priotizes specials by this package.
+ * `olddvips`: Must be specified when you use dvips older than that
+ included in TeX Live 2017, so as to make the `priority` option
+ work correctly.
#### Other options
-Any key-value pairs that are valid in `\bxpapersizesetup` can be used
+Any key-value pairs that are valid in `\papersizesetup` can be used
as package options.
% to begin with deactivated state
\usepackage[active=false]{bxpapersize}
+Note that the default values of the `\papersizesetup` command are also
+applied when the package is loaded. For example, `size=real` will be
+in effect when this package is loaded without the `size` option key.
+
### Usage
-You can change the settings of this package using `\bxpapersizesetup`
+Once the package is loaded, the output paper size will be adjusted,
+respecting the settings given by the package options. By default, the
+output papersize will be made identical to the layout paper size.
+
+ % For many cases, it's enough.
+ \usepackage{bxpapersize}
+
+You can change the settings of this package using `\papersizesetup`
command, invoked as follows:
\bxpapersizesetup[<key>=<value>,...]
@@ -72,18 +92,55 @@ command, invoked as follows:
The available keys are listed below:
* `active=true|false`: Temporarily activates/deactivates the function
- of this package. Note that, however, what happens about paper size
- synchronization when activation settings are changed in the midst
- of documents differs among TeX engines and/or DVI drivers. Thus
- this should be employed only by advanced users.
-
+ of this package.
+ * `size=<value>`: Decides what the output paper size should be.
+ Available values are:
+ - `real`: The output should be equal to the layout paper size
+ given by `\paperwidth/height`, except that the stock paper size
+ given by `\stockwidth/height` will be employed instead when
+ it is available.
+ - `real*`: The output should be equal to the layout paper size,
+ even if the stock paper size is available.
+ - `{<width>,<height>}`: The output should be equal to the
+ specified values.
+ - `<papersize-name>`: The output should be equal to the given
+ size. The set pf available paper-size names is the same as the
+ [geometry package] and is listed below:
+ a0paper--a6paper, b0paper--b6paper, c0paper--c6paper, b0j--b6j,
+ ansiapaper--ansiepaper, letterpaper, legalpaper, executivepaper,
+ screen.
+ - `landscape`, `truedimen`: These are used in combination with
+ `<papersize-name>` options, and have the same meaning as in the
+ geometry package.
+ - `box`: The output should be the actual size of the TeX box
+ to be shipped out. It is provided for advanced users.
+
+[geometry package]: https://www.ctan.org/pkg/geometry
+
+Note that, however, what happens about output paper size when some
+settings are changed in the midst of pages differs among TeX engines
+and/or DVI drivers. Thus such usage should be employed only by advanced
+users.
+
+The comamnd `\bxpapersizesetup` is a synonym for `\papersizesetup`,
+so as to cope with command name conflict. Namely, `\papersizesetup`
+will be not (re)defined if the command of that name is already defined,
+but `\bxpapersizesetup` will be always provided.
Revision History
----------------
+ * Version 0.3 ‹2017/02/08›
+ - As to `size=real`, the stock size becomes taken into account,
+ and the new value `real*` is provided.
+ - Make `nodvidriver` synonym for `disabled`.
+ - Make `\papersizesetup` synonym for `\bxpapersizesetup`.
+ - Add `olddvips`.
+ - Support `size=<papersize-name>`. together with `landscape` and
+ `truedimen`.
* Version 0.2 ‹2016/03/26›
- The first public version.
--------------------
Takayuki YATO (aka. "ZR")
-http://zrbabbler.sp.land.to/
+https://github.com/zr-tex8r