-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathtikzscale.dtx
1842 lines (1824 loc) · 95.1 KB
/
tikzscale.dtx
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
% \iffalse meta-comment
% !TEX program = pdfLaTeX
%<*internal>
\iffalse
%</internal>
%<*readme>
----------------------------------------------------------------
tikzscale --- Absolute resizing of TikZ pictures and PGF plots without
scaling text
E-mail: [email protected] Released under the LaTeX Project
Public License v1.3c or later See http://www.latex-project.org/lppl.txt
----------------------------------------------------------------
The tikzscale package extends the includegraphics command to support
tikzpictures. It allows scaling of TikZ images and PGFPlots to a provided
width or height without changing the text size.
Usage: \usepackage{tikzscale}
As an example write
\includegraphics{myTikZFile.tikz}
instead of
\includegraphics{myJPEGFile.jpeg},
with myTikZFile.tikz being the file name of a text file containing
everything from \begin{tikzpicture} to \end{tikzpicture}. To actually
do some scaling of the included TikZ file, give either an absolute width
or an absolute height in the optional argument, e.g.
\tikzscale@includetikz[width=0.5\linewidth]{myTikZFile.tikz}.
If the file contains a plot created with the PGFPlots package, set both
width and height via the optional argument, e.g.
\tikzscale@includetikz[width=\linewidth,height=0.4\linewidth]{myPGFPlot.tikz}.
%</readme>
%<*internal>
\fi
\def\nameofplainTeX{plain}
\ifx\fmtname\nameofplainTeX\else
\expandafter\begingroup
\fi
%</internal>
%<*install>
\input docstrip.tex
\keepsilent
\askforoverwritefalse
\preamble
----------------------------------------------------------------
tikzscale --- Absolute resizing of TikZ pictures and PGF plots without scaling text
E-mail: [email protected]
Released under the LaTeX Project Public License v1.3c or later
See http://www.latex-project.org/lppl.txt
----------------------------------------------------------------
\endpreamble
\postamble
Copyright (C) 2012, 2013, 2014, 2015 by Patrick Häcker <[email protected]>
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License (LPPL), either
version 1.3c of this license or (at your option) any later
version. The latest version of this license is in the file:
http://www.latex-project.org/lppl.txt
This work is "maintained" (as per LPPL maintenance status) by
Patrick Häcker.
This work consists of the file tikzscale.dtx
and the derived files tikzscale.ins,
tikzscale.pdf and
tikzscale.sty.
\endpostamble
\usedir{tex/latex/tikzscale}
\generate{
\file{tikzscale.sty}{\from{tikzscale.dtx}{package}}
}
%</install>
%<install>\endbatchfile
%<*internal>
\usedir{source/latex/tikzscale}
\generate{
\file{\jobname.ins}{\from{\jobname.dtx}{install}}
}
\nopreamble\nopostamble
\usedir{doc/latex/tikzscale}
\generate{
\file{README.txt}{\from{\jobname.dtx}{readme}}
}
\ifx\fmtname\nameofplainTeX
\expandafter\endbatchfile
\else
\expandafter\endgroup
\fi
%</internal>
%<*package>
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{tikzscale}[2013/05/22 v0.2.6 tikzscale LaTeX package]
\RequirePackage{graphicx}
\RequirePackage{etoolbox}
%
% Avoid \href{https://groups.google.com/d/msg/comp.text.tex/VRrFB4ll5n0/Vu31OC4hQG8J}{a conflict} between etoolbox and etextools
\makeatletter % The missing \makeatother command is on purpose (as every other combination results in an error).
\let\autonum@etoolbox@forlistloop\forlistloop
\RequirePackage{etextools}
\let\forlistloop\autonum@etoolbox@forlistloop
%
\RequirePackage{pgfkeys}
\RequirePackage{xparse}
\RequirePackage{letltxmacro}
\RequirePackage{xstring}
%</package>
%<*driver>
\documentclass{ltxdoc}
% \documentclass{ydoc}
\usepackage[utf8]{inputenx}
\usepackage[T1]{fontenc}
\usepackage{subfig}
\usepackage{booktabs}
\usepackage{tabulary}
\usepackage{tikzscale}
\usepackage{tikz}
\usepackage{pgfplots}
% Load the MWE package, although its functionality is not needed. The loading highlights, that some graphics used below are part of the MWE package.
\usepackage{mwe}
\usepackage{xcolor}
\usepackage{lmodern}
\usepackage{amsmath}
\usepackage{cleveref}
\usepackage[numbered]{hypdoc}
\hypersetup{pdftitle=The tikzscale package}
\newcommand{\cell}[2][c]{%
\begin{tabular}[#1]{@{}c@{}}#2\end{tabular}%
}
\newcommand{\rcell}[2][c]{%
\begin{tabular}[#1]{@{}r@{}}#2\end{tabular}%
}
% \usepackage{ydoc-desc}
% \optionaloff % otherwise the optional arguments are displayed lighter as the normal text
\def\xcmd#1{%
\cmd#1%
\futurelet\tmp\arglook%
}
\def\arglook{%
\let\next\relax
\ifx[%
\tmp%
\let\next\xoarg%
\fi
\ifx\bgroup%
\tmp%
\let\next\xmarg%
\fi
\ifx(%
\tmp%
\let\next\xparg%
\fi
\next
}
\def\xoarg[#1]{%
\oarg{#1}\futurelet\tmp\arglook%
}
\def\xmarg#1{%
\marg{#1}\futurelet\tmp\arglook%
}
\def\xparg(#1){%
\parg{#1}\futurelet\tmp\arglook%
}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
\DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
%
%\GetFileInfo{\jobname.sty}
%
%\title{^^A
% \textsf{tikzscale} --- Absolute resizing of TikZ pictures and PGF plots without scaling text\thanks{^^A
% This file describes version \fileversion, last revised \filedate.^^A
% }^^A
%}
%\author{^^A
% Patrick Häcker\thanks{E-mail: pat\[email protected]}^^A
%}
%\date{Released \filedate}
%
%\maketitle
%
%\changes{v0.1}{2012/10/31}{First public release}
%\changes{v0.1.1}{2012/11/02}{Fix some bugs, increase robustness, regenerate externalized files less often}
%\changes{v0.1.2}{2012/11/02}{Fix whitespace issues}
%\changes{v0.1.3}{2012/11/02}{Fix error when loading TikZ but not PGFPlots; Fix error when scaling complicated TikZ graphics}
%\changes{v0.2}{2013/01/02}{Add default axis ratio; save axis ratio; support \cmd{\externaldisable} and \cmd{\externalenable}; improve robustness; increase speed}
%\changes{v0.2.1}{2013/01/09}{Fix graphics with data from text file due to wrong line breaks; fix plain old \LaTeX support}
%\changes{v0.2.2}{2013/01/13}{Fully support plain (dvi) \LaTeX; mind graphicspath}
%\changes{v0.2.3}{2013/01/23}{Fix graphicspath bug; fix endlinechar bug, improve compatibility with beamer}
%\changes{v0.2.4}{2013/03/10}{Fix another graphicspath bug; support Beamer's \cmd{\pause} command}
%\changes{v0.2.5}{2013/03/30}{Do not accidently activate externalization}
%\changes{v0.2.6}{2013/05/22}{Fix whitespace issue; correctly scale with externalization even if it scales incorrectly}
% \section{Introduction}
% When dealing with graphics, there are different scaling demands. For \emph{absolute} scaling, a width and/or height is given. Opposed to that, for relativ scaling, a horizontal and/or vertical scaling factor is needed. This package only is about absolute scaling of tikzpicture environments. The different absolute scaling demands and their solutions are shown in table \ref{scalingDemands}.
% \begin{table}
% \centering
% \caption[Graphic scaling methods.]{Absolute graphic scaling methods. If multiple methods are available, the most native one is shown. Methods which \textcolor{orange}{approximate} the scaling are shown in orange text color. \textcolor{blue}{Recommended} methods are shown in blue textcolor.}%^^A Note, that the first three methods in each table are absolute ones, whereas the last three methods are relative ones.}%
% \label{scalingDemands}
% \subfloat[Scaling with scaled text and line widths.]{^^A
% \begin{tabular}{rccc}%^^A{1.1\linewidth}{RCCC}
% \toprule
% scale & Images & TikZ/PGFPlots\\
% \midrule
% \rcell{to width\\proportionally} & \textcolor{blue}{\cell{\cmd{\includegraphics}\\\texttt{[width=\emph{unit}]}}} & \cell{\cmd{\resizebox}\\\texttt{\{\emph{width}\}\{!\}}}\\[0.8em]
% \rcell{to width\\keeping height} & \cell{\cmd{\resizebox}\\\texttt{\{\emph{width}\}\{\cmd{\height}\}}} & \cell{\cmd{\resizebox}\\\texttt{\{\emph{width}\}\{\cmd{\height}\}}}\\[0.8em]
% \rcell{to height\\proportionally} & \textcolor{blue}{\cell{\cmd{\includegraphics}\\\texttt{[height=\emph{unit}]}}} & \cell{\cmd{\resizebox}\\\texttt{\{!\}\{\emph{height}\}}}\\[0.8em]
% \rcell{to height\\keeping width} & \cell{\cmd{\resizebox}\\\texttt{\{\cmd{\width}\}\{\emph{height}\}}} & \cell{\cmd{\resizebox}\\\texttt{\{\cmd{\width}\}\{\emph{height}\}}}\\[0.8em]
% \rcell{to width\\and height} & \cell{\cmd{\includegraphics}\\\texttt{[width=\emph{unit},height=\emph{unit}]}} & \cell{\cmd{\resizebox}\\\texttt{\{\emph{width}\}\{\emph{height}\}}}\\
%^^A horizontally & \cell{\cmd{\scalebox}\\\texttt{\{\emph{factor}\}[1]}} & \cell{\texttt{[transform canvas=}\\\texttt{\{xscale=\emph{factor}\}]}} & \texttt{[xscale=\emph{factor}]}\\[0.8em]
%^^A vertically & \cell{\cmd{\scalebox}\\\texttt{\{1\}[\emph{factor}]}} & \cell{\texttt{[transform canvas=}\\\texttt{\{yscale=\emph{factor}\}]}} & \texttt{[yscale=\emph{factor}]}\\[0.8em]
%^^A proportionally & \cell{\cmd{\scalebox}\\\texttt{\{\emph{factor}\}}} & \cell{\texttt{[transform canvas=}\\\texttt{\{scale=\emph{factor}\}]}} & \texttt{[scale=\emph{factor}]}\\
% \bottomrule
% \end{tabular}
% }\\%
% \subfloat[Scaling with unscaled text and line widths without tikzscale.]{^^A
% \begin{tabulary}{1.1\linewidth}{RCCC}
% \toprule
% scale & Images & TikZ & PGFPlots\\
% \midrule
% \rcell{to width\\proportionally} & -- & -- & \textcolor{orange}{\texttt{[width=\emph{unit}]}}\\[0.8em]
% \rcell{to width\\keeping height} & -- & -- & --\\[0.8em]
% \rcell{to height\\proportionally} & -- & -- & \textcolor{orange}{\texttt{[height=\emph{unit}]}}\\[0.8em]
% \rcell{to height\\keeping width} & -- & -- & --\\[0.8em]
% \rcell{to width\\and height} & -- & -- & \textcolor{orange}{\texttt{[width=\emph{unit},height=\emph{unit}]}}\\
%^^A horizontally & -- & \texttt{[xscale=\emph{factor}]} & --\\
%^^A vertically & -- & \texttt{[yscale=\emph{factor}]} & --\\
%^^A proportionally & -- & \texttt{[scale=\emph{factor}]} & --\\
% \bottomrule
% \end{tabulary}
% }\\%
% \subfloat[Scaling with unscaled text and line widths with tikzscale.]{^^A
% \begin{tabulary}{1.1\linewidth}{RCCC}
% \toprule
% scale & Images & TikZ & PGFPlots\\
% \midrule
% \rcell{to width\\proportionally} & -- & \textcolor{blue}{\cell{\cmd{\includegraphics}\\\texttt{[width=\emph{unit}]}}} & \textcolor{blue}{\cell{\cmd{\includegraphics}\\\texttt{[width=\emph{unit}]}}}\\[0.8em]
% \rcell{to width\\keeping height} & -- & -- & --\\[0.8em]
% \rcell{to height\\proportionally} & -- & \textcolor{blue}{\cell{\cmd{\includegraphics}\\\texttt{[height=\emph{unit}]}}} & \textcolor{blue}{\cell{\cmd{\includegraphics}\\\texttt{[height=\emph{unit}]}}}\\[0.8em]
% \rcell{to height\\keeping width} & -- & -- & --\\[0.8em]
% \rcell{to width\\and height} & -- & -- & \textcolor{blue}{\cell{\cmd{\includegraphics}\\\texttt{[width=\emph{unit},height=\emph{unit}]}}}\\
%^^A horizontally & -- & \texttt{[xscale=\emph{factor}]} & --\\
%^^A vertically & -- & \texttt{[yscale=\emph{factor}]} & --\\
%^^A proportionally & -- & \texttt{[scale=\emph{factor}]} & --\\
% \bottomrule
% \end{tabulary}
% }
% \end{table}
%
% The tikzscale package adds and improves certain forms of absolute scaling for TikZ and PGFPlots, respectively. These scaling methods are the ones which are most useful, maybe even the only ones which are needed. During the scaling, the text sizes and line widths are left unscaled, which avoids inconsistency and visual distraction. PGFPlots itself can scale absolutely, but an approximation is used to achieve that. The tikzscale package uses optimization algorithms and warns if the scaling is not exact.
%
% Using tikzscale all relevant scaling methods share the same user interface with the well known \cmd{\includegraphics} command, enabling some of its features like automatic file extension detection for TikZ and PGFPlots, too. Furthermore, the \cmd{\includegraphics} command is improved to look-up relative paths in the correct subdirectory, if a \LaTeX\ project is organized in subdirectories.
%
% Relative scaling methods are mostly useless, as the sizes of the used images are often arbitrary, either determined by some resolution for rastered images or some arbitrary unit vector size for vector images, TikZ and PGFPlots. For traditional images and TikZ pictures, only proportional scaling methods giving either a width or a height make sense, as otherwise they get heavily distorted if the original aspect ratio is changed. As PGFPlots can handle different aspect ratios and aspect ratios are normally not predefined for plots, its requirement is the opposite: Both width and height are needed to avoid getting arbitrary sizes. For some special plots, the axis ratio can be given, as well. These requirements lead to the marked blue colors in table \ref{scalingDemands}.
%
% \section{Usage and Examples}
% Loading the tikzscale package without loading other packages, does not do anything useful.
%
% \subsection{TikZ}
% If the tikzscale and the tikz packages are loaded, the \cmd{\includegraphics} command can be used to input and scale a tikzpicture environment located in a separate file.
%
% As an example create the following .tex-file.
%
% \vspace{0.5em}
% \noindent\cmd{\documentclass\{minimal\}}\\
% \cmd{\usepackage\{tikz\}}\\
% \cmd{\usepackage\{tikzscale\}}\\
% \cmd{\begin\{document\}}\\
% \indent\texttt{\cmd{\includegraphics}[width=0.5\cmd{\linewidth}]\{linewidth.tikz\}}\\
% \cmd{\end\{document\}}
% \vspace{0.5em}
%
% Furthermore create the following .tikz-file and save it as linewidth.tikz in the same directory as the above .tex-file.
%
% \vspace{0.5em}
% \noindent\cmd{\begin\{tikzpicture\}}\\
% \indent\texttt{\cmd{\draw} (0,0) -{}- node \{center\} (\cmd{\linewidth},1);}\\
% \cmd{\end\{tikzpicture\}}
% \vspace{0.5em}
%
% The result of the complied .tex-file should look like this.\\%^^A
%\noindent\includegraphics[width=0.5\linewidth]{linewidth.tikz}
%
% So although the original tikzpicture itself has the width of a complete line, it gets proportionally scaled down to half the width while being loaded from the \cmd{\includegraphics} command. Neither the line's thickness nor the text \texttt{center} are scaled. Compare the output to\\
% \indent\texttt{\cmd{\input}\{linewidth.tikz\}}\\
% \input{linewidth.tikz}\\
% and\\
% \indent\texttt{\cmd{\resizebox}\{0.5\cmd{\linewidth}\}\{!\}\{\cmd{\input}\{linewidth.tikz\}\}}\\
% \resizebox{0.5\linewidth}{!}{\input{linewidth.tikz}}\\
% to see tikzscale's benefit.
%
% \subsection{PGFPlots}
% \subsubsection{Scaling of width and height}
% If the pgfplots package is loaded together with the tikzscale package, the user interface is the same. Instead of giving either a width or a height, both have to be given for pgfplots. Otherwise a default axis ratio is assumed (see section \ref{axisRatio}).\\
% So,\nopagebreak
%
% \vspace{0.5em}
% \cmd{\input\{pgfplots-test.tikz\}}
%
% \vspace{0.5em}
% \texttt{\cmd{\begin}\{tikzpicture\}\cmd{\begin}\{axis\}[width=3cm,height=2cm] \dots}
% \vspace{0.5em}
%
% \noindent becomes
%
% \vspace{0.5em}
% \cmd{\includegraphics[width=3cm,height=2cm]\{pgfplots-test.tikz\}}
%
% \vspace{0.5em}
% \texttt{\cmd{\begin}\{tikzpicture\}\cmd{\begin}\{axis\} \dots}.
% \vspace{0.5em}
%
% The benefit is a more accurate scaling algorithm, as the scaling with PGFPlots can be quite coarse. Another win is the unified interface, which simplifies the sharing of plots between projects enormously, as one file and thus one plot can be included in different projects with different sizes.
%
% \subsubsection{Scaling using axis ratio}\label{axisRatio}
% The scaling described in the previous section scales the whole plot including all axis descriptions and legends to the given width and height. It can thus happen, that the plotted figure has a different size ratio than expected, if the x and y descriptions have different sizes as shown in figure \ref{width=height}.
% \begin{figure}
% \centering
% \frame{\includegraphics[width=0.4\linewidth,height=0.4\linewidth]{testgraphic2D.tikz}}
% \caption{Using options \texttt{width=0.4\cmd{\linewidth}} and \texttt{height=0.4\cmd{\linewidth}} results in an overall quadratic graphic with overall width and height set to 40\% of the linewidth.}
% \label{width=height}
% \end{figure}
% Sometimes, the x-axis and the y-axis should have a specific ratio, e.g. being equal, ignoring the axis description and other things. This is normally achieved by using PGFPlots' option \texttt{scale only axis}. Unfortunately, if this option would be used, a plot might be unsharable between two projects, if they have different requirements for the axis ratio. Thus, this option should not be used in such a case.
%
% Instead, in \cmd{\includegraphics} there is a new option \texttt{axisratio} which must be used together with either width or height. It scales the whole plot including the axis description to the given width or height as in figure \ref{axisratio} while keeping the graphical part at a given axis ratio, where the ratio is defined by width divided by height. The graphical part is thus not quadratic in general. If \texttt{axisratio} is omitted, i.e. only either height or width are given, it is assumed to be \texttt{1}.
% \begin{figure}
% \centering
% \frame{\includegraphics[width=0.4\linewidth,axisratio=1]{testgraphic2D.tikz}}
% \caption{Using options \texttt{width=0.4\cmd{\linewidth}} and \texttt{axisratio=1} results in an quadratic graphic area with overall width set to 40\% of the linewidth. The height follows from these constraints, so that the overall plot is not quadratic in general.}
% \label{axisratio}
% \end{figure}
%
% \subsection{Hints for TikZ and PGFPlots}
% The whole tikzpicture environment must be in a separate file. This allows sharing of graphics between different \TeX\ projects and a unified user interface via \cmd{\includegraphics}. Having tikzpicture environments directly in a .tex-file is not supported, i.e.\ they do not benefit from the tikzscale package. Multiple tikzpicture environments in one .tikz-file are not supported, either. Put things which always belong together in a shared tikzpicture environment and things which might be used separately in the future in separate files for code sharing across projects. The file ending may be ommited in the \cmd{\includegraphics} command, if it is one of .tikz, .TIKZ, .TikZ, .pgf or .PGF. At the moment, use only \emph{either} width \emph{or} height for normal (i.e.\ non-PGFPlots) tikzpicture environments and use width \emph{and} height or one of both optionally together with \emph{axisratio} for tikzpicture environments containing a PGFPlots' axis environment.
%
% \subsection{currfile}
% If the tikzpicture package is loaded together with the \href{http://www.ctan.org/pkg/currfile}{currfile} package, another feature is activated. Suppose you have your project organized in the following directory tree with \textcolor{blue}{directories} shown in blue color:
%
% \vspace{0.5em}
% \noindent \textcolor{blue}{projectDirectory}\\
% \indent main.tex\\
% \indent \textcolor{blue}{firstChapter}\\
% \indent\indent firstChapter.tex\\
% \indent\indent firstGraphicOfFirstChapter.jpeg\\
% \indent\indent secondGraphicOfFirstChapter.tikz\\
% \indent \textcolor{blue}{secondChapter}\\
% \indent\indent secondChapter.tex\\
% \indent\indent firstGraphicOfSecondChapter.tikz\\
% \indent\indent secondGraphicOfSecondChapter.jpeg
% \vspace{0.5em}
%
% Further suppose the chapter.tex files are \cmd{\input}ted in main.tex. Calling\\
% \cmd{\includegraphics\{firstGraphicOfFirstChapter.jpeg\}}\\
% in firstChapter.tex normally does not work. The reason is that the\\
% \cmd{\input\{firstChapter.tex\}}\\
% command in main.tex copies the content of firstChapter.tex into main.tex, so when the \cmd{\includegraphics} command is called, it is called from within projectDirectory, thus the relative path lookup of firstGraphicOfFirstChapter.jpeg fails. Instead the command\\
% \cmd{\includegraphics\{firstChapter/firstGraphicOfFirstChapter.jpeg\}}\\
% can be used (example for a Unix system), but this is tedious and counter-intuitive.
%
% If both tikzscale and currfile are loaded, the limitation is fixed, so that both \cmd{\includegraphics} commands succeed. Note, that this functionality supports the traditional graphic formats, too, and is also available without loading the TikZ or PGFPlots packages, although the package's name might imply otherwise.
%
% \section{Compatibility}
%
% \subsection{Load Order}
% There is no constraint regarding the load order known, yet. TikZ, PGFPlots and currfile might all be loaded or not in all possible combinations and orders before or after tikzscale.
%
% \subsection{Externalization library}
% TikZ' externalization library is supported. Its use is highly recommended, as tikzscale renders some graphics multiple times to get the correct size. The savings by using the externalization library can thus be huge.
%
% Using both the externalization library and tikzscale seems to have a race condition when a makefile is used with multiple jobs (-j$X$ with $X > 1$). The probability of getting errors increases with the number of jobs. For $X = 1$, obviously, no race condition could be observed. You should either avoid using mode \emph{list and make} or have only one job if you want to be on the safe side.
%
% Using \cmd{\tikzexternalenable} or \cmd{\tikzexternaldisable} inside of a tikzpicture leads to undefined behaviour when using tikzscale. It's not clear, what the correct behaviour should be and what the externalization library does withouth tikzscale.
%
% Note, that there was a \href{http://tex.stackexchange.com/a/88158/7323}{bug} in the externalization library, which has been fixed on 25th of December in 2012, so you might want to use a more recent version of TikZ or PGFPlots.
%
% Please note, that when using the externalization library, sometimes two (externalization) runs are necessary to get completely correct sizes.
%
% \subsection{Fitting library}
% Due to a \href{http://sourceforge.net/tracker/index.php?func=detail&aid=2991312&group_id=142562&atid=752792}{known bug in the fitting library}, nodes with a \texttt{fit} option also need a \texttt{transform shape} option in order to be scalable. If they are not scalable, they normally do not contain the nodes as specified when tikzscale is used.
%
% \section{Further Ideas}
% \begin{itemize}
% \item With careful considerations, it should be possible to reduce the average number of needed figure renderings, which should speed-up runs with very complicated figures.
% \item Add the external file optimization loop to axis ratio and pgfplots, as well.
% \item For width or height scaling, the main process sometimes lets a client process build a graphic which needs a rebuild to get the correct size. The main process should get some logic to issue a warning (currently only the client process issues a warning). Immediately triggering a rebuild would be even better (depending on the externalization mode).
% \item The figure name should not be choosen automatically if the name was already set by the user.
% \item If graphic files are located in a subdirectory, the externalized files should also be in that subdirectory. But there must be a fallback if a graphic is inside a directory without write access (otherwise externalizing a graphic from a system wide TeX installation would fail).
% \item allow in-file graphics by redefining the tikzpicture environment and accepting tikzscale and tikz options. The tikzscale options are evaluated using key filtering (tikz library) and the tikz options are forwarded.
% \item the package can test if a pgfplot is used (needed if normal TikZ graphics should be stretchable) by changing \cmd{\tikzscale@width} and or \cmd{\tikzscale@height} and measuring. If nothing changes, it must be a normal tikzpicture (the argument does not hold the other way round).
% \item it may be better to use the \href{http://tex.stackexchange.com/a/22957}{depth as well}
% \item The final sizing parameters should be saved per figure in the aux file. The first rendering each run should be performed with the aux file's parameters into an sbox. The scaling algorithms should only be called, if the sizing requirements are not met. The purpose is similar to the externalization library.
% \item Using something like [x=5pt] as an argument to the axis environment, e.g. to scale the units in bar plots, is problematic, as tikzscale changes the behaviour, i.e. stops the scaling.
% \end{itemize}
%
% \section{Contributions}
% \begin{itemize}
% \item Jake
% \begin{itemize}
% \item Encouraged the author to create this package.
% \end{itemize}
% \item Dr.\ Christian Feuersänger
% \begin{itemize}
% \item Encouraged the author to create this package and created PGFPlots.
% \item Answered many questions and had a lot of good ideas regarding the externalization and beyond.
% \item Fixed problems in the externalization library when used with tikzscale.
% \end{itemize}
% \item David Carlisle
% \begin{itemize}
% \item Created the \cmd{\xcmd} macro for this package, which is used in the documentation.
% \end{itemize}
% \item Prof. Kai Arzheimer
% \begin{itemize}
% \item Reported a bug when not using TikZ without PGFPlots, which lead to a fix.
% \item Reported a bug that a non-existent macro is used, which lead to a fix.
% \end{itemize}
% \item devendra
% \begin{itemize}
% \item Reported bugs when using the externalization library together with tikzscale, which lead to a fix.
% \item Reported a problem when using data files, which lead to a fix regarding \cmd{\endlinechar}.
% \end{itemize}
% \item Mohammad Reza Keshtkaran
% \begin{itemize}
% \item Reported a bug when using plain old \LaTeX with an eps file, which lead to a fix.
% \item Reported another bug when using plain old \LaTeX, which lead to some rework to fully support \LaTeX without additional code.
% \item Reported a bug when using \cmd{\graphicspath}, which lead to a fix.
% \item Reported the bug when using \cmd{\graphicspath} again, which lead to a correct fix even if currfile is not used.
% \end{itemize}
% \item Andreas Tharang
% \begin{itemize}
% \item Reported that the beamer class is incompatible with tikzscale, which lead to a change in tikzscale to fix this incompatibility.
% \item Reported that the fitting library is incompatible with tikzscale due to a bug in the fitting library, which lead to a note in the documentation.
% \item Created tests to improve the compatibility between beamer and tikzscale, which lead to support of Beamer's \cmd{\pause} command.
% \end{itemize}
% \item Klaus Pribil
% \begin{itemize}
% \item Reported an incompatibility with the pdfpages package, which lead to a fix in tikzscale.
% \end{itemize}
% \item Christoph Schmidpeter
% \begin{itemize}
% \item Reported a problem when accidently adding a superfluous space into the graphics path, which lead to a detection and fix of that case in tikzscale.
% \end{itemize}
% \item Jose Hissa Ferreira
% \begin{itemize}
% \item Reported a bug when using a graphics path with multiple path entries, which lead to a fix.
% \end{itemize}
% \item Guillaume Martrou
% \begin{itemize}
% \item Reported a bug in an example of the documentation where -- was written instead of -{}-, which lead to its fix.
% \end{itemize}
% \end{itemize}
%
%
% \section{Implementation}
% The basic idea is to first get the correct file name (i.e. find the path and the file extension), then determine the graphic type (i.e. TikZ or something else) and call either the original includegraphics command or the tikzscale command. Tikzpictures are then plotted into an invisible box and their size is measured. If their measured size differs from the requested size, they are replotted with corrected parameters to get the requested size. The correctly sized plots are then really plotted.
%
% \iffalse
%<*package>
% \fi
% \makeatletter
%
% This command draws the plot's border at the right text border, so that thick points or label descriptions can reach into the margin. This should be limited to PGFPlots only if activated.
%^^A \tikzset{every picture/.style={trim axis right}}
%
% With the option below, the labels can be moved a bit to the left so that they reach to the text margin.
% yticklabel style={align=right,inner sep=0pt,xshift=-0.1cm}
%
%\begin{macro}{\pgfmathsetglobalmacro}
% This is a general command, which might be useful for inclusion into the tikz package. It works similar to \cmd{\pgfmathsetglobalmacro} but has global scope.
% \begin{macrocode}
\def\pgfmathsetglobalmacro#1#2{%
\pgfmathparse{#2}%
\global\let#1\pgfmathresult%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\ifTikzLibraryLoaded}
% This is a general command, which might be useful for inclusion into the tikz package. This is taken from \href{http://tex.stackexchange.com/a/48472}{stackexchange} and simplified.
% \begin{macrocode}
\def\ifTikzLibraryLoaded#1#2#3{%
\ifcsdef{tikz@library@#1@loaded}{%
#2%
}{%
#3%
}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\ifExternalizationLoaded}
% \begin{macrocode}
\def\ifExternalizationLoaded#1#2{%
\ifTikzLibraryLoaded{external}{#1}{#2}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\ifInExternalizationRun}
% Executes the first argument if we are currently in an externalization run and the second argument otherwise. An externalization run is the execution of LaTeX with the sole purpose to externalize a figure. For example, if the normal shell-escape externalization mode is active, there is one main run, which gets paused, whenever a graphic is externalized. Therefore another LaTeX process is started. The former LaTeX instance is no externalization run, whereas the latter processes are. This is a general command, which might be useful for inclusion into the externalization library.
% \begin{macrocode}
\def\ifInExternalizationRun{%
\ifedefequal\jobname\tikzexternalrealjob%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\ifedefequal}
% \xcmd\ifedefequal{first expression}{second expression}{true}{false}
% This is a general command, which might be useful for inclusion into the etoolbox package. It executes the true code if both expressions expand to the same and otherwise the false code. This test is often wanted, as the order of the arguments is not important and it does not matter if the user saves a value in another macro without expanding it. This macro is not safe in an expansion-only context. An \href{http://tex.stackexchange.com/a/59571}{expandable solution} exists, too.
% \begin{macrocode}
\def\ifedefequal#1#2{%
\edef\etoolbox@ifedefequal@first{#1}%
\edef\etoolbox@ifedefequal@second{#2}%
\ifdefequal{\etoolbox@ifedefequal@first}{\etoolbox@ifedefequal@second}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\edocsvlist}
% This is a general command, which might be useful for inclusion into the etoolbox package. It works similar to \cmd{\docsvlist} but expands its argument similar to \cmd{\def} vs.\ \cmd{\edef}, which is useful if the list is stored in a macro/variable.
% \begin{macrocode}
\def\edocsvlist#1{%
\edef\tikzscale@edocsvlist{#1}%
\expandnext{\docsvlist}{\tikzscale@edocsvlist}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\eforcsvlist}
% This is a general command, which might be useful for inclusion into the etoolbox package. It works similar to \cmd{\forcsvlist} but expands its argument similar to \cmd{\def} vs.\ \cmd{\edef}, which is useful if the list is stored in a macro/variable.
% \begin{macrocode}
\def\eforcsvlist#1#2{%
\edef\tikzscale@eforcsvlist{#2}%
\expandnext{\forcsvlist{#1}}{\tikzscale@eforcsvlist}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\forgrouplist}
% This is a general command, which might be useful for inclusion into the etoolbox package. It works similar to \cmd{\forcsvlist} but uses TeX groups to separate elements instead of a comma separated list.
% \begin{macrocode}
\def\forgrouplist#1#2{%
% \end{macrocode}
% Use \cmd{\grouplistbreak} instead of \cmd{\forcsvlist}'s \cmd{\listbreak}, because the function given in the first argument can contain a call to \forcsvlist. In this case \cmd{\listbreak} is executed, although no break has been called, which lead to an error in the program, if \cmd{\listbreak} were used.
% \begin{macrocode}
\def\grouplistbreak{\def\breakFor{}}%
\tikzscale@forGroupListElement{#1}#2\tikzscale@endList%
% \end{macrocode}
% Delete \cmd{\breakFor} in case it has been set.
% \begin{macrocode}
\undef\breakFor
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@forGroupListElement}
% \begin{macrocode}
\NewDocumentCommand{\tikzscale@forGroupListElement}{mgu{\tikzscale@endList}}{%
% \end{macrocode}
% Only do list processing if \cmd{\listbreak} has not been called.
% \begin{macrocode}
\ifundef{\breakFor}{%
\IfValueTF{#2}{%
#1{#2}%
\tikzscale@forGroupListElement{#1}#3\tikzscale@endList%
}{%
#1{#3}%
}%
}{}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\eforgrouplist}
% This is a general command, which might be useful for inclusion into the etoolbox package. It works similar to \cmd{\forgrouplist} but expands its argument similar to \cmd{\def} vs.\ \cmd{\edef}, which is useful if the list is stored in a macro/variable.
% \begin{macrocode}
\def\eforgrouplist#1#2{%
\edef\tikzscale@grouplist{#2}%
\expandnext{\forgrouplist{#1}}{\tikzscale@grouplist}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@trim}
% These is a general command to trim leading and trailing spaces, which might be useful for inclusion into another package taken from the following \href{http://www.matijs.net/blog/2006/07/20/how-to-trim-spaces-in-tex}{homepage}.
% \begin{macrocode}
\def\tikzscale@trim#1{%
\ignorespaces#1\unskip
}%
% \end{macrocode}
%\end{macro}
%
% \begin{macro}{\tikzscale@trimMacro}
% A possible present leading or trailing space in the macro's content is removed from the macro.
% \begin{macrocode}
\def\tikzscale@trimMacro#1{%
\expandnext\IfBeginWith{#1}{ }{%
\expandnext\StrGobbleLeft{#1}{1}[#1]%
}{}%
\expandnext\IfEndWith{#1}{ }{%
\expandnext\StrGobbleRight{#1}{1}[#1]%
}{}%
}
% \end{macrocode}
%\end{macro}
%
% \begin{macro}{\elseif}
% This macro provides a conditional which supports an if with an arbitrary amount of elseif (none is also ok) and an optional else. With a simplified syntax (remove the tests and the grouping) this would be worth a separate package.
% \begin{macrocode}
\NewDocumentCommand{\elseif}{mm}{%
\ifboolexpr{#1}{%
#2%
\elseif@absorb
}{%
\elseif@optional
}%
}
\NewDocumentCommand{\elseif@optional}{gg}{%
\IfValueT{#1}{%
\IfValueTF{#2}{%
\ifboolexpr{#1}{%
#2%
\elseif@absorb
}{%
\elseif@optional
}%
}{%
#1%
}%
}%
}
\NewDocumentCommand{\elseif@absorb}{g}{%
\IfValueT{#1}{%
\elseif@absorb
}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\IfNoValueOrSplitEmptyTF}
% This command is from \href{http://tex.stackexchange.com/a/63248/7323}{Bruno Le Floch}.
% \begin{macrocode}
\ExplSyntaxOn
\NewDocumentCommand{\IfNoValueOrSplitEmptyTF}{mmm}{
\ifboolexpr{test {\IfNoValueTF{#1}} or test {\tl_if_eq:nnTF{#1}{{}}}}{
#2
}{
#3
}
}
\ExplSyntaxOff
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@ifExternalizationActive}
% The check \cmd{\tikzifexternalizehasbeencalled} from file tikzexternalshared.code.tex is not exactly what is needed in tikzscale, as it always stays true after it has been set by \cmd{\tikzexternalize}. Instead, add a check whether externalization is active and set it to false if externalization has not been loaded for simplification. Thus, whether externalization is active can be checked without checking if it has been loaded at all. The initial state of \cmd{\tikzscale@externalizationActive} is not trivially known, as an arbitrary combination and order of \cmd{\tikzexternaldisable} and \cmd{\tikzexternalenable} commands could have been used before the end of the preamble. In the long run, tikzexternalshared.code.tex should offer that check. Until then, we can check whether \cmd{\tikz}=\cmd{\tikzexternal@origtikz} (i.e. externalization disabled) or \cmd{\tikz}=\cmd{\tikzexternal@tikz@replacement} (i.e. externalization enabled) holds (if neither of both holds, this indicates a problem, e.g. another package redefining the command). This is, of course, only needed if the externalization library has been loaded at all. Please note, the implementation of this check as a macro is possible, because tikzscale redefines tikzpicture, whereas the externalization library redefines tikz, so there is no conflict.
% \begin{macrocode}
\def\tikzscale@ifExternalizationActive#1#2{%
\ifExternalizationLoaded{%
\ifdefequal{\tikz}{\tikzexternal@tikz@replacement}{%
#1%
}{%
\ifdefequal{\tikz}{\tikzexternal@origtikz}{%
}{%
\PackageWarning{tikzscale}{Status of externalization is unknown, thus I assume it is deactivated.}%
}%
% \end{macrocode}
% It's important, that this code is below the above code, as the below code can change the meaning of \cmd{\tikz} through side effects.
% \begin{macrocode}
#2%
}%
}{%
#2%
}%
}%
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@debug}
% \begin{macrocode}
\def\tikzscale@debug#1{%
\PackageWarning{tikzscale}{#1}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@warn}
% \begin{macrocode}
\def\tikzscale@warn#1{%
\PackageWarning{tikzscale}{#1}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\activatetikzscale}
% \begin{macrocode}
\AtEndPreamble{%
% \end{macrocode}
% Add the TikZ file extensions to the \href{http://tex.stackexchange.com/a/45502}{graphicx file extensions}.
% \begin{macrocode}
\def\tikzscale@tikzFileExtensions{.tikz,.TIKZ,.TikZ,.pgf,.PGF}%
% \def\tikzscale@tikzFileExtensions{.tikz,.TIKZ,.TikZ,.pgf,.PGF,.tex,.TEX}%
\DeclareGraphicsExtensions{\tikzscale@tikzFileExtensions,\Gin@extensions}%
% \end{macrocode}
% Save the \cmd{\includegraphics} \href{ftp://ftp.tu-chemnitz.de/pub/tex/macros/latex/required/graphics/grfguide.pdf}{command}.
% \begin{macrocode}
\LetLtxMacro{\tikzscale@oldincludegraphics}{\includegraphics}%
% \end{macrocode}
% Activate the enhanced includegraphics command at end of preamble, so that no other package is interfering (besides on purpose).
% \begin{macrocode}
\tikzscale@useEnhancedIncludegraphics
% \end{macrocode}
% Also patch tikzpicture environment to temporarily deactivate the enhanced includegraphics command inside the tikzpicture environment in case the tikzpicture environment is called directly (without includegraphics being called) and loading another graphic (like a PNG file inside of a pgfplot).
% \begin{macrocode}
\tikzscale@patchTikzpictureIncludegraphics
% \end{macrocode}
% As \cmd{\endtikzpicture} does not seem to be redefined, patch it here (once) to activate tikzscale's \cmd{\includegraphics} again. This is probably not necessary, but might be handy if there are two tikzpicture environments in one includegraphics environment.
% \begin{macrocode}
\tikzscale@patchEndtikzpictureIncludegraphics
% \end{macrocode}
% \begin{macrocode}
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzexternal}
% \begin{macrocode}
\AtEndPreamble{%
% \end{macrocode}
% Activate the output of the graphics sizes into the dpth files (one file per graphic) if externalization might be used (known at the end of preamble). This key is used if the externalization library is activated to check if the scaling is correct, otherwise the code is not needed.
% \begin{macrocode}
\ifExternalizationLoaded{%
\pgfkeys{/pgf/images/external info}%
}{}%
\@ifpackageloaded{tikz}{%
% \end{macrocode}
% Set a minimum accuracy tikzscale tries to achieve. TeX's accuracy is limited, thus, e.g. 0.04 pt, cannot always be achieved independent of the number of iterations. Use the \href{http://en.wikibooks.org/wiki/TeX/hfuzz}{value} (0.1 pt in an experiment) which is used for overfull paragraph warnings, too.
% \begin{macrocode}
\newlength{\tikzscale@accuracy}%
\setlength{\tikzscale@accuracy}{\hfuzz}%
% \end{macrocode}
% This is needed in normal TikZ pictures and in PGFPlots, but as the pgfplots package loads the tikz package, it is fine to define it here.
% \begin{macrocode}
\def\maxTestIterations{10}%
}{}%
% \end{macrocode}
% If the externalization library has been loaded, prepare it for use together with tikzscale.
% \begin{macrocode}
\ifExternalizationLoaded{%
% \end{macrocode}
% \cmd{\tikzexternaldisable} and \cmd{\tikzexternalenable} normally unintentionally deactivate the tikzscale commands (as they restore the original TikZ commands), so let them restore the tikzscale commands instead. The idea is to get the tikzscale's includegraphics command being called and then redefine tikzpicture and do the rest of the work there. Do the patching always when \cmd{\tikzexternaldisable} or \cmd{\tikzexternalenable} is called, as the patching should also be done when \cmd{\includegraphics} is not used, but \cmd{\tikzpicture} is called directly.
% \begin{macrocode}
\apptocmd{\tikzexternaldisable}{%
\tikzscale@useEnhancedIncludegraphics
\tikzscale@patchTikzpictureIncludegraphics
}{}{\PackageError{tikzscale}{Patching tikzexternaldisable failed}}%
%
\apptocmd{\tikzexternalenable}{%
\tikzscale@useEnhancedIncludegraphics
\tikzscale@patchTikzpictureIncludegraphics
}{}{\PackageError{tikzscale}{Patching tikzexternalenable failed}}%
% \end{macrodode}
% Patch the externalization command to also save the axis ratio if given. Unfortunately, \cmd{\apptocmd} cannot be used, as patching fails due to "nested patching command and parameters in patch", thus, manual patching is in order.
% \begin{macrocode}
\LetLtxMacro{\tikzscale@externalend@storeshifts}{\pgf@externalend@storeshifts}%
\def\pgf@externalend@storeshifts#1{%
\tikzscale@externalend@storeshifts{#1}%
\ifpgfexternal@info
% \end{macrocode}
% Write the axis ratio into the dpth file into variable \cmd{\tikzscale@oldAxisRatio}. The existence of the variable in the dpth file indicates if the axis ratio has been given in the last run.
% \begin{macrocode}
\tikzscale@writeToDpth{#1}{\tikzscale@oldAxisRatio}{\requestedAxisRatio}%
% \end{macrocode}
% Figures sometimes get externalized with a wrong size although they had a correct size before externalization. This size error has to be compensated in the next run, i.e. the figure must be generated with a corrected (i.e. "wrong") size to have the correct size after externalization. The error is the difference between internal measurement and external measurement. Thus, write the measured size into the dpth file into variable \cmd{\tikzscale@oldMeasuredSize} to have it available for error calculation. After perfect convergence, the measured size equals the requested size and must not be safed. However, safing the measured size is more robust, as it works even if no perfect convergence could be achieved.
% \begin{macrocode}
\tikzscale@writeToDpth{#1}{\tikzscale@oldMeasuredSize}{\tikzscale@measuredLast}%
\fi
}%
}{}%
% \end{macrocode}
% \begin{macrocode}
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@writeToDpth}
% Write the value of the third argument, if it exists, into the dpth file (write handle in the first argument) of the current figure, accessible by the second argument. The second and the third argument must contain macro names (including the backslash).
% \begin{macrocode}
\def\tikzscale@writeToDpth#1#2#3{%
\ifdef{#3}{%
% \end{macrocode}
% This is copied from the macro \cmd{\pgf@externalend@storeshifts} from file pgfcoreexternal.code.tex.
% \begin{macrocode}
\immediate\write#1{\noexpand\pgfexternal@restore{\noexpand\def\noexpand#2{#3}}}%
}{}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@maybeGetExternalSize}
% Returns the width or the height of the externalized graphic with already loaded dpth file in macro \cmd{\pgfexternalsize}. Otherwise, the macro is undefined. The width is returned if the parameter is \cmd{wd}, the height is returned if the parameter is \cmd{\ht}.
% \begin{macrocode}
\def\tikzscale@maybeGetExternalSize#1{%
% \end{macrocode}
% Use the expandability of ifIsWidth and the coupled (non-)definition of \cmd\pgfexternalwidth and \cmd\pgfexternalheight.
% \begin{macrocode}
\ifdef\pgfexternalwidth{
\edef\pgfexternalsize{\tikzscale@ifIsWidth#1\pgfexternalwidth\pgfexternalheight}%
}{%
\undef\pgfexternalsize
}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\includegraphics}
% \begin{macrocode}
\NewDocumentCommand{\tikzscale@includegraphics}{O{}m}{%
% \tikzscale@debug{In includegraphics, 1=#1, 2=#2}%
% \tikzscale@debug{In includegraphics, jobname=\jobname\ifdef{\tikzexternalrealjob}{, tikzexternalrealjob=\tikzexternalrealjob}{}}%
% \end{macrocode}
% This command uses an empty optional argument for compatibility with the traditional graphicx command.
% Start a group, so that changed variables during processing the current tikzpicture due not influence other tikzpictures. This is much more convienient, than resetting every single variable. Use \cmd{\begingroup} instead of \cmd{\bgroup} to simplify finding unmatched braces.
% \begin{macrocode}
\begingroup
% \end{macrocode}
% It happened at least once together with externalization, that the deactivation of the new includegraphics command did not work, so do it again to be safe (maybe reentrance problem with multiple tikzpicture calls?).
% \begin{macrocode}
\LetLtxMacro{\includegraphics}{\tikzscale@oldincludegraphics}%
% \end{macrocode}
% Find the exact file name, as the ending and the path could have been omitted in the call and must be resolved.
% \begin{macrocode}
\tikzscale@resolveFileName{\tikzscale@fileName}{#2}%
% \end{macrocode}
% Do everything else in another macro, which gets the resolved and expanded file name. This way, the expansion is necessary only once and all macros which are called later in this package do not have to do further expansion of the file name.
% \begin{macrocode}
\expandnext{\tikzscale@includeResolvedFileName{#1}}{\tikzscale@fileName}%
\endgroup
}%
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@includeResolvedFileName}
% Include the graphic with the optional arguments in argument one and the fully expanded and resolved file name in the second argument.
% \begin{macrocode}
\def\tikzscale@includeResolvedFileName#1#2{%
% \tikzscale@debug{In includeResolvedFileName, 1=#1, 2=#2}%
% \end{macrocode}
% Do the patching of endlinechar and tikzpicture here, as tikzpicture should not be changed if not called via the new \cmd{\includegraphics} command.
% TODO: Wouldn't it be better to call fixEndLine only if the argument really is a TikZ file? Then it would not be necessary to restoreEndLineChar if the argument is no TikZ file. Or would that be problematic for includegraphics calls inside of tikzpictures?
% \begin{macrocode}
\tikzscale@fixEndLine
% \end{macrocode}
% Check if the found file is a TikZ file.
% \begin{macrocode}
\tikzscale@ifIsTikzFile{#2}{%
\tikzscale@includetikz[#1]{#2}%
}{%
% \end{macrocode}
% Restore \cmd{\endlinechar} before calling code from other packages. This is not only cleaner, but really avoids an error when using the plain old latex (with dvi output) with an eps graphic.
% \begin{macrocode}
\tikzscale@restoreEndLineChar
\tikzscale@oldincludegraphics[#1]{#2}%
}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@useEnhancedIncludegraphics}
% Replace the \cmd{\includegraphics} command by tikzscale's more generic command, to provide a consistent user interface.
% \begin{macrocode}
\def\tikzscale@useEnhancedIncludegraphics{%
\LetLtxMacro{\includegraphics}{\tikzscale@includegraphics}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@fixEndLine}
% tikzpicture environment gets redefined:
% - without external library: only inside tikzscale (once)
% - with external library: additionally, whenever \cmd{\externalenable} or \cmd{\externaldisable} is called (\cmd{\tikzpicture} and \cmd{\endtikzpicture})
% Use cases to patch tikzpicture:
% - to use tikzscale's includegraphics
% - to restore end of line character
% Constraints:
% - The patches have to be applied at the beginning of \cmd{\tikzpicture} and the end of \cmd{\endtikzpicture}, as \cmd{\tikzpicture} might not be executed completely when using external, as then the content of the tizkpicture environment is not executed at all.
% - The patches should not accumulate
% - A group might make sense to have a local scope
% \begin{macrocode}
\def\tikzscale@fixEndLine{%
% \end{macrocode}
% There is a leading space character introduced by the externalization library, if the file is input directly. Thus, use a trick to avoid that space. Furthermore, a specific TikZ version introduces a trailing space character. To get rid of all space character issues, just solve the problem here once and for all. Note, that the redefinition of \cmd{\endlinechar} is local to the current group, so it does not have to be restored at the end of the group.
% \begin{macrocode}
\edef\tikzscale@restoreEndLineChar{\endlinechar=\the\endlinechar\relax}%
\endlinechar=-1%
% \end{macrocode}
% Restore the \cmd{\endlinechar} during the execution of the tikzpicture environment. This is necessary, for example, if data is read from a table and the data entries are separated by newline characters. Not restoring the \cmd{\endlinechar} would \href{http://tex.stackexchange.com/q/89053/7323}{distort the data}. Use \cmd{\apptocmd} to call the command inside the group opened by tikzpicture. Thus, nothing has to be done in \cmd{\endtikzpicture} regarding \cmd{\endlinechar}.
% \begin{macrocode}
\tikzscale@addRestoreEndLineCharToTikzpicture
%
\apptocmd{\endtikzpicture}{%
\endlinechar=-1%
}{}{\PackageError{tikzscale}{Patching endtikzpicture failed}}%
}%
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@addRestoreEndLineCharToTikzpicture}
% \begin{macrocode}
\def\tikzscale@addRestoreEndLineCharToTikzpicture{%
\pretocmd{\tikzpicture}{%
\tikzscale@restoreEndLineChar
}{}{\PackageError{tikzscale}{Patching tikzpicture failed}}%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@patchTikzpictureIncludegraphics}
% \begin{macrocode}
\def\tikzscale@patchTikzpictureIncludegraphics{%
% Deactivate the new includegraphics command inside of tikzpictures, as a tikzpicture might load a PNG graphic or something and this should not be scaled by tikzscale but by TikZ or PGFPlots. Besides, the current implementation is not reentrant, so its not a good idea to call the macro recursively. The deactivation must be inside of tikzpicture, as a tikzpicture can be loaded without using includegraphics, thus it cannot be done there. Using \cmd{\apptocmd} to do a local definition inside of the group started by \cmd{\tikzpicture} does not work. The \cmd{\includegraphics} command really has to be deactivated here, as a tikzpicture including a PNG file might be called directly without calling includegraphics.
% \begin{macrocode}
\pretocmd{\tikzpicture}{%
\LetLtxMacro{\includegraphics}{\tikzscale@oldincludegraphics}%
}{}{\PackageError{tikzscale}{Patching tikzpicture failed}}%
%
}
% \end{macrocode}
%\end{macro}
%
%\begin{macro}{\tikzscale@patchEndtikzpictureIncludegraphics}
% \begin{macrocode}
\def\tikzscale@patchEndtikzpictureIncludegraphics{%
\apptocmd{\endtikzpicture}{%
\LetLtxMacro{\includegraphics}{\tikzscale@includegraphics}%
}{}{\PackageError{tikzscale}{Patching endtikzpicture failed}}%
}
% \end{macrocode}
%\end{macro}
%
% \begin{macro}{\tikzscale@resolveFileName}
% Find the exact file name of a graphic file given in the second argument by testing several paths and file endings. The argument must be expandable. The file name is saved in the macro given in the first argument. The resolved file name is saved expanded in the macro, i.e. it can be fully expanded after only one expansion of the macro.
% \begin{macrocode}
\def\tikzscale@resolveFileName#1#2{%
% \end{macrocode}
% Delete the return variable if it already exists to allow checking if a file has been found.
% \begin{macrocode}
\undef#1%
% \end{macrocode}
% Create a helper function used inside the file ending evaluation.
% \begin{macrocode}
\def\tikzscale@checkDirectory##1{%
\def\tikzscale@checkExtension####1{%
\IfFileExists{##1#2####1}{%
% \end{macrocode}
% Use \cmd{\edef} instead of \cmd{\def} here, to be completely sure to only have a string left. This avoids problems when using tikzscale together with the pdfpages package and should generally be the right thing.
% \begin{macrocode}
\edef#1{##1#2####1}%
% \end{macrocode}
% Break the inner (\cmd{\forcsvlist}) loop over file extensions.
% \begin{macrocode}
\listbreak
}{}%
}%
% \end{macrocode}
% Test all possible file extensions and do not forget that the extension might already be given. \cmd{\Gin@extensions} returns the \href{http://tex.stackexchange.com/a/45502}{current content} set by \cmd{\DeclareGraphicsExtensions}.
% \begin{macrocode}
\eforcsvlist{\tikzscale@checkExtension}{{},\Gin@extensions}%
\ifdef{#1}{%
% \end{macrocode}
% Break the outer (\cmd{\forgrouplist}) loop over directories.
% \begin{macrocode}
\grouplistbreak
}{}%
}%
% \end{macrocode}
% Set the graphics path, to also find graphics in the last (current) input directory or in completely separate paths. Set it here to get updates if the user uses the \cmd{graphicspath} command inside of the document body.
% \begin{macrocode}
\tikzscale@setGraphicsPath
\eforgrouplist{\tikzscale@checkDirectory}{\tikzscale@graphicspath}%
% \end{macrocode}
% If no file has been found, return the given file name, as includegraphics should try its best. Use \cmd{\edef} due to the same reasons as above.
% \begin{macrocode}
\ifundef{#1}{%
\edef#1{#2}%
}{}%
}
% \end{macrocode}
%\end{macro}