summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/jlreq/jlreq-trimmarks.html
blob: 1186f439f7f807af8dd259639df964b630c2bb02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <title>jlreq-trimmarks</title>
  <style>
    .markdown-body {
      padding-top: 10px;
      padding-bottom: 10px;
      background-color: white;
      padding: 30px;
      line-height: 170%;
    }
    h1{
      font-size: 200%;
    }
    h2{
      border-style: solid;
      border-width: 0 0 0.1em 0em;
      padding: 0 0 0.2em 0em;
      border-color: #EEEEEE;
      margin-top: 2em;
    }
    h3{
      border-style: solid;
      border-width: 0 0 0 0.5em;
      padding: 0 0 0 0.5em;
      border-color: #EEEEEE;
      margin-top: 2em;
    }
    code{
      white-space: pre;
      font-weight: normal;
      background-color: #F4F4F4;
      border-color: #F4F4F4;
      border-style: solid;
      border-width: .2em .5em;
      border-radius: .2em;
    }
    pre{
      background-color: #F8F8F8;
      border-color: #F8F8F8;
      border-width: 1em;
      border-style: solid;
      border-radius: .5em;
      padding: 0;
      margin: 0;
      line-height: 130%;
    }
    pre code{
      background-color: #F8F8F8;
      border-style: none;
    }
  </style>
</head>
<body>
<article class="markdown-body">
<h1 id="jlreq-trimmarks">jlreq-trimmarks</h1>
<h2 id="what-is-this">What is this?</h2>
<p>This package outputs trim marks. It works with <a href="https://osdn.jp/projects/luatex-ja/wiki/FrontPage">LuaTeX-ja</a> / pLaTeX / upLaTeX / dvipdfmx / Dvips / dviout. It provides the following.</p>
<ul>
<li>Output trim marks</li>
<li>Set TrimBox and BleedBox if possible.</li>
<li>Set the size of paper.</li>
</ul>
<p>Note that this package is independent from <a href="https://www.w3.org/TR/jlreq/">Requirements for Japanese Text Layout</a> (JLReq). JLReq says nothing about trim marks.</p>
<h2 id="installation">Installation</h2>
<p>Move jlreq-trimmarks.sty and jlre-helpers.sty to $TEXMF/tex/latex/jlreq.</p>
<h2 id="how-to-use">How to use</h2>
<p>Load it by <code>\usepackage</code> with specifying the TeX engine and the DVI driver.</p>
<pre><code>\usepackage[dvipdfmx,platex]{jlreq-trimmarks}
</code></pre>
<h2 id="options">Options</h2>
<p>The following package options (keyval style) are available.</p>
<h3 id="platex-uplatex-lulatex"><code>platex</code>, <code>uplatex</code>, <code>lulatex</code></h3>
<p>Set the engine. If it is not specified, then the engine is</p>
<ul>
<li>the one used in the jlreq class if the jlreq class is loaded.</li>
<li>guessed one if the jlreq class is not loaded.</li>
</ul>
<h3 id="dvipdfmx-dvips-dviout"><code>dvipdfmx</code>, <code>dvips</code>, <code>dviout</code></h3>
<p>Set the dvi driver. If it is not specified, then</p>
<ul>
<li>the package outputs PDF file via LuaLaTeX when the engine is <code>lualatex</code>.</li>
<li>the driver is <code>dvipdmx</code> if the engine is <code>platex</code> or <code>uplatex</code></li>
</ul>
<h3 id="trimmarks_paper"><code>trimmarks_paper</code></h3>
<p>Set the size of the paper including trim marks.</p>
<ul>
<li><code>trimmarks_paper=&lt;paper type&gt;</code>: specify via the paper type. for the paper type, you can use <code>a0--a10</code>, <code>b0--b10</code> and <code>c2--c8</code>. Note that <code>b0--b10</code> is `JIS B' (Japanese B-series variant).</li>
<li><code>trimmarks_paper={&lt;width&gt;,height&gt;}</code>: specify via the width and height.</li>
<li><code>trimmarks_paper=&lt;paper size&gt;+{&lt;width&gt;,&lt;height&gt;}</code> (e.g. <code>trimmarks_paper=a4+{1cm,2cm}</code>): <code>&lt;width&gt;</code> (resp. <code>&lt;height&gt;</code>) is added to the width (resp. height) of the paper size specified by <code>&lt;paper size&gt;</code> For <code>&lt;paper size&gt;</code>, one can use <code>&lt;paper type&gt;</code> or <code>{&lt;width&gt;,&lt;height&gt;}</code> as in the above.</li>
<li><code>trimmarks_paper=a4+2cm</code> is equivalent to <code>trimmarks_paper=a4+{2cm,2cm}</code>.</li>
<li>If <code>&lt;paper size&gt;</code> is empty (e.g. <code>trimmarks_paper=+2cm</code>), the current paper size (which is specified usually by the option for the document class) is used.</li>
</ul>
<h3 id="landscape"><code>landscape</code></h3>
<p>Swap the width and the height. This swaps only the width and height which is specified with the option <code>trimmarks_paper</code>. For example, <code>landscape,trimmarks_paper=+{2cm,1cm}</code>, adds 1cm to the height and 2cm to the width. But the current paper size is not swapped.</p>
<h3 id="show"><code>show</code></h3>
<p>Specify the types of trim marks which the package outputs. It is specified with the comma separated list like <code>show={trimmarks,banner,digital}</code>. If no argument is given, everything will be showed.</p>
<ul>
<li><code>trimmarks</code>: outputs the trim marks.</li>
<li><code>banner</code>: date etc.</li>
<li><code>digital</code>:TrimBox and BleedBox.</li>
<li><code>no</code>: nothing will be showed</li>
</ul>
<h2 id="jlreqtrimmarkssetup"><code>\jlreqtrimmarkssetup</code></h2>
<p>Set the additional settings with the keyval style.</p>
<h3 id="banner"><code>banner</code></h3>
<p>The things which the package outputs when <code>show=banner</code> is specified in the package option.</p>
<h3 id="bleed_margin"><code>bleed_margin</code></h3>
<p>Set the bleed margin.</p>
<h3 id="trimmarks_width"><code>trimmarks_width</code></h3>
<p>Set the width of trim marks.</p>
<h3 id="color"><code>color</code></h3>
<p>Set the color of the trim marks. You have to load a package which defines <code>\color</code> (`color' package or its variant) before loading this package to use this function. Here are some examples of specifying the color.</p>
<ul>
<li><code>color=c</code> -&gt; <code>\color[cmyk]{1,0,0,0}</code></li>
<li><code>color=cyk</code> -&gt; <code>\color[cmyk]{1,0,1,1}</code></li>
<li><code>black</code> -&gt; <code>\color{black}</code></li>
<li><code>[cmyk]0.5,0.5,0.5,0</code> -&gt; <code>\color[cmyk]{0.5,0.5,0.5,0}</code></li>
</ul>
<h2 id="license">LICENSE</h2>
<p>This package is distributed under the BSD 2-Clause License. See <a href="LICENSE" class="uri">LICENSE</a>.</p>
<h2 id="changelog">CHANGELOG</h2>
<ul>
<li>2018-05-19
<ul>
<li>First release.</li>
</ul></li>
<li>2018-06-17
<ul>
<li>Fixed a bug.</li>
</ul></li>
<li>2018-08-08
<ul>
<li>Extended <code>trimmarks_paper</code>.</li>
<li>Added a package option <code>landscape</code>.</li>
</ul></li>
</ul>
<hr />
<p>Noriyuki Abe <a href="https://github.com/abenori/jlreq" class="uri">https://github.com/abenori/jlreq</a></p>
</article>
</body>
</html>