What does the draft mode change?

Question

I wonder which changes are made by the draft option?

That means what will be changed by calling it as global class option (\documentclass[draft]{<class>}) or locally for a single package if it is available (\usepackage[draft]){<package>}.

Note
I know that this depends on the loaded packages and if they react on the draft option or not. But I thought it could be helpful to have a overview which packages do what.

I suggest the answers to be CW and using this layout

Package/Class: `name`  
Changes

- one
- two

Has `final` option too: yes/no

If you like we can discuss the layout in meta …

While I like your question, I don't see a point in adding several CW answers. Why not write a single answer covering everything you know (with appropriate sections) and let other users add their knowledge either in separate answers (provided your answer was non-CW) or by editing your (CW) answer? — lockstep, Mar 24 '12 at 18:31
@lockstep: Hm … I though it’s a little more tidy in separate answers. And furthermore the answers can be sorted by importance/relevance by upvoting them. If you comment get’s 5 upvotes (do we call it upvotes for comments too?) I’ll merge the CW answers. — Tobi, Mar 24 '12 at 18:38
Several packages for setting someting in the page background, e.g draftmark or xwatermark, have a draft and final option, but I was too lazy to search for, what it means in each case. — Speravir, Mar 25 '12 at 01:17
@IlmariKaronen: The question shouldn’t explain it. For that we have the answers below. And since it depends on the packages one can’t say what the option does in general ;-) — Tobi, Mar 25 '12 at 08:23
@lockstep: I decided to make an overview answer and keeping the more detailed single answers. I guess thats a good compromise, isn’t it? I’ll stick the overview to the top by accepting as soon as it is possible to accept my own answer. — Tobi, Mar 25 '12 at 09:56
@Tobi a) It's at least better than the current situation ;-) b) Self-accepted answers don't flow to the top automatically -- they have to have the highest score, too. — lockstep, Mar 25 '12 at 09:59
@lockstep: b) OK, than I’ll hope that it get’s the highest votes … Since it’s CW it won’t influence my reputation if we upvote it to make it the top answer … — Tobi, Mar 25 '12 at 10:01
@lockstep: b) woud’t it be possible that you copy my overview answer in a new CW answer. Then it should be sticked to the top even if it’s not the one with the highest votes …? — Tobi, Mar 25 '12 at 10:11
@Tobi: I didn't mean you should say what it does, but what it is (as in, an option to \documentclass which can (sometimes?) also be set and/or overridden on a per-package basis). Of course, maybe that really belongs in the [tag:draft] tag wiki; I'd write it if I actually had a clue what to write there. — Ilmari Karonen, Mar 25 '12 at 16:21
Explaining the draft option to a document class and draftmode to latex or pdflatex may be interesting as well. — kiss my armpit, Mar 25 '12 at 18:22
@DamienWalters: I think that the draft (class) option and (pdf)latex’s -draftmode are too different to be covered in the same question. I suggest you ask “What does -draftmode do?” or something like that and we can link both questions. — Tobi, Mar 26 '12 at 15:07

score 76 · Accepted Answer · edited Apr 03 '23 at 22:55

Overview

_{Please add your answer here in alphabetical order too}

Classes

Print a box at the end of overfull lines.
See this answer below for a list of classes and details.

Packages

_{The links lead to the answers below.}

changes (final disables markup of changes, and list of changes)
cryptocode (disables syntax highlighting to reduce compilation time)
flowfram (show frame, typeblock and margin bounding boxes)
graphics (draw frames instead of including images)
graphicx (draw frames instead of including images)
hyperref (disable all linking features)
listings (don’t include external files)
listofsymbols (final suppresses printing of macro names and unused symbols)
mfpic (assume every latex run to be the first one)
pdfcomment (final suppresses the comments)
pdfpages (don’t include external file but print a frame box)
pgf (similar to graphics/x: all images will be replaced by empty rectangles)
pstricks (no native support, but a workaround)
showkeys (draft shows the labels, the default option)
showlabels (draft shows the labels, the default option)
thumbs (thumbs' width=2pt, thumbs' text=black, thumbs' color=grey)
todonotes (with obeyDraft package only enabled in draft mode)
varioref (turn warnings in error messages)

Document classes

Standard: article, book, report
AMS: amsart, amsbook, amsproc
KOMA-Script: scrartcl, scrbook, scrreprt, scrlttr2
Other: proc, memoir

Changes:

Print a mark for overfull lines

Have final option too: yes

Related questions:

edited Jun 10 '20 at 12:32

Community

1

answered Mar 24 '12 at 18:18

Tobi

56,353

Tobi · Answer 4 · 2012-03-25T09:40:22.590

11

Package: graphicx
Changes

Prints frames containing the file name instead of including the images

Has final option too: yes

edited Mar 25 '12 at 09:40

answered Mar 24 '12 at 18:23

Tobi

56,353

3

While it wasn't asked for directly, I think the demo option should also be mention where you don't need the actual figure and you get a black box. – StrongBad Mar 25 '12 at 18:58

score 9 · Answer 5 · answered Mar 24 '12 at 18:26

9

Package: showkeys

draft is the default setting

Has final option: yes, it disables all package functionality.

answered Mar 24 '12 at 18:26

yo'

51,322

score 8 · Answer 6 · answered Mar 24 '12 at 18:37

8

Package: varioref
Changes:

Turn error messages into warnings.

Has final option: yes

answered Mar 24 '12 at 18:37

yo'

51,322

score 7 · Answer 7 · edited Mar 25 '12 at 09:43

7

Package: hyperref

Changes:

Turns all hypertext options off

final option: yes

edited Mar 25 '12 at 09:43

Tobi

56,353

answered Mar 25 '12 at 01:00

Speravir

19,491

Tobi · Answer 8 · 2014-07-21T21:47:47.520

6

Package: listings
Changes

Doesn’t include external file but prints their caption and makes their labels.

Has final option too: yes

edited Jul 21 '14 at 21:47

answered Mar 24 '12 at 18:24

Tobi

56,353

2

How can I suppress this behaviour, or have it render a box of the SAME size as the listing, so that my DRAFT documents layout isn't heavily modified when the input listings disappear... – Nicholas Hamilton Nov 12 '13 at 12:31
2

You can pass the final option directly to a package, while the draft class option stays active for the class and other packages without the explicit option. I.e. \documentclass[draft]{article} ... \usepackage[final]{listings} ... – Tobi Nov 12 '13 at 12:47
My experience is that draft mode even inhibits the display of regular lstlisting environment listings; i.e., not only code from external files. – Jim Ratliff Sep 30 '18 at 20:07

Speravir · Answer 9 · 2014-01-30T04:24:30.510

5

Package: pdfcomment

Option draft is the default.

Changes with final option:

“PDF annotations will not be typeset and will not inﬂuence line breaking.”

(In other words: The lines will change, if inline annotations have been used.)

edited Jan 30 '14 at 04:24

answered Mar 25 '12 at 01:08

Speravir

19,491

score 4 · Answer 10 · answered Mar 24 '12 at 20:29

Package: listofsymbols
Changes:

Option draft is default with this package.
Option final removes the macronames from the lists. Symbols that are not used in the document are omitted from the List of Symbols and from the List of Subscripts.

Has final option too: yes (see above)

score 3 · Answer 11 · answered Mar 24 '12 at 18:34

3

Package: pdfpages
Changes

Does not insert pages, but prints a box and the filename instead.

Has final option too: yes

answered Mar 24 '12 at 18:34

yo'

51,322

That behaviour is probably inherited from graphicx. – Martin Schröder Mar 24 '12 at 20:53
@MartinSchröder Yes, probably. Maybe merge the answers for these two? – yo' Mar 25 '12 at 05:21

score 3 · Answer 12 · edited Feb 21 '19 at 12:42

3

Package pgf (but not TikZ)

Changes:

All images will be replaced by empty rectangles.

final option: yes

edited Feb 21 '19 at 12:42

L. F.

796

answered Mar 25 '12 at 18:13

Speravir

19,491

score 2 · Answer 13 · answered Jan 30 '14 at 20:46

2

Package: changes

Option draft is the default.

Changes with final option:

The final-option disables markup of changes, only the correct text will be shown. The list of changes is disabled, too.

answered Jan 30 '14 at 20:46

Speravir

19,491

score 2 · Answer 14 · answered Sep 26 '16 at 17:08

Package: flowfram

Changes:

Shows the bounding boxes with identifying tags for each frame, the typeblock and the margins.

Example:

\documentclass{article}

\usepackage{lipsum}
\usepackage[draft]{flowfram}

\twocolumntop{static}{1in}

\setstaticcontents{1}{Top Area}

\begin{document}

\marginpar{Marginal Note}\lipsum*[1]

\lipsum*[2-3]\marginpar{Margin Note 2}

\end{document}

Has final option:

score 2 · Answer 15 · edited Jan 30 '14 at 23:11

2

Package: mfpic
Changes:

Treats any pdflatex run as the first run, pretending figure files have not been created.

Has final option too: yes

edited Jan 30 '14 at 23:11

Dan

6,899

answered Mar 24 '12 at 20:25

yo'

51,322

score 2 · Answer 16 · answered Mar 25 '12 at 18:21

package: thumbs

Changes:

Option draft (not the default) sets the thumb mark width to 2 pt, thumb mark text colour to black and thumb mark background colour to grey (gray). Either do not use this option with the thumbs package at all, or use draft=false, or final, or final=true to get the original appearance of the thumb marks.

final option: yes

LadyGodiva2 · Answer 17 · 2022-07-14T01:58:48.493

1

Package: todonotes

Note: there are no changes while using draft or final unless changes are made to the todonotes package options.

option obeyDraft: will display the to do notes (only output the todos/todolist if in "draft mode")

Changes using final:

option obeyFinal: will not display the to do notes (suppress output of the todos/todolist if in "final mode")

edited Jul 14 '22 at 01:58

answered Feb 18 '20 at 20:47

LadyGodiva2

35

score 1 · Answer 18 · answered Feb 15 '21 at 08:43

Package: pstricks

While the package pstricks does not support the class option draft, it is possible to add this behaviour:

All pspicture environments will be replaced by white space. PSTricks commands will be ignored.

To do so use LaTeX's internal test for document class options \@ifclasswith (c.f. stackexchange question here):

\usepackage{pstricks}
\makeatletter
\@ifclasswith{article}{draft}{\PSTricksOff}{}
\makeatother

Change the article in line 3 to whatever class you have in use.

What does the draft mode change?

18 Answers18

Overview

Classes

Packages

Related questions:

Document classes

Related questions:

Linked

Related