summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/vgrid/vgrid.dtx
blob: 65349cf777e1fa0427002bdd6f96ea5867b77773 (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
% \iffalse meta-comment
%
% Copyright (C) 2013 by Scott Lawrence <bytbox@gmail.com>
% ---------------------------------------------------------------------------
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
%
% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is Scott Lawrence.
%
% This work consists of the files vgrid.dtx and vgrid.ins
% and the derived filebase vgrid.sty.
%
% \fi
%
% \iffalse
%<*driver>
\ProvidesFile{vgrid.dtx}
%</driver>
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{vgrid}
%<*package>
    [2013/12/20 0.1 Overlays a vertical grid]
%</package>
%
%<*driver>
\documentclass{ltxdoc}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\usepackage{vgrid}
\begin{document}
  \DocInput{vgrid.dtx}
  \PrintChanges
  \PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{72}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
%
% \changes{1}{2013/12/20}{Converted to DTX file}
%
% \DoNotIndex{\newcommand,\newenvironment}
%
% \GetFileInfo{vgrid.dtx}
% \title{The \textsf{vgrid} package}
% \author{Scott Lawrence\\ \texttt{bytbox@gmail.com}}
% \date{\fileversion~from \filedate}
%
% \maketitle
%
% \section{Introduction}
%
% The \texttt{vgrid} package overlays a grid intended to help the author
% enforce vertical rhythm on each page.  The spacing of the grid is taken from
% \verb|\baselineskip|, with the first line at the top of the text area.
%
% Note that \texttt{vgrid} itself does not change any spacing -- other packages
% (or careful font settings) must be used to achieve vertical rhythm. This document, for example, can be clearly seen to not have vertical rhythm.
%
% \section{Usage}
%
% To add a grid to each page, just place \verb|\usepackage{vgrid}| in your
% document's preamble. As of this version, there is no fine-grained control to
% allow grids to be excluded from certain pages. The grid will use
% \verb|\baselineskip| as the line height.
%

%
% \StopEventually{}
%
% \section{Implementation}
%
% \iffalse
%<*package>
% \fi
%
%    \begin{macrocode}
\RequirePackage{everypage}
\RequirePackage{tikz}
\RequirePackage{ifoddpage}
\newlength\vgrid@l \setlength\vgrid@l{\baselineskip}
\newlength\vgrid@y
\AddEverypageHook{
%    \end{macrocode}
% For every page, we need to re-calculate the coordinates of the grid.
%    \begin{macrocode}
	\def\@csm{\ifoddpageoroneside\oddsidemargin\else\evensidemargin\fi}
	\def\@left{\hoffset+\@csm}
	\def\@right{\@left+\textwidth}
	\def\@top{-\voffset-\topmargin-\headheight-\headsep}
	\def\@gridline{\draw [thin, gray]}
	\begin{tikzpicture}[overlay]
		\def\y{\@top-\vgrid@y}
		\@gridline (\@left, \@top) -- (\@left, \@top-\textheight);
		\@gridline (\@right, \@top) -- (\@right, \@top-\textheight);
		\setlength\vgrid@y{0pt}
		\@whiledim\vgrid@y<\textheight\do{
			\@gridline (\@left, \y) -- (\@right, \y);
			\addtolength{\vgrid@y}{\vgrid@l}
		}
		\@gridline (\@left, \y) -- (\@right, \y);
	\end{tikzpicture}
}
%    \end{macrocode}

%
% \iffalse
%</package>
% \fi
%
% \Finale
\endinput