TransWikia.com

What does the draft mode change?

TeX - LaTeX Asked on March 6, 2021

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 …

18 Answers

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)

  • microtype (disable all features)

  • 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)

Related questions:

Correct answer by Tobi on March 6, 2021

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

    overfull rule

Have final option too: yes

Related questions:

Answered by Tobi on March 6, 2021

Package: graphicx
Changes

  • Prints frames containing the file name instead of including the images

    draft final

Has final option too: yes

Answered by Tobi on March 6, 2021

Package: listings
Changes

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

    draft

    final

Has final option too: yes

Answered by Tobi on March 6, 2021

Package: microtype

  • All microtyping is disabled which may lead to different line breaking

    If the draft option is passed to the package, all micro-typographic extensions will be disabled, which may lead to different line, and hence page, breaks. The draft and final options may also be inherited from the class options; of course, you can override them in the package options. E. g., if you are using the class option draft to show any overfull boxes, you should load microtype with the final option.

Has final option: yes

Answered by egreg on March 6, 2021

Package: showkeys

  • draft is the default setting

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

Answered by yo' on March 6, 2021

Package: pdfpages
Changes

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

Has final option too: yes

Answered by yo' on March 6, 2021

Package: varioref
Changes:

  • Turn error messages into warnings.

Has final option: yes

Answered by yo' on March 6, 2021

Package: mfpic
Changes:

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

Has final option too: yes

Answered by yo' on March 6, 2021

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)

Answered by yo' on March 6, 2021

Package: hyperref

Changes:

  • Turns all hypertext options off

final option: yes

Answered by Speravir on March 6, 2021

Package: pdfcomment

  • Option draft is the default.

Changes with final option:

“PDF annotations will not be typeset and will not influence line breaking.”

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

Answered by Speravir on March 6, 2021

Package pgf (but not TikZ)

Changes:

  • All images will be replaced by empty rectangles.

final option: yes

Answered by Speravir on March 6, 2021

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

Answered by Stephen on March 6, 2021

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 by Speravir on March 6, 2021

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}

image of document

Has final option:

image of document in final mode

Answered by Nicola Talbot on March 6, 2021

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")

Answered by LadyGodiva2 on March 6, 2021

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.

Answered by fborchers on March 6, 2021

Add your own answers!

Ask a Question

Get help from others!

© 2024 TransWikia.com. All rights reserved. Sites we Love: PCI Database, UKBizDB, Menu Kuliner, Sharing RPP