Manual Letter
Manual Letter
Manual
Scrivener 2.0 for Mac OS X
Contents
7.4 Opening Existing Projects 38
7.5 Templates . . . . . . . . . . 38
7.6 Backing Up Your Work . 42
7.7 Working with Scrivener
for Windows . . . . . . . . . 45
ii
CONTENTS iii
1
http://www.harmless.de/cocoa.html
2
http://www.stone.com
3
http://www.omnigroup.com
4
http://mattgemmell.com/source/
5
http://andymatuschak.org
6
http://journler.com/
7
http://www.devon-technologies.com
8
http://www.positivespinmedia.com
9
http://www.bean-osx.com
v
vi ACKNOWLEDGEMENTS
for sharing various other code snippets from The redoubtable Douglas Davidson, Apple
his work on Bean. engineer and guru, for responding so help-
Brent Simmons—the OPML importer code fully to so many of my enquiries about the
is based on a class created by Brent Simmons intricacies of the Cocoa text system.
for NetNewswire (Copyright � c 2002, Brent Aki Inoue at Apple for advice about the word
Simmons). count code.
Shortcut Recorder is � c Contributors of Fletcher Penney, for contributing so much
10
ShortcutRecorder —thanks to Jesse Gros- time and effort in helping me get MultiMark-
jean for pointing me in the direction of this down implemented in Scrivener.
project. Everyone on the Cocoa-Dev list for their
Nathan Day—the PDF Services alias file is help and support, with special mention to
created using Nathan Day’s NDAlias class11 . Bill Cheeseman, Malcom Crawford, Max
Mark Onyschuk—help with the window flip- and Marcus at Blue Technologies (authors
ping code for the templates panel, which is of Ulysses), J. Nozzi at Bartas Technologies
based on his LIFlipEffect12 . (author of CopyWrite).
Kino—the Snapshot comparison tool was in- Stephen Kochan, author of Programming
spired in large part by Kino’s “Compare Doc- in Objective-C, for answering my questions
uments” macro for Nisus Writer Pro. when I was getting started.
Robert Warwick13 —the improvements to Many thanks to the developer of Index Card,
text table support are based on code Robert “DenVog”, who went out of his way to help
wrote for Stone Hill Invoicer. get syncing to work between Index Card and
Improved PDF anti-aliasing was provided by Scrivener.
a line of code from Skim14 .
Beta Testers
Too many to mention everyone, but a big thanks to all of you, especially those who
helped beta test during the early stages - your feedback led directly to the freeware
release of Scrivener Gold and a much enhanced Scrivener. Special mention to:
Alexandria Pallas-Weinbrecht, for all the help in testing Scrivener’s full screen mode
on a dual-monitor set up.
Ernesto Salcedo, for help with a bug in viewing webarchives.
And in the best Oscars-speech-style, thanks to Kurt Vonnegut for making me want
to write and my father for buying me a ZX Spectrum when I was a boy and thus
forever turning me into a geek.
10
http://code.google.com/p/shortcutrecorder/
11
http://homepage.mac.com/nathan_day/pages/source.xml
12
http://www.lorem.ca
13
http://www.codehackers.net
14
http://skim-app.sourceforge.net/
Part I
Introduction
1
Chapter 1
Philosophy
Most word processors and text editors aimed at writers assume the creative process
will take place in linear form; that is, they assume that the writer knows how his
or her work will begin, and will start at the beginning and continue through un-
til reaching the end. Planning and restructuring is therefore forced into a separate
workflow—the writer must either plan before beginning and keep track of hundreds
of different files using the computer, or face the laborious task of cutting and pasting
numerous chunks of text to restructure a long piece of work at the end. For shorter
pieces of writing, this is not a massive problem, but for longer texts—such as novels
or academic theses—the writer can often find him- or herself battling against the tools
of their trade.
Over the past few years, a number writing solutions have appeared, aimed at those
who don’t write in a linear fashion. All have pros and cons, and writers with vary-
ing styles of working fortunately now have a wider choice. Scrivener is one such
nonlinear tool. Scrivener was developed because no other writing environment quite
provided all of the features required for the sort of writing that demands easy access
to research, a quick overview of numerous documents and the easy restructuring of
swathes of text.
The main concepts of Scrivener can be summarised as follows:
❧ The software should allow the writer to use many of the formatting features
familiar to word processors—different fonts, italics, paragraph styles and so on.
It is up to the writer to avoid distractions, not the software.
❧ What looks good in print is not always the best way of viewing something on
the screen: the software should allow the user to completely reformat the text
on export or for printing without affecting the original (thus making it easy to
export a manuscript in a format suitable for an editor and then export it just as
easily in a format more suited to publishing on the internet).
❧ There should be a synopsis linked with each document, which can be viewed
with other synopses to get an overview of the project as a whole.
❧ Linked to the above, it should be easy to view the project as an outline and use
drag and drop to restructure the project. Moving between the outline and the
text itself should be fluid.
2
3
❧ The user should be able to view more than one document at the same time—for
instance, the end of one chapter alongside the beginning of the next, a character
sketch alongside a scene in which that character appears, or a research document
alongside the writing it is being used to support.
The overriding philosophy behind Scrivener was in part inspired by a passage writ-
ten by the author Hilary Mantel, in a collection of essays by writers on the process of
writing entitled The Agony and the Ego. Hilary Mantel described a process of “grow-
ing a book, rather than writing one,” which can be summed up as follows:
1. During the first stage of writing, you might jot ideas down on index cards—
phrases, character names, scene ideas; any insight or glimpse.
2. When you have gathered a few index cards, you might pin them to a corkboard.
Other ideas build around them, and you might even write out a few paragraphs
and pin them behind the index card with which they are associated. At this
stage, the index cards have no particular order.
3. Eventually, you may begin to see an order emerging and repin the index cards
accordingly.
4. After you have gathered enough material, you might take all of your index
cards, sheets of paper and jottings and place them into a ring-binder. You are
still free to move everything around, but now you have a good idea of how
much work you have done and how much more work you have to do.
Scrivener is thus a nonlinear writing tool that provides the writer with all of the
features found in any text editor, along with the functionality for “growing” your
work organically within the program itself.
Chapter 2
4
2.1. TERMS AND CONVENTIONS 5
the What’s New (chapter 3) section, where new major features are briefly explained,
and a list of minor changes and features is provided as well. For a full description of
everything that has changed, as well as bug fixes, check out the Release Notes2 online.
The PDF and Scrivener project versions of this manual will always be the most
up-to-date.
❧ –:The Command key, or the Apple key, is the one located directly to the left
and right of your spacebar.
❧ : The Option key is also labelled the Alt key on some keyboards, depending
on which country you purchased your Mac from. Some laptops only have one
Option key on the left side.
❧ : Control is usually located to the left of the Option key. Some laptops only
have one Control key between the Option key and the Fn key.
❧ Fn: If you have a laptop, or a newer Apple keyboard, you might have a Function
key available. Scrivener tends to avoid this key since not everyone has one
available.
❧ : The Shift keys are rarely used by themselves in shortcuts, but are often used
on combination with other modifier keys.
the word ‘collection’ can be used to indicate a casual grouping of items, and not nec-
essarily a formal Collection.
Some of the names for various elements within Scrivener are customisable on a per
project basis, and how you name these things will impact much of the interface. A
good example is the Draft, a place where your manuscript in progress is built. This
can be called whatever you like, and what you name it will impact the names of menu
items that refer to it. In all cases, this documentation will refer to these malleable
elements by their default names.
In cases where file paths are printed, the UNIX convention of providing a short-
hand to describe your personal home folder will be used. An example might look
like:
~/Documents
What’s New
Scrivener 2 is a major revision, featuring comprehensive overhauls of the interface
to make it even more intuitive and easy to use. It includes a substantial list of long-
awaited new features, such as a better style system, non-linear collections of docu-
ments, free-form corkboards, better snapshot integration, and much more. We un-
derstand that you are a busy person, and while new software can be fun for some,
others just want to keep working in the ways they are used to. Scrivener 2 has been
designed so that the majority of the new features will not get in your way until you
want them. When you first start using version 2, you should be up and running in the
way you are accustomed with a minimal period of transition. When you do get the
time to explore the new features, they are easily accessible and we think you’ll find
they add valuable tools and methods to your writing process.
In addition to the list below, you might want to also check out the new preferences
(Appendix B) and menus (Appendix A).
3.0.2 Collections
Collections add tabs to your binder, giving you the ability to collect groups of doc-
uments together for whatever purpose you desire, without moving them from their
original position. It’s a bit like making groups of aliases, without all of the fuss. You
could create a tab to collect all of the sections have your editor has marked as being
too verbose, and remove them from the collection as you trim them down, or create
another tab to store all of the documents that still need citations. Build smart collec-
tions that automatically look for search terms every time you view the tab. For more
information, read Using Collections (section 8.4).
7
8 CHAPTER 3. WHAT’S NEW
3.0.3 Marginalia
Now you get a choice between in-line annotations and footnotes, or placing your
notes into a new panel located in the Inspector. This not only lets you place long
notes out of the way of the primary draft, it can also work as a bookmarking system.
Clicking on the notes in the Inspector column will automatically scroll your editor
to its linked position in the document. When using Edit Scrivenings, you can see all
of the notes for the collected document at once. Your old projects will use the in-
line system as they always have, but you can easily convert to the new system with a
single menu command, or vice-versa. For more information, read Annotations and
Footnotes (chapter 17).
for selecting modes have been refined to make it clearer that you are changing the way
you view a binder item and/or its children items.
will let you load it in an external editor that supports that file type. Unlike references,
these files will be stored with your project, turning it into a hub for all your file types.
Full Screen Backdrop: Now you can customise your full screen experience by
choosing images from your hard drive.
Improved Navigation: New keyboard shortcuts let you traverse the binder from
right within the editor session. No more switching back and forth between binder
and editor to select the next document.
Expanded Export Features: More of your work can now be saved when using the
Export feature. Include all of your Snapshots as well.
Multiple Project Notepads: Project notes can still be accessed in the inspector,
just like you are used to, but now you can also load them in a separate window which
has been designed to look like a tabbed notebook. Add new tabs to have multiple
notebooks, and these will be accessible from the inspector as well. Now you can have
both your document notes and project notes available at the same time.
Format Bar: The new format bar collects the most common formatting tools into
a single, compact space. No more hunting around in menus, or messing with font
palettes. The margin and tab stop ruler has been separated and simplified, so now
you can show only the tools you need rather than having to keep one large all-in-one
tool at the top of your editing window. The new format bar is slim, and stays out of
your way at the top of the editing session.
Chapter 4
4.1 Registering
4.1.1 The Trial Version
You can try out all of the features of Scrivener for 30 non-consecutive days without
having to pay or register. During that period, Scrivener will be fully functional. After
30 days of use, you will no longer be able to access Scrivener at all unless you register.
(Actually, Scrivener will allow you a single “grace” session after the 30 days so that you
can export all of your work. This way, if you have decided not to buy Scrivener but
forgot to export during the 30 days, you can still get your work out of the program.)
13
14 CHAPTER 4. INSTALLATION AND UPGRADING
SCRIVEN001-XXXX-XXXX-XXXX-XXXX-XXXX
Make sure that you keep this serial number, along with the exact name under which
you registered Scrivener (the “Serial Number Name”), in a safe place, as you will need
both to register Scrivener (remember that you may need to re-register at a later date,
too - for instance when installing Scrivener on a new computer, or re-installing after
wiping your hard drive for whatever reason - so it is very important to store this
information safely).
Updating large projects: When updating very large projects, be prepared to wait
a while for the process to complete. A good rule of thumb is how long it would
take to copy the project from one disk to another and then half again that time.
If your project is so large that it will take 20 minutes to copy, then you should be
prepared to wait at least a half hour for the project to update, as part of the update
process is creating a backup of the original. You will also want to keep this fact
16 CHAPTER 4. INSTALLATION AND UPGRADING
In some cases, you may need to keep a copy of 1.x installed. If you are working with
a colleague which has yet to upgrade to 2.0, you will want to make sure to not update
these collaborative projects, and use 1.x to interface with them until they upgrade. It
is perfectly safe to do so, but if you elect to keep a copy of Scrivener 1.x installed, you
will need to take the following items into consideration:
❧ .scriv files will open in Scrivener 2.0 by default. To open older projects in
Scrivener 1.x, you will need to drag these items onto the Scrivener 1.x icon
in the Dock, or use the File � Open... menu command from within Scrivener
1.x.
❧ So long as you have both versions installed, the Mac might get confused over the
clipping services, which can be used to clip information from other programs
into Scrivener. Once you have fully uninstalled the old version of Scrivener,
these clipping services should work just fine.
❧ It is safe to run both copies at once, as they both use different preference files.
❧ Scrivener’s manual has been entirely moved to PDF (what you are likely read-
ing). If you leave 1.x installed on your machine, the old Apple Help system
will still have entries listed for Scrivener, so if you use the Help menu’s search
field (in Snow Leopard) to look up a topic, it will return search results from the
wrong version’s help. Instead, load the PDF in your preferred viewer and use
the search tool there, to find a topic.
Chapter 5
Interface
The Scrivener interface has been carefully designed to cover a wide range of uses. At
its most minimal, the interface could look no more complicated than a basic word
processor like WordPad or TextEdit. In this section, we will go over some of the basic
interface elements that will be present in nearly every project you work in. Advanced
features will be gradually introduced in their own sections as they pertain to specific
areas of the writing process.
Most of the main interface sections (binder, editors, and Inspector) can be resized
within the window via the grab handles located at the bottom, or in the case of splits,
by dragging the divider line between them.
Each of these elements will now be explained in greater detail.
17
18 CHAPTER 5. INTERFACE
5.1.1 Toolbar
Scrivener has a customisable toolbar which includes many common functions, in-
cluding a project search tool. To adjust the icons available, or their appearance, use
the View � Customize Toolbar... menu item, or right-click anywhere in the toolbar
background area.
It is possible to hide the toolbar by clicking the clear, pill shaped button in the top-
right corner of the window, or by using the View � Hide Toolbar menu item. Note
that when the toolbar is hidden, you can still access project search via the Edit menu,
or – F, which will provide a pop-up window featuring the same controls available
as on the toolbar.
5.1. INTERFACE OVERVIEW 19
Draft The Draft folder is where you place all of the documents you want to include
in your final manuscript. As such, the Draft folder is unique in that it can only
hold text files and folders - it cannot hold image files, PDF files, QuickTime
media or web pages as other folders can. All of the writing you want to be part
of your finished work should be placed inside the Draft folder, in the order you
want it (which, of course, is easy to change by dragging and dropping). When
you are ready to export or print your manuscript, use File � Compile.... This
will combine all of the individual documents inside the Draft folder into one
long document, formatted as you specify. Each file you place inside the Draft
may represent a chapter, a scene, a paragraph or whatever you want.
Some templates will have renamed this folder to something else, but its function
remains the same.
Research The Research folder can hold any type of file supported by Scrivener (text,
image, media, web archive or PDF files). It provides a default place for non-text
files to be imported and stored (although you can create other root-level folders
for this purpose if you so wish).
Some templates will have renamed this folder to something else, but its function
remains the same.
Trash When you delete an item in the binder, it is not really deleted but just moved
to the Trash folder. You can drag items in the Trash folder back into the main
binder, but you cannot create new items inside the Trash. To empty the Trash,
select Empty Trash from the File menu. This will permanently delete all items
inside the Trash folder (and cannot be undone).
The Collection interface can be toggled on and off with the associated toolbar but-
ton, or the View � Collections � Show Collections menu item.
Collections and search results can also be dismissed by clicking the X button in the
footer bar for the Binder.
20 CHAPTER 5. INTERFACE
This allows you to view search results, save them for future use, or collect arbitrary
binder items from throughout your project. For more information on how to use the
Binder and Collections, see Navigating and Organising (chapter 9).
5.1.4 Editor
Scrivener has two identical editor panes which allow you to view two parts of the
same document or different documents entirely alongside one another. The editors
will look different depending on what sort of document you are displaying and which
mode you are in (scrivenings, corkboard, outliner, standard text editor, or media view
mode). The editors can be displayed alongside one another in a vertical or horizontal
split for referring between them, or you can just view one editor.
Above each editor pane is a “header bar”. This contains navigation buttons (the
arrows) which allow you to navigate backwards and forwards through the document
history. Next to the navigation buttons is the title of the document along with its
icon. Clicking on the icon will display a pop-up menu that collects together some
common editor menus. The entire header bar has three colour status modes:
❧ Plain grey is the default, and is what you will see unless you have split the view.
❧ Blue appears when you have split editors, and indicates the active editor.
❧ Mauve appears when the editor has been locked MAC:( – L), which inhibits
it from receiving binder clicks.
On the right side are two vertical arrows which allow you to navigate through the
binder in a flat list fashion. You can also use the keyboard shortcuts, – UpArrow
and – DownArrow. Using these navigation tools will also focus the binder on
what you are selecting.
On the far right of the header view is a button that controls the split. The icon in
the button will indicate the type of split that is available - horizontal, vertical or none
(close split). Option-clicking on this button will change the split type.
Clicking on this button when both editors are visible will cause the editor associ-
ated with that header view to take over and the other editor to close.
Below each editor pane is a “footer view”. This will change depending on the
type of document visible and the current editor mode. When a text document is
5.1. INTERFACE OVERVIEW 21
being viewed, for instance, it will display the word and character count along with a
pop-up button for changing the text scale and a button for setting document targets.
In scriptwriting mode, it will provide shortcuts for accessing various script entry
macros. Various types of multimedia, and PDF, will display their own appropriate
relevant information in the footer bar.
See Also:
❧ View Modes (section 5.2): for further information on the various group and
text view modes available.
❧ Viewing Media in the Editor (section 14.7): for details on how various read-only
media are displayed in the editor.
4. Snapshots
The lock icon at the end locks the inspector so that you can reference the material
in it even when switching to a different split.
The first three sub-panes include the synopsis card, and general meta-data in addi-
tion to their specialised information. These initial sections can be collapsed by click-
ing the disclosure arrow on the left side of the header bar for each. The two meta-data
sections are as follows:
22 CHAPTER 5. INTERFACE
Synopsis & Image The top frame can show either the synopsis for the binder item,
which is what also appears in the index card representation of the item in cork-
board view, among other places. Using the top drop-down menu, you can op-
tionally also attach an image to the item to represent it in Corkboard mode,
instead of a text synopsis.
General & Custom Meta-data The General pane of the inspector shows basic meta-
data for the current document. This includes the label and status (which can be
renamed), the modified and created date of the document (click on the arrows
to switch between the modified and created date) and checkboxes that affect
how (and whether) the document will appear as part of the compiled draft for
exporting or printing. Click on the header bar to switch between general and
custom-meta data, which can be set up for each project. For more information,
read Setting Up Meta-Data (chapter 10).
Notes, References, and Keywords all display the above meta-data boxes. They are
described as follows:
Notes Displays a notepad for the document. Each document has an auxiliary
notepad associated with it. Clicking the header bar of the notes area will bring
up a pop-up menu from which you can select “Document Notes” or “Project
Notes”, which are global to the project. If you have multiple project notepads,
you may see more than one option here in parenthesis. For more information,
read Document and Project Notes (subsection 18.4.1).
References The References table allows you to hold links to related material within
the project itself, elsewhere on your hard drive or on the internet. Click the
header bar to switch between document references and global project refer-
ences. Use the latter to make links available throughout the project. For more
information, read References (subsection 18.4.2).
Keywords Displays a list of keywords associated with the selected binder item. Key-
words can be used to tag your document. Use the + and - buttons to add and
remove keywords, or the gear menu to access the project’s central keyword list.
Read more about them in Keywords Pane (subsection 18.4.3) and Using Key-
words (subsection 10.1.4).
The last two sub-panes, Snapshots and Linked Notes, take up the entire Inspector.
Snapshots An integrated view which displays all of the document’s snapshots and
the contents of the selected snapshot in the text area below. Snapshots can be
created (from the state of the current text) or deleted with the + and - buttons
in the header bar. The Compare button will show changes between the selected
5.2. VIEW MODES 23
snapshot and the current text. The Roll Back button lets you revert to an older
version of the text. For more information on using this, see Snapshots Pane
(subsection 18.4.4), and Snapshots and Changes (subsection 3.0.8).
Linked Notes Words and phrases in the text editor can have notes attached to them.
The contents of the notes will be stored in this pane. New notes can be created
with the + button, or new footnotes with the +fn button. Selected notes can
be deleted with the - button. For more information, see Linked Notes Pane
(subsection 18.4.5), and Annotations and Footnotes (chapter 17).
to that file. This is a great way of expanding scenes and fleshing out rough ideas with-
out having to worry about whether or not something should be one type or another,
so take a moment to play around with the view mode buttons in the toolbar, or use
their corresponding shortcut keys to see how you can get the most out Scrivener’s
unique file and folder structure.
The default view mode will prefer whatever mode you have selected last. If you
choose Outliner, then this is the mode that all containers will default to when clicked
upon. It will remain this way until you manually change modes again.
The section on Project Planning (chapter 12) goes into greater detail on how to
use corkboard and outliner modes to their maximum power. The section on Editing
Multiple Documents (section 14.12) will cover the unique Scrivenings mode in detail.
5.2.1 Corkboard
Scrivener has made the corkboard metaphor popular in modern writing software.
The concept of representing many documents as index cards, letting you move them
around to restructure your book, or opening them up to edit their text, is quite
useful—but Scrivener 2 takes this even further. Now you are no longer constrained
to viewing index cards in columns and rows; you can use the new free-form mode
to move cards around as freely as you might on a desk or a real corkboard. Group
together cards that are related, but spread throughout your draft; spread things out
in a chronological order; the choice is yours. While you can choose to commit your
free-form ordering back into your draft, you can also feel free to just leave things as
they are, as an alternate way of viewing a section of your work.
The important thing to realise with the corkboard is that each of the displayed
index cards are actual files or folders in your binder outline. They display the title
and the synopsis (a short description of the item) on the cover, and optionally can
represent a few kinds of meta-data using real-world metaphors as well. Just remember,
cards are documents, and conversely documents can all be viewed as cards.
The corkboard view is rich with features, to read more about it and how to best
use it, see The Corkboard (section 12.1).
5.2.2 Outliner
While the binder is in a sense a very simple outliner, there are often times when you
need to view your book, or parts of it, in a much larger context and with a greater
degree of information at your disposal. The outliner view lets you see your book
structure in a standard outline format with indenting used to indicate depth. It also
has the ability to display many built-in aspects of your documents, from their label
colour, to word counts, modification dates, keywords, and much more, including
your own custom meta-data.
5.3. FULL SCREEN INTERFACE 25
Outliner is also a great view for making bulk changes to lots of documents at once.
Since it provides feedback for so many different aspects of your document it is easy to
see what has been changed at a glance.
Many people also like to brainstorm in the Outliner view as well, as it shows more
than one level of depth at once. Whether you prefer the analogue experience of the
corkboard, or the more literal but expanded information in the outliner is up to you.
As with the Corkboard, there are many features and usages for the Outliner. To
read more about it, see The Outliner (section 12.2).
5.2.3 Scrivenings
This is a unique view mode in that it works not with the viewed items themselves, but
specifically with their text. All of the text content (even empty documents) will be
stacked together as if on a long spool of paper, letting you read through large sections
of your book at once, no matter where they are located. As you make adjustments
to the text in this view, each of the corresponding documents will be updated as you
work. The overall effect is as if you were working in a single long document, but in
fact you are editing potentially dozens or even hundreds of files as you go.
Scrivenings view (frequently referred to as a “scrivenings session” and known to
Mac users of version 1.x as Edit Scrivenings), are temporary editing sessions. You
don’t need to worry about saving them, or what will happen if you click on some-
thing and they go away. It is merely a way of pulling together a number of files so
you can edit their text at once, and then releasing them when you move on.
For more information on how to best take advantage of this editing mode, see
Editing Multiple Documents (section 14.12). We will also explore a simple usage of it
in the following Quick Tour section.
Quick Tour
Before going over this section, it is suggested that you skim through the prior chapter,
introducing the interface, if you haven’t done so already.
This chapter will get you up and running with a simple sample project, and in-
troduce a few of the most basic concepts you’ll need in order to start working with
Scrivener. It is recommended that you eventually go through the full interactive tu-
torial in the Help menu, but if you are in a hurry, this guide should get you working
productively in thirty minutes or less. Scrivener is a complex program with a lot of
depth, but we hope this section will demonstrate that despite this, it is also a very
straightforward and intuitive, so its complexity can be gradually learned as required.
We will go over the following tasks:
❧ Navigating the binder and adding new documents to the draft outline
If you need to learn more than the above, we suggest that going through the full
tutorial would be best, which can be found in your Help menu.
26
6.1. PROJECT FORMAT 27
but you can choose to organise your projects on the computer however you like. It
is a good idea to choose a place you will remember. Even though Scrivener provides
convenience functions for finding the projects you’ve worked on most recently, and
will even reopen your last session for you if you choose, these tools should not be
relied upon as your sole reference point for of where projects exist.
Okay, enough theory. Let’s create a new project right now. Invoke the File � New
Project... menu command ( – N). You should see the template selection interface
(Figure 6.1). We’ll stick with the blank starter project for now, so simply click the
Choose... button in the bottom right, or just press Return. A sheet will come down
asking where you wish to save the file; feel free to choose a location you will remem-
ber (the default is your Documents folder, but you might wish to create a special
sub-folder just for Scrivener projects), and give the project a name. This name should
be considered an internal name; it won’t be printed on the final draft, and should
28 CHAPTER 6. QUICK TOUR
just be something that you’ll easily remember. Click the Okay button once you’ve
decided on a file name and location.
document is printed here (“Untitled” since we haven’t named it yet), and as well there
are also some buttons for moving around in your project and adjusting the editor
view, but we’ll get to that later. The important thing to notice right now is that the
Untitled document has been selected in the binder, and that this selection is being
viewed in the editor.
Below the editor text area is the Footer Bar which contains information about the
editor session, such as your current word and character count, and often contains
useful buttons for adjusting the view.
The cursor is blinking in the text editor, and with zero words so far, it’s time to get
to work!
while we are in the binder. Press the UpArrow once. Immediately, you should see the
words you just typed, re-appear in the editor. That is because you are now viewing
the first starter document.
To change the name, just press Esc and type in “Chapter One”, pressing Enter to
confirm the name change.
You might notice something going on with the icons (Figure 6.3). Document
“Chapter One” looks like a page of text, but “Chapter Two” just looks like a blank
sheet of paper. That’s because we haven’t typed anything into the editor for “Chapter
Two” yet. Scrivener lets you know which parts of your project are still placeholders.
For now, let’s use another method for adding new documents. When you are in
the binder, there is a simple way to add new ones below the current document. Select
“Chapter Two”, and just press Enter. Call this one “Wineries”.
Now let’s take a look at a great way to get an overview of your Draft. Either click
on “Draft” in the binder with your mouse, or simply press the LeftArrow to jump up
to it. When you view a folder in Scrivener, by default it will automatically switch to
showing you the corkboard in the editor area. You should see three index cards, one
for each of the items you’ve created (sometimes referred to as ‘Scrivenings’), but the
cards will be blank; this is because they display the synopsis for a document, not its
internal text. Double-click in the empty ruled text area on the “Wineries” card and
type in a short synopsis for this section of the book. When finished, pressed Enter to
confirm.
At this point, if you look in the binder you’ll see a third icon type that looks like
a small index card, next to “Wineries”. This new one indicates that you’ve typed in a
synopsis, but haven’t yet typed in any text for the section. Once you enter text into
the editor for the “Wineries” section, the icon will be replaced with the one you see
for “Chapter One”. Some people like to work in a top-down fashion, where they’ll
build a conceptual outline and then fill in what they intend for each section in the
6.3. OUTLINING YOUR DRAFT 31
synopsis. These three levels of icons give you an over-all idea of your level of progress
with this task.
We’ll try that now. Load the “Wineries” card by double-clicking on the icon next
to the name. If you can’t find the right spot, just click on it in the binder. Type in a
short sentence and observe that, as predicted, the icon has now changed to match the
“Chapter One” section.
You might be wondering how much text each section should hold. The answer is
largely up to you. With a word processor, it is often convenient to work in long doc-
uments because lots of small windows can create unmanageable clutter, but Scrivener
allows you to break things down into smaller pieces, since it organises all of these files
for you and keeps them in a logical order in the binder. In fact some people break
things down into pieces as small as paragraphs, but the size of these chunks of text are
entirely up to you. You can use index cards to represent beats, scenes, whole chap-
ters, or even a mix of these depending on how much attention you need to give that
portion of the book. It’s all very flexible, and in many ways you can use the Scrivener
outline to structure things according to how you think, not according to how the
book will appear.
Scrivener also contains features intended to make that balance a little easier to work
with. Unlike most applications of this type, you can choose to view many different
sections at once, and edit them as if they were a single file without actually merging
them all together permanently. Doing this is easy, let’s try it now. Select the Draft
item in the binder again, this time by clicking on it once with the mouse. You’ll get a
corkboard again, now invoke View � Scrivenings, or press – 1. You are now viewing
the collection of documents as a Scrivenings View, rather than a Corkboard View.
Each section will be divided with a horizontal rule, letting you know where one
ends and the next begins. Try clicking in the blank area between the two sections
you’ve already added text to, and keep an eye on the Header Bar, note the title changes
to let you know where you are, “Chapter Two”. Try adding some text to the second,
empty section, then select “Chapter Two” in the binder all by itself. Note that your
edits have been made directly to the document.
Now we will do something else that is impossible in many programs. Right-click
on “Chapter One” and select Convert to Folder. The icon will change to a blue folder
with a small page in the corner. That page means the folder has text stored in it, as
though it were a text file. The text you added to this document earlier is still there,
that’s what the small page icon means in the corner of the folder icon.
Let’s move that text into a new child document. If you haven’t clicked anything,
you should still be viewing its text. Switch to the editor, and select all text with –
A and then cut the selection with – X and note the folder icon loses its page icon
badge—it no longer has any text in it.
Press – N, which is another way to create new documents. The cursor will again
flip over to the Binder; call it “Scene A”, and click in the editor to start editing the
32 CHAPTER 6. QUICK TOUR
document. Then press – V to paste the text you cut. No doubt you can see that
Scrivener is very comfortable with the notion of splitting things up, and with this
feature you can feel free to work in small portions without losing sight of the big
picture.
Click on “Chapter One” again, and use the View � Corkboard menu item to return
to the Corkboard view. What you are looking at is the corkboard for the “Chapter
One” folder, which currently only contains one card, “Scene A”. Try clicking the
draft again in the binder. Now you are viewing the index cards that belong to the
draft again. “Scene A” has disappeared, because it is a child item of “Chapter One”.
The corkboard can only show you one layer of depth in your outline at once, but you
can tell when index cards are folders (or files that contain sub-items) by the stacked
appearance of their index card. Double-click on the “Chapter One” index card’s icon
and you’ll return to where you were at the start of this paragraph. You’ve navigated
“into” the “Chapter One” folder.
Hopefully by now you understand the relationship between index cards, the
binder, and the text within the items in the binder a bit better. Feel free to play
around with things a bit more if necessary, before proceeding to the next step. If you
want to import some text from an existing work in progress, you might find the Doc-
uments � Split � sub-menu to be quite useful in converting a long document into an
agile outline.
❧ From the “Format as” menu, select “Novel Standard Manuscript Format”
6.4. COMPILING THE DRAFT 33
That’s it. Click the Compile button, choose a name and location for your RTF file,
and once the dialogue box dismisses, open the file using the Finder. It should open
with your system’s default RTF editor. As you can see, all of the test lines you typed
in are there, separated by hash marks in between the sections as well, those came from
the Compiler too, as a part of the Novel preset. This can be turned off, or changed
entirely.
Let’s try one more thing. Switch back to Scrivener and open up the Compile sheet
again. Leave everything the same, but this time click the down arrow button which
appears to the right of the “Format As” drop-down menu. The full Compile interface
will appear, and with that, you’ll be able to see just how much power is available.
Feel free to explore the interface. Many of the options are self-explanatory, but if
you find yourself confused over something, read the chapter on Compiling the Draft
(chapter 24).
There is much more to learn, but if you are in the middle of a major project and
want to get started right away, you should now know enough to make a simple outline
and start writing content into that outline, and then compile this as a single draft
document. As you’ve seen from the amount of flexibility we’ve demonstrated, you
can rest easy on the topic of “doing things the right way from the start”. Unlike
many programs, Scrivener makes it easy to change your mind later on. Folders can
become files, items can be easily re-arranged, and so on; so don’t worry too much
about adhering to any proper ways of working. Scrivener has no standard except
for your standard, which will develop in time as you become more familiar with the
interface.
If you have a spare hour or two, it would be really beneficial to go through the
full interactive tutorial or watch the introductory videos1 available on the Scrivener
homepage. Together, they cover Scrivener’s features in much more detail and should
address most things you should know to get the best results in your work.
Further recommended reading:
1. Interface (chapter 5)
Preparation
34
6.4. COMPILING THE DRAFT 35
One of the principle goals of Scrivener is to be your first stop when a new major
project is embarked upon. The program therefore contains a variety of tools which
address the early phases of a writing project. These include: brainstorming, outlining,
collecting and organising research, gathering prose snippets, building background and
world-building information, and so on. Another Scrivener principle is that what
works best for your readers and even your editor might not work best for you as a
writer. As writers, we see the text in a different way, and we have different demands
on how we organise that text. A table of contents is great for a reader, but is it the
best tool for a writer? What if you could have your own table of contents, one that
evolved out of the structure of the work itself?
This section will cover the majority of the tools that you may use to accomplish
these goals. If your method of writing couples the process of writing with prepara-
tion, you might find it beneficial to read both this section and Writing (Part III). The
level of fuzziness between preparation and writing in Scrivener is very intentional,
because the same tools you use to build up initial structures and ideas will be the
backbone of your actual text. In Scrivener, there is no separation between outline
and book order. This seamless approach will help you get straight into the writing
phase.
The topics that will be covered in this part are:
❧ Project Management (chapter 7): Creating, saving, backing up, and managing
projects on the disk.
❧ Setting Up the Binder (chapter 8): Using the built-in sections of the binder,
managing collections, organising your work, and setting up document tem-
plates.
❧ Navigating and Organising (chapter 9): Optimise how you navigate within a
project.
❧ Gathering Material (chapter 11): How to collect material from other resources
and applications.
❧ Project Planning (chapter 12): How to rapidly capturing your ideas and give
them shape, shapes that will eventually become your manuscript.
❧ Cloud Integration and Sharing (chapter 13): Introduces tools for integrating
your project with various Internet services; and working in cross-platform sce-
narios between Mac OS X and the Windows operating systems.
Chapter 7
Project Management
As mentioned before, Scrivener is a project based application and stores your projects
as separate files on your computer. These project files are saved into your Documents
folder by default, though you can choose to organise these projects however you like,
even after you’ve created them. Some find it convenient to rely upon the File � Recent
Projects menu item to organise their projects, or simply just let Scrivener maintain
which projects are open whenever they start Scrivener for the day. These tools are
valuable, but shouldn’t be a substitute for good organisation on your computer.
The intended use of a project is to store everything relating to a single major work,
be it your next novel, screenplay for a film, a doctoral dissertation, or a serial col-
lection of articles for a magazine. This can be approached in a flexible manner. It is
possible to use a project as a daily journal, a collection of random things you intend
to one day utilise in future projects, and so forth.
Going a bit deeper, the project file is a cohesive folder of files (which will appear
as a single bundled package on a Mac) containing all of the pieces that make up your
project. The accessibility of this format is meant to be used as a last resort safe-guard,
not as a way to allow you to edit a project in places where Scrivener is not available.
36
7.2. CREATING A NEW PROJECT 37
the new one you created, and the old copy will be closed. This can be a useful tool
when you wish to experiment with a series of radical structural changes, or simply as
a way to leave a trail of history as you work.
Additionally, since Scrivener projects are just files on your system, you can use the
Finder to manage projects, create duplicates, and archive old versions. Always be
sure to close your projects before doing so.
Mac OS X Tip: If you cannot find a project, often it is often easy to locate it using
Spotlight and typing in the name of the project. If you cannot remember the name,
you can search for “.scriv” to find every Scrivener project that your computer has
indexed.
It is not possible to delete old or test-bed projects from within Scrivener. To remove
projects you no longer want, use the Finder.
7.5 Templates
Simply put, templates are ordinary projects which have had some basic structure and
settings added to them. In some other applications, templates are almost a way of
modifying the way the entire application behaves, but in Scrivener, it’s best to think
of them as starter projects. Many of them will come with a few example items added
to the binder, but these are meant to be helpful guides for laying out your book, not
forms that you have to fill out, or features that must be worked around. The items
added to templates are like any other items you’ve added to projects on your own.
They can be deleted, modified, duplicated, or set aside and ignored.
In fact, you can create your own templates for future use, which will be covered in
more detail in the following pages.
7.5. TEMPLATES 39
❧ Templates are just starter projects. With the exception of a few, and somewhat
technical, differences, there is nothing in a template generated project that is dif-
ferent from a blank project. In fact, a blank project is just another template that
is extremely minimal. Everything that you see in a template can be handled
just as you would handle any other items in the binder. They can be dupli-
cated, deleted, modified, turned into document templates, or what have you.
Scrivener templates do not provide you with “forms”, “wizards”, or parts of
the interface that you must fill out before proceeding. A sample chapter folder
with a header in it is just that, a folder with some rich text in it that is of a large
font size and bold. To change it, edit it as you would any other text. If you want
another one to make a second chapter, duplicate it. Scrap it if you don’t like the
style at all and want to design your own.
❧ When you use a new template for the first time, check the Meta-Data settings
( – ,) and make sure that everything is arrange the way you prefer.
❧ Some templates will change the name of the Draft and Research folders to some-
thing more appropriate. The novel template, for example, changes the Draft
name to Manuscript. Note that when the Draft has been renamed, all interface
elements that refer to it will have their labels updated.
❧ Custom labels & status: add the types of labels, preferred colours, and status
stamps that you find useful for your projects.
❧ Project references: try making a list of writing resources and research portals
that you often use.
40 CHAPTER 7. PROJECT MANAGEMENT
❧ Compile settings: since Compile settings are stored in the project preferences,
you can set these up so that your future projects will be ready for one-click
export (or close to it!)
The important concept to keep in mind is that, when it comes to the content of
what you can do with a project, a template is identical. There are a few differences
(most pertain to how it is loaded and the explanatory information and thumbnail
that can be saved with it) but for what will be saved, consider it no different than an
ordinary project.
Try not to worry about getting everything perfect the first time through. On
average, it will take at least half a dozen new projects before things start to settle
down. It is easy to updated existing templates with revised starting parameters by
simply naming them identically with the template you wish to update.
Once you have set everything up, use the File � Save as Template... menu item to
start the template creation process.
In the “Template Information” box, provide the following details:
Title The visible title of the template (what will appear beneath the thumbnail in the
template browser).
Description A brief description on what the template provides. You may not find
this useful for yourself, but if you intend to share the template with others, it is
a good idea to explain what the template is meant to provide.
The “Icon” box on the right gives you options for setting the appearance of the
template thumbnail. You can choose from a number of available presets, or if you
wish to make your thumbnail stand out from the built-in templates, you can click
the Save Icon as File... button, which will generate an image file for you, based on
the currently selected thumbnail. After you have edited this image in your favourite
image editor and saved it as a PNG file, you can use the drop-down menu to select
Custom... and choose the saved file from your computer.
After clicking OK, the template will be saved into the system, and you can either
go ahead and continue working in the new project you started setting up (it won’t be
associated with that template any longer), or close it safely.
7.5. TEMPLATES 41
Template Variables
In addition to the standard project elements you can include in a template, there are
a few variables that might be of interest to you, especially if you intend to share the
template with others. For example, if making a template for yourself, you could
just write in your name and address on the manuscript submission cover-page you
designed. This wouldn’t work so well if you wish to share the template, though.
Template variables let you place a special code in the place where text should occur,
and when the template is first loaded, it will consult the user’s address book for the
relevant information.
The template codes are:
Code Description
<$template_firstName> First name from address book
<$template_lastName> Last name
<$template_fullName> Combines the first and last name for you, or-
dering them according to system language pref-
erences.
<$template_street> Street address
<$template_city> City
<$template_ZIP> Postal code
<$template_country> Country
<$template_phoneNumber> Work number, if provided.
<$template_email> E-mail address
<$template_projectName> The name of the project from when it was cre-
ated. Note this will not include the “.scriv” por-
tion on the end.
If you wish to edit a template which has had template variables used (such as many
of the built-in templates), then follow these instructions:
3. Hold down the option key, and click on the Choose... button
4. You can let go of the option key and give the project a name
This will inhibit the substitution of these tokens for their address book equivalents,
allowing you to edit the template file, and then update it.
42 CHAPTER 7. PROJECT MANAGEMENT
Updating Templates
To update a template which has already been saved, follow the above instructions
to safely open it without substitute variables, make the changes you wish, and then
repeat the instructions for creating a new template. When you access the Save as
Template... sheet, you will note that all of the information from the template will be
provided, so you do not have to worry about replicating this information every single
time. If you do not need to make any changes here, just click the OK button and then
Yes to confirm that you wish to update the existing template.
Note that after you have created a project from a template (even when holding
down the option key to click on the Choose... button), the project will have no
further connection with that template. So if you have created a project purely to
update a template, there is no need to keep the project around after that point, and
allowing the project to auto-save will not automatically update the template, you must
follow the template creation procedure in full.
Built-in templates cannot be overwritten. However you can open them for editing,
and then save your modifications as a new template by giving it a new name.
This location can be changed in preferences, and could even be set to save into
a synced folder over the Internet. Also by default, projects will be zip archived to
save space and protect the internal files, and Scrivener will rotate the files (delete old
backups) to keep the maximum for each project under 25 backups. In most cases,
the more automatic functions you activate here, the slower things will get. Finding a
balance between frequent backups and usable settings will be up to you.
In cases where security is a concern (if you are working with confidential files in
protected area for example) the automated backup system might present a security
risk if it produces files in an unencrypted area of your hard drive. If you are work-
ing in an encrypted environment, make sure the backup location is set to also output
to that area, or use the File � Back Up � Exclude From Automatic Backups menu com-
mand to restrict the sensitive file from getting backed up with the rest.
Read about the various options available in the section on the Backup tab (sec-
tion B.10) in Scrivener’s preferences.
will follow any relevant options that have been set in preferences, such as how many
to keep, where to store them, and how many to keep around.
Frequent use of this feature will help safeguard your work in progress, and it is
recommended that you start forming a habit of making backups whenever a decent
amount of work has been committed to the project.
1. Time Machine can be set to run manually at any time of your choosing, using
the menu status icon in the upper-right hand portion of your display. You can
thus control when Time Machine makes a backup of your projects, making sure
they are closed first.
2. As Time Machine starts to erase hourly backups that are old, it saves only the
last backups made in a single day. In conjunction with the first tip, you can
make certain that your “safe” backups are retained once Time Machine starts
erasing old backups, by always running Time Machine manually at the end of
every day.
3. Always use Apple’s Time Machine interface to restore projects. The way they
are stored on the backup disk means they are in actuality held at scattered loca-
tions throughout the disk. It only saves the parts of a project that have changed
to save space. Copying a .scriv file out of the backup disk will hardly ever re-
sult in a valid project file. Apple’s Time Machine tool will always re-assemble
a complete version of your project by building it together from hundreds of
individual backups.
Going the extra mile: Time Machine is a wonderful tool for what it does, but
it shouldn’t be used as your sole backup for two important reasons. First, being
attached to your computer at all times, it is thus susceptible to the same risks of
7.7. WORKING WITH SCRIVENER FOR WINDOWS 45
damage and loss due to theft or catastrophe. Second, no backup system should
be considered infallible, and thus you should have more than one method. Time
Machine isn’t perfect; don’t let it be your single safety net.
The Scrivener 2.0 project format is fully compatible with its Windows companion.
No conversion is necessary, and both versions can work off of the same source file
(at different times; no project should ever be opened more than once). The primary
difference in appearance between the two platforms is that Windows does not have
a “package” or “bundle” format like the Mac does. Thus, the Scrivener project will
appear in its ordinary state, which is a folder. This is invisible to you as a Mac user,
but in fact there is no difference between the two.
To open a project on the Mac, you need only double-click the “MyProject.scriv”
file, or open it from within Scrivener. On Windows this will be a folder, so you will
need to descend into the “MyProject.scriv” folder and select (or double-click on) the
“MyProject.scrivx” file that you will find at the top level within that folder.
To transfer projects between computers, always make sure to copy the entire
“MyProject.scriv” folder from Windows, not just the .scrivx file by itself. The en-
tire folder is your project, and once it is on the Mac it will go back to looking like a
regular file.
Chapter 8
46
8.1. HOW THE BINDER IS ORGANISED 47
may have parts and chapters, or you may have separate files for each scene within each
chapter, or even separate files for each individual paragraph if you so wish. Everything
that goes inside the Draft folder will be compiled into one long text file when you use
Compile Draft from the File menu (excepting documents that have their “Include in
Draft” setting unchecked). Thus, the Draft folder is central to Scrivener: ultimately,
you are aiming to complete and arrange everything inside the Draft folder so that
each of the elements it contains form an organic whole that can then be output as
a single manuscript file. Because the Draft folder is what is used to create the final
manuscript, it is unique in that it can only contain text and folder files.
With the folder still selected, click the currently selected view icon (Corkboard is
the default) in the main toolbar, and you should get a blank view that looks suspicious
like an empty text document. In fact, that’s precisely what it is. Type in some text
and see what happens. Note that in the binder, the Folder icon has changed, and now
sports what looks like a little page of paper in its corner. This means the folder itself
has text associated with it.
Let’s try something a little more radical. Right-click on the Folder in the binder
and select “Convert to File”. It should change to a stack of papers with words on
them. Delete the line you wrote in that item and it will turn into a stack of paper
with an empty page in front. Go ahead and right-click and select “Convert to Folder”.
Nothing fundamental changed here. You didn’t lose any information, the only thing
that changed is the underlying type of the item, which is really primarily a visual
change. When an item has other items beneath it, but it is a file, it is often referred
to as a document stack, or a file group, but fundamentally it can act just like a folder
does.
Let’s test that theory. Select one of your files in the binder. You should see the
text in that file as you always do. But let’s do the same thing we did earlier with the
Folder, click on the corkboard icon. It will be empty, but you are now looking at
the corkboard for that file. With the focus in the Corkboard, press – N to make
a new document. An index card should appear, just as if you were adding items to
a folder. In the binder, you’ll notice that the icon for this file has changed to the
aforementioned stack of paper.
Perhaps you can better see why it is a good idea to think of the binder as an outliner,
instead of a glorified Finder. What is all of this flexibility good for? You don’t have to
be thinking in terms of constrictive structural elements as you flesh out the skeleton
for your book. You can just add items as you go, building out new corkboards, and
changing things to folders or back to files once a structure begins to emerge.
Scrivener lets you work the way you find most comfortable. There is no need to
build out a strict outline if you’ve always worked text-first, but if you like to work
in outlines, or use the snowflake model of expansion, you can accomplish these with
ease. An outline can literally emerge out of your book, or the book can be built onto
an outline. It’s all up to you and how you work best.
In Scrivener, the concept of a Folder is fluid. It’s an important concept to grasp, be-
cause organising your book will inevitably mean a hierarchy of documents, and wher-
ever that hierarchy takes you it will take so in the form of folders, or their cousins,
the document stack. The concept of hierarchy is important, because it means you
can keep the parts of the book you aren’t currently working on tucked away, and
that means you can feel free to break things down as far as you want, no matter how
many hundreds of items you make in the binder, if you sort things into folders (or file
groups!) you can always keep the clutter at bay.
50 CHAPTER 8. SETTING UP THE BINDER
Reveal and Hide All View � Outline � Expand All and Collapse All will disclose or
reveal the entire outline at once.
Expand All can be accomplished with –9
Collapse All with – 0. Both of these commands work in many areas of the
interface where it is possible to disclose items.
Hoisting Focus on one area of the binder by selection a container and choosing Doc-
uments � Hoist Binder.
Documents � Unhoist Binder will return the binder to its full display.
Drag and Drop Items can be moved around in the binder with drag and drop. Sim-
ple pick up the item by clicking and holding on it, then drag it to where you
wish to move it. The binder will display a target preview showing where the
drop will result.
Holding down the Option key while dragging will inhibit the “Drop on” fea-
ture, making it easier to move siblings amongst one another.
Moving items with the keyboard – ArrowKeys can be used to move an item
around in the binder. Up and down will increase or decrease its placement
in the outline, while left and right will promote and demote the item.
Locking the editor Any editor can be locked with View � Editor � Lock in Place, or
– L. The header bar for the editor will be changed to a dusty red colour.
Either or both splits can be locked independently.
An alternate behaviour can be set in the Navigations preference pane (sec-
tion B.5), “Binder selection affects other editor when focussed editor is locked”.
Ordinarily if the editor split you have active is locked, nothing will happen
when you click on things in the binder. With this option enabled, the binder
click will be loaded in the opposing editor split if one is already open.
Binder Affects. . . The View � Binder Affects � sub-menu contains several choices
from which you can cause the standard behaviour to become locked rather than
dynamic. For example, if you have a left and right split, ordinarily when you
click in the binder what you click on will be loaded in the active split. If Binder
Affects Left Editor has been enabled, however, all clicks will be sent to the left
split no matter which is active. The precise contents of this menu will alter,
depending upon whether you are using a vertical or horizontal split.
Alternately, the “Other Editor” choice will cause the binder click to always
act in opposition to its normal behaviour, loading the binder click in whatever
editor is not currently active.
When binder clicks are being diverted, a small indicator will appear in the
binder sidebar header, to the left of the title. This iconic depiction will use
a darker shade of grey to indicate where future binder clicks will go. This in-
dicator will be removed when operating in the default behaviour, and so its
presence is not only useful to determine where a click will go, but that clicks
will not be functionally normally in the first place.
To reset the binder behaviour to default, use View � Binder Affects � Current Ed-
itor.
See also:
52 CHAPTER 8. SETTING UP THE BINDER
❧ Splitting the Editor (section 14.8) for further documentation on how to use
editor splits.
❧ Experiment with an alternate scene flow without disrupting the original layout
❧ Designate items which you wish to share with another author using one of the
various syncing methods
❧ Create a special compile group with an alternate selection and order than a
typical compile of the draft
tab. The background colour of the sidebar and the header bar will help remind you
that you are not in the full Binder.
When first created, Collections will be assigned with an automatically generated
colour, but their tabs can be recoloured by double-clicking the rectangular colour
chip to the right of the label. Likewise, double-click on the title to change the name
of a collection. The Binder and Search Results tabs cannot be renamed.
The are three main types (excluding the Binder) of Collections:
1. Standard Collections: allows you to freely add and remove items as you work.
This is the most flexible form of Collection.
3. Saved Search Collections: indicated with the same magnifying glass used for
Search Results, on the left side of the label; they will be dynamically populated
with a search query).
54 CHAPTER 8. SETTING UP THE BINDER
❧ With the tab interface revealed, use drag and drop from any view including the
binder. If you hold over the target tab for a moment, Scrivener will switch to
the tab allowing you to drop the items precisely where you want to place them
in the list.
❧ In the binder sidebar, you can right-click on an item(s) to access this same “Add
to Collection” menu.
In all cases, if an item already exists in the collection it will not be added again,
and its original position will not be changed, so it is safe to err on the side of “over-
selection”.
Removing items by selecting them, and then clicking the - key (Figure 8.3) in the
lower title bar, or by simply pressing Delete on your keyboard.
Delete the entire Collection by first selecting the tab you wish to remove, and then
clicking the - key in the upper title bar.
8.4. USING COLLECTIONS 55
Items can be re-ordered within the list using click and drag, or the same –
ArrowKey combinations used in the Binder. Note that since there is no hierarchy
in a Collection, you will not be able to promote or demote items.
Where new items go: In Standard Collections, you may create new items using
all of the ordinary tools available for doing so. Since collections are uncoupled
from the Binder structure in every way, new items will be placed into folders with
names corresponding to the name of the collection they were created within. These
folders will be created at the top level of the binder, at the very bottom of the list.
An example might be a new text file called “Joseph” in the Characters collection.
When you return to the binder, you will find a new text file called “Joseph” in a
folder named “Characters (New)”.
Collections take advantage of the same view modes that containers do. Click the
coloured header bar title (not the tab) to view all of the contained items using the
default view mode. This can be used to view Scrivenings, Corkboard (freeform and
linear), or Outliner. You can also remove items from a Collection by deleting them
from these views.
If the Collection interface is hidden, the sidebar background will change to a ran-
dom, automatically generated colour, and the header bar title will adjust to the name
you provided. To leave the saved search, you can either click the close button in the
sidebar footer, or enable the Collection tab interface and select another tab.
Limitations: Searches performed using the Binder Selection Only option cannot
be saved for future use, because the binder selection is a temporary state which
changes whenever you click in the binder. If you find yourself unable to save a
search, make sure this option is disabled.
The contents of a saved search are dynamic. Every time the tab is loaded, the saved
criteria will be checked against the current state of the project. If you wish to “freeze”
a list for later reference, there are two ways you can do so:
1. Convert the saved search to a standard type: This will destroy the saved search,
so only use this method if you no longer need to the search criteria. To con-
vert a saved search result to a standard collection, View � Collection � Convert
to Standard Collection.
2. Copy the contents into a new collection: This is quite easy to do. Simply select
all of the items ( – A) in the search result, and click the + button to create a new
Standard Collection.
Saved Search Collections can be removed in the same fashion as Standard Collec-
tions, by selecting the tab and clicking the - key, as shown here (Figure 8.3)
See Also:
8.5. DOCUMENT TEMPLATES 57
indicate its status, and all of the items beneath it will have a small blue “T” badge
added to their icons.
To clear a document template container designation, use the Projects � Clear Tem-
plates Folder menu item. This action will not delete anything in your project. It will
merely remove the special status from the designated templates folder. Template fold-
ers can be placed (or designated) anywhere in the binder, even in the Draft (though do
note that if you do that, they will likely show up in the final manuscript, and toggling
them to be hidden would lead to generated items being hidden by default, as well).
Some of the built-in project templates will come with a template folder already set
up for you. To use your own templates folder, first clear the default setting using the
above menu item. Optionally, you could just remove the contents of the default, and
supply it with your own templates.
If you find yourself doing this often, you might wish to create your own project
template (subsection 7.5.2).
❧ If you select an entire group, it and all of its child items will be created in the
selected position.
❧ The first template item in the template folder is a special spot as it will be given
a keyboard shortcut, – N. Using this shortcut, you can easily create that
item on the fly, so if applicable, choose the top position for a template you will
be using most frequently.
❧ Both views have an Auto-Load feature, which when enabled, will load any se-
lected item(s) in the other split, if one is opened. The Auto-Load button1 is
located in the footer bar, and will appear blue when switched on.
1
nav-auto_load_button.png
Figure 9.1: The Auto-Load button will appear blue when activated.
60
9.2. GO TO MENU 61
9.2 Go To Menu
In most cases, it will be easiest to use the binder or views to select and navigate to
various components in your project. However there are a few cases where this will
not be true. If you prefer to work with the binder hidden, are working in Full Screen
mode, or just would rather not drill down to a particular spot solely to select an item,
the Go To menu is an easy substitute for other methods, and in some cases can even
be faster than traditional navigation. The Go To menu always takes action on the
activated split, even when it has been locked.
There are two locations where this menu appears:
❧ The main application menu, View � Go To.... The main application menu ver-
sion also provides three shortcuts for navigating within an editing session:
In both cases, both sub-folders and items can be selected. When a sub-folder is
selected, it will be loaded with the default view mode (Corkboard by default). The
header bar menu is provided as a convenience, and more readily applies the navigation
action to a particular split, whereas one must first ensure the right split is active before
using the application View menu.
Standard Mode In standard mode, the Go To menu will list every item in the binder,
organised in such a way that containers will be converted into sub-menus.
Go To is one of the menus which is modified by the list of favourite items in
the project. Favourites will be placed at the very top of the menu in a flat list,
allowing quick access to frequently visited areas of the Binder.
See also, Using Favourites (section 9.6).
62 CHAPTER 9. NAVIGATING AND ORGANISING
Scrivenings Mode When the active split contains a Scrivenings session, the Go To
menu will be transformed into a table of contents for that session, letting you
quickly jump to sections within the session. The main application Go To menu
will adhere likewise to this model, but if a split that is not in a Scrivenings
session is activated, the menu will return to presenting the entire binder. The
header bar menu will always show the contents of the current session for that
split.
Favourites will not be shown when the menu is modified in this way.
See also, Editing Multiple Documents (section 14.12).
In Full Screen To use the Go To menu in Full Screen mode, move the mouse to the
top of your screen for a moment. The application menu should drop down,
and you’ll be able to access the View menu.
header bar, or menu navigation commands. Locking is meant primarily to keep the
interface from taking actions that it would ordinarily take automatically. It will not
inhibit intentional actions that you make.
When the editor is locked, the header bar will change to a reddish colour, which
persists even when the split is not active.
❧ It is possible to drag more than one item into the text area at once. Select mul-
tiple items in the binder and drag them over as above. Links will be separated
one per line.
❧ Items can be dragged into the Notes Pane (and the Project Notes window) as
well as the main text area, in this fashion.
New Link ( – L) Brings up a sheet which gives you the option between creating a
new item and choosing where to place that item, or to navigate through a list
of items that already exist.
9.5. SCRIVENER LINKS 65
There are two tabs available in the sheet. The default tab, “Create New Linked
Document”, will let you generate a new document and attach it to an existing con-
tainer (or optionally, another item, forming a new container).
The “Destination” drop-down menu provides a list of all the containers in the
project binder. Use this to select where the new document should be created. By
default, it will select the Research folder for you. If you have unchecked “Only show
containers in destination list”, then the drop-down menu will display all items in the
binder, allowing you to form new containers by creating new items beneath existing
documents3 .
The “Title” field is where you type in the name of the new binder item which will
be created. It does not need to match the text of the link.
The “Link to Existing Document” tab will provide a browser with which you can
look for an existing binder item and link to it. Using this method is very similar to
right-clicking on the text and selecting an item from the Scrivener Link sub-menu,
and is mainly provided as a convenience for people using the – L shortcut to create
new links, or wiki linking, discussed below.
Suggestions If the selected text contains material that is found in existing binder item
titles, these matching titles will be added to the menu as well as suggestions.
This is handy when you have typed out the name of a Binder item, and wish to
create a link to it.
3
If this is hard to understand, I suggest reading Folders are Files are Folders (subsection 8.1.3).
66 CHAPTER 9. NAVIGATING AND ORGANISING
Favourites As with the Go To menu, Favourites will be added to the list. Consider
adding frequently linked to items as Favourites to make it easier to access them
in the future.
This section will not appear if no Favourites have been created.
Item List The remainder of the menu will be organised according to how your
project is laid out. Containers will be converted into sub-menus, allowing you
to navigate the project and select a link target (much as you would with the “Go
To” menu).
way to wipe out dozens of links at once, something which is of particular use when
pasting text from webarchive files, or other Scrivener documents with links.
Note that linked comments and footnotes will not be deleted with this command.
❧ Current Editor: The link will replace the current editing session with the
linked item. This method works most like a web browser, and like a web
browser you can use the forward and backward buttons to get back to where
you were, after following a link.
❧ Other Editor: Will use the other split to load the clicked link. If necessary,
Scrivener will open up a new split (section 14.8) for you, using the last used
split type (horizontal or vertical).
The colour appearance of links can also be adjusted in the Appearance tab (sec-
tion B.2).
1. Links which are solely the title of the document they link to.
3. A title prefix or suffix applied to the document level that contains the links.
This is a more advanced feature of Compile, but in essence it allows you to create a
list of document titles in the text which will be altered to match their final appearance
68 CHAPTER 9. NAVIGATING AND ORGANISING
in the compiled version. Since titles can be added to, or even entirely replaced, by the
compiler, this set of features will ensure that referenced titles will remain valid after
export. An applied example:
The original text reads:
To read more about this topic, see How to Grow Better Tomatoes .
With the above options configured correctly, Scrivener will recognise that this link
points to a title and that it should be updated to reflect the final version. It will be
compiled in the manuscript as:
The Table of Contents generator uses this trick to keep its list of documents up to
date with the final manuscript version of titles.
Pro Tip: If you link the special token, <$p>, to a particular document in the
Draft, the compiler will insert a special RTF code which lets compatible word
processors cross-reference the actual page number of that item. This technique is
also used in the Table of Contents generator, but could also be used for formatting
nicer cross-references for your readers. This feature will also be available when
using the Print/PDF format option in Compile.
See also:
The second menu which will have favourites added to it is the Scrivener Link cre-
ation menu. When creating a new Scrivener Link, your favourites will be placed at
the top of this menu.
Adding and removing items from the list of favourites is easy to do. Simply select
the item in the binder and right-click on it to view its contextual menu. At the bottom
of the menu, there will be two options:
❧ Remove from Favorites: Removes the selected document(s) from the favourite
list.
❧ Edit � Scrivener Link � : Creates text links to documents, like URLs in a web
browser.
Switching to a saved layout is easy. You can either double-click on the icon next to
its name, tap Enter, or click the Use button in the footer bar of the left list. Another
way of switching layouts is to use the application menu instead of the Layout panel.
When you save a layout, it will be added to the View � Layout � All Layouts � sub-
menu. Since these are assigned a menu command, you can supply custom keyboard
shortcuts for quick access to commonly used layouts.
To remove a layout you no longer need, select the layout and click the - button in
the footer bar. You will be warned that once it is deleted you’ll be unable to retrieve
it. This warning can be dismissed so that it no longer appears, if you wish.
To update an existing layout with the current project window layout, simply select
that layout in the list, and click on the gear menu in the footer bar, choosing Update
Selected Layout. A new screenshot will be taken and the old settings will be updated
to reflect the current window layout.
Layouts can also be exported and installed into Scrivener. Using the same gear
menu as above, select the layout you wish to export, and then choose Export Selected
Layout. The layout will be saved as an XML file in the location you provide.
Pro Tip: Layouts are saved to individual files on your hard disk, in your Library
folder, under “Application Support/Scrivener/Layouts”. If you wish to transfer
them to another computer or backup your layouts, you can find them here and
make copies of these files en masse.
Because layouts are separate from projects, there are some things that they cannot
save, such as which collection you are viewing, which QuickReference panels are
open, or whether the binder has been hoisted to a certain level. Even within one
individual project, these details might change or no longer be relevant. Here is a list
of things layouts do save:
❧ Binder visible/hidden
❧ Inspector visible/hidden
In addition, optional settings are saved depending upon whether these two check-
boxes are enabled for the specific layout.
Save outliner and corkboard settings All corkboard display settings, such as card
size, ratio, card wrapping, and so on will be saved with the layout
In the outliner, which columns are visible or hidden, and column sorting.
Preserve all meta-data appearance options This will save whether or not label tint-
ing is in use in the various areas of the interface; and pin, stamp, and keyword
chip visibility in the corkboard.
Chapter 10
Setting Up Meta-Data
Documents of any type in Scrivener can have various meta-data associated with them.
Some of this meta-data can be viewed in the corkboard, outliner views, and the Quick-
Reference panes, but the main interface for viewing and editing all of the meta-data
for a given document is the Inspector (chapter 18). This section will brief you on the
various types of meta-data available, and how to create more types if necessary. It will
not go into all of the details of the Inspector pane; please read that section to gain a
full understanding of how meta-data is assigned to documents.
2. Outliner: will be placed beneath the title (which appears in bold), by default.
3. Binder: revealed in the tooltip when hovering the mouse over the correspond-
ing title.
Instead of the text synopsis, you can elect to use an image to represent a document
on the corkboard. This image will be used on the corkboard and in the inspector,
but whatever text exists in the standard synopsis field will be used in the outliner and
binder as described above, and in the various export and print options that include a
synopsis field. The image is not a replacement for the synopsis, but an override for the
corkboard.
72
10.1. META-DATA TYPES 73
In all cases, specific types of meta-data can be displayed as columns in the Outliner
view, including custom meta-data.
depicted in the following ways, many of which are optional, and can be enable in the
View � Use Label Color In � sub-menu.
1. Corkboard: will be used to shade the upper right corner of the card when using
the rounded card theme. When using the classic card themes, the pin will be
coloured according to the label. Use View � Corkboard � Show Pins or – P to
toggle the visibility of pins.
2. Outliner: The outliner can be set to tint the background colour for each row
using the label colour with View � Use Label Color In � Outliner Rows.
3. QuickReference Panels: the label is one of the priority meta-data values always
visible at the top of the QuickReference panel for each document.
4. Binder: can be set to highlight the background of each binder item using the
label colour in a manner similar to the Finder. Toggle this behaviour with
View � Use Label Color In � Binder.
5. Icons: enabled with View � Use Label Color In � Icons, this option will tint doc-
ument icons wherever they appear.
6. Index Cards: enable with View � Use Label Color In � Index Cards this optional
method will tint the background colour of index cards wherever they appear.
The label can also be used to tint colour printouts when printing corkboards and
outliners.
1. Corkboard: can be displayed as a diagonal “stamp” across the face of the card.
The appearance of this can be adjusted in the corkboard and Appearance pref-
erence panes, and display can be toggled with View � Corkboard � Show Stamps
or – S.
2. QuickReference Panels: the status is one of the priority meta-data values always
visible at the top of the QuickReference panel, for each document.
10.1. META-DATA TYPES 75
Created Date The date and time the document was first created.
Modified Date The date and time the document was last changed and saved.
Page Break Before If this checkbox is ticked, a page break will be inserted before
the document when compiled. Useful, for instance, if the document marks the
beginning of a chapter. As with Include in Draft, this only has any meaning for
text documents inside the Draft folder.
Compile As-Is All options set in the formatting pane (section 24.5) will be ignored
for the checked document. This means no extra material will be added, includ-
ing titles, and no reformatting of the text will be done. Text will always be
included, even if it would otherwise be excluded. As with the above two items,
this checkbox has no meaning for items outside of the Draft.
Wrap Text Useful for fields where you want to display all of the entered text, even
if that text causes the row to expand in height in the outliner. Unwrapped
columns will only ever show the first line of text unless you edit the field.
Colored Text When checked, the colour selection tool at the bottom will be enabled,
allowing you to customise the text colour for this column. Text colour will be
displayed in the inspector and outliner columns.
As with label and status, fields can be re-ordered by dragging rows in the configu-
ration table.
Custom-meta usage is generally limited to the inspector and outliner, though it
can also be exported along with the rest of the meta-data when compiling, exporting
binder items, and printing.
2. File export: when exporting files from the Binder, meta-data can be placed into
optional “sidecar” plain-text files corresponding to the main document being
exported. This method is used to preserve the integrity of the original docu-
ment, and to enable meta-data export in formats which would not otherwise
allow text data to be inserted into it, such as QuickTime movies.
4. Drag and Drop: When dragging documents from one Scrivener project to an-
other, all meta-data will be preserved where applicable. In some cases, like labels
and status, these values will need to already exist in the target project.
already contained there, so that the HUD should always contain a complete list of
the keywords you are using in your project no matter how you have created them.
Keywords can be managed from the HUD. By changing the name of a keyword
in the HUD, all of the associated keywords in the project will be updated instantly
in the background. When removing keywords from the HUD, they will also be
removed from all of the documents they had been assigned to. To change the colour
that represents the keyword, double-click on the small colour rectangle to the left of
the keyword.
The HUD also provides an easy way to search for keyword usage in your project.
Simply click on the keyword you wish to look for, and click the Search button in
the bottom of the HUD. If you instead wish to search all text in the project for that
keyword (instead of just real keywords), hold down the Option key and click the
Search All button which will replace it.
You can also search for combinations (using the Boolean AND logic) of keywords
by selecting more than one keyword and then clicking Search. All documents con-
taining all selected keywords will be returned.
Chapter 11
Gathering Material
1. Drag and Drop. In the Finder, select the files you wish to import and then just
drag them straight into the binder in Scrivener. (Note that you cannot drag files
from the Finder into the corkboard or outliner, but only into the binder.)
2. The File � Import... sub-menu provides a number of handy methods for bring-
ing existing material into your project binder. In cases where the imported
material has some sort of innate or optionally defined structure, Scrivener will
attempt to convert that into outline hierarchy. Files and folders will be turned
into likewise in the binder, documents with split markings can be set up to cre-
ate many documents upon import, and MultiMarkdown files with their innate
header structure will be converted to outline hierarchy
The first time you import anything, you will be presented with an informative
sheet describing important information pertaining to the various limitations of the
import feature. If you do not wish to view this warning every time you import files,
be sure to check “Do not show this warning again”.
When importing text documents, they are internally converted to the RTF format
so that Scrivener can work with them easily (again, note that this has no effect on the
79
80 CHAPTER 11. GATHERING MATERIAL
original file in the Finder, only on the copy that is made inside the Scrivener project
during the import process). This can cause some loss of data for some file types (see
“Compatibility Issues” below).
When using the import menu items, material will be imported according to where
the current binder selection is set. If you have a line selected in the binder, the material
will be inserted between the selected line and the one below it. If more than one item
is selected, the last item (in top-down fashion) will be used as the insertion point. This
means that some forms of import will be disabled depending on where your selection
is. If your selection is in the Draft, you will be unable to import media of any kind;
if your selection is in the Trash, all import will be disabled. The only exception to
this is importing another Scrivener project, and importing from SimpleText.ws, both
of which ignore binder selection and create top-level folders at the bottom of your
binder.
When using drag and drop, the dropped material will be placed wherever the inser-
tion indicator in the binder shows. If you try to drag media into the Draft, the drop
will be prohibited until you move the mouse out of that folder.
❧ RTFD (rich text format directory) A proprietary Apple rich text format com-
monly used by Mac Cocoa applications.
❧ RTF (rich text format) The universal rich text standard; note that this is often
the best format to use for importing from word processors, as Scrivener can
import footnotes, comments and images from RTF files but not from DOC
files.
❧ DOC & DOCX (Microsoft Word format) As with TextEdit, Scrivener ignores
images, footnotes and comments in DOC files, so if you have these elements in
your documents and need them preserved when importing, re-save the file as
RTF in Word and import the .rtf file into Scrivener instead of the .doc file.
❧ TXT (plain text) Note that Scrivener tries to import all plain text files using
Unicode UTF8 encoding; this should be absolutely fine in most cases, but if a
plain text document gets imported as gibberish you may need to convert it to
UTF8 format using TextEdit before importing it into Scrivener. If all else fails,
use copy and paste.
❧ FDX (Final Draft format) Using the standard document format for Final Draft,
you can import scripts directly into any area of the Binder and have those im-
ported documents converted to Scrivener’s script formatting. Better yet, use the
11.1. FILE IMPORT 81
File � Import and Split command to automatically split an FDX file into smaller
documents, with the ability to select where splits occur.
As well as these text file types, Scrivener also supports all of the main image file
types (TIF, JPG, GIF, PNG, BMP etc), all of the main QuickTime formats (MOV,
MPG, WAV, MP3 etc), PDF files and HTML, HTM and .webarchive file types for
importing saved web pages.
1. Plain-text: when a plain-text file is selected you will be presented with a text
field. Type in the separator that was used in the text document to define sec-
tions. A common example might be a “#” character. Any line in the document
that contains only the text entered into this box will be removed from the file
and used to split the results in two. This process continues, further splitting the
work into subsequent binder items, until all of these lines have been processed.
11.2. SCRIVENER SERVICES 83
2. FDX: Final Draft files can be imported using this tool, and when they have been
selected the interface will change, giving you a selection of elements to choose
from. You can select any one element to split by, such as scene breaks. The
imported FDX file will be split into multiple binder items at these break points,
and the script formatting will be converted to Scrivener’s internal formatting.
In both cases, a portion of the first line in each sub-divided section will be used to
title the incoming items in the binder.
Services never show up: In some cases, you will need to log out of your account
and back in, after installing Scrivener for the system to properly register the ser-
vices.
Where the clipped text shows up will depend in part on the service chosen. In all
cases, the active project (the last project in use, even in Scrivener is in the background)
will be used as a target, and in some cases the active document or split will be used as
the target. In all cases, you must have at least one project open for services to work.
If you wish to collect text into Scrivener, but do not yet have a project created, you
can use the Scratch Pad (subsection B.1.4) instead.
Each method has an alternate form that will bring the selected text in unformatted.
This can be useful when clipping text from the web, which often has inappropriate
text colour and other formatting applied to it. All methods include an optional titling
prompt. If you supply a separator or title, this will be placed into the document sep-
arating it from whatever content already existed. When using the formatted services,
this title will be emboldened.
The following methods are available:
1. Append Text To: The contents of the selected note will be appended after any
existing text of the document you select in the project sub-menu. A list of your
entire binder will be arranged so you can easily select any text item. Note that
media files will not be listed since they can not have text appended to them.
2. Import as Sub-Document Of: A new document will be created beneath the se-
lected document. This sub-menu operates in a similar fashion to the above,
11.4. TEXT APPENDING TOOLS 85
though it will allow you to select any of the items in the binder since all types
can contain children. The name of the scratch pad note will be used to populate
the title field for the new document.
Since Scratch Pad does not store your notes in any projects, it uses ordinary RTFD
files, which by default will be stored in your Documents folder, under “Scrivener
Scratch Pad Notes”. These are ordinary files that you can edit with other programs,
or you can even make your own RTF files in this directory, making it possible to add
notes while Scrivener is not even open.
To change the location of where notes are stored, use the General preferences pane
(section B.1). You may also set up a system-wide shortcut that will make it possible to
toggle the visibility of this panel while in other applications. Scrivener must be open
for this to work.
Drag and Drop When working in the target document, and the source document is
visible in the binder, it will often be easiest to simple click and drag the docu-
ment you wish to append, into the area you wish the text to be dropped within
the current editor. As you drag the binder item into the editor, the cursor posi-
tion will move to indicate the drop point.
Best used when you want to combine an entire document into the current one
without switching to the source document first to copy the text or use the above
command.
If you wish to simply create a Scrivener Link (section 9.5) to a document, hold
down the Option key while dragging.
the source application, and when the print dialogue appears, use the PDF drop-down
menu to select the target application. When you first ran Scrivener, it installed the
necessary mechanism for this to work. You should see an option in that list to “Save
PDF to Scrivener”. The source application will assemble the print, save it as a PDF
file, and then transfer that file to your active project. Note that if this fails, you may
have accidentally attempted to import the PDF file into your draft folder. Make sure
another folder is selected before attempting to use this.
Chapter 12
Project Planning
87
88 CHAPTER 12. PROJECT PLANNING
Figure 12.1: A fully loaded index card using the rounded card theme.
6. The status stamp (diagonal text stamped across the middle; optional)
At its most minimal, you’ll only see the icon, title, and synopsis, the three core
elements that cannot be removed. By default, keyword indicators will be shown, all
other items must be enabled in the View � Corkboard � sub-menu.
The icon, as you might have guessed, correlates directly with the icon that is visible
in the binder. In most cases, this will be one of the variations of a folder or text icon,
depending on its content status, but in some cases it might be a custom icon if you
have supplied it with one, or if you are viewing a corkboard outside of the Draft, it
might be some kind of media file icon.
The title is simply what you would expect: it is an editable name of the item as
it appears in the binder, or in the header bar when you are editing it or view its
corkboard. The title is also used by the compiler if it has been set up to consider it,
but we’ll come back to that in a later section.
The synopsis is meant to be a brief encapsulation of what the document’s purpose
is, but beyond that you can use it for whatever you like. Some people use it to keep
track of the things they need yet to do, others keep notes about what they’ve written
so far, and some don’t even fill them in at all either just leaving them blank or letting
Scrivener automatically generate a synopsis from the first few lines of text. Whatever
12.1. THE CORKBOARD 89
you end up using them for, it is important to realise that they are separate from the
actual text of the document, and in most cases what you type into them will not
appear in the final book. Use this to your advantage.
To edit either the title or the synopsis on a card, double-click in the text field you
wish to edit. Once editing, you can use Tab and Tab to navigate between cards and
their two editable fields, much like you would in a spreadsheet.
Commit Order
Freeform mode can be useful for playing with an ordering idea without actually im-
pacting binder order. You might wish to see how a sequence of scenes looks without
actually changing the order and confusing things up in the binder. If you reach a point
where you feel you have an improvement, you can choose to commit the freeform or-
der back to the binder. Click the Commit Order button in the footer bar.
90 CHAPTER 12. PROJECT PLANNING
You will be given a few options to define your ordering style. Some work left to
right, other right to left; this panel will let you apply the ordering no matter which
way you work. Once you click the Okay buttton, nothing may appear to happen
unless you were paying attention to the binder. Committing the order will never
disrupt the cards position.
When using freeform corkboards for this purpose, you might find it useful to en-
able View � Corkboard � Show Card Numbers.
Size There are two ways of arranging index cards within a corkboard. The first is to
set the size of cards and then let the corkboard wrap the cards as they fit, the
second is to provide a number of cards you always want to see in each row, and
let the corkboard resize the cards to fit that number. When the latter method is
in use (see below, for setting that), the Size control will be disabled.
Ratio Determines the size ration between height and width. By default this will
be 3 x 5, in order to emulate the appearance of real index cards. If you write
12.1. THE CORKBOARD 91
very long or very short synopses however, you might find that adjusting this to
produce shorter or taller cards will be of benefit.
Spacing The amount of space that will be drawn between index cards, both vertically
and horizontally. To pack more cards into the display at once, move the slider
toward the left. To spread out the cards and make them more readable, move
the slider to the right.
This option is only available in linear corkboards.
Cards Across Set this to the number of cards you would like to appear in each row.
When this option is anything but “Auto”. Setting this option will disable the
Size slider.
This option is only available in linear corkboards.
Keyword chips Set the maximum number of keyword colours to be “taped” to the
left side of the index card. When a document has more than that amount as-
signed to it, all keywords below the specified point will be ignored. You may
wish to adjust the Ratio to increase the height of the index card, if you want to
view large numbers of keyword chips at once.
Size to fit editor This option is not available when “Cards Across” is set to Auto.
When the Cards Across option is set to a number, this option will resize
the cards to fit the current editor width, which was the default behaviour in
Scrivener version 1. With this option off, the card size option will be used, and
cards will be forced to wrap at the specified number regardless of the window
size.
This option is only available in linear corkboards.
Use small font The small font settings can be configured in the Corkboard prefer-
ences pane (section B.3). Note that since you have full control over this and the
standard index card fonts, “small fonts” might not actually be any smaller than
the regular font size.
Horizontal mode will place all of the cards within each container on a single row,
so you can easily view them sequentially. Vertical mode will do likewise, but reserv-
ing one column for each stacked container. There is no functional difference between
these modes save for aesthetics and how they use screen space. Both are useful for
tracking the precise flow of index cards between a large selection of containers. You
might, for instance, use it to compare how scenes in a novel are balanced between
chapters, but using the label or keyword colours to scan for POV and character ap-
pearance frequency, or plot threads.
An optional numbering scheme can be applied with View � Corkboard � Number
per Section combined with the above option to “Show Card Numbers”, this will start
counting from one for each container stack. When disabled, cards will be numbered
sequentially even across container sections.
You can expand or collapse the outline by clicking on the small arrow, or disclosure
arrow, to the left of the title. When viewing an outliner with only text documents,
you may not see any arrows. All items can be expanded completely with – 9. Con-
versely, all items can be completely closed with – 0. Additionally, you can hold
down the Option key and click on any arrow.
Most columns that allow you to edit their data will provide controls for doing so.
❧ Checkboxes: an example, “Page Break Before” will present a checkbox that you
can click to add a page break before that document when exporting. You can
impact many checkboxes at once by holding down the Option key and clicking
on a checkbox. All visible checkboxes will be impacted. This means if items
have been hidden with their disclosure arrows in the outliner, they will not be
impacted.
❧ Labels and Status will provide drop-down menus that you can use to adjust the
meta-data for a row. If you wish to impact more than one row at once, select
these rows first and then use right-click to access the contextual menu, instead
of clicking directly in the outliner.
❧ Columns with editable text, such as the Target column and custom-meta data
columns, will not provide a control, but you can simply double-click on the
field to change their value.
an outline built yet, there are no documents to put notes within. There are a num-
ber of ways you could approach this problem, such as keeping notes as documents in
the Research folder or somewhere else outside of the Draft. You might also find the
Project Notes tool to be useful, as it is highly accessible from everywhere in the in-
terface. Project notes, like document notes, are a rich text field. That means you can
format within them however you please, even drag pictures into them. Project notes
can have different styling than document notes, making it easy to tell which you are
currently viewing or editing. These can be set up in the Appearances preference pane
(section B.2).
Project Notes and Exporting: Project notes are not set up to be easily exported.
There is no way to compile them at all, without physically copying and pasting
their contents into a document. Document notes can be included in various com-
pile options, as well as printing options, but project notes cannot; nor can they be
exported via any menu commands. So use project notes only for things which are
strictly internal to the project. If you intend to export or compile notes at some
point, it might be easier to take the original suggestion of using documents in the
binder, in a special folder just for this sort of thing.
This can be adjusted in the Appearances preference pane. The text area is the same as
in the inspector, though since it is a window you can resize it easily to whatever size
you prefer.
See also: The Inspector (subsection 5.1.5).
Bulk Edits: Icons can be set to many items at once by selecting them all in the
binder, and right-clicking on them to choose Change Icon, or by using the Docu-
ments menu.
96 CHAPTER 12. PROJECT PLANNING
If you anticipate using a particular icon frequently, you might wish to make a docu-
ment template (subsection 8.5.3) for it, so that you do not have to constantly re-apply
icons to new files or folders.
What to do about strange results: After you click the Open button, what you see
in the icon manager is what you will see in the binder and other views. If the icon
looks “strange” to you in this window, then it will look strange everywhere. Com-
mon problems are files with lots of white or transparent padding around them.
Open these files in a graphics editor (even Preview will do for simple cropping)
and use the software to cut out the excess padding. You can remove a bad attempt
and add it again using the above instructions until it looks right.
Another common problem is a white background. This may or may not be obvi-
ous in the icon browser, but will look bad in the binder. Removing a white back-
ground is more difficult. If you lack the expertise to do so, try selecting another
icon that is similar, from a different source.
Many icon packs for the Mac are distributed as Finder icons. If you would like to
use an icon that you have seen in the Finder, the easiest way to create a custom icon
for it is to follow these steps:
3. Click once in the small icon in the upper-left corner. You will see a halo sur-
round it when it is properly selected
5. Open Preview.app and press – N to create a new file off of the clipboard
6. You will probably see several options to choose form in the sidebar, select the
smallest available option (Scrivener’s icons are only 16x16 pixels, so choosing a
large icon will actually result in less quality)
12.5. CUSTOM ICONS 97
7. Press – C once again to copy the single icon choice; and then –N to create
another new document from the clipboard
8. Now you can save this icon to your Desktop or some other convenient location.
It is best to use the PNG or TIFF format, leaving the “Alpha” box checked.
Optimum Icon Sizes: The “native” size of a Scrivener icon is 16x16 pixels, but
many of the built-in Scrivener icons are a few pixels smaller than that, to account
for a subtle shadow around them. Therefore if you want your custom icons to fit
in with the stock icons, it is best to size them a few pixels smaller than 16 pixels
square, but leave the graphic file that large; padding the extra space with transparent
pixels. For some types of icons, it will not be necessary to tweak the icon to fit in
like this, so you can easily leave it larger.
Icons can be dragged between the “Application Folder” section and the “Project
Package” section individually, or en masse. Icons in the lower list will be available to
all of your projects, past present and future. Icons in the top list will only be visible
to that project; however they can be duplicates of icons that are in the lower list. If
you’ve created an icon for a project, and later decide you’d like to use it everywhere,
you can simply drag and drop it into the Application Folder table. If you try to drag
an icon with an identical name from one list to another, you will be informed of the
collision, and confirmation will be required before it is replaced.
When Scrivener loads your project, it checks this location (which is printed below
the table in this sheet for your reference) for matching icon names, but before doing
so, it checks within the project package itself, first. This means any duplicate names
(not graphics) in the top list will override any names in the bottom list. This way,
you can set project overrides.
13.1 Simplenote
The Simplenote Sync wizard allows you to easily sync documents in your Scrivener
project with Simplenote, so that you can work on or create documents while on the
go using an iPad, iPhone, iPod Touch or the Simplenote web application.
To use this feature, you will need to create a Simplenote account by downloading
the Simplenote app to your iPad, iPod or iPhone.
98
13.1. SIMPLENOTE 99
documents again later, when you want to sync them. The information Scrivener
places on the first line is formatted like this:
Project keyword Along with your Simplenote login details, you must also enter a
project keyword if you have not already chosen one. This is used by Scrivener to
identify documents in Simplenote that are associated with the current project.
You should choose a keyword that is meaningful to the project, easy to remem-
ber, and that is unlikely to occur on the first line of documents in general. For
instance, you might use a wordsJammedTogether version of your project title,
such as “MyGreatNovel”.
projects have the same keyword, you could run into problems, with each trying to
sync the other’s documents in Simplenote.
The project keyword is also very useful for viewing notes in Simplenote, because
you can use it as a search term to filter Simplenote so that only documents from your
project are shown in its file list. In addition, Scrivener will add this project keyword
as a tag to each document, so you can view by tags to isolate notes corresponding to a
specific project.
Once you have entered your login details and ensured that a project keyword has
been supplied, click on Continue. You won’t be prompted for the project keyword
or login details next time you sync the project with Simplenote, but if you need to
changing anything you can return to this pane by clicking on the Change Settings
button in Step 1. Note that the project keyword is shown in the top right of the
wizard in steps 1 and 2.
Icon Meaning
Green check The document is up to date both in the project and on
the Simplenote servers—the version in the project is the
same as the version in Simplenote.
Up arrow The document will be uploaded. This indicates either
that the version of the document in the Scrivener project
is newer than the one in Simplenote or that it has not yet
been uploaded at all and is now selected for syncing.
Down arrow The document will be downloaded. This indicates that
there is a newer version of the document in Simplenote
which will be downloaded in order to update the version
in the project.
Green asterisk The document needs updating in Simplenote. This green
asterisk appears if you choose (by deselecting) not to sync
a document that exists on the Simplenote servers but
which has been edited in Scrivener since the last sync.
If you select to sync the document, the asterisk will turn
into a green “up” arrow to indicate that it will be up-
loaded.
Red asterisk The document needs updating in Scrivener. This red as-
terisk appears if you choose (by deselecting) not to sync a
document that has a newer version available on the Sim-
plenote servers. If you select to sync the document, the
asterisk will turn into a red “down” arrow to indicate that
it will be downloaded.
No icon The document is not selected for syncing and does not
exist on the Simplenote servers.
the new version of the text. This ensures that you can return to the earlier
version if something goes wrong with the sync process. It is therefore highly
recommended that you keep this ticked, as it provides a good degree of protec-
tion against losing work in cases where you have inadvertently made changes to
the documents both in Scrivener and in Simplenote between syncs.
Delete from Simplenote any project documents not selected for syncing When
ticked, Scrivener will delete from Simplenote any files that were previously
uploaded from this project that are no longer ticked for syncing. This is
recommended in order to avoid clutter and slowing down Simplenote.
Once you are happy with the documents selected for sync, click Continue.
Simplenote is a general purpose note-taking system, there may be many notes in your
Simplenote account that you do not wish to import, including notes belonging to
other Scrivener projects. This pane of the wizard therefore contains two lists.
The first list contains documents that seem to have been marked as belonging to
this project. These are documents that contain the project keyword (see above) on
the first line of the note enclosed in brackets, and which were not detected as already
belonging to the project. This makes it very easy to create a document in Simplenote
and mark it for importing into a particular Scrivener project: just write the document
title followed by the project keyword in brackets on the first line of the note, e.g:
MyNewNote (MyProjectKeyword)
--
that Scrivener thinks might have been deleted from the project but are still on the
server—such documents appear in this list but are coloured red and are not ticked.
These are documents that contain the project keyword on the first line and a docu-
ment ID in square brackets, but for which the ID does match any existing documents
in the project. If you see notes coloured red in this list, the most likely explanation
is that you synced them in the past but have since deleted them from the project.
If you leave them unticked and have “Delete from Simplenote notes marked for this
project but not selected for syncing” checked, then these notes will be removed from
the Simplenote servers too.
The second list contains all other Simplenote documents, and these are not ticked
by default.
The following options are available:
Import selected documents into At the top of the “Import” pane you can choose
the folder in the project into which imported documents should be placed (the
Research folder is used by default). Only show containers in destination list
limits the documents shown in the list to folders and containers; if unchecked,
you can choose to import documents as the subdocuments of any file in the
project. (If you are unsure, just leave it ticked.)
Delete from Simplenote notes marked for this project but not selected for syncing
When checked, any notes that appear in the “Notes marked for this project” list
that are not ticked for syncing will be removed from the Simplenote servers.
(Given that this could result in the deletion of the only copies of such notes,
you will be asked to confirm this deletion during sync.)
Once you are happy with the documents you have selected for synchronization
and import, click on Sync. You can choose Go Back at any point to make changes.
Before following these instructions, it might be a good idea to run one last sync
to make sure everything is up to date. Then, simply make sure the “Delete from
Simplenote notes marked for this project but not selected for syncing” is enabled in
Step 1 and Step 2, and then Click on any file checkbox currently enabled. This will
de-select everything and wipe out the related notes on Simplenote when you click the
Sync button. Note that nothing in the project will be impacted when you do this, it
will only clear out the associated notes on the Simplenote server.
1. The tag: “Scrivener”, which will make it easy to find all files associated with
any Scrivener project.
2. A tag corresponding to the project keyword you selected above, making it easy
to filter your note list in the Simplenote application by project.
You can also add new documents to the project from Simplenote by simply adding
the project keyword tag to that document. When using this method, you needn’t
supply the project keyword in parentheses after the title; Scrivener will add it for
you.
13.1.7 Limitations
Formatting Note that Simplenote, like most mobile note-taking solutions, can only
store plain text, so all formatting—bold, italics, line spacing and so forth—will
be stripped in the versions of documents stored in Simplenote. Thus, when
updating documents in a project with corresponding versions that have been
edited in Simplenote, the following formatting limitations apply.
with notes in it, the bracket notation will be retained so that you can man-
ually fix the formatting. A helpful tip to remember is that you can copy
and paste from snapshots.
❧ Inspector comments and footnotes will not be exported. If the retention
of this information is important to you, it is recommended you use inline
notation with plain-text. You can easily convert your notes to inline with
the Format � Convert tools.
Important Note: This feature is not intended for keeping two versions of the same
project in sync and should not be used in such a manner - you should never try to
sync two different projects with the same folder. Rather, this feature is intended
to allow you to edit or share project files with other applications or on other plat-
forms, and then to have any changes made to the shared files reflected in your
Scrivener project. It also cannot be used to perform structural or outline order
modifications, just simple text content modifications.
13.2.1 Setting it Up
To access the feature, select the menu item, File � Sync � with External Folder.... A sheet
will drop down in the active project with some basic settings.
13.2. SYNCHRONISED FOLDERS 107
The first thing you will need to do is select a new, empty folder which Scrivener
will take over and use for syncing files with this project from this point forward.
Click the Choose... button (1), and navigate to the location where your cloud service
keeps your computer synchronised. For DropBox users, this will be the DropBox
folder in your home directory. Keep in mind that the folder you create will need to
be dedicated to this Scrivener project, and so must be initially empty. When you sync
documents with this folder, Scrivener will create one or more of the following three
subdirectories to store the synced files:
❧ “Trashed Files” - stores documents that had been synced but have since been
removed from Scrivener, or which had some sort of conflict. You should occa-
sionally review these files and trash them if they are no longer required.
Do not select a folder which has already been used to synchronise another
Scrivener project! The only time you should choose an existing Scrivener sync folder
is if you are certain it is for the same project, and that you have total control over the
project (it isn’t being edited by anyone else with a copy of the project). It is safe to
transfer your Scrivener project from one computer to another, and then use the same
sync folder to share changes made on the second computer. While the project will
save your sync folder selection, the second computer might have a different address
to that spot and require you to reselect it. In that case, you will get a warning when
choosing the folder, but you can dismiss the warning and safely continue.
Using this feature in an attempt to merge projects, or to have more than one person
using a copy of the project, could result in lost data or confusing results. When in
doubt, always create a new folder.
This feature provides the following options:
Sync the contents of the Draft folder Enabled by default, the entire Draft folder
will be kept in sync with the folder when this is on.
Sync all other text documents in the project Keep the rest of the project up-to-
date with this option. Note it will only work with text files. Enabling this
option also activates the Import settings, below.
Sync only documents in collection If this is selected, only documents that are con-
tained in the collection specified in the pop-up list next to this checkbox will be
kept in sync with the folder. This essentially acts as a filter for the other two
above “Sync” options. For instance, if “Sync the contents of the Draft folder” is
selected but “Sync all other text documents” is not, and if this option is selected,
then only documents that are contained in the Draft folder and in the specified
collection will be synced.
Use file numbering By default, Scrivener will prefix each filename with a numeral
corresponding to its position in the binder. This will keep your files in the same
order as the binder, making them easier to find. Disabling this will remove the
number and the contents of the folder will be subject to ordinary alphanumeric
sorting based on the names of your binder items.
option, particularly when both items have been accidentally edited separately.
Since Scrivener cannot determine which is meant to be the most up-to-date
other than by the file modification date, having snapshots available will allow
you to review the specific changes and decide how to manage conflicts should
they occur.
Check for changes in external folder on project open Enabled by default. When
this project is opened, it will briefly scan the contents of the external sync folder
and alert you if there are any changes detected, offering you the ability to update
your project immediately.
The Import section allows you to choose where files that have been created in the
Notes folder outside of Scrivener will be imported. You can select a target container
(Research by default), or uncheck the “Only show containers” option to choose any
item to become a container for imported files. This section will be disabled if “Sync
all other text documents in the project” is turned off, above.
The Format section determines how the files will be created in the sync folder.
Because script writers might not want to use a script format for notes and research
documents, there are separate options for files stored in the Draft folder and other
files in the project. There are three file formats available, and depending on your
intended purpose, selecting the right option will be important:
❧ Rich Text (RTF) This provides the cleanest transfer of information. Most format-
ting will be retained, especially when used in conjunction with a word processor
that handles all of Scrivener’s RTF features, such as Word or Nisus Writer. This
is the best option for collaborating with other individuals who do not have ac-
cess to Scrivener, or for working in a multi-platform setting yourself. (Note
that all versions of Microsoft Word fully support the RTF format.)
❧ Plain text (TXT)Formatting will be stripped when using this option. The
resulting files will be standard, plain-text files in the UTF-8 format. If they
are edited outside of Scrivener, when synced back in, all custom formatting in
paragraphs that have been edited will be lost. Scrivener will protect those areas
of the files which have not been edited, wherever possible. Scrivener does its
best to retain as much formatting as possible when re-syncing, but if formatting
is as important to your workflow as synchronising, then you will either need to
find a solution that can take advantage of RTF files, or save formatting for the
final stages in your writing project.
❧ Final Draft (FDX) Those working with Final Draft and scriptwriting mode
should use this setting, as it will retain all special script formatting in a round-
trip.
110 CHAPTER 13. CLOUD INTEGRATION AND SHARING
Automatically convert plain text paragraph spacing When this option is engaged,
Scrivener will intelligently convert your documents’ paragraph spacing to bet-
ter suit the intended environment. Since Plain-text editors cannot display
pseudo-spacing between paragraphs, this option will insert a second carriage
return to help set them apart from one another. Upon import, these extra car-
riage returns will be removed for you.
Using Folder Sync with the iPad and iPhone: If you intend to use this feature
in integration with Dropbox and the iPad or iPhone, you should always use the
plain-text format. At the time of this writing, there are no Dropbox aware editors
on the iOS that can read RTF files.
Keep this setting turned off if you require a certain standard, one way or the other,
and do not want Scrivener to adjust things for you. In particular, those working
in the MultiMarkdown workflow require double-spaced paragraphs, and so will not
want Scrivener to remove these spacings upon import. Note that this option only
affects plain text (TXT) documents.
Additional settings which impact export and import can be found in the applica-
tion preferences, under Import & Export. If you prefer to work with inline annotations
and footnotes, make sure the default setting in this pane has been changed, otherwise
your RTF comments will all become Inspector comments after a sync cycle. For
further documentation on this pane, see Import & Export Preferences (section B.9).
13.2.2 Usage
After clicking the Sync button for the first time, Scrivener will export a copy of every
item according to the options above. If the export folder is located in an area where it
is accessible to other computers and mobile devices, you can log on to DropBox with
your external application and start browsing the files as soon as they finish uploading.
Note that folders in the Scrivener project will appear as ordinary files in the sync
folder, because Scrivener folders can contain text.
Scrivener will export all items associated with your manuscript into the Draft folder.
If you choose to export non-Draft files, everything else will be placed into the Notes
folder. If you intend to start editing these files immediately, it would be a good idea
to close your Scrivener project at that point. While Scrivener will make scrupulous
copies of everything it changes (unless you’ve disabled snapshot generation), it’s best
to work in an alternating pattern to reduce confusion between which file is the most
up to date.
In a collaboration environment, it may not be possible to wait until the other per-
son is finished. It is safe to work in both the project and the exported copies at once,
so long as changed files are looked over after syncing. In most cases Scrivener will
select the best option for you, but in cases where both you and your colleague have
13.2. SYNCHRONISED FOLDERS 111
changed the file in between syncs, you might need to resolve the differences using
Snapshots and the Compare feature. For more information on using Snapshots, see
the Snapshots Pane (subsection 18.4.4).
When performing a folder sync, only resources which have changed (either in the
project or on the disk) will be synchronised, to save time. In the case where project
binder items have been updated from the disk, a list of these changed items will be
presented to you upon completion. The list will not contain items which have only
changed on the disk. Use this tool to browse through the changed items and review
them with the Snapshot Compare feature. This interface is much like Project Search,
and can be dismissed by clicking the X button in the bottom corner of the binder
footer bar.
For those that want to dig a little deeper, this is really a Collection that will be
created and titled “Synced Documents”, with each changed project document added
to it. Every time sync needs to change project files, it will look for a Collection named
“Synced Documents”, and replace the contents of it with the results of the latest sync,
so if you wish to retain a list of changed files for future reference, change the name of
the Collection to something else.
New files can be created while you are away from your project. Simply name
them whatever you would like them to be called in the binder, and save them to
the Draft or Notes folder. Scrivener will import files created in the external Draft
folder into the project’s Draft folder, and files created in the external Notes folder
into the designated auxiliary container (Research by default), when you sync. Initially
they will be imported at the bottom of their respective containers, but once you sort
them to their proper location, they will sync from that point forward in an ordinary
fashion.
When you have returned to your computer and wish to integrate any of the changes
made, simply load the project in Scrivener. It will, by default, check for any changed
files and alert you that your project is out of date. If you have this option disabled, or
the project is already open, you can manually activate the sync panel again, using the
menu item, and click the Sync button. Moments later, your project will be updated
with all of your external changes.
❧ Alternate between external files and the project. This is a rule of thumb, not a
strict rule. Scrivener reads the modification date of each file, and uses the latest
one to determine which should be the binder copy. It does not examine the
contents of files. It is thus best to alternate between using the external files,
and the project folder, rather than working in both separately for a while, and
trying to merge them later.
112 CHAPTER 13. CLOUD INTEGRATION AND SHARING
❧ Never try to sync one project’s folder with another. Even if those two
projects originally came from the same identical project, over time there will
be differences in each project that you cannot see, and these differences will
lead to confusing results at the best, and a loss of data at the worst. A sync
folder is meant to allow you to work without Scrivener for a while, and then
come back later and update your project with those changes. If you try to break
this rule, you will be warned by a dialogue box.
❧ When working from multiple computers sharing the same sync folder, always make
sure your project file is the most current. It is perfectly safe to use the same project
to sync to a shared folder from multiple computers provided you are always
using the most recent version of the project and are not trying to bend the
feature to sync two different versions of the project (see above). You will receive
a warning dialogue the first time you try on each system, but in this one case it
can be ignored.
❧ Avoid editing the filename. The numeric value on the very end of the filename
enclosed in hyphens, such as “-78-” (the precise number will be different for
each item), is vital to keeping the file identifiable by the item it is linked with
in the project; damaging the number could produce unintended duplication, or
data loss in some cases3 .
❧ Session target goals will include synced changes. When updating project files with
external edits, the session target will be incremented by the amount of text that
has been added. If you wish to keep track of your session target separately, you
might wish to reset the counter after updating your project.
❧ If using mixed inspector comments and inline annotations: When using sync fold-
ers, it is best to use either all Inspector footnotes and comments, or all inline
annotations and footnotes, and set your Import & Export preferences accord-
ingly. In some rare cases, comments adjacent to annotations can result in one
of the notes getting lost, due to the limitations of the RTF format.
Dropbox and iOS: When using Dropbox with the iPad or iPhone, you can elect
to have documents stored on your device. Ordinarily, you need an active Internet
connection to view files, but when a file has been marked as a “Favorite” it will be
stored on your device for perusal at any time. Note that if you are using a third-
party editor to interface with Dropbox and allow remote editing, this trick will
3
You can safely edit the filename so long as the dashed number is untouched. When a file has been
edited in the sync folder, if the binder name portion of the filename is changed, the sync function will
update the binder with the new name. This is considered an advanced feature, however, to be used with
care. Note that changing the sequence number will have no effect on the binder order. Also note that
if all you changed is the filename, nothing will happen due to the way modification dates are stamped
on the filesystem. Advanced users could use the UNIX command, touch, to force an update.
13.2. SYNCHRONISED FOLDERS 113
not work, but many of these editors store their text files on your device as well,
and any changes made to them will be synced the next time you have an Internet
connexion.
If you are using this feature in conjunction with another author or editor, make
sure to communicate these ground rules with them where relevant. Since it is not
possible for Scrivener to guess at your intentions, good communication over where
new files should go, and what is being independently worked upon will be beneficial.
13.2.4 Limitations
RTF Format Limitations: When using the RTF export format, you can expect zero
to minimal loss of formatting information when used in conjunction with a good
word processor. There are a few features in Scrivener that have no comparison in
RTF, such as multi-colour annotations and comments, and Scrivener links, which
will be normalised or lost, respectively.
❧ Expect loss of some features when using RTF editors that do not fully support
the RTF specifications, such as TextEdit, Pages and similar. Footnotes, com-
ments, lists, images, and tables are the most common items which have limited
support. Using fully-featured word processors with good RTF support, such as
Word or Nisus Writer Pro will help you avoid this, and even be quite useful as
comments can be used to aid in the collaboration process.
❧ To avoid having inline notation become confused with standard text, Scrivener
will export inline annotations by wrapping them in square ([ and ]) brackets.
Inline footnotes will be similarly wrapped in curly braces ({ and }). However
since Scrivener only updates changed paragraphs, unless you edit a paragraph
with one of these types, no loss of notation should occur in the rest of the
document. In the case that you do edit a paragraph with notes in it, the bracket
notation will be retained so that you can manually fix the formatting. A helpful
tip to remember is that you can copy and paste from snapshots.
114 CHAPTER 13. CLOUD INTEGRATION AND SHARING
❧ Inline images will be stripped from documents that have been edited outside of
Scrivener.
13.3 SimpleText.ws
The SimpleText.ws service is very simple, and only supports one-way import access
to files which have been created with tools that support the SimpleText.ws4 environ-
ment.
The feature can be found in the File � Import � From SimpleText.wsmenu item (sub-
section 11.1.5).
3. Opening, editing and saving the .indexcard file in Index Card on the iPad.
4. Updating the Collection in Scrivener with any changes you have made.
Because syncing with Index Card relies on Dropbox, before you begin, you will
need to ensure that you have Dropbox installed on both your computer and your
4
http://www.simpletext.ws/
13.4. INDEX CARD FOR IPAD 115
iPad. (Dropbox is a service that allows you to sync files between different devices,
which has a free option.) You can download the desktop version of Dropbox5 .
The iPad version can be downloaded from the App Store.
You will of course also need Index Card6 installed on your iPad.
To add other documents to the your collection, you can just drag them from the
binder onto the collection tab.
Read Using Collections (section 8.4) for more information on collections.
The “Save As” panel will appear, and it should automatically point to the “Index-
Card” folder inside your Dropbox folder. Index Card creates the “IndexCard” sub-
folder in Dropbox whenever you sync, so if you haven’t saved any files from Index
Card yet, it may not exist. If it doesn’t, create it yourself—navigate to your Dropbox
folder, click on “New Folder”, and name the new folder “IndexCard” (with no space).
Choose a name for the .indexcard file (or use the default one that has been entered
automatically) and click on “Save”. At this point, an .indexcard file will be saved into
the Dropbox/IndexCard folder, and the sync sheet will close. You are now ready to
fire up your iPad and edit your index cards on the go.
2. In the Dropbox app, navigate to the .indexcard file you saved in the previous
step.
3. Select the .indexcard file so that it opens in the Dropbox preview pane. It will
open as an XML document (plain text with a lot of greater-than and less-than
symbols). We’re not worried about this, though.
4. Click on the “Open In” button in the top-right of Dropbox—you will be given
the option of opening the file in Index Card.
Click on “Index Card” to open the project in the Index Card app. You should now
be presented with the documents from your Scrivener collection as index cards on
Index Card’s own corkboard. The title of the Index Card project will be the title of
your Scrivener project with the name of the collection you synced in brackets.
You can now move the cards around, edit their titles and synopses, and create new
cards, just as you would in any Index Card project.
1. Click on the “Send” button in the top-right of the header bar in Index Card and
select “Share via Dropbox” from the list that appears.
13.4. INDEX CARD FOR IPAD 117
2. At this point, Index Card, detecting that the file already exists, may ask you
whether you wish to overwrite the existing file or save using a different file
name. Choose to overwrite the existing file.
3. Now, back in Scrivener, go to File � Sync � with Index Card for iPad... again.
The collection we chose to sync should already be selected for us in the pop-up
button.
4. This time, choose “Update Collection from Index Card File. . . ”, because we
want to update our project with the changes we made in Index Card.
5. The standard Open panel will appear, and the .indexcard file that you edited
should already be selected for you. If not, select it. Then click “Open”.
❧ Ctrl-click on the selection, select “Move To” from the contextual menu that ap-
pears, and then choose a folder into which to move the documents. When you
do so, the binder will reappear to show the documents in their new location.
❧ Drag the selected documents onto the “Binder” tab in the Collections pane and
hold them there. After a second, the collections list will disappear to be replaced
by the binder, and you can drag and drop the documents wherever you want to
place them.
118 CHAPTER 13. CLOUD INTEGRATION AND SHARING
Note that in both cases, the collection remains unaffected, and continues to exist
separately.
When you next want to take your work with you on the iPad, once more ensure
that the collection contains the documents you want to take, and go through the pro-
cess again, overwriting the old .indexcard file with one generated from your updated
collection.
Also note that Scrivener will warn you if you try to sync with an Index Card file
that was not created with the selected collection.
Part III
Writing
119
120 CHAPTER 13. CLOUD INTEGRATION AND SHARING
When it comes to the process of writing itself, nobody can tell you how it should be
done. Each author has their own methods, their own rituals, and their own favourite
tactics. Scrivener was designed to recognise that everyone is different, and as a result
the program features an extraordinarily amount of flexibility and interface power.
You will find workflows and tools for all manner of writing projects, from a doctoral
thesis, the next blockbuster screenplay, to a novel, to a collaborative scientific article,
to biographies, and much more. Because of this, you will find that there are many
features you just won’t need! That is fine, because Scrivener has also been designed to
keep these features out of your way unless you need them.
This section contains a few chapters which could be considered optional. In partic-
ular, screenwriting and bibliographies can be safely skipped unless your works require
these functions.
Everyone should read the first chapter on Writing and Editing, as this will intro-
duce the full power of the editor, and if you haven’t already done so, at least skim the
prior part on preparation. Vital concepts have been introduced there, and many of
the following chapters will build off of those concepts.
The topics that will be covered in this part are:
❧ Writing and Editing (chapter 14): Full documentation of the various editor
views, full screen, formatting, layout, and tools to enhance the editing and revi-
sion processes.
❧ Page View (chapter 15): An alternate writing environment that emulates the
printed page. Useful for workflows which revolve around page counts, or just as
an aesthetic way of watching your work build pages, instead of a single scrolling
view.
❧ Full Screen (chapter 16): Scrivener’s full screen feature. Wipe aside all distrac-
tions and just write!
❧ Annotations and Footnotes (chapter 17): Learn how to comment as you write
using either Scrivener’s exclusive in-line annotation tool, or linked comments.
Also covers footnotes/endnotes; marker highlighting; and revision pens.
❧ Inspector (chapter 18): All about the inspector, which displays document meta-
data, notation, references, and more.
❧ QuickReference (chapter 19): Taking QuickLook to the next level. Open items
in persistent, editable windows. When two splits aren’t enough, use QuickRef-
erences.
scriptwriting solution, and produce exports which will work seamlessly in in-
dustry standard applications, like Final Draft.
The text engine, and Mac OS X: Please note that because Scrivener uses the OS
X text system, its behaviour in this regard is defined by Apple. The way double-
and triple-clicking on text works, the occasional awkwardness of features such as
tables and bulleted lists, font changes and so forth, are all governed by the OS X text
system, which is programmed by Apple and is out of my hands. On the other hand,
this also means you get access to many sophisticated tools which would otherwise
take years to program.
122
14.2. EDITING BASICS 123
not a layout tool, but a tool for cutting the text that will become your book. Many
authors who have stricter formatting requirements, such as scriptwriters, will start
their projects in Scrivener, and end in a word processor or desktop publishing, or
some other specialised application.
You might be wondering if Scrivener offers a plain-text editing environment as
well. There is no plain text option, as Scrivener is a writer’s tool rather than a strict
text editor, and many of the tools that are made available to you for writing rely upon
rich text to function, such as highlight, annotating, and marking revisions. Even if
you do not require formatting, you will probably find the formatting tools useful in
the writing process, especially if you are compiling to plain-text, where they will all
be safely stripped out and invisible to the reader.
Someone writing a novel or short story could very well do the whole thing in
Scrivener, including the final print for submission and export to Word format for
sending an electronic copy. Other writers are likely to export from Scrivener and
then use an intermediary tool dedicated to the sort of formatting they require to
prepare the final draft. Scrivener concentrates on the drafting stage of a long text; it
is not intended to replace your word processor entirely.
When using MultiMarkdown to format your work, you will find that some for-
matting, such as inline images, footnotes, and so forth will be converted to MMD
markings during compile. Most formatting, however, will be stripped and thus can
be useful in an annotation setting.
❧ – UpArrow: Select from the caret position to the top of the editor.
❧ – DownArrow: Select from the caret position to the bottom of the editor.
❧ – MouseDrag: By holding down the Command key and selecting using the
mouse, you can select several areas of non-consecutive text.
❧ Split with Selection as Title: Splits the current document into two documents
using the current selected text as the title for the newly created document. The
selection will remain after splitting, making it easy to remove the redundant
2
If you have used version 1, you will want to note that the footer bar now counts word and charac-
ter counts for the active selection, whenever a selection is made in the editor. The old contextual menu
counter is available for scriptwriters, and others who have disabled the footer bar view.
14.2. EDITING BASICS 125
title text if necessary, or style it like a header. For more details on splitting doc-
uments, read Managing Documents with Split and Merge (subsection 14.3.2).
❧ Set Selected Text as Title: Sets the title of the current document to the text se-
lected in the editor.
❧ Add Selection to Auto-Complete List: Adds the selected text to the project’s
auto-complete list, which can be maintained with the Project � Auto-Complete
List... menu command. Read more about this feature in Auto-Completion (sec-
tion 14.10).
❧ Scrivener Link: Allows you to create a link to another document in the project
within the text. Read more about linking items together in Scrivener Links
(section 9.5).
❧ Text Color: Provides the text colour menu, from which you can select from
the built-in colours, or those custom colours you have saved into your colour
palette.
❧ Save As Picture. . . : Available if you have clicked on an inline image. Allows you
to save the image to disk. You can also drag images into the Binder.
❧ Scale Image. . . : Available if you have clicked on an inline image. Brings up the
image scaling panel. Read more about Inline Images, here (subsection 14.4.6)
Linked inline images (section 14.4.6) also provide the ability to edit the image in
your default image editing software, via Open in External Editor.
126 CHAPTER 14. WRITING AND EDITING
❧ Add Row Above/Below: Will insert a new table row of empty cells above or
below the row in which you right-clicked.
❧ Add Column Before/After: Inserts a new table column of empty cells to the left
or right of the column in which you right-clicked.
❧ Delete Row/Column: Will delete the entire row or column in which the cell
you right-clicked upon is located.
❧ Re-number List: In rare cases, especially when pasting lists from other word
processors like Word, list numbering will sometimes not register properly. Use
this command to attempt to repair these lists.
If you prefer to always work from a certain zoom setting, the default zoom level
for both standard editors and the full screen editor can be adjusted in the Editor
preference pane (section B.6), and the Full Screen preferences pane (section B.4), re-
spectively. Note that this setting will impact all new projects, or recently upgraded
projects, not projects that have already been created.
items until it runs out of material. The second tool, special for MultiMarkdown users,
is File � Import � MultiMarkdown File.... This tool will examine the incoming file for its
header structure, and not only split files between headers, but title them according to
those headers, and even reconstruct the hierarchy of the original document.
For most other cases, read on.
Documents � Split � at Selection ( – K) This will create a new document directly be-
low the current document in the outline. The new document will contain ev-
erything that follows the caret position, and this material will be removed from
the original document. It can be useful to think of splitting in terms of “above”
and “below” the selection. Everything above the caret (and also to the left if in
the middle of a line) will remain in the original document, while everything to
the right and below of the caret will be moved to the new document.
After splitting, you will be given the option to name the new document in the
Binder.
Documents � Split � with Selection as Title ( – K) This alternative method will only
appear when a range of text has been selected in the editor. This method works
identically as at Selection does, only the selected text will automatically become
the title of the new document. This text will remain selected after you split,
making it easy to remove it, or style it as a header.
Pro Tip: You might also find the ability to search by formatting (subsection 21.4.3)
to be of use as well, as often the places you will want to split the document will
coincide with headers. While the Find by Format panel is open, you can use the
Split with Selection as Title function without closing it, and then quickly go to the
next search result within the portion that has been split off. If you wish to use
keyboard shortcuts, this means you can alternate between using – K to split the
found text, and – G to skip to the next search result.
14.3. EDITING WITH SCRIVENER 129
When splitting documents, all meta-data will be carried over to both documents.
The only exception to this will be any snapshots. They will remain attached to the
original document (everything falling before the split point), and can thus be useful
in seeing what a document looked like before it was split up. It is thus a good idea to
set up any common meta-data before you start splitting up a document.
It is not possible to undo a split action, but you can use the Merge feature to effec-
tively undo any unwanted splits.
❧ If the view you are picking documents from is based on the outline order (such
the Binder, Outliner, or Corkboard3 ), then the merged document will retain
the original outline order.
❧ When using a Collection to select items, the collection order will be used to
established the structure of the merged document.
❧ Document A
❧ Document B
3
Note that for this purpose, a freeform corkboard is still considered to adhere to Outline Order, as
is depicted by the card number (View � Corkboard � Show Card Numbers) on the index cards.
If you wish to impose a new order based on the freeform spatial placement, make sure to use the
Commit Orderbutton (section 12.1.3), first, and then merge.
130 CHAPTER 14. WRITING AND EDITING
Both Document A and Document B are selected in the Binder, and Docu-
ments � Merge is invoked ( – M), producing the following single document (with
the bold items indicating material used from Document B):
❧ Document A
When merging, the main text will be combined according to the preferences you
have set in the General preferences pane (section B.1), under the Separators section.
Merged documents can be combined with a single line, a full empty line (useful in sit-
uations where plain-text is in use and paragraphs need to have an empty line between
them), or a custom separator, which allows you to type in any sequence of characters.
Note you can add carriage returns and tabs to this field by holding down the Option
key and typing in the special character.
Tab Stops Stops can be created by clicking on the line between the grey and num-
bered area, or by right-clicking in the grey area and choosing a type. Once
placed, they can be moved via click-and-drag, and the numerical value of its
position will be printed above the mouse pointer as you drag. These will be
depicted by type using icons. The various tab stop types available are:
❧ Left: This is the standard, default type. Text will be left-aligned, with the
first line indented to the position of the tab stop.
❧ Center: Text will be centre-aligned, using the position of the tab stop as
an anchor point; this can be anywhere on the line.
❧ Right: Will right-align text with the right-indent set to the point of the tab
stop.
❧ Decimal: Most often used for aligning rows of numbers, so that the system
decimal value is lined up vertically with everything before the decimal
being right-aligned, and any fractional values left-aligned.
Ruler Conversions: When working with units in Scrivener, keep in mind that its
ruler starts at margin zero instead of paper zero. Since Scrivener is, by and large,
not “aware” of paper settings and page layout, it counts its ruler settings from the
beginning of the text on the left end of the page, not the beginning of the paper
132 CHAPTER 14. WRITING AND EDITING
itself. This is in contrast to many word processors, which start measuring at the
paper left edge, and show the print margin buffer in the display of the page.
Consequently, to convert most standard measurements to useful values here, you
will need to factor in the standard amount of print margin. This becomes more
complex with Page View. If Page View settings precisely match the print-out, then
the rule can be used verbatim, but if the settings are artificial and for aesthetic
purposes only, the results can be erratic. If you require precise measurements on
the ruler, it is recommended you either conform your Page View settings to the
actual print-out, or use the standard editor with the above conversion. Optimally,
your formatting can be deferred and set in the compiler, where formatting and
paper dimensions can be operated upon on concert.
Using tab stops while writing is as simple as pressing the tab key to advance to the
next available stop. If there are no more tab stops available on that line, the system
will wrap around to the next line at the first tab stop. This allows you to enter tabular
information into a single line, without creating multiple paragraphs. To remove a tab
from the line, simply delete it as you would any other character. Tabs can be viewed
as symbols with Format � Options � Show Invisibles.
❧ The first drop-down menu lets you select from all of the available font families
on your system.
❧ The second menu provides the available variants available for that family. Note
that not all fonts come with a full complement of variants. If for some reason
14.4. FORMATTING TOOLS 133
you cannot change a selection of text to bold or italic, check this menu to make
sure that the current font supports these variants.
❧ The third menu provides a quick list of common font sizes. If you need a cus-
tom size that is not available on this list, use the Font Panel... item at the bottom
to access the standard OS X font palette (subsection 14.4.4).
The next three buttons (section 2 (Figure 14.2)) provide toggling shortcuts to the
most common text format tools, bold, italic, and underscore, respectively. When
the caret is in a range of text that matches the format style, the buttons will appear
activated.
The next portion in this section allows control of paragraph-level text alignment.
Paragraph-level alignment comes in three flavours:
❧ Centre Align
❧ Right Align
❧ Full Justification
In all cases, these adjust the entire paragraph. If you need multiple alignments on
a single line, you will need to add special alignment tab-stops to the standard ruler
( – R).
In the third section (Figure 14.2), the left colour selection drop-down will alter the
foreground text colour. Click the button once to set the selected text to the depicted
colour (black by default), or right-click to access further options. You can opt to strip
out all colour code from here, and at the very bottom of the menu (which may be
hidden if you have a lot of colour favourites added), access the standard colour palette.
For more information on using the colour palette, see Text Colour and Highlights
(section 17.4).
The second colour selection drop-down works in an identical fashion to the first,
but it sets the background highlight colour for the selected range. Click once to toggle
the current highlight (or use – H), or use right-click to access further options as
described above.
The final, fourth section (Figure 14.2) of the Format Bar accesses paragraph and
line spacing, lists, and favourite styles.
The line spacing drop-down provides some quick presets, but for more complex
multi-type spacing preferences, select the Spacing... item at the bottom of this menu.
The list tool provides most common Western list formats. For custom and interna-
tional formats, select the Other... menu item. Lists can be enumerated or bulleted in
134 CHAPTER 14. WRITING AND EDITING
a variety of methods. They will transform the current paragraph (even if empty) into
the first list item, and will continue generating new list lines until you enter a blank
line. While entering lists, it is possible to indent or outdent lists with Tab and Tab.
Finally, the Presets menu hooks into Scrivener’s formatting preset system. As
with Apple’s default system, it is important to note that these are format and ruler
“brushes”, not word processor stylesheets. They apply saved formats to the selected
text or the caret position, but once these have been applied they will not automati-
cally update later on if you change the preset. To read more about Scrivener’s style
system, see Formatting Presets (Styles) (subsection 14.4.3).
1. Paragraph style: This will save all of your ruler settings, as well as alignment
and line-spacing attributes, and anything else found in the Format � Text � sub-
menu.
2. Character attributes: This will save any format level adjustments, like bold,
underscore, kerning, or anything else found in the Format � Font � sub-menu.
These two types can be used exclusively, or combined into a single Preset, control-
ling all aspects of the text appearance, and both can optionally also apply font size and
font family information. The Preset menus will display small icons in blue, next to
each entry, indicating whether the style will impact one or both of these types when
applied to your text.
Applying Presets
The method of application will depend upon the type of preset. For character at-
tributes presets, you must select the text you wish to apply the preset to, just as you
would when using bold or italics. For paragraph style presets, the caret can be any-
where in the target paragraph and no selection need be made. Of course, if you wish
to change many paragraphs at once, using the selection tools will allow you to do so.
Note that whatever paragraphs the selection falls into will be impacted, even if they
are not fully selected.
14.4. FORMATTING TOOLS 135
Presets which contain both character and paragraph attributes will apply all stylings
to the entire paragraph, regardless of selection. If you wish to only apply font styles
to a portion of your paragraph, then you will need to create a character attribute
preset to do so. For example, if you saved the bold attribute into the paragraph and
character preset, the entire paragraph will be emboldened, regardless of the selection
you’ve made.
You may also, in addition to the menus, right-click on a selection and use the Apply
Formatting Preset � sub-menu to select an existing preset.
Modifying a Preset
Adjusting an existing preset is easy to do. If you want to make a minor modifica-
tion to a preset, the best way to do so is to apply the preset to some text and then
modify the styling of the text. With the caret still located in that text, use the For-
mat � Formatting � Redefine Preset from Selection � sub-menu to select the preset you
wish to modify.
You will be presented with the same sheet you used to create the preset, only the
information you saved into it will be pre-populated into the sheet. In most cases you
will not need to change anything here, and can just submit the form to apply the
formatting changes you’ve made. If you do wish to change the parameters of how
much the style saves, you can make these changes to the sheet, or even change the
name of it.
If you wish to create a derivative, instead of replacing an existing preset, use the
preset to style your text, modify it, and then use the Format � Formatting � New Preset
From Selection menu command to create the new version.
136 CHAPTER 14. WRITING AND EDITING
Deleting a Preset
Deleting a formatting preset can be done at any time by using the For-
mat � Formatting � Delete Preset � sub-menu. This command cannot be undone, but
if you do accidentally delete an important preset, you can re-create it by finding an
example in your text, and creating a new one from scratch.
character added to the front of the line, informing the MMD engine to treat the text
like a code block.
Viewing inline images full-size: To view an image contained inside text on its
own, you can drag the image from the text into the header view of one of the
editors. You can then double-click on the image and zoom in or out on the image.
Note that any changes made here will not impact the embedded image in the text.
To resize the inline image, double-click on it. This will bring up the image scaling
panel. Drag the sliders left to shrink the image or right to increase its size, and then
click on OK. Unchecking “Lock aspect ratio” allows you to move the sliders inde-
pendently and therefore distort the image. Clicking Cancel restores the image to its
former size. Note that some images types cannot be resized; double-clicking on such
images will do nothing.
To save the image to the disk, right-click on the image and select Save as Picture....
Printing with Images: There is a bug in the OS X text system whereby if your
text contains an image that is much wider than the page, when printing, the page
containing the image and all subsequent pages may not get printed at all. If you
find that Scrivener is not printing all of the pages it should, check that you haven’t
got an image scaled too large in the text - if you have, fix it by double-clicking on
it and resizing it. This bug can be reproduced in TextEdit by placing a very large
image in the text and switching to “Wrap to Page” mode - the image and anything
after it will disappear.
When using MultiMarkdown, inline images (and linked images for that matter)
will be converted to MMD syntax, and the images themselves will be gathered into
the compile folder for you.
is good for small placeholders, but since the images are saved into the RTF file itself,
adding very large high resolution graphics to your files will dramatically slow down
Scrivener’s ability to load and save your file while you work on it. If you need to
work with print-ready graphics, read the following section on linking your images to
the document, rather than embedding them directly.
1. Grey: when no split is active, this is the default state. If splits are turned on, the
inactive editor will be grey.
2. Blue: when splits are active, this denotes the active split. Any actions taken
which will impact the current editor will be made to the blue document. The
title itself will also be underlined for the active split.
3. Red: when an editor has been locked, it will turn red to remind you that clicks
in the Binder will not load any files into the editor.
14.5. HEADER BAR 139
14.5.1 History
On the left-most side of the header bar are the navigation arrows. Use these to navi-
gate backward and forward through the navigation history. If you right-click on the
either of the arrow buttons, a menu will be provided, making it easy to jump straight
to something far back or forward in the history without having to go through each
point in between.
Reveal in Binder ( – R) Will show the location of the currently edited file in the
binder, disclosing containers as necessary to do so. This is most useful when the
method you used to arrive at the current document did not involve clicking in
the binder (such as using the history navigation buttons), or if you are currently
viewing a collection and wish to find where the file is actually located in your
project outline.
Path Reveals the location of the current document in descending order. The top en-
try will always be the current document; the entry below that its immediately
parent; and so on until the top of the project binder is reached. These can be
selected to immediately jump to any ancestor of the current it.
Go To Offers an alternate way to jump to a specific binder item without using the
binder. If the binder is hidden, or hoisted, for instance, will let you navigate to
other areas of the project without having to alter your settings. Your favourites
(section 9.6) will be placed in the top of this menu, making it easy to jump to
them from anywhere in the project.
When viewing a Scrivenings session, the contents of this menu will be replaced
with the contents of the current session only, thus providing a miniature “table
of contents” for the current session.
Pro Tip: If you want to use the Go To menu to access other portions of the Binder
while viewing a Scrivenings session, quickly isolate the current document by itself
with Cmd-4. Once you are in single document viewing mode, the standard Go To
menu will be revealed.
Bookmarks Displays any text bookmarks (section 14.11) that have been added to the
current document in a handy menu. Header style bookmarks will be offset and
set to bold, making it easy to cut a larger document into sections of bookmarks.
140 CHAPTER 14. WRITING AND EDITING
If you are viewing a Scrivenings session, all of the bookmarks in the entire
session will be displayed together.
Take Snapshot This command will take a snapshot (section 14.9) of the current text
and store it for later use.
Match Split Document(s) Will open the currently viewed item in the inactive split.
This command will not be available if no splits are open.
Lock In Place ( – L) Locks the editor (or split) so that no Binder clicks will affect
it. When an editor is locked, its header bar will turn a shade of red.
❧ For information on the various other document footer bars, see Viewing Media
in the Editor (section 14.7)
❧ For details on how to use the footer bar in script mode, see Scriptwriting (chap-
ter 20).
❧ Read the chapters on The Corkboard (section 12.1) and The Outliner (sec-
tion 12.2) for details on how to use the footer bar in those view modes.
Pro Tip: If you want to easy grab the word count for the current section you are
working on within a Scrivenings session, you can use the selection counting fea-
ture mentioned above in conjunction with the Edit � Select Current Text command,
which can be enabled by holding down the Option key, or pressing – A. This
will quickly select only the text of the current section you are editing, showing the
word and character count in the footer.
which will let you set a numeric word or character goal that you intend to achieve
with the section. You can optionally use Growl notification to let you know when
you’ve reached your goal. These notifications work in both ways, whether you are
working up to a number while writing, or working down to a number while editing.
When enabled, the footer bar will acquire a progress bar next to the target icon
which will fill as you type, gradually changing colour until you reach your quota.
These targets can be set individually for each document. You may also monitor and
set them using the Outliner, by revealing the “Target”, “Target Type”, and “Progress”
columns.
To disable the goal metre, enter a value of “0” into the target configuration for the
document.
In the footer bar, click the toolbox button to open the image an your default exter-
nal editor. If you wish to open the file in another program, right-click on this button
to select an alternate from a menu. This menu is provided by the operating system,
so if your favourite program isn’t showing it, you can resolve this by sorting out why
it isn’t showing up in the OS (making sure it is in the Applications folder will solve
most issues of this nature). Beside this button you’ll see a reload button. You will
need to click this after saving your edits in the external image editor in order to see
the changes.
Annotating PDFs: As with ordinary text, you can select ranges of text in a PDF
file and highlight them with – H. This tool is limited to the yellow colour. It
is not possible to insert comments into a PDF using Scrivener. To give a PDF
file advanced treatment, view it in an external editor, such as Preview, or Adobe
Acrobat. Any changes made to the PDF, once saved, will show up in Scrivener
after you refresh the file display.
Note that Skim, a popular PDF viewer, uses its own system for annotation which
does not show up in Scrivener and most other viewers. Consult the Skim docu-
mentation for details on how to save embedded annotations.
As with images, you can open PDFs in external editors for annotation or more full-
featured browsing, and use the reload button to load PDFs from the disk if changes
are not showing up immediately.
which will rewind your media by a set number of seconds whenever you pause. This
interval can be configured in the Navigation pane (section B.5) of preferences.
To further aid in transcribing, you can use the – Return shortcut key to pause and
resume a media stream in an alternate split, while you are typing in the other editor,
never having to leave the keyboard.
Remote scrolling To scroll the other text editor up and down, use – UpArrow
and – DownArrow. This command does not work when the other editor
14.9. USING SNAPSHOTS 147
Remote history access Just as you can quickly flip through the history with – [
and – ], you can cause the other editor the jump back and forth in its own
history queue with – [ and – ]. A nice trick here, when working with
a sequence of reference documents, is to “pre-load” them into your reference
split by clicking on each one sequentially. Now they are loaded into the history
queue and easily accessible while you write in the other split.
Controlling media While typing in one split, you can start and stop QuickTime
movies and audio tracks with – Return, making this setup extremely useful
for transcription. If you have Rewind on Pause enabled (subsection 14.7.3),
this shortcut will also rewind the piece by a set amount (3 seconds by default),
making it easy to catch up.
synopses or meta-data), and are therefore only available for documents that contain
text (files, folders and saved searches).
You can tell if a text document has any associated snapshots by its icon. Documents
that have had snapshots taken of them have the top-right of the paper icon folded
down.
There are two primary ways to manage snapshots: using the Docu-
ments � Snapshots � sub-menu, and the Inspector pane (subsection 18.4.4), the lat-
ter of which will be covered in the reference section. You can also conveniently use
the – 5 keyboard shortcut while editing a document to take a quick snapshot in the
background.
2. Running comparisons between the current text and a snapshot, or between two
snapshots
14.10 Auto-Completion
There are three primary forms of auto-completion in Scrivener:
1. Typesetting: adjustments made to the characters as you type them in, such as
setting quotes to typographer’s “curly” or “smart” quotes, as they are alterna-
tively called; or adjusting stand-alone i’s at the start of a sentence to capital form
2. Word and phrase completion: as you type, you can have Scrivener suggest
words for you either automatically, or with a shortcut (the default); custom
phrases can be added to each project, such as character names and locations, or
existing title names from the binder
1. The menu item, Project � Auto-Complete List... and use the + button to add new
lines to this table.
2. Select the text word or phrase you want to add, in the editor, then right-click
on it and select Add Selection to Auto-Complete List.
If you would like for Scrivener to suggest custom phrases to you as you type, set
“Suggest completions as you type” in the Auto-Complete preference pane, and then
disable “In script mode only”; making sure the third option is enabled, otherwise the
entire language dictionary will be unlocked and most will find this to be too intrusive.
Most script formatting settings will also automatically add anything typed into
certain key areas of some elements into the project’s master auto-completion list.
Character names, locations, and so on will be checked for and added, making rote
data entry more efficient as you write.
2. Bookmark Header Annotation: Will create an offset label in the bookmark navi-
gation menu, indenting regular bookmarks beneath it until another header style
bookmark is encountered. Useful for documents with many bookmarks.
Usage Tip: Unlike corkboard and outliner, scrivenings can be taken into full
screen mode. Simply press the Full Screen button in the toolbar ( – F) after
setting up the session.
You can tell when you are in Scrivenings mode by the gradated horizontal divider
lines that will be drawn between each section represented in the session. Meanwhile,
4
This feature was known in prior versions as Edit Scrivenings, but it has been renamed as the
feature is no longer an action you have to set up.
14.12. EDITING MULTIPLE DOCUMENTS (SCRIVENINGS VIEW) 153
the header bar will state the name of the currently viewed container followed by
“Composite” in parenthesis—or “Multiple Selection” followed by the title of the doc-
ument you are currently editing within the session. As you switch from document to
document, the inspector will follow along and the header title suffix will update.
Scrivenings sessions are one of the few areas in Scrivener that consider your text
from a “flat” perspective, or how it will appear once it has been compiled. There
is no indication of depth while editing documents. This is intentional, so you can
concentrate solely on the same flow of text that your readers will have.
The footer bar will switch to an alternate mode which disables the per-document
goal meter as it no longer has any meaning in a multiple document setting. Addi-
tionally, the word and character counter in the footer will count the entire session,
making Scrivenings a great way to quickly view the word count of a particular section
of your book.
If you would like for titles to be displayed more prominently, you can enable them
by switching them on in View � Editor � Show Titles in Scrivenings. The appearance
of these titles will be dictated in Formatting preferences pane (section B.7). These
titles can be edited in the same fashion as editing any other piece of text in the editor
(though formatting will not be allowed).
❧ Select text from more than one document and delete it; this includes implied
deletions, like selecting some text and then typing over the selection.
❧ Select the entire last paragraph of any document and delete it; to do this, be
careful to only select the characters of the paragraph, not the the whitespace at
the end.
Since Scrivenings is now a proper view, it affords a greater latitude in how inte-
grated it is with the outlining process, especially with a locked editor ( – L).
❧ While editing, new documents can be created with – N, inserting them below
the current document that is being edited; likewise with splitting documents.
❧ With titles turned on, it is possible to create new items without ever switching
back to the Binder, making this combination of actions one of the most seamless
ways to flesh out your outline while you write.
❧ Moving documents around in the Binder will automatically update the order in
which they appear in the Scrivenings session.
❧ Deleted documents will be removed from the session.
❧ Merging documents from the Binder will make this change in the session
Lock in Place navigation If you are in an Edit Scrivenings session and lock the ed-
itor containing the Scrivenings view in place (using “Lock in Place” from the
View � Editor � Lock In Place or header view icon menu), clicking on documents
in the sidebar that are in the Scrivenings session will move the insertion point
to the beginning of that document in the editor (just like Go To).
Meta-data grouping Some forms of meta-data will group themselves when using
scrivenings. footnotes and comments (section 17.2) will be displayed all to-
gether in the inspector in a single large stack, allowing you to quickly see if
any of the constituent articles within the session have notes. Text Bookmarks
(section 14.11) will also be grouped together in their access menu.
Page View
By selecting View � Page View � Show Page View while editing a text document, you
can transform the visual presentation of the editor to using a virtual page. This will
place your text in a to-scale representation of your print and margin settings if you use
the View � Page View � Use Printed Page Size option. The option to use “Preferences
Page Size” lets you set up a page of any dimension, and so could be used to optimise
the appearance for you screen, so long as you do not require it to have any bearing on
accuracy. For most uses, Page View is for simulating the look and feel of writing on
real pages, and is thus an aesthetic preference, not a print preview tool.
While not intended to provide a 100% accurate print preview, when used in con-
junction with export fonts and formatting and accurate page dimensions, the resulting
page estimate (which will be calculated in the footer bar statistics area) can be quite
close to the actual end product, and thus will be of considerable use to anyone who
requires pages as a metric, such as scriptwriters. Do note however that page number-
ing will always be relative to the section of text you are viewing. It is not intended to
be a method of finding “page 83” from a stack of printed out papers by your desk. It
would be computationally prohibitive to provide this information in real-time, based
on the fact that Scrivener is fundamentally not a “What You See is What You Get”
editor, like a word processor.
To increase page count accuracy in a scrivenings session, you should use the “Sepa-
rate with single line breaks” option in the Formatting preferences pane (section B.7).
This alternate method for showing the boundaries of documents in scrivenings mode
uses no height, and so will not vertically distort the size of the session. The use of
titles in scrivenings should also be avoided as they will add extra height that may not
be in the final composite.
156
Chapter 16
Full Screen
Full screen mode allows you to edit your text in a distraction-free environment. You
can view any text document (or Scrivenings session (section 14.12)) in a full screen
mode akin to the one in iPhoto, so that you can compose and refer to your notes
without the noise of the rest of your desktop or even Scrivener itself. Consequently,
you’ll find that Scrivener “disables itself” to a degree, while in full screen mode. Menu
commands that would otherwise be available are turned off—in most cases these are
commands which would have no meaning at all, such as commands for merging two
selected items in the Binder, or enabling Corkboard view.
To enter full screen, you must have a text document as the active document (you
cannot view images or any other type of media in full screen), and it must be visible as
text (that is, the corkboard or outliner modes must not be active). Launch full screen
either by hitting – F, or select View � Enter Full Screen.
Pre-loading History In Full Screen: The one instance in which you can enter full
screen if the corkboard or outliner is visible is if you have selected multiple items
in the binder. In this case, the currently selected document in the corkboard will
be displayed in full screen mode, and all of the other documents on the corkboard
will get loaded into the full screen navigation history. This is a good way of loading
multiple documents so that you can easily flip between them in full screen using
the – [ and – ] keyboard shortcuts.
This behaviour will be disabled if the editor is already displaying exactly what has
been selected in the binder. In this case, full screen will use the scrivenings session.
The only time this will be in conflict is when the active editor is not in scrivenings
mode, or is in some other way not showing the binder selection.
When you first enter full screen, you will see your document in the middle of the
screen set to a pinkish-grey paper colour, and blocking the rest of the screen, a black
background. Nearly every aspect of this experience can be changed, some right within
Full Screen mode. You will also briefly see the Full Screen HUD (detailed below). To
retrieve it, slide the mouse pointing down to the bottom of the screen and let it sit for
a moment. So long as the mouse remains in the HUD area, it will stay visible. Once
moved back up, it will disappear out of view.
157
158 CHAPTER 16. FULL SCREEN
The menu bar can be accessed by similarly sliding the mouse pointer to the top of
the screen. After a momentary pause, the menu will appear. This is a useful way to
access advanced formatting tools, and even navigate around in your project using the
View � Go To � sub-menu without leaving full screen.
Text scale This operates in an identical fashion to the text scale zoom in the stan-
dard editor. The only difference is that full screen stores its own scale setting,
independent of the editor splits.
Paper Position Allows you to choose where the “paper” (the column of text) should
appear on the screen: on the left, in the centre or on the right. You may want
it in a non-central position, for instance, if you have a lot of notes to which to
refer and you want the inspector open (and wide) next to the text.
Paper Width Use this slider to change the width of the text. You can set it so that
the text takes up the whole width of the screen or appears as a column.
Paper Height To access this slider, hold down the Option key. It will replace the
Paper Width slider, above. This sets how tall the paper column should be,
giving you a “letterbox presentation” at its more extreme settings.
Keywords Brings up the standard Keywords HUD (section 10.2) which you can use
in conjunction with the inspector (below) to assign keywords to the current
document.
Inspector Brings up the full screen inspector HUD panel (see below).
Dynamic Controls & Statistics The middle portion of the HUD changes depend-
ing upon your editing mode. In standard editing mode, this will display the
16.3. FULL SCREEN INSPECTOR HUD 159
word and character count for the document. As with the standard editor, this
will also display the counts for any selected text, using a blue label.
In scripting mode, this portion of the HUD will display element hints (much
like in Final Draft and Montage) as well as the element selection menu (which
you can always call up with – Y).
Background Fade Fades the background (everything outside of the text column—
black by default but customisable via Preferences) in and out. Useful if you
want to refer to material in other applications open in the background whilst
remaining in full screen. When using a backdrop image this slider will do noth-
ing.
Exit Full Screen The button at the far right will exit full screen mode. You may also
press the Esc key, or – F to dismiss full screen.
multiple documents and form a Scrivenings session. To utilise this in the active full
screen window, just add the Option key to these modifier keys.
Chapter 17
❧ Revision markings: the automatic application of text colour, as you edit and
write, can be assigned individual colours for up to five revisions, making it easy
to make sure your colleagues know what you have changed and vice versa.
Marking your text is one thing, finding those markings amongst a 100,000 word
draft is another. The robust Find by Format and Text Function (subsection 21.4.3)
makes it easy to quickly step through your draft, point by point, isolating and ad-
dressing issues or reviewing changes that you’ve made.
161
162 CHAPTER 17. ANNOTATIONS AND FOOTNOTES
Annotations and footnotes (this document will refer to all notes as footnotes, even
if their intended result will be endnotes) come in two different flavours. Inline nota-
tions, which are added directly to your text, and linked notes which are attached as
a special form of “link” to the base text of your book, with the content of the note
stored off to the side in the inspector, much as in many word processors. Which of
these to use will remain up to you and your preferences in most cases. You might
even find that a mixture of methods will suit you, using inline notation for short
comments to yourself about prose, and linked notes for other types of comments.
There are advantages and disadvantages to each method:
❧ Inline notes are always visible in your text; there is no way to ignore them. So
for some forms of notation, this can be an advantage in that you cannot defer
or easily ignore them. This also makes it easier to see your notes and your book
at the same reading speed—there is no need to look off to the side to get a feel
for the “meta” book.
❧ Linked notes do not disturb the flow of text, no matter how large they may be.
This means even the lengthiest of notes can be placed into your text without
having to scan from word to word in order to read the underlying book text.
❧ Inline notes, being within the text itself, do not require any additional interface
to use and never require the mouse to read. They thus work well with a slim
workflow, or in situations where screen space is at a premium.
❧ Linked notes can act a little like bookmarks. Clicking on them in the inspector
will whisk you right to the spot in the text where they are anchored.
❧ Inline notes can be placed anywhere you like (especially annotations), even in
between paragraphs or at the very beginning or end of a section, whereas linked
notes require something to “anchor to”. This makes them more useful when
jotting down notes in sections before you’ve even started to write.
❧ Inline notes are only visible in the current contextual surroundings. Notes that
are pages away and do not presently concern you in your writing and editing,
are hidden by the same virtue that hides these irrelevant texts from you: the
sheer bulk of your words.
❧ Linked notes can be easily copy and pasted as regular text. Simple select the
note(s) in the inspector, press – C and then paste these into a text document.
While the same can be said of inline annotations, since they are not all presented
17.1. INLINE NOTATION 163
together at once, it is more difficult to gather them all quickly. In the following
pages you’ll find a way to export annotations and comments to a file, which
will help with this.
❧ Inline notes exist around your text and do not depend upon it to exist. This
means you can edit the text the note refers to freely, without worrying about
losing your comments. This is in opposition to linked notes, which are an-
chored to the text—if the text is removed or entirely altered, the note will be
deleted. By corollary, inline note quantities can exceed the textual capacity of
the base text. For most authors this will not become an issue, but in some fields,
such as qualitative data analysis, where the amount of annotation can exceed the
text, running out of suitable anchor text could become a problem with linked
notes. Inline notes, being unanchored, have no limits.
These are just a few examples, and hopefully that gives you an idea of the indi-
vidual unique merits in these formats. In some special cases, using all four methods
together will afford you with additional compile powers, such as handling multiple
note streams, or using annotations as “functional” text and linked comments strictly
as notes. The next two sections will address each of these types in more depth.
What They Are: Inline notation is fundamentally a form of formatting, just like
any other formatting range in your document, such as bold or italic. Yes, Scrivener
has tools for working with them in unique ways, but they will respond to many
164 CHAPTER 17. ANNOTATIONS AND FOOTNOTES
of the actions that are designed for working around formatting, such as Paste and
Match Style. When cutting and pasting text into and out of annotations, try to
think of them as analogous to bold text. To paste some external text into a foot-
note, you’ll need to use Paste and Match Style for the text to acquire the footnote
formatting. The same is true going in other direction. Additionally, ranges can be
toggled on and off for a section of text, just as you could with an italic range.
For both annotations and footnotes, how you interface with them is identical at the
writing phase. The only difference between the two will be which one you employ,
based on what you require of the text.
Since inline notation works just like ordinary formatting, creating a note or foot-
note from existing text is just as easy as selecting the range of text you wish to adjust,
and clicking on the appropriate menu command or toolbar icon. To create an anno-
tation, you can use Format � Inline Annotation or press – A on your keyboard. As
with other formatting tools, this works in a toggle fashion. If you select some text
that is already set to be an annotation and use this command, it will be returned to
regular text. For footnotes, everything is the same only you would use Format � Inline
Footnote or – F.
To create a new footnote or annotation from text that does not yet exist, you can
use these same commands to start typing in the desired notation mode, wherever your
cursor already exists.
Moving notes around is a simple matter of cutting and pasting the text itself. Since
notations are formatting, they will move along with the text no matter where you
take them, unless you use Paste and Match Style.
that there is only one space (or two if you use two spaces between sentences) sepa-
rating the sentences outside of the annotation. All spacing within the annotation
will be preserved, when you choose to compile the document.
Since you can choose to omit annotations from the text when you export or print
it, so they are very useful for jotting down notes and ideas inside the main text that are
not really part of the main text, but which would be better placed next to the section
of text to which they refer rather than in the notes pane. When you export to RTF
format, annotations can also be converted to RTF comments that appear in marginal
boxes in Microsoft Word rather than being omitted, if you so wish. Annotations are
really the electronic equivalent of taking a red (or any colour) pen and jotting notes
over your page. For details on what options are available for omission or conversion
during compile, see Footnotes/Comments (section 24.15).
While it is possible to use annotations to create footnotes, this compile-time con-
version has fewer options available to it than standard footnotes. For fully featured
footnotes, see below.
Important note: Although you can create tables and bulleted lists inside anno-
tations and footnotes in Scrivener, they are not supported inside annotations and
footnotes in the RTF, RTFD and Word exporter. This means that if you create
tables or bulleted lists inside annotations or footnotes in Scrivener, when you ex-
port to RTF you will find that the tables and lists are stripped out. This is because
certain limitations in the OS X system can cause crashes or strange results during
the RTF conversion process in situations where tables and bulleted lists clash with
the boundaries of annotations and footnotes. If you require such elements, it is
thus recommended that you format them at a later stage of the draft in a dedicated
word processor.
If you would prefer to store the content of the comment somewhere other than
within the base text itself, read Linked Comments, in the following pages.
If included in your compile options, annotations are placed into the MMD file as
span or div ranges with inline CSS colour styling applied to match the appearance in
Scrivener. The default result is a text that looks similar to Scrivener, albeit without
the bubble around it.
For more details on how to set up your own typesetting blocks, read Functional
Annotations and Comments (section 27.1).
Note that, as a drafting application, Scrivener does not do typeset footnotes itself;
rather, you define ranges of text that you want to be exported as footnotes. Thus,
when the above text in Scrivener is exported to RTF format and opened in Microsoft
Word (or just copied from Scrivener and pasted into Word) it will take on the familiar
appearance of a numeral reference linked to a line at the bottom of the page with a
matching numeral. Footnotes will also be exported in a variety of fashions for other
formats as well, such as eBooks, MultiMarkdown syntax (and therefore as proper
footnotes in LATEX), as look-alike footnotes in HTML and plain-text, amongst others.
For all options available, read Footnotes/Comments (section 24.15).
If you would prefer to store the content of the footnote itself somewhere other
than within the base text, see Linked Footnotes, in the following pages. Also note, if
you require more than one note stream, you can couple linked footnotes with inline
footnotes and treat them separately during compile.
17.2. LINKED NOTATION 167
2. In Full Screen, comments and footnotes have a dedicate pane in the full screen
floating inspector.
3. Snapshots will save their notes when you take the snapshot, and you’ll be able
to see the anchors in the snapshot viewer, but to read the notes you will need to
drag the snapshot to a header bar in one of the available editor splits.
So, to use linked notes, you must have an anchor position to place the note. Most
often, this will just be whatever text you wish to comment upon, or in the case of
footnotes, the position where you want the footnote to ultimately appear. If you
wish to jot down pre-writing notes in a blank document, it might be easier to use
inline annotations instead.
168 CHAPTER 17. ANNOTATIONS AND FOOTNOTES
Moving Linked Notes: Most often, it will be easiest to move a linked note if you
first convert it to an inline note and then use cut and paste to move the text. After
doing so, you can convert it back to a linked note. For small edits, it is possible
to change the working “beneath” the note, so changing the wording within and
around the note anchor will suffice for small moves.
1. Select the text you wish to notate and then invoke the appropriate menu com-
mand or keyboard shorcut. To make a comment, use Format � Comment or
– 8. To make a footnotes, use Format � Footnote or – 8. This method is
quite useful for comments, as the highlight range doubles as the specifier. If you
intend to address a piece of prose in your text, the highlighted text is immedi-
ately obvious as the problem area.
2. Place the caret in or after the word you wish to notate and use one of the above
commands or shortcuts. This is the easiest method to use while writing, as you
don’t have to switch to selecting. If you reach the point in your phrase where
you wish to insert a footnote, you can merely finish typing in the word and
press the shortcut key.
In addition to the menu and shortcut commands, you can also click either the +
button or the +fn button in the header bar of the Comments & Footnotes inspector
to add comments and footnotes, respectively.
Getting Back to the Text: Once you have finished typing in the content of the
note, you can swiftly return to where you were typing by hitting the Esc key. In
the case where you have pre-selected text to be notated, the cursor will be returned
to the end of the prior selection.
Since linked notes are a kind of link, they cannot be placed atop a range of text
that is already linked, without removing the underlying link. The same holds true
in vice versa: if you have a selection of text already linked to another document with
a hyperlink or Scrivener Link, trying to annotate on top of that link will destroy
the link, as test can only be linked to one destination at a time. To annotate a link,
consider using inline notes, or place the link anchor around the linked text, rather
than on it.
To move a note’s anchor position within the text, select the text in the main text
editor you wish to re-anchor the note to, and then right-click on the note itself in the
inspector (not on the old anchor in the text, that will change your current selection).
You will find a menu command to move the note’s anchor to the selected text, Move
to Selection. This can also be a useful way of temporarily setting aside a note so you
can edit a paragraph freely. When used in a scrivenings session, this technique also
allows notes to be moved from document to document.
Pasting into many Mac OS X applications will produce a different result, as most
do not support either footnotes or comments. In this case they will use RTFD format-
ting, which is a “flattened” version that looks like footnotes and inline commentation,
but in effect just formatted text. Since these applications cannot use real footnotes and
comments in the first place, this is an acceptable compromise.
Pasting Into Word 2011: Microsoft has changed how Word accepts pasted text to
prioritise the use of the RTFD method instead of RTF, even though it can handle
RTF just fine. This means you’ll end up with flattened notation as though Word
cannot support them. If you use Word 2011, you’ll want to enable the “Use Word-
2011 compatible copy” in the Import & Export preference pane (section B.9). Do
note that when this option is enabled, it will cause standard applications which
would ordinarily use RTFD to fail, as that flattened version will no longer be pro-
vided. So only enable this option if Word is your primary processor.
Finally, pasting into a plain-text editor, like TextMate, BBEdit, or TextEdit in plain-
text mode, will produce a plain-text flattened alternative, which uses brackets and
line-spacing to achieve a footnote and comment effect.
If you wish to copy and paste text without any notation at all, use Edit � Copy
Special � Copy Without Inline Annotations or Footnotes, or – C.
1. Remove Color
3. Custom swatches
4. Show Colors (accesses the colour palette so you can select a custom colour)
Custom swatches are imported from your colour palette in the custom colour shelf,
which can be seen here (Figure 17.1). These are named automatically by the Mac OS
X system. You may find similar colours will acquire the same name, this is normal;
they should be considered conveniences, not identifiers.
172 CHAPTER 17. ANNOTATIONS AND FOOTNOTES
Setting a highlight to a range of text is quite similar, only you will use the right-
most colour chip on the format bar, instead. As with the text colour chip, clicking
once will re-use the last highlighter colour, and holding the button down or right-
clicking will access the full menu. For highlighters, this can also be accessed in the
Format � Highlight � sub-menu. In addition, the last colour used will be assigned to
the keyboard shortcut, – H for rapid application at any time.
Colours and Compiling: It is important to know that both text colour and high-
lights will be exported when compiling, to most formats. They cannot be auto-
matically removed, and so should be used either when it is your intention to have
them in the final draft, or as temporary tools that you periodically strip out when
done with them. Some formats (and some word processors) do not support colour
and highlights, and so even if they are compiled in, they may not always show up.
When using a workflow that omits these tools, you can feel safer in leaving them
in when it comes time to compile.
Scrivener provides tools for stepping through your entire project, searching for text
colour and highlighters. Read more about this feature in Find by Format and Text
(section 21.4.3).
the swatches icon again, make sure the Scrivener set is active, and drag the colour from
the custom shelf into the list. Now that it is there, you can double-click to rename it.
Note that due to the way colours are estimated, if you have several subtle variations
they will all get the same name. To avoid this, create a new named colour swatch for
each variation. This is a purely aesthetic feature though. Names are not used for
anything, except for your own reference.
Mac OS X Tip:If you wish to share your colour sets with other users, or transfer
them to another computer, you will find a file in your user Library folder, un-
der Colors, named Scrivener.clr. Place this file into the same folder on the second
computer and it should become instantly available.
17.5. MARKING REVISIONS 175
the Format � Revision Mode � Remove Current Revision Color menu command. This
command will work on the entire text session that is in the active editor, so if you
are editing multiple documents in Scrivenings, ensure you wish to wipe out markings
for all visible documents. If you only wish to strip out marks from a portion of the
session, use – 4 to isolate the document, first.
You can also use this command in conjunction with a selection, to remove only
a portion of the revision markings from the document. Make sure that the selec-
tion only contains text marked with that revision, and use the same menu command
above.
Since revision levels are nothing more than coloured text, if you happen to have
other text in your document that is coloured identically, this command will strip out
those colours too. In general, it is a good idea to reserve these colours for revisions
only, if you intend to use the feature heavily.
footnote reference IDs as you write. Just use Scrivener’s footnote tools, compile, and
you’ll have a completed document with footnotes.
If you do not wish to see footnotes in the final product, you can disable this func-
tion in the compiler, under the Footnotes/Comments pane, by checking off the “Re-
move footnotes”.
Additionally, you can deselect “Convert Footnotes to MultiMarkdown syntax” in
this same pane, to produce “plain-text” footnotes. Scrivener will emit simple plain-
text style reference numbers in your text, and then generate a list at the bottom of
the document, corresponding to these markers. This option could be useful in cases
where footnotes are not supported by the target format, and the XSLT hasn’t been
designed to handle them otherwise.
For advanced usage of both inline and inspector footnotes as multiple note streams,
read Multiple Footnote Streams with MMD (section 27.2).
Inspector
The inspector displays all meta-data associated with the document shown in the editor
pane that most recently had the keyboard focus. Note that the special root folders in
the binder - Draft, Research and Trash - have no meta-data associated with them, and
therefore the inspector just shows the project notes or references when these items are
selected.
You may toggle the appearance of the inspector with View � Layout � Show|Hide
Inspector, or by pressing – I.
The Synopsis section can be collapsed to make space for the other elements of the
Inspector.
See also: So What are Index Cards, Anyway? (subsection 12.1.1)
179
180 CHAPTER 18. INSPECTOR
18.4.2 References
The References table allows you to hold links to related material within the project
itself, elsewhere on your hard drive or on the internet. Drag documents from the
binder or the Finder and URLs from the internet into the table to create links, or use
the buttons in the References header bar to add and remove reference links. Double-
clicking on the icon of the reference, or selecting it and hitting Return, will open
the document, either inside Scrivener or in the default application depending on the
reference type. Clicking the header bar of the references area will bring up a pop-up
menu from which you can select “Document References” or “Project References”.
As with notes, document references are attached to the current document whereas
project notes are global and remain the same no matter which document you are
viewing.
References to files on your disk which are supported by Scrivener’s editor can be
dragged into a header bar for viewing, even without importing them into the project.
URLs and unsupported file formats will not allow a drop on the header bar.
When you create a Scrivener Link to a document in any way, a Reference back
to the originating document will be placed in its references list. This way you can
easily track “back links” while browsing your project. These links are, however, not
dynamic. They are created once upon linking, and can later be removed or altered.
Pro Tip: If you change the “URL” for internal links (which otherwise just state
“[Internal Link]” in the URL field) to a single asterisk, that item will be placed
at the very top of the header bar icon menu. If accessed from there, it will load
that file in accordance with your navigation settings for internal references. Use
this to create a more visible “soft link” between one or more documents, such as
frequently used research material, instructions for preparation, and so on.
1. Drag the keywords from the Keywords HUD to keywords table in the inspec-
tor
2. Drag the keywords from the Keywords HUD to the document header bar, or its
name in the binder (this latter use allows you assign keywords to many selected
documents at once)
3. Click the + button in the keywords table header bar to type in a new keyword.
If the keyword already exists, auto-completion will be used to help you with
data entry. You can also use the Enter key in the table to add new keywords.
4. Using the gear menu in the keywords table header bar to access the Add Keyword
menu, which will contain a sorted list of all keywords in the project Keywords
HUD.
5. Right-click anywhere in the keywords table itself for quick access to this menu,
as well.
1. Compare with current: Simply select the snapshot you wish to compare against
the current text, and then click the Compare button. The changes will be high-
lighted in the text preview area.
18.4. DOCUMENT SUPPORT PANES 183
2. Compare two snapshots: Select two snapshots in the table and then click the
Compare button. The differences between those two versions will be high-
lighted.
While in comparison mode, the text preview area will switch to plain-text so that
only actual changes to the content can be analysed. To return to standard viewing
mode, click the Original button. The two arrow buttons which will appear in com-
parison mode let you jump from change to change. You can use – [ and – ] to
navigate between changes, as well.
In some cases, the level of editing will be as such that the comparison mode pro-
duces confusing results. The method of analysis can be fine-tuned by clicking the
down-arrow beside the comparison button at any time. In many cases, removing
word-level analysis will produce a cleaner result, when extensive edits have been made.
These options work in a descending fashion, meaning that the lowest selected option
overrides the options above it.
1. By Paragraph: any changes made within a paragraph will trigger the entire para-
graph as having been modified.
2. By Clause: any changes made within a clause (as in a sentence) will mark the
entire clause as having been modified.
3. By Word: individual words will be marked, producing the most precise (and
thus “noisy”) results.
The Roll Back button will revert the current editor text to the text in the selected
snapshot. To use it, select the snapshot you wish to revert to, and click the Roll Back
button. Scrivener will request confirmation from you, and give you the opportunity
to snapshot the current text if you wish. Note this cannot be undone.
Read more about using snapshots here (section 14.9).
❧ Add a new comment in the text at the current text position or selection
Select multiple items in the same fashion you would select multiple documents
with the Cmd and Shift keys. Notes can be independently collapsed or revealed by
clicking the triangles beside their title. Opt-clicking these arrows will collapse or
expand all notes. Likewise the – 0 and – 9 universal shortcuts for collapse all and
expand all work as well.
Press the Esc key to return to the main text editor at any time, even while editing a
note.
Using notes as bookmarks: Clicking on a note will scroll the text editor to the
position that they appear in within the text. This means you can use notes as a
form of bookmark, or quickly jump through your text point-by-point to areas that
need addressing.
Right click on any of the notes to convert between footnote and comment, or to
reset their formatting to the application default, which can be set up in the Formatting
preference pane (section B.7). Additionally, comments can have their colour changed
by right-clicking on selected comments. This will also change the anchor highlight in
the main text.
See also: Linked Notation (section 17.2) for full usage notes on the comments and
footnotes themselves.
❧ – H — Notes
❧ – N — References
❧ – J — Keywords
❧ – M — Snapshots
18.6. ADVANCED INSPECTOR KEYBOARD USAGE 185
These five keys are all placed under the right hand in ascending order, making it
easy to memorise them and use them without leaving the home-row. These shortcuts
have two modes of operation. If the pane in question is not visible, the Inspector
will open if necessary and switch to that pane. If the keyboard shortcut is pressed
while the particular pane is already visible, it will be focussed. This means you can
always start typing in notes, even if the Inspector is hidden, by quickly tapping the
corresponding keyboard shortcut twice. The focus model is used in the panes like so:
1. Notes: Immediate access to existing text so you can start writing and editing
in notes immediately. Switch between notepads with – 6 to select the next
notepad in the list, and – 6 to select the previous notepad in the list. These
shortcuts will “wrap around” the list so you can continue to use one of them to
cycle through all notepads.
2. References: Selection is moved to the list so you can navigate with arrow keys;
tap Enter to activate a link; or Del to remove a link from the list.
3. Keywords: Selection is again moved to the list. Use arrow keys to navigate
between existing keywords; tap Enter to add new keywords; tap Del to remove
keywords.
4. Snapshots: Focus is moved to the text preview field so you can quickly copy
and paste from here if necessary.
5. Comments & Footnotes: Focus is moved to the note list. Use the up and down
arrow keys to move between notes and jump to their corresponding position in
the main document; Enter to edit the text of an existing comment or footnote;
left and right arrows to collapse or reveal a note; and Del to remove notes.
Chapter 19
QuickReference
QuickReference Panels give you the ability to open more than two documents at
once. They are in a way similar to Mac OS X’s QuickLook, but rather than limiting
you to only one QuickLook panel and a view-only model, many QuickReference pan-
els can be opened simultaneously, and when viewing items which would otherwise
be editable in the standard editor, allow full editing capability. They also provide full
editing access to most data you can get in the Inspector, with the notable exception of
snapshots (more on that below). Once opened, QuickReference panels will remem-
ber their size and position on the screen, as well as their meta-data viewing options
for the duration of the session only.
There are two easy ways to open a document in QuickReference mode:
1. Select one or more documents in the sidebar or a view and tap the Spacebar. If
more than one document is selection, multiple QuickReference windows will
be opened at once.
The panel itself is composed of four major parts, one which is hidden by default. At
the top you have quick access to the Label and Status meta-data fields. In the middle
is the editor/viewer. This is an editable, full-power text editor when viewing standard
file or folder documents, and a standard media viewer just like the main editor when
viewing PDFs, images, or QuickTime documents1 . Below the editor/viewing area
you will find a compact footer bar which will display a word and character count for
standard file or folder documents. Beside that, a drop-down menu will give you access
to some document meta-data.
1
Unlike loading film and audio in a split, the remove pause and resume commands will not work
in QuickReference panes, as you can have many audio files open at once, and Scrivener would not
know which one to trigger.
186
19.1. QUICKREFERENCE MINI-INSPECTOR 187
Text Zoom: You can independently zoom the text scale within a QuickReference
window, either by using the keyboard shortcuts, – , and – . or by using the
View � Zoom � sub-menu.
You might want to take a moment to examine the Navigation pane in preferences
(section B.5) to see how you can use QuickReference panels to open things you might
otherwise have thought you could only open in standard editor splits.
See also:
3. Notes: standard document notes (you cannot access project notes from a Quick-
Reference window)
4. Keywords: document keywords; this table also serves as a drop-point for key-
word drags from the HUD.
6. Comments & Footnotes: this is the only view that will pop-up on its own if
you add a comment or footnote while writing in the editor. This pane works
identically to its inspector counter-part.
Scriptwriting
Although Scrivener is in no way intended to be a dedicated scriptwriting program
(for such a program you might want to try Final Draft or Celtx if you have not done
so already), it does allow for basic script formatting.
❧ Screenplay
188
20.1. FORMATTING A SCRIPT IN SCRIVENER 189
You can, of course, mix up different text modes in the same document or draft, so
that parts of a document may be written as a script and other parts written as general
text. This makes it very easy to write treatments in Scrivener.
The screenplay format that comes with Scrivener by default is based on a Holly-
wood standard, but with half an inch added to the left indent of each element so
that when you print with a standard set-up of one inch margins, the left margin will
actually start at one-and-a-half inches, which is the standard to allow for three-hole
binding.
The scriptwriting mode in Scrivener works much like other scriptwriting programs
(primarily, Final Draft). On the right end of the footer view is a pop-up button with a
menu containing the various elements for the selected format. Clicking on an element
will reformat the current paragraph to the format of the selected element. So, for
instance, if you clicked on “Character”, the current paragraph might all be capitalised
and centred.
This menu also has full keyboard access, allowing you to change modes swiftly
and without the use of the mouse. To pop-up the menu can be invoked with –
Y at any time from within a scriptwriting document (even in Full Screen view). To
select an individual element style, tap the associated letter for it, on the right side
of the menu. Example: “T” for Transition, and “C” for Character. Additionally,
each element (up to the ninth) will be assigned with a number (in the order that they
appear in the element menu), which can be combined modifiers. For example, the
Parenthetical format is the fourth available element, and so it can be invoked with
– 4; a Transition is the 6th element, and so can be invoked with – 6 and so on.
Learning these numbers can be useful as you do not need to call up the intermediary
menu to change element modes.
Upon hitting enter and typing, the paragraph formatting will be changed to that
of the next set element. So, for instance, if you hit Enter after having typed in a Scene
Heading, the typing attributes might be set to Action. At this point, you could easily
change the current element by pressing the Tab key—hitting it once would change
the current element to Character. Hitting it several times will cycle through different
elements.
The footer view tells you which element will be created next by hitting tab or
return. For example, in the Screenplay format, when waiting to type in a Character
name, pressing Tab will switch you to Transition and pressing Enter will switch to
190 CHAPTER 20. SCRIPTWRITING
Dialogue. However, once you begin typing in a character name, the tab hint will
change to Parenthetical, letting you drop to that element instead of dialogue if you
wish.
Auto-completion is available for some elements, as is appropriate for their context.
Upon choosing Scene Heading, for instance, you can start typing and then hit – . or
Escape to choose from a list of “INT.”, “EXT.” and so forth. For a more aggressive
auto-completion system, this can be fine-tuned in the Word Auto-Completion section
of the Auto-Correct preference pane (section B.8). You may also define special auto-
completion lists for each element (subsection 20.6.4).
If for some reason you need to change the element type for text you’ve already
entered, you can simply place the caret anywhere within the text you want to change,
and invoke the element menu ( – Y), or use the Format � Scriptwriting � Change
Element To � sub-menu to select a different element. Note that when moving from
an form that uses all-caps to an element that does not, you will need to adjust the
capitalisation manually, as Scrivener will not try to guess what is appropriate. The
Format � Convert � sub-menu has a number of conversion routines to aid in this.
Finally, you will need to ensure that the document is being displayed on a page and
margin framework that matches the final print. The best way to do this is to set the
Page View option to use the printing settings, with View � Page View � Use Printed
Page Size. For this to work best, you should change your preference in the Editor
preference pane for “Base printed page size on:” to “Compile Settings”. If you have
your compile settings set up correctly (1” margins all around for most script formats),
then the resulting page view layout should match the actual print job.
If you work with scripting formats quite a lot, you might wish to ensure that “Show
page view in new projects” is enabled in the Editor preference pane as well.
Because Scrivener is not a dedicated scriptwriting program, the way it handles script
elements is different from Final Draft or Movie Magic Screenwriter. Dedicated
scriptwriting programs generally assign meta-data to each text element that tell the
program that, for instance, this line of text is a scene heading, that paragraph is a
piece of dialogue and so on. Scrivener does little more than automate the process you
would have to use yourself were you to use a standard word processor to format your
script; that is, it just sets up the necessary paragraph formatting for each element and
auto-capitalises if necessary. Scrivener recognises elements by their paragraph format-
ting - for instance, if a paragraph has a three-inch left indent and single line spacing,
Scrivener will look up this formatting in the list of script elements, and if an element
is found with matching formatting its name will be selected in the elements pop-up
button in the footer view. If no elements match, “General Text” will be selected.
This means that if you import a script into Scrivener from another program and
want to continue working on it, the script format mode selected in Scrivener must
exactly match the formatting of the script you have imported.
Import the script either by dragging the RTF file from the Finder into
Scrivener’s binder or by using File � Import � Files... Select “Screenplay” from the For-
mat � Scriptwriting menu.
Ensuring that the script is visible in the editor and that the editor has the keyboard
focus (by clicking into it if necessary), go to Format � Scriptwriting � Re-capitalize
Script to capitalise scene heading and character elements.
The script should now look right in Scrivener, and clicking into different parts
of the text should cause the pop-up button in the editor’s footer view to update to
display the element in which the cursor has been placed (e.g. “Character” if you have
clicked in a character element).
If the pop-up button in the right of the footer view displays only “General Text”
when you click into different areas of your script, or if “Re-capitalize Script” did not
work properly, then this is because the format mode you selected (“Screenplay” in
this example) does not exactly match the format of the script you imported.
2. Import the script either by dragging the RTF file from the Finder into
Scrivener’s binder or by using File � Import � Files...
3. Ensuring that the script is visible in the editor, click into a line of text that rep-
resents one of the elements you want to be recognised (for instance, by clicking
into a line of text that should be a scene heading).
5. Enter a title for your new format in the “Format Title” text field.
6. Select the first element in the list and give it the name you require (i.e. the name
of the element in which you placed the cursor in step 3) by double-clicking into
it and editing it if necessary.
7. From the Manage... drop-down menu in the Script Settings panel, select “Use
current font & paragraph settings”. This will copy the font and paragraph in-
formation from the line of text in which the cursor has been placed in the editor
into the Font and Paragraph panes of the Script Settings sheet.
20.4. PRINTING OR EXPORTING A SCRIPT 193
Repeat this process, matching the settings for the elements in the Script Settings
panel with the text in the editor for each element in your script.
Be sure to save your script format for use with other projects using the Manage...
pop-up button at the bottom of the Script Settings panel.
You can then use your new format with all projects in the future for any scripts you
import. Once you have successfully created your own script format mode, all of the
elements in your imported script should be recognised in the pop-up button in the
footer view of the editor, and you should be able to use the script mode to continue
editing your script. Note that more complicated script formats may require a little
more tweaking to be recognised, but the above process should work for most.
If you do create a script format mode that recognises elements from an imported
script, please use “Save to file. . . ” in the Manage... pop-up menu from the Script
Settings panel to save your format as an XML file somewhere safe on your hard drive
so that you can back it up and load it on other machines or following a hard drive
reformat if necessary. Also, please feel free to upload such format files on the forums,
where other Scrivener users may find them useful—or from where you can always
download them again should you lose them.
Optional Step: For basic scripts or those that will use Final Draft’s standard
screenplay formatting—indeed, for most screenplays—this step can be omitted, as
it is mainly concerned with setting up the formatting for custom scripts. Proceed
to the next section if this is the case.
Whenever you import a script from Final Draft into Scrivener, all of its elements
will use the formatting specified in Scrivener’s script settings. These can be set up by
selecting “Script Settings. . . ” from the Scriptwriting submenu of the Text menu. The
Script Settings panel should be familiar to anyone who uses Final Draft, as it is set up
to be very similar, allowing users to create custom script formats.
Because a Scrivener project comprises multiple documents, it is important that the
script settings are set up as the user desires before importing or creating any script
documents in the project.
If you are writing a screenplay using standard formatting, you don’t really need to
do anything here. However, if you are using a custom format, or if you have an FDX
script that uses a custom format which you wish to retain after import into Scrivener,
you need to set up Scrivener to use that custom format first.
Fortunately, this is very easy to do, as Scrivener can read the formatting directly
from an FDX file, but you must do this before importing the script itself. (Remem-
ber, Scrivener can hold many different script documents but can only use one script
format in a project at a time; this is why setting up the format must be done separately
from importing a script.)
To import the formatting from an FDX file:
1. Open the Script Settings panel by going to Format � Scriptwriting � Script Set-
tings...
2. In the Script Settings panel, click on the “Manage. . . ” pop-up button in the
bottom-left.
4. In the open panel that appears, select the FDX file that contains the elements
and formatting you want to use and then click “OK” and “OK” again on the
Script Settings panel to accept the changes.
This doesn’t import the actual script, it just imports its elements and formatting
for use in the current project.
To test the new format, create a new document, choose scriptwriting format
(Format � Scriptwriting � Script Mode - FDX Script Settings) and start typing (changing
elements using tab and enter or using the pop-up menu in the footer view beneath the
20.5. WORKING WITH FINAL DRAFT 8 195
editor). You will see that the script uses the formatting of the FDX file. Now that this
is set up, you are ready to import the contents of the FDX file.
2. Go to File � Import � Files... and select the FDX file that you want to import.
Many features will be retained: script notes become Scrivener footnotes, revisions
are marked up in red, highlighting is retained and so on.
If you wish the FDX file to be part of the script that will eventually be exported,
be sure to import it into the “Draft” folder, or drag it there after importing.
To combine all of the scenes in the Draft folder of your project into one FDX file,
do the following:
1. Go to File � Compile...
3. You may need to tweak the various settings of the Compile Draft sheet to get
the script formatted correctly, just as you would with any Scrivener project.
You should see that most elements are retained—footnotes become script notes,
coloured text becomes revised text, and so on. The header shows whatever is set in
Scrivener’s Compile Draft panel.
That covers the basics of importing from and exporting to the FDX format using
Scrivener.
196 CHAPTER 20. SCRIPTWRITING
Script Formats are Static: Creating a script format is a static process. That is to
say that if you create a script format and then use it to write a script, if you then
go back and edit the script format in the Script Settings panel, the elements of the
script you created using the older script format will no longer be recognised as
anything other than “General Text” (until you click into each element in your text
and select the correct element from the script elements pop-up menu to update
the text). Thus, to save yourself lots of painful reformatting later, it is strongly
recommended that you ensure you get your script format right before you start
using it widely.
Next to the “Manage. . . ” menu (subsection 20.6.5) is another drop-down menu that
allows you to choose the units used to define your style: inches, centimetres or points
(most script formats use inches, of course).
On the bottom-right of the panel are the “OK” and “Cancel” buttons for saving
or cancelling the changes you have made to the format mode respectively. Click-
ing “OK” saves the script format into the current project package only. This means
that if you share your .scriv file with someone else, that someone else will be able
to open the project and use the script format regardless of whether they have this
script format installed on their machine. The format will not be available for use
with other projects until you select “Save for use with other projects” from the “Man-
age. . . ” menu, though. Once you are happy with the format, it is thus strongly
recommended that you make it available for use with other projects, as you might
not remember which project file you saved it in.
20.6. CREATING YOUR OWN SCRIPT FORMATS 197
Pro Tip: Making a format available for use in other projects saves it as an XML
file in ∼/Library/Application Support/Scrivener/ScriptFormats. Considering in-
structing your backup software to include this location (and potentially others as
well within the Scrivener folder) in order to keep your settings safe. You can also
save out external copies for sharing or further safe-keeping, with the Manage. . .
menu, discussed below.
On the right of the panel is the tab view. This is used for setting the format for each
element. Select the element from the list on the left, and then set the formatting for
that element using the controls in the tab view on the right. The setting controls are
grouped under four different tabs:
Font Allows you to set the font for the current element (selected in the list on the
left). Scrivener does not use the font to identify elements, so you can change
the font in the preferences without messing up Scrivener’s recognition of script
elements.
Size Allows you to set the font size (provided “Use script font set in Preferences” is
not selected above).
Style Provides a number of options for determining the appearance of the current
element, mostly self-explanatory.
❧ All caps: If this is checked, the element will be capitalised. If End of line
is selected (below), the element will be capitalised all the way to the end
of the element. If First tab is selected, the element will be capitalised only
up to the first tab character. This accommodates formats such as the UK
stage play format, which has character names and dialogue on the same
line, with character names in capital letters followed by a tab and dialogue
in normal sentence case. If Character(s) is selected, you can enter the char-
acters into the text field that will terminate capitalisation. For instance, if
you entered a colon in the text field, the element would only be capitalised
up to the first colon.
❧ No Underline/Single Underline/Double Underline: allows you to set the
underline style for the current element. If single or double underline is
selected, you can check Underline by word to underline words only (not
spaces).
198 CHAPTER 20. SCRIPTWRITING
❧ Parenthetical: encloses the current element in brackets when you hit tab
or enter.
❧ Style to: ordinarily, the “end of line” option will do fine, but in some cases
you will only want to define a custom format to a particular point, such
as the first tab encountered on the line, or a custom character sequence.
❧ Color: The text falling within the range of this element’s definition will be
recoloured as specified here. To change the colour, click on the chip and
select a colour using the palette.
Menu shortcut Enter a letter here that will be used in the script elements menu as a
shortcut key.
Alignment Sets the current paragraph alignment (left, centered, right or justified).
Spacing Before Sets the number of blank lines to appear between the selected ele-
ment (0, 1, 2, or 3), and the last one above it.
Ruler Conversions: When working with units in Scrivener, keep in mind that it’s
ruler starts at margin zero instead of paper zero. Since Scrivener is, by and large,
not “aware” of paper settings and page layout, it counts its ruler settings from the
beginning of the text on the left end of the page, not the beginning of the paper
itself. This is in contrast to many word processors, which start measuring at the
paper left edge, and show the print margin buffer in the display of the page.
Consequently, to convert most standard measurements to useful values here, you
will need to factor in the standard amount of print margin. For example, if the
Scene Heading is specified to begin at 1.5”, you will need to subtract 1” from that
and input 0.5” into Scrivener, since an additional inch will be added to the layout,
once margins are added to the page outside of Scrivener.
Indentation Allows simple customisation of the ruler layout for each element, pro-
viding support for most if not all formatting requirements on the page.
❧ First Line Indent Sets the left indentation of the first line of the paragraph,
a value which will only impact the first line and no subsequent lines from
the same paragraph.
20.6. CREATING YOUR OWN SCRIPT FORMATS 199
❧ Left Indent: Sets the left indentation of all lines in the paragraph except-
ing the first. Set this value identical to the First Line Indent, to create a
uniform “block indent” look.
❧ Right Indent: Sets the right indentation of the paragraph. This setting
pertains to all lines.
❧ First Tab: Sets the first tab stop of the paragraph. (Note that subsequent
tab stops may be added automatically to differentiate elements should any
elements have the same formatting.)
Advanced: Allows you to set the writing direction, minimum line height and de-
fault tab interval (the latter for cases where extra tabs are added as mentioned in “First
Tab”, above). Set “Try to keep with next paragraph” to prevent widows and orphans
with this element.
On return Sets which element formatting the text will use when you hit the return
key. Using Screenplay as an example, for the “Scene Heading” element, “Ac-
tion” is selected for “On return”. This means that if you hit the return key after
typing a Scene Heading, the text will automatically be formatted ready to type
an Action element.
Tab behavior Sets what happens when you hit the tab key.
❧ Allow tabs: If this is checked, the tab key works as it would normally, that
is, it inserts tabs. With this checked, none of the other options for tab
behaviour are available.
❧ Tabbing on an empty line: Choose an element from the “Go to:” pop-up
button to set which element will be formatted when you hit tab on an
empty line. This allows you to cycle through elements using the tab key.
For instance, in the Screenplay format, if you are at the beginning of the
line using the Scene Heading format, you can then hit the tab key to re-
format the line as an Action element provided you haven’t typed anything
yet.
200 CHAPTER 20. SCRIPTWRITING
❧ Tabbing after typing: Sets what happens when you hit the tab key after
typing something in the current element. Select “Go to:” and an element
from the pop-up button to have tab automatically take you to the next
desired element (inserting a new line automatically). Use this to define
convenient alternate common elements. Select “Insert” and type charac-
ters in the text field to have the tab key insert a character sequence. In
the example above, hitting tab after typing something in a Scene Head-
ing element automatically inserts a hyphen surrounded by spaces, which
emulates the behaviour in Final Draft.
Append project auto-complete list Adds any words set in the project auto-complete
list (Project � Auto-Complete List) to the current script auto-complete list. This
way, script element completion lists can include character names set at the
project level.
Automatically add phrases to project list that occur Type in two characters to
help in isolating useful part of a phrase (such as locations and character names)
from the paraphernalia surrounding them. If a field is left blank, then anything
on the line will be used, up to any character defined in the opposing field.
An example for the Character element would be to add anything typed into
the character field prior to an open parentheses, and thus avoids such com-
mon markers as “(O.C.)”. However no starting limiter is provided, so anything
typed into the line will be added to the project list.
After project list completions When a project list auto-completion has been used,
you can set up the scripting system to do nothing, go to the next line, or insert
a tab.
An example for the Character element would be to go to next line after using a
project list completion (most likely a character name).
20.6. CREATING YOUR OWN SCRIPT FORMATS 201
Reset to defaults Reverts all customisations that you have made to the settings panel
to the Screenplay default. If you wish to revert to a saved script setting, simply
select that script from the Scriptwriting menu, instead of using this tool.
Use current font & paragraph settings Will attempt to import all available charac-
ter and paragraph level formatting attributes into the currently selected element
in the above element table. This can be quite useful when you have imported
a script from another program and wish to create a script format from the ex-
isting text. Simple click through the document, locating element types, and use
this tool to import the correct formatting into each element type.
If you are using Final Draft 8 or above, you will want to use the tool below for
scanning .fdx files for types, rather than doing all of this by hand.
Load from file. . . Loads a Scrivener script format file from the disk. Use this if you
have downloaded a script format from the Internet, or are in the process of
transferring formats from one computer to another.
Load from Final Draft .fdx or .fdxt file. . . Scrivener can examine an existing Fi-
nal Draft or Final Draft Template file for formatting rules and names, and at-
tempt to convert them to Scrivener’s internal script formatting, in one conve-
nient shot.
Save to file. . . Saves your current settings to an external file that you can easily
backup, upload to the Internet for sharing, or send to another of your com-
puters. This will not install the saved script into your Scrivener support folder.
Use the below command for that.
Save for use with other projects Essentially accomplishes the above, but automat-
ically installs it into your Scrivener support folder for immediate usage in all
of your projects. If you wish to share the file with others, or transfer them to
another computer, use the Save to file... option as well as this one.
Chapter 21
Writing Tools
❧ To get word, character and page counts for the whole of the draft (that is, the
contents of the Draft folder) and for any documents selected in the binder, use
Project � Project Statistics. To calculate the Draft statistics, Scrivener internally
generates the actual draft based upon your Compile Draft settings—so you need
to remember that if you have only got Compile Draft set up to print off syn-
opses, only the synopses will be counted. This can also mean that there will be
a delay in displaying this panel with larger projects.
❧ To get word, character, paragraph and line counts for the current document,
and a breakdown of word frequency (the number of times you use different
words), select the Project � Text Statistics menu command (this will only be avail-
able if a text document has the keyboard focus).
❧ To set a target word or character count and track your progress for the entire
draft or the current session, select Project � Show|Hide Project Targets.
202
21.2. GOALS AND STATISTICS TRACKING TOOLS 203
❧ To set a target word or character count and track your progress for a single
document, click on the target button in the bottom-right of the footer view
(this is not available in scriptwriting mode, though, where word and character
counts are rarely useful anyway). See information on the footer view for more
information.
❧ To get the word or character count for a selection of text, select some text in
a document and examine the footer bar of the editor. The word and character
count will appear in blue text. When there is no selection, this area will be used
to count the entire document or Scrivenings session.
❧ To view the word, character counts and targets for several documents at once,
use the outliner view and make visible the appropriate columns by clicking on
the “>>” button in its header bar (or by selecting View � Outliner Columns).
You can use the “Total Words” column to collect aggregate counts for items
which have children.
Usage Tip: The word frequency tool in Text Statistics only counts text within
a current view, which can include a Scrivenings session. Thus, to perform this
analysis on the entire Draft or large portions of it, create a Scrivenings session first,
and then use the Project � Text Statistics tool.
Using targets to hit an editing goal: While this tool was originally designed to
set a writing goal you work up toward, it can easily be used as an editing tool when
cutting text. It not only counts words added, but words subtracted. You can set an
editing goal in the same way you would set a writing goal. The progress bars will
appear maxed out. Once you have edited below the target, you can be optionally
alerted to this fact with Growl, or just keep an eye on it as you work.
This panel will float over your project if you leave it open, and update itself in real-
time as you write and edit. If you want to track a goal for an individual document,
rather than the entire project, use the Text Goals (subsection 14.6.3) tool in the footer
bar.
If you delete lots of text, session statistics will not start showing any progress until
you have written as much again—it is perfectly possible to have a negative session
word or character count! In other words, it shows your net gain during the session.
The session target only counts anything typed or pasted into a main text view (either
of the editors or the full screen text view) it does not count imported documents or
appended text and so forth (so you can’t cheat!).
Draft Target ❧ Count documents included in compile only* will only monitor
those texts which have the “Include in Compile” checkbox set. If your
work style has note documents scattered about in the Draft folder, they
will not be counted toward your final goal unless you disable this option.
❧ Target applies to the current compile group only* takes this a step further
and only calculates off of documents that have been chosen in the Content
pane of the Compile interface. For performance reasons, this only works
off of the top drop-down selection in the Content pane; dynamic filters
will not be used.
Session Target ❧ Count text written anywhere in the project*. Turning this on
will count anything you type or paste into the any document in the project
binder, even if it is a character sheet or a grocery list.
❧ Allow negatives*. When disabled, the session counter will never drop
below zero. Leave this on to get an accurate net total of your writing
session. When disabled, deletions will still be counted, but only until the
21.2. GOALS AND STATISTICS TRACKING TOOLS 205
❧ Show target notifications using Growl. If you have Growl installed on your sys-
tem, Scrivener will register itself for announcements, and use that system to
post notices when you exceed a goal, or fall back under it.
❧ Draft: Everything included in the Draft folder (and by default, only the current
compile group). Note that compile options which modify export content in
any way can impact this counter. If your compile is set up to only export titles
in an outline format, you’ll get a pretty small word count. Likewise, Com-
pile content selection filters, and the state of the Include/Exclude/All selection
drop-down will impact the total. In general, consider what your document
looks like when you compile: that is what will be counted.
Each of these sections have identical statistics available to them. The word and
character counters are self-explanatory. The two page count estimates are based on
different algorithms.
Pages by paperback uses the industry standard formula (for English language pub-
lishing) of taking the average number of words per page and multiplying it by the
average number of characters per word (five including a space, for six total), the prod-
uct of which is then used to divide against the total character count of the project. By
example, a book with 720,000 characters with an estimate set to 250 words per page
will produce a result of 720000
250·6
= 480. If you need to adjust the average number of char-
acters per word, switch the counting mode to Characters and provide the product of
the words-per-page multiplied by average word length. For example, if the average
word length is 8 and the number of words per page is 200, you would enter 1600 into
this box to produce a custom result.
Pages printed will be more accurate for your own printouts, as it will compile your
draft in the background, using the specified formatting and page layout settings, and
then count the total pages resulting from that. Consequently, in large projects it may
take a few moments for this sheet to display. Once you exceed 100,000 words, the
Statistics sheet will no longer automatically paginate every time you open it. You
will need to click the Update Printed Counts button to manually recalculate printed
pages. With large projects, it could be advantageous to tune the paperback estimated
206 CHAPTER 21. WRITING TOOLS
count to your printed count, so that it can serve as an immediate general figure to
work from.
Draft Statistics Options Controls how the top, Draft only section of the stats are
calculated.
❧ Count current compile group only: only calculates off of documents that
have been chosen in the Content pane of the Compile interface. This
is the only compile-time option that can be disabled. All other compile
options that restrict or modify output quantity will still be factored into
the count.
❧ Count footnotes: Footnotes are by default included in the count. If your
publishing environment demands these be considered separate, here is
where you can disable them in the total count.
Selection Statistics Options Selection works a little differently than above. Since a
sample compile is not produced in the background (and such might be mean-
ingless if the selection is outside of the Draft), some of the filters that would
otherwise be a part of the compile option setup are provided to help you hone
the results.
Page Count Options Set the counting algorithm used to estimate paperback page
counting. This figure will be divided from the total word count to produce an
estimate.
21.3. THE NAME GENERATOR 207
❧ Attempt alliteration: the generator will attempt to produce names with an allit-
erative effect, like “Jeromy Jin”. This option will work best with Latin based
languages.
❧ Forenames use initials only: reduces the forename to an initial. If more than
one forename has been selected in the option below, multiple initials will be
generated, like, “N. J. Pettersen”.
❧ Obscurity Level: this slider to adjust how obscure the names should be. Moving
the slider all the way to the left might produce a result like, “Scott Young”,
208 CHAPTER 21. WRITING TOOLS
while sliding it all the way to the right, “Chauncey Noach” (no offensive to all
the Chaunceys out there). Note that some lists by definition are obscure, so
if you keep getting odd names, check your source list and make sure nothing
unusual is selected.
Finally, you can select from one of the many lists provided. You will always need
at least one Surname list selected (indicated by the yellow “S” icon), and at least one
gender list which is compatible with the gender option set above. If you have the list
set to return male names, you will need at least one male list of forenames selected.
These are indicated by the standard gender symbol icons. You can choose as many
sources lists as you like at once.
The built-in lists will be shaded in grey because they cannot be deleted. You can
add your own custom lists. Name lists should be formatted so that all names are on a
single line, and each name is separated by a comma, like so:
name1,name2,name3,name4,name5
It might be easiest to produce these lists in a spreadsheet on a single row, and export
as a CSV file. If you use a regular text editor, make sure to name the file with a “.csv”
extension, and then click the + button in the Name Generator option panel. Locate
the file in the chooser dialogue and click Open. You will be presented with some
options on how the list should be marked. Give it a descriptive name, and mark
whether it is a list of female names, male names, or surnames. Finally, if you have
ordered list from most common to most obscure (at the end of the list), check this
box to enable the Obscurity Level slider. Note that in small lists, the obscurity slider
may not have much impact, depending upon how many names are being generated.
If you wish to delete one of your custom lists, select it in the list and click the -
button.
Search Results and the Sidebar: Since search results temporarily replace the
binder in the sidebar, it can confusing for new users to figure out how to get back
to the binder. When the collection interface is revealed, you can switch back easily
by clicking on the “Binder” tab, but otherwise you can use the small X button in
the sidebar footer, or simply tap Esc while in the search field to dismiss the search
results. For more about navigating amongst collections in general, read Using Col-
lections (section 8.4).
When nothing is entered in the search field, greyed out text will inform you of
the current search mode. By default this is “All (Exact Phrase)”, which means all
searchable elements in the project will be analysed with the exact phrase operator.
The search scope, data type, and operator mode can be adjusted via the project search
options menu, by clicking on the magnifying glass to the left of the search field. The
options are as follows:
Search In Sets the data type of the search. You can set the search to only query a
certain type of meta-data or text field, rather than everything.
❧ All: The default search mode. Every available type of searchable field will
be queried for matches.
❧ Title: Only the titles of binder items will be searched for. This is similar
to title filtering in the binder.
❧ Text: The text contents of files and folders will be queried. Note this does
not include notes and synopsis.
❧ Notes: The auxiliary document notes will be searched. Note this does not
include project notes.
❧ Synopsis: The synopsis field for each document will be searched. This is
anything that has been typed into the text area of an index card or in the
synopsis portion of the outliner.
❧ Keywords: Only keywords will be searched. Note you can also perform
keyword searches quickly by using the Keywords HUD.
❧ Label: The text (not colour) of the label meta-data will be searched. Note
the name of this meta-data field can be changed per project.
❧ Status: The text of the status meta-data will be searched. Note the name of
this meta-data field can be changed per project.
❧ Custom-Meta-Data: The text values (not meta-data field name) will be
searched.
Operator Set the method by which search terms will be handled as you type them
in.
210 CHAPTER 21. WRITING TOOLS
❧ Exact Phrase: The default method. What is typed into the field will be
queried precisely as it is typed in. “the book” will only match documents
that have the phrase “the book” as written, not documents that just have
the word “book”. It will also return documents that contain “the books”.
For exclusive matching, use Whole Word (below).
❧ All Words: Every word entered into the search field must appear in the
selected data type. Documents which only match some of the words will
not be returned. Words can be entered in any order. Analogous to logical
AND.
❧ Any Word: Queried documents must contain at least one of the words
typed into the search field. Analogous to logical OR.
❧ Whole Word: Unlike any of the above search methods, the term supplied
will only match whole words. A search for “Jo” will only return docu-
ments with that word, not documents that also contain “Joseph”.
Options Provides a few extra options, as well as searching scope limiters. Scope
limiters instruct the search engine to only analyse parts of your binder, rather
than the entire thing.
❧ Search Draft Only: Will only look in the Draft folder of the binder. Note
that if the name of Draft has been changed in the project, the title of this
option will reflect that name change.
❧ Search Binder Selection Only: Pre-select items in the binder and then per-
form the search against those items only. This selection is explicit, not
implicit. Selecting a folder will not include all of its children in the search
query as well.
❧ Search “Included” Documents: Include documents that have been marked
as “Include in Draft” in their meta-data. This option can be combined
with the below.
❧ Search “Excluded” Documents: Include documents that have not been
marked as “Include in Draft” in their meta-data. This option can be com-
bined with the above.
❧ Case Sensitive: By default, the search engine ignores letter case. If you
need to search for proper nouns and are getting a lot of false positives, this
option can help.
Save Search. . . Creates a special Saved Search Result Collections (subsection 8.4.4),
which will keep itself dynamically updated whenever you view them.
21.4. SEARCHING AND REPLACING 211
❧ – G:finds the next available match; will wrap around to the top of the docu-
ment if there are no more matches available below the current point.
❧ – G: finds the previous match; as above, but will wrap around to the bottom
of the document.
❧ – E: loads
the currently selected text into the “Find” field. Using this method,
you can define a search term and then use – G to find the next instance of that
term without even opening the panel at all.
Containing text Limits the search to only return results in which the specified text
falls within the highlight range.
Search in There are two choices available: “All Documents” will search all text doc-
uments in the binder; “Selected Documents” will constrict the search to only
those items you have currently selected in the sidebar or a view.
If you leave all of the criteria types empty, it is possible to use this panel to find all
instances of the particular formatting type.
The rest of the panel will change depending upon the current formatting mode.
As with the standard text Find panel, it can be left floating over the project window
as you click the Next and Previous buttons, allowing you to edit immediately after
coming across a match, and then going back to search without having to call up the
palette again.
The rest of this section will go over each of the individual formatting search types.
212 CHAPTER 21. WRITING TOOLS
Highlighted Text
Looks for text that has been highlighted using the highlight feature (section 17.4).
Limit search to color When enabled, only those highlights matching the chosen
colour will be found. If this is disabled, all highlight colours will be consid-
ered a match. Note that the colour must be precisely the same, so stick to using
swatches or the built-in highlighter defaults when using this tool.
Click once on the colour chip to bring up the colour palette, or right-click to select
from the system defaults and your custom colour swatches in a manner similar to the
Format Ruler.
❧ Limit Search to Color: will only consider annotations of precisely the specified
colour as matching.
❧ Exclude Color from Search: any annotations precisely matching the provided
colour will be excluded from the search. The default configuration of this
search mode is set to exclude all “Blueberry Blue” annotations. This is because
Scrivener uses this colour to add bookmark annotations. Since it is unlikely that
you will want to find these types of annotations in your search, it is provided as
a handy default.
Inline footnote searching is much more simple. Since footnotes cannot have custom
colours, no additional criteria is necessary.
Revision Colour
You will be given the choice to search for a particular revision level in the drop-down
menu. These are hard-coded as provided by the Format � Revision Mode � sub-menu.
Do note that if you have changed Scrivener’s default colours, and are working with a
colleague that has not changed their default colours, this can lead to situations where
their revisions are not visible to you and vice versa. When working in collaboration
with other Scrivener users, it is best to not customise these colours.
21.4. SEARCHING AND REPLACING 213
Coloured Text
The interface for this type of search is similar to the Highlight search. You can pro-
vide a custom colour restriction in the additional criteria section. Note that since
revision markings are essentially just formalised coloured text, you can use this panel
to work around the problems brought up above, by searching for your colleagues cus-
tom colours manually. Do note the colour choice still needs to be precise, so getting
these custom colours from them, and turning them into custom swatches will be of
benefit.
Links
You may search for URL or internal Scrivener Links using this tool. By default all
links will be returned, but if you wish to narrow the search down to a particular link
type, use the “Link Type” menu to make this choice.
Character Format
Arbitrary text-level formatting can be searched for using this tool. Any number of
options in the additional criteria can be stipulated. They work in an additive fash-
ion, so if you have both Bold and Underline selected, a successful match must be
both bold and underlined. “Keep with next” search for paragraphs that have the For-
mat � Text � Keep With Next marker added.
your editor ends up missing. Using the “Whole words only” option can mitigate this
a great deal. Without that option, searching for the character name “Sam” and replac-
ing it with “Joseph” could end you up with such (bleakly) amusing concoctions as
“Josephe” in place of every “same”.
You can choose the scope to optionally affect a variety of document meta-data, as
well as just the text of a document. The following options are available:
5. Snapshots: archived snapshots will be changed as well (take special care with
this one, as snapshots are your internal backup mechanism)
Using MultiMarkdown
For those who prefer structural writing solutions to rich text (and if this means noth-
ing to you, you can happily skip this section), Scrivener allows you to import and
export using Fletcher T. Penney’s MultiMarkdown syntax. MultiMarkdown makes
it easy to generate documents in any number of formats - for instance, LATEXand
XHTML - using a basic markup syntax (for instance, using asterisks to define **bold**
and *italics*).
It is important to note that if you have happily used normal word processors (such
as Microsoft Word or Mellel) and rich text for years and have never heard of Multi-
Markdown, structural writing or been bothered by such formats as LATEX, you can
ignore this aspect of Scrivener. Scrivener was designed primarily as a rich text applica-
tion; MultiMarkdown is implemented in such a way that those who want it can access
it easily but those who have no need of it need never be bothered by it.
215
216 CHAPTER 22. USING MULTIMARKDOWN
ters, the single biggest source of inspiration for Markdown’s syntax is the
format of plain text email.
For comprehensive information about MultiMarkdown and how to use it, see
Fletcher’s website.
Note that you can convert rich text bold and italic attributes to MultiMarkdown
syntax by using Convert > Bold and Italics to MultiMarkdown Syntax in the Text
menu. However, because rich text allows more flexibility in its use of bold and italics
than MultiMarkdown - for instance, MultiMarkdown does not support the italici-
sation of partial words - this command may or may not produce completely valid
MultiMarkdown syntax; it is up to the user to check this.
Emulating Plain-Text: Users who prefer a plain text appearance may wish to set
their default font and paragraph settings in the “Text Editing” pane of Preferences
to something that emulates a plain text “feel”. For instance, you could set the font
to Monaco 10-point (Monaco does not draw bold or italics) and set the paragraph
formatting so that there are no indents and no inter-line spacing. The latter adjust-
ment is a good one to take in many cases, even if you prefer to write in a “RTF
feel” environment, as pseudo-spacing can cause confusion and obscure underlying
missing syntax, since whitespace is a form of syntax in MMD.
MultiMarkdown Exports the draft as a plain text file, creating headers from docu-
ment titles based on the hierarchy in the binder (i.e. a document on the third
level under the Draft folder would be have its title generated as: ### title ###).
Note that structural titles will not be created for documents that have “Preserve
Formatting” checked. This really just gets a clean MultiMarkdown file out of
Scrivener, created from the whole of the draft.
MultiMarkdown - LATEX First parses the draft into MultiMarkdown format (as
above) and then pipes the text through MultiMarkdown (the program, built
into Scrivener) to generate a .tex file. By default, this uses a version of the Mem-
oir class to create the LATEXfile.
MultiMarkdown - RTF Parses the draft into MultiMarkdown format and then
pipes it through MultiMarkdown to create an RTF file. Recent versions of
218 CHAPTER 22. USING MULTIMARKDOWN
MultiMarkdown (which Scrivener has been updated to use) use a full RTF gen-
erating transform engine, which has greater support for features that were ab-
sent in prior releases, such as footnotes, stylesheets, and cross-references. Since
these RTF files contain many more features than they did in the past, you will
want to use them in conjunction with a word processor, not TextEdit, which
dumps features it doesn’t understand.
MultiMarkdown - HTML Parses the draft into MultiMarkdown format and then
pipes it through MultiMarkdown to generate an XHTML file.
1. Any inline or linked images will be converted to MMD syntax, and ex-
ported into the compile folder, ready to use by the XHTML, MD plain, and
LATEXformats
2. Scrivener’s footnote features (both inline and linked) can be used to generate
MMD footnotes, and optionally its annotations and comments can be inserted
into the document as well. Inline annotations on their own line (not embedded
in another paragraph in any way) will be exported as DIVs, all other annota-
tions, and all comments, will be exported as SPANs. This can be used advanta-
geously in more advanced workflows with custom XSLTs.
Some of Scrivener’s tools which are intended for a rich text workflow have alternate
purposes with MultiMarkdown.
Preserve Formatting blocks Accessed from the Format � Formatting � Preserve For-
matting menu, these blocks can be applied to text to protect them from format-
ting alternations during compile. With MMD, since there are no formatting
alterations, these blocks will instead emit a single tab character in front of ev-
ery paragraph within the block, in effect, making it a code block or a poetry
block (depending on which exporter you are using).
Compile As-Is This checkbox in the inspector is generally used as a larger area of
effect version of the above tool: it will protect an entire document from for-
matting alterations. In MMD, all this checkbox does is restrict the document
from emitting a title header if it otherwise would have. Thus it can be useful
for injecting sections of pure LATEXand other such applications.
Final Phases
221
222 CHAPTER 22. USING MULTIMARKDOWN
Distilling your work into a final product is an essential task for any writing appli-
cation. Scrivener approaches this problem from multiple fronts, giving you plenty
of options for producing a manuscript, web pages, printouts, e-books, and quite a bit
more. Most of these methods are functions of the compiler, a powerful export feature
which will take the contents of your draft folder and produce a single document from
the many pieces it represents. Due to the level of control that can be exercised at this
stage, learning how to export can be itself a part of the learning process, but one that
will in time benefit your ability to write freely in whatever manner you choose.
Most word processors are designed for business use, and approach document cre-
ation with the philosophy of showing you a good approximation of the final product
as you work. This integrated way of working means that you are at once presented
with the tools for writing with the same level of priority as the tools for formatting
and layout. This not only creates a more confusing and distracting interface, but can
lead to writing in a constricted environment, where you must work in a format which
you are required to deliver.
Scrivener’s approach, as with many things, allows flexibility. You can work in the
described manner to a degree, where the text as you write it is formatted to how it will
be delivered (although it will never present a full working preview in all ways), but
you can also choose to completely separate that aspect from your writing experience,
and let the compiler handle the details of formatting for you, from how titles are
named, all the way down to whether or not your paragraphs are first-line indented or
spaced apart.
Fortunately, the distinction between these two ways of working can be made as
fuzzy as you like. That is, you can gradually introduce more automation into the
compiler as you learn how to use it, rather than having to make a big jump all at once
to a new way of working. In the chapter on compiling, you will be introduced to
several basic presets that ship with Scrivener. These are intended to be starting points,
and will not address everyone’s individual ways of working. If you are accustomed to
working in a word processor, you might want to start with the Original preset and
work from there. If you are used to working in plain-text, or another workflow that
does not regard formatting as part of writing, then you might be interested in trying
one of the other more comprehensive presets, such as the novel standard manuscript,
or 12pt Times presets.
The compiler can also be a tool for producing specialised reports for yourself, by
selecting only portions of each item in the Draft to be included, such as just the
title and its synopsis. The enumerated outline preset demonstrates one such strategy,
where an indented outline of all your draft titles will be exported as a file.
Many authors will be taking their finished drafts to a word processor for final post-
production work. We will discuss several common word processors on the market
and how best to work with them in Scrivener.
Finally, we will also discuss more traditional methods of printing and exporting,
22.10. FURTHER INFORMATION 223
as well as a few techniques you can use to add final polish to your manuscript. The
topics that will be covered in this part are:
❧ Compiling the Draft (chapter 24): Discusses compile strategies, format compat-
ibilities, and gives a detailed run-down of every possible compile option.
❧ Exporting (chapter 25): Transferring the contents of your project to your hard
drive is a great way to back up your work outside of Scrivener entirely, or share
bits of your project with other people. This chapter discusses the options avail-
able to you and how best to use them.
❧ Printing (chapter 26): There are two ways of printing in Scrivener. One op-
erates as an extension of the compile feature itself, and is the preferred way to
print proofs or final submission-ready manuscripts. The second method lets
you print quick one-offs of any file in the binder, print index cards off of a
corkboard, or information from an outliner.
Chapter 23
Table of Contents and E-Books: Both the ePub and Kindle compile export for-
mats have built-in table of contents generators which you should use instead of
the methods described in this section. If you are publishing to an e-book platform
and wish to set up a ToC, please read about the E-Book Options compile pane
(section 24.18).
Note that this feature, while it can be created in any Scrivener project, is mainly
useful in conjunction with the PDF/Printing workflow, and the RTF format when
compiled.
❧ For the ePub format, use the built-in Table of Contents generator, which is
dynamic.
Creating a table of contents is a simple process, but because it is a static list, you
will probably want to save it for one of your final steps, as any changes in outline
order, addition, or removal of sections will not be reflected in the list. The first step
you will need to take is to select, in either the binder or the outliner (you could use
the corkboard as well, but since that only shows one level of depth at a time, it would
be less useful for a large book), all of the items you wish to have represented in the
contents. The easiest way to do this is using the outliner.
1. Select the Draft item in the binder, and change the view mode to outliner
224
225
2. Reset the disclosure states by selecting all ( – A), and pressing LeftArrow.
3. At this point you need to decide what depth you wish to have available in the
ToC. Repeatedly press RightArrow followed by – A until the desired depth is
reached.
5. Select the menu item, Edit � Copy Special � Copy Documents as ToC.
6. Create a new text document in the Binder, near the top of your book, and paste
the ToC data into this file.
Pro Tip: If you need to create a mini-ToC in the preface for each part of a book, as
is common with technical guides, you can follow these instructions to produce a
smaller scale list of sections. You will just want to select the relevant section instead
of the entire Draft, and paste the ToC copy into the preface area for each part.
The resulting list will be formatted with the name of the section on the left, and
a special token on the right, with an amount of indenting applied to each line, in
accordance with its outline depth relative to the highest level item that was copied (if
the portion of the book is at level 3, then a level 5 item will be indented only twice,
not five times). An additional left tab stop will be inserted into each line, allowing
you to make use of a tab in the Scrivener Link prefix compile setting, if you wish to
offset numbering from the standard title.
The token, <$p>, will be calculated and expanded during Compile to produce
page number references. In addition to page numbering, Compile will examine the
final title output and update it in the list, accordingly. In conjunction with counter
tokens in the title, and use of the title suffix and/or prefix, the resulting title could
end up looking completely different from how it appears in the list in Scrivener.
You also can create your own table of contents by hand, if you need custom for-
matting. There is nothing special about the “Copy Documents as ToC” command
that cannot be replicated manually. So if you do not like the default look, you can
either adjust the formatting after pasting, or generate your own from scratch by using
the <$p> token and linking it to the section you wish to reference with Scrivener
Links. The title should be linked as well, if you wish for it to acquire any prefix or
suffix information. Read Scrivener Links (section 9.5) for more information.
Using this feature with PDFs is more portable, since page numbers are baked into
the file and do not rely on features that only a few readers support. However since the
PDFs are generated via the OS X Print Preview feature, they will not have a dedicated
PDF ToC embedded in them, and are thus better for producing a printed copy rather
than a digital PDF with hyperlinks and a ToC.
Some things to watch for:
226 CHAPTER 23. CREATING A TABLE OF CONTENTS
❧ When first opened in Word, you will need to generate the ToC numbers by
running a test print preview once, they will appear as question marks until
doing so. Nisus Writer Pro will format the list correctly as soon as you open it.
❧ The RTF feature requires word processors capable of understanding the RTF
PAGEREF command. Page numbers will appear as question marks in the list
if they do not.
❧ If you are not using title generation in compile, and are instead relying on a
formatted title within the draft text itself, you may find this feature less useful,
and might wish to create your own from scratch using the above tips for doing
so.
❧ The dot fill used between the title and the page number is an OS X text engine
underlining feature which may not be visible in all word processors.
See Also:
❧ Compiling the Draft (chapter 24), Printing and PDFs (subsection 24.2.3)
227
228 CHAPTER 24. COMPILING THE DRAFT
In addition to these global presets, many of the project templates that ship with
Scrivener come with useful compile settings as well, saved into the projects that are
created from those templates. It would not be feasible to make all of these settings
global, as that would clutter up the list of choices, and in some cases these custom
settings are special purpose and require a workflow that is documented within the
template itself. However if you wish to use compile settings found within a template
(such as the one found in the US Screenplay template), you can create a temporary
project with that template, and save its compile settings to your master list, which
will be available from that point onward to all of your projects.
The available built-in presets are:
❧ Original: This is the standard compiler setting. It will preserve your draft as
closely as possible without adding any additional page breaks, titles, formatting
adjustments, and so on. If you have very carefully designed your book from
the start, using the text editor, this might be the best option, or at least the best
starting point.
❧ Enumerated Outline: Only outputs the title for each document, rather than all
of its text. It will use hierarchal numbering, and indenting to indicate the depth
of items according to the structure of your book. It has also been configured
to accommodate synopsis, which you can optionally enable in the Formatting
pane.
❧ Novel (Standard Manuscript Format): Formats your book using standard
Courier 12pt type and a number of common conventions such as scene sepa-
rators, double-spacing, page numbers, and so forth. Note to get the full benefit
of this preset, you will want to use one of the rich text formats, such as RTF.
This preset has been set up to treat folders and top-level files as chapters, with
everything else being treated as sections. You will want to adjust this in the
Formatting pane, if your book structure differs.
❧ Proof Copy: A useful preset for internal proofing prints. It will reformat your
script to double-spacing so you can easily take notes, and print a disclaimer after
each chapter title as well as in the header, making it easy to send out “Not for
distribution” copies to your proofing team. This preset has been set up to treat
folders as chapters and everything else as sections. If your book is organised
differently, you will want to change how things are arranged in the Formatting
pane.
❧ Times 12pt with Bold Folder Titles: The use of 12pt double-spaced Times New
Roman is increasingly becoming the submission standard in certain parts of the
world. This preset will handle most cases, but you’ll want to check with your
publisher for the precise specifications and adjust it accordingly. As with Proof
Copy, it treats folders as chapters and everything else as sections, by default.
24.2. AVAILABLE COMPILE FORMATS 229
❧ Headers/Footers: Page headers and footers; custom first-page settings are not
considered for compatibility.
230 CHAPTER 24. COMPILING THE DRAFT
Supported Features
Application Best Format Comments Footnotes Lists Images Headers/Footers ToC
Microsoft Word RTF X X X X X X
Nisus Writer Pro RTF X X X X X X
OpenOffice.org RTF X X X X
RedleX Mellel RTF X X X X X
Papyrus RTF X X X
Apple Pages RTFD X X
TextEdit (Cocoa Misc.) RTFD X X
❧ ToC: Support for Scrivener’s Table of Contents feature, including RTF Book-
marks. While technically two different features, word processors that support
one will usually support the other, so they have been combined.
❧ Note on RTFD Support: Since the two applications for which RTFD format
is recommended do not support these RTF features anyway, it often better to
use RTFD with them, as they will benefit from a few extra features that would
otherwise be dropped. RTFD will “flatten” some of the features it does not
support, such as annotations and footnotes.
Not included in the table are basic formatting features. Most word processors sup-
port these with only a few exceptions, as listed below (if the word processor is listed
next to the formatting feature, it does not support it):
❧ Custom underline styles (dotted, dashed, etc): Nisus Writer Pro; Papyrus
❧ Kerning: Mellel
Note on Exporting to Word .doc Format: Because RTF is preferred, the Word
.doc exporter uses RTF internally, meaning that .doc files exported from Scrivener
are essentially just renamed RTF files which will open in Word by default. This is
useful when you need to send .doc files to someone who is not aware that Word
fully supports RTF. If you require native .doc support, then you should adjust the
application preferences in the Import & Export tab (section B.9) for “Microsoft
.doc export”. This will force the export process to use Apple’s more basic exporter,
which will produce a native .doc file, but at the expense of dropped features and
altered formatting (in particular, indents and line-spacing will be lost). Only use
24.2. AVAILABLE COMPILE FORMATS 233
this option if you absolutely need native .doc files and RTF does not work with the
target word processor.
2. Open the RTF file in a word processor which can both read RTF well, and
produce a good .doc or .docx file. This limits your choices to Word itself or,
in most cases, OpenOffice.org. You’ll want to be careful with the latter if you
rely on bullet lists, as OOo has difficulty reading RTF bullets, but it is free,
and thus a good solution when you don’t have a lot of lists in your work. RTF
comments will also be dropped using this word processor.
3. Once you’ve produced a .doc or .docx file from one of the above applications,
this can then be opened in Pages. Since Pages does a relatively good job of
opening .doc and .docx files, you’ll have much more success using this method
than trying to use RTF or .doc/x directly from Scrivener.
It can, however, be beneficial to give plain RTF a try first. While Pages doesn’t fully
support the RTF specification, for many authors this won’t be a problem in practice.
With the exception of page breaks, the features it omits are features not often used
in works of fiction, such as images and footnotes. Another option, as recommended
above, is to use RTFD. This will give you images, but no true footnotes (which will
be flattened into pure text endnotes, and so will require further formatting in Pages if
you wish to convert them into real footnotes).
234 CHAPTER 24. COMPILING THE DRAFT
The guidelines below should be followed when exporting to the FCF or TXT for-
mats for use with scriptwriting programs:
To avoid strange characters appearing in the export, the following preferences
should be enabled in the Text Options compile pane:
When using the TXT format, along with the above settings, “Convert indents and
paragraph spacing to plain text” should be enabled when exporting to scriptwriting
programs such as Movie Magic Screenwriter and CeltX. This ensures that they will
recognise the elements correctly, as these programs read the whitespace and use it to
convert the text to the relevant script types.
Read Working with Final Draft 8 (section 20.5) for more detailed information on
both export and import processes with Final Draft 8 and higher.
1. The rule of thumb in which only items within the Draft can be compiled will
be temporarily dismissed. Items placed into a collection from outside of the
Draft will be included in the compile. However, only text and folder items will
be used.
24.4. CONTENTS PANE 237
2. Since collections have no inner hierarchy, the compile will always result in a flat
list of documents. Book parts will be on the same level as sub-sections, to put it
into practical terms. Since the final result will always be a flattened file anyway,
the main thing to note here is that only those formatting stylesheets relating to
Level 1 will apply.
Finally, you can select the “Current Selection” as your content source. This will
use whatever selection has been made in the sidebar (binder or collection). As with
collections, this option will produce a flat list for quick compile. If you wish to use
your selection as a filter against the main list, and thus preserve hierarchy, see below.
same fashion that they are indented within the binder, representing their hierarchy.
If you wish to use Collections but still retain hierarchy, read the next section on
filtering.
There are four columns in this list. It is usually a good idea to briefly scan these
columns to make sure everything will act in the manner you expect it to. On any of
the checkbox columns, you can Option-click the header to toggle checkmarks for all
visible items.
Include Linked to the Inspector option, “Include in Compile”, if unchecked the item
will not be visible in the final product. See below for an exception to this.
Title The visible name of the item in the Binder. This might be altered in subsequent
compile option panes, or updated with a counter if it includes a token.
Page Break Before Linked to the Inspector option, “Page Break Before”.
Inserts a page break control before the checked document. A common usage
for this is to use folders to contain the chapters of your book.
In the lower-right corner (marked as 3) is an override which can reverse the settings
of the “Include in Draft” checkmark. By default, the behaviour follows the logic of
the document settings. You can however inverse the logic and only export those items
marked to not be exported—or just ignore the flags altogether and export everything.
24.4.2 Filtering
Filtering is an advanced feature, marked as 41 which uses the selected contents list
above and applies additional criteria to filter the list down further. This works in a
similar manner to searching for items: only those items which match the criteria will
be included in the compile.
As with the content drop-down menu, the changes you make here will impact what
you can see in the list. If when you first load up compile and are puzzled by an empty
list, check the Filter options and make sure nothing has been left set there from a
prior session.
Filters can be defined in two ways, set with the first drop-down menu:
1
compile-contents.png
24.4. CONTENTS PANE 239
❧ Include: Everything matching the rest of the filter will be included in the com-
pile, non-matching items will be removed. This is the default setting.
The second drop-down specifies which attribute you wish to filter by. There are
three options:
❧ Documents with label: documents matching the Label specified in the third
drop-down menu will be matched and handled according to the logic in the
first drop-down menu. This is the default setting.
❧ Documents with status: as above, only using the Status meta-data field instead of
the Label field.
❧ Documents in collection: will provide a list of available Collections for you in the
third drop-down. Items found in that collection will be included or excluded
depending on the setting in the first drop-down.
❧ Current selection: as with the content selection item, this will use the current
selection that has been made in the sidebar, prior to opening the compile in-
terface. However, instead of producing a flat-list, the selection will be used as
a filter, based on the above logic of include or exclude, and thus preserving the
original structure. Since this method has no optional behaviour, the third selec-
tion drop-down will be removed.
not only have the scenes from the PoV of the other character been selected, but all of
the items with no label set at all.
The manner in which the status meta-data filter works is identical to the label meta-
data, so we will move on to the next example.
24.5 Formatting
The Formatting pane is where you will design the look and structure of your docu-
ment. It is separated into two main areas, each of which we will gradually introduce:
1. Structure and Content Table: A table for assigning content to the various Binder
item types available, and the creation of level specific content and formatting
rules.
In the supplied example (Figure 24.3), the manuscript will print all folder titles
(including any text within that folder item itself), and only text for file groups and
files. It will also override the formatting to Courier 12pt, with a large right margin
for writing notes down by hand, and adds extra information to the folder titles, one
of which warns readers that they are holding a proof copy. All of this might seem
like black magic right now, even if it gives you a taste of what the compiler is capable
of, so let’s take a look at the provided features. By the time you are done with this
section, you should be able to see how all of this fits together, and in no time you’ll
be designing your own documents.
include from your project, for each item in the Draft. As Scrivener proceeds down the
list of items it has been set up to compile, it will consult this table for instructions on
how to handle it. If that item is a folder, it will look at the folder row and if “Title” and
“Text” have been checked, will add the binder title for that item into the manuscript,
followed by any text that is in that folder file. If the next item is a text file, it checks
the text file row. If that row says only “Text” is exported, then it will print just the
text content of that file into the manuscript.
Using these checkboxes you can control the flow of information and produce a
manuscript to your requirements. Creative use of this feature can produce outlines
(Titles only for all types), a document with only your notes and no manuscript text,
chapter break items that do not export their text, and so forth. Note that as you
toggle elements on and off, you’ll see a live preview of how they will be inserted into
the compile, in the Formatting Editor below the table. We’ll get into how to change
the look and feel of this in the next section.
Pro Tips: You can enable (or disable) elements for all rows by Option-clicking on
any of the checkboxes. If you want to apply settings to only certain rows, you can
use the standard Copy and Paste functions to copy settings from one row and paste
them into another. This action will also paste any custom formatting settings as
well.
Things get more interesting when these rules are applied to levels of hierarchy.
This ability is best demonstrated with an example. Try selecting the Folder row in
244 CHAPTER 24. COMPILING THE DRAFT
the table, and then click the “Add formatting level” button, indicated with an arrow
(Figure 24.4). The label for the row that was previously selected will now be titled,
“Level 1”, and the new indented folder row will be called “Level 2+”. As you might
guess, this means you now have two rules for handling folders. The first rule will
apply to level one folders only, the second rule will apply to level two folders, and
anything deeper in the hierarchy than that. Note that when you do this, any config-
uration from the original row will be carried over into the new row to help you get
started in customising it. This holds true for formatting as well as the options we’ve
already discussed.
What do these levels correspond with? They are matched with outliner depth in
your binder. An example binder structure has been inset in the example, with the
items named to indicate how they correlate to “levels” in the Formatting pane. Items
directly beneath the Draft are considered to be “Level 1”, a child item beneath one of
those is “Level 2” and so on. The way Scrivener’s formatting engine works is by apply
a format to the maximum depth in your draft outline. Inserting rules will thus only
apply to those levels which it states in the label. In the provided example, I’ve added
a checkbox to insert Meta-Data (creation and modification dates, labels, and so forth)
to any folders at level two or deeper. Folders directly descended from the Draft will
only print their titles in the compiled document, but all folders at level two or greater
will also print their meta-data.
To remove a level-based row, you can select it and click the - button to the right of
the “Add formatting level” button.
There are other buttons and options in this table, but before we take a look at them,
let’s examine the formatting editor.
the manuscript. You can otherwise treat it just like an ordinary editor. If you click in
the “Title” area, you should see the formatting controls adjust to represent whatever
formatting has been applied to the title. Try clicking the Underline button. Unlike
with standard text, you are editing “areas” of text, so there is no need to select the en-
tire title, you can just place your cursor anywhere within the title and click Underline.
Refer to the documentation on using the The Format Bar (subsection 14.4.2) if you
are unsure of what these various buttons do.
RTF Bookmarks: When using the RTF export format, you will see an option
next to the prefix and suffix called “Include in RTF Bookmarks”. By default, ev-
ery section in your binder will get an RTF bookmark, which will create a handy
navigational reference in compliant word processors, and is also used to cross-
reference links in Scrivener’s table of contents feature (chapter 23). It may not
always be desirable to have bookmarks at every level of your outline, especially if
you use Scrivener’s outline feature to break down your book to small blocks. Sim-
ple uncheck this to remove the document type and level from the bookmarking
feature. If you do this, you will be unable to link to this level of document in the
ToC, or when using the linked <$p> feature for cross-referencing by page number.
Click the purple “Help” button in this sheet for some useful examples of title pre-
fixes and suffixes.
For MultiMarkdown users, by default, the title prefix and suffix will be placed
within the hash marks that Scrivener generates to indicate title depth. If you prefer,
you can disable the Place prefix � suffix inside hashes options to allow text entry out-
side of the header line itself. Note that to allow compatibility with the other compile
formats, you will need to manually type in carriage returns to separate lines. Placing
characters before or after the hashmarks on a title line will at best cause it to no longer
render as a title correctly.
One important thing to consider is that the title prefix and suffix entries will be
printed even if Titles are disabled for that row. This can prove very useful in some
cases. It could for example let you use casual titles in the binder, and standard generic
titles in the manuscript.
246 CHAPTER 24. COMPILING THE DRAFT
Formatting for the prefix and suffix can be handled independently. It is possible
to have three different styles affixed to each of the three components: prefix + title
+ suffix. If you wish to maintain a uniform look, use the mouse to select all of the
visible title elements before styling.
The Page padding control to the right of the Title Prefix & Suffix button controls
how much padding will be added to the top of the page, if it happens to fall on a page
break. Use this to offset your titles from the top of the printable margins if you prefer
that look. This option will not be previewed in the formatting editor.
Selective Opt-Out: You can always set specific parts of the Draft to ignore all for-
matting, no matter what settings you choose in the compiler, by using the Compile
As-Is Inspector option. Note that this will even ignore selected elements from the
structure table. Only the text of such items will be output (even if it otherwise
would not output text), and it will be output precisely as shown in the main editor.
While there is no formatting to override in the MultiMarkdown workflow, this
option will still inhibit the generation of automatic titling, even if the document
would otherwise be titled by the compiler.
Insert subtitles between text elements When either Synopsis or Notes elements
are enabled, Scrivener will insert a subtitle to help set apart these sections from
the main text, which will also be titled. These titles can be formatted like ev-
erything else in the formatting editor.
Place notes after main text The default is to place any Inspector notes above the
main text for the item being compiled. When checked, notes will be placed
below the main text area instead.
The Text Override Formatting Options section of this sheet lets you specify
just how much formatting should be changed in the source documents. Note that
if you use these, any applicable styling you’ve done in the formatting editor will be
ignored. If you set the option to preserve line-spacing, then adding double-spacing in
the formatting editor will do nothing.
❧ Override font only: If all you want to change is the base font family, checking off
this box will disable the other options and inhibit the compiler from changing
alignment and ruler styles.
24.6. PROCESSING OPTIONS 247
❧ Preserve alignment: Left, centre, right, and full justification settings will be pre-
served throughout the manuscript.
❧ Preserve tabs and indents: Actual tab characters will always be preserved. This
option merely inhibits the compiler from changing the ruler based tab stops
and indent markers. If you use blockquote indenting in your book and wish to
retain that formatting globally, use this option.
❧ Preserve line spacing: All of the spacing options, including paragraph spacing,
will be left alone.
❧ Remove first paragraph indents: When checked will use the common typeset-
ting standard which only indents paragraphs subsequent to the first paragraph,
relieving you of the burden of having to do that by hand throughout your
manuscript.
❧ On new pages only: Narrows the above option down so that it only applies to
first paragraphs following a page break.
The Preserve Formatting only preserves section adjusts how the For-
mat � Formatting � Preserve Formattingfeature works (subsection 14.4.5). By default
this feature will block all compile attempts to change formatting within the range
of text it has been applied to. Using these options, you can selectively weaken that
feature to allow some types of formatting to be overridden anyway:
❧ Alignment: Left, centre, right, and full justification will be passed through to
the preserved block.
❧ Tabs and indents: Tab stops and ruler indents will not be preserved in the block.
❧ Font size: The size of the font will be made uniform with the text around it, but
not the font family.
Compile ignoring levels outside of the current compile group This becomes use-
ful when the compile group has been set to anything other than the Draft. Or-
dinarily when a portion of the Draft is selected for compile, the formatting
treatment and counter numbering will be displayed as though the rest of the
manuscript existed. When this option is enabled, the smaller section of the
Draft will be treated as though it were the entire manuscript. Counters will
248 CHAPTER 24. COMPILING THE DRAFT
start at 1, and the immediate children of the items of the selected compile group
container will be treated as level 1 items in terms of formatting styles.
This option is disabled when compiling Collections, or when the entire Draft
has been selected, as neither of these compile methods are relevant to external
numbering.
Ignore Title Prefix and Suffix For. . . Specific documents can be set to ignore the
prefix and suffix settings, enabled in the Formatting pane (section 24.5). Com-
mon examples would be the Table of Contents, Acknowledgements, and vari-
ous Appendices. Note that the Inspector option, “Compile As-Is” can also be
used to inhibit title prefix and suffix on a per-document basis, but also at the
expense of dropping the title itself.
and carriage returns, these will be stripped out of the result. Consequently you
may wish to provide a separator using the Title prefix separator for inline
links. The value placed into this field will be inserted between the title and
the prefix, in replacement of whatever punctuation and special characters were
used in the title prefix.
First document is title page If the first document in your current compile group is
a special title page with no script formatting, leave this option enabled. It will
be assigned to Final Draft’s title page window, and kept separate from the script
itself. If you’ve noticed the first page of your script seems to be missing, and
you aren’t using a title page, make sure this option is disabled.
Break dialogue and action at sentences Use this option to adhere to the standard
of keeping action and dialogue sentences together, rather than breaking them
up between pages. If a sentence would have ordinarily been split, it will instead
be moved entirely to the following page.
Include revision colors from Preferences Your preferred revision colours, which
can be set in the Appearance preference pane, will be supplied to Final Draft’s
revision palette, maintaining a consistent revision system between the two ap-
plications.
Compile ignoring levels outside the current compile group Please read the prior
section for a full description on what this feature does.
Use default Final Draft screenplay elements By default, when using the “screen-
play” script format, Scrivener’s output will match that of the industry standards
used by Final Draft. However if you’ve made changes for your own aesthetic
tastes, or are unsure of the formatting in general, you can check this option off
to remove Scrivener’s formatting instructions and have Final Draft handle all
of the formatting. This could result in a compile that looks different than what
you’ve been writing, but in most cases there will be no visible change. Natu-
rally, if you require a script format that doesn’t conform to the standard screen-
play, make this this option is unchecked, or you will lose all of your custom
formatting in the compile (Scrivener’s copy will of course remain untouched).
250 CHAPTER 24. COMPILING THE DRAFT
Include footnotes as script notes Inline and linked footnotes will be converted to
Final Draft’s script notes feature. Footnotes will be removed from the compiled
document if this option is not enabled.
Include comments and annotations as script notes Inline annotations and linked
comments will be converted to Final Draft’s script notes feature. All commen-
tation will be removed from the compiled document if this option is not en-
abled.
The final two options allow you to set fonts for the indicated features within Final
Draft. Do note that if you intend to share the FDX file with Windows colleagues, you
may wish to change the default Summaries font to Helvetica, Arial, or something else
that is commonly available.
The Script Settings pane is only available to the Final Draft (FDX) format.
24.8. SEPARATORS 251
24.8 Separators
Separators are used to automatically insert space, breaks, or custom symbols between
the various elements in the list which will be compiled. The important aspect to note
is that by the time Compile gets to this point, your document is being considered as
a flat list of files. It doesn’t matter if a text file is four layers deep, if the next item in
the list is a folder, it will still use the Text and Folder Separator rule.
There are four types of possible combinations in a compile, and each has its own
rule. You can supply the same rule for all of them if you do not need any special
differences between types. The types are:
❧ Folder and text separator: inserted at the top of any file that directly follows a
folder
❧ Text and folder separator: inserted at the top of any folder that directly follows a
text file
Each individual rule has four options, some of which change their behaviour de-
pending on the compile format. Most of the options are as follows:
❧ Single return: A single paragraph break will be inserted, causing the final ap-
pearance to run from one document to the next with no visible “seam”.
❧ Empty line: Two paragraph breaks will be inserted, causing a visible space be-
tween the items
❧ Page break: A page break character2 will be inserted, causing the next section to
move to the next page of the manuscript
❧ Custom: Anything entered into the adjacent text field will be placed between
the two items. Note that the text or symbols entered here will be buffered by
a single return on each side, forcing it to fall on its own line. The value will be
centre aligned.
The following formats have different options and behaviours from those listed
above:
2
In the case of plain-text files, the Unicode break character will be used. While support for this is
not common, the character can still be useful as a search-and-replace anchor. TextEdit will treat this
character appropriately when the file is viewed in Page Wrap mode.In the case of plain-text files, the
Unicode break character will be used. While support for this is not common, the character can still be
useful as a search-and-replace anchor. TextEdit will treat this character appropriately when the file is
viewed in Page Wrap mode.
252 CHAPTER 24. COMPILING THE DRAFT
HTML, WebArchive, and ePub formats The “single return” and “empty line” op-
tions will be replaced by suitable alternatives to produce the same appearance
of actual paragraph breaks.
Since page breaks have no meaning in Web publishing, a horizontal rule will be
inserted. The option will be renamed to “Section break”.
MultiMarkdown, and MMD HTML formats In most cases the “empty line” op-
tion should be used to retain clean paragraph breaks between blocks. The “sin-
gle line” type will cause the last paragraph of one section to flow directly into
the next paragraph of the next section.
Page breaks are replaced by “section breaks”, which emit a series of hyphens on
their own line. This will be converted to a horizontal rule using the HTML
converter.
MultiMarkdown LATEXformat As with the other MMD formats, use of the “empty
line” type will produce the best result in most cases.
The LATEXcode for a pagebreak, \pagebreak, will be inserted for the “page
break” option. Note that this will be enclosed in an HTML comment, which
is the preferred method for passing LATEXcodes straight through the MMD sys-
tem. This ability is disabled by default, and will need to be enabled by hand in
the MMD sub-system (chapter 22).
The Separators pane is available to all formats except FCF and FDX.
Convert ellipses to triple periods The ‘. . . ’ character will be converted to three full
stops.
Convert indents and paragraph spacing to plain text Actual spaces and carriage
returns will be inserted into the document to emulate indents and paragraph
spacing (line spacing will be ignored). This function determines spacing by
rounding off the supplied value. If the base font is 12pt, and paragraph spac-
ing is set to 28pt (factor of 2.3) will be converted to two empty lines between
paragraphs.
This option is not relevant to the FDX and FCF formats, and will be removed
from the pane when they are selected.
Convert underlines to italics Use when you have produced a document with un-
derlines, but need an italic version for compile.
This option is not available to any formats which produce a plain-text docu-
ment.
Convert linked images to embedded images If you have used linked images in
your project text, use of this function will find the original resources and embed
them directly into the compiled document. You will nearly always want to use
this option when producing a file that will be sent to other people.
See also: Linked Inline Images (section 14.4.6).
Only available with the RTFD format.
254 CHAPTER 24. COMPILING THE DRAFT
Use hyphenation By default, hyphenation will not be used. When full justification
is in use, this option can substantially improve the compiled result. If you in-
tend to use a word processor to handle the compiled file, it is often better to let
it handle hyphenation.
Only available to RTF, Printing/PDF, and the word processor formats.
Avoid widows and orphans When used with a compatible word processor, this will
enable widow and orphan protection for your paragraphs.
Only available with the RTF format, and the DOC format when Import &
Export preferences have been set to export DOC files as RTF-based documents.
Convert Scrivener links to HTML links When enabled, Scrivener will insert the
necessary HTML framework to allow for links to cross-reference to internal
parts of the Scrivener outline. If the linked element is outside of the scope of the
current compile group, the link will be removed from the compiled document,
rather than produce a broken link.
Footnotes will always use internal links to cross-reference from the marker to
the footnote text.
Underline internal links By default, Scrivener links are styled so that they are not
underlined in the web page. If you wish underlining to be retained, use this
option to disable the stylesheet.
Use centered table to restrict body text width The entire document will be en-
closed in a div which will keep the width of the document within a certain limit
24.11. META-DATA 255
and centred in the browser. The precise width can be specified in the provided
text field, using pixels.
This option is not available to the e-Book formats.
If you wish to adjust the HTML DocType specifications for exported HTML files,
the technical details for how CSS is included (or not), and whether or not most ruler
styles will be converted to style, see the Import & Export preference pane.
24.11 Meta-Data
Meta-data is used to add properties to your manuscript, which many applications
will display in a document properties viewer, and with some formats, will be used to
add searchable criteria to the Spotlight database. There are three primary meta-data
interfaces available to different formats. The general meta-data interface will appear
for all formats which support the standard set of property fields, such as RTF &
RTFD, the word processor formats, and HTML & WebArchive. The other two meta-
data panes will only appear along with the specific formats they have been tailored for,
MultiMarkdown and ePub.
Since, with the exception of MultiMarkdown, meta-data is not meant to appear in
the content of the manuscript itself, none of the plain-text formats, or any formats
that do not support auxiliary properties, will show the Meta-Data pane.
24.11.1 General
With the exception of the Keywords field, the provided fields are all free-form, though
keep in mind that in some cases, like Spotlight searching, the content for the field
should match its intended purpose in order to keep searches logical. The Keywords
field takes values separated by commas, which will be shown as “pills” in the interface
as you enter them.
The Background field will let you set a paper colour for the manuscript. This is, by
and large, ignored by most word processors, and is primarily useful for the HTML
and WebArchive formats.
24.11.2 MMD
The Meta-Data pane for MultiMarkdown compilations provides a front-end to the
preliminary meta-data block at the top of any MMD file. A few examples are inserted
into new projects by default. Note that what you type into the text area below the
field will be printed into the compiled document verbatim. Thus, all rules pertaining
to the meta-data syntax should be followed. Empty lines in this area will cause the
meta-data block to prematurely abort, and special characters should be converted to
256 CHAPTER 24. COMPILING THE DRAFT
HTML entities. Scrivener will automatically insert the Format: complete meta-data
field for you, so there is no need to specify that by hand.
This interface, being project-based, is useful for creating a general meta-data block.
If your project is actually comprised of multiple documents, or if you simply prefer
to type in the meta-data block by hand, you can use documents titled “Meta-Data”
in the binder. Whenever a document so titled is the first document in the included
compile group, it will be appended to the meta-data provided in this pane. Due to
the rules of how meta-data is parsed, duplication is okay. Whatever field is stated last
will override any prior declarations. Thus a Title value in the compile pane will be
overridden by any Title fields declared in Meta-Data documents in the binder.
When using this method, the Format: complete code will not be automatically
inserted. Be sure to add it yourself if you require it. For further information on the
available MultiMarkdown meta-data fields, refer to the online documentation3 .
24.11. META-DATA 257
24.11.3 ePub
Use of the ePub meta-data pane is similar to the general meta-data pane in that most
of the fields are free-form. They will be inserted into the appropriate book descrip-
tion fields, which will be available to e-readers to display in whatever manner they
provide. Most of the simpler e-readers, such as those embedded into specific purpose
devices, will only use Title and Author, but many desktop readers such as Adobe
Digital Editions and Calibre will make use of as much meta-data as you can throw at
it.
The two fields which you will want to be more careful with are Language Code,
and the custom unique identifier. Make sure you use the correct ISO two-letter ab-
breviation for the language the book is written in. If you do not wish to provide a
custom identifier, Scrivener will generate one for you based on the author, title, and
date. If your publisher has provided a unique identifier for you, then you can check
the box and type in your own.
3
http://fletcherpenney.net/multimarkdown/users_guide/multimarkdown_syntax_guide/
258 CHAPTER 24. COMPILING THE DRAFT
Columns Columns will reformat your exported manuscript into a specified number
of columns. As with all compile features, this will have no impact on your
visual draft, while writing and editing, and only modify the appearance of the
final product once exported. To enable the use of columns, check the “Use
columns” box.
The number of columns can be adjusted with the appropriate drop-down menu.
Any value between two and four can be selected. You may also adjust how
much padding will be used to space the columns apart from one another, from
1/8th of an inch to 3/4.
24.13. STATISTICS 259
Scrivener’s default RTF exporter supports features that some other products and
free editors do not recognise. In a worst case scenario, this can result in files which
do not correctly load at all, display only a part of the content, or at the least omit the
parts they do not understand. The following options can fine-tune the RTF file you
create, so to better increase its compatibility at the expense of formatting.
Strip tables from text Use this feature when tables are causing the RTF file to ren-
der incorrectly in the target word processor
The contents of the tables themselves will not be removed, but the table code
itself will be. This results in a block of text that “flattens” the table contents into
a long list. Generally you will not want to use this unless the target application
completely fails to render tables.
Flatten footnotes and comments into regular text Use this feature when the tar-
get word processor fails to properly display footnotes and/or comments.
When enabled, all footnotes and comments will be converted to normal text,
rather than using RTF codes to insert them. Since the notion of a footnote
requires pagination to place the footnote at the bottom of the page, the end
result is that all footnotes will be exported as endnotes. Reference markers
will be inserted into the text using standard punctuation to do so. Note that
this feature modifies the existing behaviour of your compile settings. If you
have opted to strip out all comments, checking this box will not override that,
they will remain excluded. It only modifies how the feature is exported, if it is
scheduled to do so.
Use Word-compatible indents for bullets and numbered lists Use this option
when working with Microsoft Word.
Word uses a different mechanism for displaying indents in enumeration and
bullet style lists. This option will attempt to preserve as closely as possible the
look and feel of your original document. If you are not using Word, and you
are getting erratically formatted lists, try disabling this option.
24.13 Statistics
When using special placeholder tags which expand to display various statistics about
the project, the options in this pane will allow you to fine-tune how they work.
Word and character counting placeholder tags can be inserted anywhere in your
project, and in multiple places. For a complete list of available codes, either view
the help sheet for placeholder tags in the Help menu, or experiment with the various
options available in the Edit � Insert � sub-menu.
260 CHAPTER 24. COMPILING THE DRAFT
Word and character counts include all text This is the default behaviour. Any text
that is set to be compiled as a part of your manuscript will be included in the
word/character count. This means that if you enable Notes export in the For-
matting pane (section 24.5), the note text will be added to the global count as
well.
Word and character counts include To adjust the scope of the counter, enable this
option and then select from the following list of inclusive options. A check-
mark next to the type of content means that it will be included in the total
count. Counting filters will not impact what gets compiled, but only what out
of that compile gets counted.
❧ Main text
❧ Notes
❧ Synopses
❧ Only documents matching criteria. This option functions in a manner
identical to the global content filtering option (subsection 24.4.2). Read
the section on this feature for full documentation on how to use counting
filters.
Count footnotes; Count comments and annotations Footnotes and endnotes will
be included in the total count; this is the default
Likewise if enabled, comments and annotations will be included in the count
Do not count spaces in character count Enable this option if you require strict
character counts, including all spaces between words, as well as the words, in
the document. If you are unsure, check with your publisher for which standard
they use.
24.14 Replacements
Replacements are a way for you to set up your own substitutions, which works in a
manner very similar to Search and Replace, though without changing the underlying
documents in Scrivener. A table with three columns has been provided:
❧ Replace: The text which you wish to instruct the compiler to look for.
❧ With: Whatever has been supplied in the Replace column will be replaced with
what you type into this column.
24.14. REPLACEMENTS 261
❧ Case-Sensitive?: When checked, the letter case in the Replace column must pre-
cisely match, otherwise it will be ignored by the compiler.
Some example usages would be to replace an abbreviated version with a full proper
name, to make typing it in freqently easier, or inserting common editing notes.
❧ These sequences will be replaced wherever they occur. You shouldn’t choose
replacements that might fall within other words in typical usage.
❧ If you wish to make sure a replacement is always an isolated word, put spaces
around the letters in the “Replace” column.
^$@^
262 CHAPTER 24. COMPILING THE DRAFT
Replaced with:
<span class="index">$@</span>
Will take the following example text from your compiled document:
You can place the $@ tag in multiple places within the with-column expansion. An
example that would be useful for LATEXusers would take the above expansion token,
but change the Replace With value to:
\idx{$@}$@
24.15 Footnotes/Comments
The Footnotes and Comments pane controls how these two forms of notation will
be handled in the compile process, or whether they should even appear at all. Since
there are two ways to add notes to documents (linked or inline notes), it is possible
to treat the four of them differently, with most formats. As with other areas of the
application and documentation, the usage of the term “footnote” is equally applicable
to “endnote”, if the options to use endnotes have been applied.
The first section concerns itself with how footnotes should be arranged in the
manuscript, and the second section deals with inline annotations and linked com-
ments. Since not all of the available export formats support all available options,
some variants of the pane will appear differently than shown (Figure 24.10).
This option pane is a core feature available to all export formats except for FDX
and FCF.
24.15. FOOTNOTES/COMMENTS 263
Remove footnotes The exported manuscript will have all footnotes (inline or
linked) stripped from it. When this option is enabled, the rest of the footnote
section will be disabled.
264 CHAPTER 24. COMPILING THE DRAFT
Include footnotes in word and character counts This will impact only counters
which have been inserted into the document, such as <$wc>, which prints the
precise word count of the project. It does not impact the rest of the interface,
such as project statistics and targets.
Export inspector footnotes as endnotes When enabled, this will export all linked
inspector footnotes as endnotes. If the next option is not set as well, this will
require using a word process that can handle both endnotes and footnotes in the
same document.
Export inline footnotes as endnotes Similar to above, but only exports inline foot-
notes as endnotes. If you only wish one type of notation to be used in your
manuscript, make sure to check both of these options one way or the other.
Footnote format Using the drop-down menu, you can select how footnotes should
be numbered in the final manuscript. For formats which support real footnotes,
this will set an instruction in the manuscript file which word processors need
to read and understand in order for the setting to have an effect. For formats
which do not support footnotes (such as RTFD and TXT), this option will
impact how Scrivener numbers items itself, as it creates plain-text footnotes.
Endnote format All of the notes above pertain to endnote numbering as well. If
you document has both footnotes and endnotes, Scrivener will set two different
numbering hints within the manuscript file; it is up to the word processor to
handle them correctly.
Override font If you wish to use a separate font to print footnotes, this can be set
here. Note that many word processors have their own special stylesheets for
handling footnote appearance, so this option may not always be necessary.
Group footnotes before page breaks This feature is available to most formats that
cannot generate true footnotes, but still support some form of page break. It
will toggle the default behaviour whereby all footnotes are attached to the very
end of the manuscript, and will instead insert them at the nearest subsequent
page break, becoming in most cases, chapter-based endnotes.
for references to source material. It might then be useful for collaborators to see the
source material references, but not the simple inline editing comments.
Most of the compile formats have the same options available, but will handle the ex-
port of annotations and comments in different ways, depending on what is supported
within that format.
❧ Other rich text and word processor formats: In all of the formats that support the
ability to set font colours, annotations and comments will be inserted as actual
text in the document, enclosed in square brackets, and then coloured according
to the annotation text colour, or linked comment background colour, in the
project. For the purposes of this definition, HTML, WebArchive, and ePub are
considered “rich text”.
❧ Text based formats: For formats, like plain-text, FCF, and MultiMarkdown
(when the HTML method is disabled), annotations and comments will be sim-
ply wrapped in square brackets and placed into the text where they originally
appeared in the project.
Remove inspector comments Only inspector comments will be stripped from the
resulting manuscript.
Remove inline annotations Only inline annotations will be stripped from the text.
If you wish for all comments to be removed from the manuscript, make sure
both this and the above options are checked.
Include in character and word counts As with the analogous option above, for
footnotes, when checked this will include the text in all comments and anno-
tations in any word count and character count tokens that are placed into the
manuscript. Also as with the footnotes option, this will have no impact on the
other counting features in the application.
Export to RTF as Several options are available for handling all annotations and com-
ments.
This drop-down menu is only available to RTF, and the DOC format when
export preferences have been set to use RTF internally with the DOC format
(this is the default).
4
So long as the DOC format has been set to use RTF internally (section B.9).
266 CHAPTER 24. COMPILING THE DRAFT
❧ Margin comments: When using a word processor that can read RTF com-
ments, it is most often a good idea to use this option, as comments will be
placed out of the way and not be regarded as part of the actual text.
❧ Inline comments: If comments are not showing up for you using the above
option, this method will produce comments using the method described
above for other rich text formats. This method is the safest to use, but will
embed the content of comments directly into the manuscript text, and is
thus only useful for proofing scenarios and scattered other workflows.
❧ Footnotes: All annotations and comments will be inserted into the foot-
note stream along with any other footnotes (if any exist). This option
shouldn’t be used unless it doesn’t matter if commentary and footnotes
comingle. For purposes of ordering, they will be inserted into the stream
relative to the position of the footnotes/endnotes around them.
❧ Endnotes: This works the same as with footnotes, only they will be in-
serted into the endnote stream.
engine, the result will be a range of text coloured with whatever colour the
annotation text or comment background was set to. The appearance, sans the
bubble around the text, will thus be identical.
When this option is disabled, annotations and linked comments will be ex-
ported in the same fashion they are for plain-text files; enclosed in brackets.
TIPBOX: Pro Tip: In cases where an annotation falls entirely on its own para-
graph, Scrivener will use a styled <div> instead of a styled <span> to wrap the com-
ment in. This means you can use complex MultiMarkdown within annotations that
are on their own. Annotations embedded within a paragraph of otherwise normal
text, in any way, will use spans in order to preserve the original document flow, and
thus cannot contain complex syntax. They can however utilise inline formatting such
as bold, italic, footnotes, and so forth.
268 CHAPTER 24. COMPILING THE DRAFT
Use project Page Setup settings The project’s Page Setup settings ( – P) will be
used to determine the paper size and printable area. The rest of the page setup
interface in the compiler will be disabled when this option is engaged.
Page Setup button Here you can set the physical size of the page and other basic
printer settings, just as in the standard Page Setup... feature. Refer to Printing
(chapter 26) for further documentation on how to use these features.
The Page Settings button will not be available for the FDX format, as it does
not store paper size in the document.
Margins Margins set how far from the edge of the paper stock the text container will
extend to. This measurement does not include the non-printable area, which is
printer specific, so when using very low values it is a good idea to check how
close to the edge of the paper your printer can go, to avoid truncating the text.
RTFD, DOCX, and ODT format cannot access the following controls, as their
exporters or formats do not support headers and footers. Additionally, if the DOC
format has been set to use the standard OS X .doc exporter, it will not have access to
these controls.
The header and footer area is divided into two tabs, the first tab “Headers/Footers”
will control these settings for the entire document. The second tab, “Options”
will control how the first page is considered for page counting and secondary
header/footer settings.
Each line has three fields which allow you to enter different information at three
different points of alignment: left, centre, and right, respectively. It is possible to have
all three in use at once, or only one or two. Scrivener does not support recto/verso
page treatment. Consult your word processor for setting this up after compiling.
The tab titled, “Options” contains an identical set of fields for header and footer,
which, if the Different first page header/footer option is checked, will allow you to
supply an alternate header and/or footer for the first page. Leave these fields blank to
produce no headers or footers on the first page.
Page numbers count first page This option will cause the page counter token to
start counting at the first page, rather than skipping it. If you are not including
a title page in your manuscript, this option may be useful.
24.17. COVER 269
Formatting can be done in these fields using mark-up. You can choose between
using simple BBCode, or Markdown, to indicate bold, underscore and italic ranges.
Examples have been provided in the placeholder text for these fields. You can also use
tokens in the header and footer fields, some of which are only available to these fields.
Token Description
Available to Header and Footer fields
<$compilegroup> The current compile group. If you wish for this
to be more descriptive than “Draft”, you can
change the name of the Draft in the Binder to
be the name of your book.
<$surname> The surname from the current user’s Address
Book entry.
<$username> The full name from the current user’s Address
Book entry.
Some useful global replacement tokens
<$p> Prints the current page number
<$pagecount> The total page count for the entire manuscript.
This is a static number that is primarily use-
ful in conjunction with the page number to-
ken. A value of “<$p> / <$pagecount>”, will
produce, “73 / 258” on page 73 of a 258 page
manuscript.
<$shortdate> The current date, according to the system short
date settings.
<$mediumdate> As above, using the system medium date settings.
<$longdate> As above, using the system medium date settings.
The three tokens (Table 24.2) listed as available only to headers and footers only,
have an alternate usage whereby if the token name is typed in using all-caps, the final
result will be transformed to all-caps as well. For example, if the title of the Draft
folder is “My Novel”, and the token MANUAL is used in the header, it will be printed
as, “MY NOVEL” in the manuscript.
24.17 Cover
Available only to the ePub and Kindle exporters, the Cover pane sets various options
and material which will give your e-book a professional finish. The cover image will
be placed at the very beginning of the e-book (opposing the table of contents), and for
ePub files, can optionally be included as the thumbnail image that will appear when
the book is viewed on the “shelf” in the iTunes library and within iBooks mobile.
270 CHAPTER 24. COMPILING THE DRAFT
Very likely you’ve been provided with images from a designer that was assigned
to illustrate your work. They may not provide you with the file sizes necessary for
e-books, since this is still a new market. Graphics for cover art should be in a standard
RGB raster format, such as PNG, and not a vector format, such as EPS, or CMYK
which is designed for printing. For dimensions, there is no firm rule, but a size of
roughly 800 pixels tall by 600 pixels wide at 72 DPI will display crisply on nearly
all reading devices and computer screens. If you are unsure of how to make these
adjustments to the files you have been provided with, you should contact your graphic
designer with these specifications so that they can deliver a quality version to you at
the correct size.
In particular, watch out for very large files that were originally designed for full
colour press. These will unnecessarily bloat the size of your e-book, make it difficult
to send out proof copies via e-mail, and could even cause your e-book reader device
to run out of memory.
Cover Image Cover images can be selected from resources within the current
project. If you have a cover that you wish to use with your book, make sure
24.17. COVER 271
you have imported into the binder first. All images will be listed in this drop-
down menu, and will displayed in the grey preview area in the middle of the
pane once selected.
There are no hard and fast rules for image size and aspect ratio. Within iBooks,
the book shape will be determined by the cover art. If you give the compiler
a wide design, the book will appear like a wide format coffee table book in
the shelf, for example. Generally speaking, a design which is taller is better
suited for most devices, which present pages in a standard aspect ratio familiar
to paperback and hardback publishing.
Include iTunes cover art file for iBooks (ePub option) Once a cover image has
been selected, this option will be made available. It will include additional infor-
mation that iTunes needs to set the shelf cover art in iBooks. In most cases you
should keep this enabled, but if the book fails to load properly in your reader,
you could try disabling this.
Cover page title (ePub option) You should not supply the name of your book here.
This is what will be used in the table of contents internally. The standard
“Cover” has been provided as a default.
And typically going to the very end of the XML file. Pasting the entire XML file
will likely produce an invalid e-book.
272 CHAPTER 24. COMPILING THE DRAFT
An iTunes compatible cover graphic will not be produced when using SVG covers.
Center body text of HTML table of contents Will centre all of the titles rather
than left aligning them.
HTML table of contents title If you have created your own table of contents page
using Scrivener Links (also check HTML Options (section 24.10) and make sure
they are enabled) you can specify the document title (as seen in the binder) for
that file, here. This sets a special flag so it can be navigated to with the reader’s
navigation features. It will otherwise appear as an ordinary part of the book.
termine the final appearance in the e-book. Knowledge of the Cascading Style Sheet
syntax will be required to effectively customise the look and feel.
Click the Customize CSS... button, and you will be presented with a text field where
you can edit the CSS. Each script element will be provided with a separate class. Ele-
ment names which are composed of two or more words will use the so-called “camel-
Case” which involves removing all spacing and capitalising each new word but not the
first one. An example would be “Scene Heading”, which would map to a class name
of “sceneHeading”. Single-word element names are simply addressed as a lowercase
word, like “transition”. All classes should be assigned to the p element.
Even though the formatting uses CSS, you should not expect to be able to tap into
the full power of this syntax. Designing an e-book is a far cry from designing a web
page. Many CSS commands simply won’t do anything at all.
Group endnotes according to section with subtitles When disabled, all notes
within the book will be displayed in a single section with linear number from
start to finish. When disabled, notes will be broken apart into sections based
on the ToC break points, and numbering will restart for each section.
Do not allow readers to copy and paste the text Disables the ability to use copy
and paste in the reader hardware or software. Note this is a directive. Not
all readers will follow the rules, so don’t expect it to absolutely protect your
book’s contents.
Save the KindleGen log file with the Kindle file If you have having difficulties get-
ting the KindleGen program to produce a valid .mobi file, enabling this option
can help you determine what is going wrong. The log file will be placed in the
compile location you specify once you click the Compile button.
24.19 KindleGen
Available only to the Kindle e-book export format, this option pane is where you
will inform Scrivener of where you have installed the KindleGen utility. Without
274 CHAPTER 24. COMPILING THE DRAFT
this utility, it is impossible to create a Kindle e-book straight out of Scrivener, and
you will not be allowed to make any changes to the compiler until you have selected
the KindleGen tool.
To acquire this tool, download the software for your computer from this web site:
http://www.amazon.com/kindlepublishing.
It will be distributed in a ZIP file, which will you need to decompress (if you
browser does not do so for you) and place in a safe place. It is a good idea to put
it in your Applications folder so you can find it in the future if need be. Once the
KindleGen folder has been installed on your computer, click the button to select the
“kindlegen” executable from within that folder.
Scrivener does not verify if you have chosen the correct application, so double-
check your selection as the wrong choice will cause errors to occur.
Chapter 25
Exporting
You can export your work from Scrivener at any time, either as individual documents
or by combining the draft into one long manuscript and exporting it in the format of
your choice, using compile. Since the latter is a large topic in and of itself, it is covered
in depth in its own chapter, Compiling the Draft (chapter 24). Here we will look at
various ways to export data piecemeal from your project, either for backup purposes,
or to facilitate collaboration with authors who do not use Scrivener or the capability
to utilise the folder synchronisation exports (section 13.2) you can produce.
❧ OpenOffice.org (ODT)
❧ HTML
275
276 CHAPTER 25. EXPORTING
All media files will be exported as they are. You can also choose to export com-
ments and annotations, meta-data, and/or snapshots; and optionally choose to strip
out all notation. Notes will be exported as separate files using the text file format you
chose above (RTF will be used instead, when any script formats are chosen), and the
meta-data (including the synopsis, label, status and so on) will be exported into sepa-
rate plain text (TXT) files. The structure of folders created on disk will reflect their
structure in the binder1 , so in this way you can export all of your files from Scrivener
for use in another application if you so wish.
1
There are a few caveats to watch for. Since the Finder does not support text material in a folder,
Scrivener will need to create a separate text file to hold whatever material had been typed into the folder
in Scrivener, if applicable. Another caveat is that the Finder will always sort files alphabetically, rather
than using the original order in the binder. If retaining the original order is important, producing a
compiled version of the document along side the full export would be a good idea.
Chapter 26
Printing
Given that there are two discrete functions in the binder: your draft or works in
progress, and all of the support files and collections around it; you need two funda-
mentally different print modes. Since proof printing and final printing the draft are
closely related to the act of compilation itself, this function has been built into the
compile interface. For all other forms of printing, either piecemeal or in groups, the
standard print mechanisms familiar to most applications will be available, including a
few special-purpose printing tools for visualising clusters of data, like index cards and
outliner columns, that specialise in highlight meta-data and synopses.
In most cases (compile, notably excluded) all you need to do to print a selection
is press – P, or select File � Print... from the menu. Continue reading for tips and
features on how to control the appearance of your print-outs. Many aspects of the
printout can be adjusted in File � Page Setup..., and will be covered in each relevant
section. These settings are saved into each project, not globally.
Printing with Placeholders and Number Tokens: The basic one-off print tool
will not evaluate replacement tags and auto-number counters in your documents.
If you wish to print with these tokens, you should select the documents you wish
to print, and then use Compile with either the content selection set to “Current
Selection”, or the use of “Current Selection” as a filter. Read about doing this with
the compiler contents pane (section 24.4).
277
278 CHAPTER 26. PRINTING
Print Options These impact the overall look and feel of the document, including
the headers, footers, and base font.
❧ Print page numbers: Insert a page number in the top-right corner of each
page in the header area. This number will be relative to the selection you
have chosen to print, it will not reflect the actual page number of the com-
plete draft (if you are printing from within the draft).
❧ Print the file name/date: Inserts the selected document’s name next to the
page number in the header area. If more than one document has been
selected, this will revert to “printing”.
❧ Remove annotations: By default, annotations will be left in, using their
original colour, and enclosed in square brackets to help identify them
when using a black and white printer. use this option to strip them out of
the printout.
❧ Insert linked comments: By default, linked comments will be inserted be-
side the highlighted anchor range in a darker variation of the highlight’s
colour. Uncheck this to keep them out of the print job.
❧ Print using font: If you wish to override the formatting of the documents
temporarily, and use a uniform font, check this box and then select the
font and font size in the activated option menus, below.
Elements to print Similar to the Formatting pane in the compiler, you can option-
ally add meta-data to the printout for each document that is selected. By default,
only Text will be selected, which is the main text body of each document.
Most research files will print out in a standard fashion according to their type, and
there are no options for adjusting how that occurs. However, images and web pages
have a few options available in the same Options palette described above, under the
“Other” tab.
Web Pages By default, background images and colours will not be sent to the printer
to save ink and increase clarity. However if the background image is an integral
part of the design, you can change this behaviour with this checkbox.
Images There are two scaling choices from which you can only select one, “Print
actual size” and “Scale to fit page”. If the image you are printing out is very
large, you will have better success with the latter option. In most cases actual
size will produce a better quality print.
❧ Include card numbers: this is similar to View � Corkboard � Show Card Numbers.
Each card will be numbered relative to the corkboard scope, starting with 1.
280 CHAPTER 26. PRINTING
❧ Ignore cards with titles only: with this option enabled, if a card has no synopsis,
it will be ignored. This includes images that would otherwise be printed out as
image thumbnails.
❧ Highlight titles with label color: the background of the title area will be high-
lighted with the card’s assigned label colour, if relevant. The label name will
also be placed in parentheses after the title, so if you are using a black and white
printer, this information will still be available to you.
❧ Include keywords: when enabled, all keyword names will be printed out in a
comma-delineated list below the title.
❧ Print cutting guides: this option is most useful when using standard paper. Each
card will be outlined with dashed cutting guides, making it easier to separate
them into actual cards with a cutting block or scissors. If you are using perfo-
rated card stock, it is best to leave this option off.
❧ Force landscape orientation: maximises the number of cards you can fit onto a
single sheet of paper to four instead of three. If you are just printing to regular
paper and plan on cutting them apart, use this option to save paper.
❧ Embolden titles: The title of the card, printed at the top, will be emboldened to
set it apart from the rest of the card content.
❧ Print using font: override the default font with your preferred font family and
size.
2. Under “Paper Size”, select the menu choice, Manage Custom Sizes...
3. Press the + button to create a new custom paper size and call it “Index card”, or
whatever you prefer.
4. Enter the height and width of your index cards. Use a ruler if you are unsure.
Most cards come in 3 x 5 inch and 4 x 6 inch form.
5. For the non-printable area, you can select whatever you like here. A small value
of 0.25 inches is a good default.
26.3. PRINTING OUTLINES 281
6. Click OK to confirm the new paper size and then make sure that is the selected
paper size before clicking OK again to confirm your page setup.
You will now need to follow the instructions provided to you by your printer
manufacturer to figure out how to feed the cards into the machine. Some printers
will let you place the cards in a stack, but with many printers you will need to feed in
a card one by one as it prints. Keep this in mind if you intend to print out hundreds
of cards!
1. Title Area
2. Content Area
3. Meta-data Area
Information will be placed into one of these three areas if enabled, and the follow-
ing list of options will refer to these sections to indicate where the information goes.
To adjust the appearance of this print form, options have been provided in
File � Page Setup...; select “Scrivener” from the “Settings:” drop-down menu, and
then click the Options... button, followed by the “Outlines” tab. As with outliner
and text document setup, a preview will be provided as you change options, letting
you know roughly what the final form will look like.
❧ Include titles: adds the title in the Title Area, using a bold font.
❧ Include synopses: the full synopsis will be printed for each item in the Content
Area.
❧ Include label and status: if the label and status have been set for the row, they
will be added to the section. Label will highlight the background of the Title
Area with its associated colour, and will be inserted after the title (if present) in
282 CHAPTER 26. PRINTING
parentheses. Status will be placed at the bottom of the entry in the Meta-data
Area.
❧ Include keywords: keywords will be added on the line above the synopsis, in the
Content Area, in a comma-delineated list.
❧ Include custom meta-data: will be added in the Meta-data Area, one field per line
for each meta-data field that has been filed out for that row. If a row does not
have any custom-meta data assigned to it, then nothing will be printed here.
❧ Indent by level: indents each item relative to the current outliner view. So items
which are children of the root level items will be indented once, no matter how
deeply nested they are within the binder. Disabling this produces a flat list.
❧ Print file name: prints the name of the container that is being printed (which
is otherwise not represented in the printout). If the outliner is the result of a
multiple selection, then the label will simply be “printing”. This will be placed
in the header area of each page, on the right hand side.
❧ Include word count: the word count for that row (not the total word count,
which would include its children) will be placed into the Meta-data area.
❧ Include character count: as above, only printing the character count instead.
❧ Include targets with counts: if any of the above two counters have been enabled,
and a goal has been set for the row, it will be printed after the relevant counter.
❧ Prefix titles with number: if titles are enabled, the row number (relative to the
outliner, not the binder) will be prefixed to the title. This is a simple incremen-
tal counter, not a hierarchal counter.
If you find the settings for the outliner do not provide for the look you desire, you
might consider using the compiler instead. Try starting with the provided preset,
“Enumerated Outline” and customising that if necessary.
drop-down menu on the left, or click the Print button to send the compiled document
to your default printer. The first time you do this, you should Preview the print job,
first. If you do not see a Preview button, make sure the print dialogue is in its collapsed
state by clicking the little upward pointing arrow beside the printer selection menu.
This will temporarily load the print job into Preview, and if everything looks okay,
you can click the print button in the footer bar of the preview area.
See also:
❧ Read Compiling the Draft (chapter 24) for more details on how to compile.
❧ If you want to print a script, read Printing or Exporting a Script (section 20.4)
for tips.
Part V
Advanced
284
Chapter 27
285
286 CHAPTER 27. MULTIMARKDOWN TIPS AND TRICKS
The tip boxes in this PDF are an example of these so-called “island comments”.
Prior to this transition, it would have required me to type XHTML div coding di-
rectly into the Scrivener project in order to create special paragraphs like the tip box—
or I would have had to have designed some syntax and gone through all of the steps
required to add that syntax to MMD (something which should be avoided if at all
possible). Instead, I can simply mark out a section of my document in an annotation,
and prefix that annotation with the phrase “TIPBOX: ”, which the XSLT has been
designed to look for, discard, and then format the div block in such a way that it is
displayed in a LATEX“leftbar” environment.
Due to their nature, inspector comments have no div element form, as they will
always at some level be embedded within another paragraph.
Appendices
287
Appendix A
About Scrivener Displays the credits and version number of the application. If you
are experiencing problems and wish to contact customer support regarding
them, you can provide version information using this dialogue. Simply click
anywhere outside of the scrolling text area to dismiss it.
Registration. . . When you purchase the application, use this menu item to copy and
paste your registration information from the e-mail that you will receive from
Literature & Latte. In case you have lost the original e-mail or never received it,
you can use the Retrieve Lost Serial... button which will take you to a web page
with further instructions on how to retrieve it.
Check for Updates. . . You can use the Check for Updates menu item to check to see
if there is a newer version of Scrivener available for download (2.x updates are
free). Scrivener uses the Sparkle1 framework to check for updates. This means
that you can check for updates and then download and install them all without
leaving the application.
Services The items in this menu are provided by the core system, and other third-
party applications. They will let you perform various functions, mostly based
on selected text. Scrivener provides its own services which are also available
1
http://sparkle.andymatuschak.org/
288
A.2. FILE MENU 289
in this menu, and from other applications as well. See Scrivener Services (sec-
tion 11.2) for further documentation.
Quit Scrivener Leaves the program. Any projects that are currently open will be
saved to the disk if necessary, automatically. Under the default preferences,
these projects will be marked and opened automatically the next time you run
Scrivener.
New Project. . . ( – N) New Project creates a new Scrivener project. This will
bring up the Assistant panel (see Quick Tour (chapter 6)) which will walk you
through creating a new project, which will be saved as a .scriv file in the direc-
tory on disk that you specify.
Open. . . ( – O) Open allows you to open a pre-existing .scriv file on your hard disk.
Note that Scrivener cannot open read-only files directly (such as those that have
been backed up to a CD-ROM) and will give you the opportunity to save the
project to an area where you have permission to save files.
Recent Projects Here you can select and open projects that have recently been
opened in Scrivener (unless you specify otherwise in the General Preferences
(section B.1), Scrivener will reopen all projects that were open in a previous
session when it is launched).
The number of items listed in this sub-menu is governed by OS X’s global pref-
erence, which can be set in the Appearance preference pane.
Close Project ( – W) Closes the current project and all of its associated windows.
Save ( – S) Scrivener auto-saves your work so that you never have to worry about
losing your writings. Projects are also saved automatically whenever they are
closed. However, you can use Save to force an immediate save whenever you
want.
290 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Optionally, if you hold down the Opt key ( – S) you can manually rebuild the
search index. This is sometimes useful in cases where you suspect the project has
lost synchronisation with search index. There is generally no need to do this as
Scrivener will automatically rebuild indexes if something appears to have gone
awry since the last session.
Save As. . . ( – S) Will prompt you for a new project name and/or location. When
you submit this dialogue box, Scrivener will immediately start working off of
the new copy. If instead you want to generate a backup copy and keep working
off of the original, use File � Back Up � Back Up To... instead.
For more information on managing your project files, see Project Management
(chapter 7).
Import Allows you to import a variety of existing information, from your drive or
even from the Internet, into your active project. For full documentation on im-
porting information into Scrivener, refer to Gathering Material (section 11.1).
Files. . . ( – I) Import files from the file system into Scrivener. Supported
formats are .doc, .rtf, .rtfd, .txt, and other text formats; all major image
and QuickTime file forms; .pdf files; .htm, .html, and .webarchive files.
Web Page. . . ( – W) Import a web page from the Internet by supplying
Scrivener with its URL.
MultiMarkdown File. . . Takes a plain-text MultiMarkdown formatted docu-
ment and will convert its header structure into a binder outline structure.
Plain Text Formatted Screenplay. . . Import a plain text screenplay, option-
ally splitting sections into separate binder documents. This works best
with scripts that have been exported from CeltX and Movie Magic Screen-
writer.
From SimpleText.ws Integrate with the SimpleText.ws service. You will need
to provide your account log-in information. This will allow you to re-
trieve files you have created in SimpleText aware applications, such as
WriteRoom for the iPhone.
Scrivener Project. . . Import an entire Scrivener project into the current
project. Most meta-data, keywords, references, and notes will be trans-
ferred.
Import and Split. . . Takes a standard text file and allows you to supply a char-
acter sequence (such as “###”) which will be used to split the document
into sections.
A.2. FILE MENU 291
Export Provides tools for exporting elements of the binder to the file system. For
more information on exporting your work, see Exporting (chapter 25).
Sync Tools for linking parts of your project to external applications, mobile de-
vices, or disk-based files and folders. Read more about syncing in Cloud Inte-
gration and Sharing (chapter 13).
with External Folder. . . Method for creating folders with plain-text, rich
text, or Final Draft files on your system. This export location can be
anywhere, including network mounted or monitor drives, such as iDisk,
Dropbox, SugarSync, and so on. Read more in Synchronised Folders (sec-
tion 13.2).
with Simplenote. . . Method for synchronising individual files or folder con-
tent as plain-text to the Simplenote server, which can be used with a vari-
ety of applications and devices. Read more in Simplenote (section 13.1).
with Index Card for iPad. . . Index Card2 for iPad is an application which
lets you view items on a corkboard in a manner similar to Scrivener’s
corkboard. Using this tool, you can sync a collection (section 8.4) from
Scrivener to a special .plist file that Index Card can use to import your
material. Read more in Index Card for iPad (section 13.4).
Back Up Functions for managing backup copies of the current project. For more
information on back up strategies, see Backing Up Your Work (section 7.6).
Back Up Now Triggers the automatic backup system to produce a backup im-
mediately, using the preferences for backup location and rotation scheme.
Customise how this works in the Backup preferences pane (section B.10).
Exclude From Automatic Backups Removes the current project from the au-
tomated backup system. This is useful when the current project is very
large, and is causing you to have to wait for long intervals while the auto-
matic system performs backups. Note that when this option is engaged,
Scrivener’s backup protection will be completely ignored for this project.
Take care to manually back up excluded projects from time to time.
Save As Template. . . Saves the current project as a template. This will add it to the
New Project window for use as a basis for future projects. For more informa-
tion on creating templates, read Templates (section 7.5).
For full documentation of the printing process, read Printing (chapter 26).
Page Setup. . . ( – P) Accesses the standard page layout setup pane. Additionally
accesses Scrivener specific features from the Settings drop-down menu. Note,
these settings do not adjust Compile printing, only current document printing,
though Compile can be optionally configured to use your Page Setup paper
dimensions.
Print Current Document. . . ( – P) Prints the current editor view. How this will
be printed depends on the view mode, and all of the settings for this can be
accessed with File � Page Setup... above.
Undo & Redo ( – Z & – Z) Undoes or redoes the last change. Undo and Redo
work mainly for edits made to text, but they do work for some basic outlining
A.3. EDIT MENU 293
changes too, where that change does not cause the current document to change
in the editor. Each document has its own Undo history, which means you can
easily go back to another document and revert changes independently of other
documents.
Cut, Copy, and Paste ( – X, – C, and – V) Cut, copy and paste act exactly as
they do in other applications. Note that they only operate in a text editing
context, and not on binder documents or meta-data. See Documents Menu
(section A.6) for document management commands.
Copy Special This menu allows you to copy text or binder items in a variety of
ways which can apply or remove data depending on the specific menu com-
mand.
❧ Copy Documents as ToC: Will create a basic Table of Contents out of the se-
lected documents, which is meant to be pasted into a Scrivener document.
See Creating a Table of Contents (chapter 23) for further information.
Paste and Match Style ( – V) This pastes the contents of the clipboard without
any of its existing fonts and styles. Useful for when you have copied a range of
formatted text but want to paste it using the style of the text into which you are
placing it.
Delete ( – Delete) Moves the selected binder items to the Trash. Scrivener works in
the same fashion that the Finder does. Items are not directly deleted, but first
moved to a Trash folder, located in the binder. Periodically, you can review the
contents of this and empty the trash to clear up space.
Select All ( – A) Selects all of the content of the current text, outliner view, table
view or corkboard.
Select Current Text ( – A) When holding down the Option key, this alternate
method will be displayed. It is useful for selecting on the current text in a
Scrivenings session, rather than the entire session.
Complete Document Title ( Esc) If you start typing in a document title from the
same Scrivener project, you can use Esc to cause Scrivener to search your
project for matching titles, based on what you have typed thus far, and suggest
alternatives. This is very useful in conjunction with the auto-correction option
(section B.8)] to automatically detect Scrivener links typed in with [[Document
Title]] bracketing.
Add Selection to Auto-Complete List Adds the currently word to the project’s
auto-complete list. If more than one word is selected, nothing will be added
to the auto-complete list.
Insert The Insert sub-menu provides a wide variety of elements that you can
insert into text fields. These will be placed at the current cursor position.
Note that some of these insert invisible characters which control the flow
of your document, you may not see anything happen unless you have For-
mat � Options � Show Invisibles enabled.
A.3. EDIT MENU 295
Image From File. . . Allows you to select an image file from disk to insert into
the current text document (note that inserted images can be resized by
double-clicking on them).
Image Linked to File As with the above, but the inserted image file will be
linked to the original file on your hard disk, rather than copying it into
the text document. This allows you to keep image files separate, and easily
apply updates to images later on if necessary.
Read Inline Images (subsection 14.4.6) for more information on inserting
images into your text.
Draft Word Count Inserts a token which will be calculated during Compile
which indicates the word count for the entire manuscript. There are a
number of rounding options available, for cases where precise counts are
less important.
Draft Character Count As with “Manual Word Count”, inserts a token for
the total character count. Again, rounding options are available.
296 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Scrivener Link Creates a new Scrivener Link to a chosen document at the current
cursor position. Note you can also create a link to a document that doesn’t
exist yet. The New Link... command ( – L) will ask you for the title of the new
document, and where to place it; or which existing document to link to, in the
second tab. After providing this information, a link to this document will be
placed into the current editor.
Read more about Scrivener Links (section 9.5).
Unlink If the cursor is placed in the text of a link, this command will destroy it. If
you select a range of text, all links within that range will be destroyed. Useful
when pasting text from the Web, when you want to get rid of all the links that
are brought over.
A.3. EDIT MENU 297
Find As with many OS X applications, you will find familiar tools for finding things
both in individual documents, with some additional things Scrivener provides,
including tools for searching your entire project. This list briefly explains the
various functions. For full documentation on how to use Scrivener’s extensive
searching features, see Searching and Replacing (section 21.4).
Find. . . ( – F) The standard find and replace panel. This panel only works
within a single editing window. Most often this means one document,
but in the case of a combined text view, it might mean many documents.
Find Next / Previous ( – G / – G) Jumps to the next or last matching
text based on the criteria supplied in the Find panel. Note these can be
used even if the find panel is closed.
Use Selection for Find ( – E) Sets the selected text as the current find term,
copying it into the “Find” text field if the find panel is closed.
Jump to Selection ( – J) Will scroll the editor view so that your cursor po-
sition is centred on the page. Useful if you have used the scrollbar, or
PageUp/PageDown to briefly check other areas of the text.
Project Replace. . . Shows the Project Replace sheet, which allows you to re-
place text throughout the whole project. This operation cannot be un-
done, use with care.
Project Search. . . ( – F) Provides a shortcut for the toolbar Project Find
tool. If the toolbar has been hidden, a separate window will be opened
up for your convenience.
Both of these tools are quite powerful and have a wide range of options.
Please read Searching and Replacing (section 21.4) for more information on
how to use them.
If you are looking for the old menu commands to “Find Annotation” and
“Find Highlight”, these operations have been rolled into the new “Find by For-
matting” tool, which now also allows a much wider range of formatting that
can be searched for.
Spelling and Grammar Accesses OS X’s spelling and grammar tools. Note that
most of these can be set to different defaults, in the Auto-Correction tab (sec-
tion B.8).
Speech Controls for OS X’s built-in text-to-speech synthesis. Two menu controls
are provided to start and stop speaking. The active text editor will be used as
source text with these commands.
Writing Tools Provides a few OS X writing tools, as well as some custom utilities.
Outline ( – 3) Display the current editor as an outline. Also sets your preferred
collection view mode to Outliner. See also, The Outliner (section 12.2).
Enter Full Screen ( – F) Enters the full screen writing environment, switching to
text editing mode if necessary. In the case of Combined Text mode, the entire
session will be opened in full screen. Note this option is not available to media
and web pages.
Full Screen Backdrop Choose a background image for your full screen environ-
ment, rather than just using the plain background colour. The image will be
stretched vertically to fit the screen. For your convenience, all of the image
resources in the project will be listed in this menu, or you can select Choose...
to select an image from your computer. To remove the selected image, select
None.
The menu items, Go To and Text Bookmarks are also available from the header bar
icon menu.
Zoom Provides shortcuts to the zoom menu, located in the footer bar for text
documents. Temporarily zooms the display of the font up or down to increase
legibility, without adjusting the underlying font size.
Go To Offers an alternate way to jump to a specific binder item without using the
binder. If the binder is hidden, a collection is selected, or a sectino is hoisted,
for instance, will let you navigate to other areas of the project without having
300 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
to alter your work environment. The contents of this menu will be populated
by the binder, or by the current Scrivenings session. Also provided are some
contextual navigation and focus functions which will let you move around in
the binder, from the editor itself.
Text Bookmarks Jump to places in the current document which have been book-
marked. To insert bookmarks, see Edit � Insert � . The contents of this
menu will be populated by existing bookmarks from the current document
or Scrivening session.
QuickReference Similar to the Go To menu, except that the selected item will be
opened in a QuickReference window, rather than replacing the contents of the
editor. The contents of this menu will be populated by the binderbinder in all
cases.
Collections Provides commands for setting visibility and options of the Collec-
tions feature. For documentation on how to use Collections, see Using Collec-
tions (section 8.4).
The rest of this menu will be populated by the existing available collections
in the reverse order that they appear in tabs. It will always include an entry
for the binder and Search Results. Selecting an entry will switch the sidebar to
viewing that collection, making this menu useful when the tabs are not visible,
or for assigning keyboard shortcuts to oft-used collections.
Layout The commands in the Layout Sub-menu affect the main window elements.
Show/Hide Header & Footer View Toggles the visibility of the header and
footer bar. Both are elements of the editor and can be toggled indepen-
dently for each split. See Writing and Editing (chapter 14) for more infor-
mation on what these do.
302 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Lock in Place ( – L) Locks the editor (or split) so that no binder clicks will
affect it. When an editor is locked, its header bar will turn a shade of red.
Media Controls and options for various types of media. These commands will
only become available when viewing the appropriate type of media.
A.4. VIEW MENU 303
PDF Display This sub-menu controls how PDFs are displayed in the editor. Most
of these options should be familiar as they are common to many PDF viewers.
❧ Automatically Resize: Keeps the PDF sized to the width and height of the
editor window.
❧ Actual Size: Zooms the PDF to 100%, even if it is too large to display all
at once.
❧ Size To Fit: Like “Automatically Resize”, but only resizes the document
once. If you change the size of the editor view later, it will stay at the same
view.
❧ Single/Facing Pages: In single mode, will show one page per row like an
ordinary digital file. In facing mode, two pages will be placed side-by-side
in a column, more like reading a book.
❧ Continuous/Page Breaks: These two scrolling modes affect how the docu-
ment is handled when using the scroll wheel, arrow keys, or page up and
down keys. In Continuous mode, the pages flow by seamlessly; in page
break mode, only one (or two, if facing pages is enabled) pages will be
showed at a time, and scrolling actions flip between pages.
Play Media File ( – Return) Functionally, this acts like clicking the Play button in
the media viewer, for either audio or video files. If the editor is split between a
text document and a media file, and you are typing in the text document, this
shortcut will start and stop the media in the other split, allowing you to easily
transcribe or reference the media. When two media files are open at once, the
shortcut will affect the active split.
Page View Accesses features and options for displaying the text editor as a virtual
page, instead of filling the entire editor. It is not intended to be used as a layout
mechanism, though it can provide a reasonable estimate of how your pages
will look under certain conditions, once printed. Read more in Page View
(chapter 15).
These three options toggle between the three page size models.
304 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Use Printed Page Size This is the most accurate model to use as it will size the
pages and margins according to your current print. The specific metrics
and orientation used can be changed to either Compile settings or the
settings from the File � Page Setup... pane. This can be changed in the
Editor tab (section B.6).
Use Preferences Page Size A custom layout can be created in the Editor tab as
well, which will be used to define the size and margins of the page. These
metrics can be changed in the Editor tab (section B.6).
Two Pages Across When enabled, instead of displaying pages in vertical col-
umn, two will be placed beside each other as though reading a book.
Corkboard Accesses features and visual options for the corkboard. All of the set-
tings available in this menu are project specific, and most of them will only
impact a single split, allowing you to have different view settings for each ed-
itor. For more information on using the corkboard, see The Corkboard (sec-
tion 12.1). Note that further options can be accessed via the corkboard display
options button, which is located on the right-hand side of the footer bar for
each corkboard.
See also, Setting Up Meta-Data (chapter 10), for more information on the types
of meta-data that can be viewed on an index card.
Cards Across The Cards Across submenu allows you to define how many
index cards you would like to appear in each row on the corkboard. The
default is three. Auto will calculate how many cards to show, based on
the size of the editor and the size of the cards; kind of like word wrap, for
index cards.
Freeform Activates the Freeform Corkboard mode, which allows you to move
cards around on the corkboard without any grid or ordering constraints.
This can also be toggled in the Footer bar.
Commit Freeform Order It is possible to instruct Scrivener to use the cur-
rent freeform layout to re-order the actual manuscript outline structure.
Scrivener will provide several options for how this should be done. For
more information on how to work with Freeform Corkboards, see The
Corkboard (section 12.1).
Outliner Columns Displays a list of toggles which will reveal or hide the corre-
sponding columns in the active Outliner view. These settings are stored by
individual editor split, letting you have custom columns for the two views, and
are saved in the project file. You can also manage columns using the “>>”
button above the scrollbar in the outliner itself.
Use Label Colour In A document’s label colour (see Setting Up Meta-Data (chap-
ter 10) for more information on labels) can be applied as a tint to various inter-
face elements throughout Scrivener. This menu contains a list of toggles which
will enable tinting to the corresponding elements.
❧ Binder: Rows in the binder will have a background bar placed behind
items with labels in a fashion similar to how Finder applies labels to files.
306 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
❧ Icons: Only the icons will be tinted throughout the project. Wherever the
icon for a binder item shows up (such as in the Header bar, next to the
title in Corkboard, in the binder, and so forth) it will be tinted using the
colour of the assigned label.
❧ Index Cards: The entire background “paper” for index cards will be tinted
using the assigned label colour. This includes the index card which appears
at the top of the inspector.
❧ Outliner Rows: As with binder tinting, the background for the entire row
will be filled in with the label colour.
Move Focus To Provides application focus navigation tools. Rather than navigat-
ing around in your project, these commands will let you quickly select different
parts of the application without using the mouse. The first lets you cycle be-
tween common elements, while the rest will jump immediately to that element
of the interface, no matter where focus is currently placed. Note that in all
cases, the elements you wish to cycle or jump to must actually already be visi-
ble. These shortcuts will not automatically reveal parts of the interface that are
currently hidden.
Inspect A continuation of the navigation functions, these deal solely with the re-
vealing and focussing of elements within the Inspector. All of them work on
the following principle: if the keyboard shortcut revealed the item (it was hid-
den before), then the action will simply reveal the meta-data without disturbing
your original focus. If the item is already revealed, then the shortcut will switch
focus to that meta-data area. If the Inspector is hidden, it will be opened if nec-
essary, which counts as a “reveal” action.
A.4. VIEW MENU 307
Outline Provides navigation and disclosure commands which work in both the
outliner and in the binder, referred to below as the “active outliner”. Container
is defined as a folder by default, but if “Treat all documents with subdocuments
as folders” is enabled in Navigation preferences (section B.5), the definition of
container will be expanded to include document stacks as well.
❧ Expand All: ( – 9) Expands all of the visible items recursively. When this
command is used in the binder, it will expand the entire binder (including
all non-Draft sections). When used in outliner, it only works within the
context of the currently viewed portion of the binder.
❧ Collapse All: ( – 0) As with Expand All, this works the other way, closing
all visible open items recursively. Note that in both cases, you can use the
Option key in conjunction with a mouse click to selectively perform this
function on the arrow (and everything beneath it) clicked.
❧ Previous Container: ( UpArrow) Will select the previous visible con-
tainer in active outliner, no matter what the depth. In this case, previous
means a container higher on the list than the current position. If a con-
tainer is currently hidden, it will be skipped. If you only wish to select the
parent container of a the current item, you can use the LeftArrow key.
❧ Next Container: ( DownArrow) Works the same as Previous Container,
only selecting the next visible container downward from the current posi-
tion.
308 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Reveal in Binder ( – R) This command is available from either editor split, and
will show the location of the currently edited file in the binder, disclosing con-
tainers as necessary to do so. This is most useful when the method you used
to arrive at the current document did not involve clicking in the binder. This
menu command is also available from the header bar icon menu.
Binder Affects Adjusts where binder clicks will be sent. By default all clicks will
be sent to the active editor (so long as it is not locked). This will adjust that
behaviour so that the clicks go to a predetermined editor in all cases, depending
on the choice made below. If the editor is not split, this menu will be deactivated
as all clicks will naturally go to the only available editor.
Customize Toolbar. . . Lets you configure the toolbar of the main window so that
it contains the commands that you most use in the order most intuitive to you.
This can also be done by right clicking on the toolbar itself.
New Text ( – N) Creates a new text document below the current selection. When a
folder is selected, the new file will be created within the folder. Otherwise the
new file will appear as a sibling to the current selection.
New Folder ( – N) Creates a new folder document at the current selection. Fold-
ers will always be created as a sibling to the current selection.
For more information on the differences between files and folders, see Project Plan-
ning (chapter 12).
A.5. PROJECT MENU 309
New From Template There are two management commands always available
from this menu, which let you set or remove a designated template folder. Once
a template folder is set, this menu will also be populated with the children of
that template folder, which may need to be set with Project � Set Selection As
Templates Folder, below. Read more about Document Templates (section 8.5).
For tricks on how best to use text and project statistics, read Goals and Statistics
Tracking Tools (section 21.2).
Text Statistics ( – S) Brings down a sheet displaying statistics for the current
document (and thus only available when a text document or Scrivenings are
focussed).
Project Statistics ( – S) Brings down a sheet displaying the statistics for the cur-
rent project, including the word and character count for the draft and for the
current binder selection.
Meta-Data Settings. . . ( – ,) Displays a sheet which lets you adjust the two main
document meta-data fields (Label and Status by default, but these can be re-
named), as well as the custom meta-data columns for this project. For further
information on using this panel, see Setting Up Meta-Data (chapter 10).
Set as Templates Folder / Clear Templates Folder Will convert the selected
binder item into a special template folder (though note it could also be a
document stack). Each project can only have one template folder at a time. If
more than one item is selected in the binder, this menu item will be disabled.
When a Templates folder has already been set in the project, this menu item
will changed to “Clear Templates Folder”, removing its designation, but not it
or its contents.
Text Preferences. . . Displays a sheet which presents a configuration pane very sim-
ilar to the one found in the Formatting tab (section B.7) of application prefer-
ences. Changes made to this panel will override the application level settings. It
works in the same way as the application defaults, affecting all new documents,
but not existing ones.
Edit Auto-Complete List. . . Displays a sheet which lets you manually add and re-
move terms to the project’s auto-complete list. Depending on your auto-
completion settings, this will let you add custom names, places, and workflow
310 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
indicators to assist in typing out repetitive items. Modify how agressive auto-
complete should behave in the Auto-Correction preference pane (section B.8).
Empty Trash. . . Permanently discards the current contents of the project trash can.
You will be warned before this is done. Once contents have been deleted, there
is no way to undo that action. This can also be done by right-clicking on the
Trash itself in the binder.
Open The Open sub-menu provides you with a number of ways in which to open
a selected item. These menu items are relevant from the binder or collection
views, as well as corkboard and outliner views, but note that in most cases, a
single click will open a file all by itself. How it does that is dictated by the
settings available in the View � Binder Affects... sub-menu. The corkboard and
outliner can be configured to immediately open clicked files too.
The first two menu items open the selected documents in either the current
editor or the other split. To open an item in the current split (and replace the
existing view), use – O. To open selected item(s) in the other split, use –
O. This will open a new split if necessary, using the previous split orientation.
The actual labels of these menu items will change, depending upon the current
editor that is active, and whether or not split orientation is horizontal or verti-
cal. For example, if the focus is in the bottom editor of a horizontal split, the
label for – O will be “in Bottom Editor”.
With All Subdocuments If the selected item has sub-documents (this can be
determined on the corkboard if the index card appears as a stack of cards;
and in the outliner if it has an arrow beside it’s name) you can choose to
open it as a corkboard either in the current editor or the other split.
A.6. DOCUMENTS MENU 311
Show Snapshots Will reveal the Snapshots pane in the inspector, revealing it
if necessary. While this menu item does not have a shortcut, an identical
function in View � Inspect � Snapshots provides the shortcut key, –
M.
312 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Show Changes When a snapshot is selected from the snapshot list, it is possi-
ble to view the changes between that snapshot and the current document.
Note these features are also accessible from the snapshot pane itself, in a
button at the top of the inspector. If two snapshots are selected, these two
snapshots will be compared between each other, using the oldest snapshot
as the exemplar.
❧ Compare/Original: Toggles visibility of the change tracking mode.
❧ Comparison Granularity: These options can be toggled on and off
individually to determine how closely changes will be tracked, with
the finest level selected being the used method. By Paragraph will only
mark changes at the paragraph level; By Clause only marks changes
made at the phrase level; By Word is the most detailed level of change
tracking available. Use these settings to fine-tune the results if what
you are getting is too precise or vague to be useful.
❧ Next Change: ( – ]) Scrolls the view to the next available difference
in texts.
❧ Previous Change: ( – [) Scrolls the view to the previous difference.
Roll Back When a snapshot is selected, this will roll back that selection to the
main editor. The option to snapshot the current editor before making this
revision will be given.
Delete Permanently removes the selected snapshot from the disk.
Duplicate There are two different methods you can use to duplicate the selected
item(s).
Set Selection as Title ( – T) Available when text has been selected in the main
editor, the title for the current document will be replaced with whatever text
has been selected.
A.6. DOCUMENTS MENU 313
Split Provides two methods for splitting the current document into two different
documents. In both cases, everything below the current cursor position will
be moved into a new document below the current one. Everything above the
cursor will remain unchanged. This action cannot be undone (except via the
Merge command).
❧ at Selection: ( – K) Simply create a new document with all text below the
current caret position. In cases where text has been selected, the caret
position will be considered as the start of the selection range.
❧ with Selection as Title: ( – K) Works the same as above, but in this case
the currently selected text will be used to title the new document that is
created, rather than requesting a new document name after pressing the
shortcut.
Merge ( – M) The opposite of splitting, merge will take two or more documents
and combine them all together into a single document, using the top-most doc-
ument in the selection as the “template” for the merged document’s meta-data.
This action cannot be undone (except via the split command). Note that in
those fields where combination makes sense, such as notes and keywords, all of
the documents will be used to create a combined meta-data result.
How documents get merged together can be controled in the General prefer-
ences pane (section B.1), under Separators.
Group ( – G) Takes one or more selected items and creates a new folder, placing
the selection within that folder. You will be given the option to name that
folder after invoking the command.
Ungroup ( – U) The opposite of grouping, ungroup will move the contents of the
selected container up one level so that they become siblings of that container.
This action will not destroy the original container, allowing you to move the
items back in, if it was made in error.
Move Provides keyboard shortcuts for moving the item around in the outline
in two dimensions, as well as completely displacing it to another spot in the
binder.
❧ To: This menu will be populated with all of the items in the binder. The
selected item(s) will be moved beneath the selected item as children. Note
that if you select a document as the target, it will become a document stack
as it now contains children.
314 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Sort Sort acts on the children of a selected container, and sorts items alphanumer-
ically, either in Ascending or Descending order. Note that this a permanent
change that cannot be undone. Additionally, you can choose to shuffle all of
the children randomly. If you wish to just temporarily sort a list of items by a
criteria, use the outliner.
Hoist Binder Mimics the behaviour of traditional outlining software, allowing you
to temporarily obscure the full binder and focus on only one portion of it.
Hoisting will display the selected container all by itself in the binder side-
bar. Unlike collections, hoisting the binder retains all of the binder’s abilities.
Changes made to ordering and structure while hoisting will be made to the
book outline itself. If you want a non-destructive way of viewing portions of
the binder, it is recommended you use Collections (section 8.4) instead.
Convert Provides tools for converting the document’s type, writing mode, or for-
mat defaults.
A.6. DOCUMENTS MENU 315
❧ Formatting to Default Text Style: If the font and ruler styles of the docu-
ment do not conform to the application or project defaults, you can use
this command to use those to reset its appearance.
❧ Script Format. . . : Useful when you need to switch from one scripting stan-
dard to another. Note that if all you wish to do is change the current doc-
ument writing mode, you can press – 8 to do so. This function is strictly
for converting between pre-existing scripts to bring them up to spec. For
more information on scriptwriting, see Scriptwriting (chapter 20).
Auto-Generate Synopsis For single items, you can click the button in the upper
right-hand side of the index card in the Inspector. When you wish to perform
this automated function on many items at once, use this menu command. The
command will work in the same fashion as imported text documents, taking
the first 500 characters of text in the document. Note this cannot be undone;
do not run this command on cards you’ve already manually entered synopses
for, unless you are sure you want to replace them. Scrivener will warn you if it
looks like you are about to overwrite custom synopses.
Change Icon Provides access to existing icons and lets you change the document
icon to a custom icon for the selected item(s). Icons can also be managed either
globally, or by project, from here. Your custom icons will be available, as well
as many built-in icons that you are free to use in any of your works.
❧ Reset Icon to Default: Removes custom icons from the selected item(s). If
no custom icons are in place, this menu item will do nothing.
❧ Manage Icons. . . : Reveals the Manage Icons Palette, where you can add or
remove your own custom icons either to the project, or make them avail-
able globally to all Scrivener projects. For more information on managing
and creating icons, see Custom Icons (section 12.5).
316 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Font Displays the standard OS X Font submenu, which contains useful tools for
controlling the character-level appearance of your text. Fonts family, variant,
and size can also be controlled with the The Format Bar (subsection 14.4.2).
❧ Show Fonts: ( – T) Access the system-wide standard font palette, which will
change the font you type in from that point forward, or alter the existing
font of a selected range of text.
❧ Bold/Italic/Strikethrough: All of these operate in the same fashion by ei-
ther modifying the behaviour of typing if there is no selection, or toggling
the selected text between the various styles. Note that not all fonts sup-
port these styles. If it appears that one of these is not working, check your
font for proper variant support.
❧ Underline: Has been expanded from the system default menu item to pro-
vide additional support for underlining styles, including dotted, dashed,
and by word.
❧ Remember Typing Style: Use to set up fonts and ruler styles in blank doc-
uments. Ordinarily, if you change formatting settings on a blank docu-
ment, these settings will be removed to optimise the RTF file. Use this
command to force these settings to be retained. Generally you will only
need this when setting up Document Templates (section 8.5).
❧ Outline: Changes the style of the font to outlined instead of filled.
❧ Bigger: ( – =) Increases the size of the font by one point.
Text Displays the standard OS X Text submenu, which contains useful tools for
controlling the paragraph-level formatting of your text. Paragraph alignment
and spacing can also be controlled with the The Format Bar (subsection 14.4.2).
Table Provides tools for adding and manipulating tabular data in the text editor.
Tables can be set up with a given number of rows and columns, but using the
options in this menu, you can add or remove either to fit the constraints of your
data later on. You can also normalise the width and height of columns and rows
respectively with the Distribute functions.
Lists Supplies basic list styles, and few advanced controls for bullet and enumerated
list management. Unless you need custom list styles, you can generally make
do with the list button supplied on The Format Bar (subsection 14.4.2).
❧ List. . . : Build your own custom list type using the standard OS X tool for
doing so.
❧ Next/Previous List Style: ( – RightArrow / – LeftArrow) Selects the next
or previous built-in list style available and converts the current list to that
style.
318 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Formatting Provides tools for creating and applying ruler and font presets3 to
your text. For more information on using the presets system, see Formatting
Presets (Styles) (subsection 14.4.3).
Show/Hide Ruler ( – R) Toggles the visibility of the tab-stop and page margin ruler
for the active editor. Note that all formatting tools have been moved from this
ruler to the format bar.
Show/Hide Format Bar ( – R) Toggles the visibility of the character and para-
graph formatting bar, which provides quick access to many of the most com-
mon types of formatting tools.
Highlight The highlight menu lets you place a background highlight behind the
selected text, much like using a highlighter marker on paper. In addition to the
five provided presets, this menu also displays any favourite colours that have
been set on your system. For more information on how to use highlights, see
Text Colour and Highlights (section 17.4).
Revision Mode Revision modes force anything you type to be displayed in a pro-
vided colour until you disable the revision mode. This menu provides access
to these levels. For more information on using this, see Marking Revisions
(section 17.5).
For more information on annotating and footnoting your text, see Annotations
and Footnotes (chapter 17). Note that while the menu system refers to these as foot-
notes, it is possible to export them as endnotes during compile.
Comment ( – 8) Attaches a comment to the selected text (or previous word), mak-
ing a new linked comment in the inspector pane. Useful for keeping notation
text out of the editor.
Footnote As with Comments, adds a linked footnote style comment to the inspector
pane. Useful for keeping footnote information out of the editor.
3
Note that Scrivener does not supply word processor stylesheets. Styles are strictly saved formats
which can be applied to your text. Once applied they are static changes to the text and will not be
updated later if you change that favourite style.
A.7. FORMAT MENU 319
Inline Footnote ( – F) Converts the selected text into a footnote, or toggles the
writing mode to footnote mode. Useful for keeping footnotes directly in the
editor session.
Convert The convert submenu provides useful tools for the manipulation of text
and notation features.
Multiples Spaces to Space Useful for cleaning up a document that has been
typed up with multiple spaces in between sentences and so forth.
Bold and Italics to MultiMarkdown Syntax Converts rich text bold and
italic formatting codes into respective MMD syntax. Note that in some
cases this can produce odd results; be sure to proof the results before send-
ing off to the printer.
Options Provides options which impact the display or behaviour or the text editor.
Minimize ( – M) Minimises the window to the Dock (the same as the yellow button
in the top-left of the window). Hold down the Option key to minimise all.
Zoom ( – -) Zooms the window in or out (the same as the green button in the
top-left of the window). Scrivener will try to zoom intelligently to best fit the
contents of the window, taking into account your preferred editor width. Hold
down the Option key to change to Zoom All.
Zoom to Fit Screen ( – =) Zooms the window in and out, so that it takes up the
whole of the screen.
Float Window “Floats” the project window above other application windows, so
that you can have it visible at all times should you wish, even when switching
to other programs. Be sure not to use this in conjunction with Zoom to Fit
Screen.
Show/Hide Scratch Pad ( – � ) Displays or closes the floating Scratch Pad Panel
(section 11.3); useful for collecting information while using other applications.
Bring All to Front Brings all Scrivener windows to the front. Hold down the Op-
tion key to change to Arrange in Front.
Window List The rest of this menu will be populated by all of the windows (ex-
cluding panels, like the Keywords HUD) that are currently open in Scrivener.
Selecting from this list will bring that window to the front.
Scrivener Manual A quick link to the PDF that you are likely reading. The ver-
sion that ships with Scrivener will be kept as up to date as possible, but newer
revisions might frequently be available on the web site’s support page4 .
Interactive Tutorial If you have not yet gone through the tutorial (you should!)
this menu command will walk you through the process of creating the tuto-
rial Scrivener project. You will be given the option of where to save it, and
from that point on you can load it like an ordinary project. If you have already
created the tutorial project, you can use this menu command to quickly load it
again.
Placeholder Tags List. . . There are many placeholder tags you can use with
Scrivener, and this will provide an exhaustive list of them all in a floating win-
dow so you can copy and paste them into your project (or compile settings) as
needed.
Support A handy hyperlink to our web site’s support page. Here you can download
the latest copy of the PDF in US Letter or A4, find contact e-mail addresses,
links to our forums and wiki, after-sales support from our vendor, eSellerate,
and more.
4
http://www.literatureandlatte.com/support.php
5
http://www.literatureandlatte.com/videos.php
322 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
User Forums A handy hyperlink to the official Scrivener forums where you can
meet other authors around the world using Scrivener, share tips, report bugs,
request tech support, or have a cup of latte in our off topic section.
Literature & Latte Home A handy hyperlink to our home page6 which provides
easy access to everything else we offer on our web site.
Scrivener Home Link to the main Scrivener page7 , where you will find useful down-
load links for updates, case studies, links to share Scrivener with Twitter and
Facebook, and more.
Keep Up to Date. . . Presents a form which you can use to submit your e-mail ad-
dress and name to subscribe to our newsletter. This is a low volume list that
we use to send out important updates and news. Please take care to whitelist
“litereatureandlatte.com” in your spam filter, prior to submitting this form, as
you will be sent a confirmation e-mail which must be responded to before you
will be subscribed. You can also click on the Twitter and Facebook buttons to
visit our official social pages.
Privacy Notice: Your e-mail address will never be shared with third-parties or
sold to marketing lists.
6
http://www.literatureandlatte.com/
7
http://www.literatureandlatte.com/scrivener.php
Appendix B
Preferences
Because Scrivener is a multi-project application, preferences are split up in different
areas so that you can supply new projects with some starting preferences. Once these
projects have been created, they will maintain their own individual settings from that
point forward. One step beyond that, there are a sub-set of preferences which apply at
the document level, and each document will diverge from the project and application
preferences.
Not all preferences work in this “cascading” fashion. The ones that do will be
indicated as such in their notes. Many of the preferences which are wholly project
specific and make no appearance in the application preference system at all. A good
example of this is whether or not pins are displayed on index cards. By default they
are, but you can turn them off for a project—and it will remember that setting. There
is, however, no way to change that behaviour globally.
All of the project specific preferences are located in menus, and most of these are in
either the Project menu or the View menu. This section will not cover these specif-
ically, though some might be mentioned in passing where applicable. Instead, this
section strictly focusses on the application preferences dialog. For information on spe-
cific menu options, see the appendix, Menus and Keyboard Shortcuts (Appendix A).
B.1 General
General preferences govern the basic application’s behaviour, its integration with
other programs, and how appending or merging text with existing documents should
be presented.
Show start panel when there are no projects open Toggles the display of the start
panel, which lets you create new projects, open existing projects on your drive,
or select from a list of recently worked on projects.
323
324 APPENDIX B. PREFERENCES
B.1.2 Saving
Auto-save after n seconds of inactivity Sets how long Scrivener waits to save
changes after it becomes inactive. Scrivener automatically saves changes made
to projects. So that it is not constantly saving - and to avoid any slowdown this
might cause - when any changes are made to a project, Scrivener takes note and
waits for a suitable time to save them. It then waits until the user stops interact-
ing with the program for more than than two seconds (by default). If the user
makes no edits after this period, Scrivener deems it a good time to auto-save the
project without the save process interrupting what the user is doing. You can
change the period Scrivener waits to auto-save with this preference. If you in-
crease the period significantly, be sure to use Save from the File menu regularly
to force saves to your project.
Automatically name untitled text documents upon saving When enabled, text
documents that have been left untitled will acquire the first few words from
the document.
B.1.3 Separators
This table lets you configure how Scrivener will separate texts from one another in
various situations. In all cases, you have three choices available:
1. Single Return: Inserts a single carriage return between selections. If two para-
graphs appear together, there will be no whitespace between them, save for any
style-based paragraph spacing.
2. Empty Line: A full empty space will be inserted between selections. If you
prefer or require working with double-spaced paragraphs, this is the option you
will want to use.
3. Custom: Lets you type in a custom separator. Some default common examples
have been provided. If you wish to insert carriage returns, use Return to do so.
B.1. GENERAL 325
The four different types of selections you can separate are as follows:
1. Merged Documents: Determines how documents will be merged when using the
Merge command from the Documents menu. Note that this setting only affects
the main text - the notes of merged documents will always be separated by a
double newline.
2. Append clippings service: When using the global Append Clipping Scrivener
service, clippings will be separated from any existing text by this option.
3. Append selection: When selecting text and using the Edit � Append Selection to
Document command, the selection will be separated from the existing text by
this option.
4. Scratch pad notes: When appending text to documents from the scratch pad,
incoming text will be separated from existing text by this option.
Notes location In Scrivener 2, your scratch pad notes are now stored on the hard
drive using RTF files. This option lets you choose the location for where those
files will be automatically saved. By default, they will be stored in your Docu-
ments folder, under a special folder that Scrivener will create for them.
Note that in secured working environments, you might wish to alter the loca-
tion of this to also reside in the encrypted area of your drive.
B.1.5 Miscellaneous
When you first start using Scrivener, actions which have a destructive nature (such as
importing in such a way that original formatting might be lost) will produce a warn-
ing dialogue. You can choose to disable these as you see them. The Reset button will
clear all of these dismissals and make them appear again the next time it is appropriate.
B.2 Appearance
Most preferences relating to the appearance of Scrivener can be modified here. In
a few cases, things which modify appearance, but are more related to the specific
function they fall within, will be located in the special section for them. A good
example is the background texture for corkboards, which is located in the Corkboard
section.
B.2.1 Options
General and miscellaneous appearance options.
Binder uses source list style If this checked, the highlight bar in the binder takes
on the gradient that it does in programs such as the Finder and iPhoto - that
is, it will have a blue (or silvery if the Graphite theme is selected in System
Preferences) gradient when it has the focus or a grey gradient when it doesn’t.
The colour of the binder will be set to a light blue, as is standard for source lists
(although you can change the colour again after checking this option if you so
wish). If this option is not checked, the binder’s selection highlight is drawn
based on the system highlight colour - although it is still drawn as a gradient, in
contrast to most other programs. If your system uses the standard Aqua theme
and blue highlighting, you will notice very little difference between this option
being turned on and off.
Show subdocument counts in the binder Beside each container in the binder, a
number will be displayed showing how many documents it contains. This num-
ber is recursive, meaning that it will count not only its immediate children, but
all of the descendents beneath those children as well, if applicable.
Keep text on lines in index cards and notes When enabled, Scrivener will adjust
the ruling beneath lines to match the current font size. In most cases, this will
produce the most pleasant result, but if your notes have a lot of different font
sizes, it might look nicer to keep the rules uniform, regardless of font size.
Show notepad lines in documents notes Turns on notepad style ruling for docu-
ment notes, giving it the appearance of a pad of paper.
Show notepad lines in project notes As with the above, will toggle whether or not
notepad style ruling is used in the project notes pane.
Check the secondary box to also apply this setting to the project notes window.
Smooth text and line art in PDF documents Anti-aliasing is used by default to
keep your PDF documents crisp at all levels of magnification. If you computer
runs slow while viewing PDFs, disable this to increase performance.
B.2. APPEARANCE 327
Target progress bars use smooth transition between colours By default, the three
colours you select for progress bar display will be used to gradually blend be-
tween each other as you type. When this feature is disabled, the progress bar
will “snap” from one colour to the next. If you prefer a more noticable notifi-
cation of when you’ve reached a goal, this can be a useful option.
Label colour tint opacity Define how much blending Scrivener should use between
label colour and the underlying icon. Moving the slider right, to “High” will
cause icons to be coloured more vividly; moving the slider left to “Low” will
cause the effect to be more subtle.
B.2.2 Outliner
Options for adjusting the appearance of the Outliner view mode.
Uses alternate row colours Draw alternative background colours behind rows in
the outliner. When this is turned off, the background will be a solid shade.
You can define the actual colours used in the section below.
Has horizontal grid lines Draw seperators between rows in the outliner.
Has vertical grid lines Draw seperators between columns in the outliner.
B.2.3 Fonts
Options for setting application fonts. If you wish to adjust the editor fonts, visit the
Formatting tab (section B.7).
Binder font Choose the font which will be used to display the text labels of items
in the binder, and Collections. Note that some font choices will not allow all
of the checkbox options available, because they do not have the proper font
variant. The default font choice, Lucida Grande, for instance, does not have
an italic variant. If you wish to use these options, make sure to choose a font
which has the proper variants available to it.
You can also select font variants to be used to alter the appearance of items in the
binder. The font variants you wish to apply must be available to the font you have
selected. Folders and document containers can be treated separately, if you wish.
These variants will impact the outliner as well, but only if the outliner is set to not
show embedded synopses. Scrivener needs to reserve the bold variant for titles, in
order to differentiate them from the synopsis.
328 APPENDIX B. PREFERENCES
The number of interface elements you can customise has been dramatically increased
in Scrivener 2. Consequently, interface colours are now chosen using a selection tree,
as it would take many pages of preferences to display them all together. To alter the
default colour for the desired interface element, first select the major category in the
left-most column, and then the item itself from the centre column. Click on the
colour well at the right to assign a new colour, or click Use Default Color to reset the
option to the system default.
B.3 Corkboard
Provides options and settings which will impact the way the corkboard functions and
appears.
B.3.1 Appearance
Draw lines in index cards Determines whether lines should be drawn in the text
area of index cards (affects both the corkboard and the index card in the inspec-
tor).
Display images as photographs Media files such as QuickTime movies and images
can be displayed as “Polaroids”. Disabling this option will show a standard
synopsis index card to represent the image, instead.
Arrange cards from right to left Will cause index cards be ordered from right to
left, top to bottom. If you are accustomed to working in right-to-left languages,
this will make the Corkboard more intuitive.
Status stamp opacity Allows you to set the opacity of stamps on the corkboard.
Corkboard shadows Sets the intensity of the shadows around the cards and borders
of the corkboard view.
Position pins Allows you to choose whether pins on the corkboard (if displayed)
should be drawn in the centre of the title area of each index card (which looks
more authentic but can partially obscure the actual title) or in the top-right
corner. If using the rounded card theme, this option will have no effect.
Index card theme Lets you choose the line colours used in the index card. “Red
and blue” divides the title area from the text with a pinkish-red line and draws
B.3. CORKBOARD 331
blue lines in the text area; “Blue and black” divides the title area from the text
area with a blue line and draws black lines between the text. These represent
the most common colours of index cards in the real world. The rounded card
theme displays cards in a more stylistic fashion. Cards will have rounded edges;
labels will be represented as a colour block instead of a pin; and lines will be
drawn in grey. This setting will also impact the index card in the Inspector
(though it will always have square corners).
B.3.2 Fonts
The options in this section let you alter the fonts used to draw index cards. To change
the font, click the Select... button to the right of the option you wish to adjust. This
will present the standard font selection palette and any choices you make here will be
applied to the preview immediately.
Index cards title font Lets you set the font used in the title area of index cards (this
affects the index cards both in corkboard mode and in the inspector).
Photographs title font If you have enabled “Display images as photographs” option,
the title of the image will be drawn below the thumbnail using this font choice.
Index cards text font Lets you set the font used in the text area of index cards (affects
index cards both in corkboard mode and in the inspector).
Status stamp font Lets you set the font (and whether or not it should use bold face)
of the stamps that can be drawn diagonally over index cards in corkboard mode
to show the status.
Allow drop ons When enabled, lets you drop index cards on top of other cards to
store them as children beneath that card. This action is similar to dragging
items beneath other items in the binder.
“Opens the parent corkboard” will select the parent of the current corkboard.
If the corkboard you are viewing is already at the top of the binder, it has no
parent and nothing will happen.
“Creates a new card” follows a common behaviour amongst diagramming ap-
plications. When in linear mode, the new card will appear at the end of the list.
In free-form mode, the new card will appear beneath the mouse pointer.
“Do nothing” ignores all double-clicking on the corkboard background.
B.4.2 Options
Highlight current line Enabling this will place a background highlight colour be-
neath the current virtual line (not paragraph), making it easier to see where you
are in your text. The colour of this will be determined depending on your Text
Color settings. If overriden, it will use a lighter shade of this colour behind the
text. Otherwise, it will use the preference for Current Line Highlight, under
the Editor section, in the Appearance tab (section B.2).
Fade between modes Gracefully fades the screen between full screen and regular
editing mode.
1
Note that temporary attributes can only affect colour - it is not possible to choose a different font
in full screen, for instance. Some other plain text applications do allow you to change the font in full
screen. They can do this because the whole of the text only ever uses one font at a time - plain text
doesn’t hold any font information, fonts are used only for display. However, because Scrivener is a rich
text application, it is possible for a single piece of text to use multiple fonts. It is therefore impossible
to change these fonts to one font temporarily, edit the text and then change the font back.
B.4. FULL SCREEN 333
Close full screen when the Escape key is pressed When disabled, you will need to
use the keyboard shortcut for full-screen mode (Opt-Cmd-F by default) to tog-
gle between modes.
Hide main window when entering full screen mode Check this to hide the main
window during full screen sessions. If this is unchecked, you can see the main
window beneath the translucent areas of the full screen background (unless you
have set the opacity to opaque using the slider in the full screen control panel),
and you can also have the main window visible on another screen if you have a
multi-screen set up. Checking this so that the window is hidden means that you
could use the translucent areas of the full screen window to look at the contents
of the windows of other applications. Note that in some circumstances, having
the main window visible during full screen mode can slow down typing, so it is
usually best to leave this checked as it is by default.
Open full screen window on secondary screen when available If this is checked
and you have more than one display, the full screen window will be opened
on the secondary screen.
Scroller type Allows you to customise how the scroll bar looks in full screen mode.
“Standard full screen scroller”: The scroller will look like the ones you would
see in the full screen modes of iPhoto or other iApps (the translucent grey-
white against black). This scroller will always be visible if there is enough text
to warrant a scroller and disappear when there is not.
“Auto-hiding scrollbar (uses text color)”: The scroller will take on the colour
of the text (as set using “Override text color” - see above), and will only appear
when the cursor is over it. Move the cursor to the edge of the paper area to get
this scroller to appear. This is an unobtrusive scroll bar that gets out of your
way when you don’t need it, and fits in with the the retro green-on-black full
screen look that a lot of users like.
“No scroller”: Full screen mode will not feature a scroll bar under any circum-
stances if this is selected.
Disable insertion point blinking When enabled, the cursor will be always visible
on the screen.
Use block insertion point of n pixels Adjust the width of the insertion point from
its default of 1 pixel. This will dramatically increase the visibility of it, however
with variable-width fonts (like Optima), this setting can produce odd results. It
is best used with a fixed-width font like Courier.
334 APPENDIX B. PREFERENCES
B.4.4 Margins
Sets the margin spacing between the text and the “paper” edge. You can select a dif-
ferent distance for horizontal and vertical margins. The top and bottom margin will
only affect the very top and bottom of the document on the page.
Default Text Zoom Dynamically scale the size of the text font for full screen mode.
This will not impact the underlying font settings, letting you use a larger or
smaller font only while in full screen.
Paper position There are three possible choices, “Left”, “Center”, and “Right”. Gen-
erally this is useful in conjunction with a high amount of Background fade, so
that you can place reference material alongside the full screen page.
For the next two options you can use the Use Current button to grab the settings
from the active project. Often it is easier to visually arrange things how you like them
using the HUD. These buttons let you do that and then transfer the settings to your
defaults.
Paper width Adjusts how much width the virtual page should take up (not including
the margin space). Move the slider all the way to the right to take up the entire
screen, or all the way to the left to use only a narrow column.
Background fade Lets you adjust the blend between the background and the chosen
background color. All the way to the right means no blending at all, it will be
completely opaque. All the way to the left means no blend will be used and
you’ll see the windows behind Scrivener as if there were no background at all.
B.5 Navigation
The navigation settings provide settings to alter how Scrivener reacts to the various
actions you can take to navigate around in your project. There are numerous ways
of doing so, from clicking directly on items, to using buttons to scroll through doc-
uments like a flip-book, to using menus to jump directly to a specific place in your
book, and more.
In nearly all cases, unless otherwise indicated, navigation options are globally ap-
plied; that is, no matter how you select an item, these options will apply.
B.5. NAVIGATION 335
If you are coming to Scrivener 2.0 from older versions, you may note that a lot
of the preferences pertaining to default group modes have been removed. This is be-
cause they have been replaced with a smarter, dynamic system that no longer requires
maintaining preferences.
Show folder text when selected from search results Overrides default behaviour
of opening folders (and if “Treat all documents with children as folders” is set,
document stacks as well). When this is enabled, all container style search results
will reveal their text when clicked on in the search results, rather than reveal-
ing their children in accordance with the selected view mode. This option is
enabled by default, because generally speaking, most search results are based on
the text of the matching item, not its descendent items, and so the reason the
item is in the search list at all is because of its text.
Collapse auto-expanded outline items after drag and drop When dragging items
into containers if you pause over the container Scrivener will helpfully reveal
the contents (if hidden) allowing you to drop items several layers deeper than
you could initially see. This option will close all automatically opened contain-
ers for you, after dropping the items. This setting impacts both the binder and
the outliner view.
Always create new items as siblings Ordinarily, when a container is the selected
item, creating a new text item will place that item within it as a child, at the
end of the list if necessary. This will hold true for text groups as well as folders,
if “Treat all documents with children as folders” is enabled. When this option
is enabled, all newly created items will be created at the same level, below the
selected item.
Folders are always created as siblings, even when this option is off.
336 APPENDIX B. PREFERENCES
Option-dragging creates duplicates Enable this feature to cause the various organi-
sational views to mimic the Finder in that when you hold down the Option key
while dragging items, it will create copies of those items in the location where
you drop them, rather than moving the items.
Return creates new item in list, outline, and corkboard views If this is checked, a
new item is created whenever you hit the return key in the outliner, binder,
corkboard or certain list views (such as the keywords list). Note that if you are
editing the title of an item, return ends the editing, hitting return again will
then create a new item.
in the editor, replacing the current view. If you would prefer it to match the
binder behaviour, change this to “QuickReference Panel”.
B.6 Editor
The options for the main text editor control how text is displayed within the editor it-
self. For options pertaining to fonts, see the Formatting tab (section B.7); and options
pertaining to text input and typography in the Auto-Correction tab (section B.8).
Typing clears search highlights When using the Project Search feature, Scrivener
will highlight the matching search results for you. If this is enabled, the high-
lights in the current editor will be temporarily removed as soon as you start
typing. To restore them, select another document from the search result list
and then use the Back button ( – [) to return.
Use hyphenation When full justification is turned on, it can increase readability to
use hyphenation at the expense of not being as “pure” to the actual text you
have keyed in. Consequently this is off by default.
Use fine kerning Uses a higher quality text rendering model which reduces known
screen artefacts, such as “text wobble” while typing, and ugly kerning at odd-
number zoom settings. Disable this feature to marginally increase performance,
if necessary.
338 APPENDIX B. PREFERENCES
Highlight current line Enabling this will place a background highlight colour be-
neath the current virtual line (not paragraph), making it easier to see where you
are in your text. To change the colour of this highlight, use the Appearance tab
(section B.2), in the Editor section, under Current Line Highlight. This setting
will also impact full screen, unless text colour override is enabled.
Disable insertion point blinking When enabled, the cursor will be always visible
on the screen.
Use block insertion point of n pixels Adjust the width of the insertion point from
its default of 1 pixel. This will dramatically increase the visibility of it, however
with variable-width fonts (like Optima), this setting can produce odd results. It
is best used with a fixed-width font like Courier.
Default Text Zoom Dynamically scale the size of the text font in the editor. This
will not impact the underlying font settings, letting you use a larger or smaller
font while editing. Note this only sets the default. Each editor split can have
its own settings and these settings will be preserved between editing sessions.
Ruler Units Lets you choose the units (centimetres, inches, picas, or points) that
should be used in the main editor’s ruler (available by hitting – R when the
editor has the focus or by selecting Show Ruler in the Edit menu.
Margins Sets the margin spacing between the text and the edge of the view. You
can select a different distance for horizontal and vertical margins. The top and
bottom margin will only affect the very top and bottom of the document in the
editor.
Default Editor Width This value, in pixels, is used to determine the overall width
of the project window when using the menu command, Window � Zoom.
Scrivener will attempt to scale the window so that your preferred editor width
fits in with the binder, and optionally, the Inspector if it is open. Click the User
Current button to capture the current width from the active project. Setting this
to 0 (zero) will cause the editor to always take up as much space as possible (in
effect, making Zoom act like Window � Zoom to Fit Screen).
B.6. EDITOR 339
Use fixed width When this is enabled, Scrivener will also use the above setting to
artificially restrict the width of the editing “page” no matter how wide you
make the editor itself. The area not used by this page will be filled in with a
background colour, which you can set in the Editor section, under Fixed Width
Background, in the Appearance tab (section B.2).
Draw shadow around pages Add a shadow around the virtual page, offsetting it
from the background colour.
Center pages horizontally Instead of always pegging the virtual page at the left side
of the editor, no matter how wide, Scrivener will place the page in the middle
of the editing view.
Show margin guides Will draw a border around the printable are of the virtual page.
Spacing between pages When more than one page of text is displayed, the number
of pixels entered here will buffer the pages from one another.
If you enter a value of 1 (one), a single line will separate pages vertically.
If you enter a value of 0 (zero) pages will flow from one to the next (but will
still have top/bottom margins separated them).
The following two options are used when “Use Printed Page Size” from the
View � Page Layout menu is set to off. This will let you work in a different layout
configuration than what will eventually be printed.
Margins Sets the margin spacing between the text and the edge of the view. You
can select a different distance for horizontal and vertical margins. The top and
bottom margin will only affect the very top and bottom of the document in the
editor.
Page Size Using pixels, define a custom page size. Scrivener already provides for a
3x5 card custom page size, for those wishing to work in a smaller format, and a
page size that will conform to your print settings. This will let you set up a third
display page which, like the 3x5 setting, does not impact your print output.
Base printed page size on: There are two ways to print from Scrivener. “Document
printing Page Setup settings” will use the settings provided in the standard Mac
application Page Setup window, in the File menu. The other choice is to use
the “Compile Draft settings”, which is how you will most likely be publishing
340 APPENDIX B. PREFERENCES
B.7 Formatting
B.7.1 Main Text Style
These settings determine how new documents will be configured. They will not
adjust the formatting of documents you have already created, in any projects, so you
needn’t worry about these settings destroying your formatting.
Further, these settings can be adjusted per project. To change the settings for each
project, select the menu command Project � Text Formatting Preferences. These will
always be set to the application defaults shown here, when you make a new project.
If you change the settings in the project formatting preferences, changes made to this
tab will not impact that project.
It is best to visualise default formatting settings in the following order of prece-
dence, starting with the “weakest” and ending with the “strongest”:
To reset a document to either the project preferences (if changed) or the applica-
tion preferences, use the menu command, Documents � Convert � Formatting to De-
fault Text Style.
The top half of the tab is dedicated to setting up the default settings for new text
documents (files and folders). You will have access to the full standard ruler settings,
as well as font controls via the Show Fonts... button. All changes you make here will
be immediately previewed against the provided sample quotation.
If you already have a document set up the way you would like all future documents
to appear, make sure that editor (and not the other split, if one is open) is active before
clicking the Use Current button.
Do not color the text of inline notes (faster) Turns off the text colour for inline
annotations—this option should speed up typing on slower machines.
Inspector comments font Sets the default font for inspector comments. Since these
fields are rich text, this setting will only impact new comments. Inline annota-
tions will always take on the styling of the text around them.
B.8. AUTO-CORRECTION 341
Footnotes font When enabled, the font within an in-line footnote will be changed
to this setting. It will still conform to the ruler settings of the text around it.
To apply this setting to inspector footnotes as well, check the box labelled, “Use
for inspector notes too”.
Notes font The default font for all notes. This setting impacts Project Notes and
Document Notes alike. Note that both of these are rich text fields and can
be changed from this default. As with the main text editor, if you change this
setting later on, old notes will remain as they were.
Writing direction In most cases, you will want to use the “Natural” setting, which is
set up depending on your default system language. This should go from right to
left, or left to right, automatically. If however, you do most of your writing in a
language that is different from your system settings, you can manually override
this here. Note you can also manually override individual documents as well in
Format � Text � Writing Direction, this only sets the default. Authors working in
both Arabic and German, for example, will probably want to leave this setting
at Natural and change each document according to the language it contains.
❧ Center: the title will be centred in the editor, rather than left-aligned
❧ Use title background color: when checked, the title background colour will be
used to highlight the title. This can be set in the Appearance pane (section B.2).
❧ Separate with single line breaks: uses a lower-profile and more vertically accurate
divider marker, rather than the single-line full-width divider. This option is
useful when page formatting must be precise, such as in scriptwriting, or if you
usage of scrivenings tends more toward very small chunks rather than section-
oriented chunks. Some may also find it to be more visually appealing than the
divider line.
B.8 Auto-Correction
The Auto-Correction tab contains many of the options that were previously found in
the Typography section in Scrivener 1.
342 APPENDIX B. PREFERENCES
B.8.1 Spelling
Check spelling as you type in new projects Displays red underlining for words
that are not found in the built-in dictionary, as you type. This setting only
impacts future projects. To change the behaviour of existing projects, toggle
this feature on in the Edit � Spelling and Grammar menu.
Correct spelling errors as you type Will correct common spelling errors and typos
automatically. For example, “teh” will be corrected to “the”.
With grammar check Displays green underlining for words and phrases which the
built-in grammar checker deems to be in poor style or in violation of grammar
rules.
B.8.2 Auto-Capitalization
Fix capitalization of sentences Will fix letter case issues if a lowercase letter follows
a period and a space.
Capitalize ‘i’ If the letter ‘i’ is found by itself, will automatically capitalise it.
In script mode only Disable the auto-completion feature unless the editor has been
set to script mode.
Only suggest completions from custom auto-complete lists Will restrict the
auto-completion list to only those words that you have specified in Project � Edit
Auto-Complete List.... When disabled, will attempt to find words using the
exhaustive built-in language dictionary.
B.8.4 Substitutions
Enables a wide array of commonly used symbols and typographic conventions, by
detecting when their use is appropriate. Not all text entry areas are capable of using
substitutions, but they will always be available in the main text editors.
B.9. IMPORT AND EXPORT 343
Note that if you are using the MultiMarkdown export system, it is best to leave
typographic substitutions disabled, as it will handle all of that automatically after
export, and in some cases special characters can confuse the exporter.
❧ Use smart quotes: will convert inch and foot characters into typographic quotes
(also referred to as “curly” quotes) as you type, according to your system lan-
guage settings. To customise these, click the System Text Preferences... button
that is provided at the bottom of the window.
❧ Disable smart quote, em-dash and ellipsis substitution in script mode. The
above three options will be ignored in script mode.
❧ Superscript ordinals. When numbers are typed with a following ordinal, the
ordinal will be superscripted and set to a smaller font.
❧ Automatically detect web addresses and [[Scrivener links]]. If you start typing in
a web address, Scrivener will automatically generate a web link for it so you can
click on it and open the link in your web browser. Scrivener document titles
can be linked to by surrounding the title in brackets. For more information on
this feature, see Scrivener Links (section 9.5).
❧ Symbol and text substitution. Accesses the system level substitution engine
for OS X Snow Leopard and higher. To modify the list, click the System Text
Preferences... button.
HTML Import You can set how HTML files will be handled if you drag them into
Scrivener. The WebArchive option will package the document into Apple’s We-
bArchive format, which is viewable in many Macintosh applications. Do note
that if you plan to work with colleagues using the Windows version, or wish
to share project resources universally, you should use the Text option instead.
Text will preserve basic formatting, but complex page formatting will be lost.
Optionally, you can also choose to convert dropped WebArchives or imported
web pages directly from the Internet to text as well.
OPML Import When OPML files are dropped into the binder, Scrivener will at-
tempt to convert these outlines into Scrivener outlines. This can be useful if
you do your initial brainstorming in a dedicated outliner application. Some of
these applications support attached notes to each outliner header. If notes exist,
Scrivener can be instructed to apply these notes either to the Synopsis alone,
the main text, or the document notes for that heading in the outline. Note that
in the case of the last two options, the synopsis will still be set automatically.
If you want dropped OPML structures to be generated inside of a special folder,
rather than directly into your existing Binder structure, enable the “Create
folder to hold imported OPML items” option.
Plain Text Import When importing plain-text files (usually they have a .txt file ex-
tension), you can have Scrivener either apply the current default styling prefer-
ences, or optionally use a special font for these files.
Import Final Draft FDX script notes as. . . Final Draft’s export format saves your
commentation notes. Scrivener can convert them to linked Inspector Com-
ments, inline annotations, or footnotes.
Import RTF footnotes and endnotes as inline footnotes If unchecked will con-
vert RTF footnotes and endnotes to linked Inspector Comments.
HTML Export Document type refers to the web standard that should be used dur-
ing export. If you are unfamiliar with web standards, chances are the default
setting of the older “HTML 4.01 Strict” will suffice. If you intend to publish
B.10. BACKUP 345
your writings within a modern blogging system, however, in most cases using
one of the XHTML formats will be more compatible.
Styling can be set to three levels. Embedded styling will declare CSS styles
at the top of the exported file, allowing you to easily adjust them with your
own custom stylesheets. Inline CSS puts the styling directly into the HTML
elements themselves, and so is useful in situations where you wish to override
default stylesheets. Finally, “No CSS” will export devoid of any styling. In
many blogging and content management systems, all presentation formatting
is already handled for you, and this will be the best option.
“Preserve white space” will attempt to convert your ruler settings into the ap-
propriate CSS style codes.
This setting will affect the manner in which compile produces .html and .we-
barchive files, as well.
Use Word-2011 compatible copy If checked, copying and pasting from Scrivener
into Word 2011 will use true footnotes and comments. This is needed owing
to changes in Word 2011 (which now accepts RTFD pastes), but is off by de-
fault because RTFD is useful for pasting into other Apple and Cocoa text-based
programs.
B.10 Backup
Scrivener 2 has a fully automated backup system. The options in this tab will control
the various aspects of it.
Back up on project close Whenever a project is closed (either directly or via appli-
cation shutdown), a backup will be created.
Back up on each manual save Will create a backup copy whenever you manually
save a project with – S. Note this is not the same as Scrivener’s auto-save fea-
ture, which by default is triggered after every two seconds of idling. Backups
will only be triggered if you select the menu command manually.
346 APPENDIX B. PREFERENCES
Back up every n minutes In addition to the event-based backups above, you can set
Scrivener to create a new backup while you work. In the case of very large
project, this can be the setting that most adversely impacts your writing experi-
ence, as Scrivener will restrict you from editing during the backup.
Compress automatic backups as zip files If you are storing your backups on a net-
work drive, or Internet syncronised service like DropBox, this option will not
only save space but will protect the project format from the sorts of damages
which can occur when lots of files are transferred over the Internet. However,
it will adversely affect the performance of your backups, as Scrivener not only
has to collect and assemble a copy of the project, but compress it as well, before
letting you return to your work. With very large projects, this can take many
minutes to complete.
Only keep n most recent backups To avoid the proliferation of hundreds of copies,
use this option to have Scrivener restrict the number of backups to a defined
amount. Once this amount is reached, it will rotate through the copies, over-
writing the oldest available copy.
Backup location The default location stores your backups in your user Library
folder, under Application Support/Scrivener. If you would prefer these back-
ups be kept somewhere more visible, or on a synchronized, external drive, or
secured area, click the Choose... button and use the folder navigator to select
the destination folder. If you choose a location that later becomes invalid (a
common example is external drives), Scrivener will immediately warn you as
soon as it tries to back anything up.
As a convenience, you can quickly access the backup folder by clicking the
Open backup folder... button.
Appendix C
Placeholder Tags
For a complete list of all placeholder tags available in Scrivener, see Help � Placeholder
Tags List....
347
Appendix D
348
D.2. USING SCRIVENER IN A SECURE ENVIRONMENT 349
which conform to whatever guidelines are required of you. Literature & Latte
make no claims about the security of Scrivener in confidential environments.
If you work in a field that requires confidentiality and/or encryption, it may be pos-
sible to convert Scrivener into a semi-secure application. Be aware that Scrivener is
not coded with maximum security in mind, and unless you are using third-party tools
and hardware to protect your active RAM and hardened equipment, security is only
going to apply to the data which is stored on the disk. Your project will be held (in
full or in partial) in unencrypted RAM whenever you are working on it.
If you are not using FileVault or some other technology to protect your user folder,
you can create pockets of encrypted storage in your user folder with Apple’s Disk
Utility application, which comes installed on every Mac and can be found in the
Utilities sub-folder in Applications. Use this tool to create encrypted disk images to
the size and protection level that you require, and then store your Scrivener projects
on these disks. Documenting the production of these disk images are out of scope for
this manual. You will find full documentation in Apple’s help files for Disk Utility.
Further steps will need to be taken to ensure that data in these projects are not
accidentally disseminated. By default, Scrivener creates a backup of your project,
every time it is closed, to your Library folder. You will want to adjust this location to
reside within an encrypted drive as well (it need not be the same one). Do note that
sequential backups can take up a lot of space over time and prepare an encrypted disk
large enough to accommodate at least five copies of each project you are working on
with plenty of room to spare. You can alter the location of automated backups using
the Backups preference pane. The default location is:
~/Library/Application Support/Scrivener/Backups
If you are working in a mixed environment, or only wish to protect a single file,
you might instead opt to exclude the sensitive project from the backup system individ-
ually. This can be done with a menu toggle, File � Back Up � Exclude from Automatic
Backups. You will now need to maintain your own manually scheduled backups.
Finally, the Scratch Pad also stores information in a non-encrypted area of your
Documents folder. Either take care to refrain from putting sensitive data into the
Scratch Pad, or use the General preference pane to relocate it’s storage location to an
encrypted disk image. The default location for Scratch Pad files is:
~/Documents/Scrivener Scratch Pad Notes
When Scrivener panics because it cannot write to the disk, it will terminate your
editing session and dump anything in RAM to your Documents folder. These files
will be placed in a folder named for the project itself, using the format, “Project
Name.scriv Recovered”. If you lose the connexion to the encrypted disk or for some
350 APPENDIX D. TIPS AND TRICKS AND TROUBLE
other reason find yourself dumped out of your project, you will be warned with a
dialogue box, and you should take steps to move the files from Documents to the
encrypted area and digitally shred the originals.
If you are using FileVault or a disk-level encryption tool, then your entire user
folder will be encrypted, and you can use Scrivener in its normal configuration. It
does not save any project material to places outside of your home folders, including
diagnostic and error recovery data.
For each hidden preference, you will be supplied with the complete command re-
quired to enable it. To remove the preference, you will need to use a slightly different
command:
defaults delete application.address PreferenceCode
No value is required when deleting a preference setting as the whole key will be
removed from the preference file. For example, to reset Scrivener’s built-in divider
with to 1px borders instead of thick Jaguar era split dividers, type in:
defaults delete com.literatureandlatte.scrivener2
SCRNoSinglePixelSplits
This will impact the entire application. However if you would like to disable icons
for only some projects, use the following format:
defaults write com.literatureandlatte.scrivener2
[MyProjectFileName].hideBinderIcons
The project file name should not include the extension. So for instance, to hide
binder icons for MyNovel.scriv project:
defaults write com.literatureandlatte.scrivener2
MyNovel.hideBinderIcons 1
Finally, you can disable only the text file and text file stack icons by adding the
following command:
defaults write com.literatureandlatte.scrivener2
SCRHideOnlyTextIcons 1
For this to work, you will need to have SCRHideBinderIcons set, otherwise it will
do nothing.
Where the final value is the number of points you wish to indent by for each level.
This setting will also impact the offset of the secondary tab, which can be used in the
link prefix to offset numbering from the title.
D.4 Troubleshooting
D.4.1 Some compile pages start too far down on the page
If some of the pages in your printed or compiled copy start further down on the page
than you anticipated, and you can find no extra carriage returns in your draft, you
might have the page padding feature enabled in the Formatting compile pane. For
each type and level, check on the right-hand side of the formatting area for a Page
Padding value of greater than zero. This will insert padding on pages that follow a
page break in the compilation.
If you cannot find Scrivener in the Applications folder (or wherever else you
thought it had been installed), then it likely never get properly installed in the first
place. Follow the instructions in Installation and Upgrading (chapter 4) to fix the
problem.
❧ Fixed compile option panes to include new Kindle exporter, splitting up the
old option pane into its new appropriate sections, Cover (section 24.17), and
E-Book Options (section 24.18). Additionally, the KindleGen (section 24.19)
section was added.
❧ Added new compile sections, Script Settings (section 24.7), Layout Op-
tions (section 24.12)[cpane-layoutoptions], and Statistics (section 24.13)[cpane-
statistics].
❧ Added tips for choosing the correct image size for e-book covers (section 24.17).
❧ Added new section, Back to the Binder (subsection 8.4.5), addressing the ability
to drag items from collections back into the binder to gather and/or reorder
them.
Minor Changes
❧ Moved all compile option panes up to the Section level so that they can be
referenced from the table of contents. Also moved the file format info and
tables higher up in the chapter as it is relevant to more people than the advanced
options.
354 APPENDIX D. TIPS AND TRICKS AND TROUBLE
❧ Fixed wording in Page Settings (section 24.16), which implied the “Page Setup”
button access the global project settings. In fact, it sets the paper settings for the
compiler alone and is not connected to the main page setup feature.
❧ Added tip box in Searching and Replacing (section 21.4) which highlights where
the binder goes while searching, and how to get it back.
❧ Added tip box in Linked Notation (section 17.2) for handling cases where you
want to move a linked note’s anchor position.
❧ Added small section, Working with Print-Ready Images (section 14.4.6) which
addresses proper handling of large, high resolution images in Scrivener.
❧ Created a new chapter in Writing, called Writing Tools (chapter 21), to house
topics on bibliography management, statistics and goals, search and replace, and
the name generator.
❧ Fixed wording in Project Statistics (subsection 21.2.2), which did not accurately
explain the paperback page counting model.
❧ Added an addenda footnote to Exporting Binder Files (section 25.1) which fur-
ther explains the limits of binder->finder ordering.
❧ Added tip for annotating PDF files in Viewing PDFs (subsection 14.7.2).
❧ Added entry to Supported File Formats (subsection 11.1.1) for the OPML for-
mat.
❧ Fixed various entries for Edit � Copy Special � Copy Without Comments or Foot-
notes to properly reflect new changes that strip out linked notes as well.
❧ Updated Folders and Files (subsection B.5.1) preference list to match current
feature set.
❧ Added Annotations and Footnotes (chapter 17) to the part on Writing (name
changed from “Annotating and Marking your Text” as there would have other-
wise been no clue on where footnote management was addressed in the ToC.
❧ Added two tips for advanced MMD usage, Functional Annotations and Com-
ments (section 27.1), and Multiple Footnote Streams with MMD (section 27.2).
❧ Added section for Built-in Presets (section 24.1), for the compiler.
❧ Added section for Printing (chapter 26) and a small cross-reference section to
the main printing section, in the compiler chapter.
Minor Changes
❧ Numerous menu, shortcut, and label errata have been folded into this revision;
including minor adjustments introduced in version 2.0.1
❧ Chapter on Scriptwriting (chapter 20) has been revised and updated to 2.0
changes.
Legal
Scrivener and this manual are copyright �c 2006–2011 by Literature & Latte LLC.
All rights reserved. Literature & Latte are not affiliated with, or endorsed by the
following companies and their products or services:
❧ Dropbox
❧ Simperium Simplenote
❧ OpenOffice.org
❧ Final Draft
❧ CeltX
❧ Mariner Montage
❧ EndNote
❧ Bookends
❧ Sony Reader
❧ Amazon Kindle
❧ RedleX Mellel
356
357
❧ Papyrus
All products above and otherwise mentioned in this text are trademarks of their
respective owners.
Literature & Latte take no responsibility for any text lost through synchronisation.
As with all synchronisation processes, you should ensure you back up regularly and
double-check that the right documents are being synchronised.
Visit our website for a copy of the licence agreement1 . By using this software you
are agreeing to be bound by the terms of this licence.
1
http://www.literatureandlatte.com/licence.php