diff options
author | Karl Berry <karl@freefriends.org> | 2021-03-16 22:16:28 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2021-03-16 22:16:28 +0000 |
commit | fff02b5626cd3f9378318e2ca421bcd238e34f17 (patch) | |
tree | b20336ad4f552878392027d8f8b15efc6d785272 /Master/texmf-dist/doc/latex/gridpapers/README.md | |
parent | 2ca606b41366967129514d78b3f2c1c53c257b8a (diff) |
gridpapers (16mar21) (branch)
git-svn-id: svn://tug.org/texlive/branches/branch2020.0@58454 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/gridpapers/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/gridpapers/README.md | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/gridpapers/README.md b/Master/texmf-dist/doc/latex/gridpapers/README.md new file mode 100644 index 00000000000..a9be615209d --- /dev/null +++ b/Master/texmf-dist/doc/latex/gridpapers/README.md @@ -0,0 +1,113 @@ +# The *gridpapers* package +Make your own quadrille, graph, hex, etc. paper! Uses the [PGF/TikZ](https://en.wikipedia.org/wiki/PGF/TikZ) package for LaTeX, which should be part of any modern TeX installation. All colors and spacing are customizable. + +There are .tex files in the examples/ +directory to help get you started with customization. +Each tex file has an almost-empty body, with a `\usepackage` statement +that you can customize. For example, +examples/engineer-pad.tex looks like this: +```latex +\documentclass{article} +\usepackage[pattern=majmin, colorset=engineer]{gridpapers} +\begin{document} +\thispagestyle{empty} +~ +\end{document} +``` +(The `~` in the body forces a non-empty body, or else latex wouldn't +generate a PDF). + +Note: This package is distinct from a different package with a similar +name, [graphpaper (on CTAN)](https://www.ctan.org/pkg/graphpaper). + +Installation +------------ +If `gridpapers` is already provided in your TeX distribution, skip +this section. You should be able to install `gridpapers` [from the +CTAN](https://www.ctan.org/pkg/gridpapers) via your distribution's +utility (e.g. the TeX Live Utility). Alternatively, you can get the +package from the [source repository on +GitHub](https://github.com/mcnees/LaTeX-Graph-Paper). If you do not +want to do a "full" installation, just copy gridpapers.sty into the +same directory as your LaTeX source. + +Usage +----- + +All the configuration happens via the `\usepackage` command. The +current valid options are: + +* `pattern=<name>`: +Valid pattern names are: +`std,stdeight,majmin,dot,hex,tri,iso,lightcone,ruled,doubleruled`. Default +is `std`. Patterns come with default page geometry (size and margins; +see `geometry`), and default 'fullness' (whether they fill the page or +not; see options `fullpage` and `textarea`). +* `colorset=<name>`: +Valid color preset names are: +`std,precocious,brickred,engineer,plumpad`. Default is `std`. A +preset determines the `majorcolor`, `minorcolor`, and `bgcolor` all at +once. But, you can start from a preset and then override some colors. +* `majorcolor=<color>`: Override the preset "major" color. This can + be a named color, or using the syntax from xcolor to mix colors + together. +* `minorcolor=<color>`: Override the preset "minor" color. As above. +* `bgcolor=<color>`: Override the preset background color. As above. +* `patternsize=<length>`: Override the preset pattern size. The + meaning of this length argument is different for each pattern; see + PDF documentation for full details.. +* `dotsize=<length>`: Controls the size of the dots themselves for + `pattern=dot`. Default: `.7pt` +* `fullpage`: Make the pattern fill the whole page. +* `textarea`: Make the pattern fill only the text area of the + document. At most one of the `fullpage` or `textarea` can be + specified. If one is specified, it will override the default + 'fullness' setting of the pattern. +* `geometry={<geometry spec>}`: Page geometry specification, using the + syntax of the geometry package. If the geometry package was loaded + before gridpapers, this option will be ignored. This specification + will override the pattern's default page geometry. + +For example, let's say you want to use the `tri` pattern, which by +default fills the page. But you want it to fill just the textarea of +an A4 page with 2cm margins, and you want the triangles to be .75cm long. +Finally, you like the colors of the `engineer` set, but want a white +background. Then you would write: +```latex +\usepackage[pattern=tri, + patternsize=0.75cm, + textarea, + colorset=engineer, + bgcolor=white, + geometry={a4paper, margin=2cm}]{gridpapers} +``` + +Gallery +------- + +Some example styles: + +![Standard](https://raw.githubusercontent.com/mcnees/LaTeX-Graph-Paper/screenshots/std.jpg "Standard") + +![Quad](https://raw.githubusercontent.com/mcnees/LaTeX-Graph-Paper/screenshots/quad.jpg "Quadrille") + +![Hex](https://raw.githubusercontent.com/mcnees/LaTeX-Graph-Paper/screenshots/hex.jpg "Hex") + +![Dots](https://raw.githubusercontent.com/mcnees/LaTeX-Graph-Paper/screenshots/dot.jpg "Dots") + +![Light cone](https://raw.githubusercontent.com/mcnees/LaTeX-Graph-Paper/screenshots/lightcone.jpg "Light cone") + +![Precocious Engineer](https://raw.githubusercontent.com/mcnees/LaTeX-Graph-Paper/screenshots/rosie.png "Precocious Engineer color scheme") + +![Hex Engineer](https://raw.githubusercontent.com/mcnees/LaTeX-Graph-Paper/screenshots/hexengineer.png "Hex grid with Engineering Pad color scheme") + +Credits +------- + +This package was created by [Robert McNees](http://jacobi.luc.edu/) +with additional contributions from [Leo +C. Stein](http://duetosymmetry.com/), and is maintained by both. This +material is subject to the [LaTeX Project Public License +1.3c](https://www.ctan.org/license/lppl1.3), (c) 2017-2021. The +hexagon pattern code is [due to Philippe +Goutet](https://tex.stackexchange.com/questions/6019/drawing-hexagons/6128#6128). |