19

I'm currently writing my thesis and have been looking for ways to speed up compile time. I can shave off a lot of time by using draft mode so that images aren't processed, but I have several TikZ diagrams which also take some time to compile. Is there a way for me to put a switch in my header that can ignore processing the TikZ diagrams when I'm just checking my writing?

For example, I'd just like to 'turn off' the tikzpicture environment when compiling drafts.

hpesoj626
  • 17,282
Flip
  • 527

2 Answers2

10

Here is a solution that redefines the tikzpicture environment by conditionally wrapping a comment environment (from the verbatim package) around it. I've only tested it with tikzpicture but I think it could be easily adapted to any other environment.

Set the \newif called \showtikz to true (using \showtikztrue) or false (using \showtikzfalse) at the beginning of your document in order to show or hide all the tikzpicture environments in your document, respectively.

This solution by cmhughes to the question How to make LaTeX ignore the contents of an environment? was useful.

EDIT: I changed my \newif, originally \hidetikz, to new \showtikz; double negatives such as \hidetikzfalse are difficult to parse.

\documentclass{article}
\usepackage{tikz}
\usepackage{verbatim}   % for the comment environment
\usepackage{lipsum}

\newif\ifshowtikz
\showtikztrue
%\showtikzfalse   % <---- comment/uncomment that line

\let\oldtikzpicture\tikzpicture
\let\oldendtikzpicture\endtikzpicture

\renewenvironment{tikzpicture}{%
    \ifshowtikz\expandafter\oldtikzpicture%
    \else\comment%   
    \fi
}{%
    \ifshowtikz\oldendtikzpicture%
    \else\endcomment%
    \fi
}

\begin{document}
\begin{tikzpicture}[scale=1]
    \path[draw=red,fill=red!20] (0,0) rectangle (4,4);
\end{tikzpicture}

\lipsum[1]
\end{document}

If \showtikz is set to true, the output is:

enter image description here

If \showtikz is set to false, the output is:

enter image description here

Community
  • 1
jub0bs
  • 58,916
  • 3
    If you want this to work when options are given to \begin{tikzpicture} (e.g. [scale=2]), you need to put an \expandafter between \else and \oldtikzpicture in your redefinition of {tikzpicture}. – Philippe Goutet Apr 30 '13 at 17:03
  • 1
    What if the OP wants the rest of the formatting (paragraphing, pagination) to be independent of whether the picture is present/absent? Probably not what he needs, but makes the question harder. Then you'd need to know the size of the picture. – Ethan Bolker Apr 30 '13 at 17:48
  • @EthanBolker Well, that's not what I understand the OP wants, so I didn't consider that possibility at all. I don't see how that could be easily done, though. The size of the picture depends on the tikz commands inside it, so you'd probably have to somehow draw the complete picture anyway in order to get the correct size. That would not speed up the compilation, as required by the OP. – jub0bs Apr 30 '13 at 17:53
  • 1
    Thank you, everyone! Re: Ethan's question, indeed, this isn't relevant for my current workflow, but it's an interesting question as well. Thanks to all for the very helpful discussion, solution, and references. – Flip Apr 30 '13 at 19:04
  • It leaves the Caption (in this example caption is not there) intact. What if I want to removed the caption too? – Tash Apr 08 '20 at 16:22
4

Similar to my answer in Simple way to switch inline asymptote figures on and off (with a slight modification), you can gobble the content of an environment using environ, and output whatever you want instead:

enter image description here

\documentclass{article}

\usepackage{tikz,environ}
\usepackage{lipsum}

%\newcounter{tikzfigcntr}
%\RenewEnviron{tikzpicture}[1][]{%
%  \par% New paragraph
%  \stepcounter{tikzfigcntr}% Step tikzfigcntr counter
%  This is \texttt{tikzpicture}~\thetikzfigcntr% Place appropriate text
%  \par% New paragraph
%}

\begin{document}

\begin{tikzpicture}[scale=1]
    \path[draw=red,fill=red!20] (0,0) rectangle (4,4);
\end{tikzpicture}

\lipsum[1]

\end{document}

If you uncomment the tikzpicture redefinition (and counter definition), the replacement text "This is tikzpicture <num>" is printed (where <num> is a counter representing the picture number). Replace this with whatever you want:

enter image description here

Werner
  • 603,163
  • Does providing \env@tikzpicture@save@env and \env@tikzpicture@process have any effect in this? – Andreas Storvik Strauman Jun 13 '19 at 08:07
  • 1
    @AndreasStorvikStrauman: There was a bug in environ which required this to exist in order to \RenewEnviron an environment that wasn't originally defined with \NewEnviron. This was fixed in v0.3 (2015/05/04). I've updated the answer since it's not necessary anymore. – Werner Jun 13 '19 at 19:53