Downloaded 21 times
![6 CHAPTER 2. ABOUT THIS MANUAL
window.
Users who are already familiar with prior versions of Scrivener will want to consult
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.
The PDF and Scrivener project versions of this manual will always be the most up-to-
date.
2.1 Terms and Conventions
Some features apply only to the standard version of the software, and others only apply
to the Mac App Store version. Various key features will be marked to indicate this. If
you have purchased the program directly from our web site, then you have the standard
version. If you used Apple’s App Store tool to buy Scrivener, then you have the Mac
App Store version. Sections applicable to only one or the other will be indicated as such:
l Standard retail version of Scrivener: [Standard Version]
l Mac App Store version of Scrivener: [App Store Version]
Whenever the documentation refers to an action that must be taken by you, the visible
name for that action will be formatted like so. Button labels, menu items, and keyboard
shortcuts will all be displayed in this fashion.
Menus will be displayed in a hierarchy using the “ ” character to separate top-level,
sub-menu, and items. Example: To convert a range of selected text to uppercase, invoke
the Format Convert To Uppercase command.
Keyboard shortcuts will use the following symbols:
l –: The Command key, or the Apple key, is the one located directly to the left
and right of your spacebar.
l : 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.
l : Control is usually located to the left and right of the Option keys on their
respective side. Some laptops only have one Control key between the Option key
and the Fn key on the left side.
l : The Shift keys are rarely used by themselves in shortcuts but are often used in
combination with other modifier keys.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-14-2048.jpg)
![9
compile view, adding crucial and commonly needed options. Even if you already know
how to use the compiler, you may find Summary mode to be of greater convenience for
once involved tasks, like changing the font of a preset from one style to another.
Quick Find by Synopsis
Quickly searching for items in the Binder is now easier with the Find Synopsis (subsec-
tion 20.1.4) tool. This window features a search engine which gathers results as you type,
and quick access to the index card or graphic for any of these results. Use this tool to
quickly find items by name or synopsis text, jot down notes in the synopsis text, or as a
tool to locate and load items, without disturbing your current working area.
Colour Themes
In the past you’ve been able to save out your preferences to a file, and so by using that
you could save different colour sets as “themes”. However this had a drawback in that
it saved all of your preferences in that file, not just the appearance settings. Now you
can save just appearance settings using the same Manage... menu from the Preference
window. Themes let you switch colour sets with ease, so you could for example use a
brighter Composition theme during the day, and switch to a darker theme at night.
Composition Mode
Well all right, this isn’t a new feature, but we thought you should know that what we’ve
been calling “Full Screen” all this time is now called “Composition Mode”. Why? In
short, Mac OS X Lion happened along, and as you may know, the phrase “full screen”
is destined to become a phrase that most Mac users associate with a particular feature:
expanding the application to fit the display—not completely changing the interface into
something else. So Scrivener now has two different features for maximisation. Full Screen
works like most other programs in Mac OS X Lion (and won’t be available in older ver-
sion of the OS), while Composition Mode is the same distraction-free writing interface
you’ve grown familiar with.
Full Screen for Lion
[10.7 (Lion) Only] For those who have upgraded to Mac OS X Lion (10.7), the new
full screen feature has been adopted by Scrivener, giving you another alternative work-
ing mode where the standard project window can take up the entire screen. This is in
addition to the familiar full screen editing mode, which has been renamed to Composi-
tion Mode. There are two ways to access this new feature: using the menu command](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-17-2048.jpg)
![82 CHAPTER 9. NAVIGATING AND ORGANISING
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).
Wiki Link Style
An optional method lets you type in new links without using the mouse at all, or even
being fully aware of the title you wish to link to. To enable this method, visit the Correc-
tions tab of Scrivener’s preferences, and turn on and [[Scrivener links]] in the Substitutions
section.
To use this method, while typing in the text you can enter two double-brackets, type
in the title of the item you wish to link to, and then close it with a second pair of brackets,
as shown. Scrivener will detect what you are trying to do, and if it finds an exact match to
a document, will link it for you automatically. If it does not recognise the text inside the
brackets as correlating with an existing title, the New Link sheet4 will pop-up, giving you
the option to either create a new item and place it in the Binder, or via the second tab,
“Link to existing document”, navigate to an existing document in the Binder and create
a non-literal link. Non-literal links are useful when you wish to link phrases in your text
without directly referencing the name of the item you are linking to. Once substitution
has been performed, the brackets will be removed.
As with other substitution types, wiki linking5 works only on newly typed material.
If you have previously typed in double-bracketed words, and then enable the option, you
will need to re-bracket them.
9.5.2 Removing Links
Links can be removed (including URLs to external web pages) with the Edit Unlink menu
command, without destroying the underlying text. Any link falling within the currently
selected text will be removed, so there is no need to be precise about what you select.
This is an easy way to wipe out dozens of links at once, something which is of particular
use when pasting text from web files, or other Scrivener documents with links.
Note that linked comments and footnotes will not be deleted with this command.
4
sheet-new_link-new.png
5
Referring to these links as “wiki links” does not imply that your project can become a wiki. It merely
refers to the appearance of the syntax as it is typed in. Scrivener links must always point to an existing
resource, unlike true wiki links, which can be placeholders for items which do not yet exist.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-90-2048.jpg)
![9.7. LAYOUTS PANEL 87
l Collection tab interface visible/hidden
l Inspector visible/hidden
l Split type (horizontal/vertical/none)
l Binder mode (whether it affects one or current editors)
l Header bar visible/hidden
l Footer bar visible/hidden
l Editors locked in place
l Ruler and Format Bar visible/hidden
l Selection auto-load in alternate editor settings
l Window size and position and view sizes
l Toolbar visible/hidden and view mode (such as small or large icons)
l Corkboard/outliner/scrivenings/editor mode for each split
l Page View or standard draft view for each split
l Full Screen status [10.7 (Lion) Only]
In addition, optional settings are saved depending upon whether these two checkboxes
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 tinting
is in use in the various areas of the interface; and pin, stamp, and keyword chip
visibility in the corkboard.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-95-2048.jpg)
![124 CHAPTER 13. CLOUD INTEGRATION AND SHARING
13.1.1 How It Works
Simplenote is a general purpose note-taking system and knows nothing of Scrivener or
Scrivener projects. When uploading documents to Simplenote, Scrivener therefore places
some information on the first line so that it is able to find and recognise these documents
again later, when you want to sync them. The information Scrivener places on the first
line is formatted like this:
MyDocumentName (MyProjectKeyword [ID])
--
“MyDocumentName” represents the document title as it appears in the binder,
“MyProjectKeyword” is the keyword you assign to the project in this wizard (see be-
low), and “ID” is an internal numerical ID that Scrivener assigns to all documents, which
you won’t normally see. In practice, it might look like this:
The Grand Finale (MyGreatNovel [756])
--
These three pieces of information in combination allow Scrivener to sync documents
with Simplenote. You should therefore not edit this line in Simplenote. In particular,
if you edit the project keyword or numerical ID, Scrivener may not recognise the Sim-
plenote text as belonging to the current project, or worse, it may try to sync it with the
wrong document in Scrivener. It is thus generally recommended that you leave this line
alone. However, you can edit only the document title (the part before the parentheses),
which will update the title in Scrivener when synced, if you really want to.
13.1.2 Getting Started
Login details The Simplenote Sync wizard will first prompt you to enter your login
details. Enter the e-mail address and password which you used to register for Sim-
plenote. You can check “Remember in keychain” to have your login details remem-
bered for the future.
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 remember,
and that is unlikely to occur on the first line of documents in general. For instance,](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-132-2048.jpg)
![13.1. SIMPLENOTE 125
Figure 13.1: Simplenote Sync: Configuration
you might use a wordsJammedTogether version of your project title, such as “My-
GreatNovel”.
Do not use (parentheses) or [square brackets] as part of your keyword. Since these
are used by Scrivener to identify the salient portions of the note’s identification,
adding additional brackets into the token can cause the sync to malfunction.
NOTE: It is important to understand that Scrivener has no way of knowing which doc-
uments in Simplenote are associated with which Scrivener project without this keyword,
so it is up to you to choose a unique keyword for each project. If two 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](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-133-2048.jpg)
![184 CHAPTER 14. WRITING AND EDITING
ing Corkboard or Outliner views, or media that would not otherwise respond to
scrolling.
Note that this form of scrolling is based on the scrollbar, not actual text position,
so the position of the scroll point will not be saved when used in conjunction with
the history button, like cursor position is. The exception to this are PDF files,
which are always saved by scroll-point, not cursor position.
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 transcrip-
tion. 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.
14.8.3 Managing Split Views
If you wish to swap the actual position of the material in the editors, so that the content
on the left now appears on the right, for example, use the View Layout Swap Editors
menu command.
To synchronise the contents of both splits, click the document icon in the header bar
for the side you wish to use, and select the Match Split Document(s) command. This will
duplicate your current view selection in the other editor. So if you are in a Scrivenings
session, that session will be duplicated; if you have a Multiple Selection view, that selec-
tion will be duplicated in the bottom view—and the current view mode in the active split
will be used instead of the active default for that split (and will thus set the default for
that split to the acquired view model).
14.9 Using Snapshots
Snapshots provide a way of backing up and saving different versions of individual docu-
ment. Taking a “snapshot” of a document takes a copy of the text of that document as it
exists at that exact moment in time and stores it so that you can return to it, or restore
it, at a later date. Using snapshots, you never need worry about making major edits to](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-192-2048.jpg)
![14.11. TEXT BOOKMARKS 189
point on. If you are not scriptwriting, or none of this matters to you terribly, then
this compatibility alert does not apply to you.
14.10.4 Binder Title Completion
If you have started typing in the name of a title that is found in your binder, you can
request a list of completions from Scrivener by pressing a different shortcut, Esc. A list
of all the titles that are still candidates for a match will be presented. As with the above,
you can use the arrow keys to select and item and hit return to insert the full title.
This feature is particularly useful in conjunction with the “wiki style” Scrivener link
option. Simply type in [[ start typing in the title name, hit Esc, select a title, and then
close with ]]. A Scrivener link will be automatically created for you.
14.10.5 Scriptwriting Auto-Completion
Scriptwriting mode engages a more aggressive auto-completion method, which scans as
you type and looks for completions, matching the behaviour of most scriptwriting pro-
grams on the market. Most of the script formats that are shipped with Scrivener come
stocked with many common phrases and abbreviations, which will be contextually tied
to the element you are currently working in. For example, “MOMENTS LATER” will
appear whilst typing in a Scene Heading element, but will not appear in a Dialogue ele-
ment.
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.
Since auto-completion cannot reliably determine appropriate letter case, sometimes it
may produce results that are undesirable, such as a mixed case location name in a slugline.
To remedy this, when selecting the auto-completion you wish to use, hold down the
Shift key. Any word or phrase selected with the Shift key held down will complete using
uppercase letters.
14.11 Text Bookmarks
Text bookmarks are useful when you wish to quickly mark a spot in your text in a way
that can be easily recalled later on, or for marking out sections of text in longer docu-
ments. There are two types of bookmarks:
1. Bookmark Annotation: This is your standard bookmark. Great for quickly mark-
ing a spot for later editing, quick navigation, or whatever you require.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-197-2048.jpg)
![Chapter 16
Composition Mode
Composition mode allows you to edit your text in a distraction-free environment. You
can view any text document (or Scrivenings session) in a composition mode akin to what
many so-called “zenware” applications provide, 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 composition mode. Menu
commands that would otherwise be available are turned off—in most cases because these
are commands which would have no meaning at all, such as commands for merging two
selected items in the binder, or enabling vorkboard view.
To determine what will be loaded into composition, Scrivener uses the active selection.
This selection can be made either in the sidebar, or in an outliner or corkboard view. This
works by implication as well: when no cards are selected in a corkboard, technically the
container is selected, as can be witnessed in the inspector, and so it is the container’s text
itself that will be loaded in composition, which might often be blank.
There are two exceptions to this rule:
1. View as Scrivenings: If you are viewing a group of documents in Scrivenings mode,
then composition mode will use that same mode. This is the easiest way to load an
entire container’s text into composition mode, as it requires no further selection.
2. Pre-load documents into history: If multiple items are selected and Scrivenings mode
is not enabled, then each item will be loaded into the composition mode’s history
queue. Working in this fashion, you can use – [ and – ] to flip between the docu-
ments without returning to the main project window.
Launch composition mode either by hitting – F, or select View Enter Composition
Mode.
When you first enter composition mode, you will see your document in the middle
of the screen set to a pinkish-grey paper colour, and masking the rest of the screen, a
black background. Nearly every aspect of this experience can be changed, some right
within composition mode. You will also briefly see the Control Strip (detailed below).
197](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-205-2048.jpg)
![17.1. INLINE NOTATION 207
tations are meant to be omitted upon export or print-outs (though do not have to be)
whilst footnotes become “real” footnotes upon export, and thus have more options avail-
able to them for styling footnotes, particularly with the RTF format option. Visually,
the difference is that footnotes are not coloured but are surrounded with a black bubble
and have a grey background.
Formatting Footnotes: Unlike annotations, any whitespace on the front or back of
the text will be stripped out. This allows you to insert “buffer space” around the foot-
note and help set it apart from the regular text. As with annotations, the placement
of the bubble is important in that the text around it should flow sensibly, but with
footnotes you also need to take into account that if the bubble were collapsed, that is
where the footnote reference mark would be. Try to visualise the entire bubble as a
single number, and this will help you with placement.
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 text in Scrivener is exported to RTF format, and opened in a compliant word proces-
sor, 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 vari-
ety of fashions for other formats as well, such as eBooks, MultiMarkdown syntax (and
therefore as proper footnotes in LTEX), as look-alike footnotes in HTML and plain-text,
A
amongst others. For all options available, read Footnotes/Comments (section 23.16).
17.1.3 Referenced Inline Footnotes
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.
If, however, you like inline footnotes but would still like to keep the bulk of the notes
outside of the main text body area, there is a method you can employ which works in
a referencing manner. To use this method, place a footnote in the intended location
within the text body, and type in a unique reference keyword surrounded by square
brackets. An example of this might look like this: [Reference]. Now somewhere else in
the same document, place the full content of the footnote and make sure to place that
same bracketed reference in its content area. For the above example, this could look like:
[Reference] Here is the text of the footnote as it will appear in the final manuscript.
When compiled, Scrivener will match the two footnote ranges together by their
bracket reference, remove the bracketed segment entirely, and shift the content so that it](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-215-2048.jpg)
![228 CHAPTER 18. INSPECTOR
The + button has three options available:
l Add Internal Reference: presents a menu containing all of the items in your project
binder. Click on any item, even a folder, to create a reference to it. The default
description for it will be its binder title.
l Look Up & Add External Reference: use this menu to load a file browser. Any file
you select in this browser will be added as a link to the reference list. The default
description for it will be the file name.
l Create External Reference: creates a new row in which you can manually copy and
paste or type in the internal title and valid URL or file path of the resource you
wish to link to. This is most useful for creating links to the Internet, as you can
just paste in the URL you have available.
Likewise, any existing reference can be edited by double clicking on the text labels. To
finish editing, press Return or click anywhere else in the table, with your mouse. You
can use this to update broken links with the correct file path or URL, or change their
internal names. For internal links to other Scrivener items in your project, you cannot
edit the target, only the name. To replace it with a new target, you’ll need to create a new
reference and then remove the old one.
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.
To delete a reference, select it and click the - button, or tap – Delete.
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 “[In-
ternal 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 accor-
dance 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.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-236-2048.jpg)
![230 CHAPTER 18. INSPECTOR
Viewing a particular keyword in the panel is easy to do, just double-click on the key-
word’s colour chip that you wish to see and the Project Keyword window will be opened
for you and will select the keyword in the list.
See Also:
1. Using Keywords (subsection 10.1.4)
2. Project Keywords (section 10.2)
18.4.4 Snapshots Pane
This section of the Inspector gives you easy access to all of your existing snapshots, the
ability to create new ones, load up comparative displays between snapshots or the current
editor, and delete old ones.
At the top of the Inspector, you will find two buttons. Clicking the + button will
create a new untitled snapshot for the current document (you can also use – 5 to do this
while typing). To remove a snapshot, select it in the table, and click the - button. To read
the contents of a snapshot, click on any of the rows and its text will appear in the text
preview area below the table. It is not possible to edit snapshots, but you can select text
from them and use copy and paste to restore bits of them. Read below for how to revert
the entire document to a selected snapshot.
The comparison control features let you quickly see differences between the snapshot
and the current version of the text, or between two snapshots, by selecting more than
one snapshot from the table. When in comparison mode, the button title will change to
Original which will return you to the non-annotated preview when clicked.
The two arrow buttons which will appear in comparison 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 produces
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. Thus, to switch to “By Clause”, you need only disable “By Word”.
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.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-238-2048.jpg)
![272 CHAPTER 21. USING MULTIMARKDOWN
marked up with tags or formatting instructions. While Markdown’s syn-
tax has been influenced by several existing text-to-HTML filters, the single
biggest source of inspiration for Markdown’s syntax is the format of plain
text email.
21.2 What is MultiMarkdown?
The following is Fletcher T. Penney’s description of MultiMarkdown:
Markdown is great, but it lacked a few features that would allow it to
work with documents, rather than just pieces of a web page.
I wrote MultiMarkdown in order to leverage Markdown’s syntax, but
to extend it to work with complete documents that could ultimately be
converted from text into other formats, including complete XHTML doc-
uments, LTEX, PDF, RTF, or even (shudder) Microsoft Word documents.
A
In addition to the ability to work with complete documents and conver-
sion to other formats, the Markdown syntax was lacking a few things. Michel
Fortin added a few additional syntax tools when writing [PHP Markdown
Extra]. Some of his ideas were implemented and expanded on in MultiMark-
down.
John Gruber may disagree with me, but I really did try to stick with
his proclaimed vision whenever I added a new syntax format to MultiMark-
down. The quality that attracted me to Markdown the most was its clean for-
mat. Reading a plain text document written in Markdown is easy. It makes
sense, and it looks like it was designed for people, not computers. To the
extent possible, I tried to keep this same concept in mind when working on
MultiMarkdown.
I may or may not have succeeded in this. . .
For comprehensive information about MultiMarkdown and how to use it, see
Fletcher’s web site2 .
21.3 MMD and Scrivener
The first thing to note when using MultiMarkdown in Scrivener is that because Scrivener
is a rich text editor, it has no plain text mode. This means that you can add bold, italics,
images and so forth to your text, but when you export to a MultiMarkdown format
2
http://fletcherpenney.net/multimarkdown/](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-280-2048.jpg)
![310 CHAPTER 23. COMPILING THE DRAFT
imported it 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 only] Once a cover image has been se-
lected, this option will be made available. It will include additional information
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. Do not use this option if you intend to publish using iTunes
Producer.
Cover page title [ePub only] You should not supply the name of your book here. This
is what will be used in the table of contents internally, to identify the cover page.
The standard “Cover” has been provided as a default.
23.7.1 SVG (ePub Only)
This is an advanced feature which will allow you to insert SVG code which can be used
in conjunction with, or instead of, a bitmap image. If you have been provided with SVG
artwork code by a designer, or have created one yourself, use the SVG button to access
the sheet. The text area labelled, “SVG Code” is where you will paste the vector format
code.
You will need to manually specify a default view box size. Get this information from
your designer, the graphics program you used to create the SVG code, or from the XML
itself. The actual size used is less important than maintaining the original aspect ratio.
Incorrect aspect ratio values (the factor between height and width) will cause the graphic
to become squashed.
You will need to research which SVG standard your target readers will be using. At
the time of this writing, most readers are capable of understanding SVG 1.0 and SVG 1.1
(including SVG 1.1 Basic). When copying the XML code, make sure not to include the
XML declaration and doctype lines. Only paste the SVG element and its contents. This
will be the line starting with:
<svg version="1.1" id="Layer_1"...](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-318-2048.jpg)
![Appendix A
Menus and Keyboard Shortcuts
This appendix will address each item in every menu, and will display the keyboard short-
cut for it when applicable. It is intended to be a quick, exhaustive reference of the menus,
and will attempt to point you in the right direction for more thorough discussion and
analysis of various features when necessary.
See also: Scrivener Shortcut Reference1 , on the Web.
A.1 Scrivener Menu
Much like the application menu in any other Mac OS X program, this provides access to
application level information, features, and system integration, such as Services.
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.
Preferences. . . ( – ,) Accesses the main application preferences window. For a com-
plete list of all available options, see Preferences (Appendix B).
Reveal Support Folder in Finder [10.7 (Lion) Only] Opens Scrivener’s “Application
Support” folder, where it stores your automatic project backups, custom project
templates, custom icons, and so on. Use this if you wish to transfer settings be-
tween machines, or if asked to do so for troubleshooting reasons.
Registration. . . [Standard Version] 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 the invoice, you can use the Retrieve Lost Serial... button which
will take you to a web page with further instructions on how to retrieve it. Not
1
http://www.literatureandlatte.com/wiki/doku.php?id=scrivener_shortcut_reference
371](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-379-2048.jpg)
![372 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
infrequently, invoices can end up in spam collection folders, so be sure to check
your e-mail application and make sure it did not get tagged as spam, first.
Check for Updates. . . [Standard Version] 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). This tool lets you 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 in this
menu, and from other applications as well. See Scrivener Services (section 11.2) for
further documentation.
Quit Scrivener Leaves the program. Any projects that are currently open will be saved
to the disk, if necessary, and backed up for you. Under the default preferences,
these projects will be remembered and opened automatically the next time you
run Scrivener.
A.2 File Menu
The File menu contains everything that handles creating files on your computer, includ-
ing creating new projects, saving, backing up, importing and exporting. It also deals with
printing and project-specific settings.
New Project. . . ( – N) New Project creates a new Scrivener project. This will bring
up the Project Templates window (see Quick Tour (chapter 6)) which will walk
you through creating a new project file in the location 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 (you can also specify in the General Preferences (section B.2) whether
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 prefer-
ence, which can be set in the system Appearance preference tab.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-380-2048.jpg)
![378 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
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 in the text editor,
this alternate method will be displayed. It is useful for selecting only the text in
the section you are currently editing within a Scrivenings session, rather than the
entire session.
Select Group with Descendants ( – A) When holding down the Option key with an
active item selection (excluding on corkboards), this alternate method will be dis-
played. It provides a useful shortcut to select an item and all of its descendant items
at once. This can be useful when performing an action that requires a literal selec-
tion. Corkboards cannot use this function, as they can only display one level of
hierarchy at a time.
Complete ( Esc) Manually calls up the word-completion service, regardless of word
auto-completion settings. Can optionally be invoked with – . or simply Esc by
itself on some keyboard layouts.
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.9)
to automatically detect Scrivener links typed in with [[Document Title]] wiki-style
bracketing.
Add Selection to Auto-Complete List Adds the currently selected 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](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-386-2048.jpg)
![A.4. VIEW MENU 387
Swap Editors Only available when Split Horizontally or Split Vertically is se-
lected (see above). This commands swaps the position of the two split panes.
For example, so that the view on the top will become the view on the bottom
and vice versa.
Show (Hide) Header & Footer View Toggles the visibility of the header and
footer bar. Both are elements of the editor and can be toggled independently
for each split. See Writing and Editing (chapter 14) for more information on
what these do.
Show (Hide) Layouts ( – )) Toggles the Layouts panel, which allows you to
manage view settings by saving the current settings, or retrieving other set-
tings you’ve saved in the past. See Layouts Panel (section 9.7).
Editor Options and commands for controlling the main editor.
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.
Scroll to Next/Previous Page These menu commands will only activate when
Page View is enabled on the active editor. They will flip the scroll bar by page,
rather than by relative position, as the keyboard PageUp and PageDown keys
do.
Show Titles in Scrivenings When enabled, editable titles of documents will be
placed in the editing session along with their associated texts. Titles can be
independently styled to set them apart in the Formatting tab (section B.8).
These will only appear in Scrivenings mode.
Forward/Backward in Document History ( – [ and – ]) Like a Web browser,
the editor keeps track of everything you’ve visited. Using these commands
you can navigate back and forth in the history. Note you can also use the
Forward and Backward buttons in the header bar. Each split keeps its own
history.
When selecting a number of documents in the binder prior to entering com-
position mode, the history queue will be pre-stocked with these selected
items, so long as the main editor is not set up in Scrivenings mode.
Other Editor Provides controls to manipulate whichever split is not currently
active.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-395-2048.jpg)
![388 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
l The Forward and Backward in History commands ( –] & – ]) op-
erate just like the above commands, only in the opposing split without
moving focus there.
l The Scroll Up and Down commands ( – UpArrow & – DownArrow)
act like PageUp and PageDown, only in the opposing split, again without
moving focus there.
Clear Document History Use this command to wipe out the document history
for 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 mech-
anism, 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).
Show Page View ( – P) Toggles Page View on and off.
These two options toggle between using your global page size preferences (which
can be entirely fictional, if you desire), or your print settings for a more accurate
depiction of the page.
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.7).
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.7).
Two Pages Across When enabled, instead of displaying pages in vertical column,
two will be placed beside each other as though reading a book.
Media Controls and options for various types of media. These commands will only
become available when viewing the appropriate type of media.
* 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.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-396-2048.jpg)
![A.4. VIEW MENU 389
l Automatically Resize: Keeps the PDF sized to the width and height of the
editor window.
l Actual Size: Zooms the PDF to 100%, even if it is too large to display all
at once.
l 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.
l 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.
l 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 be-
tween a text document and a media file, and you are typing in the text docu-
ment, 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.
* Fast Forward/Rewind ( –] / – [) Will jump playback forward or
backward by two seconds. This shortcut works while playback is running,
or while paused. In the latter case, it will stay paused at the new position. As
with Play Media File, will work in the opposing split while typing, providing
further aid for transcription.
Corkboard Options Features and visual options for the corkboard. The settings in
this menu are project specific, and some of them will only impact a single split,
allowing you to have different view settings for each editor. For more information
on using the corkboard, see The Corkboard (section 12.1). Note that further op-
tions 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](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-397-2048.jpg)
![394 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
l Left/Top Editor: The left/top editor no matter which editor is active.
l Right/Bottom Editor: The right/bottom editor split, no matter which editor
is active.
Enter (Exit) Full Screen [10.7 (Lion) Only] Utilises Lion’s full screen implementa-
tion, expanding the main project window to occupy the entire screen. In this mode,
the project window will be moved to its own “Space3 ”, and cannot be resized until
Exit Full Screen has been invoked. Exiting Full Screen mode will return the project
window to the original Space that it came from.
[New in 2.1] The menu command by this name was previously used to invoke
Scrivener’s full screen text editing mode. The name of this feature has been changed
so as to not conflict with Lion’s standard naming convention.
Enter (Exit) Composition Mode ( – F) Enters the full screen writing environment,
switching to text editing mode if necessary. If the editor is displaying a Scrivenings
session, the entire session will be opened in full screen. Note this option is not
available to media and web pages, or any other view modes.
[New in 2.1] This feature used to be named “Full Screen”. It has been changed
to avoid conflicts with the Lion feature by the same name. Even if you are not
running Lion, the new name will be in use for the sake of consistency.
Composition 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 re-
sources in the project will be listed in this menu, or you can select Choose... to
select an image from your computer. To remove an image you’ve already set, select
None.
Show (Hide) Toolbar Toggles the visibility of the main application toolbar.
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.
3
Apple’s term for virtual desktops, where you can create a fresh empty desktop for a particular session
of work.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-402-2048.jpg)
![396 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS
Show (Hide) Project Keywords ( – H) Displays or closes the Project Keywords
(section 10.2), for managing all of the keywords in use by your project.
[New in 2.1] This feature has been renamed from “Keywords HUD”.
Meta-Data Settings. . . ( – ,) Displays a sheet which lets you adjust the two main doc-
ument meta-data fields (Label and Status by default, but these can be renamed), as
well as the custom meta-data columns for this project.
See also: Setting Up Meta-Data (chapter 10).
Text Preferences. . . Displays a sheet which presents a configuration pane very similar
to the one found in the Formatting tab (section B.8) of application preferences.
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. Additionally the linked footnote mode can be modified to use an
anchor marking, instead of highlight words and phrases in the main text editor.
Read more about Text Preferences (section 10.4).
Edit Auto-Complete List. . . Displays a sheet which lets you manually add and remove
terms to the project’s auto-complete list. Depending on your auto-completion set-
tings, this will let you add custom names, places, and workflow indicators to assist
in typing out repetitive items. Modify how agressive auto-complete should behave
in the Corrections preference tab (section B.9).
Set Selection 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.
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.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-404-2048.jpg)
![A.6. DOCUMENTS MENU 399
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 func-
tion in View Inspect Snapshots provides the shortcut key, – M.
Show Changes When a snapshot is selected from the snapshot list, it is possible
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.
l Compare/Original: Toggles visibility of the change tracking mode.
l Comparison Granularity: These options can be toggled on and off in-
dividually 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 avail-
able. Use these settings to fine-tune the results if what you are getting is
too precise or vague to be useful.
l Next Change: ( – ]) Scrolls the view to the next available difference in
texts.
l Previous Change: ( – [) Scrolls the view to the previous difference.
The following two commands will only activate when a snapshot selection is
active in the Snapshot Inspector pane.
Roll Back Rolls back to the selected snapshot, replacing the text in the main edi-
tor. The option to snapshot the current editor text, before making this revi-
sion, will be given in a pop-up dialogue box.
Delete Permanently removes the selected snapshot from the disk. You will be
asked to confirm this action as it cannot be undone. You may also delete
snapshots with the backspace key, or by clicking the - button in the Snapshots
Inspector.
Duplicate There are two different methods you can use to duplicate the selected
item(s).
l with Subdocuments and Unique Title: ( – D) This is the default method in
most applications. The entire item (including all of its children if it has any)
will be duplicated, and it will be provided with a unique name automatically.](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-407-2048.jpg)
![B.3. APPEARANCE 421
B.3.6 Customizable Colours
Custom interface colours are chosen using a column view. To alter the default colour for
the desired interface element, first select the major category in the leftmost column and
then the item itself from the middle column. Click on the colour well in the right column
to assign a new colour, or click Use Default Color to reset the option to the application
default. Since the program updates in real time as you alter the preferences, it is often
beneficial to display the area you wish to customise, then adjust the colours while viewing
the changes.
There are a few extra options located around the main table:
Use different colors in full screen [10.7 (Lion) Only] When using the new Lion full
screen feature, you can optionally choose to use a different set of colours for most,
but not all, of the colour settings. When this checkbox is enabled, a “Full Screen”
section will be added to the left-most column. Any changes made within this cate-
gory will only be used when the project window is in full screen mode.
Use dark gray theme Adjusts a number of interface detailing to use a darker grey
theme, which can improve the appearance of colour themes which are darker in
mood. Additionally, if you use the Graphite system theme, you might prefer its
graphite toned active header bar, which replaces the blue active header bar.
Use dark gray theme in full screen only [10.7 (Lion) Only] When enabled, the dark
gray theme will only be in effect when using Lion’s full screen mode. In conjunc-
tion with using different colours to establish a darker overall palette in full screen,
you could create an effective day mode vs. night mode.
Note: Some categories have identical settings, such as both the Editor and Composi-
tion Mode sections containing “Scrivening Titles”. Where duplication exists, the refer-
ence tables (Table B.1) will list only the first entry.
Some background colour options also allow a texture. When you see the button
Choose Texture..., you can set this particular element of the interface to use a tileable
graphic for its background instead of a colour. Many tiling graphics can be found on the
Internet for free. It is best to choose textures that are relatively small, as larger textures
can slow down the interface. To clear a texture you no longer want to use, just click the
Use Default Color button. The elements which take a texture are:
l Editor: Text Background
l Editor: Page Background](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-429-2048.jpg)
![B.10. IMPORT AND EXPORT 441
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 language set-
tings. To customise these, click the System Text Preferences... button that is pro-
vided at the bottom of the window.
Disable smart quote, em-dash and ellipsis substitution in script mode The three op-
tions above this one 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 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.
Automatically detect [[Scrivener links]] Scrivener document titles can be linked to by
surrounding the title in double-brackets. For more information on this feature, see
Linking Documents Together (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.
B.10 Import and Export
Scrivener supports a wide variety of file formats, both for import into a project and for
exporting or compiling. The options in this tab adjust how these functions operate.
B.10.1 Import Options
Import supported file types only By default, Scrivener will only allow you to drag file
types into the binder3 if it can internally display them. Scrivener will store un-
supported files with the rest of the project, but will not be able to display them,
though with Mac OS X 10.7 (Lion), you’ll see a Quick Look preview of the file, if
it provides one. You will still be able to load them using external applications.
This option prohibits importing unsupported file types. If any have been imported
into projects in the past, they will remain.
RTF These two options set how RTF comments and footnotes will be converted to
Scrivener’s notation format. By default, they will be formatted as linked notation.
3
You can only ever drag text files, or folders with text files, into the Draft](https://image.slidesharecdn.com/usermanual-120729050305-phpapp02/75/User-manual-Scrivener-2-1-for-Mac-449-2048.jpg)
Uploaded byGBSNetworks
User manual Scrivener 2.1 for Mac
This user manual provides instructions for using Scrivener 2.1 software. It includes sections on installation and interface overview, project management, outlining and organizing documents, writing and editing tools, compiling drafts into final formats like PDF and HTML, and customizing preferences. The manual contains over 400 pages with detailed explanations and screenshots to help users maximize the power of Scrivener for drafting, organizing, and compiling a variety of creative works and documents.
More Related Content
![[Webinar] Mehr Conversions mit dem Social Media/Landing Page Message Match](https://cdn.slidesharecdn.com/ss_thumbnails/webinarunbouncehootsuitemessagematchv6slideshare-150505122427-conversion-gate01-thumbnail.jpg?width=640&height=640&fit=bounds)
Similar to User manual Scrivener 2.1 for Mac
User manual Scrivener 2.1 for Mac
- 1. User Manual Scrivener 2.1 forMac OS X Literature & Latte July, 2011 Revision: 2.1-01f c 2010–2011, Literature & Latte LTD. All rights reserved.
- 2. II Preparation 45 7 Project Management 48 Contents 7.1 7.2 Project Size Limitations . . Creating a New Project . . . . . 48 49 7.3 Saving and Making Copies . . 50 7.4 Opening Existing Projects . . 50 7.5 Moving Projects on Your Contents ii Drive . . . . . . . . . . . . . . . 51 7.6 Templates . . . . . . . . . . . . 51 Acknowledgements vi 7.7 Backing Up Your Work . . . 56 7.8 Tips for Working Cross- Platform . . . . . . . . . . . . . 59 I Introduction 1 8 Setting Up the Binder 60 1 Philosophy 2 8.1 How the Binder is Organised 60 8.2 Binder Controls . . . . . . . . 64 2 About This Manual 5 8.3 Using Collections . . . . . . . 66 2.1 Terms and Conventions . . . 6 8.4 Document Templates . . . . . 71 3 What’s New 8 9 Navigating and Organising 74 9.1 General Navigation . . . . . . 74 4 Installation and Upgrading 16 9.2 Go To Menu . . . . . . . . . . . 75 4.1 Portable Installations . . . . . 17 9.3 Hoisting the Binder . . . . . . 76 4.2 Registering . . . . . . . . . . . . 17 9.4 Controlling Binder Integra- 4.3 Application Updates . . . . . 19 tion . . . . . . . . . . . . . . . . 77 4.4 Upgrading from Scrivener 1 . 19 9.5 Linking Documents Together 79 4.5 Staying Informed . . . . . . . . 21 9.6 Using Favourites . . . . . . . . 85 9.7 Layouts Panel . . . . . . . . . . 85 5 Interface 22 9.8 Full Screen Mode . . . . . . . . 88 5.1 Interface Overview . .... . 22 9.9 Filtering Items in Views . . . 89 5.2 View Modes . . . . . . .... . 29 5.3 Composition Mode (Full 10 Setting Up Meta-Data 90 Screen Editing) . . . . .... . 33 10.1 Meta-Data Types . . . . . . . . 90 5.4 Selections . . . . . . . . .... . 33 10.2 Project Keywords . . . . . . . 95 10.3 Project Properties . . . . . . . 96 6 Quick Tour 35 10.4 Text Preferences . . . . . . . . 98 6.1 Project Format . . . . . . . . . 35 6.2 The Main Window . . . . . . 37 11 Gathering Material 99 6.3 Outlining Your Draft . . . . . 38 11.1 File Import . . . . . . . . . . . . 99 6.4 Compiling the Draft . . . . . 43 11.2 Scrivener Services . . . . . . . 105 ii
- 3. CONTENTS iii 11.3 Linking to Files on Your 16 Composition Mode 197 Computer . . . . . . . . . . . . 106 16.1 Using Background Image 11.4 Scratch Pad Panel . . . . . . . . 106 and Textures . . . . . . . . . . . 198 11.5 Text Appending Tools . . . . 107 16.2 The Control Strip . . . . . . . 198 11.6 Print as PDF to Scrivener . . 108 16.3 Full Screen Inspector HUD . 200 16.4 Customising Full Screen 12 Project Planning 109 Appearance . . . . . . . . . . . 200 12.1 The Corkboard . . . . . . . . . 109 16.5 Composition Mode with 12.2 The Outliner . . . . . . . . . . 115 Multiple Displays . . . . . . . 200 12.3 Project Notes . . . . . . . . . . 118 12.4 Custom Icons . . . . . . . . . . 120 17 Annotations and Footnotes 202 17.1 Inline Notation . . . . . . . . . 204 13 Cloud Integration and Sharing 123 17.2 Linked Notation . . . . . . . . 208 13.1 Simplenote . . . . . . . . . . . . 123 17.3 General Usage Tips for No- 13.2 Synchronised Folders . . . . . 132 tation . . . . . . . . . . . . . . . 212 13.3 Which to Use? . . . . . . . . . 141 17.4 Text Colour and Highlights . 216 13.4 SimpleText.ws . . . . . . . . . 142 17.5 Marking Revisions . . . . . . . 219 13.5 Index Card for iPad . . . . . . 142 17.6 Text Markings and Multi- 13.6 Scrivener Everywhere . . . . . 147 Markdown . . . . . . . . . . . . 223 18 Inspector 225 III Writing 150 18.1 Synopsis Card . . . . . . . . . . 225 18.2 General Meta-Data View . . . 226 14 Writing and Editing 153 18.3 Custom Meta-Data View . . . 226 14.1 Rich Text Editing Philosophy 153 18.4 Document Support Panes . . 226 14.2 Editing Basics . . . . . . . . . . 154 18.5 Locking the Inspector . . . . . 232 14.3 Editing with Scrivener . . . . 156 18.6 Advanced Inspector Key- 14.4 Formatting Tools . . . . . . . . 163 board Usage . . . . . . . . . . . 232 14.5 Header Bar . . . . . . . . . . . . 174 14.6 Footer Bar . . . . . . . . . . . . 177 19 Scriptwriting 234 14.7 Viewing Media in the Editor 179 19.1 Formatting a Script in 14.8 Splitting the Editor . . . . . . 182 Scrivener . . . . . . . . . . . . . 234 14.9 Using Snapshots . . . . . . . . 184 19.2 Using Page View to Esti- 14.10 Auto-Completion . . . . . . . 187 mate Page Counts . . . . . . . 236 14.11 Text Bookmarks . . . . . . . . 189 19.3 Importing a Script from Fi- 14.12 Editing Multiple Docu- nal Draft and Other Programs 237 ments (Scrivenings View) . . 190 19.4 Printing or Exporting a Script 240 19.5 Working with Final Draft 8 . 240 15 Page View 195 19.6 Creating Your Own Script 15.1 Setting Page View Dimen- Formats . . . . . . . . . . . . . . 243 sions . . . . . . . . . . . . . . . . 195 19.7 Using Script Formatting 15.2 Tips for Accuracy . . . . . . . 196 for Other Purposes . . . . . . 249
- 4. iv CONTENTS 20 Writing Tools 250 23.14 Replacements . . . . . . . . . . 331 20.1 Searching and Replacing . . . 250 23.15 Statistics . . . . . . . . . . . . . 334 20.2 QuickReference . . . . . . . . 259 23.16 Footnotes/Comments . . . . 335 20.3 Goals and Statistics Track- 23.17 Page Settings . . . . . . . . . . . 341 ing Tools . . . . . . . . . . . . . 262 23.18 Meta-Data . . . . . . . . . . . . 346 20.4 The Name Generator . . . . . 268 23.19 RTF Compatibility . . . . . . 350 20.5 Bibliography Management . . 269 23.20 Quick Font Override . . . . . 351 20.6 Using Equations with 23.21 KindleGen . . . . . . . . . . . . 352 MathType . . . . . . . . . . . . 270 24 Exporting 353 21 Using MultiMarkdown 271 24.1 Drag and Drop Between 21.1 What is Markdown? . . . . . . 271 Projects . . . . . . . . . . . . . . 353 21.2 What is MultiMarkdown? . . 272 24.2 Exporting Binder Files . . . . 353 21.3 MMD and Scrivener . . . . . . 272 24.3 Exporting to an Outliner 21.4 Importing MMD Files . . . . 273 with OPML . . . . . . . . . . . 354 21.5 Exporting MMD Files . . . . 274 24.4 Exporting Meta-Data to a 21.6 MMD in Rich Text Envi- Spreadsheet . . . . . . . . . . . 356 ronment . . . . . . . . . . . . . 275 21.7 MMD Meta-Data . . . . . . . . 276 25 Printing 358 21.8 Updating MultiMarkdown . 277 25.1 Document Printing . . . . . . 358 21.9 Advanced MultiMarkdown . 277 25.2 Printing Index Cards . . . . . 360 21.10 Further Information . . . . . 277 25.3 Printing Outlines . . . . . . . 362 25.4 Printing the Draft . . . . . . . 364 IV Final Phases 278 V Advanced 365 22 Creating a Table of Contents 281 26 MultiMarkdown Tips and Tricks 367 23 Compiling the Draft 285 26.1 Functional Annotations 23.1 Compile Summary . . . . . . 286 and Comments . . . . . . . . . 367 23.2 Built-in Presets . . . . . . . . . 288 26.2 Multiple Footnote Streams 23.3 Available Compile Formats . 289 with MMD . . . . . . . . . . . . 368 23.4 Expanded Compile Interface 296 27 Customising Keyboard Shortcuts 369 23.5 Contents . . . . . . . . . . . . . 298 23.6 Separators . . . . . . . . . . . . 306 23.7 Cover . . . . . . . . . . . . . . . 308 VI Appendices 370 23.8 Formatting . . . . . . . . . . . . 311 23.9 Title Adjustments . . . . . . . 323 A Menus and Keyboard Shortcuts 371 23.10 Layout . . . . . . . . . . . . . . 323 A.1 Scrivener Menu . . . . . . . . . 371 23.11 Script Settings . . . . . . . . . . 327 A.2 File Menu . . . . . . . . . . . . 372 23.12 Transformations . . . . . . . . 328 A.3 Edit Menu . . . . . . . . . . . . 376 23.13 HTML Settings . . . . . . . . . 331 A.4 View Menu . . . . . . . . . . . 383
- 5. CONTENTS v A.5 Project Menu . . . . . . . . . . 395 B.8 Formatting . . . . . . . . . . . . 437 A.6 Documents Menu . . . . . . . 397 B.9 Corrections . . . . . . . . . . . 439 A.7 Format Menu . . . . . . . . . . 403 B.10 Import and Export . . . . . . 441 A.8 Window Menu . . . . . . . . . 409 B.11 Backup . . . . . . . . . . . . . . 444 A.9 Help Menu . . . . . . . . . . . . 410 C Placeholder Tags 446 B Preferences 413 D Tips and Tricks and Trouble 447 B.1 Preference Presets and D.1 Getting Support . . . . . . . . 447 Themes . . . ...... .... . 414 D.2 Bookmarks or Small Files . . 447 B.2 General . . . ...... .... . 415 D.3 Using Scrivener in a Secure B.3 Appearance ...... .... . 418 Environment . . . . . . . . . . 448 B.4 Corkboard . ...... .... . 422 D.4 Hidden Preferences . . . . . . 449 B.5 Compose . . ...... .... . 427 D.5 Troubleshooting . . . . . . . . 452 B.6 Navigation . ...... .... . 430 B.7 Editor . . . . ...... .... . 434 E Legal 454
- 6. Acknowledgements Many thanks tothe following people for very kindly donating time or code to Scrivener: Heinrich Gliesen—help with inline image Scrivener’s HUD panels in Tiger (code to be scaling. found on their respective web sites). Jonathon Mah—help with the bubble high- Philip Dow (author of Journler6 )—help with lights around comments and footnotes. the custom ruler code. Andreas Mayer—NSBezierPath and table view Wagner Truppel for help figuring out how to extensions1 . draw the diagonal status text in the corkboard. Andrew C. Stone—smart quotes code2 . Martin Wierschin of Nisus, for various help Todd Ransom (author of Avenir) at with the chicaneries of the text system and returnself.com—filtering and page number RTF. printing code. Peter Maurer—help with the custom animated Jesse Grosjean (author of Mori and Write- disclosure triangles (and kindly provided the Room) at Hog Bay Software—auto-saving code. images too). Split view code based on OASplitView from Christian and Eric at Devon Technologies7 — the excellent OmniGroup3 . help with keeping Scrivener in the background Andy Matuschak—for various resources and when the clippings services are used. great code snippets available on his website. Positive Spin Media—the tab bar in the project Matt Gemmell—various code snippets (includ- notepad uses PSMTabBarControl, Copyright ing the colour contrast code, the use of Quick c 2005, Positive Spin Media (all rights re- Look for the file link view and the corkboard served), which in turn uses portions of code options bubble window) from his source code from Copyright 2004 The Shiira Project8 (all site4 . rights reserved). Andy Matuschak5 and Matt Gemmell are Malte Rosenau—for pointing me in the direc- also responsible for the basis of the code for tion of the code I needed to import web pages 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 vi
- 7. vii with their titlesintact. line of code from Skim14 . James Hoover, creator of Bean9 , for providing The redoubtable Douglas Davidson, Apple en- the basis of the “show invisibles” code and for gineer and guru, for responding so helpfully to sharing various other code snippets from his so many of my enquiries about the intricacies work on Bean. of the Cocoa text system. Brent Simmons—the OPML importer code is Aki Inoue at Apple for advice about the word based on a class created by Brent Simmons for count code. NetNewswire (Copyright c 2002, Brent Sim- Fletcher Penney, for contributing so much time mons). and effort in helping me get MultiMarkdown Shortcut Recorder is c Contributors of Short- implemented in Scrivener. cutRecorder10 —thanks to Jesse Grosjean for Everyone on the Cocoa-Dev list for their help pointing me in the direction of this project. and support, with special mention to Bill Nathan Day—the PDF Services alias file is cre- Cheeseman, Malcom Crawford, Max and Mar- ated using Nathan Day’s NDAlias class11 . cus at Blue Technologies (authors of Ulysses), J. Mark Onyschuk—help with the window flip- Nozzi at Bartas Technologies (author of Copy- ping code for the templates panel, which is Write). based on his LIFlipEffect12 . Stephen Kochan, author of Programming in Kino—the Snapshot comparison tool was in- Objective-C, for answering my questions when spired in large part by Kino’s “Compare Docu- I was getting started. ments” macro for Nisus Writer Pro. Many thanks to the developer of Index Card, Robert Warwick13 —the improvements to text “DenVog”, who went out of his way to help table support are based on code Robert wrote get syncing to work between Index Card and for Stone Hill Invoicer. Scrivener. Improved PDF anti-aliasing was provided by a 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 composition mode on a dual-monitor set up. Ernesto Salcedo, for help with a bug in viewing webarchives. Sophie, for implementation ideas in expanding Scrivener’s MultiMarkdown capabilities. 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 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/
- 8. viii ACKNOWLEDGEMENTS turning me into a geek. — Keith Blount
- 9.
- 10. Chapter 1 Philosophy The maker of a sentence launches out into the infinite and builds a road into Chaos and old Night, and is followed by those who hear him with something of wild, creative delight. Ralph Waldo Emerson 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 until 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 varying 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: l The software should allow the writer to use many of the formatting features famil- iar to word processors—different fonts, italics, paragraph styles and so on. It is up to the writer to avoid distractions, not the software. 2
- 11. 3 lWhat 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). l There should be a synopsis linked with each document that can be viewed with other synopses to get an overview of the project as a whole. l 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. l It should be possible to view individual “documents” either as discrete chunks of text or combined with other (arbitrary) documents. Thus, for instance, a chapter could be viewed as a whole or each scene could be viewed individually. l 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. l The software should be capable of storing and displaying common research docu- ments, because writers do not just use text—they also refer to images, web pages, recorded interviews and other media. The overriding philosophy behind Scrivener was in part inspired by a passage written 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 “growing 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 re-pin the index cards accordingly.
- 12. 4 CHAPTER 1. PHILOSOPHY 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 fea- tures found in any text editor along with the functionality for “growing” your work organically within the program itself.
- 13. Chapter 2 About This Manual This manual has been written using Scrivener and is available in three different formats. If you purchased a boxed copy of Scrivener, you should have a printed version of it available for desktop reference. It can also be accessed as a PDF from the Help menu, under User Manual. You should also find two copies which have been specially formatted to be printed on either US Letter or A4 standard printer paper on our website1 . Lastly, the Scrivener project used to author the manual can be downloaded from the Support section of the Literature & Latte website as a demonstration of writing in Scrivener. It has been written using the MultiMarkdown formatting syntax and so demonstrates that system as well. The manual itself has been split into five primary sections and an appendix. The first section introduces Scrivener’s terminology and interface and gives a quick tour for those who want to start writing as soon as possible. It is highly recommended that you also go through the separately available Interactive Tutorial (which can be accessed via the Help menu in Scrivener) to get the most out of Scrivener and eliminate confusion over some of its unique features, but the quick tour (chapter 6) should have you writing using Scrivener’s basic main features within half an hour. Scrivener has a wide variety of features to accommodate many different purposes, in- cluding novels, screenplays, academic papers and dissertations, general non-fiction, jour- nalism, blogging, and much more. While it strives to present as simple an interface as possible, once you start digging into the application, you will find a degree of flexibility and complexity to suit even the most esoteric needs. To help organise all of these con- cepts, the next three sections take a pragmatic look at the primary stages of any major project, Preparation (Part II), Writing (Part III), and Final Phases (Part IV), and detail Scrivener’s tools for aiding you through the drafting process and ultimately exporting and printing your work. In each section the features most useful to you during those phases will be explained in depth. The last section, Advanced (Part V), deals with spe- cialty topics such as MultiMarkdown. If you want to find a specific feature, consult the appendices at the end of the manual for a cross-referenced list to every menu item and 1 http://www.literatureandlatte.com/support.php 5
- 14. 6 CHAPTER 2. ABOUT THIS MANUAL window. Users who are already familiar with prior versions of Scrivener will want to consult 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. The PDF and Scrivener project versions of this manual will always be the most up-to- date. 2.1 Terms and Conventions Some features apply only to the standard version of the software, and others only apply to the Mac App Store version. Various key features will be marked to indicate this. If you have purchased the program directly from our web site, then you have the standard version. If you used Apple’s App Store tool to buy Scrivener, then you have the Mac App Store version. Sections applicable to only one or the other will be indicated as such: l Standard retail version of Scrivener: [Standard Version] l Mac App Store version of Scrivener: [App Store Version] Whenever the documentation refers to an action that must be taken by you, the visible name for that action will be formatted like so. Button labels, menu items, and keyboard shortcuts will all be displayed in this fashion. Menus will be displayed in a hierarchy using the “ ” character to separate top-level, sub-menu, and items. Example: To convert a range of selected text to uppercase, invoke the Format Convert To Uppercase command. Keyboard shortcuts will use the following symbols: l –: The Command key, or the Apple key, is the one located directly to the left and right of your spacebar. l : 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. l : Control is usually located to the left and right of the Option keys on their respective side. Some laptops only have one Control key between the Option key and the Fn key on the left side. l : The Shift keys are rarely used by themselves in shortcuts but are often used in combination with other modifier keys.
- 15. 2.1. TERMS ANDCONVENTIONS 7 When a keyboard shortcut requires a combination of modifier keys, they will be printed together. Example: – V, which matches Edit Paste and Match Style, means you should hold down all three of these modifier keys and then tap the V key on your keyboard. The hyphen is used to separate the modifier keys from the target key and is not meant to be included in the shortcut itself. Interface elements will be capitalised as proper nouns to help differentiate them from standard nouns when appropriate. A Collection is an interface element, while the word “collection” can be used to indicate a casual grouping of items, and not necessarily a formal Collection. Some of the names for various elements within Scrivener are customisable on a per project basis, and how you name these will impact much of the interface. A good example is the Draft, the 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 shorthand to describe your personal home folder will be used. An example might look like: ~/Documents The tilde is a shorthand which means: “/Users/yourusername”. In this case, the path refers to the Documents folder in your home folder.
- 16. Chapter 3 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 documents, free- form corkboards, better snapshot integration, and much more. We understand 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, allowing you to be up and running 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). New in 2.1 MathType Integration Those who need to work with equations will be pleased to find that Scrivener 2.1 now offers integration with MathType, the premier equation editing and typesetting software by Design Science1 . Adding equations is now as simple as using Edit Insert MathType Equation. Once added to your draft, you can double-click at any time on the equation to open it for editing. Compile Summary Mode The Compile feature has always been one of the richest areas of Scrivener 2.1, and also carries with it some of the most complex parts of the program. In the past, if you wanted to compile you either had to be happy with one of the pre-built formats, or dive into the full advanced interface. The new Compile Summary Mode (section 3) expands the basic 1 http://www.dessci.com/en/products/mathtype/ 8
- 17. 9 compile view, addingcrucial and commonly needed options. Even if you already know how to use the compiler, you may find Summary mode to be of greater convenience for once involved tasks, like changing the font of a preset from one style to another. Quick Find by Synopsis Quickly searching for items in the Binder is now easier with the Find Synopsis (subsec- tion 20.1.4) tool. This window features a search engine which gathers results as you type, and quick access to the index card or graphic for any of these results. Use this tool to quickly find items by name or synopsis text, jot down notes in the synopsis text, or as a tool to locate and load items, without disturbing your current working area. Colour Themes In the past you’ve been able to save out your preferences to a file, and so by using that you could save different colour sets as “themes”. However this had a drawback in that it saved all of your preferences in that file, not just the appearance settings. Now you can save just appearance settings using the same Manage... menu from the Preference window. Themes let you switch colour sets with ease, so you could for example use a brighter Composition theme during the day, and switch to a darker theme at night. Composition Mode Well all right, this isn’t a new feature, but we thought you should know that what we’ve been calling “Full Screen” all this time is now called “Composition Mode”. Why? In short, Mac OS X Lion happened along, and as you may know, the phrase “full screen” is destined to become a phrase that most Mac users associate with a particular feature: expanding the application to fit the display—not completely changing the interface into something else. So Scrivener now has two different features for maximisation. Full Screen works like most other programs in Mac OS X Lion (and won’t be available in older ver- sion of the OS), while Composition Mode is the same distraction-free writing interface you’ve grown familiar with. Full Screen for Lion [10.7 (Lion) Only] For those who have upgraded to Mac OS X Lion (10.7), the new full screen feature has been adopted by Scrivener, giving you another alternative work- ing mode where the standard project window can take up the entire screen. This is in addition to the familiar full screen editing mode, which has been renamed to Composi- tion Mode. There are two ways to access this new feature: using the menu command
- 18. 10 CHAPTER 3. WHAT’S NEW (View Enter Full Screen) or window button along the top2 , or by using a saved Layout that has been created in full screen mode. In the latter method, you can create special full screen layouts (such as nothing but a huge corkboard) and easily access them with the Layouts feature. To promote this, the Layouts toolbar button has been added to the default set, and the Layouts menu itself now occupies its own place in the Window menu, rather than being buried in the View menu as before. Data Export Two new export features have been added to better allow exporting to spreadsheet appli- cations and outliners, using common standards for doing so. For spreadsheets, you can now export any Outliner view to CSV (you can choose between comma, tab, or semi- colon separators). This can, if you wish, be a full output of every possible column, or just the columns you have visible in the Outliner. For applications based on structural hierarchies, like dedicated outliners, you can now export to OPML. New in 2.0 Freeform Corkboards The corkboard feature has always been another way to view and rearrange the order of your book by placing it into a familiar metaphor. Scrivener 2 takes the metaphor the rest of the way. Now you can view a freeform corkboard for your sections where cards can be moved around arbitrarily, allowing the right brain to visualise your book in new ways. If you decide to commit the new order into the binder outline, you can do so with the press of a button. For more information, read The Corkboard (section 12.1). Collections Collections add tabs to your binder, giving you the ability to collect groups of documents together 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 your editor has marked as being too verbose, then remove them from the collection as you trim them down. Create another tab to store all of the documents that still need citations. Build smart collections that automatically look for search terms every time you view the tab. For more information, read Using Collections (section 8.3). 2 The new conventional shortcut for this feature across many applications is – F, which Scrivener now uses to enter and exit Lion’s full screen mode. Previously, this was used by Project Search (subsec- tion 20.1.2), which has had its shortcut changed to F.
- 19. 11 Marginalia Now you geta choice between using 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 also works as a bookmarking system. Clicking on the notes in the inspector column will automatically scroll your editor to its linked position in the document. This is especially useful in Scrivenings view, where you can see all of the notes for the collected documents at once. Your old projects will upgrade using 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). Improved Compile For most Scrivener authors, compile is the last crucial step where all of your hard work is bound together into a single document. It lets you write in a way that is comfort- able for you, while quickly generating a format that is comfortable for your editor or agent. Scrivener 2 recognises the importance of this process and has increased its abili- ties in nearly every facet. Now you can design export instructions which automatically title and number your chapters for you; insert custom separators between types of doc- uments; filter compile according to meta-data or other criteria; and export to more for- mats, including ePub and WebArchive, with even better Final Draft support. Compile now takes your export format into account and reduces the complexity of the options provided accordingly. For more information, read Compiling the Draft (chapter 23). iPad Workflow Support While the iPhone and iPod touch gave people a taste of mobile writing, the iPad has made this more practical. In response, 2.0 features integration with the popular Simplenote and Index Card for iPad, as well as the ability to synchronise parts of your project text with an external folder full of files. In combination with a file-sharing service like Dropbox3 , this latter feature provides integration with many plain-text editors on the iPad and can also be used as a collaboration tool. To read more about these new features, see Cloud Integration and Sharing (chapter 13). Better View Integration The relationship between corkboard, outliner, and editor was, for many, a stumbling block when learning Scrivener. A lot of thought has gone into making this relationship 3 Dropbox is a free tool that lets you keep a folder synchronised between all of your computers. For more information, visit the Dropbox homepage4
- 20. 12 CHAPTER 3. WHAT’S NEW more intuitive. You no longer have to worry about choosing between Edit Scrivenings (now called Scrivenings) and other view modes or setting preferences to change the be- haviour of clicking on items in the binder. Whatever group view mode you used last is what Scrivener will use the next time, and switching among the views is now more seamless. The toolbar buttons 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. QuickReference Windows Since there are occasions when it is fruitful to have more than two documents open at once, Scrivener now provides a QuickReference panel. It’s a bit like Finder’s Quick Look, except unlike Quick Look, you can actually edit the content and have multiple panels open at once. You can even split the QuickReference panel and edit nearly any- thing in the second pane that would ordinarily require the inspector to be open. Quick- Reference panels can also be used while working in composition mode. For more infor- mation on how to use QuickReference panels, read QuickReference (section 20.2). Snapshots and Changes Taking snapshots of your documents as you work has always been a crucial safety net in Scrivener, but Scrivener 1 just gave you a list of snapshots in a window and made you do the work of figuring out what had changed and which snapshot was which. Snapshots have now been moved into the inspector, meaning you can view them right alongside your current version. They can even be loaded into the editor itself as a read-only ref- erence. You can also now ask Scrivener to mark changes between revisions, and it will highlight new words and overstrike deleted words for you. For more information, read Snapshots Pane (subsection 18.4.4). Automatic Backups To keep your work safe, you can now tell Scrivener to automatically back up your projects as you work. There are a number of ways in which to do so: opening and closing the project, and manual saves. Tell Scrivener to use your Dropbox folder for automatic backups, and never worry about keeping all of your machines up to date. You can still make manual backups using the File Menu as before. Document Templates Before, if you wrote a template character sheet, reference page, and so on, you had to make sure to remember to duplicate the original and then move the copy to the right spot. Now you can set up a template folder which will automatically place its contained
- 21. 13 documents in aneasy-to-use menu from which they can be inserted into your draft wher- ever you want them. Document templates will be clearly marked with a special icon in the binder. For more information, read Document Templates (section 8.4). Page View Display your work in a variety of visual page formats, including single-page, two-page side by side, and custom page sizes. While not intended to replace your word processor or layout program, Page Layout preview will give you a rough idea of how many pages your sections are. This will be of considerable use to scriptwriters and appreciated by others who prefer to work in a page-based method or just prefer the aesthetic appeal of seeing virtual pages scrolling by. 3.0.1 Hundreds of Other Improvements Often when a new product version says hundreds of new improvements, you know they are counting each and every change, including bugs fixes. Scrivener 2 actually does have hundreds of improvements, far too many to realistically list. You’ll notice most of the refinements as you go about working in the way you’ve grown accustomed to. Here are just a few of the new things you can do. Binder Favourites: Set documents or folders as “favourites” and they’ll get pinned to various document selection menus in the interface, such as Go To and Scrivener Links. Text Bookmarks: Set bookmarks in the text of your document to mark places of interest for quick navigation. Bookmarks use the existing inline annotation feature, so they’re easy to spot while you work and omit when you publish. New Style System: Apple’s built-in style system has been completely replaced with an improved style builder and selection mechanism. It is important to note that Scrivener styles are still a way of applying favourite formatting rules and font variations, not dy- namic styles in the sense of a word processor, but the system for maintaining and creating these has become much easier. Refined Menu Layout: Much thought has been put into storing the vast number of functions available. The new menus have been re-arranged to be more intuitive and logical. Preferences Overhauled: More control is available, letting you personalise your copy of Scrivener even further, and the sections have been re-arranged to be more logical and accessible. Better Keywords: Keywords are now stored centrally for each project and can be assigned colours which you can choose to display on index cards in the corkboard. This
- 22. 14 CHAPTER 3. WHAT’S NEW raises the visibility of keywords, making them more useful when viewing large groups of documents together. Custom Binder Icons: Create or import your own custom icons and assign them to documents and folders in the binder. Project Specific Formatting Preferences: In addition to the global application editing formatting preferences, you can now set each project to have special formatting defaults. Improved Project Templates: Creating a new project is now even easier. Scrivener comes loaded with a number of useful starter templates, and it is even simpler to make your own and sort them using the new topical category system. New Index Card Appearance: In addition to the Scrivener 1 index card styles, the new Rounded theme gives both the card and the “pins” an entirely new look. Revision Marking: Set up revision marking “pens” that automatically colour new text according to the revision number as you type it in. New Format Search: You can now search by a wide collection of format-based crite- ria. You can look for all italic or bold texts, search by revision markings or highlights, find inline annotations, and more. Titles in Scrivenings: Display and edit the titles of documents right in the editor while working in Scrivenings. Integrated Title and Synopsis in Outliner: The outliner no longer requires a second column to show both the Title and Synopsis; they are now displayed in a single integrated column, familiar to users of outlining tools like OmniOutliner, giving you more space for other columns. View Enclosing Group: It’s now easy to jump up in the hierarchy from where you are currently editing, using the current view mode. If working with corkboards, you can view the corkboard “above” the current one in the outline structure, for example, or if when working with a section of the draft in Scrivenings mode, you can broaden the scope of your text editor to include the texts around it. Expanded Scratch Pad: The Scratch Pad has been modified to work better as an out- board research collection tool. You can now store any number of notes, and these will be saved as accessible RTFD files right on your disk. You can also easily transfer notes to any of your open projects. Optimised Text Engine: Snow Leopard introduced changes in the way text is ren- dered; Scrivener 2 has been optimised to better work with these changes, improving per- formance when working with large documents. Character Name Generator: Authors of fiction will be pleased to find that a powerful name generator has been built into the application. You can supply it with a wide range
- 23. 15 of criteria, includingethnic background; gender; forenames, surnames, or both; even alliteration. Scrivener also gives you the ability to add your own custom name lists. Store Any Kind of File: You can now drag and store any type of file into your binder and load it in an external editor that supports that file type. Unlike references, these files will be stored in your project, turning it into a hub for all your file types. Composition Backdrop: Now you can customise your composition 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, including all of your document snapshots. Multiple Project Notepads: Project notes can still be accessed in the inspector, but now you can also load them in a separate window, letting you view both your document notes and project notes at the same time. You can add new tabs to the project notes window to create multiple notepads, and these will be accessible from the inspector as well. Format Bar: The slim new format bar collects the most common formatting tools into a single, compact space above the editor. No more hunting around in menus or messing with font palettes. The margin and tab stop ruler has been separated and simplified, allowing you to show only the tools you need.
- 24. Chapter 4 Installation and Upgrading If you purchased Scrivener through the Mac App Store, then this chapter will not be relevant to you, as it pertains to the registration, installation, and maintenance of the standard retail version. You may safely skip to the next chapter, Interface (chapter 5). All installation and application updates will be handled by the Mac App Store application for you. If you purchased the boxed version of Scrivener, insert the CD-ROM into your com- puter and wait for it to appear in the Finder. Create a new Finder window with – N and choose the Go Applications... menu item. Drag the Scrivener application from the CD to your Applications folder. For online downloadable purchases, download the trial version from the Literature & Latte web site. The trial version can be unlocked at any time with the registration serial number that was sent to you when you purchased the application. When the DMG fin- ishes downloading, double-click on it in the Finder (if it hasn’t opened for you automati- cally), and follow the above instructions to drag the Scrivener icon to your Applications folder. Scrivener will not be correctly installed on your system if you drag the icon from either the CD, or the DMG, straight into the Dock. It must be dragged into the Applications folder or, if you do not have administrative rights for the computer, you may install it into an Applications folder within your home folder (you can create one, if necessary). After copying the Scrivener application to your hard drive, you can then drag a copy to the Dock from the Applications folder if you wish. If you attempt to run Scrivener from a “non-standard” location, you will get a warning message which will offer to you the chance to have it install it for you. If you intend to run Scrivener from outside of an Applications folder, then you should check the box that will inhibit this warning from appearing again in the future. Once this is complete, you should eject the DMG or CD from your computer. Click the Scrivener icon in the Dock (if you have placed it there), or double-click the icon in the Applications folder to launch Scrivener. 16
- 25. 4.1. PORTABLE INSTALLATIONS 17 4.1 Portable Installations We do not recommend installing Scrivener on a portable drive that you routinely remove from your computer in order to keep your data portable between multiple machines. It is best to install and register Scrivener on each machine independently. 4.2 Registering 4.2.1 The Trial Version You can try out all of the features of Scrivener for 30 non-consecutive days without hav- ing 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 all1 unless you register. If you are getting close to the end of your trial and have decided to not purchase Scrivener, please skip forward to the sections on Compiling the Draft (chapter 23) and Exporting (chapter 24), for details on getting your data out of the program. 4.2.2 Purchasing Scrivener During the trial period, whenever you launch Scrivener, you will be reminded of how many trial days you have left and given the option of buying and registering. Clicking on the Buy Online button will take you to the Literature & Latte online store, where you can purchase a licence for Scrivener. You can also visit the online store at any time whilst using Scrivener with the Help Purchase Scrivener... menu item. If you are reading the paper copy of this manual, you probably already have a Scrivener serial number in the box. When you buy a licence for Scrivener online, you will be e-mailed your unique serial number, which will have the following format: 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 again in the future. 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. 1 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 easily get your work out of the program.
- 26. 18 CHAPTER 4. INSTALLATION AND UPGRADING If you have lost your serial number, clicking Retrieve Lost Serial... in the registration window will take you to our vendor’s self-service support site, where you can request to have the information sent to you. 4.2.3 Registering Scrivener After purchasing a licence and receiving your unique serial number, you can register Scrivener by clicking on the Enter License... button in the “Scrivener is unregistered!” box that appears whenever you launch Scrivener. Alternatively, you can choose Register... from the application (Scrivener) menu. In the “User Name” box of the registration window, enter the exact name under which you registered Scrivener (referred to as the “Serial Number Name” in the e-mail you re- ceived with your registration details). Enter your unique serial number in the “Registra- tion Code” box, then click the Register button. You must make sure that both the user name and serial number are exactly as they appear in the registration e-mail you received, or registration will fail. If you receive a message stating that the name or serial number is invalid: l Check and make sure they are in the right order. The name of the software owner should be in the top field; the serial number in the second field l Try using copy and paste to transfer the information from the e-mail to this form and make sure that when you select the text in the e-mail, that the selection range does not extend beyond the first or last letter or number in the field. For this reason, it is probably best to copy and paste both the user name and serial number directly from your e-mail. Be sure to select only the text and not any additional white space. After clicking the registration button, Scrivener will attempt to authenticate your copy over the Internet. No private information will be relayed during this. If for some reason the Internet cannot be accessed from your computer, you will receive a warning message with instructions on how to activate the software. A URL will be provided which you can use on another computer to access the activation code you’ll need to complete the registration process on the original computer. You can use copy and paste into the forms to make this easy. Once Scrivener has been registered, you can begin using it immediately. There will no longer be a time limit on its use and you will no longer see the nag box at startup.
- 27. 4.3. APPLICATION UPDATES 19 4.3 Application Updates When you first start using Scrivener, you will be presented with a panel which asks whether or not Scrivener should automatically check for updates. To use this feature, you must have a connection to the Internet. If you click Check Automatically, once a day when you launch Scrivener, if your ma- chine is connected to the internet, Scrivener will do a quick check to see if there is a newer version available and will prompt you to update if one is found. (It is strongly recommended that you always update to the newest version available.) Choosing Don’t Check will disable automatic checks, but you can always manually select Check for Up- dates... from the application (Scrivener) menu. This option is available even if you also have Scrivener checking automatically. You can change your mind later by setting this option in the application preferences, under the General tab (section B.2). There you can also adjust the frequency of the automatic checks, ranging from hourly to monthly. When a check finds available updates, a window will appear outlining the details of the upgrade. It is recommended you brief yourself with the update notes, as sometimes changes in operation occur. You can view the full list of changes at any time on our web site2 . To upgrade the application, click the Install Update button. Scrivener will download the latest version of the application for you, and when it is done downloading you will be presented with a button to restart the program. Click this, and after Scrivener restarts your copy will be up to date. 4.4 Upgrading from Scrivener 1 While it is possible to run more than one version of Scrivener at once on your computer, it is advisable to first delete your copy of 1.x before installing the new version. To do this, make sure Scrivener is closed, then drag its icon from the Applications folder to the trash in your Dock before following the above installation instructions. Since the application preferences have all been updated, you will need to go through the new preference system and set up your defaults again. The project file format has been updated considerably, and new or upgraded projects cannot be opened in Scrivener 1.x versions of the application. The first time you load each of your older projects in 2.x, you will be presented with a dialogue box asking if you wish to upgrade the project format. Until you do so, it will not be possible to open these older projects in Scrivener 2.x. When updating the project, Scrivener will create a 2 http://www.literatureandlatte.com/scrivChangeList.php
- 28. 20 CHAPTER 4. INSTALLATION AND UPGRADING backup copy of the original project, preserved in the 1.x format, which you can choose to back up or delete once you’ve verified the update was successful. Once the update process is complete, the project will open and you can begin working immediately. Updating large projects: When updating very large, multi-gigabyte projects, be pre- pared 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 that time again. If your project is so large that it will take 20 minutes to copy, then you should be pre- pared 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 in mind when considering drive space. Do not attempt to update a multi-gigabyte project file on a drive that does not have enough space left on it to accommodate a duplicated copy. In some cases, you may need to keep a copy of 1.x installed. If you are working with a colleague who has yet to upgrade to version 2, you will want to make sure not to update these collaborative projects and will need to use 1.x to interface with them. It is perfectly safe to do so, but if you elect to keep a copy of Scrivener 1.x installed, you will need to consider the following: l .scriv files will open in Scrivener 2.x 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. l 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 clip- ping services should work just fine after a reboot. l It is safe to run both copies at once, as they use different preference files. l Scrivener’s manual has been entirely moved to PDF (what you are likely reading). 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. l In some cases custom keyboard shortcuts, which are assigned using Apple’s Key- board Shortcuts tool, can get assigned incorrectly or lost.
- 29. 4.5. STAYING INFORMED 21 4.5 Staying Informed If you would like to keep up to date on the latest developments and releases of Scrivener, you can sign up for our low-volume newsletter using Help Keep Up to Date.... Once you submit the form, a confirmation e-mail will be sent to the address you provided. You will need to click a link within this e-mail before you will be officially added to the list. If you cannot find the confirmation e-mail after 24 hours, check your spam folders, and consider adding “literatureandlatte.com” to your white-list. The “Keep Up to Date. . . ” window also links to our Twitter feed and Facebook page. We frequently publish small tricks and tips through these channels.
- 30. 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. 5.1 Interface Overview When you initially run Scrivener, you will be presented with a Getting Started window. This is actually a full-featured launching pad for all for all of your future projects. When- ever you are ready to start a new project (the details of which you’ll read about later on), such as a new novel or paper for a journal, you’ll use this interface to select a starting template, or a blank starter. You can hide this “Getting Started” interface in the Op- tions... drop-down menu in the bottom of this window. The remainder of this section briefly summarises the main components of a typical project window. Each area will be discussed in greater detail later on, and if you are interested in a particular feature you’ll find cross-references to more exhaustive articles on these topics. You may want to click on the “Blank” category in the left list, and then use the “Blank” starter to create a tem- porary test project to play around with, while reading this chapter. Skip forward to the Quick Tour (chapter 6) if you need instructions for doing so. The main project interface comprises five main elements, not all of which are visible when a new project is created. 1. Toolbar: Frequently used tools displayed in a standard fashion, familiar to most Mac OS X applications, which can be customised as you see fit. 2. Binder: A hierarchal list of all items in your project, including the manuscript; a general collection area for research materials, notes, and so forth; a trash can for collecting deleted items; and finally the top-level area where you can create your own files and folders. 22
- 31. 5.1. INTERFACE OVERVIEW 23 Figure 5.1: The Basic Interface
- 32. 24 CHAPTER 5. INTERFACE 3. Format Bar: Supplies frequently used text editing and formatting tools, available to both editor splits. 4. Editor: The editor can be split into two panes which can show two parts of the same document, or two different items altogether. This is where all viewing and editing is done. 5. Inspector: A feature-packed tool providing information about the currently active split. The inspector has five separate sub-panes, which address various aspects of the viewed resources. Not all of them are available for all media types. 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. 5.1.1 Toolbar Scrivener has a customisable toolbar which includes many common functions, includ- ing 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 back- ground area. It is also 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 search controls available as on the toolbar. 5.1.2 The Binder The binder is so-called because it really acts as the ring-binder of your project. It provides a hierarchical list of all items in your project. You can drag items around to restructure your project and double-click on any item to rename it. Selecting an item in the binder displays its content in the editor pane that most recently had the keyboard focus (see below) and its meta-data in the Inspector (again, see below). You can create as many folders and files as you wish in the binder, but there will always be three top-level folders that cannot be deleted (although they can be moved around within the top level and renamed): Draft The Draft folder is where you place all of the pieces of text you want to include in your final manuscript. As such, the Draft folder is unique in that it can only hold
- 33. 5.1. INTERFACE OVERVIEW 25 text files and folders—it cannot directly hold image files, PDF files, QuickTime media or web pages as other folders can, though it is of course perfectly possible to embed figures into the text itself, much as you would in a word processor, at the editor level. All of the writing you want as 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 doc- uments 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 Project menu. This will permanently delete all items inside the Trash folder (and cannot be undone). The Collection tab interface can be toggled on and off with the associated toolbar but- ton, or the View Collections Show Collections menu item. You can organise material into tabs you create, or save common searches as dynamic collection. In most cases, if this manual refers to have a “binder selection”, it is often accurate to assume that applies to collections and search results as well. Collections and search results can also be dis- missed by clicking the X button in the footer bar for the Binder. Due to the similarity of these views, the entire sidebar is often referred to in this manual as “the binder sidebar”. This is meant to indicate that you needn’t take the referenced action only in the Binder itself, but in any view that presents itself in this sidebar, such as the Search Results lists. 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).
- 34. 26 CHAPTER 5. INTERFACE 5.1.3 Format Bar The Format Bar stretches across the top of the main application view, right below the toolbar, and provides easy access to the most common text formatting tools. It can be selectively hidden when not needed with the Format Hide Format Bar menu command. For more information, read The Format Bar (subsection 14.4.2). 5.1.4 Editor The main editor occupies the large space to the left of the Binder, and will be your main working area for all manner of tasks. It automatically loads whenever you click an item in the Binder. Not only is it where you will be doing most of your writing, but it also has the ability to display groups of selected items in various useful fashions, which we will be getting in to shortly, and is a capable multimedia viewer, too. The editors will take on different appearances and functions depending on what sort of document you are displaying and which group view mode you are in. The editor can also be split, either vertically or horizontally, giving you two independent working areas at once. At the top of each editor is a “header bar”. This contains navigation buttons (the arrows) which allow you to navigate backwards and forwards through the document his- tory. Next to the navigation button pair 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 menu commands. The entire header bar has three colour status modes: l Plain grey is the default, and is what you will see unless you have split the editor. l Blue appears when you have split editors, and indicates the active editor. l Mauve appears when the editor has been locked ( – 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 associated with that Header Bar to take over and the other editor to close. Below each editor pane is a Footer Bar. This will change depending on the type of document visible and the current editor mode. When a standard text document is being
- 35. 5.1. INTERFACE OVERVIEW 27 viewed, for instance, it will display the word and character count along with a pop-up but- ton 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. Corkboard and Outliner group view modes have their own footer bar func- tions, too. See Also: l View Modes (section 5.2): for further information on the various group and text view modes available. l Viewing Media in the Editor (section 14.7): for details on how various read-only media are displayed in the editor. l Header Bar (section 14.5): for more information on the informative strip along the top of the editor. l Footer Bar (section 14.6): on how to use the strip along the bottom of the editor, which will change according to what type of document you are viewing. 5.1.5 The Inspector The Inspector is not always visible by default in new projects, but will always be on the right side of the project window when it is visible. Its purpose is to display all meta-data associated with the document shown in the editor pane that most was recently viewed in either editor. 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. More on that later; for now, if the inspector appears suspiciously empty, know you have an item selected that does not support meta-data. The inspector has five different sub-panels, which can all be accessed via buttons along the very bottom of the Inspector. If an associated panel has had data entered into it, an asterisk will appear in the upper-right corner of the button. The sub-panes are listed in the order they appear: 1. Synopsis, Meta-data and Notes 2. Synopsis, Meta-data and References 3. Synopsis, Meta-data and Keywords 4. Snapshots
- 36. 28 CHAPTER 5. INTERFACE 5. Linked Text Notes 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 addition to their specialised information. These initial sections can be collapsed by clicking the disclosure arrow on the left side of the header bar for each. The two meta-data sections are as follows: Synopsis & Image The top frame shows either the synopsis for the binder item, which is what also appears in the index card representation of the item in corkboard mode, among other places. Using the top drop-down menu, you can optionally also attach an image to the item to represent it in Corkboard mode, instead of a text synopsis. Media files by default will display a graphical synopsis, but you can use the drop- down menu to switch to text if you prefer. General & Custom Meta-Data The middle frame of the inspector shows basic meta- data for the current document. This includes the label and status (which can be renamed to something more appropriate to the current project), 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 on the types of meta-data available, read Setting Up Meta-Data (chapter 10). The Notes, References, and Keywords panels all display the above two components. 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 and accessible from any part of the project, right here. If you have multiple project notepads, you may see more than one option here in parenthesis. For more information, read Document and Project Notes (subsec- tion 18.4.1). References The References table lets you to hold links to related material within the project itself. Links can also point elsewhere on your hard drive or on the internet. Click the header bar to switch between document references and global project
- 37. 5.2. VIEW MODES 29 references. 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 document. Keywords 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 Keywords (subsec- tion 10.1.4). The last two sub-panes, Snapshots and Comments & Footnotes, 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 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 Using Snapshots (section 14.9) for more general information on Snapshots. Comments & Footnotes 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 comments can be created with the + button and 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). 5.2 View Modes There are three primary “group view modes” available in Scrivener. View modes give you a powerful way to view and modify multiple documents at once in a variety of fashions, each tailored to different tasks. View modes are generally only triggered when the editor is asked to view more than one document at a time. This can happen if you Cmd-click on more than one binder item or even if you just click on a folder. It is also possible to manually enable a view mode, allowing you to easily flesh out a single document with new index cards beneath it. For the most part, Scrivener will anticipate what you are trying to do and react accord- ingly. If you click on a single text file, it will display the contents of that text file in the editor. If you then click on the group containing that file, it will automatically switch to your preferred group view mode, the one which you used last (corkboard by default). An
- 38. 30 CHAPTER 5. INTERFACE exception to this is when “Treat all documents with subdocuments as folders” has been disabled in the Navigation preference tab (section B.6). In this case, file type items will always be treated as though they were single text files, even if they are acting as folders. The other exception to this rule is when the view mode has been explicitly set to single text file mode. If you intentionally disable the corkboard to edit a folder’s text, then the view mode will remain text-only until changed, no matter what type of item you click on in the binder. A key principle is that view modes are just that. They are alternative ways of viewing a binder item, and thus like the binder are methods for organisation. You can think of view modes as being like an elaborate extension of the binder, and in that sense they work closely with it and display information in the same top-down fashion. You can drag items from a corkboard into the binder to move those cards, or vice versa. All documents in the binder can both contain text and children. This is a departure from how most applications work, where the only way to organise items into other items is to use a folder. Scrivener doesn’t restrict you to that, and indeed even allows you to convert a text file to a folder and back again. Consequently, even though it selects the most appropriate view mode depending upon what you click on, you can always override the default. For folders, you can turn off the current view mode and read or add text to it. For files you can select a view mode manually and then add items to them as if they were folders. When performing the latter, you will most likely be presented with an empty corkboard or outliner at first. This is fine, because you can still go ahead and add items to that view, and in doing so you will add children automatically to that file. This is a great way of expanding scenes and fleshing out rough ideas, so take a moment to play around with the view mode buttons in the toolbar, or their corresponding shortcut keys, to see how you can get the most out of 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 Multi- ple Documents (section 14.12) will cover the unique Scrivenings mode in detail. 5.2.1 The Group Mode Toolbar Control Included in the default application toolbar is a so-called “segmented control”. It is in the middle of the window, and contains three buttons embedded in a single row (Figure 5.2). The figure depicts the control when a group of items or a container has been selected. When a single item has been selected, the label will change to “View Mode”, and the icon
- 39. 5.2. VIEW MODES 31 Figure 5.2: Segmented control in group mode with Scrivenings mode selected. on the far left will depict a single page. The control displays the active view mode with a shaded background. This is the last view mode that you picked, and it means that editor will always use that method of display content, until you change it again while viewing a group. To change a mode, click on any of the other buttons in the control. The view for the active editor will immediately change, and simultaneously set your preference for that view mode. You can also click on the shaded view mode that is already selected to intentionally disable it and view the text of the container that you are viewing. If you have clicked on a folder and are viewing its index cards on a corkboard, clicking the corkboard button again will switch to viewing the text of the folder. This is considered to be a view mode setting as well (or rather the absence of a preference). All future clicks to container items will load the text editor in single file mode until you again choose a view mode from the control. These three options can also be accessed via the View menu, or by using the associated shortcut keys that can be found there. The shortcut keys and menus work in the same fashion, where invoking corkboard while you are already viewing an item as a corkboard will switch that view mode off and go to single text mode. 5.2.2 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 freeform mode to move cards around as freely as you might on a desk or 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 freeform 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.
- 40. 32 CHAPTER 5. INTERFACE The important thing to realise with the corkboard is that each of the displayed index cards represent files or folders in your binder outline. They display the title and the synopsis (a short description of the item), 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.3 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: label colour, word counts, modification dates, keywords, your own custom meta-data, and much more. Since the outliner provides feedback for so much meta-data, it is a great mode for easily making and viewing bulk changes to your documents. Many people 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 uses for the outliner. To read more about it, see The Outliner (section 12.2). 5.2.4 Scrivenings This is a unique view mode in that it works not only with the viewed items themselves, but specifically with their text, and is consequently a tool for working with text (and folder) items, rather than multimedia files. All of the text content (even empty docu- ments) 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 ad- justments 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 (frequently referred to as a “Scrivenings session” and known to 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 something 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.
- 41. 5.3. COMPOSITION MODE(FULL SCREEN EDITING) 33 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. 5.3 Composition Mode (Full Screen Editing) Composition Mode is a special interface which will blot out not only the rest of Scrivener, but the rest of your computer as well, allowing you to concentrate fully on the production of text. It only works for documents and folders, and while it provides access to the menus, QuickReference panels, and most aspects of the inspector, its default state is to simply display the text contents of the selected document (or documents, if you are viewing an combined text) in a “page” in the middle of your screen. Read more about Composition Mode (chapter 16). 5.4 Selections Selection and “Focus” are often important in Scrivener, as there are features which work when only certain types of things are selected in the interface. A good example of this is the Format Convert To Uppercase menu command. It has no meaning when a se- lection of index cards is currently active, rather than some text. If there is a selection restriction on a feature, this manual will often indicate as such using the following termi- nology: l Active selection: this relates to “focus”, or where the application is currently ac- cepting keyboard input. In other words, if you tapped the ‘h’ key, that is where the ‘h’ would be sent. In some cases this might not do much or anything at all; in an editor it would insert an ‘h’ letter, and in the Binder it would select an item starting with ‘h’. l Inactive selection: A selection can be inactive. If you select the Draft folder in your Binder and then click in the editor, the selection will become dimmer (or grey, depending on your settings). Inactive selections are seldom used, but there are a few cases cases, especially when exporting. l Active text editor: the main text editor must be active (the insertion caret must be blinking within it). In cases where the interface is split into two editors, this not only means an editor must be selected, but the editor you wish to perform the function in. Some commands do not require text to be selected, only an editor, others will perform universal actions if no text is selected, but an editor is active; others will refuse to work unless you have a selection.
- 42. 34 CHAPTER 5. INTERFACE l Active item selection: items, also known as files and folders, are individual re- sources in your project binder. An item can be a folder, a photograph, or a web page you’ve imported, just to name a few. When a feature requires an active item selection, that means the focus must be in a view which supports viewing items (like the Binder or the Corkboard), and one or more items must be selected.
- 43. Chapter 6 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 will in- troduce a few of the most basic concepts you’ll need in order to start working 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 very straightforward and intuitive, so its complexity can be gradually learned as required. We will go over the following tasks: l Creating a new project from a blank template l Navigating the binder and adding new documents to the Draft folder l Working with the corkboard and Scrivenings text view l Compiling the document into an RTF file If you need to learn more than the above, we strongly suggest going through the full tutorial, which can be found in the Help menu. 6.1 Project Format Scrivener is a project based application, which means that it stores your projects as sep- arate files, rather than working like a database which hides the location from you and loads everything automatically when you start up the program, or a file based program like Word, which creates an empty document whenever you launch it. The intended use of a project is to store everything relating to a single major work, be it your next novel or screenplay, a dissertation for your masters, or a serial collection of articles for a magazine or blog. 35
- 44. 36 CHAPTER 6. QUICK TOUR Figure 6.1: Template Wizard It is recommended that for each new “real world” project you embark on, a new project file should be created1 . When you create a new project, Scrivener asks where you want to save the file. By default this location is your personal Documents folder, 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 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 (Fig- 1 There are, of course, many exceptions to this. A series of articles for a magazine might work very well together in a single project.
- 45. 6.2. THE MAINWINDOW 37 ure 6.1). In the left list of categories, click on the “Blank” entry (if necessary), and then select the blank starter project. 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 remember (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 is what will be used on your disk, and so should be memorable and placed in a location you’ll easily find in the future2 . Click the Create button once you’ve decided on a file name and location. 6.2 The Main Window The project will be created, and you’ll be presented with a fresh Scrivener project window (Figure 6.2). The left sidebar panel is your project binder, where everything stored or created in your project will be represented in an outline structure. On the right side of the window we have the editor (which is more than just a text editor, as we will shortly see). In most cases, what you click on in the binder will be displayed on this side of the window. Along the top, above the editor, is the Format Bar, which provides access to common formatting tools such as font selection, justification, line spacing, and so on. If you cannot see all of the tools, try expanding your window horizontally. If you want to see tab stops and margins, use the menu command Format Show Ruler or press – R. Directly below the Format Bar is the editor Header Bar. The title of the current doc- ument is printed here (“Untitled” since we haven’t named it yet). 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! 2 While Scrivener can helpfully remember your current working session the next time you start, older projects might no longer be in any of Scrivener’s own lists, and you’ll need to know where they are saved on your computer to open them.
- 46. 38 CHAPTER 6. QUICK TOUR Figure 6.2: A typical new blank project 6.3 Outlining Your Draft Why do that when we can procrastinate for another minute, though? Take a look at the binder. Let’s discuss how best to use Scrivener’s Draft section. Unlike a word proces- sor, Scrivener’s design philosophy revolves around creating and organising your writing project in arbitrary pieces according to what is most comfortable for you. For exam- ple, you could make a new file for each chapter, or take that even further and make a new file for each scene within those chapters. It’s totally up to you, and unlike in most programs, you won’t be penalised for breaking things down as small as you desire. The binder displays these pieces like an indented outline. Let’s try it. If you haven’t touched anything yet, the cursor should still be blinking in the main text editor (if it isn’t, just click in the middle of this white text area with your mouse). Type a few words in here and then press the Return key to create a new paragraph. Glance up to the top-left and note the far-left window button (which is red on most
- 47. 6.3. OUTLINING YOURDRAFT 39 Figure 6.3: Progress so far Macs). You should see a little dot within the button. This means your project hasn’t been saved yet. If you don’t see a dot, try typing another word into the editor. By the time you finish examining it, the dot ought to disappear—your project has been saved. Whenever you pause for two seconds, Scrivener’s auto-save feature will kick in and save all your recent work. You might notice that the title of your document changed when this happened. If you leave a document as “Untitled”, the first line will be used as the title. This will only happen once, and you can always change the automatic title to something more descriptive. Let’s make a new document in the binder. There are a number of ways to do this, but first let’s try the most direct method: click the large green + button in the toolbar just once. The cursor will flip over to the binder and let you type in the name of the new doc- ument. Type something here, like “Chapter Two”, and press Enter to confirm. You’ll notice that the content you just typed into the editor has disappeared. This is because you are now viewing “Chapter Two”. Let’s fix the name of the first document 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 con- firm the name change. You might notice something going on with the icons (Figure 6.3). Document “Chap- ter 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.
- 48. 40 CHAPTER 6. QUICK TOUR 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 “Chap- ter Two”, and just press Enter. Call this one “Wineries”. Now we will 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, building a conceptual outline and then filling in what they intend for each section in the synopsis. These three levels of icons give you an overall 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 chapters, 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 struc- ture 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
- 49. 6.3. OUTLINING YOURDRAFT 41 of documents as a Scrivenings session, rather than a Corkboard. 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, and indicates that the text you added to this document earlier is still there. This is different than stating that a folder has text items as children beneath it. The page badge will only be applied if the folder item itself has text content. Let’s move that text into a new child document, with the “Chapter One” item selected in the Binder, press – N, which is another way to create new documents. When a folder is selected in the Binder, new documents will automatically be assigned to it as children. Call this new document, “Scene A”, and then click on “Chapter One” again to select the folder and view it as a Scrivening session. The first line of text you typed will be visible above the divider line, we want to move it below the divider line, moving it into “Scene A”. You can select paragraphs in Scrivener by triple-clicking anywhere within them. Try that now, and then drag and drop the text below the divider. Notice that the page icon badge in the Binder has been removed from the folder, and the Scene A icon now has a page of typed text in it. Once again, anything you do in a Scrivenings session is instantly made to the underlying sections it represents. You could also have used standard copy, cut, and paste commands to move the text. 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. For our next experiment, select the View Corkboard menu item to return to the cork- board view. What you are seeing here is an important concept in how view modes inte- grate together. The editor was in Scrivenings mode, giving you access to each file’s text content, but is essentially focussed on the “Chapter One” folder. When you switched to using Corkboard mode nothing changed about that criteria: 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. “Scene A” has disappeared, because it is a child item of “Chapter One”, not the Draft.
- 50. 42 CHAPTER 6. QUICK TOUR l Corkboard mode will 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. l Outliner mode, which we haven’t explored yet, is a bit more like the Binder in that you can see items at all levels of depth beneath the current selection. l Scrivenings mode usually includes all text content beneath the current selection, no matter how deep they are in the outline. There is one main exception to these rules of thumb: Multiple Selections, which hap- pen when you select more than one binder item at once, but for simple single selections, the above guidelines will help you decide which view mode to use, depending on what you need to do. You might be wondering about that oddly titled “Wineries” card. Let’s move it to the Research section of your Binder, since in our hypothetical little universe here, it would be used to collect research on various wineries that the characters are involved in. There are multiple ways of moving items around in the outline, but the most familiar will be drag and drop. Click and hold on the index card in the Corkboard, and drop it onto the Research folder over in the Binder. This demonstrates how easy it is to move material in and out of the drafting area, as well as the fact that you can use a view mode to help organise your material in the Binder. In larger projects, the Binder might become quite large, so remember this trick as it can make moving items from one remote section of the Binder to another very easy. As you learn more about the program, you’ll find other ways to specify content as being “meta” to the draft manuscript itself, even while leaving it in the Draft. Hopefully by now you can see 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 before proceeding to the next step. Working with Existing Material: Likely, you already have content from an existing work in progress you would like to bring into Scrivener for your first project. While the methods described here could certainly help you with that, you might find the Documents Split sub-menu to be even more useful in converting a long document into an agile outline. For more information on this technique, explore Splitting The Document (section 14.3.3).
- 51. 6.4. COMPILING THEDRAFT 43 6.4 Compiling the Draft We’ve only scratched the surface of what can be done, but before ending this tour we’ll look at one more thing: compiling. Compile is Scrivener’s terminology for what most applications refer to as Exporting. This name was chosen to reflect the fact that Scrivener is doing quite a bit more than just converting the data from one format to another or moving data to an external location that other programs can access. Scrivener’s compiler can generate documents to a number of different formats, do simple or complex trans- formations on the binder structure, reformat everything to a consistent look, and much more. The philosophy of letting you work the way you want to work is very much sup- ported by the compiler. There is no need to work in Courier, Times New Roman, or whatever your editor prefers. You can choose an elegant font or one that is easy to read at 3am with sore eyes. In the end Scrivener will generate a document to your required specifications. Let’s try it now. Press – E or select the menu command, File Compile.... After all of the features described above, you might think you got the wrong function at first. By default Scrivener presents a very simple form with some industry standard presets and an export file format chooser. l From the “Format As” menu, select “Novel (Standard Manuscript Format)” l Change the “Compile For” option to Rich Text (.rtf) 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 changed, or turned off 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 23). 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 your work 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,
- 52. 44 CHAPTER 6. QUICK TOUR 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 in- teractive tutorial or watch the introductory videos3 available on the Scrivener homepage. Together, they cover Scrivener’s features in much more detail and should address most of what you should know to get the best results in your work. Further recommended reading: 1. Interface (chapter 5) 2. Navigating and Organising (chapter 9) 3. Gathering Material (chapter 11) 4. Writing and Editing (chapter 14) 5. Compiling the Draft (chapter 23) For now, happy writing! 3 http://www.literatureandlatte.com/videos/index.php
- 53.
- 54. 46 CHAPTER 6. QUICK TOUR The pages are still blank, but there is a miraculous feeling of the words being there, written in invisible ink and clamoring to become visible. Vladimir Nabakov One of the principal 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 more. 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, to a level of detail you require and no less or greater? This section will cover the majority of the tools that you may use to accomplish these goals. If your methods couple the processes of writing and preparation, you might find it beneficial to read portions of 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 tools you use to write, edit, and finish off your text with. In Scrivener, there is no separation between outline and book order. This seamless approach will help you get straight into the writing phase, even while you are still planning and evolving the work. Thus, you can just easily start writing prose immediately, and let the bigger picture emerge organically out of what you write. To better learn the fundamentals of Scrivener—such as where your works will be saved, and how to use the binder to select items within your project to view or edit them—it is recommended that you read the next three chapters. After that point, we’ll discuss some more practical research, planning and project usage techniques, which can be learned as needed. The topics that will be covered in this part are: l Project Management (chapter 7): Creating, saving, backing up, and managing projects on the disk. l Setting Up the Binder (chapter 8): Using the built-in sections of the binder, manag- ing collections, organising your work, and setting up document templates.
- 55. 6.4. COMPILING THEDRAFT 47 l Navigating and Organising (chapter 9): Optimise how you navigate within a project. l Setting Up Meta-Data (chapter 10): The various forms of meta-data available for tracking progress and types. l Gathering Material (chapter 11): How to collect material from other resources and applications. l Project Planning (chapter 12): How to rapidly capturing your ideas and give them shape, shapes that will eventually become your manuscript. l Cloud Integration and Sharing (chapter 13): How to take you work with you, collaborate with others, and manage cross-platform usage between Mac OS X and the Windows operating systems.
- 56. 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 collection 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. 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. 7.1 Project Size Limitations Since Scrivener was primarily written with the long-format author in mind, much effort has been put into making it as robust as possible. It can handle book-length manuscripts with ease, store large quantities of research material, and handle many thousands of indi- vidual components, even on a single corkboard. Scrivener has been tested against projects with millions of words in them; way beyond what it would normally have to face. So for ordinary usage, you will never need to worry about limitations. There is one caveat to keep in mind, however. The bigger your project is on the disk, the longer it will take to produce backups. When combined with the automated backup system, this could mean waiting long periods of time for backups to complete in the most extreme cases. While Scrivener is very capable of handling large amount of media, some 48
- 57. 7.2. CREATING ANEW PROJECT 49 users have found it better to use database software in conjunction with Scrivener, when gigabytes of data are involved. There is no universal rule of thumb on upper limits, this will be whatever you are com- fortable with, and how much available storage space you have in order to keep consistent backups. If you have an 8GB project, that means each backup will consume another 8GB maximum (less if you use the slower zip archival option), and will take as long to produce as it would to duplicate 8GB of data on your hard drive. 7.2 Creating a New Project When you first start Scrivener, you will be presented with the Project Templates window, which also includes a handy “Getting Started” section. You may hide (or choose to reveal it again) this at any time using the Options... drop-down menu in the lower left of this window. In addition to providing an easy selection mechanism for new projects based on tem- plates, you can also create a blank new document (the default for new installations), open existing projects from your disk, or select from a short list of recently opened projects. To call up this window later on, use the File New Project... menu command, or press – N. Along the left side of the window are template categories. A number of useful presets have been provided, and it is easy to make your own templates as well. The Options drop-down menu provides template management tools. To read more about creating and managing templates, see Templates (section 7.6). To create a new project based on an existing template, click on that template to make it active, or select the “Blank” template to start with a fresh project. A description of the template, if one has been provided, will appear in the grey text box below the selection area. Click the Choose... button to proceed. The next step is selecting where you would like to save the project file. It is a good idea to choose a place that you will remember. You might want to create a special folder in the Documents folder just for your Scrivener projects. You can use the New Folder button to do so. Type the name of your project into the Save As field. This can be changed later if you require, so if your project doesn’t have a final title yet, don’t worry! At any point, you can go back and change your initial selection if you change your mind, by clicking the Cancel button. The Create button will activate once you have supplied a name and valid save location. Click this button to proceed with the settings you have chosen.
- 58. 50 CHAPTER 7. PROJECT MANAGEMENT 7.3 Saving and Making Copies While you work, your projects will be automatically saved on a frequent basis. By default, this means that after two seconds of inactivity, the project will always be saved. You can monitor this process by watching the upper-left corner of the window. The left- most “traffic light” button will have a dot inside of it whenever the project contains edits which have yet to be saved to the disk. If you stop typing or clicking in the interface for a moment, the mark should disappear after a brief pause, and now everything is saved to the disk. You can change how rapidly this happens by adjusting the inactivity interval in the General section of the application preferences. At times, or if you have selected a very long interval for some reason, you might wish to manually save the project. This can be done as per normal in any application, by selecting File Save, or pressing – S. This feature need not be used to fully save the project, however. Very often, by the time you activate this command, the project will already be saved to the disk and it will do nothing. It is also possible to save a separate copy of the project, while working, and continue working in the new copy. To do this, select File Save As... ( – S), and choose a new name for the project. After supplying a new name and clicking the Save button, the active project will become 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. 7.4 Opening Existing Projects Existing projects can be opened in a variety of ways. For convenience, Scrivener keeps track of the last several projects you have opened, and stores them in a list, accessible from File Recent Projects.... In addition, this list can be accessed from the Project Template window, via the Open Recent drop-down menu at the bottom. By default, Scrivener will remember any projects you leave open when you quit, and will re-open these for you the next time. This behaviour can be changed in the General preferences tab. You can open older projects using File Open... ( – O), or click the Open an Existing Project... button in the Project Templates window. As with managing projects that have been saved, you can also use the Dock, Finder, Spotlight, or other system tools to open files stored on your drive. Simply double-click
- 59. 7.5. MOVING PROJECTSON YOUR DRIVE 51 the project you wish to open in the Finder. Spotlight is also handy when a project gets misplaced and you are unsure of where it is saved. If you don’t recall the name of the project, you can search for “.scriv” to find every Scrivener project in your Spotlight index. When trying to sort out the differences between near similar versions of a project, you will find that the Quick Look information for your projects is quite extensive. A full outline of the entire Draft will be presented to you, including any synopses that have been typed into index cards. Use this ability to figure out which project is the correct version, before opening it. It is not possible to delete old and unwanted projects from within Scrivener. To remove projects you no longer want, use standard file management tools as you would with other folders and files. 7.5 Moving Projects on Your Drive Despite being folders full of files, you can otherwise treat the .scriv project as you would any other file or folder on your system. Everything that Scrivener needs to work with the project is contained within the folder, and so moving it will have no detrimental effect on its safety. Always close a project prior to moving it. While a project is open, Scrivener main- tains a very close connection with the files inside of it. Since it cannot predict where you will move the project, if it is moved while open the software will no longer save files in the correct location, and can lead to lost work. Projects act just like ordinary files in the Finder. The fact that they are special folders can be largely ignored, and so they can be easily moved just as you might move a JPEG file you downloaded, or a .doc file you have written in Word. 7.6 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 modi- fying the way the entire application behaves, but in Scrivener, it’s best to think of them as starter projects. Many of them 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.
- 60. 52 CHAPTER 7. PROJECT MANAGEMENT 7.6.1 Using Built-in Templates Most of the built-in templates will provide you with a readme-style document that ex- plains what the purpose of the template is, what has been modified and set up for you, and how best to use it to develop your project. Most also contain a sample PDF showing how the final manuscript will be formatted if all of the project settings are left alone. For templates that do not come with a help file, here are a few things to keep in mind as you explore templates: Templates are just starter projects. It is worth saying again. With the exception of a few and somewhat technical differences, there is nothing in a template-generated project that is different from a blank project. In fact, a blank project is essentially an extremely minimal template. Everything that you see in a template can be handled just as you would handle any other items in the binder. They can be duplicated, 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 with an empty scene in it is just that: a folder with with a file in it. To change it, edit it as you would any other piece of outline. 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 structure. When you use a new template for the first time, check the project meta-data settings (Project Meta-Data Settings...) and make sure that everything is arranged 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. Some templates will have “document templates” inside them, already pre-configured. This will provide you with starter documents for creating new elements within the tem- plate. You can modify the items in this folder to customise them or add your own. 7.6.2 Creating Your Own Templates Creating custom templates is as easy as creating a new project, and if you often set up projects with the same starter items—like character sheets, keywords, or custom labels— personalised templates will save you a lot of time. Here is a list (by no means complete) of things that are commonly changed or added to custom templates: l Custom labels & status: add the types of labels, preferred colours, and status stamps that you find useful for your projects.
- 61. 7.6. TEMPLATES 53 l Project references: try making a list of writing resources and research portals that you often use. l Character sheets or research note starters: use Document Templates (section 8.4) to supply yourself with your favourite starter documents. l Compile settings: since compile settings are stored in the project settings, you can configure these so that your future projects will be ready for one-click export (or close to it!). l Starter Collections: standard collections as well as saved search collections can be placed in a template as well, though initially they will probably be empty. l Starter story structure: set up your favourite story-building techniques and out- lines. The important concept to keep in mind is that whatever you can save within a project, you can save as part of a template1 . There are a few differences (mostly pertaining to how a template is loaded and the description and thumbnail that can be saved with it), but for the most part you should consider a template no different from 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 update existing templates with revised material; this will be covered in greater detail in the following pages. 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). Category Which section to add the template to in the browser. Description A brief description of what the template provides. You may not find this necessary 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. 1 Technically, there is a 50 MB size limit to what can be saved as a template, but given that a template is intended as a starter project, you are unlikely to ever encounter this restriction.
- 62. 54 CHAPTER 7. PROJECT MANAGEMENT The “Icon” box on the right gives you options for setting the appearance of the tem- plate 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 graphic 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 delete the original project or continue working in it without affecting the template. Template Variables In addition to the standard project elements you can include in a template, there are a few placeholders that you can type into the editor which are especially useful 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 your manuscript submission cover-page. This wouldn’t work so well if you wish to share the template, though, and in fact Scrivener will check your templates for stuff that looks like your personal information and warn you if you wish to proceed. Template variables let you place a special code where text should occur, and when the template is used to create a new project, it will consult the user’s Address Book for the relevant information. Many of the built-in templates that ship with the software have been set up to do this already, which is how they place your personal information into new projects. You’ll find a list of available placeholders here (Table 7.1). If you wish to edit a template which uses these variables (such as many of the built-in templates), follow these instructions: 1. Create a new project ( – N). 2. Select the template you wish to edit. 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. Holding the Option key will inhibit the substitution of these placeholders for their Address Book equivalents, so you can edit the template file and then save it as an update.
- 63. 7.6. TEMPLATES 55 Table 7.1: Project Template Placeholders Code Description <$template_firstName> First name from Address Book <$template_lastName> Last name <$template_fullName> Combines the first and last name for you, ordering them according to system language preferences. <$template_initial> First letter of first name from Address Book <$template_street> Street address <$template_city> City <$template_ZIP> Postal code <$template_state> State or county <$template_country> Country <$template_phoneNumber> First phone number listed in your address card. <$template_email> First e-mail address listed <$template_projectName> The file name of the project from when it was created. Note this will not include the “.scriv” portion on the end. Updating Templates To update a template which has already been saved, follow the above instructions to open it without substituting the placeholders, make any changes you wish, and then choose File Save As Template.... All of the information from the original template will be filled in for you, 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, the two have no further connection. Thus, existing projects that you created from a template will not be modified to reflect changes made to the template. Likewise, if you have created a project purely to update a template, there is no need to keep the project around after that point, as allowing the project to auto-save will not automatically update the template; you must choose Save As Template... again. 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. 7.6.3 Managing Templates In the Template browser window, the Options menu in the bottom left provides the fol- lowing functions for managing templates:
- 64. 56 CHAPTER 7. PROJECT MANAGEMENT Set Selected Template as Default Changes the default template selection to whichever template you currently have selected. A yellow border will appear around the selected template. Once this is set, the next time you call up this window it will highlight that template for you. Import Templates. . . If you have downloaded templates from the Web or copied your custom templates from another computer, use this feature to import the files into the template system. Export Selected Template. . . Useful for sharing your templates on the Web with other authors or for transferring templates to another working computer. Delete Selected Template When a custom template is selected, you can use this menu item to remove it from your system. Note that the built-in templates cannot be removed. 7.7 Backing Up Your Work Regularly backing up your work is an important part of the writing process in that it keeps your efforts safe, and while there are many external strategies for keeping your work safe from catastrophes and mistakes, the most important part is remembering to do it. Fortunately it is possible to set up Scrivener to handle most of the latter part for you. 7.7.1 Configuring Automated Backups By default, Scrivener will automatically back up every project that you work on, when- ever you close it. These backups will be stored in your user folder: ~/Library/Application Support/Scrivener/Backups This location can be changed in preferences, and could even be set to save into a folder that is synchronised over the Internet, such as with Dropbox. 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 5 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. It is important to note that the backup system, as it ships by default, is set up with a common method of working in mind, whereby you close your project on a regular basis (say at the end of every day). If you find your own work habits deviate from that, you would do well to go over the Backup preference tab, and change the settings to better suit
- 65. 7.7. BACKING UPYOUR WORK 57 your style of working. Those who leave their projects open for weeks or even months at a time, will most certainly want to change the backup settings to be triggered by manual saves, and remember to run a manual save at least once a day for maximum protection. On the other hand, if you open and close projects multiple times a day, you might find the default limit of only five copies too limiting. Mistakes you’d like to revert may have rolled off the backup list, because five backups were created in the past day or two. Increasing the number of stored backups to a higher value means more drive space will be used for each project, but will ensure you have something from more than a few sessions ago to restore from. In cases where security is a concern (if you are working with confidential files in a 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 working 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 command to restrict the sensitive file from getting backed up with the rest. Read Using Scrivener in a Secure Environment (section D.3) for more tips on locking down your projects. Read about the various options available in the section on the Backup tab (section B.11) in Scrivener’s preferences. 7.7.2 Managing Backups for Large Projects Very large projects can conflict with what would ordinarily be good settings for the auto- mated backup system. If a project has reached a point where backing it up automatically has become a nuisance, rather than decreasing the amount of backup security globally, consider excluding the large project from the automated system. While the project is open, use the File Back Up Exclude From Automatic Backups menu command. Once this option is checked off, the automatic backup system will ignore this project entirely. It will then be up to you to keep manual backups of the project. The File Back Up Back Up Now feature is useful in this regard. 7.7.3 Manually Backing Up Backups can be created whenever and wherever you want. Use File Back Up Back Up To... and select a backup location. The “Backup as ZIP file” option will compress the backup project into a zip file after saving it, and is thus useful when backing up to remote storage locations, such as MobileMe or Dropbox. By default, backups will be timestamped, making it easy to find a precise version later on. It is also possible to manually trigger the automatic backup system, even for projects which have been excluded, by using File Back Up Back Up Now. This will follow any
- 66. 58 CHAPTER 7. PROJECT MANAGEMENT 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 recom- mended that you start forming a habit of making backups whenever a decent amount of work has been committed to the project. 7.7.4 Tips for Using Time Machine Mac OS X Leopard and greater provides the Time Machine feature, which will automat- ically back up your computer once every hour, and store backups as far back in time as possible, reducing the frequency of these backups the further back in time you go. This presents a unique problem with Scrivener in that the hourly backup routine is likely to run while you are working in Scrivener. This means that Time Machine will be capturing your project while it is open and in progress, a state that could produce incomplete backups if you try to restore from that particular point in time. Frequent users of Scrivener may very well keep their projects open for weeks at a time, meaning good backups of their project will be few and far between. There are fortunately a few tips you can use to help Time Machine work effectively with Scrivener: 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 locations throughout the external backup 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 result 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 individ- ual backups.
- 67. 7.8. TIPS FORWORKING CROSS-PLATFORM 59 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 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. 7.8 Tips for Working Cross-Platform Important Notice: At the time of this writing, Scrivener for Windows is still in beta development. You can find out more about it from the main web site2 . The Mac OS X Scrivener 2.x project format is fully compatible with its Windows com- panion. 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 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 “MyPro- ject.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 “MyPro- ject.scriv” folder from Windows, not just the .scrivx file by itself. The entire folder is your project, and once it is on the Mac it will go back to looking like a single file.
- 68. Chapter 8 Setting Up the Binder 8.1 How the Binder is Organised The binder is the document browser on the left of the main window where you can organise your files (by default it is coloured a pale blue when the project window is active). It allows you to structure and rearrange your work with the utmost flexibility, much like a ring-binder in the real world (hence the name). You can drag files from the Finder straight into the binder to import them, too, which you can read more about in Gathering Material (chapter 11). The binder is an optional element, though in most cases you’ll want to rely on its or- ganisational features at all times. To hide the binder, click the Binder icon in the toolbar, select View Layout Hide Binder, or press – B. All of these commands can be used to restore its visibility if it has been hidden. The binder is labelled at the top. Some functions will automatically replace the Binder view with a temporary data display. Project Search Results are the most common of these. This label will change to reflect whatever automatic data is currently being viewed, and additionally the colour of the sidebar background will change to help notify you that you are no longer looking at the main project binder. You can always get back to the binder by clicking the small X button in the footer bar of the binder, or by clicking on its tab, if it is visible. This section will go over the various aspects of the binder, and how to best use Scrivener’s features to structure, navigate around in, edit, and write your draft. Scrivener does some things which are unusual, and generally restricted to high-powered expensive applications. As a consequence, this can result in some interesting surprises, some of which are revealed in the built-in templates distributed with Scrivener. 8.1.1 The Three Root Folders The binder has three default root folders which cannot be deleted or moved from the top level (although they can be renamed, moved around amongst each other, but not within 60
- 69. 8.1. HOW THEBINDER IS ORGANISED 61 Figure 8.1: The three default top-level folders each other or other folders, or assigned custom icons). To use Scrivener effectively, it is very important to understand the significance of these folders. The Draft Folder As the name suggests, the Draft folder is where you place all of the files that you want included in your actual draft. How you structure it is entirely up to you—you 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. While media files cannot be placed di- rectly into the Draft folder, images can be placed into the text files themselves, in their appropriate locations within the text, just like in a normal word processor. A good way to think of the draft is like a long spool of paper or a scroll. In a normal word processor, this entire spool would be presented to you in a single window, with one scrollbar. Moving text around within that spool means cutting and pasting it from one spot to the next. In Scrivener, you can take that long spool of text and chop it up. These chopping points are entirely up to you—what you find useful as a writing tool. The compile feature offers a way to tape the whole thing back together into a single file, which is what you’ll need to work with the rest of the world. Meanwhile the “Scrivenings” editing mode does the same thing, but in a temporary fashion, and as such is an authorial tool which makes working in smaller pieces easier, since you can at any time view and
- 70. 62 CHAPTER 8. SETTING UP THE BINDER edit a larger segment of your draft as though it were a single file. These features will be discussed in depth in due course, but for now it is good know that there are no penalties for slicing and dicing up your manuscript into an easily to visualise outline. The Research Folder The Research folder is the default folder for non-text documents such as images, PDF files and so on (although it can hold text files too). You can create as many subfolders as you wish to organise your research, or you can rename it and create other folders in the root to hold different types of research. The Trash Folder Whenever you delete a file in Scrivener (by hitting the – Delete, for instance, or by selecting the Edit Delete menu item), the file is not actually removed from the project but is instead moved to the Trash folder. You can tell at a glance if the Trash folder has anything in it, as its icon will appear full. To permanently remove files from the project, select “Empty Trash” from the Project menu after having moved files to the Trash folder. Note that although you can rearrange items inside the Trash folder or view it like any other binder item (and of course, you can move files into the Trash folder by dragging); you cannot create new files inside it. It is not meant to be a working area. If you wish to have a secondary holding area for files you are not sure if you want to really delete, you can create your own folder in the binder to hold them. Files that have been place in the Trash will have their icons ghosted. This is useful in differentiating old files, since project search results will include trashed items as well. 8.1.2 Files and Containers If, like many authors, you are used to using a word processor for all of your writings, you probably have a few habits that you’ll inevitably end up bringing with you to Scrivener. One of these is working with large sections of information. In a word processor, it can be awfully clumsy to work in extremely long files the length of an entire book, but at the same time it can also be clumsy working with sections that are too short; it means having so many files open at once and no good way of keeping all the windows organised. A common tendency is to treat the binder like a collection of those semi-large files, say the length of a chapter, because even just that small incremental step can be so much better than working in a word processor. But if you organise your project in this fashion, you could be missing out on a part of the Scrivener experience. As it uses the convention of folders and files, you might instinctively approach the binder as a sort of “meta-Finder”, but in actuality, it’s far better to think of the binder in
- 71. 8.1. HOW THEBINDER IS ORGANISED 63 terms of being a bonafide outliner. You might have been drawn to Scrivener for this very reason, but because of the daunting number of things that must be learned all at once, have found yourself falling back to using a simplified file-is-chapter approach. The next section will demonstrate that it’s not only easy to work more dynamically, but it will save you countless hours in the long run if you just take a few minutes to sort things out, cut them up, and allow your book to emerge as a genuine outline. That’s what Scrivener’s binder can do for you, and unlike other word processor applications or plug- ins that tout outlining capabilities, you can use your own internal “authorial outline” which may or may not have anything to do with the actual construction of the book itself. 8.1.3 Folders are Files are Folders As you no doubt instinctively know, a folder is a place where you organise files. You can create folders on your disk, put files and even other folders inside of them to keep everything nice and tidy. Let’s throw away all of those notions for a moment and take a new, fresh look at folders, because in Scrivener, folders are an entirely different animal. Select a folder in one of your projects by clicking on it in the binder. You’ll probably get a corkboard view of its child items1 or perhaps an Outliner view if that is how you have things set up. This is all pretty straight-forward, but what happens if you close the corkboard view? With the folder still selected, click the currently active Group Mode button (Cork- board is the default) in the main toolbar (or use View Corkboard). You can tell which mode is active by its shaded background. After clicking the shaded button, you should get a blank view that looks suspicious like an empty text document. In fact, that’s pre- cisely 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 1 This is a term from outlining applications which means: items which are contained by the parent item. It is a relative term, for a parent could be a child of another parent. You’ll often see items referred to in genealogical terms like “siblings”, “aunts”, “ancestors” and so on. Most of these are intuitive and mean exactly what you’d expect. “Aunts” are a little more esoteric, but it refers to an item that is one level “higher” in the hierarchy than the previous item. A item has an “aunt” if the next item below it in the list is thus a sibling of its “parent”.
- 72. 64 CHAPTER 8. SETTING UP THE BINDER 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. This documentation will often refer to either folders or file groups as “containers”, when the distinction does not matter. 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 wherever that hierarchy takes you it will take so in the form of folders, or their cousins, the doc- ument 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. 8.2 Binder Controls Revealing and Hiding Elements Click on the arrow to the left of any container to re- veal or hide its contents in the binder. Use the LeftArrow and RightArrow keys to open and close containers. In conjunction with the Option key with either of the above methods, expand or collapse an entire portion of the outline tree at once.
- 73. 8.2. BINDER CONTROLS 65 Reveal and Hide All View Outline Expand All and Collapse All will disclose or re- veal 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 inter- face where it is possible to disclose items. Hoisting Focus on one area of the binder by selecting a container and choosing Docu- ments Hoist Binder. Documents Unhoist Binder will return the binder to its full display. Moving items with drag and drop Items can be moved around in the binder with drag and drop. Simple 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, showing where the drop will end up. Holding down the Option key while dragging will inhibit the “Drop on” feature, 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. Keyboard navigation The arrow keys move around in the binder. Up and down arrows will move up and down the outline. Left and right will ascend and descend the hierarchy. When a container is selected, the first time you press LeftArrow, a container will be closed, the second time will jump up to the next parent. UpArrow and DownArrow will jump from one visible container to the next. If a container is hidden from view, it will not be selected. When “Treat all documents with subdocuments as folders” is enabled in the Navigation preferences, file groups will be included when navigating this way. UpArrow and DownArrow jump to the top and bottom of the binder. Note this is different than the Home and End keys, which will only scroll the view, but retain your current selection. Copying Items While ordinary copy and paste functions are not allowed in the move- ment or reproduction of binder items, copying a selection of items can be useful. In most cases this will place a list of names on the clipboard. When copying images from the binder, the graphic will be placed on the clipboard and can be pasted into rich text editing fields, such as the main editor, project notes, and document notes.
- 74. 66 CHAPTER 8. SETTING UP THE BINDER 8.3 Using Collections Collections are a way to augment the binder method of organisation, and they will tem- porarily supplant the binder view in the sidebar, allowing you to reorganise or arrange collections of items in a flat list, regardless of their position in the actual project. You can think of collected items as being a bit like an alias, or a shortcut to that item. Changes made to items within the collection will also be made to the original item in the binder. A single item can be outside of the collections, or in one, or even in many. Each instance all points back to the same original item in the binder. When setting up a new project, you might like to create a few starting Collections to help organise material as it flows into the project, or as you generate new outline ideas. If you find yourself creating a sequence of common Collections at the start of every project, you might want to design a custom template (subsection 7.6.2) for yourself. Here are some example uses for Collections: l Experiment with an alternate scene flow without disrupting the original layout. l Collect all scenes which still need to be edited. l Designate items which you wish to share with another author using one of the various syncing methods. l Create a special compile group with an alternate selection and order than a typical compile of the draft. l Store saved searches for future use, or to monitor workflows. l Set aside groups of documents in a day-by-day schedule, removing them from each daily collection as you address them. 8.3.1 The Collection Interface To reveal the Collection interface, click the Collections icon in the toolbar, or select View Collections Show Collections. Each virtual tab represents a single collection. In the screenshot (Figure 8.2), the “Binder” tab is selected. While not a true collection, this is how you can navigate back to the Binder after viewing a Collection. Click on any tab to select it; when a tab is selected, it will re-colour and ghost all of the tabs below it to help indicate which is the active tab. Additionally the header bar will change its title to the name of the tab. You could hide the Collections interface at this point and continue working in that tab. The background colour of the sidebar and the header bar will help remind you that you are not in the full Binder.
- 75. 8.3. USING COLLECTIONS 67 Figure 8.2: The basic Collection interface with the binder selected. When first created, Collections will be assigned with an automatically generated colour, but their tabs can be recoloured by double-clicking the 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 or permanently removed. 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. 2. Search Results Collection: a special collection type that cannot be removed. Any project searches will have their query and results stored in this collection. This is persistent between project sessions. 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 every time you view the tab.
- 76. 68 CHAPTER 8. SETTING UP THE BINDER Figure 8.3: Standard Collection Controls 8.3.2 Standard Collections Creating a new standard Collection is as easy as pressing the + button. Any items that you have selected in the active view (including the Binder, other views, or even other Collections), will be automatically added to it. Once a Collection has been created, you can add or remove items to it, so it is not critical to select everything before you create it. There are several ways to add items to a collection: l 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. l Using the Documents Add to Collection sub-menu, any selection of items, in- cluding the active item that is being edited or viewed in the editor, can be added to the bottom of a collection list. l In the binder sidebar, you can right-click on an item(s) to access the “Add to Col- lection” 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”. Remove 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.
- 77. 8.3. USING COLLECTIONS 69 Delete the entire Collection by first selecting the tab you wish to remove, and then clicking the - button in the upper title bar. Items can be re-ordered within the list using click and drag, or the same – ArrowKey combinations used in the Binder. Since there is no hierarchy in a Collection, you will not be able to promote or demote items. 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 de- fault 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. 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)”. 8.3.3 Search Result Collection If you’ve used Project Search, then you’ve been using a Collection without perhaps real- ising it. Search results are placed into this special collection every time you run a search, and the criteria of your search are saved into it along with the project. This means the last Project Search that you ran will always be available to you, even after you have re- booted your computer. Like the Binder tab, the Search Result tab cannot be deleted, and there is always one included with every new project. WIN: The Search Results tab can be dismissed by clicking the red X button in the corresponding tab. This will clear the tab view if you otherwise were not using collections, and reset your search criteria. Both the built-in Search Results collection, and Saved Search Result Collections, allow you to view the label and status of the matching items, making it convenient to enact workflow changes without using the outliner. When you click on the Search Results tab, the previous search criteria will be loaded into the search bar tool, allowing you to further tweak the results if you desire. Since search results depend upon the search criteria, you cannot manually add, remove, or change the order of items from the Collection, as you can with the standard type.
- 78. 70 CHAPTER 8. SETTING UP THE BINDER Figure 8.4: The Search Result Collection 8.3.4 Saved Search Result Collections As with the Search Results tab, saved searches have a magnifying glass in the corner to indicate that it is a special type of Collection which automatically generates its contents for you. Saved searches are created by clicking the magnifying glass in the Project Search tool, and selecting Save Search. When saving from a Keyword or Label search, the asso- ciated colour of the meta-data you are looking for will be used for the tab’s colour as a convenience. If the Collection interface is hidden, the sidebar background will change to a random, automatically generated colour, and the header bar title will adjust to the name you pro- vided. 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
- 79. 8.4. DOCUMENT TEMPLATES 71 only use this method if you no longer need the search criteria. To convert a saved search result to a standard collection, select the tab in the sidebar, and use the menu command, View Collections 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 Collections, by selecting the tab and clicking the - key, as shown here (Figure 8.3) See Also: l Project Search (subsection 20.1.2). 8.3.5 Back to the Binder It is possible to select some or all of the items in a collection and instruct Scrivener to gather them all together into one spot, based on the order of their appearance in the collection. To do so, you will need to have the collection tab interface visible. Simply select the files you wish to gather, drag them to the binder tab and hold for a moment. The binder will activate, and you can drop the selection wherever you please. Do notice that this moves items from one spot to another, and cannot be undone. Experienced users of outliner style programs will recognise this ability as “mark and gather”. The marking phase is done by assigning documents to a collection. Dragging them back out to the binder then gathers them quickly into one focussed spot. This can be an extremely useful technique for some workflows. It can also be useful to experiment and implement an experimental text flow. If a chapter or section just doesn’t seem to flow right, you can quickly create a new collection, Option-drag the container of items to the new tab, and then re-organise the flow using the collection’s ability to view itself as a corkboard or outliner, then reviewing the text with scrivenings mode. Once you are satisfied with the new layout, select all of the sub- files and drag them back into the original folder in the binder using the above method. The items will be re-organised for you in the actual book structure. 8.4 Document Templates Document templates give you the ability to designate a set of items which can be used to create new items. Much as with project templates (section 7.6), everything that you add to a template item will be added to new items created off of it. This includes the various
- 80. 72 CHAPTER 8. SETTING UP THE BINDER Figure 8.5: Example Document Template Structure meta-data, notes, keywords, references, synopsis, and of course any text. Additionally, folder items designated as templates will create copies of their children too, allowing you to quickly generate complex repeating structures. Document templates do not provide forms that you can fill out with the tab key. They are simply a convenient way to reproduce ordinary folders and files, with their meta-data intact. 8.4.1 Setting a Document Template Folder Templates are designated by placing them into a special folder, marked as being a template container (which can be a folder or file group). Each project can only have one template container at a time. To set it up, select the container of templates, and use the Project Set Selection as Templates Folder. The binder icon will change to 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 Templates 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 folders 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
- 81. 8.4. DOCUMENT TEMPLATES 73 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 tem- plate (subsection 7.6.2). 8.4.2 Creating Document Templates Creating new templates is as easy as creating a normal file or folder item in the binder. There is nothing special about these items, save for their position within the designated templates folder. Anything that you create within the templates folder will be available for usage in the project. It is possible to pre-configure all aspects of an item. The only thing which will not get carried over is Snapshots. The latest version of the item’s text will always be used and Snapshots will be ignored. 8.4.3 Using Document Templates Once a container is designated as a Template Folder, and items have been added to it, you can generate copies of these templates via the Project New From Template sub-folder. The items in this folder will be arranged precisely as they have been organised in the binder. Groups will become further sub-menus. As with the other commands that create new items, they will be created in relation with the current binder selection. l If you select an entire group, it and all of its child items will be created in the selected position. l 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. l It is possible to assign your own keyboard shortcuts to other items, using the in- structions here, Customising Keyboard Shortcuts (chapter 27), but note that these shortcuts will only apply to those projects which have identically named templates. l As with project templates, once created, document templates have no connection with the item that they were modelled after. It is safe to delete a template that is no longer being used to create new items. You might wish to, however, move the template item to another spot outside of the template folder, in case you ever need it again.
- 82. Chapter 9 Navigating and Organising In this chapter, we will discuss the project window itself, and the many tools that are available for moving around within this window, controlling its appearance, and adjust- ing how it behaves when you click on things within it. 9.1 General Navigation Moving around within a large project is an important part of writing efficiently, espe- cially in an application like Scrivener, which lets you cut your work up into small pieces. An average book might have anywhere between several dozen and a few hundred sec- tions arranged into many folders. Along with the binder, there are two primary tools for making sense of all of these pieces: The Outliner (section 12.2) and The Corkboard (section 12.1), covered later in this portion of the book. For now we will concentrate on how to use them as navigational tools, and as your skills increase, you’ll find other uses for them beyond mere navigation. Beyond the three primary navigation tools, there are a number of other features which can be used as needed to enhance the main three, and these will be covered in this section as well. 9.1.1 Navigation specifics Some navigation features which are common to both the corkboard and the outliner are: l Double-click on an icon to load that document in the editor. Figure 9.1: The Auto-Load button will appear blue when activated. 74
- 83. 9.2. GO TOMENU 75 l –O to load the selected item in the editor, or when more than one item is se- lected, isolate the focus on just the selected items. This latter usage is quite useful when you have a large Corkboard or Outliner, and wish to quickly show only those items you’ve selected. l – O to load the selected item in the other editor split. l Both corkboard and outliner views have an Auto-Load feature which when en- abled, will load any selected 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. 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 composition mode 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, though you can alter this behaviour by holding down the Option key, which will load the selected item in QuickReference panel, instead. There are two locations where this menu appears: l The main application menu, View Go To. The main application menu version also provides three shortcuts for navigating within an editing session: – Previous Document ( – UpArrow): Selects the previous item in the binder, no matter what the relative depth. – Next Document ( – DownArrow): Selects the next item in the binder, no matter what the relative depth. – Enclosing Group ( – R): Selects the parent container which the currently selected item is within; in effect traversing up the hierarchy, much as if you had clicked on the parent container using your mouse in the binder. The current view mode preference will be used if possible. If you are editing a section of the Draft using Scrivenings mode, then using this command will expand the Scrivenings session to include the parent and its siblings, just as if you had clicked on the parent; if working on a corkboard, the next corkboard higher up will be viewed. In cases where the current view mode conflicts with 1 nav-auto_load_button.png
- 84. 76 CHAPTER 9. NAVIGATING AND ORGANISING the selection, corkboard will be used as a fall-back. An example might be if you have scrivenings mode enabled as your default view mode, but you are currently viewing an image or PDF. Since scrivenings does not apply to these items, this command will switch you over to corkboard. l Via clicking on the item icon in the editor header bar. 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). 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 Composition Mode To use the “Go To” menu in composition 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. 9.3 Hoisting the Binder When you need to focus on one specific area of the binder, you can use Documents Hoist Binder to isolate the currently selected container. Only one item can be selected, and it must be a container (file or folder).
- 85. 9.4. CONTROLLING BINDERINTEGRATION 77 Figure 9.2: Hoisting: Before and After When a container has been hoisted, the appearance of the binder will change2 . The header bar will be replaced with the name of the container that has been selected, includ- ing a small icon representation of its type, and the list of items available will be reduced to only those items which are children of the selected container. If you wish to select the container itself (for example to view Scrivenings, or its cork- board), click on the header bar. Once selected you can choose the view mode you prefer, if necessary. To return to standard Binder view, either click the indicated X button in the footer bar of the binder area, or select the menu command, Documents Unhoist Binder. 9.4 Controlling Binder Integration In most cases, whatever you click on in the binder will be automatically loaded into the active editor. This can become more complicated when there is more than one editor split in use. When this is the case, the split which has its header bar highlighted in blue will be the one that receives binder clicks. The inverse of this is however not true. The 2 action-hoisting.png
- 86. 78 CHAPTER 9. NAVIGATING AND ORGANISING binder will not automatically select items based upon what you are viewing in the editor. The editors can drift from the original selection quite easily. All you need to do is use the history buttons, double-click on an index card icon, use the View Go To menu, click on a Scrivener Link, and so forth. There are two features available which change how clicking in the binder sidebar work. Any editor split 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 which persists even when the split is not active. Either or both splits can be locked independently. This feature can also be accessed from the header bar menu. Locking the editor prohibits external click actions from impacting the locked editor. This means that clicks in the binder, corkboard or outliner (when Auto-load is enabled), will be blocked. This makes it easy to keep your editing session while you use the binder or these other views to explore the outline. What locking will NOT do is prohibit actions taken from within the editor itself. This includes use of the binder navigation arrows, history functions, and manually dragging items to the header bar, or menu navigation commands. Locking is meant primarily to keep the interface from taking actions that it would ordinarily take automatically. Locking will not inhibit intentional actions that you make, but some (like the View Go To sub-menu) may cancel the lock state. A common exception to this rule of them is when it makes sense to scroll your view, or select items within it, based on an external selection. If the editor is a locked Scrivenings session (where more than one text file is viewed at once), then if you click on something that is contained within that session, Scrivener will scroll to the right spot for you—but like if you clicked on an entry in a table of contents link, in an e-book reader. In a large locked corkboard, you can jump to individual cards by clicking on them in the binder. Again, this alternate method of navigation only works when the item you click on in the binder sidebar is contained within the locked view already. You will need to unlock the editor in order to use the binder to select items outside of the current view. An alternate behaviour can be set in the Navigations preference tab (subsection B.6.3), “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 dy- namic. 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 Af- fects Left Editor has been enabled, however, all clicks will be sent to the left split
- 87. 9.5. LINKING DOCUMENTSTOGETHER 79 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 side- bar 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 indicator will be removed when operat- ing 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 Editor. See also: l Splitting the Editor (section 14.8) for further documentation on how to use editor splits. 9.5 Linking Documents Together Much like hyperlinks on the Web, Scrivener Links make it easy to create and use a net- work of text-based cross-references within your project. Since in most cases they do not export from your project, it is safe to use them in the text of your work wherever you need them. They can also be used within the various available notepads. Their ability to elevate the visibility of information in your project can turn them into a valuable naviga- tion tool, as well as providing convenient uses beyond the project itself, during Compile. The creation of links can even be a good brainstorming tool, as you can build your outline with links, while typing. Links appear much like URL links do on the Web. They will sport a blue appearance and be underscored. The link colour can be customised in the Appearance preference tab, under “Customizable Colors”, in the Editor section. The underscore cannot be removed, so even links set to same colour as the base text can be identified. 9.5.1 Creating Scrivener Links Drag and drop l To create a link to a specific item in the binder, drag the item into the text where you would like it to appear, while holding down the Option key. The blinking cursor will help show you where the final location of the drop will occur. When
- 88. 80 CHAPTER 9. NAVIGATING AND ORGANISING creating links in this fashion, they will be automatically titled by the name of the document that was dragged. l It is possible to drag more than one item into the text area at once. Select multiple items in the binder and drag them over as above. Links will be separated one per line. l Items can be dragged into the Notes Pane (and the Project Notes window) as well as the main text area, in this fashion. Select Items and Copy When you want to create links to items in multiple places, it is usually easier to use the Edit Copy Special Copy Documents as Scrivener Links menu command. Now you can paste ( – V) the items into several different places rapidly. As with Drag and Drop, you can select more than one binder item at once, producing quick lists of links. Select Text and Link Often you will want to link a phrase to a specific document without having the name of that document be a part of the link. To create links in this fashion, select the text you wish to link, and then right-click on the selected text. Use the Scrivener Link sub-menu to create a new link. This menu is also located in Edit Scrivener Link. This sub-menu functions in a very similar manner to the “Go To” menu (section 9.2), by providing an organised list of every item in the binder. The menu is organised as follows: 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. There are two tabs available in the sheet. The default tab, “Create New Linked Doc- ument”, will let you generate a new document and attach it to an existing container (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 . 3 If this is hard to understand, I suggest reading Folders are Files are Folders (subsection 8.1.3).
- 89. 9.5. LINKING DOCUMENTSTOGETHER 81 Figure 9.3: Create a New Linked Document 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. This section will not appear if no suggestions are found. 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.
- 90. 82 CHAPTER 9. NAVIGATING AND ORGANISING 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). Wiki Link Style An optional method lets you type in new links without using the mouse at all, or even being fully aware of the title you wish to link to. To enable this method, visit the Correc- tions tab of Scrivener’s preferences, and turn on and [[Scrivener links]] in the Substitutions section. To use this method, while typing in the text you can enter two double-brackets, type in the title of the item you wish to link to, and then close it with a second pair of brackets, as shown. Scrivener will detect what you are trying to do, and if it finds an exact match to a document, will link it for you automatically. If it does not recognise the text inside the brackets as correlating with an existing title, the New Link sheet4 will pop-up, giving you the option to either create a new item and place it in the Binder, or via the second tab, “Link to existing document”, navigate to an existing document in the Binder and create a non-literal link. Non-literal links are useful when you wish to link phrases in your text without directly referencing the name of the item you are linking to. Once substitution has been performed, the brackets will be removed. As with other substitution types, wiki linking5 works only on newly typed material. If you have previously typed in double-bracketed words, and then enable the option, you will need to re-bracket them. 9.5.2 Removing Links Links can be removed (including URLs to external web pages) with the Edit Unlink menu command, without destroying the underlying text. Any link falling within the currently selected text will be removed, so there is no need to be precise about what you select. This is an easy way to wipe out dozens of links at once, something which is of particular use when pasting text from web files, or other Scrivener documents with links. Note that linked comments and footnotes will not be deleted with this command. 4 sheet-new_link-new.png 5 Referring to these links as “wiki links” does not imply that your project can become a wiki. It merely refers to the appearance of the syntax as it is typed in. Scrivener links must always point to an existing resource, unlike true wiki links, which can be placeholders for items which do not yet exist.
- 91. 9.5. LINKING DOCUMENTSTOGETHER 83 9.5.3 Configuring How Links Work in the Interface Most of the configuration options for links are located within the Navigation tab (sec- tion B.6), in the Scrivener Links section. Here you can configure how links will act when they are clicked, and what will happen when new links are created. Both settings have three options available: l 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. l 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). l QuickReference Panel: The item will be loaded into a QuickReference panel (sec- tion 20.2)6 . The colour appearance of links can also be adjusted in the Appearance tab (section B.3). 9.5.4 When Scrivener Links can be Compiled For the most part, Scrivener Links are a feature which reside within the realm of Scrivener. When compiling, they will most often be stripped out of the source text, and thus are handy for inserting useful links for your own purposes, which will not show up at all in the finished manuscript. There an optional exception to this rule that requires a chain of conditions to be present. 1. Links which are solely the title of the document they link to. 2. Enable the “Update titles in Scrivener links with prefix and suffix settings” option, in Compile under “Title Adjustments”. 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 link to document titles in the text which will be altered to match their final appearance in the compiled version. Since titles can be added to, or even entirely replaced, by the compiler, 6 Scrivener Links activated from within a QuickReference panel will always open a new panel.
- 92. 84 CHAPTER 9. NAVIGATING AND ORGANISING 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 . The phrase “How to Grow Better Tomatoes” is linked to a binder document of the same name, in the final manuscript. However, in the compiler the author has arranged for this title to be prefixed, so that in the book it will appear as: Chapter 7: 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: To read more about this topic, see Chapter 7: How to Grow Better Tomatoes . 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 pro- cessors 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. E-books are afforded more power in that they can link to items in the Binder which are otherwise not true sections. This can be useful if you wish to link to a particular figure— you could place that figure in a text file all by itself, and then link to that resources with a Scrivener link. This will navigate to the image in most reader hardware and software. See also: 1. Compiling the Draft (chapter 23) 2. Creating a Table of Contents (chapter 22)
- 93. 9.6. USING FAVOURITES 85 9.6 Using Favourites Setting binder items as favourites will increase their visibility in a few key areas of the application. One of these has already been covered; the Go To menus. Setting an item as a favourite will make it easy to navigate to that item in the future, as it will always be present at the top level of that menu (with the exception of when the menu is acting as a table of contents for a Scrivenings session). The second menu which will have favourites added to it is the Scrivener Link creation 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: l Add to Favorites: Adds the selected document(s) to the favourite list. l Remove from Favorites: Removes the selected document(s) from the favourite list. Favourites will be added to the following menu functions: l View Go To : Provides navigation features to any spot in the binder. l View QuickReference : Opens a QuickReference Panel for the selected item from that menu. l Edit Scrivener Link : Creates text links to documents, like URLs in a web browser. l Documents Move To : Moves selected binder items to other locations in the binder. 9.7 Layouts Panel The Layouts panel allows you to save different layout set-ups and load them again easily. For instance, in the early stages you might focus on a large corkboard without any other interface to get in the way; as structure starts to emerge, you may have the binder open with the corkboard in the top editor and text in the bottom editor; whilst composing, you may have only the text open, with the binder, inspector and toolbar hidden. By using the Layouts panel to save different layouts, you can switch between these view settings quickly, without having to go through the process of hiding the binder, toggling
- 94. 86 CHAPTER 9. NAVIGATING AND ORGANISING the toolbar and so forth. You can even save column settings and other details into layouts. To show the Layouts panel, select View Layout Show Layouts, or press – 0. If you do not have any layouts saved yet, you’ll be presented with a window and an empty list. You can try the feature out immediately by clicking the + button. A screen- shot of your current project window will be taken and placed into the right side of the screen, and you’ll be given the opportunity to name the layout something meaningful. With a combination of names and screenshots, your layouts should remain accessible and easy to find. 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 configure custom keyboard shortcuts for quick access to commonly used layouts, using the standard OS X system shortcut tool. 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. Use the Import Layout menu choice to import a layout you have transferred from another computer or downloaded from the Internet. 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 saved layouts 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 or switched to viewing a particular collection. Even within one individual project, these details might change or no longer be relevant. Here is a list of things layouts do save: l Binder visible/hidden
- 95. 9.7. LAYOUTS PANEL 87 l Collection tab interface visible/hidden l Inspector visible/hidden l Split type (horizontal/vertical/none) l Binder mode (whether it affects one or current editors) l Header bar visible/hidden l Footer bar visible/hidden l Editors locked in place l Ruler and Format Bar visible/hidden l Selection auto-load in alternate editor settings l Window size and position and view sizes l Toolbar visible/hidden and view mode (such as small or large icons) l Corkboard/outliner/scrivenings/editor mode for each split l Page View or standard draft view for each split l Full Screen status [10.7 (Lion) Only] In addition, optional settings are saved depending upon whether these two checkboxes 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 tinting is in use in the various areas of the interface; and pin, stamp, and keyword chip visibility in the corkboard.
- 96. 88 CHAPTER 9. NAVIGATING AND ORGANISING 9.8 Full Screen Mode Mac OS X Lion introduces a new feature which make it easy for third-party applications like Scrivener to utilise a special full screen mode which pushes the Dock and main system menu bar off-screen. In addition to reducing these distractions, the application is free to fill every single available pixel on your monitor. Scrivener’s full screen implementation is project window based. This means you can actually run several different projects at once in different full screen spaces on your sys- tem. Each project window will feature a full screen expansion icon in its upper-right hand corner. This button corresponds with the View Enter Full Screen menu command7 and can be toggled with – F. Toolbar Bug: In the current release of Lion, there is a bug which causes the main toolbar to appear in full screen mode, even if you’ve set the toolbar to be otherwise hidden. Fortunately it will be auto-hidden along with the main menu, and curiously if you select View Hide Toolbar while in Full Screen, it will then act as it should (but it will not stay that way permanently). Since Lion creates a new “Space”, dedicated for any project window that has been set to use full screen, any peripheral windows that had been opened (such as the colour palette, Find tool, QuickReference panels, etc.) will not be conveyed to that new space for you. New windows that you open while working in full screen will remain in that view, but existing windows will not, and cannot be moved afterwards without closing them and then re-opening them. Full Screen with Multiple Displays: Due to how Mac OS X Lion handles full screen mode, if you are using multiple displays and enter full screen mode, all of the other displays will be blacked out. This is unfortunately out of our control. 9.8.1 Full Screen and Layouts Saved Layouts (section 9.7) will remember if they have been saved in full screen mode. Switching to a Layout that has been marked with a full screen icon beside it will enter full screen as well as re-arrange the window, making for a convenient way to work with special-purpose Layouts intended to use a lot of space. If you do not wish for a Layout to transition you to full screen, you can hold down the Option key when selecting the Layout for use. 7 In prior versions of Scrivener, this menu command would enable the distraction free writing mode. Due to naming conflicts, this feature has been renamed to Composition Mode (chapter 16).
- 97. 9.9. FILTERING ITEMSIN VIEWS 89 You may also select up to one full screen layout to use as a default. This will cause Scrivener to trigger the use of this layout even when using the standard menu command, rather than using the Layout features to access it. You can think of it as a way of setting up Scrivener to have a different form of interface when entering full screen. If no Layout has been selected as a full screen default, then the current window settings will merely be expanded until the project window fills the screen. 9.9 Filtering Items in Views One of the ways in which you can work in Scrivener is with interleaved notation amongst your work in progress. This is a method that some prefer, as it keeps their thoughts and ideas immediately contextual with the text itself, and it supports a working method where notes are more extensive than what can easily be put into annotations attached to the text itself. In Scrivener, you can place text documents right alongside the documents used to contain portions of your Draft, and then instruct these special note documents to not compile (subsection 10.1.5)—in other words when you turn the Draft folder into one long file, these note files will be hidden. Ordinarily, when you view a portion of the draft with the Scrivenings view mode (section 14.12), you will see all of your notes and draft text together. This can be advan- tageous, especially if you use an alternate font for your note files—but there will be times when you want to just see the compilable text that will become your book. You can also select any container and use the Documents Open (with) Compilable Subdocuments menu item. The name of this menu item will change depending on whether or not you’ve set up your preferences to consider the container as part of a Scrivenings session. Some prefer to omit the container, and so set “Include folder text in Scrivenings (composite text mode)” in the Navigation preferences tab (subsection B.6.1) to off. When this setting is disabled, the menu item will omit the ‘with’, and only the children of the selected container will be included in the flat list. A quick way of doing this is to hold down the Option key and click on a container containing the portion of the draft you wish to view in this fashion. For some people who use minimal organisation, this might mean using the Draft item itself. The result of this action will be a flat multiple selection of items. You can actually view these in any format that you prefer, though in most cases you’ll probably want to use the Scrivenings view mode.
- 98. Chapter 10 Setting Up Meta-Data Documents of any type in Scrivener can have various meta-data associated with them. Meta-data is a way of talking about something without impacting it. A simple example from the analogue world could be a Post-It note on a paper-clipped stack of paper. The Post-It note is a kind of meta-data, and so is the paper-clip. In Scrivener, meta-data can be applied in similarly analogue fashion, like stamps across the face of an index card, or what colour of pin or marking it has in its corner. Other types of meta-data in Scrivener are more abstract, and you can even make up your own if the built-in types are not enough. Some of this meta-data can be viewed in the corkboard, the QuickReference panes and outliner views, 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. 10.1 Meta-Data Types The basic meta-data types include the title, and text synopsis (including an optional image replacement for the synopsis). The title is the most important component of any item in the binder, as it will be used to identify the document in the many views, menus, and export methods. When exporting as files, filenames will be set according to the title field; when compiling, titles can be used to generate headers for that section; index cards use the title; the outliner is composed of a list of titles; and titles may also be used intelligently by the compiler when linked to the document by that same name. The synopsis is a plain-text field, primarily intended to be a short summation of the contents of the document, though how you choose to use it is entirely up to you. The synopsis is displayed in a variety of ways. 1. Corkboard: used to display the content area of the card. 2. Outliner: will be placed beneath the title (which appears in bold), by default. 90
- 99. 10.1. META-DATA TYPES 91 3. Binder: revealed in the tooltip when hovering the mouse over the corresponding 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. In all cases, specific types of meta-data can be displayed as columns in the Outliner view, including custom meta-data. 10.1.1 Setting Up Label & Status The next two forms of meta-data are flexible in what you can refer to them as. Using the Project Meta-Data Settings...( – ,) you can set up custom names for both the label and status, and the interface will adjust accordingly, no longer referring to them as “Label” and “Status” for that project. If you wanted, you could have “POV” and “Location” instead of “Label” and “Status”, or “Focus” and “Type”, or “Monkeys” and “Bananas”, or anything else you want. The documentation will continue to refer to them as labels and status for convenience. They are also, after the title, the most visible items in the entire interface. They can be represented in the corkboard and outliner views, are best administered in the inspector, are given a priority position in the QuickReference panel, are displayed in search results, and are given priority placement in most of the printing methods. Labels, having an associated colour, can also be used to visibly tint various interface elements, such as binder or outliner rows or even the entire index card “paper”. The default blank project and many of the templates come packaged with a few exam- ple status & labels, but you will most likely wish to create your own. To add or remove project labels, use the Project Meta-Data Settings menu item, or press – ,. The inter- face provides tables for three meta-data types. Labels and status lines can be added or removed with the + and - buttons. Edit an existing label by double clicking on the text. For labels, the colour can be changed by double-clicking on the colour chip to the left. The order in which these items appear in their respective menus is determined by their arrangement in this table. Click and drag rows to rearrange them. When you create new items in the binder, either by adding items or importing, they will automatically be supplied by a default label and status value. Ordinarily this will be assigned to the “No Label” or “No Status” choices. If you wish to change this behaviour, select the alternate value by clicking on its row, and then click the Make Default button. Once you click the OK button, the interface will update with your changes.
- 100. 92 CHAPTER 10. SETTING UP META-DATA 10.1.2 Label Colours Labels can have a colour associated with them and are completely customisable - you can even rename “Label” to “POV” or something that better fits your project (see below). Labels are one of the most flexible meta-data types in terms of how visible they are in the interface, so you can pick a colour to reflect how prominent you wish them to be, depending on their associated material’s content. Label colour can be depicted in the following ways, many of which are optional, and can be enabled 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. The visual style can be changed in the Corkboard preference tab. 2. 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 docu- ment icons wherever they appear. 6. Index Cards: enable with View Use Label Color In Index Cards this optional method will tint the “paper” colour of index cards wherever they appear. The label can also be used to tint colour printouts when printing corkboards and out- liners. 10.1.3 Status Stamps As with the label, the status field can have its representative name altered to suit your project’s unique requirements. By default, this field represents the status of a document in terms of its completion, such as “To do” or “Rough draft”, but this field can be used for whatever purpose you desire. Unlike the label, there is no corresponding colour, and so its display potential is more limited.
- 101. 10.1. META-DATA TYPES 93 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 preference tabs, and display can be toggled with View Corkboard Show (Hide) Stamps or – S. 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.4 Using Keywords Each document can have a list of keywords associated with it. These are useful for mak- ing documents easily searchable—for instance, you can list all characters and locations connected with a scene in the keywords even if they are not mentioned explicitly in the text. Creative uses for keywords also include extended status control, plot management, and whatever else you can think of. Like labels, keywords have an associated colour which will be displayed beside the keyword in the inspector list, as an underscore in the relevant outliner column, and in the Project Keywords window (see below). Additionally, keywords can be used in the corkboard as small coloured squares along the right-hand edge of the card. The visibility of these can be toggled with View Corkboard Show Keyword Colors, or – K. The display preferences for these can be adjusted via the corkboard display controls (subsec- tion 12.1.4). When exporting or printing, keywords will be displayed on a single line, separated by commas. 10.1.5 Minor Meta-Data In addition to the primary types of meta-data, there are a few smaller items, located in the General meta-data section of the Inspector: Created Date The date and time the document was first created. Modified Date The date and time the document was last changed and saved. Include in Compile A checkbox determining whether the document should be in- cluded in the draft when exported or printed via Compile from the File menu. If checked, the document is exported or printed; if not, it is excluded from the export/print (this can be temporarily overridden in Compile). This way, you can have documents in the Draft folder that act as notes that are never included in the final draft. Note that this setting really only has any meaning for documents that are inside the Draft folder, though it can be set anywhere, allowing you to modify text documents outside of the Draft in cases where they might at some point end up
- 102. 94 CHAPTER 10. SETTING UP META-DATA being compiled, or used as templates for files that will be compiled. The checkbox never has any meaning for media entries, as these items can never be compiled. 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 begin- ning of a chapter. As with Include in Compile, this only has any meaning for text documents inside the Draft folder. Compile As-Is All options set in the compile formatting options pane (section 23.8) will be ignored for the checked document. This means no extra material will be added, nor will text be removed, including titles, and no reformatting of the text will be done1 . As with the above two items, this checkbox has no meaning for items outside of the Draft. 10.1.6 Custom Meta-Data When you need to keep track of more detail than the default meta-data options provided, adding custom fields to your project can be a valuable move. Custom fields are funda- mentally free-form text labels. Setting them up is done using the Project Meta-Data Settings... control, in the third tab. For each column you wish to add, press the + button and supply a column title. Each field has two options: 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 configuration 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. 10.1.7 Exporting Meta-data All meta-data can be exported in a variety of ways, usually text-based for maximum compatibility, so you needn’t fear having important organisational information getting locked-in with the project format. Meta-data can be exported in the following fashions: 1 The one exception to this being when a Quick Font Override (section 23.20) is in use.
- 103. 10.2. PROJECT KEYWORDS 95 l Compiling: when compiling the Draft, enabling meta-data export is an optional feature of the Formatting pane. The various types of meta-data will be exported into the Draft in a variety of ways best suited to the type of data involved. l 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 ex- ported. This method is used to preserve the integrity of the original document, and to enable meta-data export in formats which would not otherwise allow text data to be inserted into it, such as mp3 files. l Outline and Corkboard printing: both of these printing methods optionally allow meta-data to be expressed in the printout. Unlike the above two examples, these al- low for a more fine-grained approach, letting you export just the label or keywords if you want. l Drag and Drop: When dragging documents from one Scrivener project to another, 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. 10.2 Project Keywords The Project Keywords window holds all of the keywords in use by the project. As you en- ter new keywords into the Inspector (subsection 18.4.3), they will be added automatically to the central project list. You can access this pane via Project Show Project Keywords, or – H. You can create a new keyword by clicking on one of the buttons at the bottom of the panel. The left-most button creates a new keyword as a sibling of the selected keyword, and the one next to it creates a new keyword as a child of the selection. The third button deletes the selected keyword(s). Keywords are automatically sorted alphabetically. You can drag any keyword onto any other keyword to make the dragged keyword a child of the one onto which it was dropped. For the most part, the hierarchical structure of key- words are really only an organisational convenience with no effect on how the keywords are represented in documents themselves. There is one exception to this, below. To assign keywords in the panel to a document in the main window, select and drag the desired keywords from the panel and drop them onto either the keywords table in the inspector of the main window, the header view above the document editor or onto the document in the binder, corkboard or outliner. If there is a multiple selection in the binder, corkboard or outliner and the keywords are dropped onto one of the selected documents, the keywords will be applied to all selected documents. Hold the Option
- 104. 96 CHAPTER 10. SETTING UP META-DATA key down whilst dragging to drag not only the keyword but also any parent keyword(s) under which it is grouped. You don’t have to use the keyword panel to create keywords, of course—you can also enter keywords directly into the keywords table, in the inspector (subsection 18.4.3), to apply them to the current document. Note that whenever you apply keywords via the inspector, they will automatically be added to the list in the panel if they are not already contained there, so that the panel should always have 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 panel. By changing the name of a keyword in the project keywords window, all of the associated keywords in the project can be updated in the background. When removing keywords from the panel, 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 project keywords window 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 panel. 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. 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 containing all selected keywords will be returned. 10.3 Project Properties The fourth tab of the Project Meta-Data Settings... panel contains some optional labels that will be used in many of the built-in compile format presets, and can be used in your own using the referenced placeholder tag to the right of each field (which can be copied and pasted for your convenience). As you might note from looking at this panel, Scrivener will attempt to use reasonable defaults for these fields if they are not changed by you. Project Title The Project Title is ordinarily taken from the name of your project file, but in cases where that does not match reality (as it is often convenient to use naming conventions in your project file names to set large revisions apart), you can use this field to override the default and use your own title for the work. Abbreviated Title Especially useful in headers, long titles often need to be shortened to fit in the header area, so you can optionally use the <$abbr_title> placeholder to
- 105. 10.3. PROJECT PROPERTIES 97 Figure 10.1: Project Properties Tab display a shortened version of it. If nothing is supplied here, it will use the project title value (modified or not) as a fallback. Author’s Full Name, Surname, and Forename Ordinarily, these three fields will pull information from your Mac’s Address Book program, using the default card set up by your system when you first set up your computer. If you need to use a pen name, these would be the fields you should modify. Do note that if you started with a built-in template, some of these values will already be evaluated to text, particularly in any title page material. Since they have been evaluated to text and are not using a token, you will need to edit them separated; this panel will not update them.
- 106. 98 CHAPTER 10. SETTING UP META-DATA 10.4 Text Preferences Sometimes a project will need its own font and ruler settings. Ordinarily, all new files you make in all projects will conform to the settings in the Formatting preferences tab (section B.8). Using Projects Text Preferences..., you can supply an override to a specific project, so that its new documents take on a custom appearance. Scriptwriting and Fonts: when using Scrivener to compose scripts, the font for the script will be selected for you based on the script settings, not the application settings or this override. See Scriptwriting (chapter 19) for further details. First, enable “Override text formatting for this project”, with the checkbox at the top, and then proceed to use the mock editor to set up your preferred styling for this project. This works just like the Formatting pane, or if you haven’t used that before, much like the standard text editor. The Use Current button provides a handy way of importing settings from the current text editor at the cursor position. So if you’ve already set up a document to look the way you want it to, using this button can save some time. Use different font for footnotes This also overrides the application preferences for an alternate footnote font. This setting will impact both inline and linked footnotes (chapter 17). It will work even if you are not setting a custom font for footnotes in the main application preferences. Use footnote marker An alternate way of referencing linked footnotes, which places a custom marker after the selection or current word, rather than highlighting it. In documents that make use of heavy notation, this can help keep the editor looking clean. The marker used can be typed into the text field. If you prefer this behaviour for all of your projects, clicking the Make Default but- ton will force your setting on all projects, even those you’ve already created. Read more about this feature in Linked Footnotes (subsection 17.2.3).
- 107. Chapter 11 Gathering Material 11.1 File Import Whether you are using Scrivener for the first time and want to use it with documents you have already created in other programs, or whether you just have reference files lying around that you want to bring into an existing project, the chances are that at some point you will need to import documents created in other word processors and programs into your Scrivener project. Fortunately, this is very easy. Importing files into the project binder means that these files will be copied (and possi- bly transformed into a fashion that Scrivener can use better) into the project itself. The original copies on your disk will not be removed or altered in any way. While it is pos- sible to easily edit many file types from within Scrivener with an external editor, if you wish to retain maximum external control over the files, you might wish to use References (subsection 18.4.2) or aliases (subsection 11.1.3) instead, strategies that is also useful when your research material measures in gigabytes. There are two ways to import documents from other programs: 1. Drag and Drop. In the Finder, select the files you wish to import and then just drag them straight into the binder (not the corkboard or outliner) in Scrivener. When dragging folders, all of the contents of that folder will be added recursively, and the file structure on your disk will be recreated in the binder. 2. The File Import sub-menu provides some handy methods for bringing existing material into your project binder, including directly off of the Internet, if you have the URL. In cases where the imported material has some sort of innate or option- ally defined structure, Scrivener will attempt to convert that into outline hierarchy; documents with split markings can be set up to create many documents upon im- port; 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 window describing important information pertaining to the various limitations of the import 99
- 108. 100 CHAPTER 11. GATHERING MATERIAL 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 original file on your disk, 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 importing 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 insertion 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. 11.1.1 Supported File Formats Scrivener supports the following text types for importing: l RTFD (rich text format directory) A proprietary Apple rich text format com- monly used by Mac Cocoa applications. l 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. l DOC & DOCX (Microsoft Word format) As with TextEdit, Scrivener ignores im- ages, 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. Only Leopard and greater supports .docx files. l ODT (Open Document Text) Supported by Leopard and greater, this open format is the primary format used by OpenOffice.org, but has broad support amongst many word processors.
- 109. 11.1. FILE IMPORT 101 l TXT (plain text) Note that Scrivener tries to import all plain text files using Uni- code 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 for- mat using TextEdit before importing it into Scrivener. If all else fails, use copy and paste. Files with the following extensions will be imported as text as well, .xml, .tex, .mmd, .md and .markdown. l FDX (Final Draft 8+ 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 File Import Import and Split... command to automatically split an FDX file into smaller documents, with the ability to select where splits occur. l FCF (Final Draft 5–7 File Converter Format) A special format for conveying scripts into and out of Final Draft. Use this format to import scripts into Scrivener if Final Draft 8 or greater is not available. As with FDX, can be used in conjunction with File Import Import and Split.... l OPML (Outline Processor Markup Language) Commonly exported from outlin- ing style applications, this format well let you transfer an outline tree from one application to another. Many applications will also save text notes attached to out- line nodes, and if Scrivener detects them, it will use this material in the main text editing area. This behaviour can be changed in the Import & Export preference tab (section B.10). By default, each top-level outline node will be imported into the binder with all of its children. To contain the entire import in a single folder, you’ll find an option in the aforementioned preference tab. l .indexcard (Index Card for iPad files) If you have no need for keeping Index Card and Scrivener synchronised (section 13.5), and just want to import some cards you’ve created, you can import an .indexcard file straight into the Binder. This will work in a fashion similar to OPML. It will create a sequence of matching cards for you based on the original cards in Index Card. This feature will not organise cards from “stacks” into folders. l No extension. Documents with no extension get imported into Scrivener as plain text files (note that this can often be a source of confusion - if you try to import an RTF or DOC file that has no extension, when you import it into Scrivener you will see all of the raw code because it will be imported as plain text. Make sure you add the appropriate extension before importing to ensure that Scrivener recognises it as an word processor file).
- 110. 102 CHAPTER 11. GATHERING MATERIAL 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 audio/visual formats (MOV, MPG, WAV, MP3 etc), PDF files, HTML, and .webarchive file types for importing saved web pages from Safari and other Mac applications that support it. Unsupported Formats on Snow Leopard and earlier: Any file type can be imported, even if it is not supported by Scrivener. Such files will appear in Scrivener’s editor as an icon with a link which, when clicked on, will open the file in the program associated with it. Or you can click on the Quick Look icon in Scrivener’s footer bar to view the file in a Quick Look panel. Unsupported files in the binder, while they cannot be viewed in a split or edited are otherwise fully capable of everything other media files are capable of. They can be organised, keyworded, annotated, and referenced. “Import supported file types only” must be disabled in the Import & Export preference tab. Unsupported formats on Lion and later: Most of the above still applies. The only difference will be that Quick Look data is loaded into the split view, instead of simply revealing an icon. If the selected item does not have any Quick Look data, then the icon view will be used instead. 11.1.2 Web Page This lets you enter the URL of a web page that you would like to import into Scrivener. The web page will be archived on import, meaning you will no longer need to be con- nected to the Internet to view it (you can convert it to a text file afterwards by using Documents Convert Web Archive to Text should you wish to edit the file). Web pages cannot be imported into the Draft (which only supports text), so you must ensure that a non-Draft item in the binder is selected for this item to be available, or change your preferences to import web pages as rich text files. Functional Web Pages: Many web pages these days are “functional” in that you can do things inside the web page after you load it. A good example of this is Gmail, GoogleDocs, or even a simple search form. These sorts of pages, if they require a login, will not import correctly. You will need to use copy and paste, or somehow export the material from the web site to your drive in order to archive them. 11.1.3 Linking to Research Material The default method for bringing research material into your project results in the original file being duplicated into your project. From there, it becomes a part of the project in every way. If you move the project to another computer, your research material will follow. There are a few downsides to this. One is when you need to continue refining
- 111. 11.1. FILE IMPORT 103 and editing these external resources. While this can be done from within Scrivener, by loading the file in an external editor—if you want these files to be up to date and available to other applications, fully importing them represents a compromise. Another downside is project size. While the project format itself is capable of great quantities of imported material, this can slow down the automatic backup routine, and will make creating your own backups less convenient, especially if the project contains many gigabytes of research material. The solution is to link to these items instead of importing them. The special menu command, File Import Research Files as Aliases, can be used to establish a link between the original file(s) and your project. Linked resources will be displayed with a small arrow in the lower-left corner of the icon, in Scrivener. If these files are renamed or moved, the link will adjust accordingly. However if you move the project to another computer, the research files will no longer function. The links will stay in place, and all meta-data or organisation you have assigned to them will remain, but the source of the file will be offline until you return to the primary computer where the link was established. This feature is only available for non-text research (PDF, multimedia, and web files). Due to technical limitations, it is not possible to link to a supported word processor file or plain-text document. 11.1.4 MultiMarkdown File This imports a MultiMarkdown text file into the project by splitting it into multiple files based on its structure, and recreating that structure in the binder. The Meta-data block will be inserted as the first document at the top level, which Compile will use as auxiliary meta-data on top of any Compile Meta-data settings for MultiMarkdown. Below that, each header found in the MMD file will be used to create a new document at an appropriate level of depth, with any text following that header up to the point of the next header included in that document. 11.1.5 Plain Text Formatted Screenplay When importing screenplays from Movie Magic Screenwriter, Celtx, and other programs that export plain-text scripts, you can use this import utility to have them converted into Scrivener’s script formatting automatically. You can optionally choose to have the imported file split into multiple scene documents for you. If you are working in Final Draft, you should use the FDX format instead, with the Import and Split utility, or FCF for a version of Final Draft prior to 8.
- 112. 104 CHAPTER 11. GATHERING MATERIAL 11.1.6 From Simpletext.ws If you use WriteRoom for the iPhone, or the SimpleText.ws service, you can login using this utility and select from your available note files online, choosing which ones to down- load into the binder. If you are using your own server to provide SimpleText services, you can use the Options... button to supply the proper connection information. Scrivener does not support uploading documents to SimpleText.ws, if you wish to use a note taking service that offers round-trip synchronisation, we recommend Simplenote (section 13.1) or one of the many mobile editors that can edit text files off of a Dropbox account. 11.1.7 Scrivener Project Allows you to import another Scrivener project. The files of the other project will be imported into a folder entitled “Imported Project” at the bottom of the binder, with the structure intact. Keywords and project references are also imported, and any project notes are imported as a text document which is placed at the top of the folder. This command can also be used to import—and therefore retrieve—corrupted projects. If you have a project that has somehow become corrupted so that it can no longer be opened in Scrivener, use File Import Scrivener Project... to have Scrivener do its best to re- trieve all the data. All the text, synopses and notes will be retrieved, along with snap- shots. The structure cannot be retrieved for corrupted projects, however, and folders will be imported as text documents (which you can convert back to folders using Docu- ments Convert to Folder. 11.1.8 Import and Split There are two modes for this tool: 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 sections. 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. 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.
- 113. 11.2. SCRIVENER SERVICES 105 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. 11.2 Scrivener Services Scrivener installs several services that aid in grabbing text from other applications and getting them straight into Scrivener without having to worry about manually opening Scrivener and then pasting in the text yourself. The Services menu is not found in the main menu bar, but in the Services submenu of the application menu (which will be named according to whichever application currently has the focus). In all cases, you will need text to be selected for the appropriate services to become available. In versions of OS X prior to Snow Leopard, the menu options will appear greyed out, but in all newer versions, they simply won’t appear until text is selected. 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 services. 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 if 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.2.5) 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 sepa- rating it from whatever content already existed. When using the formatted services, this title will be emboldened. The following methods are available: Append to Current Notes Targets active document split. Selected text will be appended to the active document’s Notes field, which may not appear to do anything unless you have the Inspector open. Append to Current Text Targets active document split. Selected text will be appended to the active document’s main text area. If the cur- rent document in Scrivener is not one that can hold text (for instance, if it is an im- age document), the Scrivener icon will bounce and Scrivener will display a warning
- 114. 106 CHAPTER 11. GATHERING MATERIAL panel telling you that you cannot append text to any open documents, and asking if you would like to create a new clipping for the text instead. Make New Clipping Targets active project. Creates a new text document in the active project in Scrivener from the selected text in the active application. Note that all new clippings are placed inside a “Clippings” folder which will appear right at the bottom of the binder. This service is slightly different from the above two in that the title you provide will be used to name the clipping document that is created in the binder. A default, date-based title will be provided in case you do not wish to bother with naming them individually. It is possible to adjust whether or not you are prompted for a title, or whether Scrivener comes to the foreground after using a Service, in the General preferences tab (section B.2). 11.3 Linking to Files on Your Computer It is possible to link to files, rather than import them directly into the project. In order to reduce confusion in the binder, linked items cannot be directly placed into the binder. They must be inserted into the references table for another item. A common tactic is to use the typical filing card system, whereby you create an index card describing the material, and then link to it and any other relevant files in its references. To read more about references, see References (subsection 18.4.2). 11.4 Scratch Pad Panel The scratch pad is a universal Scrivener tool that is not tied to any particular project. You can use it to jot down notes that don’t fit anywhere else or that arise whilst you are looking at another application. You can access it from the Window Show Scratch Pad menu ( – Enter), or you can right-click on the Scrivener icon in the Dock and select “Scratch Pad” (which will bring up the scratch pad over the currently active application). The scratchpad is a floating panel, which means that you can have it open over the main window (or in composition mode) while you work on other documents or even other applications. The top pane contains a list of all the note documents you currently have stored in the scratch pad. New notes can be added by clicking the + button in the lower-left, and notes you no longer need can be deleted with the delete button next to it. Deleted notes will be moved to the system trash, so if you make a mistake, you’ll find your notes by clicking on the trash can in the Dock.
- 115. 11.5. TEXT APPENDINGTOOLS 107 When projects are open, the Send to Project... sub-menu will provide you with a list of all opened projects. There are two ways of bringing notes into the project: 1. Append Text To: The contents of the selected note will be appended after any exist- ing 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 cannot be used since they cannot have text appended to them. 2. Import as Subdocument of: A new document will be created beneath the selected document. This sub-menu operates in a similar fashion to the above, 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 the 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 regular files that you can edit with other programs. You can even create your own rich text files in this directory, making it possible to add notes while Scrivener is closed. To change where notes are stored, use the General preferences tab (section B.2). 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 running for this to work. 11.5 Text Appending Tools Text selections can be easily appended to other texts within Scrivener, using two handy methods. Append Selection to Document This command is available in the contextual menu, when right-clicking on selected text. The command will provide a sub-menu pop- ulated with every item in the binder, prioritising any favourites to the top of the list. Best used when the target document is not visible, or you want to remain in the source document after the append action. Drag and Drop When working in the target document, and the source document is visible in the binder, it will often be easiest to simply click and drag the document 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 position will move to indicate the drop point.
- 116. 108 CHAPTER 11. GATHERING MATERIAL 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. 11.6 Print as PDF to Scrivener If the information you wish to import into Scrivener is locked in a format that cannot be used, a somewhat common way of capturing this information is to print the document from 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 work1 . 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. 1 If you bought the Mac App Store version, you’ll need to set this up yourself. To create a link to Scrivener in the PDF menu, add an alias to your ∼ Library PDF Services folder, from your installed copy of Scrivener (usually in the main Applications folder).
- 117. Chapter 12 Project Planning 12.1 The Corkboard The corkboard provides a familiar, visual way of viewing documents in your binder. You can arrange index cards in direct correlation with their order in the outline structure, or alternatively as a freeform corkboard where cards can be freely moved about without directly impacting the structure of the book. We will explore the various features in depth, shortly, but first let’s take a look at the index card itself. In Scrivener, every document you create is a document and an index card and a cork- board and an outline. This can be a little confusing at first, for in the real world, an index card clearly cannot also be a corkboard. In Scrivener, though, you can choose to view any document as a corkboard. Each index card on the corkboard represents a document held within the selected document in the binder that is represented by the corkboard itself. Another way of looking at it: the corkboard displays the subdocuments of the selected document as editable index cards. At the same time, the document displayed as a cork- board or outline is also an index card (which holds the synopsis of that document), and itself could also be viewed as an index card on a corkboard or a row in the outliner. If that is as clear as mud, then read on. 12.1.1 So What are Index Cards, Anyway? One of the issues that takes some adjustment to get used to is the relationship between index cards and the text of the book itself. You can type titles and text onto the card just like you would the real thing, but there is sometimes confusion as to why that text doesn’t get dropped into the book. So let’s take a look at what an index card really is. There are really seven different components to an index card, but depending on your preferences you might not see them all at once. 1. The document icon 2. The document location numeral (optional) 109
- 118. 110 CHAPTER 12. PROJECT PLANNING Figure 12.1: A fully loaded index card using the rounded card theme. 3. The title of the document 4. The synopsis of the document 5. The colour label (colour swatch in top-right corner; optional) 6. The status stamp (diagonal text stamped across the middle; optional) 7. Keywords indicators (swatches along the right; optional) Also, not shown in the diagram, it is possible to tint the colour of a card based on its label. This can be used in addition to, or instead of, the colour chip in the upper-right corner. To tint cards by label type, use View Use Label Color In Index Cards. At its most minimal, you’ll only see the icon, title, and synopsis, the three core ele- ments 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.
- 119. 12.1. THE CORKBOARD 111 The synopsis is meant to be a brief encapsulation of what the document’s purpose is, but 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 highly visible 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 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. 12.1.2 Linear Corkboard The standard, or linear, corkboard displays a linked representation of one level in your binder hierarchy. You can visualise this as a bit like looking at specimens on a slide. Each slide has a slice of a tree branch on it. To look at a different (whether deeper or higher) portion of the branch, you’ll need to load a different slide. The corkboard displays one layer at a time, and by clicking up and down in the hierarchy you can view different layers. In the linear corkboard, moving items around will change the actual order of those items in the binder. This makes it very useful for getting a “bird’s eye” view of a section of your book, and enables you to affect changes upon the ordering of that book with simple drag and drop. If you enable “drop-ons” in the Corkboard preferences tab (section B.4), you’ll also be able to add cards to other cards, just as you would drop items onto a folder. Many other appearance and behaviour settings can be adjusted in that tab. 12.1.3 Freeform Corkboard While freeform corkboards have the same “single layer” method of looking at your binder structure, they do not have a rigid linked relationship with it. You can move cards around freely and without any sort of grid constraints. To switch to freeform view, click the small “stack of cards” icon in the segmented control in the lower-right hand corner of the footer bar. Click the grid icon to its left to return to standard linear mode. You can freely switch between modes at will. Scrivener will store the position of your cards in freeform mode even if you switch back to linear for a while. The two modes remain discrete from one another, though they do share some preferences which you can read about in the following pages.
- 120. 112 CHAPTER 12. PROJECT PLANNING Figure 12.2: Corkboard options pane Commit Order Freeform mode can be useful for playing with an ordering idea without actually impact- ing 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 order back to the binder. Click the Commit Order button in the footer bar. 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 button, 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 enable View Corkboard Show Card Numbers. 12.1.4 Corkboard Options The Corkboard Options pop-up contains settings which are specific to each project. Changes made to this pane will only impact the active project they have been made in, let- ting you have two entirely different visual appearances for each major work. Any changes made will be saved with the project, meaning you can save your preferred defaults into a custom project template for future use.
- 121. 12.1. THE CORKBOARD 113 To access the pop-up, click on the “Corkboard Options” footer bar button, as shown (Figure 12.2). You can click anywhere on the corkboard to dismiss this pop-up pane. 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 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 distinct, 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 right side of the index card. When a document has more than that amount assigned 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 preferences tab (section B.4). 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.
- 122. 114 CHAPTER 12. PROJECT PLANNING Further Options: There are a number of other appearance related preferences that you can set, which can dramatically alter the look and feel of the corkboard. Most of these options are included in the Corkboard preference tab (section B.4), but a few colour related options are also in the Appearance tab (section B.3). 12.1.5 Stacked Corkboards When more than one container of any type has been selected, the corkboard will switch to a special stacking mode, displaying the contents of each container, separated by a line. By default, this will wrap each container’s section as though it were a normal corkboard; cards will be displayed according to your view settings. You can also select between vertical or horizontal stacking by clicking on one of the left two buttons in the segmented control, found on the right side of the footer bar, near the view options button. 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 reserving 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 appearance 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 count- ing from one for each container stack. When disabled, cards will be numbered sequen- tially even across container sections. 12.1.6 Placing Images on the Corkboard When working in an area of the project outside of the draft folder, it is possible to import graphics and other media into your binder. They will be supplied with special icons, indicating the type of file they are. Graphics will be represented with a small iconic image of a sunset photograph. When viewing a corkboard that contains graphics, they will be drawn on the cork- board as a photograph, rather than the typical index card. This behaviour can be changed in the Corkboard preferences tab (section B.4), if you prefer to see your summary synop- sis for the image instead. You may also change how any item at all in the corkboard is represented in a way which will always override the above preference. Even folders and standard text files can be represented by a photograph, or vice versa, photographs can be represented as index
- 123. 12.2. THE OUTLINER 115 cards. For further instructions on how to do this, read the Synopsis Card (section 18.1) overview in the chapter on the inspector. This will only change the items representation on a corkboard. The text synopsis will not be deleted, and can be edited using the outliner. The binder icon will not change. If your graphic files have text icons, this means they have been dragged into a text file, rather than imported directly. You can rectify this problem by dragging the image from the text file back into the binder. 12.2 The Outliner Outliner mode shows all of the descendants of the current document along with their associated meta-data in a tabular format like a spreadsheet. The default configuration will show the title and synopsis in the main column on the left. You can edit by double- clicking into the text field you wish to edit. Once editing, you can move between titles and synopses with the arrow keys, much like in an ordinary text editor or outliner. Press Enter to confirm your changes. 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. Conversely, 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. l 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 check- box. 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. However if you select a number of items first and Option-click on a checkbox, only those selected items will be modified. l 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. l Columns with editable text, such as the Title column and custom-meta data columns, will not provide a control, but you can simply double-click on the field to change their value.
- 124. 116 CHAPTER 12. PROJECT PLANNING 12.2.1 Managing Columns To add or remove columns from the display, click the small >>< span><span class="annotation" style="color:#4455E0">WIN:down arrow< span> button in the far-right column header bar<span class="annotation" style="color:#BA44E0">, use theView/Outliner Columns/‘ sub-menu, or just right-click in any of the column header names. Column settings are saved per editor split. So you can set up an outliner to perform a particular function on the left side of your screen, and display extended information on the right side, just to provide an example. To change the order in which the columns are displayed, drag and drop the column header to the desired location. You can resize the column width by moving your mouse between column header titles until the cursor changes to a double-pointed arrow, then click and drag to increase or decrease the width of the column. Title Column: these three options specify how the compound Title column should ap- pear. This column will be named “Title and Synopsis” when the “with Synopsis” column is checked. l Title – and Synopsis – with Icons Corresponding to the general meta-data: the first two columns allow you to edit the Label and Status of each row individually. The remaining three columns are read-only. Keywords will be underlined using the colour that has been assigned to that keyword. l Label l Status l Keywords l Created Date l Modified Date Statistics: the first two options show the word or character counts for each item in the outliner. The second set will not only show the statistics for that row, but will sum up all of the items descending from that row as well. A folder itself might have no words in it, but if it contains five text files with 1,000 words each, the folder’s row will display 5,000 in the Total Word Count column.
- 125. 12.2. THE OUTLINER 117 The word count columns will colour the text according to your progress bar colours. So if you prefer to not turn on the progress bars (discussed below), you can still get a rough idea of how far you are form your goal, based on the colour of the text. l Word Count l Character Count l Total Word Count l Total Character Count Further options from general meta-data: the checkboxes displayed in these columns are directly linked to their respective options in the Inspector, general meta-data section. l Include in Compile l Page Break Before l Compile As-Is Targets and progress tracking: as with statistics, these who target tracking information for each item in the outliner, and the variants which use totals will add up the combined statistics for all descendants as well. If a folder has five text documents, each with a goal of 1,000 words, the Total Target column will display 5,000. If the sum total of all words in the descending documents is 2,500, the Total Progress tracking bar will be filled to 50%. l Target l Target Type l Progress l Total Target l Total Progress Any custom meta-data fields you have created will be listed at the bottom of the menu as well.
- 126. 118 CHAPTER 12. PROJECT PLANNING 12.2.2 Special Columns In addition to the standard columns, there are two choices which impact the main Title column. They are indented beneath the Title option in the column menu. l and Synopsis: embeds the text of the index card synopsis field beneath the title. With this option enabled, the title will be emboldened and you can edit both Title and Synopsis together right in the outliner. The Show (Hide) Synopsis button in the footer bar provides a shortcut to turning this special column on or off. l with Icons: When disabled, item icons will be removed from the outliner display, producing a cleaner, more “text like” appearance. The Title (and Synopsis) column is also special not only in that it provides compound information, but if it is the only column present, it will automatically fill the entire width of the outliner. 12.2.3 Sorting by Columns To sort by columns, click on the column header. The first click will sort ascending, clicking again will sort descending, and a third click will turn off sorting. This form of sorting is “virtual”. It will not impact the actual order of the items in the binder, so you can safely use it in conjunction with other methods of gathering items or viewing them, without fear of disrupting your book structure. However, if you wish to change the underlying Binder order to match the custom sort you’ve set up, you can do so by selecting all of the outliner rows and dragging them back into the folder they reside in, in the Binder. When items are dragged into the Binder, their order is remembered, so as long as the sorted items come from the same folder, dragging them back to that folder will re-order them in according with their visible order in the Outliner (or Corkboard, for that matter) view. Due to how this works, it can not be used to re-order many items within sub-folders at once. You’ll need to re-order each folder individually. In the case of the Title (and Synopsis) column, sorting will be performed by binder title, not the synopsis content. 12.3 Project Notes As your project begins to take shape, you will no doubt have many ideas that you wish to capture, but nowhere concrete to put them yet. Documents all have a separate note pane which can be accessed in the inspector, but if you don’t even have a stable outline built yet, there are no documents to put notes within. There are a number of ways you could
- 127. 12.3. PROJECT NOTES 119 approach this problem, such as keeping notes as documents in the Research folder or somewhere else outside of the Draft, or even in the Draft with their respective “Include in Compile” flags disabled. You might also find the Project Notes tool to be useful, as it is accessible from every- where in the interface. 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 Appearance preferences tab (section B.3). 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 compile op- tions, 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. For a simple example, open the inspector (click the blue ‘i’ button in the toolbar, or press – I) and try clicking on anything in the binder that isn’t a document. A good example of that is the Draft folder. The inspector will be replaced by a single pane titled “Project Notes” (if that didn’t happen, you might be viewing one of the index cards in the corkboard that pops up. Just click once in the background of the corkboard to de- select any cards.) Type in a sample line here so we can track it around the interface as we explore this feature. This field is not only accessible from the Draft, but any document can view the project notes in their inspector as well. Try clicking on one of those index cards in the Draft corkboard and make sure the left-most button in the bottom of the inspector is clicked (the one that looks like a little notepad). By default, this will show you the document notes for that selected card. You can click on the header bar where it says “Document Notes” and select “Project Notes” instead. The sample line that you typed in above will become visible. You can easily flip between notes with – 6 while the inspector is open. You can see how accessible project notes are. Even when viewing nothing at all they are visible, and they can always be selected when viewing anything in the binder, even a movie. There is another way to view project notes as well, and this will also allow you to maintain multiple notepads. We’ll see how to access those in the rest of the interface after we create a few. To view the project notepad, invoke the Window Project Notes
- 128. 120 CHAPTER 12. PROJECT PLANNING menu command, or press – P. By default, this will look like a pad of ruled paper. This can be adjusted in the Appearances preference tab. 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). 12.3.1 Creating New Project Notepads Along the top of the Project Notes window, you’ll see a tab labelled “General” and on the right-hand side, a + button. Click that to create a new tab. Now you have two project notebooks. These are completely independent from one another, and so can be used to store different types of notes. To rename a tab, double click on it. Tabs can also be re-ordered by clicking and drag- ging on them. 12.3.2 Using Multiple Notepads in Inspector Now that you have multiple notepads, you’ll probably want access to them in the inspec- tor as well. Navigating back to a document, click on the notes header again and you’ll see the new items you created are available for selection. You can, as before, use – 6 to flip between them all, and now – 6 is also available to rotate backward through the list. Both of these commands wrap around the list so if you get to the top or bottom they will keep going in the same direction in an endless cycle. 12.4 Custom Icons If you wish to customise the appearance of your binder, it is easy to do so with custom icons. All items can be modified, even the three “core” folders: Draft, Research, and Trash. Scrivener comes with many icons right out of the box. To see what is available, simply click on the item you wish to customise in the binder, corkboard, or outliner, and view the Documents Change Icon sub-menu. To reset an icon to its binder default, select Documents Change Icon Reset Icon to Default. You can also set the icon of the document you are currently editing. When using scrivenings, this will only impact the document that your cursor is within. 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 Documents menu. If you anticipate using a particular icon frequently, you might wish to make a docu- ment template (subsection 8.4.3) for it, so that you do not have to constantly re-apply icons to new files or folders.
- 129. 12.4. CUSTOM ICONS 121 12.4.1 Creating and Managing Custom Icons It is easy to make your own icons, even if you do not know how to edit images in a graphics program. Load up the icon manager with Documents Change Icon Manage Icons... and click the + button in the lower table, under “Icons in Application Support” (we’ll explain what that means in the next section). Find the graphics file you wish to convert to an icon on your disk with the file chooser, and click the Open button. If the graphics file was larger than 16x16 pixels, Scrivener will automatically resize it for you. 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 obvious in the icon browser, but will look bad in the binder. Removing a white background 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: 1. Select a file in the Finder that has this icon. 2. Press – I to get info on that file. 3. Click once in the small icon in the upper-left corner. You will see a halo surround it when it is properly selected. 4. Press – C to copy the icon. 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 from in the sidebar, select the small- est available option (Scrivener’s icons are only 16x16 pixels, so choosing a large icon will actually result in less quality). 7. Press – C once again to copy the single icon choice; and then –N to create an- other new document from the clipboard.
- 130. 122 CHAPTER 12. PROJECT PLANNING 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 Pack- age” 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 Support 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. 12.4.2 Custom Icon Portability The final thing to consider is whether or not icons will be visible off of your computer. If you’ve been adding icons to “Application Support” all along, if you take your project file to another computer, when you load it all of those icons will disappear. They will still be assigned, but since Scrivener cannot locate any replacement icons, they will simply be ignored until you return to the original computer. So when working on multiple computers, it is good idea to drag your Application Sup- port list into the Project Package list. This way your icons will be available wherever you go, and once you are on the second computer, you can drag them back into its Applica- tion Support list, installing them on that computer as well. Now you will no longer need to put them in the Project Package list for them to appear on both systems. When collaborating with other individuals, it is a good idea to install custom icons into the project package. This way everyone can see and use them.
- 131. Chapter 13 Cloud Integration and Sharing It is becoming increasingly important to have the ability to make your work instantly available everywhere you go, no matter what device you might currently be using. Shar- ing files amongst a circle of colleagues, proofers, and editors is also becoming common. In conjunction with the Simplenote1 network, you can distribute copies of text items from your binder to your note network, and access them from anywhere using portable devices or other Simplenote-aware applications. In addition, a generalised tool using sim- ple files and folders has been provided, which can be integrated with file sharing services such as Dropbox2 , which can in turn be accessed by numerous text editing applications on mobile platforms. Synchronisation should always be done with care, no matter what method you use. Computers will do exactly what we tell them to do, even if the outcome is not what our original intention was. Whenever using automated syncing tools, be sure to double-check your settings, and backup frequently. Scrivener uses automatic Snapshots to protect your work by default. This can mean a lot of automated Snapshots may build up over time, but given the unpredictability of all the many factors involved, it’s generally a good idea to leave it turned on. 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. 1 http://simplenoteapp.com/ 2 http://www.dropbox.com 123
- 132. 124 CHAPTER 13. CLOUD INTEGRATION AND SHARING 13.1.1 How It Works Simplenote is a general purpose note-taking system and knows nothing of Scrivener or Scrivener projects. When uploading documents to Simplenote, Scrivener therefore places some information on the first line so that it is able to find and recognise these documents again later, when you want to sync them. The information Scrivener places on the first line is formatted like this: MyDocumentName (MyProjectKeyword [ID]) -- “MyDocumentName” represents the document title as it appears in the binder, “MyProjectKeyword” is the keyword you assign to the project in this wizard (see be- low), and “ID” is an internal numerical ID that Scrivener assigns to all documents, which you won’t normally see. In practice, it might look like this: The Grand Finale (MyGreatNovel [756]) -- These three pieces of information in combination allow Scrivener to sync documents with Simplenote. You should therefore not edit this line in Simplenote. In particular, if you edit the project keyword or numerical ID, Scrivener may not recognise the Sim- plenote text as belonging to the current project, or worse, it may try to sync it with the wrong document in Scrivener. It is thus generally recommended that you leave this line alone. However, you can edit only the document title (the part before the parentheses), which will update the title in Scrivener when synced, if you really want to. 13.1.2 Getting Started Login details The Simplenote Sync wizard will first prompt you to enter your login details. Enter the e-mail address and password which you used to register for Sim- plenote. You can check “Remember in keychain” to have your login details remem- bered for the future. 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 remember, and that is unlikely to occur on the first line of documents in general. For instance,
- 133. 13.1. SIMPLENOTE 125 Figure 13.1: Simplenote Sync: Configuration you might use a wordsJammedTogether version of your project title, such as “My- GreatNovel”. Do not use (parentheses) or [square brackets] as part of your keyword. Since these are used by Scrivener to identify the salient portions of the note’s identification, adding additional brackets into the token can cause the sync to malfunction. NOTE: It is important to understand that Scrivener has no way of knowing which doc- uments in Simplenote are associated with which Scrivener project without this keyword, so it is up to you to choose a unique keyword for each project. If two 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
- 134. 126 CHAPTER 13. CLOUD INTEGRATION AND SHARING Figure 13.2: Simplenote Sync: Step One 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 de- tails next time you sync the project with Simplenote, but if you need to change 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. 13.1.3 Step 1: Synchronizing Existing Documents You will next be asked to choose which documents in the project you wish to sync with Simplenote. You can choose to sync all documents in the current project or to specify individual documents. It is generally recommended that you don’t sync all documents in a project, because this can clutter up Simplenote and severely slow down synchroni- sations. Because Simplenote notes are stored on the cloud (that is, online), Scrivener has
- 135. 13.1. SIMPLENOTE 127 to download them into memory every time you sync, so the more notes you have in Simplenote, the longer the sync process will take. If you choose to identify the documents you wish to sync (as recommended), you are presented with separate lists for documents contained in the Draft folder and all other text documents in the project (Simplenote is text-only so you can only choose text docu- ments). You should go through and tick the documents you wish to upload to Simplenote for editing while on the go. All documents that have already been uploaded and exist in Simplenote will be ticked for syncing automatically. The icons (Table 13.1) next to the document titles will tell you what will happen when you choose to sync. Table 13.1: Simplenote Status Icons Icon Meaning Green check The document is up to date both in the project and on the Sim- plenote servers—the version in the project is the same as the ver- sion 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 uploaded. Red asterisk The document needs updating in Scrivener. This red asterisk appears if you choose (by deselecting) not to sync a document that has a newer version available on the Simplenote 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 following options are available. Take snapshots of affected documents before updating When ticked, Scrivener will take a snapshot of documents being updated before overwriting them with the
- 136. 128 CHAPTER 13. CLOUD INTEGRATION AND SHARING Figure 13.3: Simplenote Sync: Step two 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 protection 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.
- 137. 13.1. SIMPLENOTE 129 13.1.4 Step 2: Importing Documents From Simplenote The final part of the wizard allows you to choose to import documents that exist in Simplenote but which do not yet have corresponding files in the project. Given that 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) -- (The two hyphens on the second line are optional.) Note that there is no numerical ID in square brackets in this case because that is some- thing only Scrivener can assign (and when you sync these documents, Scrivener will indeed add a numerical ID). Do not try to guess and assign your own. The documents in this first list are usually all ticked by default. The exception are documents that Scrivener thinks might have been deleted from the project but are still on the server—such docu- ments 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 document ID in square brack- ets, 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. You can use this list to assign notes to the project, if the “Assign imported notes to project” option is checked, below the list. If you do not assign them, they will be imported but the original note will not be set up to sync with Scrivener in the future. Additionally, you can enable “Show notes from other projects” to see items which are already assigned to other Scrivener projects that are syncing with Simplenote. 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 Re-
- 138. 130 CHAPTER 13. CLOUD INTEGRATION AND SHARING search folder is used by default). Only show containers in destination list limits the documents shown in the list to containers (folders are always considered con- tainers, even if empty); 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.) Remove blank lines between paragraphs in imported notes Allows you to choose whether or not empty lines should be removed in imported documents: because Simplenote is plain text, it is common to separate paragraphs using empty lines, but in Scrivener paragraphs are less likely to need blank lines between them. (Note that when uploading documents to Simplenote, Scrivener automatically places blank line padding between paragraphs to make them easier to read in Simplenote.) 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 synchronisation and import, click on Sync. You can choose Go Back at any point to make changes. 13.1.5 Using Simplenote Tags When syncing files, Scrivener will assign two tags to each file: 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. Another way of assigning notes to a project is to use the “Other notes” browser, in Step 2, to find the note, tick its checkbox, and then also the “Assign imported notes to project” checkbox, below this list.
- 139. 13.1. SIMPLENOTE 131 13.1.6 Clearing Out Simplenote When you’ve reached a point in your project where you no longer require external sync- ing, or would for any other reason like to clear off everything belonging to your project, it is very easy to remove everything from the server pertaining to the project. 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. 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 updat- ing documents in a project with corresponding versions that have been edited in Simplenote, the following formatting limitations apply. l Scrivener maintains the formatting of paragraphs within a note that have not been changed. l Any paragraphs that have been edited in Simplenote will lose their formatting in Scrivener. l Images will be stripped from documents that have been edited in Simplenote. l To avoid having inline notation become confused with standard text, Scrivener will export inline annotations by wrapping them in double- parentheses (( and )). Inline footnotes will be similarly wrapped in curly braces {{ and }}. These work in both directions. If you type them into a paragraph using your text editor, they will be converted to their respective type of notation upon syncing. l Inspector comments and footnotes will not be exported. If the retention of this information is important to you, it is recommended you use inline no- tation with plain-text. You can easily convert your notes to inline with the Format Convert tools. Number of Notes At the time of writing, Simplenote is limited to syncing 2,000 notes a day. Although this sounds a lot, if you end up syncing the entire contents of ten
- 140. 132 CHAPTER 13. CLOUD INTEGRATION AND SHARING projects that contain 200 text documents, you can soon end up with a lot of notes in your Simplenote account. It is therefore strongly recommended that you only sync the documents you need for working on while away from Scrivener, and that you ensure the option is ticked to trim documents that are not being synced. This will also help ensure that syncing remains as fast as possible. 13.2 Synchronised Folders Scrivener lets you prepare a special external folder on your disk, which it will use to keep the text contents of a project up to date if (but not when) changes are made to the contents of this folder. Because it works with simple flat list of files and a few built-in folders, the format is uniquely suited for integrating with various folder sharing services such as Dropbox, SugarSync, MobileMe, and others. Using this feature, you can share your work in progress with collaborators, agents, or editors, and later read back any changes they have made directly into your project. Additionally, you could use the feature in conjunction with mobile applications which are aware of Dropbox, making it possible to edit your project’s content on an iPad or iPhone, and later merge those edits with your main project. 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 platforms, 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. 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, 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:
- 141. 13.2. SYNCHRONISED FOLDERS 133 Figure 13.4: Sync External Folder Sheet
- 142. 134 CHAPTER 13. CLOUD INTEGRATION AND SHARING l “Draft” - stores documents contained inside Scrivener’s Draft folder. l “Notes” - stores text documents contained elsewhere in the project. l “Trashed Files” - stores documents that had been synced but have since been re- moved from Scrivener, or which had some sort of conflict. You should occasionally review these files and trash them if they are no longer required. It is not possible select a folder which has already been used to synchronise an- other Scrivener project! In this case, another project can very well mean the same exact project you just copied to another computer. This will most often be an issue when you use the project on more than one computer, and your account name on those computers are different. When working in situations such as these, it is best to turn off automatic sync on project open and close, and run it manually from your primary computer. There is never a reason to use this feature to keep two copies of the same project up to date. If you need to work on your project from more than one machine, it is best to copy the project completely. The reason for prohibiting this is that even when working from the same exact project, it is all too easy to cause problems between copies of the project, which will inevitably differ over time, internally. 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. Saving changes without syncing: If you merely want to adjust your sync settings (commonly to enable or disable automatic checking on project open and close), you can hold down the Option key in the set-up window to change the Sync button to a Save button. Clicking this will update your project settings without running sync. 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
- 143. 13.2. SYNCHRONISED FOLDERS 135 documents that are contained in the Draft folder and in the specified collection will be synced. Prefix file names with numbers 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. Take snapshots of affected documents before updating Enabled by default. With this option turned on, Scrivener will automatically generate snapshots of each docu- ment if it requires updating. If you prefer to handle snapshots manually, you may want to turn this off. However be aware that leaving it on is the safest option, par- ticularly 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 external folder on project open and automatically sync on close Enabled by default. When this project is opened, it will briefly scan the contents of the ex- ternal sync folder and alert you if there are any changes detected, offering you the ability to update your project immediately. When closing, the same check will be performed. This option will ensure that the sync folder and the project remain up to date, though they will differ while editing, until you run sync again. 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 in destination list” 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. For instance, scriptwriters might not want to use a script format for notes and research doc- uments, so 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: l Rich Text (RTF) This provides the cleanest transfer of information. Most formatting 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 access
- 144. 136 CHAPTER 13. CLOUD INTEGRATION AND SHARING to Scrivener, or for working in a multi-platform setting yourself. All versions of Microsoft Word fully support the RTF format. l Plain text (TXT)Formatting will be stripped from edited portions when using this option. The resulting files will be standard, plain-text files in the UTF-8 for- mat. If they are edited outside of Scrivener, when synced back in, all custom for- matting 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 for- matting 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. l Final Draft (FDX) Those working with Final Draft 8+ and scriptwriting mode should use this setting, as it will retain all special script formatting in a round-trip. Automatically convert plain text paragraph spacing When this option is engaged, Scrivener will intelligently convert your documents’ paragraph spacing to better 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 carriage 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 and write 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 Mul- tiMarkdown 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. When using plain-text, inline annotations and footnotes (chapter 17) will be scanned for within the external files, and any text matching the following patterns will be con- verted to the corresponding notation style. Using this feature, you can round-trip your notes, and even create new notes in an external editor. Annotations will use double- parentheses, and footnotes will use double-curly-braces. Additional settings which impact export and import can be found in the application preferences, under Import & Export. If you prefer to work with inline annotations and
- 145. 13.2. SYNCHRONISED FOLDERS 137 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 doc- umentation on this pane, see Import & Export Preferences (section B.10). 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. Using the sync folders as an inbox: In addition to creating files for material that already exist in your Binder, you can use this feature to collect notes while you are away from Scrivener. If you intend to use this feature only as an inbox, that is, for collecting new notes and not working with existing material, you can set up sync to use an empty collection. The empty Drafts and Notes folders will be created for you if their respective checkboxes are ticked. Any files you create in this folder will be imported into the project in the future, and will be available for further sync unless you explicitly remove them from the Collection filter. In a collaboration environment, it may not be possible to wait until the other person 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 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 pre- sented to you upon completion. The list will not contain items which have only changed
- 146. 138 CHAPTER 13. CLOUD INTEGRATION AND SHARING 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 cre- ated and titled “Updated Documents”, with each changed project document added to it. Every time sync needs to change project files, it will look for a Collection named “Up- dated 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. 13.2.3 Tips for Working with Synced Folders Here are a few guidelines which, if followed, will prevent problems in everyday use: l 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. l 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 best, and a loss of data at 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.
- 147. 13.2. SYNCHRONISED FOLDERS 139 l Disable automatic sync on open and close before duplicating the project in Finder. If you create a duplicate from within Scrivener (using the back up features, or File Save As...), you do not need to worry about this as Scrivener will clean up any automated settings for you. However if you intend to duplicate the project outside of Scrivener using Finder, make sure to disable this option first, otherwise they will both end up using the same folder automatically, and this can lead to man- gling your project if you continue working in both projects. Once you’ve created the duplicate, it is safe to turn it back on in the original project, provided you either leave automatic syncing off in the new project, or point it at another folder. l 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. l 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 . l 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. l If using mixed inspector comments and inline annotations: When using sync folders, it is best to use either all Inspector footnotes and comments, or all inline anno- tations and footnotes, and set your Import & Export preferences accordingly. 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. 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.
- 148. 140 CHAPTER 13. CLOUD INTEGRATION AND SHARING Dropbox and iOS: When using the Dropbox app 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 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 connection. 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. l If you use sequential annotations separated only by colour, it would be a good idea to move them so that they have a word or two in between them, or separate them by putting them on different lines. l Expect loss of some features when using RTF editors that do not fully support the RTF specifications, such as TextEdit, Pages and similar. Footnotes, comments, lists, images, and tables are the most common items which have limited to no 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. Plain-text Limitations: Since it is impossible to convey formatting in plain-text with- out some sort of visible mark-up, Scrivener takes steps to protect as much of your for- matting as it possibly can. As with RTF, only those files which have been edited will be transferred back to your project, but further, each changed file will be analysed at the paragraph level and only replace those paragraphs that have been changed, leaving the rest of the file untouched with its original formatting.
- 149. 13.3. WHICH TOUSE? 141 l To avoid having inline notation become confused with standard text, Scrivener will export inline annotations by wrapping them in double-parentheses (( and )). Inline footnotes will be similarly wrapped in curly braces {{ and }}. These work in both directions. If you type them into a paragraph using your text editor, they will be converted to their respective type of notation upon syncing. l 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. l Embedded images will be stripped from documents that have been edited outside of Scrivener. 13.2.5 Disabling Synchronisation If you no longer need to maintain an external sync folder, you can shut off this feature by removing the sync folder from your drive, moving it to another location, or changing its name. When loading the project, if Scrivener detects that the sync folder no longer exists as originally defined, it will shut off any synchronisation features in the project. 13.3 Which to Use? If you have no investment in either Dropbox or Simplenote, you might be wondering which is the best to use. Simplenote is designed to be an easy way to work with note files. When you load the app on your mobile device, it automatically hooks into the central Simplenote server if possible, so as you work your changes are saved globally and all of your other devices are updated with the new notes and text. Consequently, Simplenote is very easy to use. There is no configuration you have to do, you simply download their free app from the App Store and start working with the scenes you sent out for sync from Scrivener. If you are looking for a quick and painless way to edit your manuscript on the go or easily add thoughts and ideas to your projects, then Simplenote is an excellent way of doing so. Another advantage to Simplenote is that it uses a central server instead of your hard drive. This can be particularly important if you use more than one computer, and not all of your computers have the same log in name. Syncing with an external folder requires the names of places to be the same no matter what you computer you are on—and this can be impossible in some cases without complicated work-arounds. Simplenote doesn’t care if your user name is one thing or another, so it will always work wherever you go.
- 150. 142 CHAPTER 13. CLOUD INTEGRATION AND SHARING While much has been stressed over the simplicity of Simplenote, this should not imply that Dropbox is complicated to use. It is, especially considering what it is capable of doing, very straight-forward and useful within minutes of installation. There is much you can do with Dropbox, and most of these topics would be out of scope for this manual. Specifically in terms of Scrivener, using a sync folder with Dropbox gives you extra power because you have more control over what you use to edit the files. Unlike Simplenote, everything is stored as simple text files on the hard drive of every computer or mobile device you install Dropbox on. That means you can access them just as you would any file on your computer, with any program you like. If you need to do more than one thing with your manuscript, outside of Scrivener; if you like to choose the apps you use to edit text; if you want to keep all of your external notes easily accessible as ordinary files, then Dropbox might be your best bet. 13.4 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 environment. The feature can be found in the File Import From SimpleText.wsmenu item (subsec- tion 11.1.6). 13.5 Index Card for iPad Index Card for the iPad is a corkboard and outlining app that was partly inspired by Scrivener. It allows you to create projects comprising index cards (each of which holds a title, synopsis, and main text, just like Scrivener’s index cards) which can be moved around and edited on a virtual corkboard, or in a list view resembling Scrivener’s out- liner. It is therefore an ideal companion application, and using Scrivener’s “Sync with Index Card for iPad” feature you can package up parts of your Scrivener project for edit- ing and restructuring in Index Card on the iPad. The synchronisation process involves creating a collection in Scrivener, saving it as an .indexcard file that can be read by Index Card on the iPad, and later updating the collection in Scrivener from the updated .indexcard file written out by Index Card after you have made changes on the iPad. There are therefore four steps involved in syncing with Index Card: 1. Creating a Collection to hold the documents to sync. 4 http://www.simpletext.ws/
- 151. 13.5. INDEX CARDFOR IPAD 143 2. Saving an .indexcard file to your Dropbox folder. 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 iPad. (Drop- box 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. 13.5.1 Creating a Collection Index Card projects consist of a single stack of index cards that can be moved around on a corkboard. Because Index Card expects a flat list of cards, it is not possible to sync the entire structure of a Scrivener project, or even all of the contents of the Draft folder, which will most likely contain documents inside folders several levels deep. For this reason, the Collections feature is used to sync with Index Card. The Collec- tions feature allows you to maintain different flat lists of any documents in the project, which can be ordered however you wish. You should thus create a collection before you sync with Index Card. After editing your project in Index Card, you can easily assign your new arrangement of documents to the binder. To create a collection, first select the documents you wish to take to Index Card in the binder. Next, click on the “Collections” icon in the toolbar to reveal the collections pane if it is not already visible (or select View Collections Show Collections). Finally, click on the + button in the collections header bar. A new collection will be created that contains the documents you had selected. You can rename the collection to anything you like, but something meaningful such as “Index Card Sync” might be a good idea. (You can change the colour of the collection by double- clicking on the colour chip in its tab when the collection is active.) Adding Whole Folders To Collections: If you wish to include the contents of an entire folder in the collection, select the folder and hold down the Option key down while clicking on the “Add Collection” button. 5 http://www.getdropbox.com 6 http://www.denvog.com/iphone/IndexCard
- 152. 144 CHAPTER 13. CLOUD INTEGRATION AND SHARING 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.3) for more information on collections. 13.5.2 Saving the Index Card File to Dropbox We have now set up a collection ready for syncing with Index Card. The next step is to create a file in our Dropbox folder that Index Card will be able to read. To do so, use File Sync with Index Card for iPad... Choose the collection you created in the first step from the “Collection” pop-up but- ton. There are three options you can select from: Sync main text with Index Card notes This feature only works with newer version of Index Card, which support adding notes to index cards, as well as synopsis. With this option, Scrivener will store the main text of your draft for that section into the notes for the card. This way you can not only see your cards and work with them, you can edit their contents too. Do take notice that by default Index Card will not include notes in an exported .indexcard file. If that option is left off, no changes you make on the iPad to the main text will be made to the project. Take snapshot before updating main text As with the other synchronisation tools, leaving this option on will automatically create a snapshot of the item prior to changing its text contents, providing an extra layer of safety. Convert plain text paragraph spacing If you have formatted your paragraphs with sin- gle breaks between them, this will optimise paragraph spacing to look good in a plain text file (which Index Card needs for the notes field). Likewise, paragraphs will be converted back to single breaks when updating the main text. This option is not necessary (and indeed would be undesirable in most cases) if the source .scriv project already uses double-breaks between paragraphs. Once you have everything set up, click on Create or Update Index Card File.... The “Save As” panel will appear, and it should automatically point to the “IndexCard” folder inside your Dropbox folder. Index Card creates the “IndexCard” subfolder 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).
- 153. 13.5. INDEX CARDFOR IPAD 145 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. 13.5.3 Editing the File in Index Card on the iPad To open the .indexcard file on your iPad, ensure that you have both Dropbox and Index Card installed, and then follow these instructions: 1. Open the Dropbox app on your iPad. 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. 13.5.4 Updating the Collection in Scrivener When you get back to your computer, you’ll want to update your Scrivener project with the changes you have made in Index Card. To do this, you’ll first need to update the .indexcard file in the Dropbox/IndexCard folder, as follows: 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. 2. If you are syncing main text as Index Card notes, then make sure the “Include Notes in Export” option is enabled at this stage, otherwise your text changes will not be included.
- 154. 146 CHAPTER 13. CLOUD INTEGRATION AND SHARING 3. 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. 4. 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. 5. This time, choose “Update Collection from Index Card File. . . ”, because we want to update our project with the changes we made in Index Card. 6. 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”. The collection in your Scrivener project should immediately be updated to reflect the changes you made on your iPad—the order will be changed if you moved things around, the titles and synopses of any documents you edited will be updated, and any new index cards you created will appear as new documents in the collection. (When you return to the binder, you will find any new documents that were created have been placed in a folder below the Research folder, which will be named using the title of the collection followed by “Unsorted” in parentheses.) Note that if you deleted any index cards in Index Card on the iPad, they will be removed from the collection in Scrivener but will not be deleted from the binder. Committing Rearrangements to the Binder Collections exist in parallel to the binder, allowing you to gather disparate documents from all over the binder in arbitrary lists in any order you wish. If you’ve spent a lot of time in Index Card on the iPad rearranging the cards and finding their most effective order, at some point you will want to take that arrangement to the binder rather than having it sectioned off in a collection. This is easy to do, and there are several ways of doing it. Here are the easiest: With the collection visible, select all of the documents in the collection list. Then, either: l Ctrl-click on the selection, select Move To from the contextual menu that appears, 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. l 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.
- 155. 13.6. SCRIVENER EVERYWHERE 147 Note that in both cases, the collection remains unaffected, and continues to exist sepa- rately. 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 process again, overwriting the old .indexcard file with one generated from your updated collec- tion. Syncing Multiple Collections: It is possible to sync more than one collection in a project with Index Card—each collection will appear in Index Card as a separate project. However, bear in mind that if any documents appear in more than one col- lection, any edits you make to them in one Index Card project could get overridden were you to later sync with an Index Card project created from another collection that contains some of the same documents. 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. 13.6 Scrivener Everywhere All of the methods discussed so far have worked on the assumption that you only need to work on a specific aspect of your project when away from home, but many people prefer to work in several places, and like to use a second computer like a laptop. Many others would prefer to have total editorial control of the likes only Scrivener can provide, rather than simply working with content or high-level organisation in an index card style application. Keeping more than one computer synchronised can be a lot of work, but keeping one Dropbox folder synchronised between computers requires no thought at all. It therefore follows that placing your Scrivener project into a Dropbox folder so that it is immediately available to every computer you own, would seem a perfectly natural pro- gression. What you should be cautious of, when entertaining this idea, is that a Scrivener project is comprised of many smaller files, and that they all need to be working together as a cohesive whole. Ordinarily, this is not a problem. Nothing goes into your project and messes with it, except for Scrivener. When you place a project on Dropbox, however, you are giving Dropbox permission to scrutinise and curate the individual pieces of your project that ordinarily only Scrivener messes with. This goes for other synchronisation technologies in general. By and large, this is safe to do. Dropbox is designed to carefully make sure each com- puter has a thorough and exact replicate of what all your other computers have. However, a problem can arise when one computer edits your project in a way which conflicts with the copies on the other computers. This can be easy to accidentally do. All it takes is
- 156. 148 CHAPTER 13. CLOUD INTEGRATION AND SHARING working on a copy of a project that is not yet fully synced. This might happen because your computer has been offline for a while, or because Dropbox never got a chance to fully update all of the files in the project. When this happens, copies of each “conflicted” file will be duplicated with different names so that you can decide which one is the best copy, or manually merge them to- gether in a text editor. Ordinarily, this is fine and easy to do, but inside of a Scrivener project, it can be more complicated. For one thing, the full contents of your project might not even be easily visible. Secondly, some of the files in a project are very technical in nature, and if you are not fluent in XML, it might be impossible to best decide which version is better. The solution is to never get into this position in the first place, and this is fortunately easy to do. To avoid conflicts with synced projects: 1. Always make sure your syncing software is done syncing before you open a project. Good syncing software, like Dropbox, will let you know when it is moving data to or from the central server on the Internet. In the case of Dropbox, a small icon will be placed into the status menu bar area, in the top-right portion of your screen across from where the main menus are. Keep an eye on this indicator and wait for the green checkmark7 to appear before you open the project. 2. Never open a project more than once. If all goes well, Scrivener will warn you if you try to do this, but in some scenarios this warning might fail, so try to always remember to close your project when you are done with it. 3. Always wait for your syncing software to finish syncing before you shut down your computer. This is of course a corollary to the first rule. Just as you should wait for your computer to be updated before opening a project, you need to make sure that all of your changes made to the project have finished syncing back to the server (and thus made available to your other computers), before you put it to sleep or shut it down. If you follow these three simple rules, you will dramatically decrease the chance of any strange conflicts arising due to working in a live syncing folder with Scrivener. As with all synchronisation technology, it is inherently “less safe” than working local and saving remote. It is possible to work safely for years in this fashion, but extra vigilance will be required of you. 7 It is possible to customise the status icon, and not all of the visual themes use a green checkbox to indicate when Dropbox is in standby mode. Familiarise yourself with how your preferred status icon works.
- 157. 13.6. SCRIVENER EVERYWHERE 149 While this section has primarily focussed on Dropbox as a means for keeping your project files synchronised between computers. There are many technologies for doing so these days. If you have another solution you are using and prefer, test its viability with copies of your project prior to committing important work to it. A note on using such sharing services for collaboration: while it is possible for multiple parties to work off of a single .scriv file hosted on a shared network folder, extra caution will need to be exercised in order to keep the project data safe. At the very least, this section of the manual should be distributed to all parties concerned, and good lines of communication should be established so that everyone knows when a person is actively editing a file. There are fail-safes programmed into Scrivener to let you know when another session is currently active in a project, but making sure everyone is on the same page with who is editing the project will ensure no mistakes are made. Guideline #2 above deserves to be reiterated: never open a project for editing if another person is currently editing the project. To date, only one such technology is known to be a risk to use in this fashion, and that is Apple’s iDisk, which simply is not designed with complex project formats in mind. It is not recommended that you use iDisk for live projects under any circumstances. It is however, quite safe to use it to “transport” zipped backups of your projects from one computer to another. Finally, it has been said before, but it bears repeating: Scrivener’s built-in folder sync tools should never be used to keep two projects in sync. They are not full projects, and because of their simple and accessible nature, do not contain nearly enough information to properly inform a project of everything it needs to keep your data safe, but rather only what they need to interface with one single project.
- 158. Part III Writing 150
- 159. 13.6. SCRIVENER EVERYWHERE 151 Writing is easy. All you do is stare at a blank sheet of paper until drops of blood form on your forehead. Gene Fowler 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 extraordinary 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, game design, a collaborative scientific article, biographies, and much more. Because of this, 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. Consequently, this section contains a few chapters which could be considered optional. In particular, 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 introduce the editor, where you will be doing most of your writing, 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: l Writing and Editing (chapter 14): Full documentation of the various editor views, composition mode, formatting, layout, and tools to enhance the editing and revi- sion processes. l 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. l Composition Mode (chapter 16): Scrivener’s composition mode feature. Wipe aside all distractions and just write! l Annotations and Footnotes (chapter 17): Learn how to comment as you write using either Scrivener’s exclusive inline annotation tool, or linked comments. Also covers footnotes/endnotes; marker highlighting; and revision pens.
- 160. 152 CHAPTER 13. CLOUD INTEGRATION AND SHARING l Inspector (chapter 18): All about the inspector, which displays document meta- data, notation, references, and more. l QuickReference (section 20.2): Taking Quick Look to the next level. Open items in persistent, editable windows. When two splits aren’t enough, use QuickRefer- ences. l Scriptwriting (chapter 19): While Scrivener is not meant to replace an industrial strength scriptwriting tool, it can still function as a very adept first-draft scriptwrit- ing solution, and produce exports which will work seamlessly in industry standard applications, like Final Draft. l Using MultiMarkdown (chapter 21): If you prefer to write in a structured or se- mantic style rather than with a rich text focus, MultiMarkdown provides a simple, easy to read way of defining and using styles which can be exported to word pro- cessors, web pages, and LTEX. A
- 161. Chapter 14 Writing and Editing Scrivener uses the standard OS X text editor, and therefore all of the features of OS X’s rich text editing system (which are showcased in Apple’s TextEdit application) are avail- able1 . Scrivener also provides some extra word processing features. Most of these features are available via the Text menu, so it is recommended that you familiarise yourself with the Text menu help section (section A.3). 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 our hands. The good news is this also means you get access to many sophisticated tools which would otherwise take years to program. 14.1 Rich Text Editing Philosophy Scrivener supports a rich text editing environment, which means that it is loosely “what you see is what you get”. Unlike word processors or desktop layout applications, how- ever, the precise formatting that you use when writing in Scrivener may in fact look nothing at all like the final product. The compiler will be covered in greater detail in a later section (chapter 23), but suffice to say that you can work in one font, say the de- fault Cochin, but publish in an industry standard font like Courier, without having to change your source text. What this means for you is that certain aspects of your editing can be conveyed through the compiler, like a range of italicised text, while the base font itself can be changed beneath that. Scrivener’s editor can thus be used like a typical word processor, but with the knowledge that rich text formatting can be altered later on to produce different results. 1 The only exception to this is that in Scrivener, you are not allowed to paste QuickTime files into the text. This is because of a bug in OS X that can cause crashes or strange behaviour when a QuickTime file is contained inside a single piece of text that is being viewed in two panes, such as Scrivener’s split view. 153
- 162. 154 CHAPTER 14. WRITING AND EDITING Scrivener is not intended to be a full-blown word processor, but rather a word gener- ating environment. It is 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 scriptwrit- ers, will start their projects in Scrivener, and end in a word processor or desktop publish- ing, or some other specialised application. 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. 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 edi- tor, 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 pro- cess, especially if you are compiling to plain-text, where they will all be safely stripped out and invisible to the reader. Emulating plain-text: If you find working in a plain-text environment to be more productive, you may wish to set the default editor font to one that does not support rich text features, such as Courier, and change the ruler settings so that there are no indents or paragraph spacing. This set-up will emulate a plain-text environment whilst still allowing features such as annotations and highlighting. When using MultiMarkdown to format your work, you will find that some format- ting, 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. 14.2 Editing Basics 14.2.1 Keyboard Shortcuts and Modifier Keys l ArrowKeys: Extend current selection in the direction of the arrow key that is used. l LeftArrow or RightArrow: Extend the selection by word. l UpArrow or DownArrow: Extend the selection by paragraphs. l – UpArrow: Select from the caret position to the top of the editor. l – DownArrow: Select from the caret position to the bottom of the editor.
- 163. 14.2. EDITING BASICS 155 l – LeftArrow or RightArrow:Select from caret position to beginning or end of line respectively. Note the definition of line is not a paragraph. To select to the beginning or end of the paragraph, use the above paragraph selection shortcut. l MouseDrag: Extend the current selection using the mouse. l Double-click: Select word. Can be used in conjunction with dragging to select a range by word. l Triple-click: Select paragraph. Can be used in conjunction with dragging to select a range by paragraph. An advanced method of selection can allow you to select more than one location at once. By holding down the Command key and selecting using the mouse, you can select several areas of non-consecutive text. The Option key can be used to select rectangular portions of text, which is mainly useful for trimming unwanted characters off of the beginnings of several lines. 14.2.2 Spell Checking Spell checking in Scrivener can be accomplished either as you type, or after you are done writing a section. Depending on your preferred way of writing, you’ll want to set how this works in the Corrections preferences tab (section B.9), where you will find other options such as which language to use, and whether or not Scrivener should try and fix common typos for you as you write. You may also use Edit Spelling and Gram- mar Check Spelling While Typing ( – ) to toggle instant spell checking on and off for the project. With active spell checking turned on, if you misspell a word while writing, it will be underscored with a wavy red line. Whenever you see a word with this marking, you can right-click on it and the contextual menu will contain best-guess suggestions for which word you were aiming for. Alternatively, if you prefer to not be alerted to misspellings while writing, you can defer the spell check process for later. When you are ready to spell check a document, right-click anywhere in the document, and select Spelling and Grammar Show Spelling and Grammar from that menu. A familiar floating window will let you step through the document error by error, fixing mistakes and adding unique words to your personal dictionary as you go. As with most tools of this nature, if you type anything into the top field and click “Change” you can add a correction that is not shown in the suggestion list. The Ignore button will temporarily ignore the misspelled word, while Learn will add the word to Scrivener’s permanent ignore list. The Guess button can come in handy if
- 164. 156 CHAPTER 14. WRITING AND EDITING none of the suggestions are close. You can change the word itself in the top field, or select one of the suggestions and click this button in an attempt to narrow the list down to the correct word. Grammar checking can also be enabled here, and you can look up definitions for words by clicking on them in the suggestion list and clicking the Define button. This will open the standard Dictionary tool, with the word pre-selected. 14.3 Editing with Scrivener Beyond the basics of text editing, which are similar to many applications, Scrivener pro- vides further tools, specifically designed for writers, in its editor interface. The rest of this chapter will focus on these tools in a comprehensive fashion, where you can glance through the list of topics covered and pick which items you feel are best suited to your writing style and the task in hand. You could read this section from start to finish, but it is meant to be a collection of individual nuggets that you can learn independently, as you gradually build up your knowledge of the application. 14.3.1 Scaling Text The text of the editor can be scaled up and down, without affecting the font size, via the ability to zoom the scale of the text. Each split can have its own zoom setting; addition- ally the composition mode can have its own independent zoom setting as well. All of these settings are preserved between sessions and saved into the project file itself. In the standard text editor interface, zoom can be set using the zoom tool in the footer bar (section 14.6). In composition mode, this same tool is provided within The Control Strip (section 16.2). You can also use the menu commands: 1. View Zoom Zoom In ( – .) to increase the zoom factor of the text. 2. View Zoom Zoom Out ( – ,) to decrease. If you prefer to always work from a certain zoom setting, the default zoom level for both standard editors and the composition mode editor can be adjusted in the Editor preference tab (section B.7), and the Compose preference tab (section B.5), respectively. Note that this setting will impact all new projects, or recently upgraded projects, not projects that have already been created.
- 165. 14.3. EDITING WITHSCRIVENER 157 14.3.2 Contextual Menu for the Text Editor The text view’s contextual menu contains many standard commands such as Cut, Copy, Paste, Spelling and so forth, along with a number of commands specific to Scrivener. Several common tools, such as Spotlight searching, dictionary access, and selected word/character counts2 , and so forth have been moved to the Writing Tools sub-menu. If a selection has not already been made, right-clicking will select whatever word was under the mouse pointer. The Scrivener-specific commands (the appearance of which will depend on the selec- tion) are listed below: Text Editing Contextual Menu Remove Link When the active selection contains one or more hyperlinks, this com- mand will appear. It is functionally equivalent to Edit Unlink. Split at Selection Splits the current document into two documents at the selection point (the current blinking cursor point, or the initiating edge of the selection, which will be on the left by default, or on the right when using right-to-left languages). 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 title text if necessary, or style it like a header. For more details on splitting documents, read Managing Documents with Split and Merge (subsection 14.3.3). Append Selection to Document Provides a menu of all documents in the binder. Se- lecting a document from this menu will cause the selected text in the editor to be appended to the document selected from the menu. Read Gathering Material (chapter 11) for more tips on moving text around and organising information in the Binder. Set Selected Text as Title Sets the title of the current document to the text selected 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). 2 If you have used version 1, you will want to note that the footer bar now counts word and character 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.
- 166. 158 CHAPTER 14. WRITING AND EDITING Scrivener Link Allows you to create a link to another document in the project within the text. Read more about linking items together in Linking Documents Together (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. Highlight Provides the highlight menu, allowing you to select a highlight colour for the selected text, or to clear it. Read more about this and the above feature in Text Colour and Highlights (section 17.4). Images Contextual Menu These options appear when right-clicking on an image that has been placed within the text (subsection 14.4.7). 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.7) Linked inline images (section 14.4.7) also provides the ability to edit the image in your default image editing software, via Open in External Editor. Tables Contextual Menu When right-clicking within a table in the editor, additional options will be provided: Table. . . Accesses the standard OS X table palette, which provides formatting, cell di- mension, and nesting, and cell split and merge features. 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. Borders This sub-menu provides some handy border tools. Distribute Rows/Columns Evenly Adjusts the height or width of all rows or columns so that every cell has the same dimensions.
- 167. 14.3. EDITING WITHSCRIVENER 159 Lists Contextual Menu Only one extra option over the base text system has been added for list management: 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. 14.3.3 Managing Documents with Split and Merge The ability to expand and contract the outline in a fashion which best suits how you work is important, so there are two tools which make it easy to fashion your outline into as broad or detailed a map as you require. Before discussing the specific tools which let you cut apart documents or sew them back together, it would be useful to also discuss a few methods that you can use to mitigate the regular need for them. When you wish to merge two or more documents together, it is good to ask whether or not this action is necessary. With most applications, and thus the habits we have cultivated from using them, the answer to whether or not one should merge is, yes. However Scrivener offers two powerful answers for the merging problem. First, for visualising smaller pieces of a document as a single document, but only temporarily, you can select any container in the binder, or even just a scattering of items, and choose to view and edit them as a single document (section 14.12). Second, the compilation (chapter 23) system enables you to publish your final manuscript as a single document, no matter how many pieces it may be divided into within Scrivener. For splitting long documents, in some cases you may be able to utilise two import tools which do most, if not all, of the splitting for you. The first tool, File Import Import and Split..., will let you supply a separator, or a string of characters, that mark natural sections within the original file. Whenever Scrivener encounters this separator, it will automatically start putting the remaining content into a new binder item, continuing to split into new binder 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 doc- ument. Finally, if you’ve done your original outlining in a dedicated outliner program, it will likely support an OPML export, which you can drag into Scrivener’s binder. It will recreate the outline structure, placing any original outline notes into the text area for each outline header. For most other cases, read on.
- 168. 160 CHAPTER 14. WRITING AND EDITING Splitting The Document Often, when importing material that you have composed in other applications that do not support an easy to use built-in outline, your text will arrive in Scrivener in one large chunk. Where you choose to break this long document apart is up to you, and the split tools make it easy to do so. To split in a document into two pieces, you will first need to place the caret at the precise point in the document where you wish the split to occur3 . If you select a range of text, the start of the selection will be considered the caret point, for purposes of splitting. Once the selected location has been chosen you can use one of two methods to split the document: Documents Split at Selection( – K) This will create the new document directly be- low the current document in the outline. It will contain everything that followed 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 ap- pear when a range of text has been selected in the editor. This method works iden- tically 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. 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, to avoid having to make numerous identical changes later on. It is not possible to undo a split action, but you can use the Merge feature to effectively undo any unwanted splits. 3 This can even be done when there is nothing to split. If you split from the very end of the document, this can still be useful due to how it copies all meta-data.
- 169. 14.3. EDITING WITHSCRIVENER 161 Pro Tip: You might also find the ability to search by formatting (subsection 20.1.5) 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. Merging Documents Together In opposition to splitting, the ability to select two or more documents and merge them together into a single document is also made easy with Scrivener. Unlike the split func- tion, merging is a super-document level action, and thus requires a selection to be made in a corkboard, outliner, binder view, or from within a collection; you cannot merge from within a text file. Documents do not have to be in consecutive order, they can be picked from through- out the project. When selecting non-linear items, here are some tips to determine order- ing: l If the view you are picking documents from is based on the outline order, such the binder, outliner, or corkboard (for this purpose, a freeform corkboard is still considered to adhere to Outline Order. If you wish to impose a new order based on the freeform spatial placement, make sure to use the Commit Orderbutton (sec- tion 12.1.3), first, and then merge), then the merged document will retain the orig- inal outline order. l When using a Collection to select items, the collection order will be used to estab- lished the structure of the merged document. When it comes to merging, Scrivener will attempt to retain as much meta-data as is logically possible. The synopses, notes, keywords, references, and list of snapshots will be combined together, much in the same fashion that the main text will be. Meta-data which cannot be combined (such as Title, Label, any custom meta-data, compile option flags, and so forth) will use the top-most document as a reference point. For example: l Document A – Synopsis: “This is the first document” – Keyword: “Apples”
- 170. 162 CHAPTER 14. WRITING AND EDITING – Status: “First Draft” l Document B – Synopsis: “This is the second document” – Keyword: “Carrots” – Status: “To Do” – Notes: “Mix these two together in a blender for a great tasting, healthy bever- age.” 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): l Document A – Synopsis: “This is the first document This is the second document” – Keywords: “Apples”, “Carrots” – Status: “First Draft” – Notes: “Mix these two together in a blender for a great tasting, healthy beverage.” When merging, the main text will be combined according to the preferences you have set in the General preferences tab (section B.2), under the Separators section. Merged documents can be combined with a single line, a full empty line (useful in situations 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. 14.3.4 Typewriter Scrolling You can turn “typewriter scrolling” on for the main editors, QuickReference panes, and for the composition mode editor independently via the Format Options sub-menu ( – T). Typewriter scrolling was an innovation of the The Soulmen’s Ulysses. When it is switched on, just as with a typewriter, the line of text you are typing will remain centred
- 171. 14.4. FORMATTING TOOLS 163 Figure 14.1: Example Ruler Settings vertically in the editor, once your text is long enough to reach the middle of the screen. This means that your eyes do not have to be glued to the bottom of the screen all the time when typing in a long piece of text. When Typewriter Scrolling is enabled, your scrollbar will act as though there is more content than the document actually has. This is because we add extra spaces below your current line in order to keep it in the middle. These spaces do not actually exist in the file, and will vanish if the feature is disabled. It is possible to adjust where the focus point will be. If you’d prefer for editing to happen in a different fraction of the screen, visit the Editor preference tab (section B.7), and set the “Typewriter scroll line” to the top quarter, third, middle (default), bottom third, or quarter of the screen. The Typewriter Scrolling feature is not available in Page View, given how this feature lays out the pages in a simulacrum of the printed page, which will of course not contain any of the dummy lines added to keep the entry position in the middle of the screen. 14.4 Formatting Tools 14.4.1 The Ruler The text editor in Scrivener uses a ruler for setting indents and tab stops, such as many word processor applications provide. It can be shown or hidden via Format Show(Hide) Ruler or – R. This will present a simple indenting and tab stop interface (Figure 14.1). The following elements can be found in the ruler: Tab Stops Stops can be created by clicking in the numbered area and dragging up, or by right-clicking in the ruler 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
- 172. 164 CHAPTER 14. WRITING AND EDITING mouse pointer as you drag. These will be depicted by type using icons. The four tab stop types available are: l Left: This is the standard type. Text will be left-aligned, with the first line indented to the position of the tab stop. l Center: Text will be centre-aligned, using the position of the tab stop as an anchor point; this can be anywhere on the line. l Right: Will right-align text with the right-indent set to the point of the tab stop. l 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. To remove a tab stop, simply click and drag it out of the ruler. Indents There are three indenting controls, not to be confused with margin controls (which Scrivener’s ruler does not address). Indenting is the action of offsetting text a defined distance from the margin. A left indent pushes the text boundary toward the right, away from the left margin. A right indent pushes the text boundary toward the left, away from the right margin. In addition to the two primary indent marker is the first-line indent marker. This will only indent the first line of a paragraph. Using this control, it is possible to set the first line to indent by half an inch, while the rest of the paragraph is set to zero (or directly adjacent to the margin). Scrivener’s default formatting settings demonstrate the best way to use indentation, if you need to use it at all. Hanging Indents These are produced using the same tools as ordinary first-line indents, only to produce a hanging indent, you will need to inverse which marker comes first. If the first-line indent marker is to the left of the left-indent marker, then the body of the paragraph will be pushing inward, while leaving the first line “hanging” over the blank space left below it. 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 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.
- 173. 14.4. FORMATTING TOOLS 165 Figure 14.2: Format Bar: displayed in sections Consequently, to convert most standard measurements to useful values here, you will need to factor in the standard amount of print margin by adding in the margin to the value you see in the ruler. For example, if you are using 1” margins and you need a right-indent of 1”, the right-indent should be set at 5.5” for US Letter, not the standard 6.5”. Optimally, your formatting can be deferred and set in the compiler, where formatting and paper dimensions can be operated upon in 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, but no newline will be added. 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 (Hide) Invisibles. Ruler settings are adjusted per-paragraph. If you wish to set tab stops or indents for many paragraphs at once, you will need to select them prior to using the ruler. If for some reason you need to apply ruler settings from one portion of text to another, it is possible to copy paragraph settings by using Format Text Copy Ruler 14.4.2 The Format Bar The Format Bar provides quick access to common formatting features, typically found in fewer quantities with the combined tab and margin ruler in other applications. If you are looking for tab and margin controls, you can still toggle that per text view with – R. The visibility of the Format Bar is toggled with – R. The first section (Figure 14.2) of controls handle font face, size, and variant. All of these tools act immediately on the currently selected text. If no selection is given, then they will alter how you type from the current caret position onward. l The first drop-down contains formatting presets (subsection 14.4.3); handy ways to apply many formatting preferences at once. l The second menu lets you select from all of the available font families installed on your computer.
- 174. 166 CHAPTER 14. WRITING AND EDITING l The second provides the variants available for that family. Note that not all fonts come with a full complement of variants. If for some reason you cannot change a selection of text to bold or italic, check this menu to make sure that the current font supports these variants. l The third menu provides a quick list of common font sizes. If you need a custom 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 aforementioned Presets menu hooks into Scrivener’s formatting preset system. As is the case 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 automatically update later on if you change the preset. The next three buttons (section two (Figure 14.2)) provide toggling shortcuts to the most common text formatting tools: bold, italic, and underscore, respectively. When the caret is in a range of text that matches the format style, the appropriate buttons will appear activated. Directly to the right of these, control for paragraph-level text alignment exist in button form. Paragraph-level alignment comes in four flavours: l Left Align (default) l Centre Align l Right Align l 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 ruler ( – R). In the third section 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 initially 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
- 175. 14.4. FORMATTING TOOLS 167 current highlight (or use – H) for the selected text, or use right-click to access further options as described above. The final, fourth section of the Format Bar accesses paragraph & line spacing, and lists. The line spacing drop-down provides some quick presets, but for more complex multi- type spacing preferences, select the Other... 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 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. 14.4.3 Formatting Presets (Styles) Previously known as “Styles”, the new system changes the name to avoid confusion with word processor styles, which keep assigned ranges of text up to date with stylesheets. The new system improves upon the management of presets, and increases the reliability of custom keyboard shortcuts when applied to them, by placing the styles into the Scrivener menu itself, rather than solely in toolbars. A few Presets have been provided to you for convenience, or as starting points for your own preferred look and feel. Note that Presets are not in any way tied to the rest of the application or project formatting rules. For instance, if you change the application default to use paragraph spacing instead of indentation, the Body preset will not change and will still apply an indent to the target text. This is by design, as Body is nothing special and can even be deleted or completely redefined. These can be found either in the Format Bar, under the Presets... drop-down menu, or in the Format Formatting Apply Preset sub-menu. There are two basic types of presets available: 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, under- score, kerning, or anything else found in the Format Font sub-menu. These two types can be used exclusively, or combined into a single Preset, controlling 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.
- 176. 168 CHAPTER 14. WRITING AND EDITING Applying Presets The method of attribute application will depend upon the type of preset. For character attributes 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 anywhere 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. 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. Creating New Presets To create a new preset, you will need some exemplar text in your editor, containing the styling you wish to preserve for future use. If you intend to create a paragraph style, the caret should be placed anywhere within the paragraph you intend to use as a default. For character attributes, you will need to place the caret in the text where that format appears. It is often best to not select any text for this procedure, as doing such will increase ambiguity where multiple styles and attributes are employed. Invoke Format Formatting New Preset From Selection. You will be presented with a sheet that will let you name the new style, choose whether it will impact character attributes, paragraph styles, or both, and optionally if font settings should be stored as well. If you do not want the preset to change the underlying font family or size, then make sure these checkboxes are disabled. Once a name has been added to the sheet, you will be able to save the preset for future use. It will appear in the Format Bar menu, as well as in the application menus. 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.
- 177. 14.4. FORMATTING TOOLS 169 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. 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. 14.4.4 Font Palette The font palette is a standard tool provided by Apple, and can be toggled with For- mat Font Show Fonts and Hide Fonts. You can also use – T to toggle this view at any time. This palette provides full access to the font typesetting engine, including access to many OpenType features and custom font effects. For basic font changes, the Format Bar (subsection 14.4.2) will suffice. The precise appearance of the palette will change depending how large you make it. As the size of the palette increases, more options will be made available to you. Since this palette is provided by Apple, please refer to the help files provided by TextEdit, for details in using it. To use the font palette to change the appearance of your text, you will need to first select the text you wish to change, and then call up the palette. Any changes you make will be immediately reflected in the editor. 14.4.5 Resetting Formatting Oftentimes, after you’ve gathered material from the Web, or imported documents that you’ve written in another word processor, the formatting of the imported material will not match the default font in Scrivener for new documents. While you can change this default at any time with the Formatting preference tab (section B.8), this will not impact documents you’ve already created or imported, as Scrivener has no way of knowing if that is what you really want to do. Often it might be okay to leave the file as non-
- 178. 170 CHAPTER 14. WRITING AND EDITING standard, especially if it is research material that you never intend to include directly in the draft or even edit. If you do want to retrofit these documents to your current defaults, you can do so with the Documents Convert Formatting to Default Text Style menu command. Since this command works at the document level, you can select as many cards, outliner rows, or binder sidebar items as you please and convert them all in one go. After clicking the menu command, a window will pop up asking how much formatting you wish to apply to the selected document(s). Most of these options work in a negative fashion. By example: if you select “Preserve alignment” for instance, and the document is left-aligned, even if your preferences are for full justification, they will not be applied because you have elected to preserve the original alignment. The only exception is the “Convert font only” option. This basically presumes you’ve checked off “Preserve alignment”, “Preserve tabs and indents” and “Preserve line spac- ing”. Since the remaining option is a font detail, it will be wiped out unless specifically checked off, too. Once you’ve used this window to set up how deeply this command will impact a doc- ument, you can waive it in the future by holding down the Option key when selecting the menu item. Please note that because this command impacts broad changes in potentially many dozens or more of documents at once, there is no undo. The procedure only impacts formatting, so it is safe to use, but if you are unsure of whether or not the result will favourable, either Snapshot (section 14.9) the documents first, or perform the conversion one-by-one and proof the results. Once you are confident you have the right settings engaged, you can proceed at a more rapid pace. Some simple tips for preserving common formatting based ranges: l Preserving Block Quotes: Block quotes are usually indicated entirely by some form of increased left, and sometimes right as well, indent. Preserving tabs and indents will protect most block quotes from being reduced to normal text by this tool. l Preserving List Spacing: Some styles call for lists to be single-spaced even if the text around them has a greater line-height or inter-paragraph spacing. Using “Pre- serve line spacing” will protect these lists at the expensive of not applying your preferred line spacing to standard paragraphs. l Preserving Titles: If you’ve got a document with a lot of headers already for- matted into it, you could try preserving font size, style and line spacing, but this will in many cases be the three things you want to apply. Titles are going to be
- 179. 14.4. FORMATTING TOOLS 171 harder to manage automatically, and may require manual effort to keep their for- matting as intended. Another thing you can consider doing is switching to using Scrivener’s compile feature to generate titles from your binder names, and leave worrying about special formatting for headers to the computer. One last tip is to use “pre-emptive” format conversion. If you know that you will wish to discard the formatting of the text you are pasting, you can use the special Edit Paste and Match Style command to do so. This will treat the text as though it were plain-text, and as such it will take on all of the characteristics of the text around the cursor position where it is pasted. Since the text is treated as plain-text, this means you will lose any inline formatting and function, such as hyperlinks and italics. If you intend to keep this level of formatting, deferring the problem to later by using the document conversion feature will be a better choice. 14.4.6 Preserve Formatting If you are planning on letting Scrivener’s compiler do all or most of the final formatting for you, it can often be useful to preserve ranges of text from the formatting engine. A common example of this would be the use of block-quoting as a left indent. Technical writers might find it useful to set apart blocks of text as “code”, using a special font and layout. In the past, you had to break out these special sections into their own documents and preserve the formatting of the entire document. Now you can define these ranges right in their original context. To specify a range of text for preservation, select the text in the editor, and then invoke the Format Formatting Preserve Formatting menu command. This will draw a blue dashed box around the text, which can be worked around and within like any other type of formatting range. Also like other formatting tools, to toggle a preserved range off, simply select the entire range and use this same menu command. Preserved formatting will also protect your text when using the Docu- ments Convert Formatting to Default Text Style tool, which is useful for homogenising the look of your document according to your editor preferences. Any text contained within these blocks will retain their original formatting and not be touched by this tool. MultiMarkdown users can use preserved formatting ranges to define code blocks. Any paragraphs located within a Preserve Formatting range will have a tab character added to the front of each line within it, informing the MMD engine to treat the text like a code block. Authors working with HTML may use Preserve Formatting to preserve ranges of raw HTML code. If you wish to type in some HTML code by hand and have it passed straight through to the final result, you can use this tool in conjunction with the HTML Settings
- 180. 172 CHAPTER 14. WRITING AND EDITING compile pane (section 23.13) setting, “Treat ‘Preserve Formatting’ blocks as raw HTML”, enabled. 14.4.7 Inline Images While images themselves cannot be placed into the Draft as binder items, you can in- sert an image into the text either by dragging an image file in from the Finder, drag- ging an image document in from the Binder, Outliner or Corkboard, or by selecting Edit Insert Image From File.... The image will be placed at the current cursor position. Images placed into documents in this fashion will create a new copy of that image, even if it was dragged in from the Binder. This becomes important when working with place- holder images. If you intend to later edit your images or replace them with updated copies from a graphic designer, you may wish to use Linked Images instead (below). 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 independently 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. 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. If an image is resized, or has alignment or line-spacing attributes applied to it, these options will be used in the final compilation. This is true even if the compiler has been set up to ascribe new formatting rules to your manuscript. In short, images come with a sort of limited Preserve Formatting (subsection 14.4.6) block implicitly around them. To save the image to the disk, right-click on the image and select Save as Picture.... 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. Working with Print-Ready Images If you’ve been provided full size, print ready graphics for publication, it is often best to not embed them directly into your document. Embedding images in the document is good for small placeholders, but since the images are saved into the RTF file itself, adding
- 181. 14.4. FORMATTING TOOLS 173 very large high resolution graphics to your files may 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. Embedding Inline PDFs It is possible to drag PDF files into your editor to embed them. This feature is meant to allow the usage of graphics saved in the PDF format. It will not allow multi-page docu- ments to be inserted into the final manuscript, and if the original PDF is pre-formatted for print, you will very likely need to crop the result down significantly so that it can fit within the page margins, using a PDF editor such as Preview, or Acrobat Pro. When compiling to formats that do not support embedded PDFs (which is pretty much all of them), a raster graphic will be automatically generated for you and embedded as a PNG file, if the compile format allows embedded graphics. If it does not, such as with plain-text files, then as with standard graphic files, they will be omitted as per usual. When use File Export Files... and selecting RTF, this conversion will also take place. This will cause a loss of vector data, and so the processes uses a large PNG that is then shrunk down to scale to maximise quality. You can adjust the DPI use for this in the Import & Export preference tab (section B.10). Linked Inline Images Linked images are useful when the actual graphics in your project text are incomplete or placeholders for larger, production-ready graphics. If you are familiar with desktop publishing tools like Adobe InDesign, then the manner in which linked images work will be familiar to you. For those not aware, linked images are the placement of graphics in your text in such a way that the representation of the image in your editor is being generated by files outside of the project. Note that for increased performance, Scrivener uses a cached version of your image when you create a link to it while the project is open. Whenever you re-open the project, this thumbnail will be updated with the current image on the disk. To create a linked image, use the Edit Insert Image Linked to File... menu command. When compiling with linked images, the current version of those images on disk will be used to create the embedded copies used in the compiled version. Since nearly all of the compilation formats do not support active image linking, Scrivener must take the current version and embed it in the final copy. So if you are in a workflow that involves external help from designers, be sure to get your external images up to date before producing final compiled copies.
- 182. 174 CHAPTER 14. WRITING AND EDITING 14.5 Header Bar The header bar appears at the top of each editor pane, and can be toggled on and off via View Layout Show (Hide) Header View. It contains useful navigation tools, displays the current title of the edited document(s), and provides control over editor splits. The header bar has three colour states: 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.1 History On the left-most side of the header bar are history navigation arrows, which should be familiar in appearance and usage from any web browser. Use these to navigate 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. 14.5.2 Item Icon Menu Next to the navigation buttons is the document icon, which shows what type of docu- ment is being displayed (and its content status if it is a folder or text file). Clicking on this icon brings up a menu containing some useful shortcuts to oft used commands. The icon menu works on the current session, which can at times mean more than one file, when working in Scrivenings mode. 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 view- ing a collection and wish to find where the file is actually located in your project outline. When used with Scrivenings mode, all of the entries included in the session will be highlighted in the Binder at once.
- 183. 14.5. HEADER BAR 175 Path Reveals the location of the current document in descending order. The top entry 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. This command always works on individual files. When a Scrivenings session is in use, the constituent portion of the session that you are currently working on will be revealed in the path. 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. If you are viewing a Scrivenings session, all of the bookmarks in the entire session will be displayed together. Bookmarks can be added to your document using – B, or from the Edit Insert sub-menu. Take Snapshot This command will take a snapshot (section 14.9) of the current text and store it for later use. This command always impacts only one file. When used in a Scrivenings session, only the constituent portion of the session your cursor is currently in will be saved to a snapshot. 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.
- 184. 176 CHAPTER 14. WRITING AND EDITING 14.5.3 Header Bar Title To the right of the history navigation buttons, the title of the currently viewed item will be displayed; as you navigate through the project, this title will update to reflect the current contents of the editor.. In the most simple cases, it will display the title of the document you are currently viewing or editing. Whenever the presented title consists of only the title itself, you may edit the name of it by clicking within the text, and pressing Enter to confirm. When you are viewing a collection of items in a corkboard or cutliner, the name of the viewed container will be displayed. That is, if you click on a folder in the binder, the name of that folder will be displayed in the header bar, regardless of which index card or outliner row you have currently selected. When viewing the result of multiple item selections in the binder, the view will dis- play the title, “Multiple Selection”. This is a unique view which lets you know that the corkboard or outliner you are viewing doesn’t “exist” anywhere in the project. You are viewing a selection of items, but you will not be able to add new items or re-arrange exist- ing items because there relationship amongst each other does not correlate with anything in the Binder. In the case of a Scrivenings session that comes about as the result of clicking on a container, the name of the container will be displayed first followed by “(Composite)”. Suffixed to this will be the name of the current document you are editing within that session. When the Scrivenings session is the result of a Multiple Selection, it will be stated as such, and the name of the currently edited document within the session will be suffixed to that reminder. In all cases where the title is a not a literal binder title, you will lose the ability to edit the name of the document. You will need to use the inspector or the binder to make this change, or enable View Editor Show Titles in Scrivenings. 14.5.4 Sidebar Navigation Moving to the right-hand side of the header bar, you will find two arrows pointing up and down. These arrows allow you to navigate within the project sidebar (be it the binder, Search Results, or Collection that is currently viewed), as though it were a flat list. This form of movement is unique in that the binder selection will update. In most cases, when you navigate to documents using the menus or the various controls available in the header bar, the binder selection will not update to follow your select, by design. In this case however, these two buttons are actually synonymous with clicking on documents in the sidebar.
- 185. 14.6. FOOTER BAR 177 Clicking the up-arrow will move you to the document immediately above the current document in the sidebar. Ordinarily, this will be the binder. The selected document will always be the one immediately above, even if that item is currently hidden and on an entirely different hierarchal level. Clicking the down-arrow will always move you to the document immediately below, in the current sidebar list. If you are viewing a container as a Scrivenings session, the behaviour of this feature will modify slightly. The nature of selection will still be the same in terms of linear above/below selection, but the current session will not be dismissed. It thus can be used as a form of navigation within a Scrivenings session. Note that if you navigate above or below the boundary of the selection, it will be dismissed. This feature is an augmentation of the basic behaviour. It is not available to multiple selection based sessions. If you wish to navigate within a multiple selection based Scrivenings session, use the Go To menu instead. These two buttons can also be activated with the keyboard shortcuts, – UpArrow and – DownArrow, respectively. 14.5.5 Split View Button Finally, the last button on the right-hand side is a multi-purpose button which changes depending upon the current layout of the application and your last preferred split orien- tation. If no splits are open, a small line will be drawn through the icon in the horizontal or vertical orientation to let you know which way the editor will be split if you click on the icon. If you hold down the Option key, this will switch to the opposing orientation, and that preference will be saved for future splitting as well. Once a split is already open, the icon will appear blank. Clicking on it in this state will close the opposing split. This means you should click on the icon in the header bar for the document view you wish to retain once the split has closed. Either side can be dismissed by clicking on the opposing header bar button. Additionally, if you hold down the Option key while a split is open, a vertical or horizontal line will be drawn, allowing you to switch split orientations without otherwise disturbing your layout. Both splits will remain open, only the orientation will change. See also: Splitting the Editor (section 14.8). 14.6 Footer Bar Below each editor pane is the footer bar. This is the most dynamic part of the editor, in that it will change depending on the type of document visible and the current editor
- 186. 178 CHAPTER 14. WRITING AND EDITING mode. When a text document is 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 script mode, it will display scripting hints and the elements menu. When a QuickTime document is displayed, it shows the current playing time. And so on. This section will cover the tools available to the standard text editor. l For information on the various other document footer bars, see Viewing Media in the Editor (section 14.7) l For details on how to use the footer bar in script mode, see Scriptwriting (chap- ter 19). l Read the chapters on The Corkboard (section 12.1) and The Outliner (section 12.2) for details on how to use the footer bar in those view modes. As with the header bar, it’s visibility can be toggled with View Layout Show (Hide) Footer View. 14.6.1 Text Zoom You can make the text in the text editor bigger or smaller without changing the font by using the text scaling pop-up in the left side of the footer bar. See Scaling Text (subsec- tion 14.3.1) for more information. 14.6.2 Quick Text Statistics In the middle of the footer, the current word and character account of the text you are editing will be displayed in real-time as you type. This counter works for all visible text, even if it would otherwise not be compiled, and will aggregate all text together when using Scrivenings view. This counter will also display the statistics for the current text selection if one exists. When the counter is displaying selected text, the colour will turn blue to indicate that it is no longer counting the entire document(s) text. Clicking in the statistics area will reveal a pop-over, which will display a little addi- tional information, but more importantly, provides a quick count without footnotes or annotations—though you can selectively turn either of these back on. The live counter that updates while you type will always include both of these for performance reasons, so if you need to get a quick statistic scan without them, use the pop-over. The pop-over also works with a selected range of text.
- 187. 14.7. VIEWING MEDIAIN THE EDITOR 179 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 feature 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 char- acter count in the footer. 14.6.3 Text Goals When you are editing a single document in stand (not scriptwriting) mode, a small target icon will appear on the right side of the footer bar. This button brings up the target options for the current document which will let you set the numeric word or character goal 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/or “Progress” columns, while the “Total Goal” and “Total Progress” columns will show an aggregated goal count and total progress toward that sum, for the displayed Outliner row and all of its descendant items. In this way, you can easily work toward chapter or other larger section goals, while still maintaining a fine-grained approach to cutting up the section into smaller pieces. To disable the goal metre for a document, enter a value of “0” into the target configu- ration for the document. 14.7 Viewing Media in the Editor The editor is capable of viewing most of the file types that you will need to interface with for research and creative use. The footer bar will often change to provide tools for working with different media types. Note that Scrivener is, by and large, not intended to operate as an editor for all types of files. It would take years to design these features, and in most cases your existing applications will do a better job of editing PDFs, movies, and images. Consequently, a convenience button will be provided in most media views, making it simple to load the document in an external editor of your choice. Changes made to the file will be saved within the Scrivener project when you return4 . 4 If you are already viewing that file in the editor, you may need to refresh its view in order to see the changes.
- 188. 180 CHAPTER 14. WRITING AND EDITING 14.7.1 Viewing Images The image view is displayed whenever an image document is selected, allowing you to zoom in and out and rotate it. If the image is larger than the viewable area, click and hold the mouse on the image and move the mouse to drag-scroll the image around. To zoom in and out and rotate, double-click anywhere within the image or the grey area around it. This will bring up the image tools pop-up. The slider at the top of the pop-up allows you to scale the image.The button to the left of the slider zooms the image as far out as it will go (that is, makes it as small as possible) and sets the slider to the far left; the button on the right of the slider zooms the image as far in as it will go (makes it as large as possible) and sets the slider to the far right. Below the slider, you can check a “Scale to fit” option which will disable the slider and always size the image according to how big the editor is. There are three additional tools available: there is a button for rotating the image (rotating it 90 degrees clockwise, or anti-clockwise when Option-clicked); a button for fitting the image to the current viewable area; and a button that returns the image to 100% magnification. In the footer bar, click the toolbox button to open the image in your default external 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. 14.7.2 Viewing PDFs The PDF view is displayed when a PDF document is selected. Its main view looks and acts exactly the same as Preview.app. You can control the display of the PDF document via the View Media PDF Display sub-menu, and you can zoom in and out of it using the “Zoom In” and “Zoom Out” controls in the View Zoom sub-menu. You can also access many of these tools via right-click on the PDF display itself. The footer bar contains arrow buttons on the left, which allow you to browse back and forth through the pages of the PDF document, and text in the centre showing the number of pages the PDF document has and which page you are currently viewing. 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
- 189. 14.7. VIEWING MEDIAIN THE EDITOR 181 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 documentation 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. 14.7.3 Viewing QuickTime Documents The QuickTime view is used to display movie and sound files. It should be familiar to most OS X users. From the control bar beneath the viewing area (above the footer bar), you can play or pause the movie, change the volume, or step backwards and forwards through it. On the lower right, you’ll see a rewind symbol with a pause button in the middle of it. This is an optional mode which will show up as blue if engaged, which will rewind your media by a set number of seconds whenever you pause. This interval can be configured in the Navigation preferences tab (subsection B.6.4). 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. 14.7.4 Viewing Web Pages The web view displays imported web pages. Note that clicking on any links in a page displayed in the web view will open the link in the system’s default internet browser. Scrivener does not allow internal browsing simply because this would mean integrating many of the features of a browser into the web view (such as back and forward buttons, a refresh button, maybe even a download manager. . . ) and this is outside of Scrivener’s scope. When the web view is shown, the content of the footer will display the original URL a as a link that can be clicked on to open the original page in the system’s default browser. You can increase and decrease the size of the web page font using the standard View Zoom sub-menu.
- 190. 182 CHAPTER 14. WRITING AND EDITING Pro Tip: If you archive search forms, such as http://www.google.com/, and searches that you perform will have their results opened up in your web browser. Thus it can be useful to store a number of common research portals in your Binder for quick access. Note that since this uses an archived version of the web page, if the host site changes their searching protocol, your archived search might break (this generally only happens rarely). 14.7.5 Viewing Unsupported Document Types By default, Scrivener will let you import files into the Binder that it cannot display in the editor. You can restrict this by checking off “Import supported file types only”, in the Import & Export preference tab (section B.10). Unsupported file types will use whatever icon they have been assigned by the system. When loaded in an editor, the file icon and its filename will be displayed. Double-click on the icon to load the file in its default external editor, or right-click on the toolbox icon to select an alternate application. The toolbar will also feature a Quick Look icon. Clicking this will produce the same effect as using Quick Look in the Finder. As with supported files, unsupported files are imported into the project package itself. 14.8 Splitting the Editor Scrivener’s editor uses a technique known as editor splitting. You may have encountered split screen editing in other applications, but the level of integration and power between the two splits in Scrivener is likely to be unfamiliar to new users. Rather than arbitrarily splitting the interface any number of times and ways, the editor uses a two-way split system so that you can easily control the flow of information in the opposing split while you work. If you are unfamiliar with splitting an editor in general, you can think of it as a way of opening a second editor in which you can view the same item you are already working on, or another item entirely. When the same item is loaded into both splits (which is what happens when you create a new split), any edits made to either side will be immediately shown in the other split. Using two splits makes it easy to edit or refer to other parts of the document without scrolling back and forth. Loading another item entirely into the second split makes reference a snap. While you could use the history functions to jump back and forth between a reference source and the portion of your manuscript that you are editing, splits will present both items to you at once, even allowing you to play media in the second split while recording notes on it as it plays.
- 191. 14.8. SPLITTING THEEDITOR 183 In addition to standard file viewing and editing, you can also use splits to do anything else that you would ordinarily do in a single editor. You can mix Corkboard, Outliner, and Scrivening sessions together, and even link the splits so that clicking on cards or outliner rows automatically loads the item in the second split for you. We’ll now take a look at all the available possibilities in turn. 14.8.1 Horizontal and Vertical Splits The editor interface can be split in one of two orientations. In vertical mode, the divider will be drawn down the middle of the screen, and is most suitable to viewing two text documents side-by-side as it maximises vertical space. Horizontal mode creates a split that is familiar to many applications like Mail with content on the top and bottom. In either case, both sides of the split have the same degree of power in loading various views, media types, and text editing. You can easily switch between orientations by choosing the opposite split type in the View Layout sub-menu, or Option-clicking the split icon in the header bar (section 14.5). When the editor has been split, a header bar and footer bar will be created for each split. This means that each side has its own history queue, view modes, zoom settings, and so on. Everything that you can do to a single editor window can be done to a split window, and those changes will be remembered for that side of the split. An example of this would be view modes. With a single editor interface, if you choose to view containers using the Corkboard model, every time you click on a container or select more than one item, a Corkboard will be presented to you. However, when splits are engaged, each side has its own view settings. This means the left side (in a vertical orientation) can be set to Outliner, and the right side set to Scrivenings. Quickly switching between editors: It is easy to jump between splits without using the mouse, by using – E and – R. When the split orientation is vertical, E will access the left editor and R the right; when the split orientation is horizontal, E will access the bottom editor and R the top. Additionally the keystroke that cycles between the Binder and the Editor, Tab, will include both splits in the rotation. 14.8.2 Controlling the Opposing Split There are a few commands that you can use to impact the editor your are not currently working in, reducing the need to flip back and forth between them. These are located in the View Editor Other Editor sub-menu, and have shortcuts for handy usage. Remote scrolling To scroll the other text editor up and down, use – UpArrow and – DownArrow. This command does not work when the other editor is view-
- 192. 184 CHAPTER 14. WRITING AND EDITING ing Corkboard or Outliner views, or media that would not otherwise respond to scrolling. Note that this form of scrolling is based on the scrollbar, not actual text position, so the position of the scroll point will not be saved when used in conjunction with the history button, like cursor position is. The exception to this are PDF files, which are always saved by scroll-point, not cursor position. 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 transcrip- tion. 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. 14.8.3 Managing Split Views If you wish to swap the actual position of the material in the editors, so that the content on the left now appears on the right, for example, use the View Layout Swap Editors menu command. To synchronise the contents of both splits, click the document icon in the header bar for the side you wish to use, and select the Match Split Document(s) command. This will duplicate your current view selection in the other editor. So if you are in a Scrivenings session, that session will be duplicated; if you have a Multiple Selection view, that selec- tion will be duplicated in the bottom view—and the current view mode in the active split will be used instead of the active default for that split (and will thus set the default for that split to the acquired view model). 14.9 Using Snapshots Snapshots provide a way of backing up and saving different versions of individual docu- ment. Taking a “snapshot” of a document takes a copy of the text of that document as it exists at that exact moment in time and stores it so that you can return to it, or restore it, at a later date. Using snapshots, you never need worry about making major edits to
- 193. 14.9. USING SNAPSHOTS 185 a document, because you can take a snapshot of it before you begin editing and then re- store the older version later if you change your mind about the changes you have made. Snapshots only affect the text of documents (not notes, 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 Documents Snapshots sub-menu, and the Inspector pane (subsection 18.4.4), the latter of which will be covered completely the referenced section. You can also conveniently use the – 5 keyboard shortcut while editing a document to take a quick snapshot in the background. 14.9.1 Creating Snapshots While working on a document, there are three easy ways to snapshot it for future refer- ence. The key thing to understand with Snapshots is that they provide a way to set mile- stones for individual items in the binder. They are not a tool for providing an overall snapshot of the entire project, structurally speaking, and are probably not the best tool for taking a quick snapshot of your entire draft. In most cases, large scale backups like this would be best created using the File Back Up Back Up To... menu item. That aside, it is simple to quickly snapshot multiple documents. Select the documents you wish to snapshot in the binder sidebar, corkboard, or outline, and press – 5, or Documents Snapshots Take Snapshots of Selected Documents to create a snapshot of each. Snapshots can later be accessed individually in the Inspector pane. You can jump straight to them with – M, or Documents Snapshots Show Snapshots. A second way of taking snapshots is to supply them with a title as they are created, use Documents Snapshots Take Snapshot with Title, or – 5. This can be done for single or multiple selections. In the latter case, the title will be added to each document in the selection. Snapshots can be titled at a later time using the Inspector. The third method for creating snapshots is from the Snapshot pane itself in the Inspec- tor. Click the + button in the header area of this pane to create a new snapshot. 14.9.2 Managing and Comparing Snapshots Existing snapshots are all managed in the inspector pane. To jump to snap- shots, click the button with the camera in the Inspector footer bar, use the Docu- ments Snapshots Show Snapshots menu item, or press – M. In the snapshots pane, you can create new snapshots from the current text with the + button, remove
- 194. 186 CHAPTER 14. WRITING AND EDITING old snapshots by selecting them in the snapshot list and clicking the - button, or roll back to a prior version of your text using the Roll Back button. More details on the functions available in the inspector can be found in Snapshots Pane (subsection 18.4.4). 14.9.3 Comparing Changes The comparison feature lets you analyse the differences between versions of your text. There are two ways of using this: 1. Compare with current: select the snapshot you wish to compare against the current text, and then click the Compare button. The changes will be highlighted in the text preview area. 2. Compare two snapshots: select two snapshots in the table and then click the Com- pare button. The differences between those two versions will be highlighted. 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. Comparisons can be reviewed in the standard editor, and are thus useful in conjunc- tion with a split view, as you can review the edits alongside the current version of the document. To view a snapshot in an editor split, drag the snapshot from the table in the Inspector to the header bar of the split you wish to load it in. If you hold down the Option key while doing this, comparison mode will be engaged for the split. 14.9.4 Viewing Snapshots in the Editor It is possible to load snapshots as read-only text into the main editor splits. To do this, simply drag the snapshot you wish to view into the header bar for the editor split you wish to load it in. You can also load the snapshot in comparison mode by holding down the Option key as you drag the snapshot into the header bar. 14.9.5 Automatically Created Snapshots Some functions in Scrivener will create automatic snapshots for you. When a document is scheduled to be changed to a sync action, the default behaviour is to create a snapshot before updating the document with the remote changes. This makes it easy to find what has changed with the external document. This behaviour can be suppressed within the sync configuration panes if you wish to keep the snapshots area for your milestones, only.
- 195. 14.10. AUTO-COMPLETION 187 14.10 Auto-Completion There are three primary forms of auto-completion in Scrivener: Character substitution 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. 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. Scriptwriting abbreviations Common scriptwriting abbreviations such as “O.C.”, “Ext.” and so on, can be suggested as you type. These are generally defined in the script formatting definition (Format Scriptwriting Script Settings). 14.10.1 Character Substitutions With character substitutions, you can set which characters will be replaced as you type. Scrivener uses a combination of built-in enhancements, plus OS X’s (Snow Leopard and greater) built-in substitution engine. These can all be set in the Corrections preferences tab (section B.9). Each option is documented more fully, there. These adjustments always happen automatically as you type, but some require you to terminate the word you are typing in, before they will take action. 14.10.2 Custom Auto-completion Word and phrase completion can be used to suggest completions as you type, but more commonly you will use a keyboard shortcut to trigger the completion menu. – ., Esc, and Esc (all by itself) work on most systems, but on some only one will work. In partic- ular, Esc is frequently set to open Front Row on most Mac laptops. Each project has it’s own custom auto-completion list, which adds words and phrases to the stock dictionary that is provided. There are two ways to add items to this list: 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.
- 196. 188 CHAPTER 14. WRITING AND EDITING If you would like for Scrivener to suggest custom phrases to you as you type, set “Sug- gest completions as you type” in the Auto-Complete preference tab, 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. 14.10.3 Auto-Completion Scope When using the scriptwriting feature of Scrivener, key words and phrases will often be automatically added to the auto-complete list where appropriate. For example, if you type in the name of a character in the Character element, it will automatically be added to your project’s auto-complete list. By default, these special automatic entries will only be made in reference to the element they came from. A character name, to continue that example, would be defined in the auto-complete list as being applicable only to the Character element type. It will not appear as a suggestion when you are typing in the Scene Heading element. So by and large you will never have to bother with setting anything up here. As you write, Scrivener learns about your script and becomes better at making suggestions to you depending on where you are and what you are typing. If you want to make changes to the scope, this is possible in the Project Auto- Complete List... window. In the Scope column, you can change the element type or assign it to. There are two special settings available: l General: The default when adding your own, or using the contextual menu com- mand to add to the list. When used in a scripting context, any element that does not maintain its own auto-complete list and scoping will have access to it. This is also true for outside of a scripting context. l All (Text & Scripts): Largely the same as General, only these entries will absolutely be available everywhere, even in scripting elements that maintain their own lists. If you open an older project created prior to 2.1, all of your existing phrases will be assigned to the latter option, and so causing them to act as they always have. If you are a scriptwriter, you might want to visit this window and adjust existing phrases so that they act more logically. Compatibility Alert: If you are a scriptwriter that is collaborating with other authors using Scrivener, make sure everyone in the loop is upgraded to 2.1 if you intend to use scoping. Older versions of Scrivener will wipe out the scope assignments when opening the project. Note this is only important if you have spent time fixing your scopes, or want to retain the usage of scoped completion phrases created from that
- 197. 14.11. TEXT BOOKMARKS 189 point on. If you are not scriptwriting, or none of this matters to you terribly, then this compatibility alert does not apply to you. 14.10.4 Binder Title Completion If you have started typing in the name of a title that is found in your binder, you can request a list of completions from Scrivener by pressing a different shortcut, Esc. A list of all the titles that are still candidates for a match will be presented. As with the above, you can use the arrow keys to select and item and hit return to insert the full title. This feature is particularly useful in conjunction with the “wiki style” Scrivener link option. Simply type in [[ start typing in the title name, hit Esc, select a title, and then close with ]]. A Scrivener link will be automatically created for you. 14.10.5 Scriptwriting Auto-Completion Scriptwriting mode engages a more aggressive auto-completion method, which scans as you type and looks for completions, matching the behaviour of most scriptwriting pro- grams on the market. Most of the script formats that are shipped with Scrivener come stocked with many common phrases and abbreviations, which will be contextually tied to the element you are currently working in. For example, “MOMENTS LATER” will appear whilst typing in a Scene Heading element, but will not appear in a Dialogue ele- ment. 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. Since auto-completion cannot reliably determine appropriate letter case, sometimes it may produce results that are undesirable, such as a mixed case location name in a slugline. To remedy this, when selecting the auto-completion you wish to use, hold down the Shift key. Any word or phrase selected with the Shift key held down will complete using uppercase letters. 14.11 Text Bookmarks Text bookmarks are useful when you wish to quickly mark a spot in your text in a way that can be easily recalled later on, or for marking out sections of text in longer docu- ments. There are two types of bookmarks: 1. Bookmark Annotation: This is your standard bookmark. Great for quickly mark- ing a spot for later editing, quick navigation, or whatever you require.
- 198. 190 CHAPTER 14. WRITING AND EDITING 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. Bookmarks work by placing a special marking at the beginning of a paragraph or line, and there are two tools for doing this without disrupting the writing process. Use the Edit Insert Bookmark Annotation menu command, or – B to place the marker at the front of the current paragraph without moving your cursor. Use Edit Insert Bookmark Header Annotation to insert a header style annotation in a similar fashion as a standard annotation. Custom bookmark labels: Bookmarks are simply an inline annotation starting with an asterisk and a space. The first few words of the line following will be used to label the bookmark in the navigation menu. If you wish to provide a custom label, add it to the annotation after the asterisk and the rest of the line will be ignored. The same holds true for header style bookmarks. These use two asterisks and then a space, so to give them a custom label, enter the label into the annotation after these asterisks. In addition to formal bookmarks, any inline annotations that appear on a line by themselves will be added to this menu as well, regardless of whether or not they have an asterisk in front. 14.11.1 Navigating to Bookmarks Once bookmarks have been created, they can be viewed in the header bar icon menu, un- der Bookmarks, or View Text Bookmarks menu. To navigate to a particular bookmark, select it from this menu. When viewing several documents in a Scrivenings session, all of the bookmarks found within the individual documents will be used to populate this menu. To remove a bookmark, simply delete the inline annotation on the respective line. 14.12 Editing Multiple Documents (Scrivenings View) The “Scrivenings” view mode (View Scrivenings) allows you to edit multiple text docu- ments as though they were one long document. This way, you can write in small chunks and then combine them in any way you like to see how they work together. For instance,
- 199. 14.12. EDITING MULTIPLEDOCUMENTS (SCRIVENINGS VIEW) 191 you might write lots of small scenes for a chapter, and then edit them all together in an Scrivenings session to see how the chapter works as a whole. Scrivenings mode is only available when the entire selection (or contents of the selected container) are text or folders. 14.12.1 Viewing Multiple Texts as One Document Scrivenings mode is, like corkboard and outliner view modes, another way to view multi- ple selections of documents. How you view more than one document changes depending on your approach. Viewing more than one document can be as simple as clicking on a folder. By default, this will view the items within that folder as index cards on a cork- board. However using the Group Mode segmented control, you can easily switch your view over to Scrivenings, the left-most icon showing a stack of papers. Another way of switching is to use the View Scrivenings menu command, or pressing – 1 on your key- board. As with corkboard or outliner, you can also form scrivenings sessions by selecting multiple items in the binder, or clicking on the header bar of a collection or search result. Usage Tip: Unlike corkboard and outliner, scrivenings can be taken into composition mode. Simply press the Compose button in the toolbar after setting up the session. Read more about the composition mode (chapter 16) for general information on this feature. You can tell when you are in Scrivenings mode by the horizontal divider lines that will be drawn between each section represented in the session. Meanwhile, 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 document you are cur- rently editing within the session. As you switch from document to document, the inspec- tor will follow along so you can see which document you are in by glancing at the index card in the inspector. Scrivenings sessions are one of the few areas in Scrivener that consider your text from a “flat” perspective. There is no indication of depth while editing documents. A prologue at the very top will be printed right along with items which are buried in sub-folders. This is intentional, so you can concentrate solely on the same flow of text that your readers will use. 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. Additionally, the word and character counter in the footer will count the entire session, making Scriven- ings a great way to quickly view the word count of a particular section of the Binder.
- 200. 192 CHAPTER 14. WRITING AND EDITING 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 tab (section B.8). 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). In that same section you can opt to use a slimmer divider which uses no vertical space to draw itself. This will be of most use to those who must work with accurate page counts in Page View, or simply as an aesthetic preference. 14.12.2 Editing with Scrivenings For the most part, editing in Scrivenings mode is no different than editing a single docu- ment one at a time; most of the tools that you have learned thus far will be available to you. You can select all of the text and format it, copy and paste it to another application, create snapshots of individual portions of the session, and so on. You will not be able to do the following: Due to the manner in which multiple real files are being combined as though they were one “file”, it is not possible to select across a file boundary with the keyboard, or to delete text from across multiple files at once. These limitations are unavoidable. If you were to delete a range of text that spanned two or more documents, Scrivener would have to guess where one document now ended and the other now began—and if the whole of the text of one document had been deleted in the process, Scrivener would have to decide whether to delete that document, too. These are all decisions that are better left to you. Since Scrivenings is a full view mode, it affords a great degree of latitude in how inte- grated it is with the outlining process, especially with a locked editor ( – L). l While editing, new documents can be created with – N, inserting them below the current document that is being edited; likewise with splitting documents. l 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. l Moving documents around in the Binder will automatically update the order in which they appear in the Scrivenings session. l Deleted documents will be removed from the session. l Merging documents from the Binder will make this change in the session
- 201. 14.12. EDITING MULTIPLEDOCUMENTS (SCRIVENINGS VIEW) 193 14.12.3 Useful Tips Navigating with the sidebar navigation buttons If you click one of the navigation buttons (subsection 14.5.4) in the header bar, and that navigation action will result in movement within the boundaries of the active session, you will be navigated from section to section without disturbing the session. If you leave the boundaries of the session, or if the original selection was the result of a non-linear multiple selection, it will be dismissed. Using the Go To menu to navigate While the active split is in Scrivenings mode, the View Go To sub-menu and the duplicate of that menu in the header bar icon menu will display only the contents of the current Scrivenings session. Selecting items from that list will jump you straight to that document like a small table of contents. Selecting only the document you are editing Use – A to select the entire text area for only the document you are actively editing within the session. Standard – A will always select the text of the entire session. Selecting by section is also a useful way to get a quick word count of the active document in the footer bar. Jumping to the end or beginning of a section In conjunction with the above tip, a neat trick for jumping to the very beginning or end of the current section is to select the section with – A, and then use the LeftArrow to jump to the begin- ning, or the RightArrow to jump to the end, as this is standard behaviour for any selection. Isolating the current document If, in the course of editing a scrivenings session, you find you wish to isolate the current document so you can focus on it exclusively, you can simply tap – 4, or use View Go To Editor Selection. To return, you can use View Go To Enclosing Group, or use – R. 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 together 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.
- 202. 194 CHAPTER 14. WRITING AND EDITING Vertically accurate scrivenings divider If for reasons of taste, or formatting necessity, you require a zero-height scrivenings divider, you can toggle on a slim mode in the Formatting preference tab (subsection B.8.3). This mode will draw small “crop marks” in the margins instead of using a divider across the middle. If vertical ac- curacy is a necessity, you will also want to avoid usage of titles in the scrivenings session. When in slim mode, the height of the page should be preserved for pur- poses of rough preview with the Page View editing mode. Viewing only items which can be compiled By filtering items in views (section 9.9), you can create a Scrivenings session that includes only items which can be compiled with a single click. This can be exceptionally useful if you tend to write notes into your drafting area, and set those notes to not be included in the compile. To use this feature, Option-click on the container (including a Collection or Hoist header bar) you wish to filter, or with a selection of items, use the Documents Open with Compilable Subdocuments menu command.
- 203. Chapter 15 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, which can be configured to display two opposing pages at once, with View Page View Two Pages Across, however since Scrivener does not keep track of actual pages, this should not be relied upon as a full-spread layout preview, as the even/odd arrangement you see in the editor might very well end up being swapped in the final product. In fact, 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. In some cases, especially where the compiled product will look identical to the formatting you see in the editor, it can be used as a fairly accurate gauge of writing progress in terms of literal pages. Read on for tips on the best ways to set up this feature for this style of working. Editing in Page View is otherwise identical to use the standard drafting style editor in all ways, and will work with Scrivenings mode, too. 15.1 Setting Page View Dimensions To have this feature place your text in a to-scale representation of your print and margin setting, use the View Page View Use Printed Page Size option. You may select whether or not this means the Page Setup settings for the entire project, or the specific page and margin settings you are using in the compiler (which might be the same). The option to use “Preferences Page Size” lets you set up a page of any dimension, which could be as exotic as index card sized blocks, or long narrow strips of “paper”, or more simply to optimise the appearance for your screen dimensions, so long as you do not require it to have any bearing on accuracy. For full details on the available settings, read further on the Editor preferences tab (section B.7). 195
- 204. 196 CHAPTER 15. PAGE VIEW 15.2 Tips for Accuracy When used in conjunction with export fonts, 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 numbering 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 “Separate with single line breaks” option in the Formatting preferences tab (subsection B.8.3). 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 the titling feature in scrivenings should also be avoided as they will add extra height that likely will not be in the final composite.
- 205. Chapter 16 Composition Mode Composition mode allows you to edit your text in a distraction-free environment. You can view any text document (or Scrivenings session) in a composition mode akin to what many so-called “zenware” applications provide, 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 composition mode. Menu commands that would otherwise be available are turned off—in most cases because these are commands which would have no meaning at all, such as commands for merging two selected items in the binder, or enabling vorkboard view. To determine what will be loaded into composition, Scrivener uses the active selection. This selection can be made either in the sidebar, or in an outliner or corkboard view. This works by implication as well: when no cards are selected in a corkboard, technically the container is selected, as can be witnessed in the inspector, and so it is the container’s text itself that will be loaded in composition, which might often be blank. There are two exceptions to this rule: 1. View as Scrivenings: If you are viewing a group of documents in Scrivenings mode, then composition mode will use that same mode. This is the easiest way to load an entire container’s text into composition mode, as it requires no further selection. 2. Pre-load documents into history: If multiple items are selected and Scrivenings mode is not enabled, then each item will be loaded into the composition mode’s history queue. Working in this fashion, you can use – [ and – ] to flip between the docu- ments without returning to the main project window. Launch composition mode either by hitting – F, or select View Enter Composition Mode. When you first enter composition mode, you will see your document in the middle of the screen set to a pinkish-grey paper colour, and masking the rest of the screen, a black background. Nearly every aspect of this experience can be changed, some right within composition mode. You will also briefly see the Control Strip (detailed below). 197
- 206. 198 CHAPTER 16. COMPOSITION MODE To retrieve it, slide the mouse pointer down to the bottom of the screen and let it sit for a moment. So long as the mouse remains within the control strip, it will stay visible. Once moved back up, the control strip will disappear out of view. 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 composition mode. 16.1 Using Background Image and Textures You can replace the default solid background colour with an image of your choosing, by accessing the View Composition Backdrop menu. The image will be scaled to fit your screen using the maximum height or width, whichever is better. This can mean that if the image does not match your screen’s aspect ratio, the background colour may still be visible along the sides or top and bottom. Textures can be assigned to either the background area, or the paper area behind the text. Textures are graphic files you select which will be tiled to fill the entire visible area, and are thus useful for simulating real paper. Textures can be configured in the Appearance preference tab (section B.3). 16.2 The Control Strip The composition control strip contains various controls for manipulating the interface elements available to composition mode. All of these settings operate on a project-by- project basis, as opposed to the global scope of the application preferences. It is possible to leave the control strip open perpetually, by leaving the mouse at the bottom of the screen. If you wish to keep track of your word count, or are working in script mode, this can be a handy way to keep tabs on your status. If you do so, you may wish to set the paper height (detailed below), so that the bottom of the page does not fall below the controls. In order from left to right: Text scale This operates in an identical fashion to the text scale zoom in the standard editor. The only difference is that composition mode stores its own scale setting, independent of the editor splits. Paper Position Select where the “paper” (the column of text) should be anchored on the screen: on the left, in the centre or on the right. You may want it in a non-central
- 207. 16.2. THE CONTROLSTRIP 199 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 Project Keywords (section 10.2) which you can use in conjunction with the inspector (below) to assign keywords to the current docu- ment. Inspector Brings up the floating Inspector panel (see below). Dynamic Controls & Statistics The middle portion of the control strip changes de- pending upon your editing mode. In standard editing mode, this will display the 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 strip will display element hints as well as the element selection menu (which you can always call up with – Y, even if the strip is not visible). Background Fade Fades the background (everything outside of the text paper column) in and out. Useful if you want to refer to material in other applications open in the background whilst remaining in composition mode. Paper Fade When a backdrop image is in use, the “Background Fade” slider will be re- placed with this one, which operates in an identical fashion, only it lets you blend the paper colour with the backdrop, or reduce its visibility entirely. When both a background texture or backdrop and a paper texture are in use, this slider will be entirely disabled. Exit Composition Mode The button at the far right will exit composition mode. You may also press the Esc key, or – F to return to the main project window.
- 208. 200 CHAPTER 16. COMPOSITION MODE 16.3 Full Screen Inspector HUD The composition mode version of the inspector gives you near full access to the inspector data which will float over the editor so it doesn’t get hidden behind the background. Use the top-drop down menu to access the different data views. Label and Status will always be visible at the bottom of this window. For a full discussion on these views and what they represent, read Meta-Data Types (section 10.1), and Inspector (chapter 18). The top selection drop-down will provide you with the following options: l Synopsis l Picture: If a photograph has been attached to the index card, you can view it with this option. l Document Notes l Project Notes: If you have created additional document notepads, they will all be listed here. l Keywords l References l Comments & Footnotes Each of the individual panes will be provided with a full complement of editing con- trols, so you can add and remove items from these lists, just as you would with the stan- dard inspector. 16.4 Customising Full Screen Appearance Appearance settings can be set in the Compose preference tab (section B.5). Refer to the documentation provided for this pane for greater detail on available options. Due to limitations in the OS X text system, it is not possible to temporarily override the font family in composition mode. The text colour can be overridden, but changing the font would require an irreversible adjustment to your formatting. 16.5 Composition Mode with Multiple Displays When using two monitors, you can configure Scrivener to use the secondary display as the composition window instead of the primary display. This can be adjusted in prefer- ences.
- 209. 16.5. COMPOSITION MODEWITH MULTIPLE DISPLAYS 201 Also, if you don’t mind taking a performance hit, you can choose to leave the main Scrivener interface open on the primary display. When doing so, Option-clicking on text or folder items in the Binder will load these items into your live composition session. As with the standard editor, using the Command and Shift keys will select multiple docu- ments and form a Scrivenings session. To utilise this in the active composition window, just add the Option key to these modifier keys.
- 210. Chapter 17 Annotations and Footnotes As a tool designed for the production of texts, there are many methods for facilitating not only the writing process, but the editing process, and the “public notation” process which is typically expressed via some form of page or section footnote, or endnote at the conclusion of the work. This chapter will cover all of the various methods that Scrivener provides. We will cover: l Annotation and Commentary: the ability to place production notes within the document, making it easy to communicate changes or needs to yourself, collab- orators, your editor, or to receive the communications from others. Scrivener supports the RTF standards for commentary, and will convert any word proces- sor applied notes to your preferred notation style, which can be configured in the Import & Export preference tab (section B.10). l Footnotes and/or Endnotes: being a drafting tool, Scrivener makes no attempt to typeset either of these as you write, however it is easy to insert notes precisely where you need them, and when you compile they will presented according to your exacting demands. As with comments, RTF standards are supported and incoming notes will be converted to your preferred notation style. Scrivener supports two note streams, allowing you to output both footnotes and endnotes, if required. In the case where highly specific formatting is required, it may be advantageous to use a citation manager that can scan an RTF and produce a bibliography for you (section 20.5). l Text colours and Highlighters: to aid in increasing the visibility of passages, you are provided with an extensive complement of tools for highlighting and marking your text in colour. l 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 (or yourself) know what you have changed and vice versa. 202
- 211. 203 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 20.1.5) makes it easy to quickly step through your draft, point by point, isolating and addressing issues or reviewing changes that you’ve made. 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 notation, which are added directly to your text, and linked notation, 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: l Inline notes are always visible in your text; there is no way to diminish their promi- nence. 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. l 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. l 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. l Linked notes can act like bookmarks. Clicking on them in the inspector will whisk you right to the spot in the text where they are anchored. l Inline notes can be placed anywhere you like (especially annotations), even in be- tween 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. l Linked notes can be easily viewed together in a collected interface no matter how far apart they are physically spread apart. This becomes especially advantageous in a Scrivenings session. A note on page 50 has the same prominence as a note on page 1.
- 212. 204 CHAPTER 17. ANNOTATIONS AND FOOTNOTES l 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. l Linked notes can be easily copied and pasted as regular text into any editor. Sim- ple 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 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. l Inline notes exist around your text and do not depend upon it to exist. This means you can edit the text that the note refers to freely, without worrying about losing your comments. This is in opposition to linked notes, which are anchored to the text—if the text is removed or entirely altered, the note will be deleted. By corol- lary, 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 individual 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 few sections will address each of these types in more depth. 17.1 Inline Notation Scrivener has long sported a unique method for taking notes and indicating footnotes, by placing them directly into the main text stream itself. It mimics the natural annotation process that one applies when working with paper, where notes are scribbled below the problem lines themselves, into margins, or anywhere else they will fit in. It means your notes remain prominent and easy to find so long as they remain issues worthy of atten- tion. The same treatment can be given to footnotes as well. Keeping the actual text of the footnote directly in-line with the text it augments can increase productivity and help keep your meta-book relevant and cohesive. Further advantages are in entry speed. Since notation is done directly in the text while you are typing or editing, it is easy to flow
- 213. 17.1. INLINE NOTATION 205 from “editor” to “writer” without disrupting the process with floating windows, margin bubbles, or the many other mechanisms that applications use to attach notes. Despite the advantages, there are still cases and tastes which would prefer to keep no- tation out of the main text area. If you have interest in commenting on your work or adding footnotes to it without adding text to the main editing area, please skip down to Linked Notation (section 17.2). What They Are: Inline notation is fundamentally a form of formatting, just like any other formatting spans in your document, such as bold or italic. Yes, Scrivener has tools for working with notations in unique ways, but they will respond to many 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 notations, try to think of them as analogous to bold text. To paste some external text into a note, you’ll need to use Paste and Match Style for the text to acquire the notation 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. How you interface with inline annotations and footnotes is identical at the writing phase. Since inline notation works just like ordinary formatting, creating a note or foot- note from existing text is 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 annotation, 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; just 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 is placed in the editor. 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. 17.1.1 Inline Annotations Annotated text will appear red with a “bubble” around it, by default. You can change the colour by placing the cursor anywhere within it and using the colours palette, which is toggled via Format Font Show Colors, or – C. On a per project basis, Scrivener will remember the last colour you chose and use it for the next new note you create. To
- 214. 206 CHAPTER 17. ANNOTATIONS AND FOOTNOTES split an annotation into two pieces, select the portion you wish to split off and assign it a different colour. To ensure your text exports as expected, you must check that the text surrounding your annotation would make sense were the annotation not present, including how you set out your whitespace (spaces, newlines etc). In other words, if you place an annota- tion between two sentences, make sure that there is only one space (or two if you use two spaces between sentences) separating the sentences outside of the annotation. On the other hand, when you choose to compile annotations into the document inline, all spacing within the annotation will be preserved; the end result will look like it does in the main editor. Since you can choose to omit annotations from the text when you export or print it, 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 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 compatible word processors, rather than omitted, if you wish. For details on what op- tions are available for omission or conversion during compile, see Footnotes/Comments (section 23.16). While it is possible to use annotations to create footnotes, this compile-time conversion 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 annotations 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 export 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. 17.1.2 Inline Footnotes The creation of inline footnotes is quite similar to annotations, and really in most ways, footnotes act identically to annotations. The main difference lies in the fact that anno-
- 215. 17.1. INLINE NOTATION 207 tations are meant to be omitted upon export or print-outs (though do not have to be) whilst footnotes become “real” footnotes upon export, and thus have more options avail- able to them for styling footnotes, particularly with the RTF format option. Visually, the difference is that footnotes are not coloured but are surrounded with a black bubble and have a grey background. Formatting Footnotes: Unlike annotations, any whitespace on the front or back of the text will be stripped out. This allows you to insert “buffer space” around the foot- note and help set it apart from the regular text. As with annotations, the placement of the bubble is important in that the text around it should flow sensibly, but with footnotes you also need to take into account that if the bubble were collapsed, that is where the footnote reference mark would be. Try to visualise the entire bubble as a single number, and this will help you with placement. 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 text in Scrivener is exported to RTF format, and opened in a compliant word proces- sor, 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 vari- ety of fashions for other formats as well, such as eBooks, MultiMarkdown syntax (and therefore as proper footnotes in LTEX), as look-alike footnotes in HTML and plain-text, A amongst others. For all options available, read Footnotes/Comments (section 23.16). 17.1.3 Referenced Inline Footnotes 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. If, however, you like inline footnotes but would still like to keep the bulk of the notes outside of the main text body area, there is a method you can employ which works in a referencing manner. To use this method, place a footnote in the intended location within the text body, and type in a unique reference keyword surrounded by square brackets. An example of this might look like this: [Reference]. Now somewhere else in the same document, place the full content of the footnote and make sure to place that same bracketed reference in its content area. For the above example, this could look like: [Reference] Here is the text of the footnote as it will appear in the final manuscript. When compiled, Scrivener will match the two footnote ranges together by their bracket reference, remove the bracketed segment entirely, and shift the content so that it
- 216. 208 CHAPTER 17. ANNOTATIONS AND FOOTNOTES is defined in the location of the original anchor. Make sure the anchor and the text are both located in the same document, are both defined with an inline footnote range, and that each document has one unique reference pair. You can use the same reference pairs in other documents within the same draft compile, they only need to be unique within the same section. 17.1.4 Inline Annotations and MultiMarkdown Since inline annotations are embedded right in your text, this makes them exceptional as a form of marking blocks of text for special typesetting or other purposes. A good example is this manual that you are reading now. Periodically you may see a “tip box”, a portion of text set apart from the rest of the text with a thick black border on the left. This is a special typesetting block that has been defined in the MMD export engine for this book, and is triggered by setting an annotation in Scrivener, prefixed with the term, “TIPBOX:”. While linked comments can be used to achieve a similar result, they are in general less flexible for advanced purposes. 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. Inline annotations placed in their own paragraph(s) will be exported as divs, while annotations that flow into standard text paragraphs will use spans, with br HTML elements to mark paragraph breaks. If you intend to use complex MMD into an annota- tion block, you will need to make sure it is in its own block away from any standard text paragraphs. For more details on how to set up your own typesetting blocks, read Functional An- notations and Comments (section 26.1). 17.1.5 Finding Inline Notation Scrivener provides tools for stepping through your entire project, searching for anno- tations and footnotes. Read more about this feature in Find by Format and Text (sec- tion 20.1.5). 17.2 Linked Notation Creating and reviewing linked notation is made very simple with Scrivener’s innovative sidebar approach. Unlike methods which use positional margin areas to display the note, or typesetting driven methods which attempt to display a footnote exactly as it will ap- pear in print, linked notes give you the power of placing meta text outside of the base
- 217. 17.2. LINKED NOTATION 209 text, while presenting this information in a “stack” which, while ordered as they appear in the document, does not other reflect the spatial distance between notes. This means a footnote on page 12 will appear right alongside a footnote on page 27. This stacking method makes it easy for you to see all of your notes at once, and by clicking on individ- ual notes in the stack, jumping straight to that portion in the text. Individual notes can be collapsed, so if one note is quite long, it doesn’t monopolise the space. Best of all, they will all be stacked together indiscriminately, but in order, when viewing a larger portion of text in a Scrivenings session. Meanwhile, the “anchor point” in the text where the note is attached will be drawn using one of three methods: 1. For comments, a prominent coloured rectangle around the word, making it easy to spot the location of notes as you scroll through your text 2. For footnotes, a grey rectangle around the word or phrase, giving a distinctive advantage over hunting for small superscript numbers in a word processor. 3. Alternatively, for footnotes, affixed after the word or phrase as a symbol or marker. This approach more closely mimics how a word processor presents footnotes and endnotes. It can be a useful alternative when the original text is densely covered with references. Clicking on any anchor highlight will highlight that comment in the inspector, open- ing it if necessary to do so. You can also hover over a highlight, and the note text will appear in a tooltip. There are three other places notes will be positioned: 1. In QuickReference panels, comments and footnotes will be placed into a split view below the main text editor within the panel. 2. In composition mode, comments and footnotes have a dedicate pane in the 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. To use linked notes you must in most cases have anchor text to attach the note to, in the same way you need some text to create a hyperlink with. Often this will 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.
- 218. 210 CHAPTER 17. ANNOTATIONS AND FOOTNOTES To create a new note, either: 1. Select the text you wish to notate and then invoke the appropriate menu command or keyboard shortcut. 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 immediately 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 text. 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 type 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 text 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. 17.2.1 Managing Linked Notes Deleting notes can be accomplished by selecting the note(s) in the inspector and then clicking the - button; by clicking the small X button in the top-right of each note; or by simply deleting the text that the note is anchored to, in the editor. To move a note from one text anchor to another, select the text in the main text editor that 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
- 219. 17.2. LINKED NOTATION 211 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. 17.2.2 Linked Comments Linked comments, as with inline annotations, can be assigned a custom colour. By de- fault, when you use one of the previously mentioned techniques for adding a note, the highlighter anchor box in your text will be yellow, as will the corresponding note in the inspector. These two colours will always match, making it easier to see where you are in your text in relation with your notes. To change the colour of a note, a convenience tool has been designed into the right- click contextual menu when clicking on the note in the inspector. Six default colours have been provided for rapid usage, but you can also opt to use the colour palette to change the colour to a custom selection. This can be done either by selecting the note and pressing – C as per normal, or selecting Show Colors from the contextual menu. You can adjust the colour of many comments at once by selecting more than one before opening the colour palette, or right-clicking on any of the selected notes. Scrivener will also remember the last colour you chose and automatically use it for the next new note that you create. This is remembered across all projects, and will be persistent until you specifically choose a new colour. As with inline annotations, the primary usage for comments will be to add meta com- mentary to your text; commentary that isn’t intended to appear in the final cut. However it is possible to adjust this behaviour in the compiler, and even opt to compile comments as footnotes. Read Footnotes/Comments (section 23.16) for further details on available options. 17.2.3 Linked Footnotes As with inline footnotes, linked footnotes will by default appear with a grey background, and will likewise appear grey in the inspector. Footnote colours cannot be individually changed, though you can adjust the global application default for footnote presentation in the Appearance preference tab (subsection B.3.6). Unlike comments, the positioning of the anchor point in the text is important, as it will be used to place the reference mark in your final text once you compile. The positioning point is at the end of the anchor highlight area, not the beginning. So if you wish to place a note at the end of a sentence, you would highlight the last word of that sentence. This will be done for you automatically if you place the caret anywhere in that word or at the end of the word, and create a footnote.
- 220. 212 CHAPTER 17. ANNOTATIONS AND FOOTNOTES There is an alternate form of usage which you may prefer to use if you find the default appearance too heavy for the quantity of footnotes in use. This method will place the footnote marker after the current selection, or current word, rather than highlighting them. What Scrivener uses for a marker can be customised, but by default it uses an asterisk. To enable this method of working, visit Project Text Preferences..., and enable the “Use footnote marker” option toward the bottom. When compiling, the system will scan the contents of the footnote link anchor, and if contains this supplied marker and nothing else, it will remove the placeholder text from the compiled manuscript. Take care to select one marker and use it consistently from that point hence. If you switch markers halfway through your project, or turn this feature off, the mismatching markers will appear in your final draft. Marker text can be changed by hand in the editor, so if you need to switch styles, you’ll need to settle the differences using the editing tools. The Make Default button can be used to force this setting to all of your projects, even those that were not using it before, or had their own custom markers assigned. Again, make sure you have not already invested in a particular marker style before clicking this button. See Inline Footnotes (subsection 17.1.2) for general tips on footnotes in Scrivener. 17.2.4 Finding Linked Notations Scrivener provides tools for stepping through your entire project, searching for inspector comments and footnotes. Read more about this feature in Find by Format and Text (section 20.1.5). 17.3 General Usage Tips for Notation 17.3.1 Stripping Out All Notation If you wish to strip out all (inline and linked) notes from a text at once, this can be easily done by copying the text with Edit Copy Special Copy Without Comments or Footnotes, or – C, and then pasting directly over the copied text. Do note this will also destroy footnotes, so use this command with care. 17.3.2 Referring to Compiled Numbering When producing compiled documents for your own proofing, or when coordinating proofing and editing with others, it can often be useful to be able to reference footnote and endnote numbering from within Scrivener. When you compile, all of your dynamic
- 221. 17.3. GENERAL USAGETIPS FOR NOTATION 213 notes will be turned into the appropriate styling in word processors, including number- ing. Scrivener will by default save these numerical assignments and display them in the Inspector pane. These numbers will remain static. If you change the order of your outline, or add and remove footnotes, the numbers in the Inspector will not change dynamically as they do in a word processor. This way you can maintain a hard link with the currently distributed compilation, and when you receive notes from your peers regarding notes of such and such a number, can use Scrivener’s Inspector pane to find those numbers, even if you’ve done extensive editing which would have otherwise altered those numbers. Once you do compile, the numbers will be reset again. This might not always be de- sirable. To give a simple example, you might want to run off some personal compilations after distributing a proof, but if you’ve changed the order of things then your static num- bering reference will no longer be in sync with the copy that is out for proof. In cases like this, you’ll want to enable the Format Options Prompt Before Updating Footnote Numbers menu option. At the conclusion of the compilation, a pop-up warning will ap- pear and ask if you’d like to have the new numbering pressed into the Inspector from this point on. If you click no, the numbers will remain in sync from the last time you clicked yes (or the last time you compiled without this option on, naturally). If inline footnotes and linked footnotes are both set to output into the same stream (either both footnotes or endnotes), then the inline footnotes will be calculated into the numbering—but since there is nowhere to display meta-data for the footnote, the number of that inline footnote itself will not be displayed anywhere. The numbering of the linked footnotes around it will however jump over it, maintaining the accuracy of the count. Using this method, you can discern the number of an inline footnote by looking at the linked notes around it. Additionally, with the RTF format you can also specify that linked comments also be exported as footnotes or endnotes. When this option is in play, numbering will take them into account as well. For obvious reasons, there are a few caveats when using this feature: l Notes must be compiled as sequential. If you are using settings which reset the numbering per page l If you turn off numbering in the Inspector (via the Format Options Hide Com- pile Footnote Numbers in Inspector) then numbers will not be updated when you compile. This can be useful for freezing the current numbering without having to answer to pop-up message after every compile.
- 222. 214 CHAPTER 17. ANNOTATIONS AND FOOTNOTES l For the purposes of recalculation, the compiler will consider all documents in the Draft (though it will only count those that are being exported). This way, if an item at one point had numbered references within it, and was later excluded, those numbers would be removed from the Inspector. l When the compile group has been set to a Collection or to use the current Selec- tion, if it also contains any items not in the Draft, then footnote renumbering will simply be skipped to avoid confusing situations. Ensure that your compilation Collections contain only Draft items, if you intend to use this feature on a regular basis. l Numbering will always use Arabic numerals, even if the compiler was set to use another numbering scheme for the actual notes. If you intend to use this feature for referencing out to proofs, you might consider leaving your numbering set to Arabic during this portion of the process. Not all documents in the project are considered. Use this to your advantage. If you want to make a hard copy of your reference numbering available into the indefinite fu- ture, you could create a duplicate of the entire Draft (or the portions you wish to pre- serve) into the main area of the Binder. Once there these numbers will never be removed by the compiler and so will always be visible and left as they had been when these files were last in use. Be wary of situations where you often compile off of a Saved Collection as this duplicate Draft might very well have items which match the Collection’s criteria, triggering the case above where Collections of mixed Draft/non-Draft items will forgo re-numbering. If the Saved Collection is primarily intended for producing Draft compile groups, consider limiting its search scope to “Search Draft Only”. This could cause confusion in cases where these items are dragged in whole or in part back into the Draft, as duplicate numbers would be an issue until numbering is reset. 17.3.3 Resetting Linked Note Formatting Both comments and footnotes allow formatted text within them. This means you can ap- ply whatever formatting you wish into these, and they will be exported with this format- ting when you compile. Consequently, adjust the Formatting preferences (section B.8) for notes will not immediately impact them, as this might wipe out your formatting. You can however, just as with documents, reset the formatting to the application default by right-clicking on selected notes and choosing Convert to Default Formatting.
- 223. 17.3. GENERAL USAGETIPS FOR NOTATION 215 17.3.4 Exporting Annotations and Comments You can export all of the inline annotations and linked comments in your project into an RTF file with File Export Comments & Annotations. Optionally, you can restrict this down to the selected items in the sidebar, rather than the entire project. You can also choose to export titles along with the comments, making it easier to find where they came from. 17.3.5 Notation with Copy and Paste Within Scrivener, you can copy or cut, and paste ranges of text that contain any style of notation, and it will be carried along with the selection. This can even be done in between projects. When pasting into other programs, however, the footnotes and comments will be con- verted to several styles that the receiving program can choose from. For word processors, most will select RTF formatting. Thus, to get the most benefit from pasting, you should use applications that can read RTF formatting. A good rule of thumb is, if it can import footnotes and comments, they will work with copy and paste, too. Pasting into many other applications will produce a different result, as most do not sup- port either footnotes or comments. In this case they will use RTFD formatting, which is a “flattened” version that looks like footnotes and inline commentary, 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 tab (subsection B.10.2). 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 provided. 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 Spe- cial Copy Without Comments and Footnotes, or – C.
- 224. 216 CHAPTER 17. ANNOTATIONS AND FOOTNOTES 17.3.6 Links, Notes, and Tables Inline notation supports the ability to create Scrivener Links within them. They will function as per normal, and this is a handy way to “hide” link text from the final manuscript. Due to how linked notes work, it is not possible to create links within them. Consequently, if you convert your inline notes to linked notes, you will lose any Scrivener Links that had been set within them. Tables and notes do not mix well together as features, and is something we are working to improve. In the meantime, when compiling a manuscript that contains comments or footnotes within a table cell, the notes will be stripped out of the table. If you need to notate table cell data, it is possible to override this behaviour. You will need to use a hidden preference (section D.4) to do so. Table formatting will likely break with this option on, so be aware that although this will preserve your notes, you will need to clean up the tables in a word processor after you compile. 17.4 Text Colour and Highlights Arbitrary text colour can be applied to your document in a fashion similar to any other formatting range. Select the text you wish to change the colour on, and either use For- mat Font Show Colors ( – C), or use the text colour selector in the Format Bar (sub- section 14.4.2) to set the colour. The format bar will remember the last colour you have used, so it easy to rapidly apply the same colour to multiple text selections with a single click. It will also pick up a colour when you click on text that has already been coloured. If you wish to change the colour, right-click on the colour chip or click and hold. A pop-over will appear with the following contents: 1. The built-in presets (black, red, etc.) 2. Common swatches (the first swatch with a red line drawn through is “remove colour” choosing this one will erase any colour in the selection and return the text to default) 3. If applicable, any custom swatches will appear in a separate grid below the main grid 4. Show Colors (access to the colour palette) 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; the names should be considered conveniences, not identifiers.
- 225. 17.4. TEXT COLOURAND HIGHLIGHTS 217 Setting a highlight to a range of text is quite similar, only you will use the second colour chip on the format bar, instead. As with the text colour control, single-clicking once will re-use the last highlighter colour, and holding the button down or right-clicking will ac- cess 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. Scrivener will remember the last highlighter colour used from that point on, even in other projects. The contents of the highlight menu will be divided into four main sections: 1. Remove Color 2. Built-in presets (black, red, etc.) 3. Custom swatches 4. Show Colors (accesses the colour palette so you can select a custom colour) Colours and Compiling: By default, text colours and highlights will be compiled into your final manuscript. If you use these features for internal editing, you will find options for disabling them in the Transformations compile pane (section 23.12). Not all word processors support text colour and highlighting features. 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 (sec- tion 20.1.5). 17.4.1 Naming Text Highlights The default text highlight marker names can be changed to something less generic, on a universal level, by using colour palette swatch groups. Swatch groups are OS X’s way of letting you create selections of colours and giving them useful names. To change the highlighter colours, show the Color Palette ( – C), and select the third icon from the left. Next, from the “Palettes” drop-down menu, select the group titled, “Scrivener”. You should now see something resembling the above screenshot. Mac App Store Note: It is not possible to install the custom Scrivener colour swatch group using the version of Scrivener for the Mac App Store. The Scrivener group will still show up in the palette, but any changes you make to it will be lost after you restart the program. To make permanent changes, you’ll need to create your own
- 226. 218 CHAPTER 17. ANNOTATIONS AND FOOTNOTES Figure 17.1: Scrivener swatch set
- 227. 17.5. MARKING REVISIONS 219 group called “Scrivener Custom”. The best way to do this is to rename the Scrivener set to “Scrivener Custom”, using the gear menu to the right of the palette selection menu. This will create a persistent colour swatch group for you, preloaded with all of Scrivener’s built-in colours. Double-click on any of the provided highlights to rename it. Your changes should be visible immediately in the Scrivener interface, where applicable. Your own colours can be added to any of Scrivener’s various colour selection menus, as well. If necessary, click and drag downward in the location marked above, “Custom colour shelf”. You should see a row of white squares appear. You can drag out as many rows as you like. The easiest way to create new custom colours is to use either the colour wheel (first icon) or the sliders (second icon). When you find a hue that you’d like to use as a high- light, text colour, or annotation colour, drag from the large colour preview area at the top of the pane, and drop into one of the empty slots in the custom shelf. If you check one of Scrivener’s colour menus right now, you’ll see that it has already been added below the base sets. To change the name of your custom colour, click on 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, under 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 Scrivener uses a basic technique for making revisions visibly distinctive from one another and the base text. At its core, the feature is simply a formalised method for apply text colour as you type. The formal nature of this is in both the selection of the tool, rather than picking some arbitrary colour from the Format Bar, and a collection of tools for working with that particular colour at a later time. Whenever a revision level has been enabled in a project, it will impact all primary editor views where text editing is possible (it will not impact notes or other ancillary
- 228. 220 CHAPTER 17. ANNOTATIONS AND FOOTNOTES Figure 17.2: Custom named colours
- 229. 17.5. MARKING REVISIONS 221 fields). The cursor colour will be changed to that colour, to remind you of this fact, before you start typing. In addition to colour the text as you type, usage of the strikethrough format will colour the strike-out in accordance with the revision level, too. Limitations: Revision levels are not to be considered equivalent to “track changes”, as seen in version controlled software, or Microsoft Word. They are very simple, low bandwidth tools, that only mark modified or new text. Removed text will not be marked in any way. If you wish to track all changes between a document and its revised state, take a look at the snapshot feature (section 14.9). Stricken text, while it will display the revision level from when strikeout was used, will need to be manually removed later on. 17.5.1 Setting a Revision Level There are five revision levels available, and each are accessible in the Format Revision Mode sub-menu. Simply click on the coloured menu command you wish to use as your revision mode, and begin editing the document. As you type in new text, it will be automatically coloured with the revision level, as if you had typed it in and then selected it, and applied a text colour with the Format Bar. If you wish to paste text into the editor using the revision colour, use Edit Paste and Match Style. Selecting the same colour from this menu again will toggle the revision marking system off. This can be especially useful if you bind these colours to keyboard shortcuts, using your Mac OS X custom keyboard shortcuts. If, for example, you bind Ctrl-2 to level two, then you can tap that shortcut again to return to standard editing. 17.5.2 Marking Existing Text There are times when you may wish to mark existing text with a revision level. To do so you must already have a revision level set, then select the text you wish to mark, and use the Format Revision Mode Mark Revised menu command. This menu command will only appear when active text has been selected, so if you do not see it, ensure that the text you have selected is in the active editor. 17.5.3 Removing a Revision Level Once you have reviewed a document’s revisions, you will probably wish to remove the revision markings from that document. This can be very easily done by selecting the ap- propriate revision level from the menu, and then without selecting any text, use the For- mat 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 mul- tiple documents in Scrivenings, ensure you wish to wipe out markings for all visible
- 230. 222 CHAPTER 17. ANNOTATIONS AND FOOTNOTES 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 selection 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. 17.5.4 Removing all Revision Markings When you’ve reviewed all revisions are are ready to return the document to a default colour state, you can use Format Revision Mode Remove All Revisions to strip out all revision level markings in the active text session. The same warning from above applies: this will impact all documents in a Scrivenings session. Likewise, the same warning about overlapping colour usage applies as well: any colours matching any of the revision levels will be stripped from the documents. 17.5.5 Changing the Revision Colours It is possible to change Scrivener’s associations for which colours are which levels. These can be configured in the Appearance preference tab (subsection B.3.6), in the Revision Colors tree of the Customize Colors section. Once changed, Scrivener will no longer associate existing coloured text as being a part of a revision, even if a revision mode was used to apply that text in the past. In particular, the tools for stripping out revision colours will cease to work on documents marked up with the original colour scheme, and the tool for finding revision markings (below) will no longer uncover these markings. It is thus advisable to not touch these settings if you intend to use revision markings in a collaborative environment. If multiple authors are using different preferences, none of the special tools for working with these modes will function correctly. Either establish a standard set of colours between all involved parties, or agree to use the defaults. 17.5.6 Finding Revision Markings Scrivener provides tools for stepping through your entire project, searching for revision levels. Read more about this feature in Find by Format and Text (section 20.1.5).
- 231. 17.6. TEXT MARKINGSAND MULTIMARKDOWN 223 17.6 Text Markings and MultiMarkdown Since MultiMarkdown has scant tools for working with text formatting, many of the above marking techniques have no direct analogue, with the exception of footnotes. In the case of annotations and comments, it is possible to use embedded XHTML coding to simulate comments, and they will be marked in such a way that it is easy to get both the colour information and the fact that they are comments, from an XSLT stylesheet. In fact, the default MMD XSLTs have been designed to work with Scrivener’s annotation format in a simple way. Other markings, such as text colour, highlighting, and revision levels, will be completely dropped from the compile. 17.6.1 Using Comments with MultiMarkdown Both inline annotations and inspector comments work very similarly when compiling with MultiMarkdown. Both can be independently stripped from the document during compile, making it possible to leave one as “functional” and the other style as pure com- mentary. Since there is no directly analogue for comments1 , Scrivener employs the usage of MMD’s ability to handle raw XHTML coding in the document. When using MMD, it has always been possible to pass XHTML through the parsing engine so that it lands directly in the XHTML document, either in its transitive state toward another format, or as a final product. This behaviour can be disabled in the compile settings, and comments will be passed through to the document in the same manner that they are using the plain-text export, wrapped in square brackets. For advanced usage tips on using comments and annotations in a functional capacity, as a way of dynamically expanding MMD’s base syntax, read Functional Annotations and Comments (section 26.1). 17.6.2 Using Footnotes with MultiMarkdown When compiling a draft using MultiMarkdown, the compiler can be instructed to pro- duce proper footnote syntax for all of your inline and linked footnotes in the project. This will be done using MMD’s referencing syntax, where a footnote reference is placed at the point of the note in the text, and the content of that note is placed at the bottom 1 While it is true, MMD uses XHTML, and XHTML has a perfectly valid syntax for comments, it is not viable to use it because MMD already has an advanced secondary usage for XHTML comments, in that raw LTEXcan be passed directly through the parsing engine and land in the final .tex file. Thus, usage of the A XHTML comment engine for general comments or other purposes would cause undesirable side-effects.
- 232. 224 CHAPTER 17. ANNOTATIONS AND FOOTNOTES of the file with a link to that reference marker. Scrivener will general all of the refer- ence tokens for you, making it exceptionally easy to do this. Unlike with a standard text editor, you don’t have to worry about coming up with unique 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 function in the compiler, under the Footnotes/Comments pane, by checking off the “Remove 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 26.2). 17.6.3 Text and Highlight Colour with MultiMarkdown In short, nothing is done to export Scrivener’s text colour (including revision levels, which are just a formalised way of using text colour) and highlighting features to Multi- Markdown, as there is no suitable analogue for these tools, and in most cases since they represent a function of a document’s meta commentary, are not considered to be suitable for semantic transfer. If there are cases where you would like to use colour in your com- piled documents, you might wish to take a look at advanced inline annotations, above. Rather than looking at this as a limitation, you can consider it to be a feature. As with most purely rich text features in Scrivener, they can be used liberally to annotate and comment upon your work, without fear of them every showing up in the final product.
- 233. Chapter 18 Inspector The inspector is a panel on the right-hand side of the project window which displays all meta-data, snapshots, and notes associated with the document shown in the editor that most recently had the keyboard focus. Since the special root folders in the binder—Draft, Research and Trash—have no meta-data associated with them, the inspector just shows the project notes or references when these items are selected. The inspector is broken down into sections, or “panes”. These panes can be toggled by clicking the buttons along the very bottom of the inspector. The first three display the common meta-data features of the item, while the snapshot and linked notes section has dedicated panes that take up the entire inspector. With the exception of the aforementioned root folders, any item in Scrivener has access to all meta-data and notation capability. You can use Notes to write about a painting you are studying in the editor, attach gallery URLs and research papers to it with References, or organise it with keywords. Snapshots and linked notes however will only be available to items which allow text editing in the editor, namely folders and files. You may toggle the visibility of the inspector with View Layout Show (Hide) Inspec- tor, or by pressing – I. 18.1 Synopsis Card At the top of the inspector (for the Notes, References and Keywords panes), you will find a depiction of the document’s index card. (The corkboard’s special features, such as pins and stamps, will not be rendered on the card.) As with the corkboard, you can edit the title and synopsis right on the card, updating the document’s corresponding information. There are two controls along the top of the card on the right-hand side. The first is a drop-down menu with an index card graphic in it. Click here to select between text synopsis and graphical synopsis. In graphical mode, you can drop in an image from the Finder (or the binder) which will be used to “represent” this document on the corkboard. The text synopsis will not be erased, and in fact will still be used in the outliner and vari- 225
- 234. 226 CHAPTER 18. INSPECTOR ous export methods, but in the inspector and corkboard, the graphic will be used instead. Read Placing Images on the Corkboard (subsection 12.1.6) for further information. The button on the far right will automatically generate a synopsis based on the cur- rent text in the document. If text is selected in the editor, it will be used to fill in the synopsis; otherwise, the first few lines will be used. Clicking this button is similar with the Documents Auto-Generate Synopsis menu command, however the latter does not consider your current selection. When using graphical synopsis mode, this button will be replaced with an X which when clicked will erase your graphic selection. 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) 18.2 General Meta-Data View This collapsible section appears in the middle portion of the Notes, References and Key- words panes of the Inspector. It displays the basic document meta-data and provides controls for editing it. Read Meta-Data Types (section 10.1) for further detail. 18.3 Custom Meta-Data View Click on the header bar for General Meta-Data to reveal the Custom Meta-data control. You can also alternate between General and Custom meta-data by pressing – 7. The interface presents a table with the meta-data field name in the left column, the editable values you may supply on the right. If custom colours have been assigned to any fields, they will be rendered here as text colour. Also, word-wrapping will impact this table. Read Custom Meta-Data (subsection 10.1.6) for more information. If no custom meta-data has been configured for the project, this panel will not be available. 18.4 Document Support Panes The five views of the inspector present further access to notes, reference links, keywords, text snapshots, and linked comments and footnotes, respectively. The first three share space with the synopsis and meta-data panels, the last two take up the entire inspector interface. The five panes can be accessed at any time by clicking on the icons in the bottom of the inspector, or by using the View Inspect sub-menu and its respective shortcuts, which will be discussed at the end of this section.
- 235. 18.4. DOCUMENT SUPPORTPANES 227 18.4.1 Document and Project Notes Document notes provide a rich text writing area that is outside of the main text area. You can use notes to store any auxiliary information about the current document for reference whilst writing, without cluttering up the binder. 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”. Document notes are always attached to the current document in the sense that you cannot view them unless you have loaded their respective document in the binder. Project notes are similar to document notes, except they are visible to the entire project, no matter what document you have selected. In addition, you can also create multiple project notepads, using the Project Notes window (section 12.3). When more than one notepad has been created for a project, you will see them appear in this menu as well. There will always be at least one project notepad. You can cycle forward and backward through all available document and project notepads with – 6 and – 6. 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 your browser into the table to create links, or use the + button in the References header bar. Double-clicking on the icon of the reference, or selecting it and hitting the Return key, will open the document, either inside Scrivener or in the default application or browser depending on the reference type. How internal (and supported) file types are opened in the editor is determined in the Navigation preference tab (section B.6). This sets the default, but you can always opt to open a reference using an alternate method by right- clicking on it in the table. It is possible to open references in a: l Current View, replacing the current editor l Other View, as a split view using the last split type you used if one needs to be created l QuickReference panel l Quick Look, which will only be available for unsupported file types Using these menu commands, or dragging and dropping reference items to an editor header bar, will let you open external media files not stored in the project, in the editor as though it were a project resource.
- 236. 228 CHAPTER 18. INSPECTOR The + button has three options available: l Add Internal Reference: presents a menu containing all of the items in your project binder. Click on any item, even a folder, to create a reference to it. The default description for it will be its binder title. l Look Up & Add External Reference: use this menu to load a file browser. Any file you select in this browser will be added as a link to the reference list. The default description for it will be the file name. l Create External Reference: creates a new row in which you can manually copy and paste or type in the internal title and valid URL or file path of the resource you wish to link to. This is most useful for creating links to the Internet, as you can just paste in the URL you have available. Likewise, any existing reference can be edited by double clicking on the text labels. To finish editing, press Return or click anywhere else in the table, with your mouse. You can use this to update broken links with the correct file path or URL, or change their internal names. For internal links to other Scrivener items in your project, you cannot edit the target, only the name. To replace it with a new target, you’ll need to create a new reference and then remove the old one. 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. To delete a reference, select it and click the - button, or tap – Delete. 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 “[In- ternal 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 accor- dance 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.
- 237. 18.4. DOCUMENT SUPPORTPANES 229 18.4.3 Keywords Pane Keywords can be used to hold character names, locations, themes, or anything else. This way, you could assign the name of a theme to a document as a keyword, and then later you could perform a keyword search to find all documents that deal with that theme (especially useful as you are unlikely ever to use the name of a theme directly in the text itself). You can associate keywords with documents to help you find them when performing a project search. Use the plus and minus buttons in the header bar above the keywords table to add and remove keywords (or you can drag words and phrases from text to the keywords table to create a new keyword). You can also use the Project Keywords win- dow, which stores a repository of all keywords used in the project, to assign keywords by dragging them from the project keywords into the keywords table in the inspector; this is an easy way to add several keywords at once. There are several ways to add new keywords to your document: 1. Drag the keywords from the Keywords panel to keywords table in the inspector 2. Drag the keywords from the Keywords panel 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 panel 5. Right-click anywhere in the keywords table itself for quick access to this menu, as well. Keywords can be unassigned from a document by selecting them in the keywords table and clicking the - button, or pressing the Delete key on your keyboard. To change the order of the keywords, drag and drop them in this table. This can be useful if you are viewing keywords on the corkboard as colours. Since only the first few (the precise number of which you can modify) will be shown, it is good to move the most important keywords you intend to track to the top of the list.
- 238. 230 CHAPTER 18. INSPECTOR Viewing a particular keyword in the panel is easy to do, just double-click on the key- word’s colour chip that you wish to see and the Project Keyword window will be opened for you and will select the keyword in the list. See Also: 1. Using Keywords (subsection 10.1.4) 2. Project Keywords (section 10.2) 18.4.4 Snapshots Pane This section of the Inspector gives you easy access to all of your existing snapshots, the ability to create new ones, load up comparative displays between snapshots or the current editor, and delete old ones. At the top of the Inspector, you will find two buttons. Clicking the + button will create a new untitled snapshot for the current document (you can also use – 5 to do this while typing). To remove a snapshot, select it in the table, and click the - button. To read the contents of a snapshot, click on any of the rows and its text will appear in the text preview area below the table. It is not possible to edit snapshots, but you can select text from them and use copy and paste to restore bits of them. Read below for how to revert the entire document to a selected snapshot. The comparison control features let you quickly see differences between the snapshot and the current version of the text, or between two snapshots, by selecting more than one snapshot from the table. When in comparison mode, the button title will change to Original which will return you to the non-annotated preview when clicked. The two arrow buttons which will appear in comparison 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 produces 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. Thus, to switch to “By Clause”, you need only disable “By Word”. 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.
- 239. 18.4. DOCUMENT SUPPORTPANES 231 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, but if you opt to create a snapshot from your current text, it is possible to effectively undo a roll-back by rolling “up” to the latest revision. Read more about using snapshots here (section 14.9). 18.4.5 Linked Notes Pane The final pane keeps track of all the comments and footnotes that appear in the current text view. This means that in Scrivenings mode where multiple documents are repre- sented, this display will show a combined view of all notes across the documents, in the order that they appear. Along the top of the pane, you will find three buttons which in order of appearance from left to right do the following: l Add a new comment in the text at the current text position or selection l Add a new footnote in the same manner as above l Delete the selected comment(s) for footnote(s). 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 po- sition 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 pref- erence tab (subsection B.8.2). Additionally, comments can have their colour changed by
- 240. 232 CHAPTER 18. INSPECTOR 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. 18.5 Locking the Inspector You can lock the inspector to the current editor so that when the other editor in the split view receives the focus, the inspector does not change contents but instead continues to display information about the document in the first editor. To lock it, just click on the icon of the padlock in the bottom right of the inspector (in the footer view, near the window resizing control). 18.6 Advanced Inspector Keyboard Usage The following keyboard shortcuts may be used to access the individual Inspector panes: l – H — Notes l – N — References l – J — Keywords l – M — Snapshots l – K — Comments and Footnotes 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.
- 241. 18.6. ADVANCED INSPECTORKEYBOARD USAGE 233 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. These shortcuts can be used in the following places as well: l QuickReference panels: if the panel has the focus, then using one of these shortcuts will open the split view to the inspector info requested by the shortcut l Composition mode: likewise, when in composition view, these shortcuts will call up and reveal the appropriate portion of the floating inspector.
- 242. Chapter 19 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 and is thus great for first drafts. 19.1 Formatting a Script in Scrivener To format a script in Scrivener, select the format you want to use from the For- mat Scriptwriting sub-menu. When in scriptwriting mode, the top item in the Scriptwriting sub-menu will be checked and will display the name of the format you are using. This preferred format, which will change depending on your last selection, can be toggled with – 8. By default, the standard “Screenplay” format is selected and Scrivener is in scriptwrit- ing mode. If “Script Mode - Screenplay” did not have the tick next to it, then we would know that the current editor was not in scriptwriting mode (that is, it would be in nor- mal prose mode for general writing). You can more easily tell whether or not you are in scriptwriting mode by looking at the footer bar, which will display various scriptwriting tools and hints, rather than the standard word and character statistics display. Addition- ally, the binder icon for that item will be tinted yellow, with three-hole punches on the side. Scriptwriting mode is a setting which is individual to each document. Once a docu- ment has been toggled to scriptwriting mode, it will remain that way until you change it. Thus it is possible to have a standard document in one split for your notes, while using scriptwriting mode in the second split to draft your work. However, it is not possible to use more than one type of script formatting in the same project. This is a project level setting, and so if you need to create a stageplay and screenplay at the same time, you will need to do the adaption in a tandem project. At the bottom of the scriptwriting menu you can see a list of all the different script formats that are available. Scrivener comes with the following formats built-in: l Screenplay 234
- 243. 19.1. FORMATTING ASCRIPT IN SCRIVENER 235 l BBC Radio Scene Style l BBC Taped Drama l Comic Book (Antony Johnston) l Comic Book (Alternative) l Stage Play (UK) l Stage Play (US) 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 Hollywood 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 bar is a drop-down menu contain- ing 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. The menu can be called up with – Y at any time from within a scriptwriting document (even in composition mode). 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.
- 244. 236 CHAPTER 19. SCRIPTWRITING The footer bar 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, press- ing Tab will switch you to Transition and pressing Enter will switch to Dialogue. How- ever, 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. If for some reason you need to change the element type for text you’ve already entered, you can place the caret anywhere within the text you want to change, and invoke the element menu in the footer bar, or use the Format Scriptwriting Change Element To sub-menu to select a different element. Note that when moving from an element 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. 19.1.1 Auto-Completion Using the built-in script settings, auto-completion is available for some elements, as is appropriate for their context. Upon choosing Scene Heading, for instance, you can start typing with “E” and you will be presented with a options like “EXT.” and “EVENING”. You may disable or enable (or add your own) additional items from this list by editing your script settings (section 19.6.1), though note you should in general not use this list to assign project specific completions like scene locations. It is best to use the Project Auto- Complete List... window for this. You may want to save your scripting adjustments for future use in another project. The auto-completion lists in the script settings should be seen as integral parts of a script. Some elements have been configured to automatically do this for you. Scene headings are a good example. They will add anything you type in between a ‘.’ and a ‘-’ in a scene heading line. In practice this means the part marked in bold in this example would be added to the project auto-complete list: “EXT. THE RED LION - NIGHT”. When words and phrases are added to the project auto-complete list in this fashion, they will be assigned a “scope” (subsection 14.10.3) which restricts their eligibility to only when you are typing within that element. A character name will not suddenly pop up in the slugline, for instance. You can adjust the scope of automatically added phrases using the main project auto-complete list. 19.2 Using Page View to Estimate Page Counts While the point should remained stressed that Scrivener is not designed at any level to provide a completely accurate pagination solution, with rigid formatting, such as that
- 245. 19.3. IMPORTING ASCRIPT FROM FINAL DRAFT AND OTHER PROGRAMS 237 used by most scriptwriting formats, and a few optional settings, it is possible to get very close to an accurate page count, when using the new Page View (chapter 15) mode. The first thing you will need to do is switch Scrivener’s default Scrivenings separator from a divider line to single line breaks, which can be set in the Formatting preference tab (subsection B.8.3), at the very bottom of the panel. This version uses a “zero-height” display model which will not introduce page inflation over long documents, like the standard divider will. You will also want to disable the usage of titles in Scrivenings mode, for your project, as it will likewise expand the overall height of the document over large sections. Scrivenings View and Scriptwriting: When creating a scrivenings session, if the ses- sion includes a mix of script formatting documents and regular documents, Scrivener will determine which mode to use based on the type which has the most entries in the session. This means, if you create a scrivenings session with 4 standard documents and 2 script documents, script mode will not be on by default. In the other direction, if there are more scripts that standard documents, script writing tools will be enabled in those standard documents. You can switch modes while in scrivenings with the – 8 shortcut. This will only impact (globally) the scrivenings session, and not any of the underlying files. 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 tab 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 tab as well. 19.3 Importing a Script from Final Draft and Other Programs Final Draft 8 Users: Refer to the section (section 19.5) on exchanging files with Final Draft 8. For users of Final Draft 7 and earlier, you can import scripts created in Final Draft by using “Save As” in Final Draft to save your script in “File Converter” (FCF) format, then import the resulting .fcf file. Scrivener will try to match the elements in
- 246. 238 CHAPTER 19. SCRIPTWRITING the FCF script to the elements in the current script format. For projects that use the basic screenplay formats, this should be all you need to do to import a script with all of its elements recognised. Because Scrivener is not a dedicated scriptwriting program, the way it handles script ele- ments is different from Final Draft or Movie Magic Screenwriter. Dedicated scriptwrit- ing programs generally assign hidden 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 nec- essary. Scrivener recognises elements by their paragraph formatting. 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 for- matting 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. 19.3.1 Importing From Final Draft 7 and Earlier First, you will need to export the script from Final Draft as an RTF file. Follow the instructions provided with your software package, for doing so. 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.
- 247. 19.3. IMPORTING ASCRIPT FROM FINAL DRAFT AND OTHER PROGRAMS 239 19.3.2 Importing Other Scripts as RTF If your script formatting was not recognised properly, or if you imported a script that has no matching format mode in Scrivener, you will need to create your own format mode that matches the script using the Format Scriptwriting Script Settings panel. This method can also be used to recover Scrivener formatted script files, if the original scripting settings have been lost for one reason or another. Here’s how: 1. Export the script from your scriptwriting program as an RTF file. 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 repre- sents one of the elements you want to be recognised (for instance, by clicking into a line of text that should be a scene heading). 4. Open the Script Settings panel (Format Scriptwriting Script Settings...). 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 cur- rent font & paragraph settings”. This will copy the font and paragraph information 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. 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.
- 248. 240 CHAPTER 19. SCRIPTWRITING 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. 19.4 Printing or Exporting a Script You can use the compiler (File Compile...) to print your script (or to turn it into a PDF file). For examples of how to do this, take a look at one of the scriptwriting project templates by going to File New Project... and selecting a project template such as the Screenplay template. Read the instructions that come with the template to see how to set up your project so that it is formatted properly when printed (or exported). In the majority of cases, just as you would with many other types of writing in Scrivener, you will want to export your script from Scrivener so that you can do all the final formatting in a dedicated formatting program such as Final Draft, see Export- ing Scripts (subsection 23.3.3) for information on how to use the Compiler to export to many popular scriptwriting programs. 19.5 Working with Final Draft 8 That this information is only relevant to Final Draft 8 users. Users of previous versions of Final Draft should use the FCF format for importing and exporting their work. 19.5.1 Importing Formatting from a Final Draft Document Optional Step: For basic scripts or those that will use Final Draft’s standard screen- play 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 sec- tion 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 Set- tings 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.
- 249. 19.5. WORKING WITHFINAL DRAFT 8 241 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 docu- ments 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. (Remember, 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 Settings... 2. In the Script Settings panel, click on the “Manage. . . ” pop-up button in the bottom- left. 3. Select “Load from Final Draft FDX. . . ” 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 el- ements using tab and enter or using the pop-up menu in the footer view beneath the 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. 19.5.2 Importing the FDX Files You can import FDX files into Scrivener in one of two ways. Both are fully featured, the only difference between the two is that the second will offer options for cutting up the script into smaller pieces automatically: 1. Using the standard file import methods; drag and drop into the project binder, and File Import Files....
- 250. 242 CHAPTER 19. SCRIPTWRITING 2. Go to File Import Import and Split... and select the FDX file that you want to import. See Import and Split (subsection 11.1.8) for further details. 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. 19.5.3 Exporting Individual Documents to FDX To export individual documents to Final Draft, just select the documents you want to export in the binder and then go to File Export Files... Select “Final Draft 8 (FDX)” as the export format. The exported file should open in Final Draft 8 with all features intact. 1. Compiling the Whole Draft to an FDX File 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... 2. Select “Final Draft 8 (FDX)” as the file format. 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. 4. Click on “Export. . . ” and choose a filename. 5. Open the exported file in Final Draft 8. 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.
- 251. 19.6. CREATING YOUROWN SCRIPT FORMATS 243 19.6 Creating Your Own Script Formats Scrivener comes with a number of script formats built in. You can also create your own script formats tailored to your own requirements; as well as export and import script modes for sharing on the Internet. To create your own script format mode, select Format Scriptwriting Script Settings... and use the window that appears to name your format and define its various elements. At the top of the panel is the Format Title text field. Enter the name of your format here (e.g. “Television (BBC Comedy)”). This is the name which will be visible in the menu, if you later choose to save your settings to a script format that other projects can use as well. On the left of the panel is the Elements list. This is a list of the parts that make up your script, such as “Scene Heading”, “Dialogue” and so on. You can add new elements and delete existing ones using the + and - buttons beneath the list, and you can rename elements by double-clicking into them. You can also reorder elements by dragging and dropping them. Note that “General Text” and “General Text (Centered)” will be added to the end of any element list you create but will not appear here as they have no special properties by definition. 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 19.6.2) 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. Clicking 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 “Manage. . . ” menu. Once you are happy
- 252. 244 CHAPTER 19. SCRIPTWRITING 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. It’s worth reiterating that script settings are saved directly into the project itself auto- matically, when you click the OK button. There is no need to repeatedly save a customised script. Saving a script is for when you want to use that format for another project entirely. Pro Tip: Making a format available for use in other projects saves it as an XML file in ∼/Library/Application Support/Scrivener/ScriptFormats. Considering instructing 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. 19.6.1 Format Tabs 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, which this section will describe. Font Tab The Font tab provides options for setting the character appearance for the selected ele- ment, as follows: 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. This also holds true for font changes made in the editor. Size Allows you to set the font size in points. Style Provides a number of options for determining the appearance of the current ele- ment, mostly self-explanatory. l All caps: If this is checked, the element will be capitalised. If “End of line” is selected, the element will be capitalised all the way to the end of the element; for the purposes of this definition, a paragraph is a line. If “First tab” is se- lected, 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
- 253. 19.6. CREATING YOUROWN SCRIPT FORMATS 245 selected, you can enter the keyboard characters 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. l No Underline/Single Underline/Double Underline: allows you to set the un- derline style for the current element. If single or double underline is selected, you can check Underline by word to underline words only (not spaces). Colour and Adornment * Parenthetical: encloses the current element in brackets when you hit tab or enter. * 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 the single letter here that will be used in the script elements menu as a shortcut key. Paragraph Tab The paragraph tab provides paragraph formatting for the selected element: Alignment Sets the current paragraph alignment (left, centred, right or justified). Spacing Sets the inter-line spacing (single, 1.5 or double). Spacing Before Sets the number of blank lines to appear between the selected element (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, provid- ing support for most if not all formatting requirements on the page.
- 254. 246 CHAPTER 19. SCRIPTWRITING l 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. l Left Indent: Sets the left indentation of all lines in the paragraph excepting the first. Set this value identical to the First Line Indent, to create a uniform “block indent” look. l Right Indent: Sets the right indentation of the paragraph. This setting pertains to all lines. l First Tab: Sets the first tab stop of the paragraph. (Note that subsequent tab stops may be added automatically to differentiate elements should any ele- ments have the same formatting.) Advanced: Allows you to set the writing direction, minimum line height and default 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. Tab/Return Tab The Tab/Return pane allows you to control the tab and return behaviour for the selected element; that is, it lets you specify what happens when you hit the tab or return keys, and so thus can be used to aid in the flow of documentation creation while you write. If you are creating a scripting environment from scratch, you might wish to save this step for last, since you will need to reference other elements (which may not exist while you are going through the list, initially). 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, “Action” 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 and ready to type an Action element. Tab behavior Sets what happens when you hit the tab key. l 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. l Tabbing on an empty line: Choose an element from the “Go to:” pop-up but- ton to set which element will be formatted when you hit tab on an empty
- 255. 19.6. CREATING YOUROWN SCRIPT FORMATS 247 line. This allows you to cycle through elements using the tab key. For in- stance, 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 reformat the line as an Action element provided you haven’t typed anything yet. l 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 characters 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 Heading element automatically inserts a hyphen surrounded by spaces, so you can easily enter a chronological marker. Auto-Complete Tab The Auto-Complete tab allows you to set a custom list of words that will appear for auto-completion while typing in the current element. Use the + and - buttons below the list to add or remove new words to the auto-complete list, and double-click on words to edit them. When typing your script, hit Esc or – . to bring up the auto-complete list. Note that the auto-complete list only appears after you start typing a word. For each entry, you can check the “Go to Next Line” box, which will force the editor to move to the next element (as it would if you pressed Return) once it has been entered. 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 common 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.
- 256. 248 CHAPTER 19. SCRIPTWRITING An example for the Character element would be to go to next line after using a project list completion (most likely a character name). 19.6.2 Managing Scripts At the bottom-left of the main script settings panel is a drop-down menu entitled “Man- age. . . ”. This allows you to reset your script elements to the default screenplay settings, to save your format for use with other projects, to save it for back-up somewhere on your hard drive (or to share it with others) and to load from file an existing format mode cre- ated either by yourself or someone else. You may also import formats from Final Draft FDX or FDXT files. 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 character 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 existing 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 Final Draft or Final Draft Template file for formatting rules and names, and attempt to convert them to Scrivener’s internal script formatting, in one convenient 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 computers. This will not install the saved script into your Scrivener support folder. Use the below command for that.
- 257. 19.7. USING SCRIPTFORMATTING FOR OTHER PURPOSES 249 Save for use with other projects Essentially accomplishes the above, but automatically 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. 19.7 Using Script Formatting for Other Purposes While the Scriptwriting mode has been preconfigured and designed for scriptwriting, it deserves to be mentioned that it is at its heart nothing more than an automated styling and structural engine. This means it can be used for a variety of purposes having nothing to do with scriptwriting. For instance, you could use it to aid in the transcription of an interview. By setting up formatting “elements” for each participant in the conversation, you could easily attribute each portion of text to the appropriate speaker, and if the interview is a back and forth between two individuals, you could even set it up to alternate back and forth between speakers whenever you press return. If you need to create a structural document, and cascading between structural types would be of benefit, then consider using the Scriptwriting engine to create you own format from scratch.
- 258. Chapter 20 Writing Tools 20.1 Searching and Replacing There are three primary tools for searching for items in a project. Project searching has numerous options for searching for particular types of information (like say, searching just in synopses), and will always scan the entire project for matches. Document search- ing is more familiar in that it provides a Search and Replace window that will act on the current text you have loaded. Third, format searching has many ways to search for particular types of formatting in your project. Depending on the type of search being used, you will be faced with two different types of response from the application. Project searching gathers all documents that match the criteria together, and displays them in the sidebar. These search results can be used as the basis for collections, either as a selection for a new standard collection, or to save the search criteria as a saved search collection. Holding search results in the sidebar also means you get to use all of the document management tools you are familiar with by now. Document and format searching on the other hand do not collect results, but rather step through the search results one by one, in a familiar fashion. Document searches will never “escape” the text editor. That is, they will not go off into other documents you do not have loaded, looking for results. Format searching, as with document searching, operates in a step-by-step manner, but will by default step through every matching item in the entire project. 20.1.1 Document Find and Replace As with many Mac OS X applications, you are provided with a standard Find and Replace panel which can be called up in any text view with – F. Note that the find panel operates only in the current text editor (which might include multiple documents when using Scrivenings mode). To replace text in all documents use Project Replace (see below); to search for text in all documents, use Project Search. 250
- 259. 20.1. SEARCHING ANDREPLACING 251 In addition to the buttons available in the panel, there are some keyboard shortcuts you can learn which can reduce the reliance upon clicking within the panel to carry out searches. l – G: finds the next available match; will wrap around to the top of the document if there are no more matches available below the current point. l – G: finds the previous match; as above, but will wrap around to the bottom of the document. Additionally, – E can be used to load the currently selected text into the “Find” field without opening the panel. 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. While the Find panel is open, you can continue editing in the main project window. This is especially useful when using the “Selected Text” option, which will only perform searches (and replacements if applicable) within the selection range. You may also restrict matches to only those which have the same letter case, are look for matches which only fall within the start of a phrase, end of a phrase, be a whole word, or the default, “contains” which matches even parts of words. The Next and Previous buttons will jump from one result to the next. When the last match is discovered, the Find tool will wrap around to the beginning of the document again. There are three replacement options. l Replace: Replaces the currently matched item l Replace & Find: Equivalent to clicking the Replace button and then the Next but- ton l Replace All: Will replace all matches with the provided replacement value with no further interaction. To leave the Find tool, you can either click the close window button, or tap the Esc key. 20.1.2 Project Search Project search is a tool for finding binder items which match the search you’ve provided. This is unlike the standard Find tool, which steps through a document one match after another. It returns everything at once in a list, which you can then go through at your
- 260. 252 CHAPTER 20. WRITING TOOLS leisure. You can think of it as a way of “filtering” the Binder so that it only shows those items which match the search. As a convenience, the search text you provided will be automatically loaded into the Find search tool for you. This means you can immediately use the keyboard shortcut to find the next search result within the document, – G. Note however that because Project Search can operate on many different types of item elements, the search result itself may not be in the primary editor. It might be a label, or a keyword, instead. In these cases, – G will not located the search result for you. When you use project search, the results will be placed into a temporary, dedicated collection called “Search Results”. If the collections interface has been hidden, this fact will be largely obscured from you (though the background colour of the sidebar will change, as will the title for the sidebar, at the very top), but the collection will be created, and can be accessed later so long as you do not run another search. Search Results and the Sidebar: Since search results temporarily replace the binder in the sidebar, it can initially confusing 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 Collections (section 8.3). There are two ways to access Project Search. You can either click in the search field in the toolbar, or press F to place the cursor focus there. If the toolbar has been hidden, a convenience window will be opened providing the same features as the toolbar search. Finding (Almost) Everything: While it may at first seem a bit useless to use search to find everything in the Binder, it can often be useful as searching this way presents your entire project in a flat list. In conjunction with sorting by columns in the Outliner, this can reveal useful information, such as sorting by Modified Date to see everything you’ve recently edited. To search for everything, simply type in a single asterisk into the search bar. Another use for this feature can be to combine it with some of the other search options to return everything that otherwise matches a specific criteria. Hence, “almost” every- thing. If you leave the scope and field options to the most permissive, then searching for an asterisk will find everything in the project—even things in the Trash. However, if you change the search scope to only operate in the Draft folder, for example, an asterisk will only return all Draft items.
- 261. 20.1. SEARCHING ANDREPLACING 253 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, which means that if you type in two words, they will need to appear together in that order. 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. You can also search within multiple field types at once by holding down the Option key and selecting another type (though of course if “All” is selected this will only result in changing the type to the selected search field, you’ll need to use the Option key on a second field to add another). Option selecting can also be used to turn off an extra field without disturbing the total selection. If you wish to fully reset the search criteria to a single source, either select All, or select any field without using the Option key. l All: The default search mode. Every available type of searchable field will be queried for matches. l Title: Only the titles of binder items will be searched for. This is similar to title filtering in the binder. l Text: The text contents of files and folders will be queried. Note this does not include notes and synopsis. l Notes: The auxiliary document notes will be searched. Note this does not include project notes. l Synopsis: The synopsis field for each document will be searched. This is any- thing that has been typed into the text area of an index card or in the synopsis portion of the outliner. l Keywords: Only keywords will be searched. Note you can also perform key- word searches quickly by using the Project Keywords window. l 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. l Status: The text of the status meta-data will be searched. Note the name of this meta-data field can be changed per project. l Custom-Meta-Data: The text values (not meta-data field name) will be searched.
- 262. 254 CHAPTER 20. WRITING TOOLS An optional mode can be accessed by holding down the Option or Command key when clicking on the magnifying glass icon. You can select multiple types of data to search within, when doing this. To reset the search mode to a single type, either select “All”, or click on the magnifying glass without a modifier key and select the single search type you wish to use. Operator Set the method by which search terms will be handled as you type them in. l 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 match- ing, use Whole Word (below). l All Words: Every word entered into the search field must appear in the se- lected 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. l Any Word: Queried documents must contain at least one of the words typed into the search field. Analogous to logical OR. l Whole Word: Unlike any of the above search methods, the term supplied will only match whole words. A search for “Jo” will only return documents 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. l 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. l Search Binder Selection Only: Pre-select items in the binder and then perform 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. l 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. l Search “Excluded” Documents: Include documents that have not been marked as “Include in Draft” in their meta-data. This option can be combined with the above.
- 263. 20.1. SEARCHING ANDREPLACING 255 l 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.3.4), which will keep itself dynamically updated whenever you view them. 20.1.3 Project Replace The menu command, Edit Find Project Replace provides the ability to replace text throughout the entire project. Set the text to find, the text with which to replace it, whether the search should be case-sensitive or apply to whole words only and specify what should be affected by the replace (any combination of text, titles, notes, synopses and snapshots). Note that a Project Replace cannot be undone (except by using “swap” to exchange the search term for the replacement text and repeating the Replace All oper- ation, which in some cases might have unexpected results). A progress bar at the bottom of the sheet shows you the progress of the replacement operation—bear in mind that it could take a little while on large projects. As with all tools that make widespread changes in a fashion which cannot be undone, it is often a good idea to back up your project prior to use it. A simple mistake can render your entire draft illegible, or even worse, produce subtle flaws that even 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 replacing 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: 1. Text: standard text editor contents 2. Titles: the titles of the documents as they appear in the binder 3. Notes: any inspector note fields that are attached to documents 4. Synopses: the text content of each index card 5. Snapshots: archived snapshots will be changed as well (take special care with this one, as snapshots are your internal backup mechanism) 6. Project notes: any project notes will be impacted as well.
- 264. 256 CHAPTER 20. WRITING TOOLS 20.1.4 Find Synopsis Sometimes you just want to jot down a quick idea or note to yourself on a particular item within your project, but you don’t want to hunt around for it in the Binder (maybe it isn’t even visible), or use Project Search and lose your current working environment. The synopsis, an integral component of every item in your project, is useful for this sort of task, and especially so when coupled with the Find Synopsis feature. To call up the search tool, use the menu command, Edit Find Find Synopsis, or press – G from anywhere the main project window. An integrated search and edit window will appear. As you type in the search field, the Title and Synopsis text for every item in the project will be scanned, and any matching items returned in the table below the search field. The search type used is phrase based. This means that the sequence of letters you type in must match either the title of the card, or any text within its synopsis. If you skip words or letters, the card will not be returned as a result. While searching, you can use the UpArrow and DownArrow keys to move the selection bar in the results table. With the card selected that you wish to edit, press the Return key to jump immediately to the synopsis field, or use your mouse to click in either the title or synopsis area of the index card. Click on other entries in the tables to view other cards, or use – UpArrow and – DownArrow to flip between cards while you are editing in a text field. You may also use the Tab key to switch from the search field, to the results table, to the index card itself. Pro Tip: You can also call up the Find Synopsis window using – F when the applica- tion focus is in either the Corkboard or Outliner view. If you wish to perform another search immediately, you can tap the Esc key to return to the search field at any time. Pressing it a second time will reset the search. Pressing Esc a third time, or in an empty search field, will close the window. The window can also be closed with the standard – W shortcut. Your last search will be remembered within the current session, so you can feel free to close the search window for a while, and recall it later without losing your place. Sometimes a quick note isn’t enough. If you want to transition from the index card to the item’s QuickReference view, double-click on any of the search results, or tap the Spacebar while it is selected in the search result table. You may also use the standard View Reveal in Binder command to highlight any active card or selected search result, in your project binder. When an item has been set to use a graphic to represent itself on corkboards, the image will appear in the card, rather than the synopsis text. This functions in the same way as the index card in the Inspector, in that you can drop graphics into it from either the
- 265. 20.1. SEARCHING ANDREPLACING 257 Binder or your computer to update or add a graphic. To switch between graphic and text modes, right-click on the item in the search result list and select the appropriate option. 20.1.5 Find by Format and Text Function The Formatting Finder palette, Edit Find Find by Formatting ( – F), gathers to- gether a number of powerful project-wide search tools for otherwise difficult to locate things, such as italicised text; cross-links; annotations & footnotes; and so on. The basic panel has a drop-down menu at the top which is the primary formatting mode selector. Below that there are two common tools to all modes. 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 docu- ments in the binder (even outside of the Draft); “Selected Documents” will con- strict 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. Also like the standard Find panel it can run in “background mode” as well. Once a search cri- teria has been set up, you will find menu commands and keyboard shortcuts for stepping back and forth from one match to the next, in the Edit Find sub-menu. The rest of this section will go over each of the individual formatting search types. Highlighted Text Looks for text that has been highlighted using the highlight feature (section 17.4). Limit search to color When the checkbox is enabled, only those highlights matching the chosen colour will be found. If this is disabled, all highlight colours will be considered a match. Note that the colour must be precisely the same, so stick to using basic or custom swatches or the built-in highlighter defaults when using this tool. Click once on the colour chip to bring up the colour palette, or click and hold to select a built-in highlighter colour.
- 266. 258 CHAPTER 20. WRITING TOOLS Comments and Footnotes Will search within any inspector-based comments or footnotes in the project. By default all will be considered as potential matches, but you can narrow this down by selecting one of Comments or Footnotes from the “Type” menu. Inline Annotations and Footnotes Searching for inline annotations gives you three colour matching options: l Any Color: No limits will be made on the search results. l Limit Search to Color: will only consider annotations of precisely the specified colour as matching. l 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, or to share the list of colours used, prior to making any edits. This feature will step through any edits that have been made while using a particular revision level, including any overstrikes that have been made. Coloured Text The interface for this type of search is similar to the highlight search type. You can provide 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 custom
- 267. 20.2. QUICKREFERENCE 259 colours manually. Do note the colour choice still needs to be precise, so using custom swatches or built-in presets will generally be easiest. As with the highlight tool, you can click and hold on the colour swatch to select from a built-in default. 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. Text with Preserved Style This will find text which has had a Preserve Style block drawn around it, from the For- mat Formatting Preserve Formatting tool. Since there are no optional qualities to these blocks of text, no additional criteria is required. Character Format Common text-level formatting can be searched for using this tool. Any number of op- tions in the additional criteria can be stipulated. They work in an additive fashion, 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 Format Text Keep With Next marker added. 20.2 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 Quick Look, but rather than limiting you to only one Quick Look panel and a view-only model, many QuickReference panels 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 ac- cess to most data you can get in the Inspector, with the notable exception of snapshots (more on that below). Once opened, QuickReference panels will remember their size and position on the screen, as well as their meta-data viewing options. When “Reopen QuickReference panels when opening projects” is enabled in the General preferences tab (subsection B.2.1), any open panels, their position, and internal meta-data settings will be remembered in between sessions. Panels that were closed will not be remembered, nor will their various settings. There are two appearance styles available. The default uses a standard window design. The alternate style uses a glossy black translucent style, familiar from Apple programs
- 268. 260 CHAPTER 20. WRITING TOOLS and Quick Look on Snow Leopard and lower. Both are functionally identical to one another, leaving this as a mainly aesthetic choice. The main exception to this is that stan- dard appearance QuickReference panels can also use a Format Bar (which is hidden by default, but can enabled as per usual with the Format Show Format Bar menu command). In addition, since these use a standard window, they will respond to normal windowing commands. You’ll be able to minimise QuickReference panels to the dock and alternate through them with ‘Cmd-“. This choice can be made in the Appearance preference tab (section B.3). An additional option, Window Float QuickReference Panels will toggle whether or not these should “float” over your other project windows. Floating is most useful in Composition Mode, where the backdrop would ordinarily hide the panels, but toggling this feature on and off can be useful in a variety of conditions. So a hotkey has been supplied as well, Q. The Window Zoom menu command, when activated on a QuickReference panel that is viewing an image resource will expand the size of the panel to match the width of the graphic, if necessary. There are three 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 panels will be opened at once. 2. Use the View QuickReference sub-menu to navigate your project binder and open a document from anywhere, without disturbing your existing editor views or requiring an editor lock. This method is also accessible from composition mode. This menu functions in a similar manner to the “Go To” menu. Each item in the Binder will have an entry, and you select a container entry just as easily, to open that container in its own QuickReference panel. 3. Hold down the Option key when selecting an item from the Go To menu, or from the Path menu in the editor header bar. This works at any time. 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 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.
- 269. 20.2. QUICKREFERENCE 261 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 most if document meta-data otherwise provided in the Inspector. Text Zoom: You can independently zoom the text scale within a QuickReference panel, 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.6) to see how you can use QuickReference panels to open things you might otherwise have thought you could only open in standard editor splits, such as clicked links. Once you have closed a QuickReference panel, for the remainder of your session it will be saved into the Window Closed Panels sub-menu, much like a modern web browser might save all of the tabs you have recently closed. This way, you can feel free to close QuickReference windows whenever you are immediately done with them, as they will remain easily accessible to you within that session. See also: l Inspector (chapter 18) l Meta-Data Types (section 10.1) 20.2.1 QuickReference Mini-Inspector Each QuickReference panel has the ability to load up key components of the inspector’s meta-data into a split view. Using the drop-down menu, you can select which type of meta-data you wish to view: 1. Synopsis: the content of the index card 2. Picture: the representational graphic if one has been selected 3. Notes: standard document notes (you cannot access project notes from a Quick- Reference panel) 4. Keywords: document keywords; this table also serves as a drop-target for keyword drags from the Project Keywords window. 5. References: the list of document references; as with notes, project references cannot be viewed.
- 270. 262 CHAPTER 20. WRITING TOOLS 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. 20.2.2 Using QuickReference Panels in Composition Mode Since by default, QuickReference Panels float over the Scrivener interface, they will re- main visible even when entering composition mode, making them useful for bringing ref- erence material into this dedicated writing environment. Additionally, you can open new QuickReference panels while in composition, by accessing the View QuickReference sub-menu. If you have floating turned off, QuickReference panels will act like other windows in that clicking anywhere in the composition interface will hide them. You can bring all QuickReference panels back to the front by turning floating back on, even if only temporarily. 20.3 Goals and Statistics Tracking Tools At some point, most writers will need to get some idea of the progress of their work by checking the word, character or page count. There are several ways of doing this in Scrivener: l To get word, character and page counts for the whole of the draft (that is, the contents of the Draft folder) or for any documents selected in the binder, use Project Project Statistics. To calculate the printed page count statistics, Scrivener internally generates a compile document, based upon your compile settings—so you need to note that if you have compile set up to print off synopses and nothing else, only the synopses will be counted. This can also mean that there will be a delay in displaying this panel with larger projects, and with projects over 100,000 words, you’ll need to manually update the printed page count, to avoid lengthy waits whenever the tool is used. l 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 available if a text document has the keyboard focus). When using Scrivenings mode, the full word count will be tabulated, not just the section you are currently editing. l To set a target word or character count and track your progress for the entire draft or the current writing session, select Project Show (Hide) Project Targets.
- 271. 20.3. GOALS ANDSTATISTICS TRACKING TOOLS 263 l To set a target word or character count and track your progress for a single doc- ument, 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 bar for more information. You can also use the Outliner to view the Total Progress and Total Goal columns, to aggregate statistics for group of documents. l 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. l 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 the outliner column bar(or by selecting View Outliner Columns). You can use the “Total Words” column to collect aggregate counts for items which have children. l To view a combined word and character count of an arbitrary selection of docu- ments, use the outliner or corkboard to select several documents, and then Ctrl- click on the selection. The combined word and character count for those docu- ments will appear greyed-out at the bottom of the contextual menu. Note this method only counts texts within the actual selection, not the implied selection in the case of children beneath the selected items. To count them too, disclose the items in the outliner and select them along with their parent items. Usage Tip: The word frequency tool in Text Statistics only counts text within a cur- rent 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. 20.3.1 Project Targets The project targets panel allows you to set goals for your writing—either for the Draft as a whole or for the number of words you want to write during the current session—and to check on your progress. To bring it up, select Project Show Project Targets or press – T to toggle its display. The targets panel displays two progress bars: one showing the progress of the draft and the other showing the progress of the current session, , which you can optionally instruct Scrivener to reset for you at the end of every day. Using this panel, you can set
- 272. 264 CHAPTER 20. WRITING TOOLS a target word count for the draft (that is, the contents of the Draft folder) and for the current session, and keep track of how far you have to go before you reach your goals. To change the targets, just click in the appropriate text field and enter a new target word count (or target character count—you can set whether the target should be in words or characters by clicking on “words” so that a pop-up menu appears, providing a choice between “words” and “characters”). 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. 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. 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 composition mode editor) it does not count imported documents or appended text and so forth (so you can’t cheat!). Project Targets Options Click the Options button in the Project Targets panel to configure how these progress bars are calculated, and what Scrivener should do if you meet your goals. Draft Target Options for total draft counting. l 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 l 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
- 273. 20.3. GOALS ANDSTATISTICS TRACKING TOOLS 265 l Deadline: counts down the days you have left at the bottom of the target window. This can also be used to calculate how many words you need to continue writing per session in order to meet your deadline, below. Session Target Options for session based counting. l 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 l 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 counter reaches zero, so some deletions would no longer be counted after that point, making it less accurate l Automatically reset at midnight: when enabled, Scrivener will reset the session counter for you at midnight. If you prefer to handle the reset manually, use the button for doing so in the main Project Targets window. l Automatically calculate from draft deadline: requires the “Deadline” option to be enabled above, and the counting method to be either Words or Char- acters. Counting by pages cannot be accurately calculated when using this mode. When a deadline has been set, you can have Scrivener handle the cal- culation required to meet your deadline given the amount of time left. For example, if you are at 85k words in a 100k draft and have 10 days left to finish, then Scrivener will set your daily session goal to 1,500 words per day. If you come in under or over that goal, Scrivener will adjust the daily session target whenever you hit reset, or automatically if midnight reset is enabled. l Writing Days: by default, all days are considered eligible for writing, in terms of calculating your daily goal. If you cannot write every single day of the week, simply click on the days you can write, and the feature will adjust the calculation so that you don’t end up writing below the curve. If all days are deselected, the calculation assumes you can write on every day. Show target notifications using Growl: if you have Growl installed on your system, Scrivener will register itself for announcements, and use that system to post notices when you exceed a goal, or fall back under it. 20.3.2 Project Statistics Project statistics can be called up at any time with Projects Project Statistics or –S on the keyboard. This sheet has two sections to it:
- 274. 266 CHAPTER 20. WRITING TOOLS l 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, Compile 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. l Selection: A count of everything you have currently selected in the Binder, option- ally including all of their children items as well. Each of these sections have identical statistics available to them. The word and char- acter counters are self-explanatory. The two page count estimates are based on different algorithms. Pages by paperback uses an industry standard formula (for English language publish- ing) 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 product 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 characters 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 other content settings, and then count the total pages resulting from that. Consequently, in large projects it may take a few moments (or even minutes, for long works) for this window 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 paper- back estimated count to your printed count, so that it can serve as an immediate general figure to work from. Project Statistics Options To access options for how project statistics are calculated, click the Options tab in the window. Draft Statistics Options Controls how the Draft only section of the stats are calcu- lated.
- 275. 20.3. GOALS ANDSTATISTICS TRACKING TOOLS 267 l 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. l Count footnotes: Footnotes are by default included in the count. If your pub- lishing environment demands these be considered separate, here is where you can disable them in the total count. Selection Statistics Options Tuning options for how selected items should be counted in statistics. l Count all documents: In this context, all documents means: regardless of whether the document meta-data flag, “Include in Compile” is on or off. l Count only documents marked for inclusion: Only those documents that have “Include in Compile” checked will be counted. l Count only documents not marked for inclusion: As above, only with the in- verse logic. l Exclude comments and annotations: All inspector comments and annotations will be disregarded by default. If you wish to count them too, un-check this option. l Exclude footnotes: Footnotes are by default included in the count. l Count sub-documents: When disabled, only the literal selection will be counted. With this option on, the selected items and all of their children will be counted, all the way down to the bottom of the outline. 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. Read the prior section for details on how this works. 20.3.3 Text Statistics The Text Statistics panel can be accessed with Project Text Statistics or – S, is only available when the active editor is displaying text, and it will produce statistics for all of the text being displayed, even if that editor is currently displaying many documents in a Scrivenings session. The types of information it provides are more pertinent to the topology of the text document, as opposed to the end product (where page counts and paperback estimations come into play).
- 276. 268 CHAPTER 20. WRITING TOOLS In addition to the simple counter statistics, you can flip down the Word Frequency chart to display a table of discovered words, how often they have been used numerically, and graphically how often in comparison with other words in the table. These columns can be sorted by clicking on their header fields. 20.4 The Name Generator Scrivener comes with an exhaustive name generator, which includes many thousands of common names, as well as selections such as dictionary words that sounds like names, literary names from classics, a broad selection of regional names in several languages, and can even attempt alliterative names—all with extensive options for setting relative obscurity, naming styles such as double-barrelled surnames, initials, and so on. To access the name generator, invoke the Edit Writing Tools Name Generator... menu command. You can adjust how many names will be generated, and then click the Gener- ate Names button. To set further options, click the little gear button beside it. The available options are: l Gender: select one option here. The default is either gender. l Attempt alliteration: the generator will attempt to produce names with an alliter- ative effect, like “Jeromy Jin”. This option will work best with Latin based lan- guages. l Double-barrelled surnames: produces names like, “Otis Cowie-Milburn” l 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”. l Number of forenames/initials: produces multiple forenames. You can select from 1 (default) to 3. l 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”, while slid- ing 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
- 277. 20.5. BIBLIOGRAPHY MANAGEMENT 269 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. 20.5 Bibliography Management Scrivener offers simple integration with your favourite a bibliography or citation man- ager such as Bookends, EndNote or Sente for academic work. To set it up, visit the Gen- eral preferences tab (subsection B.2.6) Click on Choose to choose your citations manager (usually from the Applications folder). If you set a citations manager here, you can hit – Y (or Format Bibliography Citations...) to launch your bibliography application and bring it to the front automatically. You can then use your bibliography/citations application to paste a citation placeholder into Scrivener. After compiling to RTF, you will need to use your manager to scan these placeholders into final print form. If you are using Papers version 2, which has simple citation management features, it is better to use their built in “Manuscript” feature than Scrivener’s integration, as this will provide a quick pop-up interface that automatically pastes the citation placeholder back into Scrivener. Refer to the documentation for Papers for details on how to use this.
- 278. 270 CHAPTER 20. WRITING TOOLS 20.6 Using Equations with MathType If part of your writing involves the addition or construction of equations in your draft, then you can use Scrivener’s Design Science MathType2 integration to insert equation objects into the draft, much like you would an ordinary figure. To create a new equation, position your cursor where you wish to have it appear, and use Edit Insert MathType Equation . If you have MathType correctly installed on your machine, you will see the equation interface pop up over the Scrivener window. Any changes made within this window will be saved back into the Scrivener project when you close the window (by default it will ask for confirmation when closing the window) or use File Close and Return to Scrivener. To edit an equation later on, simply double-click on the equation in the Scrivener editor. The MathType interface will pop up again, and any changes you make will be saved back into the file when you close it. Equations act much like ordinary images. They can be aligned or styled like them in the editor, and when they are compiled they will be converted to images and handled as they ordinarily would be for the particular format in use. Equations can be saved and edited from any rich text field, including project or docu- ment notes. Typing Expansion Conflict Some type expansion applications, such as Typinator and TextExpander can cause Scrivener and MathType to have troubles communicating with one another. The main symptom of this will be items that refuse to save changes, or the inability to insert new equations. If you experience either of these symptoms, restart Scrivener and avoid using any text expansion tools while working with equa- tions (most programs give you a setting to ignore particular applications, you may wish to take this step). 2 http://www.dessci.com/en/products/mathtype/
- 279. Chapter 21 Using MultiMarkdown For those who prefer structural writing solutions to rich text (and if this means nothing 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, LTEXand XHTML - using A 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 MultiMark- down, structural writing or been bothered by such formats as LTEX, you can ignore this A aspect of Scrivener. Scrivener was designed primarily as a rich text application; Multi- Markdown 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. 21.1 What is Markdown? The MultiMarkdown syntax is based on the “Markdown” syntax created by John Gru- ber, and the best description of what Markdown is comes from his Markdown web site, Daring Fireball1 : Markdown is a text-to-HTML conversion tool for web writers. Mark- down allows you to write using an easy-to-read, easy-to-write plain text for- mat, then convert it to structurally valid XHTML (or HTML). Thus, ‘Markdown’ is two things: (1) a plain text formatting syntax; and (2) a software tool, written in Perl, that converts the plain text formatting to HTML. See the Syntax page for details pertaining to Markdown’s formatting syntax. You can try it out, right now, using the online Dingus. The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted docu- ment should be publishable as-is, as plain text, without looking like it’s been 1 http://daringfireball.net/projects/markdown/ 271
- 280. 272 CHAPTER 21. USING MULTIMARKDOWN marked up with tags or formatting instructions. While Markdown’s syn- tax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. 21.2 What is MultiMarkdown? The following is Fletcher T. Penney’s description of MultiMarkdown: Markdown is great, but it lacked a few features that would allow it to work with documents, rather than just pieces of a web page. I wrote MultiMarkdown in order to leverage Markdown’s syntax, but to extend it to work with complete documents that could ultimately be converted from text into other formats, including complete XHTML doc- uments, LTEX, PDF, RTF, or even (shudder) Microsoft Word documents. A In addition to the ability to work with complete documents and conver- sion to other formats, the Markdown syntax was lacking a few things. Michel Fortin added a few additional syntax tools when writing [PHP Markdown Extra]. Some of his ideas were implemented and expanded on in MultiMark- down. John Gruber may disagree with me, but I really did try to stick with his proclaimed vision whenever I added a new syntax format to MultiMark- down. The quality that attracted me to Markdown the most was its clean for- mat. Reading a plain text document written in Markdown is easy. It makes sense, and it looks like it was designed for people, not computers. To the extent possible, I tried to keep this same concept in mind when working on MultiMarkdown. I may or may not have succeeded in this. . . For comprehensive information about MultiMarkdown and how to use it, see Fletcher’s web site2 . 21.3 MMD and Scrivener The first thing to note when using MultiMarkdown in Scrivener is that because Scrivener is a rich text editor, it has no plain text mode. This means that you can add bold, italics, images and so forth to your text, but when you export to a MultiMarkdown format 2 http://fletcherpenney.net/multimarkdown/
- 281. 21.4. IMPORTING MMDFILES 273 (which requires the text to be converted to plain text), all rich text attributes - bold, italics, images and so forth - will be lost. The format of the exported text is defined entirely by the MultiMarkdown syntax you use. For instance, the text “this is some text” in Scrivener would be exported via MultiMarkdown as “this is some text”. Note that you can convert rich text bold and italic attributes to MultiMarkdown syn- tax 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 Mul- tiMarkdown - for instance, MultiMarkdown does not support the italicisation of partial words - this command may or may not produce completely valid MultiMarkdown syn- tax; 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 some- thing 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 adjustment 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. Scrivener currently ships with the last stable version of MultiMarkdown 2. As of the time of this writing, MultiMarkdown is now up to version 3. This represents some signif- icant changes in how the post-processing works, and Scrivener is not quite ready to fully address them. However you can install MMD3 in a way which Scrivener will pick up on and use. The Mac support package, which is distributed with the same repository as the main MMD3 installer, will place some helper scripts in the same location that Scrivener checks for when verifying a user installation. These scripts will redirect Scrivener to the MMD3 binaries. There are other considerations you may need to make as well, but these are internal to the MMD format. Be sure to go over the MMD documentation and make sure your meta-data is ready for the transition. 21.4 Importing MMD Files You can import any existing MultiMarkdown files into Scrivener using File Import MultiMarkdown File.... This will parse the file you select and break it up so that it is imported into the binder with its hierarchy intact, taking document names from the headers defined in the file.
- 282. 274 CHAPTER 21. USING MULTIMARKDOWN 21.5 Exporting MMD Files You export to MultiMarkdown format the same way you export to any other format— using Compile Draft under the File menu. In the menu of the “Compile For:” drop-down menu you will find several options for exporting to MultiMarkdown format. MultiMarkdown Exports the draft as a plain text file, creating headers from document titles based on the hierarchy in the binder (i.e. a document on the third level un- der 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 - LTEX First parses the draft into MultiMarkdown format (as above) A 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 Memoir class to create the LTEXfile. A MultiMarkdown - RTF Parses the draft into MultiMarkdown format and then pipes it through MultiMarkdown to create an RTF file. Recent versions of MultiMark- down (which Scrivener has been updated to use) use a full RTF generating trans- form engine, which has greater support for features that were absent in prior re- leases, 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. There are two conditions under which Scrivener will create a compile folder, instead of a single compile file. If graphics have been dragged directly into the text, it will generate the appropriate syntax for image inclusion and export the graphic into the compile folder as well as the master file. Additionally, if you have resources in your Binder and have typed in the image syntax yourself, using Scrivener Links to link from the image filename part of the syntax to the binder item, it will be gathered and exported to this compile folder, too. Ordinarily, the compile folder will be completely regenerated each time you compile. This can be destructive in cases where you’d like to make changes to the content of that folder in between compiles, such as adding .tex support files, or if you’d like to compile into a pre-prepared folder with all of the support material you require.
- 283. 21.6. MMD INRICH TEXT ENVIRONMENT 275 If the folder you select to compile into ends in “-mmd”, “_mmd”, or “.mmd”, then this behaviour will be disabled. The contents that would have ordinarily be placed in a freshly created compile folder will instead be saved directly into the selected folder, updating any files that exist there as necessary, while leaving the rest alone. 21.6 MMD in Rich Text Environment Because MultiMarkdown requires a certain degree of precision, many of the visual tools that rich text users commonly use can have a negative impact on how well you can “see” your document. For example, in MMD, a tab in front of a line turns it into a code block; thus indenting the first line of each paragraph could lead to confusing results. Likewise, using paragraph spacing could make for confusing results in an environment where every block needs a clear space around it. Pseudo-spacing might lead you to believe a space exists where in reality there is none. Consequently it is often a good idea to reduce the level of formatting in your projects as much as possible. This doesn’t mean that a project needs to look unappealing. If you reduce the para- graph spacing to zero, the double-newline that is required between paragraphs looks only slightly larger than normal. Meanwhile, because formatting is ignored by the compile process, you can feel free to take advantage of any formatting tools you like to pretty up your document, safe with the knowledge that none of it will ever appear outside of Scrivener. Some like to use a monospace font, like in many plain-text editors. Indeed, with tables, this can make editing much easier. However many others use whatever font is appealing to them, maybe saving monospaced fonts for those sections that require a little perfect placement. There is one exception to that. An option in the compiler can be set to attempt to convert rich text formatting to real plain-text whitespace. That is, a paragraph with a full line of pseudo-spacing after it will be converted to an actual empty newline. Indents will become tabs (so be careful with that one). This option is mainly intended to be a convenience for people who are switching to MMD from a rich text environment, and have a lot of existing material that is single-line spaced. However you could use this option to take advantage of rich text aesthetics while working in MMD, if you wished. When exporting via MultiMarkdown using any of the above methods, all rich text formatting is completely cleaned from your draft, as it passes through a plain-text engine; there is no need to clean up extraneous highlighting and other markings when working with MMD. There are two exceptions: 1. Any inline or linked images will be converted to MMD syntax, and exported into the compile folder, ready to use by the XHTML, MD plain, and LTEXformats A
- 284. 276 CHAPTER 21. USING MULTIMARKDOWN 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 annotations, and all comments, will be exported as SPANs. This can be used advantageously 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 Format- ting menu, these blocks can be applied to text to protect them from formatting al- ternations during compile. With MMD, since there are no formatting alterations, these blocks will instead emit a single tab character in front of every 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 formatting alter- ations. 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 LTEXand other such applications. A 21.7 MMD Meta-Data MultiMarkdown supports a free-form meta-data system, with some meta-data keys being used intelligently by the system. You should read the MMD documentation about these fields, and you can add your own without detrimental effect. To set up project-level meta- data, which will be attached to every compile you produce, use the Meta-data pane in the compiler. Additionally, you can add a document to the draft titled “Meta-Data”. If this document is the very first document that Scrivener processes during compile, it will be tacked on to whatever project compile meta-data has been defined. Due to the way MMD meta-data works, fields which are defined twice are redefined. Thus you can set a project default for “Title”, and then have individual sections of your draft override that with their own “Title” settings. When importing an MMD document via File Import MultiMarkdown File..., if Scrivener detects a meta-data block, it will create this file for you. If you wish to move
- 285. 21.8. UPDATING MULTIMARKDOWN 277 these values to the compiler, or indeed if you wish to move any set of properly format- ting meta-data values into the compiler, you can simply copy and paste into the compile pane meta-data table. Scrivener will read in the meta-data and convert it to the key-value system it uses in the compiler. See also: MMD compilation meta-data (subsection 23.18.3). 21.8 Updating MultiMarkdown Scrivener comes with MultiMarkdown support built in, so you don’t have to worry about installing anything extra. However, there may be times when Fletcher up- dates MultiMarkdown between Scrivener versions, in which case you may want to ensure that you have the latest version of MultiMarkdown installed. To ensure that Scrivener uses the most recent version of MultiMarkdown rather than the version built into Scrivener, you just have to install the new version of MultiMarkdown into ei- ther ∼/Library/Application Support/MultiMarkdown or /Library/Application Sup- port/MultiMarkdown. (Fletcher provides an installer that will install MultiMarkdown to one of these locations over at his web site.) 21.9 Advanced MultiMarkdown There is a nearly limitless quantity of formats and document styles you can achieve, once you learn how to harness the full power of the export engine. However these are all out of scope. Stop by our forums, or visit the wiki, to find hundreds of tips and tricks from veteran MMD users, and stay tuned for a special PDF that Literature & Latte will be producing, which will cover everything from the basics to advanced MMD usage in conjunction with Scrivener, coming some time in first quarter 2011. 21.10 Further Information Fletcher T. Penney, the creator of MultiMarkdown, is actively involved in supporting MultiMarkdown in Scrivener. He has generously contributed time and effort in writing tutorials and answering users’ questions on the forums. His own tutorials are by far the best places to go to learn about using Scrivener with MultiMarkdown. See his web site and the Scrivener forums for more information. Thank you, Fletcher!
- 286.
- 287. 21.10. FURTHER INFORMATION 279 Nothing stinks like a pile of unpublished writing. Sylvia Plath Distilling your work into a final product is an essential task for any writing application. 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 is comprised of. 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 creation 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 every- one’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, by selecting only portions of each item in the Draft to be included, such as just the title and its synopsis
- 288. 280 CHAPTER 21. USING MULTIMARKDOWN and meta-data. 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, desktop publish- ing, or scriptwriting application for final post-production work. We will discuss several common applications on the market and how best to work with them in Scrivener. Finally, we will also discuss more traditional methods of printing and exporting, 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: l Creating a Table of Contents (chapter 22): It is easy to create a static list in typical table of contents formatting, which can include dynamic page number references which will be calculated by your word processor upon opening the compiled file. l Compiling the Draft (chapter 23): Discusses compile strategies, format compatibil- ities, and gives a detailed run-down of every possible compile option. l Exporting (chapter 24): 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 available to you and how best to use them. l Printing (chapter 25): There are two ways of printing in Scrivener. One operates 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.
- 289. Chapter 22 Creating a Table of Contents While there is no support for inserting a dynamic table of contents into your draft, there is a way to produce a static list of items that is cross-referenced to page numbers during compile and that uses Scrivener Links internally to make the list useful for the author as well. Table of Contents and E-Books: Both the ePub and Kindle compile export formats have an automatic built-in table of contents generator which should often be used 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 23.10.3). The method described here can be used to produce a custom ToC in cases where the automatic generator produces results you cannot use. This feature, while it can be created in any Scrivener project, is mainly useful in con- junction with the PDF/Printing workflow and with the RTF format when compiled and opened in a word processor that supports bookmarks and cross-references. Available automatic table of contents for special formats: l For the ePub format, use the built-in Table of Contents generator during compile, which is dynamic. l With MultiMarkdown XHTML compile, specify xhtml-toc.xslt in the XHTML XSLT meta-data field. l Table of contents for MultiMarkdown to LTEXis handled by the specific XSLT in A use, but in most cases it will be included automatically and dynamically when you typeset the .tex file. 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 or the addition or removal of sections will not be reflected in the list. The first step is to select all of the items you wish to have represented in the contents. The easiest way to do this is using the outliner. 281
- 290. 282 CHAPTER 22. CREATING A TABLE OF CONTENTS 1. Select the Draft item in the binder and change the view mode to outliner. 2. Reset the disclosure states in the editor 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. 4. Press – A once again if necessary. 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. The final title output will also be examined and updated in the list. 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 formatting. 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 ToC 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 it to acquire any prefix or suffix information. Read Linking Documents Together (section 9.5) for more information. With e-books, page numbers are meaningless, so a table of contents should only link to titles. You can generate a list like this very quickly by using Edit Copy Special Copy
- 291. 283 Documents as ScrivenerLinks, instead of copying them as a ToC. E-books have their own automatic table of contents feature, but if you wish to supply your own custom list, this would be the easiest way to get a start. Once you have the list pasted in, you can format it as you want. Using a table of contents of with page numbers and PDFs is generally more portable, since page numbers are baked into the file and do not rely on dynamic features that only some word processors support. If you intend to distribute the file to a number of people, and are unsure of what word processor everyone uses, PDF will provide the most consistent result between all platforms. 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 than a digital PDF with hyperlinks and a ToC. Scrivener has no capability for the latter task. You will need to use a PDF editor to create a table of contents that can be seen in a typical PDF viewer’s sidebar. Some things to watch for: l When first opening the compiled document in Microsoft Word, you will need to generate the ToC numbers by running a test print preview once; they will appear as question marks until you have done so. l The RTF feature requires word processors capable of understanding the RTF book- mark methods. Page numbers will appear as question marks in the list if they do not. l If you are not using title generation in compile, and are instead relying on a format- ted title within the draft text itself, you may find the “Copy Documents as ToC” feature less useful and might wish to create your own from scratch using the above tips for doing so. l If some items come out with no page number, check to make sure those items are output any text. Folders that do nothing, for instance, if they were copied in the original copy command, will come up as unknown cross-references because nothing about that folder was compiled, not the text of it nor its title. l 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: l Compiling the Draft (chapter 23) l Linking Documents Together (section 9.5)
- 292. 284 CHAPTER 22. CREATING A TABLE OF CONTENTS l MMD Meta-Data (section 21.7)
- 293. Chapter 23 Compiling the Draft The main purpose of Scrivener is to provide a place that will help you write a long piece of text (whether novel, thesis or factual book), which may be structured as individual pieces in the binder but which can easily be output as one large file for working with “the rest of the world”. Thus, you write, gather and organise the material for your manuscript in the Draft folder, and when you are ready to export or print the manuscript as a whole, you use File Compile ( – E) which takes the contents of the Draft folder, formats it as you specify, and outputs (or prints) it as a single document. Using the various settings available, you can export or print your texts however you like—even regardless of how the files are formatted in Scrivener itself. Compile settings are an intrinsic part of your project; they just as much a part of it as any folder or file in your binder. They will be saved with the project and travel with it if you move it to another machine or share it with a collaborator. The available compile presets (which will be discussed shortly) are global to your machine, and can be applied to any of your projects, but once they are applied those settings are in your project. You can also save custom setups as your own presets to be used in this same fashion, or export them as portable files which can be used to share settings with colleagues, or update a second computer. At it’s most basic usage (Figure 23.1), you can select from a number of handy presets using the Format As: drop-down menu on the top, and then supply a target file format using the Compile For: drop-down menu at the bottom. MAC: In between, you’ll find common options pertaining to the file format you have chosen. For example, with the e- book formats you can quickly set up a cover image. Some of the presets use more detailed options that cannot be seen initially. If you require more detailed control of the exported file, you can click the All Options tab to reveal the full Compile interface. From here it is possible to control practically every element of your draft as it is processed into a single file. 285
- 294. 286 CHAPTER 23. COMPILING THE DRAFT Figure 23.1: Compile interface in summary mode. 23.1 Compile Summary The available settings are determined by the export format (section 23.3), chosen in the “Compile For” drop-down menu. Font adjustments, for instance, would serve no pur- pose when compiling to plain-text, so it will be removed when using this export format. The settings here will correlate to a particular setting (or set of like settings) in the “All Options” tab, and changing one will affect the other. Summary view is just that, a quick list of common options readily available, but not representative of the entire compile setup, which may perform functions that are not displayed in summary view. The following lists all of the possible options available, sorted by export format, and cross-referenced to the full option pane whence it came. Common Options These are included for all compile export formats. l Compile (section 23.5): selects the source material for the compile. Ordinarily this is the entire Draft, but you can also choose from portions of the Draft, Collections, or even based on your current Binder selection. l Front Matter (subsection 23.5.3): lets you pick from a folder of alternate front matter material that you have set up in the binder. Use this option to quickly switch between different font matter sets depending on how you are compil- ing.
- 295. 23.1. COMPILE SUMMARY 287 l Remove comments and annotations (section 23.16): disables the output of all commentary, either inline or in the inspector. l Convert smart quotes, em-dashes and ellipses to plain text (section 23.12): Enables or disables all three of these common text transformations. When viewing all options, these can be set independently. Rich Text, Web Pages & Printing This includes Print, PDF, RTF, RTFD, DOC, DOCX, ODT, HTML, and WebArchive. * Font (section 23.20): set this to “Over- ride all fonts with face” and choose a font to completely override every font setting. This doesn’t change the font settings themselves, but rather a special override which adjusts body text, titles, extraneous material (like Notes and Meta-Data), headers and footers, and footnotes. Switching this option back to “User current compile format font settings” will disable the override, and the original font selections will be used. * Convert italics to underlines (section 23.12): if the submission process requires underscoring to be used instead of italics, this feature will let you write in italics but produce a properly underscored manuscript. To convert underlines to italics, you’ll need to view all options. Plain-text (TXT) l Convert to plain text (subsection 23.12.1): depending on the choice made, actual spaces and carriage returns will be inserted into the docu- ment to emulate indents and paragraph spacing (line spacing will be ignored), as well as other effects. Final Draft 8 (FDX) l First document is title page (section 23.11): set this if the first document in your draft is a title page, so that it can be marked as such for Final Draft. l Include footnotes and comments as script notes: all notation styles will be exported as Final Draft style script notes. E-books This includes EPUB, and MOBI. l Title (subsection 23.18.2): the title of the work. This is what will show up in book lists when browsing through books in an e-reader. l Authors: this will show up when browsing by author in an e-reader. l Cover image (section 23.7): select from any graphic in the Binder to use as the e-book cover. This is typically placed on the first page of the book in the e-reader, and some software will also use it when displaying the book in a list.
- 296. 288 CHAPTER 23. COMPILING THE DRAFT l Generate HTML table of contents (subsection 23.10.3): causes a copy of the table of contents to be formatted and printed in the e-book material. A “meta- data” version of the table of contents will always be encoded into the e-book for use by readers that support quick navigation. MultiMarkdown This includes MMD, MMD-HTML, MMD-LTEX, and MMD-RTF. A l Convert comments and annotations to HTML-styled text (section 23.16): causes Scrivener to insert spans and divs around inline and inspector notation. This will cause text to appear coloured as per the original note, in most cases. Turning this off will cause comments to appear as ordinary text wrapped in square brackets. This option is only available when notes are not being com- pletely removed. 23.2 Built-in Presets In some cases, you may not need to look any further than the supplied presets that have been bundled with Scrivener. Some of these have been designed to conform to common industry standards in terms of manuscript submission and working with agents and edi- tors; others have been designed as useful working tools, such as the ability to export an indented outline, or the distribution of proofreading copies. If you wish to customise these presets, you will want to read the section on Expanded Compile Interface, directly following, and any of the Option Panes which are relevant to you. Once you have changed a preset and saved or compiled, the selection menu will revert to “Custom”. Your custom settings will always be saved in the project, but if you change presets you will lose your custom settings. If you wish to save your settings for future use, read the following section (section 23.4) for instructions on how to do so. 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 cre- ated from those templates. You can always recall the original compile settings used by a template, using the Format As drop-down menu, and selecting the template’s special preset from the list. The available built-in presets are: l Original: This is the standard compiler setting, and in a sense it isn’t really a preset, just a complete lack of one. 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, this might be the best option. or at least the best starting point. This option will appear at the top of the
- 297. 23.3. AVAILABLE COMPILEFORMATS 289 menu when starting from a blank project, but will be moved down the list, next to the special “Custom” entry (which holds your current settings), when the project was created off of a template. In that case, the template’s original formatting will be stored in an inviolate preset at the top of the menu. l 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 (up to six levels of indentation, though you can add further levels if you require). It has also been configured to accommodate synopses, which you can optionally enable in the Formatting pane. This is a useful starting point if you want a simple data sheet print out of all the pieces in your Draft folder. l Standard Manuscript Format: Formats your book using standard Courier 12pt type and a number of common conventions such as scene separators, double-spacing, underlined emphasis (instead of italic), 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 (though not file groups) as chapters, with everything else being treated as sections. You will want to adjust this in the Formatting pane, if your book structure differs. l 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 dis- tribution” 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. 23.3 Available Compile Formats The compile formats table (Table 23.1) shows all the formats supported by Scrivener, with commentary on their usage. 23.3.1 Rich Text Formats The following table shows which file format constitutes the best option when exporting for use with several popular applications, and which features are supported by those programs. Explanation of features and how compatibility is determined:
- 298. 290 CHAPTER 23. COMPILING THE DRAFT Table 23.1: Compile Formats Table Format Extension Description General Purpose Formats Print N/A Used to immediately print the compiled draft PDF .pdf Saves a quick PDF; uses “Rich Text with Attach- ments” (RTFD) as an underlying format. Rich Text .rtf General purpose rich text format supporting multiple fonts, images, tables, bullet points, foot- notes and comments. Almost always the best op- tion when exporting for use in a general-purpose word processor, including Microsoft Word. Rich Text with .rtfd Apple’s proprietary extended RTF format. Use- Attachments ful mainly for exporting to other Apple Cocoa applications such as TextEdit, especially if image support is needed. Incompatible with most word processors and all other computing platforms. Microsoft Word .doc Simple Word format exporter. It is usually better 97–2004 to export using RTF format—see the note below on exporting to Word .doc format. Microsoft Word .docx Simple Word DOCX exporter. This uses Ap- ple’s default exporter, which loses much of the formatting, including indents and line spacing. It is always better to use RTF if possible. OpenOffice.org .odt Simple ODT exporter. This uses Apple’s default exporter, which loses much of the formatting, in- cluding indents and line spacing. It is better to use RTF if possible. Plain Text .txt UTF-8 (Unicode) plain-text file. Plain text con- tains no formatting but can be opened almost anywhere, on all platforms and devices. Scriptwriting Formats Final Draft 8 .fdx For transferring your script to Final Draft, this is the best option unless you have an older ver- sion of Final Draft than version 8. Maintains synopses (as scene summaries), scene titles and custom script element formatting. Final Draft 5–7 .fcf Use the FCF converter when working with an Converter older copy of Final Draft. Supports only basic screenplay formatting.
- 299. 23.3. AVAILABLE COMPILEFORMATS 291 Table 23.2: Compile Formats Table Cont’d Format Extension Description E-book & Web Support ePub eBook .epub Generate feature-rich e-books for use in portable reading devices that support the ePub format, such as the Sony Reader or iPad (ePub files can be dragged into the iTunes Library to import them into iBooks). Kindle eBook .mobi Generate feature-rich eBooks for use in portable reading devices that support the .mobi format, such as the Amazon Kindle. Requires Ama- zon’s KindleGen, which is only available for In- tel based Macs. Web Page .html Creates a single HTML file suitable for web- publishing. Web Archive .webarchive Much like HTML, but conveniently packages ex- ported image files into a single bundle, using Ap- ple’s webarchive format, which can be opened by Safari (including the Windows version) and various Mac OS X applications. Not compatible with most other browsers. MultiMarkdown Post-processing MultiMarkdown .md Export a plain-text MultiMarkdown file, useful for archiving, or further custom post-processing. MultiMarkdown .tex Exports a L TEXformat file with full MultiMark- A -> L TE A X down parsing. Note that if you are intending to export a L TEXfile that has been handwritten in A Scrivener (without MMD), you should use the plain-text exporter, above. MultiMarkdown .rtf Export an HTML-derived RTF file with partial -> RTF MultiMarkdown support. Note that the RTF files generated in this fashion will be limited in features and formatting support in the same way as HTML, and is not equivalent to Scrivener’s standard RTF exporter in the word processor compatibility tables. MultiMarkdown .html Generates a W3C compliant XHTML file, suit- -> HTML able for web-publishing or further XML post- processing.
- 300. 292 CHAPTER 23. COMPILING THE DRAFT Table 23.3: Support Features by Word Processor Application Best Format Comments Footnotes Lists Images Head/Foot 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 RTFD X X l Comments: RTF comments are an optional way to export Scrivener’s comments and annotations. Compatible word processors will display these comments in their own fashion, usually in the margins. If annotations are exported as inline com- ments then they will be supported by all editors, as they just become ordinary text at that point. This is the recommended setting if your word processor does not support RTF comments, but you need to export annotations. l Footnotes: For compatibility, so long as a word processor supports footnotes and/or endnotes, it is considered compatible. Not all word processors support some of the more advanced footnote appearance features, such as custom number- ing styles and restarting numbering on each page. l Lists: Compatibility is considered to be simple bullet and enumeration list transfer. Specific bullet styles and custom enumeration styles may not be equally supported by all programs. l Tables: Only basic table support is required to be considered compatible. Cus- tom styling and other advanced features are not taken into consideration. Most word processors do not support nested RTF tables, but do support cell background colour and border options. l Images: Inclusion of inline images is required for compatibility. l Headers/Footers: Page headers and footers; custom first-page settings are not con- sidered for compatibility. l 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.
- 301. 23.3. AVAILABLE COMPILEFORMATS 293 l 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 oth- erwise 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 support 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): l Text Highlights: OpenOffice.org l Background colour (page): OpenOffice.org1 ; Nisus Writer Pro; Mellel; Papyrus l Custom underline styles (dotted, dashed, etc): Nisus Writer Pro; Papyrus l 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 es- sentially 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 sup- ports RTF. If you require native .doc support, then you should adjust the application preferences in the Import & Export tab (section B.10) for “Microsoft .doc export”. This will force the export process to use Apple’s more basic exporter, which will pro- duce 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 this option if you absolutely need native .doc files and RTF does not work with the target word processor. 23.3.2 Special Note on Pages Pages is a unique word processor in that it has limited RTF support. Compounding this, its proprietary .pages format is unpublished, and has no officially supported mechanisms for allowing applications to read and save to the format. However there is one loop- hole that can be used to get information from Scrivener to Pages with minimal loss of formatting: its support of Microsoft Word’s .doc and .docx formats. Unfortunately, as noted in the previous section, Scrivener does not actually produce full-quality native .doc files as this is a proprietary format for which only basic exporters are available to most Mac programs, and for the same reasons its .docx export is basic and 1 Including derivatives, such as NeoOffice and LibreOffice.
- 302. 294 CHAPTER 23. COMPILING THE DRAFT involves the loss of certain formatting. So while Scrivener allows access to these basic exporters, they will not suffice for what most people need. This means that if you use the RTF format for exporting to Pages, formatting will be lost because Pages does not fully support RTF; but if you use .doc or .docx, formatting will be lost because Scrivener only has basic exporters for these formats. The preferred method for getting data from Scrivener to Pages thus takes three steps: 1. Produce a quality RTF file from Scrivener. 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). 23.3.3 Exporting Scripts The following table shows which file format constitutes the best option when exporting for use with several popular scriptwriting applications. The guidelines below should be followed when exporting to the FCF or TXT formats 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: l Straighten smart quotes
- 303. 23.3. AVAILABLE COMPILEFORMATS 295 Table 23.4: Script Format Recommendations Application Best Format Notes Final Draft 8 FDX Supports comments and footnotes (as script notes), synopses (which become scene sum- maries), titles, dual dialogue (dialogue marked using “Preserve Style” in Scrivener becomes dual dialogue in Final Draft), revision marks, custom element formats. Final Draft 5–7 FCF FDX is always better, so only use this if you don’t have access to Final Draft 8. FCF is essen- tially a plain text format and so any formatting such as bold or italics will be lost. Also note that it only supports the basic script elements—Scene Heading, Action, Character, Dialogue, Paren- thetical and Transition. See below for important tips which will help avoid strange characters ap- pearing in the export. Movie Magic TXT See below for important tips which will help Screenwriter avoid strange characters appearing in the export, and ensure proper element conversion. CeltX TXT As for Movie Magic Screenwriter. Montage RTF or TXT Montage will do a decent job of importing script files saved in either the RTF or TXT formats (if you use TXT, follow the same rules as for Movie Magic Screenwriter and CeltX). l Convert em-dashes to double-hyphens l Convert ellipses to triple periods In the Separators pane: l Set all separator types to “Single return”. 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 pro- grams 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 19.5) for more detailed information on both export and import processes with Final Draft 8 and higher.
- 304. 296 CHAPTER 23. COMPILING THE DRAFT 23.4 Expanded Compile Interface The full compile interface (accessed by clicking the All Options tab) is where fine-grained tweaks can be made to the compile process. The full compile window is arranged into two main sections. On the left is a list of options pertaining to the currently selected export format, at the bottom of the window. Clicking on an option title in this list will reveal an associated configuration screen on the right side. You can cancel any changes you’ve made by clicking the Cancel button at the bottom of the compile window. This will exit the dialogue without compiling, and in addition, it will reset any changes you’ve made to the compile interface since you loaded it. 23.4.1 Saving and Managing Custom Presets Compile settings are saved into the project whenever you compile, or hold down the Option key and click the revealed Save button. There is no need to repeatedly save to a preset in most cases. So when should you save compile settings? You might wish to save them for use in other projects, or simply to temporarily use a special-purpose compile preset (like Enu- merated Outline) without losing all of the work you have put into your settings. Saving presets will add them to the main Format As: drop-down menu at the top of the compile sheet, meaning from that point on, you can apply them to any other project you create. To access preset management features, select the last option in the “Format As” drop- down menu, Manage Compile Formats.... A pop-up window (Figure 23.2) will appear, presenting a list of all available presets, as well as buttons along the bottom for managing them. Built-in presets are marked in grey text, and some of the functions for managing them will be disabled. You cannot, for instance, permanently delete a built-in preset. The checkbox beside each preset governs whether or not it will appear in the main “Format As” menu. This way you can store as many presets as you want, even if you aren’t using them regularly, without cluttering up the preset menu. You can toggle all on or off by holding down the Option key while clicking on any checkbox. Import. . . brings up a file browser. Locate a saved compile preset on your drive to install it into Scrivener. Export. . . The selected preset in the left list will be saved as a file on your disk which you can then use to carry to another machine, send to a colleague, or back up for safe keeping.
- 305. 23.4. EXPANDED COMPILEINTERFACE 297 Figure 23.2: Manage Compile Format Presets Update. . . Will transfer the current compile settings for your project into the selected preset. This is useful when you’ve made incremental changes to one of your presets and wish to update it for future use. Built-in items cannot be updated. To create a variation of a built-in, first apply the settings using the main Format As drop-down, make your desired changes, and then use the management window to create a new preset with the + button. Plus & Minus Buttons Clicking the + button presents a dialogue box in which you can title the preset. This is how it will appear in the preset menu, so it often works best to choose a meaningful name that you will remember in the future. You can also use the delete key. Clicking the - button will delete the selected preset. Built-in items cannot be deleted (to disable them, use the checkbox). Revert to Defaults Clicking this button will reset the checkboxes to the factory default, it will not make any changes to the list itself.
- 306. 298 CHAPTER 23. COMPILING THE DRAFT 23.4.2 Saving and Resetting Compile Settings At any point, you can hold down the Option key in the compile sheet. This will switch the Cancel and Compile buttons to Reset and Save, respectively. Reset will revert all changes you have made back to the last saved version (or preset default if you have never used compile for your project before). The Save button will dismiss the Compile sheet, but save your settings before doing so. This is useful when you want to make a change to your export settings, but do not want to actually compile the document yet. 23.4.3 The Option Panes Option panes are along the left side of the window, in a sidebar style list, when the “All Options” tab is clicked. Each export format has a variety of features available for cus- tomisation. Some of the tabs will be available to all formats, but some are only available to certain types, and others only appear for single specialised formats. Since there is a good deal of duplication, this section will go over each of the available tabs only once, roughly in the order which they would appear in the sidebar list. It will be noted in each section which formats the tab is relevant to. 23.5 Contents This option pane is a core feature available to all export formats. The Contents pane is where you define which parts of the Draft Scrivener will use to create your exported file. To accomplish this, it provides several tools of varying scope. The method with the most immediate impact is the drop-down menu at the very top of the interface, marked as 1 (Figure 23.3), which sets the “Compile Group”. Ordinarily this will have the Draft selected (which might be called something else if you have renamed it, or started with a template). In cases where you wish to proof only a portion of the book, or are working in a compound project that includes several editions located in the Draft, you can use this drop-down to select only a portion of the draft folder. Whatever container you select will include everything from that point downward, or in outliner terminology, its de- scendants. You could, for example, choose the folder called “Chapter 1”. All of the scene files included in the folder will be used in the Compile, optionally including the chapter folder itself, but nothing outside of that folder will be used. Depending upon the type of selection made with the content drop-down menu, sec- ondary options may appear alongside it. When selecting a component of the Draft A secondary drop-down menu, “Compile
- 307. 23.5. CONTENTS 299 Figure 23.3: Compile—Contents Pane Group Options” provides for two separate options on how the grouping should be handled. l Treat compile group as entire draft: ordinarily 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; chapter 13 will re- main 13. When this option is enabled, the smaller section of the Draft will be treated as though it were the entire manuscript. All counters (either in com- pile settings or in the draft itself) will 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. l Include selected container in list: the selected container is included in the com- pile group by default. If you would prefer to only see the items beneath it and downward, then turn this option off. When the above option has been set as
- 308. 300 CHAPTER 23. COMPILING THE DRAFT well, this can cause level based formatting rules to shift up by one, as the items within it are no longer level 2, but level 1. When the above option is off, all levels are computed as though the rest of the draft folder were included, and so this option will make no difference in formatting. When using the current selection This option uses the active selection in the main project window (which could be cards in a Corkboard, or items in the Binder or a Collection). As with Collection based compile groups (below), this option will produce a flat list for quick compile. If you wish to use your selection as a filter (subsection 23.5.2) against the main list, and thus preserve hierarchy. The secondary option, “Include subdocuments” will set whether or not your selec- tion should automatically include anything beneath the selected items, too. This is especially useful if you wish to compile two folders with many sectional files. You can just select the two containers, click this option on, and be done with it. When selecting a from Collection In addition to folder selection, you can also select a Collection to be used the content source. When Collections are in use, there are two important things to consider: 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. 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. Collections have no secondary options available. 23.5.1 Content Item List The item list is the large table in the middle, displaying the contents of the current com- pile group. In the case of the illustrated example, marked as 2 (Figure 23.3), the Draft has been selected, and so the entire Draft contents are revealed in the list below it. The items in this list will be indented in the same fashion that they are indented within the binder, representing their hierarchy. If you wish to use Collections or a selection to group by, but still retain hierarchy, read the next section on filtering.
- 309. 23.5. CONTENTS 301 There are four columns in this list. It is usually a good idea to initially 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 in that column. Include Linked to the Inspector option, “Include in Compile”, if unchecked the item will not be used in the final product unless the compiler has specifically be in- structed to use this checkbox in an unorthodox fashion (below). This is generally used to create static exceptions for items which will rarely or never be a part of the compiled product. For quickly filtering or selecting the scope of a compile to for example print out one or two chapters, you should use the compile group selector or filters. Title The visible name of the item in the Binder. This might be altered in subsequent compile options, or updated with a counter if it includes a token in the name. Pg 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 set special pages like title pages and table of contents. For items which create a repeating pattern where a page break would be needed, you should use Separators (section 23.6) instead of individually marking checkboxes for each item; and indeed most default settings include an automatic page break wherever a folder follows a file (often used to denote a new chapter). With some compile formats, page breaks can be important, particularly the e-book formats, which use section breaks to determine the automatically generated table of contents. As-Is Linked to the Inspector option, “Compile As-Is”. All formatting set in the formatting pane (section 23.8) will be ignored for the checked document. This also means no extra material will be added, including titles or synopsis. Text will always be included, even if it would otherwise be excluded. 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 doc- ument settings. You can however inverse the logic and only export those items marked to not be ordinarly exported—or just ignore the flags altogether and export everything. 23.5.2 Filtering Filtering is an advanced feature, near marking 4 (Figure 23.3) which uses the current compile group and applies additional criteria to filter the list down further. This works
- 310. 302 CHAPTER 23. COMPILING THE DRAFT in a similar manner to using Project Search: only those items which match the criteria will be included in the compile group list. As with the compile group 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 one of two ways, set with the first drop-down menu: l Include: Everything matching the rest of the filter will be included in the compile, non-matching items will be removed. This is the default setting. l Exclude: Everything matching will be removed from the compile. The second drop-down specifies which attribute you wish to filter by. There are four options: l 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. l Documents with status: as above, only using the Status meta-data field instead of the Label field. l 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 de- pending on the setting in the first drop-down. l Current selection: as with the content selection item, this will use the current se- lection that has been made in the sidebar, prior to opening the compile interface. 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 selection drop-down will be removed. Applied Example: Meta-data Filtering In the provided example (Figure 23.4), the Contents pane has been simplified to only show relevant interface elements. Additionally, the option to show label colour (here, renamed to “PoV”) has been enabled in View Use Label Color In Icons. Example 1 has the Filter checkbox disabled. The list is thus a pure depiction of what- ever container has been selected for compilation, in this case the top-level Draft. We have
- 311. 23.5. CONTENTS 303 Figure 23.4: Sample filtering options
- 312. 304 CHAPTER 23. COMPILING THE DRAFT labelled scenes a, d, and e with the “Joseph” character colour, and scenes b, c, and f with another character. The other items have no colour label. Example 2 shows the Filter option enabled, set to include all documents with PoV (label) of Joseph. The resulting list has been filtered to only show the three items which have had the “Joseph” label set. What you cannot see here is that it is only selecting items within the current compile group. If other documents in the project are labelled “Joseph”, but outside of the current compile group, they will not be included. Filtering only adjusts the current contents of the compile group. Example 3 is more subtle. In this case we have left the second two options alone, but changed the first option to exclude all documents with PoV of Joseph. Note that 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. Notes on Collection Filtering The basic premise behind Collection filtering is the same as when using meta-data fields. Items which match the criteria will be included, or if exclude has been set, everything except those matching items will be included. Also as we demonstrated with meta-data, the candidate items available for filtering must originally appear in the unfiltered compile group list. Even though Collections can contain items from anywhere in the project, they will not be selected for compile unless they originally fell within the compile group scope. Contrary to the method of selecting a Collection as your compile group, using a Col- lection as a filter will preserve any existing hierarchy within the original list. Of course, if the original list was itself the product of a Collection, there will be none. Thus, filtering by Collections can often produce a similar content result to selecting a Collection group, save for retaining outline structure. The one other major difference between the two methods is based on the concept described above: filters can only modify the contents of the list they have been provided with. The items listed within a Collection will be used to match against the given compile group list, and they will never produce new results outside of the original list. So if you wish to include items from a Collection that do not exist in the original compile group, you will need to use that Collection for your compile group. Collections are an effective way to arbitrarily focus your Draft for special purposes, without adjusting the “Include in Draft” checkbox for these items, but do note that this feature is secondary to the Include checkbox. The checkbox will always have priority
- 313. 23.5. CONTENTS 305 over any filter settings. Filters adjust availability of an item in the list, they do not dictate the terms of compile beyond that point. 23.5.3 Front Matter As it becomes increasingly important to be able to deliver material in multiple formats, there is a rising necessity for swapping out front matter (that material which comes before the main content of the work) depending on your compile format. A simple example of this might be a PDF delivered to a Print on Demand service, and an e-book published to Amazon or iTunes; or a proofing instruction page for your editing team, but a proper title page with contact information in a submission quality format. In one, you might want a table of contents that uses page numbers, but in the other you won’t have page numbers available, and wouldn’t want those codes visible. Using the standard methods of selection, you would need to individually toggle these variant front matter items on and off depending on what you were compiling. The Front Matter feature (near marking 4 (Figure 23.3)) makes it possible to automate and save however much of the starting material in your work into the compile preset itself. This way, when you switch to an e-book format, you’ll automatically get the right font matter material for that format. There are a few conditions which will disallow the use of the Front Matter feature (your settings will remain, but the controls will be disabled and unused for this compile), when either of the following are being used as the compile group source: l A subgroup of the Draft is selected and “Treat compile group as entire draft” is disabled. l Selection based compile groups. These prohibitions do not apply to Filters, as Filters are a secondary modifier to the main content group selection, however if the necessary items are not included in the parameters of the filter they will be effectively removed. So if you have a project that require multiple front matter folders, you’ll want to include them in any special compile selections you’ve set up for filters. Due to how filters work, this can be utilised as a creative way to filter out portions of the normal front matter when dealing with special compile settings. Selecting a folder as a front matter folder will instantly move all of the contained items (and descendants) to the very top of the compile contents list2 . This will happen no 2 For the purposes of those features which utilise the first items in the Draft—such as MultiMarkdown’s use of a ‘Meta-Data’ item—the relocated front matter items will be considered first in the Draft, even though in the Binder they are not.
- 314. 306 CHAPTER 23. COMPILING THE DRAFT Figure 23.5: Compile—Separators Pane matter where the source folder is located. If for some reason you choose a folder that is saved somewhere down toward the bottom of the Draft, choosing that folder would effectively move the contents of it up to the top of the Draft for the compile (they will remain where they are in the Binder). Ordinarily you would never want to do this, however, for if you had optional front matter options to select from, you would want to locate them outside of the Draft so that the alternates do not show up in the compile. As intimated, you can place your front matter alternates anywhere in the Binder that you please, save for the Trash. 23.6 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 realise is that by the time the compiler gets to this point, your outline is being considered as a flat
- 315. 23.6. SEPARATORS 307 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. Separators will not clean up any manually typed in separation that may exist between items in the editor text itself. For example, if you have items with a lot of empty lines in between them, the separators control will only establish if any additional separation should be added. There are four primary types of possible combinations, each with its own individual rule. You can supply the same rule for all of them if you do not need any special differ- ences between types. The types are: l Text separator: inserted between any two adjacent text documents l Folder separator: inserted between any two folders l Folder and text separator: inserted at the top of any file that directly follows a folder l 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 depend- ing on the compile format: l Single return: a single paragraph break will be inserted, causing the final appearance to run from one document to the next with no visible “seam”, and is the most minimal option you can choose l Empty line: two paragraph breaks will be inserted, causing a visible space between the items. This method will trigger a non-indented paragraph following the break, if “Remove first paragraph indents: after empty lines and centered text” (subsec- tion 23.8.3) is in use l Page break: a page break code will be inserted, causing the following item’s text to move to the next page of the manuscript l 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. This method will trigger a non-indented paragraph following the break, as “Empty line” above behaves with the referenced option above. The following formats have different options and behaviours from those listed above:
- 316. 308 CHAPTER 23. COMPILING THE DRAFT Plain-text Files In the case of page breaks, the Unicode break character will be inserted. 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. HTML, WebArchive, and ePub formats The “single return” and “empty line” options 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” option should be used to retain clean paragraph breaks between blocks. The “single 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 con- verter. MultiMarkdown LTEXformat As with the other MMD formats, use of the “empty A line” type will produce the best result in most cases. The LTEXcode for a pagebreak, pagebreak, will be inserted for the “page break” A option. Note that this will be enclosed in an HTML comment, which is the pre- ferred method for passing LTEXcodes straight through the MMD system. This A ability is disabled by default, and will need to be enabled by hand in the MMD sub-system (chapter 21). The Separators pane is available to all formats except FCF and FDX. 23.7 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. Many other e-book readers also use the cover image itself to provide their own “shelf” style interface. 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,
- 317. 23.7. COVER 309 Figure 23.6: Compile—Cover & ToC 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, nor CMYK colour space 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 must be selected from resources within the current project. If you have a cover that you wish to use with your book, make sure you have
- 318. 310 CHAPTER 23. COMPILING THE DRAFT imported it 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 only] Once a cover image has been se- lected, this option will be made available. It will include additional information 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. Do not use this option if you intend to publish using iTunes Producer. Cover page title [ePub only] You should not supply the name of your book here. This is what will be used in the table of contents internally, to identify the cover page. The standard “Cover” has been provided as a default. 23.7.1 SVG (ePub Only) This is an advanced feature which will allow you to insert SVG code which can be used in conjunction with, or instead of, a bitmap image. If you have been provided with SVG artwork code by a designer, or have created one yourself, use the SVG button to access the sheet. The text area labelled, “SVG Code” is where you will paste the vector format code. You will need to manually specify a default view box size. Get this information from your designer, the graphics program you used to create the SVG code, or from the XML itself. The actual size used is less important than maintaining the original aspect ratio. Incorrect aspect ratio values (the factor between height and width) will cause the graphic to become squashed. You will need to research which SVG standard your target readers will be using. At the time of this writing, most readers are capable of understanding SVG 1.0 and SVG 1.1 (including SVG 1.1 Basic). When copying the XML code, make sure not to include the XML declaration and doctype lines. Only paste the SVG element and its contents. This will be the line starting with: <svg version="1.1" id="Layer_1"...
- 319. 23.8. FORMATTING 311 Figure 23.7: Compile—Formatting Pane . . . and typically going to the very end of the XML file. Pasting the entire XML file will likely produce an invalid e-book. An iBooks compatible cover graphic will not be produced when using SVG covers. 23.8 Formatting The Formatting pane is where you will design the look and structure of your document. It is separated into two main areas, both 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.
- 320. 312 CHAPTER 23. COMPILING THE DRAFT 2. Formatting Editor: A format editing and live preview area, which displays the for- matting rules for the selected row, above. In the supplied example (Figure 23.7), the manuscript will print all folder titles (includ- ing any text within that folder item itself), and only text for file groups and files. It will also override the formatting to Courier 12pt, 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 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. 23.8.1 Structure and Content Table The structure table initially has three rows which correspond to the three binder basic item types that can be found in a draft folder: folders, file groups (text files that have subdocuments), and text files3 . For a moment ignore the “Level 1+” labels, we’ll get to that in a moment. In the columns to the right of each type you will find a checkbox for each content element that can be optionally included by the compiler. Think of these as optional material you can include from your project, for each item in the Draft. As Scrivener proceeds down the list of items it has been instructed 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. Creative use of this feature can produce outlines (Titles only for all types), a document with only your notes and no manuscript text, chapter containers that export only their title, 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 discuss how to change the look and feel of this in the next section. Global Changes: 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 3 Some of the provided project templates might configure a number of formatting rows beyond the basic default three. A new blank project, however, will always just have three rows, one for each type. You might want to create a new blank project in order to follow along with this explanation.
- 321. 23.8. FORMATTING 313 Figure 23.8: Example multi-level formatting rule. them into another, but be aware, this action will also paste any custom formatting settings from the lower pane 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 the table, and then click the “Add formatting level” button, indicated with an arrow (Figure 23.8). 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. To start, all configuration options 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 applying a format to the maximum depth in your draft outline. Inserting rules will thus only apply to those levels
- 322. 314 CHAPTER 23. COMPILING THE DRAFT 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 descendant 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. 23.8.2 Formatting Editor The formatting editor view is linked with the structure table above it. When you select a row in that table, you are also editing the format for that row as well. Thus, each type of binder item can have its own formatting rules, and further levels of depth in the binder can have their own formatting rules. A very simple example of this would be different heading sizes depending on the level. While added components, such as Title and Synopsis, can be formatted to your choos- ing, the main text area will remain greyed out. To make any changes to the main text body formatting, the first thing you need to do is enable the formatting override. In the header for the structure table, click the checkbox labelled, Override text and notes formatting. When this option is engaged, your entire manuscript will be given a uni- form appearance which can, if you choose, be radically different from how it looks in Scrivener. In a moment, we’ll discuss just how much can be reformatted, but for now assume the entire look and feel will be altered. This area of the pane has a condensed Format Bar, a Ruler, some special options at the top, and a large text preview area. This cannot be typed in, it shows you what ele- ments have been selected in the structure table, and how they will be formatted in the manuscript. You can otherwise treat it just like an ordinary editor. If you click in the “Ti- tle” 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 entire title, you can just place your cursor anywhere within the title and click Underline. Refer to the doc- umentation on using the The Format Bar (subsection 14.4.2) if you are unsure of what these various buttons do. E-books and Fonts: Unless you have purchased distribution rights for the font you’ve selected, fonts cannot be legally embedded into the e-book (and Scrivener is not ca- pable of performing this action; it would need to be done after compiling). Conse-
- 323. 23.8. FORMATTING 315 quently, the precise font family that you choose in this pane will probably not be the font you see in the e-book. In most cases, this is precisely what you want. The e-book reader hardware or software will provide fonts for the user, and most will want to use their preferred font and styling if give the choice. The exception to this is that the font family will be declared in the formatting meta-data, so if that font is available on the device or computer, then it will in some cases be used. Again, this is up to the software itself as to whether or not it should override the reader’s preferences with your font choice. In addition to the standard controls detailed above, additional elements will be pro- vided along the header bar of the formatting editor, if relevant to the particular format in use. Include in 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, every section in your binder will get an RTF bookmark, which will create a handy navi- gational reference in compliant word processors, and is also used to cross-reference links in Scrivener’s table of contents feature (chapter 22), or your own Scrivener Links. 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 into small blocks. Simple 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 and type of document in the ToC, or when using the linked <$p> feature for cross-referencing by page number. Click the “Help” button in this sheet for some useful examples of title prefixes and suffixes. HTML Elements When using a format based on HTML (which includes e-books), an element selector will appear next to the “Title Settings” control, using “Body text” by default—which is to say the standard paragraph element will be used. You may want to set your headings to use HTML style header numbers, where h1 is the highest level and h6 is the lowest. Each element within the formatting editor can be assigned an HTML element. Page Padding Located on the right hand side of the formatting editor header bar, this controls how much padding will be added to the top of the page when it happens to fall on a page break. Use this to offset your titles from the top of the printable mar- gins if you prefer that look. This option will not be previewed in the Formatting pane, you will need to compile in order to see the results.
- 324. 316 CHAPTER 23. COMPILING THE DRAFT Figure 23.9: Title Prefix and Suffix tab When using the plain-text output format, blank lines will be inserted wherever a page break would appear. Thus this setting can be used to visually space apart sections, even though in most text editors, page breaks not not possible. This option is not available to the MultiMarkdown formats, as this engine does not heed extraneous spacing. Level Settings The Level Settings... button provides options for adjusting the content boilerplate text around headings, heading formatting and letter case adjustments, as well as the text im- mediately following the heading. These adjustments will only appear when you compile. They will not be added to the binder items’ titles or adjust the base text itself, and are thus useful for keeping clutter out of the binder and editor. Rather than putting “Chap- ter <$n>:” into every single chapter folder in the binder, you can simply add that to the Prefix and be done with it. This means you can also more easily use casual titles for proofing prints, and more generic titles when submitting your manuscript. It is possible to type carriage returns, tabs, and other such characters into these fields, allowing you to create multi-line titles if you wish. The Title Prefix and Suffix tab (Figure 23.9) handles the insertion of text elements around the title of the binder item itself. One important thing to consider is that the title prefix and suffix entries will be printed even if the Title is disabled for that row. This
- 325. 23.8. FORMATTING 317 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 final output. These are set specifically for each formatting rule established in the above table. This means a folder on level 1 could use “Part I”, while a folder on level 2 and greater could use “Chapter 1”, while text items could use something else entirely. Once added, formatting for the prefix and suffix can be handled independently from the title. It is possible to have three different styles affixed to each of the three compo- nents: prefix + title + suffix. If you wish to maintain a uniform look, use the mouse to select all of the visible title elements before styling. Tab characters and carriage returns can be added to these fields as well, and they have been set to show invisible characters in order to facilitate designing more complex or multi-line title adornments. Prefix Anything typed into this box will be printed before the relevant binder item’s title, on that same line. If you intend to use this to insert the first part of a multi- line title, insert at least one; carriage return after the boilerplate text in this box. Suffix The contents of this box will be printed after the binder item’s title, or if the binder item is not being printed, directly after the prefix. Consequently if you intend for this to display information on a line below the main title, insert at least one carriage return prior to typing anything in. MultiMarkdown and Titles The title prefix and suffix will ordinarily 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 outside 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. Plac- ing characters before or after the hashmarks on a title line will at best cause it to no longer render as a title correctly. Title Appearance and Run-Ins In the Level Settings... dialogue, the Title Appearance tab (Figure 23.10) has three options for transforming the Title, Title Prefix, and Title Suffix, independently. These transforms adjust the letter-case appearance of the text while compiling, so you don’t have to use uppercase titles in your Binder. It also lets you use “Fake” small caps. True small caps are a function of a font’s typographic settings, and few fonts have these capability built into them. Faked small caps will adjust everything to uppercase, and then tweak the font size for each letter so that it appears to be using small caps. Consequently, this option should not be used if you will need flexibility down the road to change that in a word processor.
- 326. 318 CHAPTER 23. COMPILING THE DRAFT Figure 23.10: Title Appearance tab Fake Small Caps cannot be previewed in the Formatting pane, though they will acquire an uppercase appearance to help indicate it has been changed. You will need to compile in order to see the results. Insert title as run-in head When the title (or title suffix) is immediately followed by a standard text block (Main text, Notes, or Synopsis), it will be output in the first paragraph of that text. In the case of using a suffix on its own line, the suffix will be moved into the first paragraph, not the title. When using run-in headings, the font and character attributes of the title will be used to style the title, but its ruler settings will be ignored in favour of the Main Text settings. A single space will be added after the title, so if you want to embellish it with an em-dash or some other sequence, use a Title Suffix. This option will not be previewed in the Formatting pane, you will need to compile in order to see the results. Text Alterations In addition to the structure and formatting of the heading itself, it is possible to affect the following text in the main body with a capitalisation option. If your formatting requirements are such that the first few words of the paragraph following a title need to
- 327. 23.8. FORMATTING 319 Figure 23.11: Text tab be uppercase, then you can use the Text tab (Figure 23.11) of the Level Settings... dialogue to do so. As with all other options in this panel, they can be applied per type and level, based on the selected row in the table above. 23.8.3 Special Formatting Options Returning to the structure table, the Options... button in the table header bar will open a sheet which lets you set just how much of your custom formatting will actually be applied to the compiled manuscript, as well as a few other options. These settings are global to the entire compilation, and cannot be set specifically per formatting rule. 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; which also can be strategically administrated from the Con- tents compile options pane. This will even ignore selected elements from the structure table, such as whether Title or Notes are checked off. 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. Absolutely no options from the Formatting pane will be used when outputting these sections.
- 328. 320 CHAPTER 23. COMPILING THE DRAFT While there is no formatting to override in the MultiMarkdown workflow, this op- tion 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 itself also be titled. These titles can be formatted like every- thing else in the formatting editor in a unified fashion. You only need to edit the formatting of one subtitle to impact them all. 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. Remove first paragraph indents Utilises the common typesetting practice of discard- ing the first-line indent for any paragraph following a header and/or section break. The calculation for this can be tuned with a set of options below the main check- box. l On new pages only: first-line indent will be stripped only when the item has been configured with a page break, either via a procedural declaration in the Separators pane (section 23.6), or individually for the item, via the “Page Break Before” toggle in the Inspector. Use this when you break down your work into pieces that are smaller than reader-accessible sections in your work. l At the start of each new document: this is the default behaviour. Whenever a new document is encountered the first-line indent of the initial paragraph will be stripped out. l After empty lines and centered text: unlike the above two options, this can trigger the removal of the first-line indent from even within an individual section. A full blank line (often used to denote scenes or section breaks), or the presence of any centre-aligned text (such as a scene separator like ‘#’) will trigger it. This can be useful as a compromise between the above two options, where your outline is a casual representation of the reader-accessible structure, and might not strictly conform to section breaks or employ a mix thereof. Text Override Formatting Options This section of the options panel lets you specify just how much formatting should be changed in the source documents. Note that if you use these, any respective styling you’ve done in the formatting editor will be
- 329. 23.8. FORMATTING 321 ignored. For example, if you set the option to preserve line-spacing, then adding double-spacing in the formatting editor will do nothing. Access to this section will be disabled unless “Override text and notes formatting” is enabled. l Override font only: If all you want to change is the base font family, check- ing off this box will disable the other options and inhibit the compiler from changing alignment and ruler styles. l Preserve alignment: Left, centre, right, and full justification settings will be preserved throughout the manuscript. l 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. l Preserve line spacing: All of the spacing options, including paragraph spacing, will be left alone. Preserve Formatting only preserves Adjusts how the Format Formatting Preserve Formattingfeature works (subsection 14.4.6). The default settings will block all com- pile attempts to change formatting within the range of text within the block. Merely by enabling this feature, you automatically opt-out of special-purpose fonts within the Preserve Formatting block. Using these options, you can selectively weaken that feature to allow some types of formatting to be overridden anyway: l Alignment: Left, centre, right, and full justification will be passed through to the preserved block. l Tabs and indents: Tab stops and ruler indents will not be preserved in the block. l Line spacing: preserves any settings from the spacing configuration. This not only includes the most obvious spacing between the lines themselves, but also any offset between the paragraphs themselves. l Font size: The size of the font will be made uniform with the text around it, but not the font family. Handling Blockquotes: Blockquoting presents a unique typesetting situation in that you often need a combination of some settings retained from the Preserve Formatting block, but not all of them. A common configuration would be to enable the restric- tion checkbox, and then de-select only alignment, as blockquotes typically are set in a smaller face, using single line-spacing, and a left offset indent from the margin.
- 330. 322 CHAPTER 23. COMPILING THE DRAFT 23.8.4 Managing Formats at a Higher Level With so many options available in regards to the specific formatting itself, within the mock editor, it is useful to have management tools for moving these formats around between rows. Say you’ve set up a meticulously designed formatting template for second level file stacks, and realise that with the exception of the title prefix, you want everything else to be applied to second level text files too. You can use standard copy and paste commands to transfer all settings from one row to another. Copy and paste portions of formatting If all you want to do is copy the formatting you’ve applied from one element to another in a different area (even in a different row), click anywhere within the sample element you wish to copy from and then use the standard formatting copy and paste tools for doing so: l Copy ruler: –C l Paste ruler: –V l Copy character attributes: –C l Paste character attributes: –V The following two tools are row level actions, you must have a row in the structural table selected in order for them to work. Copy and Paste All Settings Between Rows The keyboard shortcut commands for Copy ( – C) and Paste ( – V) can be used to bulk transfer all settings for both the structural table (whether title, notes, etc. export) and the entire formatting pane below. A common tactic is to set up one row just the way you want, then paste it to all of the others and tweak them as necessary. Setting the font for all elements To set the base font for all elements within the for- matting editor, select the row for the type and level you wish to edit and use – T to bring up the font palette. Any changes made here will impact every single ele- ment uniformly, so save this method for the very beginning of the customisation process. You will lose variant, size differences, and other characteristics that have already been applied to various elements. When using this method, even if the main text area is not being overridden, the font will change. This does not mean that your draft will be reformatted (unless the override option is selected later on, of course).
- 331. 23.9. TITLE ADJUSTMENTS 323 23.9 Title Adjustments This is a special option pane in that it will only appear when Formatting rules (sec- tion 23.8.2) have, at least once, declared that a title be adorned with a prefix or suffix. These options further define how adding these title settings should function within the context of manuscript, including how other items even referring to the documents should be treated. For example, if you have instructed folders to be prefixed with “Chapter <$n>”, caus- ing that to become a part of the visible and effective title at the reader level, you can ensure that all cross-references pointing to those folders (via Scrivener Links) are likewise modified. Do not add title prefix and suffix to documents. . . Here you can set specific docu- ments to not use any prefix and suffix settings, even if they are otherwise scheduled to do so. Common examples would be the Table of Contents, Acknowledgements, and various Appendices. Note that while the Inspector option, “Compile As-Is” can also be used to inhibit title prefix and suffix on a per-document basis, doing so comes at the expense of dropping the title itself and forcing the export of the main text body for that item. Update titles in Scrivener links with prefix and suffix settings When Scrivener links directly reference a binder item title, the compiler will be instructed to update the text of the link to match the final, altered, title. Since the prefix and suffix field can contain special whitespace characters, such as tabs and carriage returns, these will be stripped out of the result in order to keep the reference inline. 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 any whitespace used in the title prefix. Click the help button, located nearby, for some practical examples of usage. Do not include title suffixes in updated links will restrict this renaming option to only use the prefix value. 23.10 Layout This is where general decisions about the overall layout of the document can be made, and as such it presents an array of different options depending on the output format. It is also where most of the book level presentation decisions (such as table of content look and feel) for e-books can be set. This panel is available to all formats except Final Draft.
- 332. 324 CHAPTER 23. COMPILING THE DRAFT End-of-Text Marker This option is available to all export formats. It will place the pro- vided text at the very end of the compiled file, signifying the end of the document. Some submission formats require a special punctuation sequence at the end, and this option can be used to keep that sequence outside of the main working area in the editor. Do not add page padding to the first document The “Page Padding” option, set up in the Formatting compile pane (subsection 23.8.3), normally inserts a blank area pushing the content of the page down from the top margin wherever a page break is encountered, or a section break, if the format uses these instead. If the first document in the draft would ordinarily create a page break, this option can be set to disable this behaviour. It will not remove the page break, only the offset padding. 23.10.1 For PDF and Print One extra option is available when printing or using the PDF file format. Empty Lines Across Page Breaks Enable “Replace empty line separators that fall across pages”, and then supply a custom separator backup. This will be used only when an “Empty Line” Separator (section 23.6) is scheduled to be used, and that line would otherwise be hidden by the page change. This is a common typesetting convention for making sure that separations between scenes are indicated at all times. 23.10.2 For Rich Text With Rich Text formatting (including Print, PDF, and the various word processor for- mats) this pane allows for some advanced page layout options, such as widow and orphan protection where applicable, hyphenation, and with RTF, column based layout. The following option is available to all of the rich text formats. Use hyphenation By default, hyphenation will not be used. When full justification is in use, this option can substantially improve the readability and appearance of the compiled result. If you intend to use a word processor to handle the compiled file, it is often better to let it handle hyphenation, instead. The remaining options are only available with the RTF format, and the Word 97–2004 .doc format when Import & Export preferences (section B.10) have been set to export .doc files as RTF-based documents.
- 333. 23.10. LAYOUT 325 Avoid widows and orphans When used with a compatible word processor, this will en- able widow and orphan4 protection for your paragraphs. Columns Columns will reformat your exported manuscript into a specified number of vertical columns. As with all compile features, this will have no impact on your visual draft, or 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. l Do not use columns for the first document: useful for title pages or the abstract block in many style guides used by the sciences. l Number of columns: the number of columns on each page can be adjusted here. Any value between two and four can be selected. l Space between columns: 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. 23.10.3 For E-books This pane is only available to the ePub and Kindle .mobi export formats. It provides additional options which impact the presentation and functionality of your book, such as cross-referenced table of contents and script formatting. Table of Contents Table of contents are often handled by the device using a special interface which lets the reader jump directly to a designated spot in the book like a hyperlink. You will rarely need to create your own table of contents by hand. Scrivener will generate a table of contents based on items which have a section break assigned to them. Section breaks are generated in two fashions: either procedurally in the Separators compile pane (by default, folders following files automatically get one), or ones you have set up manually, using the “Page Break Before” Inspector flag. Use flat list of contents in navigation controls (NCX) By default, the TOC list will be nested according to the depth of the items in the binder. To produce a flat list of items instead, enable this option. This only impacts the “software” ToC, not the HTML formatted ToC. On a Kindle, this list is not provided to the reader in the 4 Widows are remnant lines where the paragraph breaks across the page, resulting in only a few words after turning the page. Orphans are the opposite, where the paragraph begins so low down on the page that only the first line can be read before a page flip is required. This option will strive to reduce instances of this by moving paragraphs from one page to another to keep the text as cohesive as possible.
- 334. 326 CHAPTER 23. COMPILING THE DRAFT software, however the Kindle does use the NCX ToC to generate the dots that it places in the navigation progress bar at the bottom of the book page. These dots are used for navigation within the book via the joystick control, and they only use the top level of ToC entries to generate dots. Consequently, if you want dots for items of greater depth in your ToC, you will want to set this to flat list. Generate HTML table of contents In addition to a “software” ToC, which can be ac- cessed in readers that support the feature, you can also automatically generate a ToC into the text of the book itself. This increases compatibility at the expense of adding a little clutter to your book. 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 us- ing Scrivener Links (also check HTML Options (section 23.13) 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. Screenplay and Script Formatting If your e-book is composed of, or contains any script formatting, you should enable the “E-Book contains script formatting” option. Scrivener will insert special formatting rules which match the script format settings you are using in that project, and typeset these elements appropriately. In most cases, the default styling will be acceptable, but with some custom formats that have difficult to emulate styles, you may need to customise the rules which determine the final appearance in the e-book. Knowledge of the Cascading Style Sheet5 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. Element names which are composed of two or more words will use the so-called “camelCase” 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 “scene- Heading”. Single-word element names are simply addressed as a lowercase word, like “transition”. All classes should be assigned to the p element. 5 http://www.w3.org/TR/2011/REC-CSS2-20110607/
- 335. 23.11. SCRIPT SETTINGS 327 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 in most display software. 23.11 Script Settings This set of options lets you configure a few details which impact how a script will be formatted, using Final Draft 8 or greater. As such,the Script Settings pane is only available to the Final Draft (FDX) format. 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 be- tween 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 tab, will be supplied to Final Draft’s revision palette, maintaining a consistent revision system between the two applications. Use default Final Draft screenplay elements By default, when using the “screenplay” 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 format- ting. 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. Naturally, if you require a script format that doesn’t conform to the standard screenplay, make this this op- tion is unchecked, or you will lose all of your custom formatting in the compile (Scrivener’s copy will of course remain untouched). 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 docu- ment if this option is not enabled.
- 336. 328 CHAPTER 23. COMPILING THE DRAFT 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 enabled. Fonts 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 some- thing else that is commonly available. 23.12 Transformations The Transformations pane provides text and formatting conversions (where applicable). Since many of the available formats have their own unique strengths and weaknesses, not all of the options listed will be available for every format. 23.12.1 Plain Text Conversions These are useful conversion tools for translating special characters and some ruler styles to plain-text variants. These options are made available to the rich text formats as well. Straighten smart quotes Typographic quotes will be substituted with straightened vari- ants. In versions of Mac OS X Leopard and greater, the system language settings will be used to determine the proper substitutions. Convert em-dashes to double hyphens The ‘—’ character will be converted to –. If this option does not appear to be working, ensure that you have used em dashes ( - ) and not en dashes ( -) in your manuscript. The MultiMarkdown formats will convert em-dashes to triple hyphens instead, as the double hyphen is used to input an en-dash. Convert ellipses to triple periods The ‘. . . ’ character will be converted to three full stops. Delete struck-through text Any text that has had a strikethrough applied to it will be removed from the compiled file when this option is enabled, allowing a form of “soft-deletion” while editing. Do not convert auto-number tags to numbers Scrivener’s token counter system will be disabled (the tokens will remain visible). Note this only impacts the counter system. Other document tokens and replacements will still be expanded.
- 337. 23.12. TRANSFORMATIONS 329 Convert multiple spaces to single spaces Cleans up instances where the original typ- ing has two or more space characters after a full stop. Convert to plain text Actual spaces and carriage returns will be inserted into the docu- ment to emulate indents and paragraph spacing (line spacing will be ignored) and even margins. This function determines spacing by rounding up the supplied value. If the base font is 12pt, and paragraph spacing is set to 28pt (factor of 2.3) then two carriage returns will be inserted between paragraphs. If applicable, this feature is compounded with any overwritten formatting, as established in the Formatting compile option pane (section 23.8). l Paragraph spacing: add spacing in conformance to any before or after para- graph spacing in styled text. l Paragraph spacing and indents: in addition to the above, spaces will be inserted wherever lines have been indented. This works in a similar fashion, where spacing is rounded up. If the indent is roughly equivalent to three spaces, then three spaces will be inserted. This only simulates first-line indenting. Block quotes and other effects such as hanging indents cannot be simulated in this mode; use the following if you require that level of emulation. l All whitespace: with the exception of full justification, this mode will attempt to faithfully preserve all whitespace, including alignment, right-indent offset- ting, block indentation, hanging indents, and so forth. l All whitespace (add a one inch margin): in addition to all of the above, this mode also adds 10 spaces to the left of every line. Naturally, the actual size of this space will differ depending on the text editor you open the file in, and the font being used to represent the plain-text document. This option is not relevant to the FDX and FCF formats, and will be removed from the pane when they are selected. MultiMarkdown and Spacing: The “Convert to plain text” tool can prove to be of great benefit when working with the MultiMarkdown format, or indeed any plain-text marking system such as LTEX, where the original source document was typed accord- A ing to standard word processor conventions of only using a single paragraph break between paragraphs and using pseudo-spacing between the paragraphs, or indents, to achieve visual separation. Since many plain-text markup formats require a clean break between paragraphs, this option can automatically convert such a word-processor style document to a form that plain-text systems can work with.
- 338. 330 CHAPTER 23. COMPILING THE DRAFT Most of these formats do not recognise or use greater quantities of space than one, for instance five empty lines between two paragraphs is the same as one empty line, in MMD. Thus, it is safe to use this option even when a mix of spacing conventions have been used, as any overage in the correctly typed portions will not impact the output. In most cases you will not want to emulate indents with MMD, unless they have only ever been used to indicate verse or code blocks. If paragraphs have been indented for aesthetic preference in the editor, then enabling indent conversion will turn every single paragraph in your compiled document into a code block. 23.12.2 Rich Text Conversions This section provides options for automatically converting a few rich text conventions from one standard to another. They are only made available to the compile formats which support styled text. Convert italics to underlines If the submission process requires underscoring to be used instead of italics, this feature will let you write in italics but produce a properly underscored manuscript. This option is not available to any formats which produce a plain-text document. Convert underlines to italics Use when you have produced a document with under- lines, but need an italic version for compile. This option is not available to any formats which produce a plain-text document. Remove Highlighting Text highlights will be stripped from the compiled document in all cases, save for when highlights are used to indicate other features. Notably, when compiling to RTFD, Scrivener will use highlighting to indicate linked notation ranges. This setting will not impact this behaviour. Remove text color Likewise as above, this option will strip all custom colouring from the compiled document and force all text to black, without exception. Convert linked images to embedded images Available with the RTFD format. 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 or viewed from more than one computer. Since the other available formats do not support linking, they will always import and embed any linked resources during compilation. See also: Linked Inline Images (section 14.4.7).
- 339. 23.13. HTML SETTINGS 331 23.13 HTML Settings HTML Options control a few specific features in relation to the Web Page (but not .we- barchive), ePub and .mobi formats. If you wish to adjust the HTML DocType specifi- cations 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 tab (section B.10). Convert Scrivener links to HTML links When enabled, Scrivener will insert the nec- essary 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 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. The following two options are only available to Web Page compilation. Treat “Preserve Formatting” blocks as raw HTML A useful option when writing specifically for the purpose of web publishing. The Preserve Formatting tool can be used to output any raw HTML that you type into the editor, rather than its typical role of preserving formatting. Use centered table to restrict body text width The entire document will be enclosed in a div which will keep the width of the document within a certain limit and centred in the browser. The precise width can be specified in the provided text field, in pixels. The default value of 600 pixels is optimised for a character size of roughly 12 points, which will maintain a conventional line length of 10–12 English (or similar) words for maximum readability. 23.14 Replacements “Replacements compile options pane” 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:
- 340. 332 CHAPTER 23. COMPILING THE DRAFT l Replace: the text which you wish to instruct the compiler to look for. l With: whatever has been supplied in the Replace column will be replaced with what you type into this column. l Case-Sensitive: when checked, the letter case in the Replace column must precisely match, otherwise it will be ignored by the compiler. l Whole Word: restricts the match to only those incidences where it has a clear space around the phrase. “Sam” will not match “Sammy” when this option is active. Some example usages would be to replace an abbreviated version with a full proper name, to ease typing it in frequently, or inserting common editing notes. Two tabs are presented to you, “Project Replacements” and “Preset Replacements”. It is important to know that while it may sound otherwise, the Replacements in the Preset tab are in fact stored in your project as well. Everything in the compile pane is stored in your project. The fundamental difference between these two tabs is what happens
- 341. 23.14. REPLACEMENTS 333 when you work with other presets. Preset Replacements will be saved into custom pre- sets when you create your own, but Project Replacements never will. Likewise, Project Replacements are totally protected from any changes made to your compile preset. If you switch from the template settings to the proofing preset, for instance, the Preset Re- placements will be reset (usually to blank), but the Project Replacements will be safe. If you create a Replacement in one tab, but later decide that it should be in the other, you can use normal copy and paste to exchange settings between tabs. So in summary: l Project Replacements: always stick even if you change presets, and are never saved into a preset. These are best for things that are highly specific to a particular work, like character name substitutions. l Preset Replacements: are saved into your project file as well, but are volatile in that changing a preset will reset the list to whatever that preset defines (including noth- ing, if that be the case). These are best for things which suit entire categories of works. Useful expansions such as the figure caption provided in the example screen- shot are a good example of a Preset Replacement. They will always be saved into presets you create. Upgrading to 2.1: When you first load a project in 2.1, your existing Replacements (if applicable) will be placed into the Preset tab. If you would prefer some or all of them to be moved over to the Project tab, you can use copy and paste to move them. Replacements can contain other tokens, as demonstrated (section 23.14) in the fifth row, which will produce a numbered figure caption prefix, and also introduces an ad- vanced method which will be detailed below. Replacements are evaluated in the order they are defined. This means you can use use earlier replacements in your subsequent replacements, if you are feeling brave. 23.14.1 Advanced Replacements Usage Replacements can also take a special tag which will be used to match everything within the replacement match, that does not otherwise match the “structure” of the replacement tag. This is much more easily explained with an example. The character sequence $@ can be inserted into the first column anywhere within the replacement field. An example might be, ˆ$@ˆ. Now in your base text, if the replacement field encounters a caret sym- bol, it will seek for a second caret symbol and then copy everything in between those two symbols into the $@ tag. This can be placed into the With column, amidst your custom expansion code. A practical example that would be useful for those writing directly in HTML, or perhaps MMD:
- 342. 334 CHAPTER 23. COMPILING THE DRAFT ^$@^ Replaced with: <span class="index">$@</span> Will take the following example text from your compiled document: This is a ^test^ of advanced replacements. And convert it to: This is a <span class="index">test</span> of advanced replacements. The $@ character may be placed anywhere within the “With” field, but must be com- pletely contained within delimiters in the “Replace” field. 23.15 Statistics When using special placeholder tags which expand to display various statistics about the project, the options in this pane fine-tune how they work. Word and character counting tags can be inserted anywhere in your project, including some of the compile pane fields, like headers and footers. 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. 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, for example, Notes or Syn- opsis export in the Formatting pane (section 23.8), 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 op- tion and then select from the following list of inclusive options. A checkmark 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. l Main text. To adjust counting for footnote, endnote, or comment text, see below.
- 343. 23.16. FOOTNOTES/COMMENTS 335 l Notes l Synopses l Only documents matching criteria. This option functions in a manner iden- tical to the global content filtering option (subsection 23.5.2). Consult the section on this feature for full documentation on how to use 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 char- acter counts. If you are unsure, check with your publisher for which standard they use. This option pane is a core feature available to all export formats. 23.16 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 with some formats possible to treat the four of them differently. 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 comments. Since not all of the available export formats support all available options, some variants of the pane will appear differently than shown (Figure 23.12). This option pane is a core feature available to all export formats except for FDX and FCF. 23.16.1 Footnote Options Some formats do not support real footnotes or endnotes. When using these formats, Scrivener will create the appearance of endnotes by embedding look-alike text represen- tations for both the marker and the footnote itself. Since most of these formats also do not have a concept of a “page”, it will be impossible for them to generate true footnotes. Consequently, they will nearly always be inserted at the very end of the document, be- coming in effect, endnotes. When using these formats, the available options will reflect what is capable.
- 344. 336 CHAPTER 23. COMPILING THE DRAFT Figure 23.12: Compile—Footnotes/Comments Pane (RTF) The HTML based formats, including e-books, will insert hyperlink references leading from the footnote marker to the footnote text. This will allow readers to click on the marker in the text and jump directly to the footnote. With e-books, most e-book readers have a “back” button which will let readers navigate back to the place there were before referencing the footnote. 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. Export inspector footnotes as endnotes When enabled, this will export all linked in- spector 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 doc- ument.
- 345. 23.16. FOOTNOTES/COMMENTS 337 This option is only available to the RTF format, and by extension the DOC (but not DOCX) format, when RTF-based formatting is set in the Import & Export preference tab. 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. This option is only available to the RTF format, and by extension the DOC (but not DOCX) format, when RTF-based formatting is set in the Import & Export preference tab. 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 num- bering hints within the manuscript file; it is up to the word processor to handle them correctly. This option is only available to the RTF format, and by extension the DOC (but not DOCX) format, when RTF-based formatting is set in the Import & Export preference tab. 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. However, this feature does have one important side-effect: when enabled, footnotes will acquire the line-spacing and alignment settings from the most common paragraph style. This format will be used consistently for all footnotes, even if they are featured in sections which have substantially different base formatting than the rest. Ordinar- ily, footnotes pick up the paragraph settings of the paragraphs they fall after. Group footnotes. . . 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.
- 346. 338 CHAPTER 23. COMPILING THE DRAFT Available to Print, PDF, RTFD, DOCX, ODT, and TXT. The e-book formats have a similar option, but it behaves slightly differently and will be documented below. Add separator between text and footnotes Inserts a series of hyphens to set apart the endnotes from the main document, when using the plain-text format. Footnote numbering restarts on each page Instead of keeping a running tally throughout the manuscript, each page’s footnotes will restart according to the numbering methods available. Indent footnotes to match text By default, footnotes will be first-line indented to the same degree as the directly preceding paragraph, according either to the formatting rules defined, or the inherent formatting in the document if the compiler is set to not reformat. When disabled, footnotes will be flush left at the margin, regardless of any other formatting settings. Use period and space instead of superscript in markers This option conforms to the Chicago Style for note markers foot or endnote itself (not the main body text). 23.16.2 E-book Footnote Options By and large, e-books use a similar scenario to those formats which cannot display end- of-page footnotes. Since e-books do not have literal pages they must use some form of endnotes, which will be cross-referenced with hyperlinks to and from the note and orig- inal text. The special options pertaining to these formats are: Reduce marker font size The reference marker in the main text will be shrunken when this option is enabled. Endnotes page title The section name for the table of contents entry which will contain all notes from the entire e-book. By default this uses the conventional “Notes”. Group endnotes by section with subheading Within this endnote section of the e- book, notes can be sub-divided into portions, using the name of the binder item they came from as the section header. Without this option, all endnotes will be displayed together in one long list. 23.16.3 Comments and Annotations Options As with footnotes, it is possible to use both inline annotations and linked comments in the same project, and selectively handle them during compile. You may wish, for
- 347. 23.16. FOOTNOTES/COMMENTS 339 example, to use inline annotations for simple editing notes, and linked comments 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. l RTF/DOC6 : Provide additional options for utilising RTF’s comment syntax (often displayed in the margins when loaded in a word processor). Unfortunately this syntax is not widely supported. If comments refuse to show up in your word processor, try using one of the other methods listed below. l 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”. l Text based formats: For formats, like plain-text, FCF, and MultiMarkdown (when the HTML method is disabled), annotations and comments will be simply wrapped in square brackets and placed into the text where they originally appeared in the project. The following options are available: Remove inspector comments Only inspector comments will be stripped from the re- sulting 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. 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). 6 So long as the DOC format has been set to use RTF internally (section B.10).
- 348. 340 CHAPTER 23. COMPILING THE DRAFT l 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. l Inline comments: If comments are not showing up for you using the above op- tion, 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. l Footnotes: All annotations and comments will be inserted into the footnote stream along with any other footnotes (if any exist). This option shouldn’t be used unless it doesn’t matter if commentary and footnotes commingle. For purposes of ordering, they will be inserted into the stream relative to the position of the footnotes/endnotes around them. l Endnotes: This works the same as with footnotes, only they will be inserted into the endnote stream. Inline annotation enclosing markers Designated as “Enclosing markers” when using the RTF format, if annotations are to be left in place, you can set the two markers that will be used to delineate them from the rest of the text. Someone who is publishing in HTML might for instance wish to use the open and close syntax for HTML comments. Those using MMD to create LTEXfiles might do the same, as A HTML comments allow one to write raw LTEXinto the editor. A 23.16.4 MultiMarkdown Options The MultiMarkdown compile formats handle footnotes uniquely from the other format- ters. Scrivener will, by default, automatically generate and ID the necessary footnote syntax for you. An MMD marker will be inserted wherever the footnote has been placed in the document, and the appropriately matching footnote text syntax will be inserted elsewhere in the compiled MMD file. Whenever Scrivener is set up to work in this fashion, linked inspector footnotes will use a different ID prefix than inline footnotes. In ordinary MMD usage, this will make no visual difference to you. MMD does not care what the footnote ID is, so long as it is unique to the document. However, using a distinct prefix for linked footnotes gives you the option to write an advanced XSLT file to handle them differently (such as mixing endnotes with footnotes), if you wish to. Inline footnotes will be prefixed with “fn”, followed by a serial number. Linked foot- notes will be prefixed with “cf”, again followed by a serial number.
- 349. 23.17. PAGE SETTINGS 341 Convert to HTML-styled text Since MultiMarkdown has no good analogue syntax for comments, by default Scrivener will insert a styled HTML container around the comment. Both inline annotations and linked comments will be treated identically in this fashion. Since MMD will pass HTML straight through its engine, the result will be a range of text coloured with whatever colour the annotation text or com- ment 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 exported in the same fashion they are for plain-text files; enclosed in the defined markers. This latter option should be used with MultiMarkdown version 3, which is no longer XHTML based when using non-HTML target formats. Using HTML styled inline annotations in MMD3 will cause them to disappear from the output. Use the enclosing marker fields to instead inject code of your choosing. You could for instance use an open and close marker pair of: <!– marginpar{ and ‘} –>, to convert your inline annotations to LTEXmargin notes. A TIPBOX: Pro Tip: In cases where an annotation falls entirely on its own paragraph, Scrivener will use a styled <div> instead of a styled <span> to wrap the comment 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. 23.17 Page Settings Various print settings can be set up with the Page Settings pane, such as margins, paper size, headers and footers. Only formats that support page settings can use this pane, and amongst those not all support headers and footers. For these, that part of the pane will be removed. Use project Page Setup settings The project’s Page Setup settings (File Page Setup...) will be used to determine the paper size, printable area, and margins. Disabling this option will enable the margin and compile page setup buttons below. 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 25) for further documentation on how to use these features.
- 350. 342 CHAPTER 23. COMPILING THE DRAFT Figure 23.13: Compile—Page Settings (RTF) 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 factor in 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. When using the Facing Pages tab (subsection 23.17.4), symmetrical margins can be used. The right and left values will be used in alternation as is suitable for many printing specifications. RTFD, DOCX, and ODT format cannot access the following controls, as their ex- porters or formats do not support headers and footers. Additionally, if the DOC format
- 351. 23.17. PAGE SETTINGS 343 has been set to use the standard OS X .doc exporter, it will not have access to these con- trols. 23.17.1 Header and Footer Tab The header and footer area is divided into three tabs, the first tab “Header and Footer” will control these settings for the entire document. The second tab, “First Page” will control how the first page is considered for page counting and secondary header/footer settings. Finally the third tab, “Facing Pages”, can enable recto/verso layout controls for symmetrical header/footer control and margin offset alternation. Each of the tabs are very similar to one another: There are two rows for the header and footer, each with 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 a row in use at once. Formatting can be done in these fields using markup. 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. Using Special Characters: Since markup is allowed in these fields, some special punc- tuation marks set aside for markup cannot ordinarily be used. You can however in- struct the compiler to ignore special characters. If you need to print asterisks or un- derscores, you can wrap the fields in double-curly-braces. The entire row needs to be treated this way. So for example if you wished to turn off markup for the header, you would type in “{{” in the beginning of the left-aligned field, and “}}” at the end of the right-aligned (third cell) field. This would need to be repeated for the footer if desired. No header on new pages following page breaks This option is only available to the PDF and Print file format options. When enabled, the header (not footer) will be disabled on any page following a page break. Most often this will be used to keep the title page for chapters clean, as is common in typesetting. No header or footer on single pages As with the above, this option is only available to Print and PDF. When enabled both the header and footer will be removed from any page that has a page break directly following it. This would most often be seen in cases like book or part level breaks, where a single page is dedicated to some sort of title.
- 352. 344 CHAPTER 23. COMPILING THE DRAFT Header and footer fonts In the PDF, Print, RTF (and RTF-based .doc), and FDX have access to two additional settings which let you override the font with your choice for the header and footer alike. Table 23.5: Useful Header and Footer Tokens Token Description Available to Header and Footer fields <$compilegroup> The current compile group. If you wish for this to be more de- scriptive than “Draft”, you can change the name of the Draft in the Binder to be the name of your book. <$projecttitle> Project Title, as set in Project/Meta-Data Settings..., or falls back to the name of the project file itself if none has been specified. <$abbr_title> Optionally defined abbreviated project title, also defined in the project Meta-Data settings panel. This also falls back to using the project title above, or the filename of the .scriv project, if necessary. <$sectiontitle> When compiling to PDF, this will print the title of the last Binder item that used a page break. All subsequent pages will continue printing that title until a new page break is encountered. When used with RTF, this feature does not work, so the token will print using <abbr_title> instead. <$surname> The surname from the current user’s Address Book entry, or the project’s meta-data settings. <$forename> The forename; as above. <$fullname> The full name; as above. 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 useful in conjunction with the page number token. A value of “<$p> / <$pagecount>”, will pro- duce, “73 / 258” on page 73 of a 258 page manuscript. <$p-r> Prints the current page number using Roman numerals. You can alternatively uppercase this placeholder when typing it out, to produce uppercase Roman numerals. <$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 tokens (Table 23.5) 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
- 353. 23.17. PAGE SETTINGS 345 be transformed to all-caps as well. For example, if the title of the Draft folder is “My Novel”, and the token <$COMPILEGROUP> is used in the header, it will be printed as, “MY NOVEL” in the manuscript. 23.17.2 Sectional Titles When using the PDF compile format, the <$sectiontitle> placeholder tag in the header and footer fields will print out the Binder name (including any suffix or prefix) of the item which last caused a page break. In practice, this will often mean the folder in which a section is contained, but anything that causes a page break, whether procedurally via the Separators pane (section 23.6), or by hand with the “Page Break Before” inspector checkbox, will reset the value of this placeholder to its title. All subsequent pages will use this title until another page break is encountered. This feature, due to technical limitations, is only available to the PDF compile format. When used with the other export formats, the value of this placeholder will fallback to <$abbr_title>, which itself will fallback to the project title if necessary. In this fashion, you can safely use the section title placeholder in your headers, even if you intend to pro- duce both PDF and RTF compilations. When compiling with PDF you’ll get dynamic section headers, and with RTF you’ll get the abbreviated project title, or the full project title itself if an abbreviation has not been set up in the Project Properties (section 10.3) panel. 23.17.3 First Page Tab This tab contains an identical set of fields for header and footer, which must be enabled with the “Different first page header/footer” option. Each field here can specifically override the settings in the prior tab on a field-by-field basis. Page numbers count first page This option will cause the page counter token to start counting at the first page, rather than skipping it, even if the first page does not display a page number. If you are not including a title page in your manuscript, this option may be useful. Start regular header and footer on. . . Only available to the PDF and Print formats, this option lets you offset the alternate header footer settings by additional pages. The “Automatic” selection is the default, and in most cases it is safe to leave this alone if you use Scrivener’s other book management features, such as front matter (subsection 23.5.3) selection. When front matter is in use, the above header and footer settings will be used for the entirety of it, with the normal header and footer (defined in the first tab) being used for the remainder. This way you can add or
- 354. 346 CHAPTER 23. COMPILING THE DRAFT remove material from the front matter, or easily switch sets, without having to fiddle with this setting and count pages. When you are not using front matter, this setting will be equivalent to ‘2’. 23.17.4 Facing Pages Tab When “Use facing pages (alternating margins, headers and footers)” is enabled, the header and footer grid will describe the settings for the verso page, or the left-hand even num- bered page in a printed book. The initial header and footer grid in the first tab will become the recto page, or right-hand odd numbered side. This will make it possible to put a page number in the verso top-left corner and recto top-right. Additionally, when this option is turned on, the margin settings defined above will alternate. If “Left” margin is set to 0.75” and Right to 1.25”, then on the verso page the right margin will actually be 0.75” and the left 1.25”. This alternation will not be directly displayed in the settings above; you will just need to visualise the result. 23.18 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 in the document’s properties. 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. Despite the differences, all of the variations are referred to by the same name in the option pane list. 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. 23.18.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 indexing catalogues logical. The Keywords field takes values separated by commas, which will be shown as blue “pills” in the inter- face as you enter them.
- 355. 23.18. META-DATA 347 Figure 23.14: Compile—Meta-Data (General) 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. 23.18.2 E-books 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 description 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 and dedicated devices such as Adobe Digital Editions and Calibre will make use of as much meta-data as you can throw at it. The three fields which you will want to be more careful with are Language Code, the custom unique identifier, and if you have multiple authors, the Authors field. In
- 356. 348 CHAPTER 23. COMPILING THE DRAFT Figure 23.15: Compile—Meta-Data (ePub) the Language Code field, make sure you use the correct ISO two-letter abbreviation 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. For multiple authors, separate each author with a semi-colon to ensure that they all get registered as separate individuals in the e-book. The ePub format allows for multiple authors so that book searches can be done on each author independently. Amazon’s KindleGen utility does not recognise multiple authors, so only the first name contained within a bubble will be applied to the .mobi book. To ensure all authors are listed in the .mobi file, refrain from using semi-colons to separate the names, or add them later with a tool that is capable of adding multiple names to the .mobi file you’ve compiled.
- 357. 23.18. META-DATA 349 Figure 23.16: Compile—Meta-Data (MMD) 23.18.3 MMD The Meta-Data pane for MultiMarkdown compilations provides a front-end to the pre- liminary 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 HTML entities. Individual rows can be moved around with click and drag. The order of meta-data fields only matters when using MultiMarkdown version 3. You may also paste raw text meta-data into this table and Scrivener will parse it and turn it into keys and values for you. For example, if you copied in a meta-data block containing: Title: The History of Origami
- 358. 350 CHAPTER 23. COMPILING THE DRAFT Author: Ioa Petra’ka Date: March, 2011 Revision: 0.5-proof Then you would see a result similar to the one depicted in the screenshot (Figure 23.16) 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. Add “Format: complete” at end of meta-data Disable this option if you wish to pro- duce a “snippet” style compilation, or if you are using MultiMarkdown version 3, which no longer uses this field. For further information on the available MultiMarkdown meta-data fields, refer to the online documentation7 . 23.19 RTF Compatibility 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. This option pane is only naturally available with the RTF format, and also to the .doc format when it has been set to use a RTF-based code, in the Import & Export preference tab (section B.10). Strip table formatting from text Use this feature when tables are causing the RTF file to render incorrectly or not at all in the target word processor The contents of the tables themselves will not be removed, but the table cells them- selves will be. This results in a block of text that “flattens” the table contents into 7 http://fletcherpenney.net/multimarkdown/users_guide/multimarkdown_syntax_guide/
- 359. 23.20. QUICK FONTOVERRIDE 351 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 target 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 pag- ination 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. 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 modi- fies 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. Ensure hyperlinks are colored and underlined Most word processors will do this for you, but Microsoft Word will not, resulting in links that cannot be seen. Check this box to make hyperlinks visible in Word. 23.20 Quick Font Override Available to all formats except those which do not use fonts (plain-text and MultiMark- down), this option is coupled with the summary mode font selection which provides for an easy way to override fonts throughout the entire compile setup. When in use, this will set every font family in the Formatting pane, header and footer settings, and footnotes—it will even override the font in documents that have been set to compile “as-is”. A com- mon example usage would be the adjusting the submission format preset to use Times New Roman instead of its default, Courier. This option will not actually change the font selections that it overrides, so it can safely be used in a temporary capacity. Once disabled, all font declarations will go back to how they were set up initially. It also does not make any change to the font size or variant. Thus you will still need to use the font controls throughout the compile interface if you need to adjust sizes and variants (such as italics).
- 360. 352 CHAPTER 23. COMPILING THE DRAFT 23.21 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 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. Amazon’s tool requires an Intel based Macintosh computer, and will not run on PowerPC based computers. If you are on a PPC machine and need to produce .mobi books, your best option will be to use the ePub generator, and then convert the compiled .epub file to .mobi, using a conversion utility such as Calibre8 . To acquire this tool, download the software for your computer from Amazon’s web site9 . KindleGen is only compatible with Mac OS X 10.5 (Leopard) and greater, running on Intel hardware. 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. Save the KindleGen log file with the Kindle file If you are having difficulties getting 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. 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. A common symptom of having picked the wrong item is if the compiler generates an error about no .mobi file being present, after compiling, and switching on log report- ing does not end up producing a log file, since KindleGen produces this log, not Scrivener. 8 http://calibre-ebook.com/ 9 http://www.amazon.com/kindlepublishing
- 361. Chapter 24 Exporting You can export your work and research material 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 23). 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. 24.1 Drag and Drop Between Projects While it is not possible to drag items directly from the binder to other programs on your computer (including the Desktop), you can easily drag items between Scrivener projects. This will retain almost all of the documents meta-data, including its notes, snapshots, keywords, and so on. If necessary, set up the target project to have the same custom meta- data settings as the source project. For example, if you intend to drag a file from project A over to project B, and this file has been assigned to a custom meta-data value of “Oslo” in a custom “Location” column, you will need to ensure that the “Location” column has been set up in project B’s meta-data configuration prior to dragging. Scrivener will attempt to match labels and status, but unless both projects came from the same un-altered source this will likely produce undesired results. Items should be proofed for their label and status after copying them into the target project. 24.2 Exporting Binder Files To export files and folders from the binder as individual files and folders on your system, select the files you wish to export in the binder and then choose File Export Files..., or press – E. This will by default also export any descendants of the selected items as well. This way you can select an entire chapter and export all of its section files at once. You can change this behaviour by using the “Export selected files only (do not export subdocuments)” option, which you’ll find in the Export panel itself. 353
- 362. 354 CHAPTER 24. EXPORTING When exporting more than one file, Scrivener creates an folder on the disk to hold all of the exported files. Enter the name you would like to be given to this folder in the ”Save As” text field, and then choose where you would like this folder to be created. From the ”Export text files as” pop-up menu, you can choose to export text documents as one of the following: l Rich Text with Attachments (RTFD) l Rich Text (RTF) l Microsoft Word (DOC or DOCX) l OpenOffice.org (ODT) l Final Draft 8 (FDX) l Final Draft 5–7 File Converter Format (FCF) l Plain Text (TXT) l HTML All media files will be exported as they are. You can also choose to export comments and annotations, meta-data, and/or snapshots; and optionally choose to strip out all no- tation. 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 (in- cluding the synopsis, label, status and so on) will be exported into separate 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. 24.3 Exporting to an Outliner with OPML Many outliners support a common format known as OPML. In a sense it is like RTF in that it is a way for many different programs to communicate with one another, and in this case specifically to communicate outlines. That is, it can describe “headings” which are what you see in the Binder as names of items, and the relationship between those headings 1 There are a few caveats to watch for. Since traditional files and folders do 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.
- 363. 24.3. EXPORTING TOAN OUTLINER WITH OPML 355 in terms of order and There is an additional convention on top of this format which allows for some outlining programs to attach “notes” to outliner headings. Unfortunately this method of attaching notes is not a standard, and so support for it may vary in terms of quality and features. The good news is that most applications these days do support a “_notes” field. Scrivener supports the “_notes” method for attaching additional data to outliner head- ers, both on import and export. This is optional, so if you are having difficulties loading the OPML file in the target software, try using “Titles only” as your export option. This mode will adhere to the OPML specifications. Typical usage is to select (binder sidebar, corkboard, and outliner views are all accept- able places to make a selection) a container that you wish to export (all descendant items will be included), and use the File Export OPML File... menu command. You may also indicate that the entire Binder should be exported. Outliners use a “root” item concept. When you select a container to be exported, that container will be considered the “root” item. Depending on what outlining software you use, this item may not be initially vis- ible, as some default to hiding the root item. It is however stored safely in the OPML file. When exporting the entire Binder, Scrivener will create a new root item to represent what was the Binder itself, and place all of the top-level items within it (even the Trash and its trashed items). When you indicate that some extra form of textual data should be added to the outline, beyond the title headings themselves, they will be attached as notes. Due to limitations in the design of this convention, it is not possible to transfer rich text information between outliners using the “_notes” method. All material will be converted to plain-text. 24.3.1 Usage The following options are available from within the export panel: Export entire binder Rather than use the current selection, export the entire Binder outliner from top to bottom. This will include everything; even items you have currently in the Trash can. Note attachment options Using the loose convention of placing plain-text notes into a “_notes” attribute for each outline heading, you can often communicate extra in- formation to other outlining software. In all cases, save for the first, the associated data for that option will be assigned to the same binder item it came from. So if an item named “Fruit” has a description written into its index card, and you select “Include Synopses”, then in your outliner, the “Fruit” heading will contain a note field with the description from the synopsis attached.
- 364. 356 CHAPTER 24. EXPORTING l Titles Only: if attempting this gives you issues or error messages, the first option “Titles only” conforms most closely to the published specifications for OPML and should be the safest format to use. l Include Synopses: contents of any index cards, or the synopsis field. l Include Text: in this case, “text” refers to the main body text for that item, or what you have typed into it using the text editor. This will be the content of the research material, or portions of your draft as you have written them. This only includes text from file or folder items in the Binder. l Include Notes: uses the auxiliary Inspector Notes field for each included item. As with the main text option, the results of this will be converted to plain- text. 24.3.2 Limitations l This method is primarily intended for exporting an indented outline, rather than exporting meta-data. If you wish to export tabular meta-data lists, try Exporting Meta-Data to a Spreadsheet (section 24.4). l Only text material (and consequently text items and folders) can include their con- tent in the “_notes” field. Research items such as graphics or PDF files will have their heading exported into the outline (if they’ve been selected to do so, naturally), but there will be no attached notes to these items. 24.4 Exporting Meta-Data to a Spreadsheet Outliner views can be exported to formats which are suitable for loading in spreadsheet software, like Apple Numbers, or Microsoft Excel; many database style programs; and other miscellaneous programs that support data. If you wish to export a specific set of columns, or even all possible meta-data, use File Export Outliner Contents as CSV.... This menu item will be disabled unless an Outliner is currently the active view. This method is primarily intended for tabular data export. If you would refer a hierarchal export more suitable for outlining, you might want to try Exporting to an Outliner with OPML (section 24.3). Formats The three formats below are all commonly accepted by most spreadsheet appli- cations. Check with your preferred software for details. Scrivener will export the first row in the file as “headers”, so your importing software should be instructed as such if applicable.
- 365. 24.4. EXPORTING META-DATATO A SPREADSHEET 357 l Comma-separated values (best for most spreadsheet software) l Tab separated values (use this for sharing data with Tinderbox2 ). l Semi-colon separated Only include columns visible in outliner When checked, the column list and the or- der of those columns will be used to create the data file. When deselected, Scrivener will export all meta-data columns (including any custom columns you might have added) in the order that they appear in the View Outliner Columns sub-menu. 2 http://www.eastgate.com/Tinderbox/index.html
- 366. Chapter 25 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 fundamentally differ- ent 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. 25.1 Document Printing Individual documents and supported media can be printed one by one. When more than one text document has been selected in the binder, they will be printed together according to the current view mode. If you are viewing the selection as a corkboard, index card printing will be used, if viewing them in scrivenings, the text view will be printed using the text document printing settings (below). If you select a single media file, such as an image or a PDF, it will printed as per normal (as if you had loaded that file in its normal viewer and opted to print it. However if you select more than one media file, or a mix of media and text files, index card printing mode will be used instead, which you can read about in the following section. 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 358
- 367. 25.1. DOCUMENT PRINTING 359 the use of “Current Selection” as a filter. Read about doing this with the compiler contents pane (section 23.5). 25.1.1 Text Documents Print Settings Page margins can be set up with File Page Setup... or – P, and then select “Scrivener” from the “Settings:” drop-down menu. To set up how documents are printed individually (or together, when printing from a scrivenings session), navigate to the above setting pane, and then click the Options... button in the lower-right. Adjustments for text document printing can be found under the “Text Documents” tab. As you adjust these options, the preview pane above will adjust, giving you a preview of the final look. Print Options These impact the overall look and feel of the document, including the headers, footers, and base font. l 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 complete draft (if you are printing from within the draft). l 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”. l Remove annotations: By default, annotations will be left in, using their origi- nal 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. l Insert linked comments: By default, linked comments will be inserted beside the highlighted anchor range in a darker variation of the highlight’s colour. Uncheck this to keep them out of the print job. l 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 optionally 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.
- 368. 360 CHAPTER 25. PRINTING 25.1.2 Other Print Settings Since scrivenings mode is not available to media, your only options for printing groups of them will be on index cards or using the outliner printer. Consult the following sections for details on these two methods. 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. 25.2 Printing Index Cards When viewing a collection of items on a corkboard, you can print the content of the corkboard onto index card sized blocks on a page. The formatting for this has been optimised to work with Avery(tm) Perforated Index Card stock, but you can use any paper with a chopping block or scissors to cut the cards apart if need be, or even feed in regular index cards if your printer supports abnormal paper feeds. Since this method is optimised for printing to standard index card size, it will not print a perfect copy of what you see on the corkboard, and in most cases this would not be desirable anyway as the background textures and such would be a waste of ink, and longer cards would only show what could be seen without scrolling. So instead, the content of the card’s title and synopsis will be printed, and will continue to print on subsequent cards until the entire synopsis has been printed. Cards with lots of text content may take several cards to print out. if the corkboard contains images, the image thumbnail will be placed into the card area unless that item has specifically been set to display the text synopsis instead of the image thumbnail. Note that most meta-data will not be shown when an image is placed into an index card as a thumbnail. As with printing text documents, you can access options for corkboard printing in the File Page Setup... menu, navigate to Scrivener settings in the “Settings” drop-down, and
- 369. 25.2. PRINTING INDEXCARDS 361 then click the Options... button. You will find an “Index Cards” tab with the following options. As you adjust these options, the preview pane above will change to reflect your choices. l Include titles: adds the title of each card to the top. l 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. l 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. l Highlight titles with label color: the background of the title area will be highlighted 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. l Include keywords: when enabled, all keyword names will be printed out in a comma-delineated list below the title. l 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 perforated card stock, it is best to leave this option off. l 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. l 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. l Print using font: override the default font with your preferred font family and size. 25.2.1 Tips for Printing to Individual Cards With some printers, it is possible to feed individual cards into the printer, which makes for a cheap alternative to perforated cards. You will want to ensure that your printer is capable of handling thicker paper in small sizes before attempting this. Follow these steps to set up Scrivener: 1. Select the File Page Setup... menu item.
- 370. 362 CHAPTER 25. PRINTING 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. 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 manu- facturer 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! 25.3 Printing Outlines As with corkboards, you can print the content of an outliner view by simply viewing the material you wish to print in the outliner, and press – P. Also, as with corkboard print- ing, this will not attempt to reproduce the precise appearance or even all of the columns you have set, as this would lead to situations that would be difficult to print, with very wide outliners. Instead, the outliner printer function collections a lot of frequently used meta-data, and presents them in a largely linear format, which at its most basic will be the title and the synopsis for each row in the outliner. Each row in the outliner will be printed in a “block” on the page, and within this block there are three primary sections in this order: 1. Title Area 2. Content Area 3. Meta-data Area Information will be placed into one of these three areas if enabled, and the following 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
- 371. 25.3. PRINTING OUTLINES 363 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. l Include titles: adds the title in the Title Area, using a bold font. l Include synopses: the full synopsis will be printed for each item in the Content Area. l 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 parentheses. Status will be placed at the bottom of the entry in the Meta-data Area. l Include keywords: keywords will be added on the line above the synopsis, in the Content Area, in a comma-delineated list. l 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. l 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. l 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. l 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. l Include character count: as above, only printing the character count instead. l 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. l Prefix titles with number: if titles are enabled, the row number (relative to the out- liner, not the binder) will be prefixed to the title. This is a simple incremental counter, not a hierarchal counter.
- 372. 364 CHAPTER 25. PRINTING 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, “Enu- merated Outline” and customising that if necessary. Or, if you just want the data, try exporting the outliner to a spreadsheet compatible file (section 24.4). 25.4 Printing the Draft Printing the entire draft, the portion of your project that is set aside for your work in progress itself, is accomplished via the compiler, and is not unlike compiling to a saved file. You will use the same interface to print, and all of the options available to you during compilation will be functional. To print, open the compile interface with File Compile ( – E) and using the “Compile For:” drop-down menu, select ”Printing/PDF”, then click the Compile button. Once Scrivener has finished processing your draft, you will be presented with the stan- dard OS X print dialogue. From here, you can choose to save a PDF from the 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: l Read Compiling the Draft (chapter 23) for more details on how to compile. l If you want to print a script, read Printing or Exporting a Script (section 19.4) for tips.
- 373. Part V Advanced 365
- 374. 366 CHAPTER 25. PRINTING I love being a writer. What I can’t stand is the paperwork. Peter de Vries
- 375. Chapter 26 MultiMarkdown Tipsand Tricks 26.1 Functional Annotations and Comments The functional usage of annotations is a largely advanced feature for MMD, and requires the usage of custom XSLT coding to take advantage of, and requires a little understanding of how notes are compiled into the MMD document. For the most part, the XHTML element that Scrivener uses is the “span”. Commented text will be wrapped in a span element, classed as “annotation” for CSS and XSLT match- ing purposes, and then styled using an inline CSS directive to colour the span in accor- dance with the RGB value used in Scrivener to codify the annotation or comment. Put another way, a red annotation will end up styled as red in your XHTML document. MMD’s default engine then takes that a step further with LTEX, using the colour pack- A age to style text as coloured ranges in LTEX. You can thus have commented text go all A the way from Scrivener to LTEX, appearing roughly as it does in Scrivener, without the A bubble. An alternate form that Scrivener will use is when inline annotations are on paragraphs all by themselves. In this scenario, a “div” element will be used to wrap the entire section. For those versed in XHTML, the difference between the two will be readily apparent, but for the rest, this basically means that the content of a “island comment” will be capable of structural detail in a way that an “embedded comment” cannot be. An embedded comment couldn’t utilise paragraphs within the comment, because that would disturb the document flow from its original appearance, and it would also violate the XHTML specifications as paragraphs cannot exist within span elements. In practical terms, this means you can use full MMD syntax within so-called “island comments”, something you cannot do in embedded comments, you can only use simple formatting like italics and bold—anything that does not require a block element (like a paragraph, or a bullet list) to express. In a sense, this elevates island comments to a fully functional role. Using a custom XSLT which is designed to look for them, they can be used to ascribe additional semantic meaning to a document at the block level. This can also be done for embedded comments, but only so long as the intended syntax does not require a block level expression. 367
- 376. 368 CHAPTER 26. 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 directly 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 sim- ply 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 LTEX“leftbar” environment. A Due to their nature, inspector comments have no div element form, as they will always at some level be embedded within another paragraph. 26.2 Multiple Footnote Streams with MMD Each type of footnote will be exported using a different reference prefix. This prefix is just a text-based convention, and is in the default MMD installation, completely devoid of meaning. Inline footnotes will be exported with a “fn” prefix, followed by a sequential number which is incremented for each footnote that is processed. Meanwhile, linked in- spector footnotes will be prefixed with “cf”, instead. In the standard export workflows, this will actually be completely invisible to you. Both will come out looking identical, if you mixed types within Scrivener. However because a prefix has been used to denote each type, this gives you the opportunity to apply additional rules to your custom XSLT which handles each note type as a separate stream. If your work requires both footnotes and endnotes, it would thus be possible to generate an XSLT that produces these, pro- vided the final output format it is generating can handle it.
- 377. Chapter 27 Customising Keyboard Shortcuts You can customise shortcuts in OS X’s Keyboard preference pane. Just click on the “Key- board Shortcuts” tab in that pane, and then “Application Shortcuts” in the sidebar. For example (to add a shortcut to the Show Collections) follow these steps (Snow Leopard and greater): 1. Click the + button below the right list 2. Select Scrivener in the “Application” drop-down 3. Type in “Show Collections” for the menu title. This part is important, the name of the menu must be typed in completely and precisely, including capital letters, and the three dots at the end if applicable, though you do not need to type in the existing shortcut if it had one. 4. Click into the keyboard shortcut field, and then press the keys you wish to use for this shortcut. If you accidentally press the wrong keys, you can try again by clicking back in this field and pressing the right combination. 5. Click the “Add” button. Now switch back to Scrivener and test the shortcut. In some cases you may need to restart to program for menu shortcut changes to take hold. 369
- 378.
- 379. Appendix A Menusand Keyboard Shortcuts This appendix will address each item in every menu, and will display the keyboard short- cut for it when applicable. It is intended to be a quick, exhaustive reference of the menus, and will attempt to point you in the right direction for more thorough discussion and analysis of various features when necessary. See also: Scrivener Shortcut Reference1 , on the Web. A.1 Scrivener Menu Much like the application menu in any other Mac OS X program, this provides access to application level information, features, and system integration, such as Services. 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. Preferences. . . ( – ,) Accesses the main application preferences window. For a com- plete list of all available options, see Preferences (Appendix B). Reveal Support Folder in Finder [10.7 (Lion) Only] Opens Scrivener’s “Application Support” folder, where it stores your automatic project backups, custom project templates, custom icons, and so on. Use this if you wish to transfer settings be- tween machines, or if asked to do so for troubleshooting reasons. Registration. . . [Standard Version] 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 the invoice, you can use the Retrieve Lost Serial... button which will take you to a web page with further instructions on how to retrieve it. Not 1 http://www.literatureandlatte.com/wiki/doku.php?id=scrivener_shortcut_reference 371
- 380. 372 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS infrequently, invoices can end up in spam collection folders, so be sure to check your e-mail application and make sure it did not get tagged as spam, first. Check for Updates. . . [Standard Version] 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). This tool lets you 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 in this menu, and from other applications as well. See Scrivener Services (section 11.2) for further documentation. Quit Scrivener Leaves the program. Any projects that are currently open will be saved to the disk, if necessary, and backed up for you. Under the default preferences, these projects will be remembered and opened automatically the next time you run Scrivener. A.2 File Menu The File menu contains everything that handles creating files on your computer, includ- ing creating new projects, saving, backing up, importing and exporting. It also deals with printing and project-specific settings. New Project. . . ( – N) New Project creates a new Scrivener project. This will bring up the Project Templates window (see Quick Tour (chapter 6)) which will walk you through creating a new project file in the location 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 (you can also specify in the General Preferences (section B.2) whether 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 prefer- ence, which can be set in the system Appearance preference tab.
- 381. A.2. FILE MENU 373 Close Project ( – W) Closes the current project and all of its associated windows. Close Project and Clear Interface Settings ( – W) When holding down the Op- tion key and viewing the File menu, you’ll see this mechanism for closing a project. This will safely shut down the project and as a final step, trash the project’s “UI” preference file. This means the project will go back to how a brand new Blank project looks. All options such as interface component visibility (rulers, inspector, etc), splits, label tinting, columns, and other settings will be factory reset. Ordinar- ily, you’ll only ever need to do this as a troubleshooting step, or a way of fixing a layout glitch you’ve encountered. Close Window ( – W) Closes the currently active window, QuickReference, or dia- logue box. However if the project window has focus, the entire project will be closed instead. Composition mode must be exited explicitly, it does not respond to – W. Save ( – S) Scrivener auto-saves your writings as you work, so that you never have to worry about losing your efforts. Projects are also saved automatically whenever they are closed. However, you can use Save to force an immediate save whenever you want. 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 (chap- ter 7). Import Features for importing 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).
- 382. 374 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Files. . . ( – I) Import files from the file system into Scrivener. Supported for- mats 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. Research Files as Aliases. . . Rather than fully importing items into the project, this command establishes a link between the original item and the project. This link will automatically adjust if the original item is moved or renamed. Read Linking to Research Material (subsection 11.1.3) for further details. 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, optionally splitting sections into separate binder documents. This works best with scripts that have been exported from CeltX and Movie Magic Screenwriter. From SimpleText.ws Integrate with the SimpleText.ws service. You will need to provide your account log-in information. This will allow you to retrieve 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 transferred. 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. Export Provides tools for exporting elements of the binder to the file system. For more information on exporting your work, see Exporting (chapter 24). Files. . . ( – E) Allows selected contents of a project to be exported as files and folders onto the hard drive. This feature should primarily be used to create a hard copy backup, or to share resources with someone not using Scrivener. Generally speaking, you will want to use Compile to export your book. Outliner Contents as CSV When an Outliner view is active, this menu com- mand will activate. It will export the current Outliner view in a format that is readily accessible to spreadsheet software and other programs capable of tabular display. See also: Exporting Meta-Data to a Spreadsheet (section 24.4)
- 383. A.2. FILE MENU 375 Comments and Annotations. . . Exports just the comments and annotations from the project into a single file. Optionally you can choose to export only the pre-selected binder items. Sync Tools for linking parts of your project to external applications, mobile devices, or disk-based files and folders. Read more about syncing in Cloud Integration 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, Sug- arSync, and so on. Read more in Synchronised Folders (section 13.2). with Simplenote. . . Method for synchronising individual files or folder content as plain-text to the Simplenote server, which can be used with a variety 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.3) 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.5). Back Up Functions for managing backup copies of the current project. For more in- formation on back up strategies, see Backing Up Your Work (section 7.7). Back Up To. . . Generates a backup copy of the project to a specified location. Backup copies, unlike “Save As”, will be created and then ignored by Scrivener, you will keep working in the current version of the project. Op- tionally, you can choose to compress the backup in a zip archive, which takes longer, but is the recommended method for storage of backups on network drives. Back Up Now Triggers the automatic backup system to produce a backup imme- diately, using the preferences for backup location and rotation scheme. Cus- tomise how this works in the Backup preferences tab (section B.11). Exclude From Automatic Backups Removes the current project from the auto- mated backup system. This is useful when the current project is very large, 2 http://www.denvog.com/iphone/IndexCard/
- 384. 376 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS and is causing you to have to wait for long intervals while the automatic sys- tem 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 your future projects. For more information on creating templates, read Templates (section 7.6). For full documentation of the printing process, read Printing (chapter 25). Page Setup. . . ( – P) Accesses the standard page layout setup pane. Additionally ac- cesses 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. Compile. . . ( – E) Compile is the standard method for producing a manuscript out of all the pieces in the Draft. This feature provides an immense degree of flexibility, and is fully documented in Compiling the Draft (chapter 23). A.3 Edit Menu The Edit menu contains options related to editing. All of the standard Mac Edit menu items (with which you will be familiar from such programs as TextEdit) can be found here, including cut, copy, paste and find, alongside with a large complement of Scrivener- specific features. 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 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.
- 385. A.3. EDIT MENU 377 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 command. l Copy as HTML: Reproduces most formatting as HTML codes using inline CSS. The resulting HTML should look very similar to the text you copied in Scrivener, including some ruler settings, colour, highlight, and so on. l Copy as HTML (Basic using <p> and <span>): Applies minimal inline CSS for- matting. Ruler styles and some types of formatting will be lost. This is often the best choice for pasting into blogging and Content Management Systems, which provide their own stylesheets. l Copy as HTML (Basic using <br>): Applies very basic, HTML 4.01 compliant code. When constructing HTML e-mails, or working with an older web site, this is what you will want to use. l Copy as BBCode: Translates most basic formatting into BBCode, suitable for forum posts. Because BBCode does not support as many formatting features as full HTML+CSS, some elements will be lost. l Copying without Comments or Footnotes: ( – C) will strip out all annota- tion and footnote text, while retaining all other formatting. Most often this is useful for producing “clean” snapshots (section 14.9) after an editing session. This command will remove all notation, including linked notation. The following menu commands operate on selected documents, not text: l Copy Documents as Scrivener Links: Ordinarily, when you copy a selection of documents, pasting them will just list the names of the documents. This command will also build links back to each of the respective documents. l 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 22) for further information. Paste and Match Style ( – V) This pastes the contents of the clipboard without any of its existing fonts and styles, in essence, treating it like plain-text. 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.
- 386. 378 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS 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 in the text editor, this alternate method will be displayed. It is useful for selecting only the text in the section you are currently editing within a Scrivenings session, rather than the entire session. Select Group with Descendants ( – A) When holding down the Option key with an active item selection (excluding on corkboards), this alternate method will be dis- played. It provides a useful shortcut to select an item and all of its descendant items at once. This can be useful when performing an action that requires a literal selec- tion. Corkboards cannot use this function, as they can only display one level of hierarchy at a time. Complete ( Esc) Manually calls up the word-completion service, regardless of word auto-completion settings. Can optionally be invoked with – . or simply Esc by itself on some keyboard layouts. 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.9) to automatically detect Scrivener links typed in with [[Document Title]] wiki-style bracketing. Add Selection to Auto-Complete List Adds the currently selected 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
- 387. A.3. EDIT MENU 379 may not see anything happen unless you have Format Options Show Invisibles enabled. 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.7) for more information on inserting im- ages into your text. Line Break ( – Return) Inserts a soft-break instead of a full paragraph break. Use this when you need to create a list within a single paragraph. Page Break Inserts a page break within the current text. Note that, as in TextE- dit’s “Wrap to Window” mode, page breaks are invisible and will only show up when printing or exporting to a fully-featured word processor, or if you have “Show Invisibles” enabled. Typically, it is best to let Scrivener handle page breaks by section, using the “Page Break Before” option in the inspector. Non-Breaking Space Inserts an space character which will prohibit word-wrap from dividing two or more words from each other. For the purposes of word- wrap, it will consider a sequence of words separated with non-breaking spaces as a single word. Word Joiner Inserts an invisible Unicode character which has zero-width, but otherwise acts just as a non-breaking space. Auto-number Scrivener has a number of internal counters which are repre- sented as tokens in the text. These will be counted and printed in the desired format when compiling. For full documentation on how to use the various counters, see Placeholder Tags (Appendix C), or Help Placeholder Tags. Draft Word Count Inserts a token which will be calculated during Compile which indicates the word count for the entire manuscript. There are a num- ber of rounding options available, for cases where precise counts are less im- portant. This and the next menu title will change according to the name you have chosen for the Draft folder.
- 388. 380 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Draft Character Count As with “Manual Word Count”, inserts a token for the total character count. Again, rounding options are available. Bookmark Annotation ( – B) Inserts a special inline annotation at the begin- ning of the current line used to populate a document’s bookmark menu. See Text Bookmarks (section 14.11). Bookmark Header Annotation Inserts a special inline annotation at the begin- ning of the current line. This will start a new section in a document’s book- mark menu. See Text Bookmarks (section 14.11) for more information. Endnote Marker This special placeholder will collect all of the endnotes in a project and place them at the location of the marker. This will be especially useful for some academic formats, which do not place endnotes at the very end of the text. If you are using multiple streams to compile both footnotes and endnotes, this marker will not impact footnotes. This requires endnote grouping to be enabled in the compiler. See Foot- notes/Comments (section 23.16) for further detail. This method does not work with the RTF (and .doc, if it is set to use RTF mode) format. Horizontal Line Inserts a rule at the cursor position. Three choices are provided: l Centered Line (roughly 80% of the page width) l Page-spanning Line (from margin to margin) l Signature Line (shorter, left-aligned rule) Current Date & Time ( – D) Inserts a plain-text date-stamp based on your system’s Long Date and Long Time format. Sort Paragraphs Requires a text editor selection of more than one paragraph (line) to activate. Once active, will re-organise each selected paragraph in an ascending or descending fashion. Append Selection to Document Provides a sub-menu populated with all of the doc- uments in your project. By selecting one of these, the text currently selected will be added to the end of that document (this can be a folder or a file). If it is your intention to move the text instead of copying it, after issuing this command, you can simply press the Delete key. Use the New... sub-menu choice to create a new document containing the selected text. You will be asked where to place this new document in a subsequent sheet.
- 389. A.3. EDIT MENU 381 Add (Edit) Link. . . When adding a link, this tool works for hyperlinks of all types. To create a new Scrivener Link, see below. If the cursor is not placed within a link, you can use this command to make a new one. It will be inserted into the current document at the cursor position, automatically selecting the nearest word if necessary. The sheet will provide you with several common prefix options, or optionally no prefix. If the cursor is currently placed inside of a link (including Scrivener Links), this command will let you edit the destination for that link. Scrivener Link Creates a new Scrivener Link to a chosen document at the current cursor position, using the linked-to document name, or if you have pre-selected text, the original text will be turned into a link and no name will be inserted into the document. Using this menu, 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 in the current editor. Read more about Linking Documents Together (section 9.5). To adjust what Scrivener does after the link is created, visit the Navigation prefer- ences tab (section B.6). 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. This will not erase the underline text itself, it will simply remove the link from the text. To delete both the text and the link together, select the linked text and delete it as you would normal text. 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, in- cluding 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 20.1). 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.
- 390. 382 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS 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, copy- ing 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 posi- tion 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 replace text throughout the whole project. This operation cannot be undone, 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 20.1) for more information on how to use them. Find Synopsis. . . Opens a pop-up window with an integrated real-time search tool and index card view below the search results table. This feature can be used to rapidly located items based on the text of their Title or Synop- sis fields. Its key advantage is being able to do so without disturbing your project window view settings. Read Find Synopsis (subsection 20.1.4) for fur- ther documentation on this feature. 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 Formatting” tool, which now also allows a much wider range of formatting that can be searched for. Find by Formatting. . . ( – F) Opens the Find by Formatting panel. This tool is quite powerful and has a wide range of options, please see Searching and Replacing (section 20.1) for full documentation. Find Next / Previous Formatting ( –G / – G) As with Find Next and Find Previous, will let you jump from match to match within a single docu- ment, even without the “Find by Formatting” panel open.
- 391. A.4. VIEW MENU 383 Spelling and Grammar Accesses OS X’s spelling and grammar tools. Note that most of these can be set to different defaults, in the Corrections tab (section B.9). l Show Spelling and Grammar: ( – :) Opens the standard Spelling and Gram- mar panel. If you wish to change the base language the spelling and grammar checker uses, you can set that here. l Check Document Now: ( – ;) Will start checking for misspellings from the current cursor position downward. l Check Spelling While Typing: ( – ) Turns on the automatic spell checker which will underline in red, unrecognised and misspelled words as you type. l Check Grammar With Spelling: Also turns on grammar checking, which will look for poor style or grammatical errors as you type and underline them in green. 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. l Look Up in Dictionary and Thesaurus: Sends the currently selected word, or the word that the cursor is currently located within, to Apple’s Dictionary application. You can also use – D to do quick spot-checks l Search in Spotlight/Google/Wikipedia: Uses the currently selected text or ac- tive word to search the selected resource for results. Google and Wikipedia searching requires an active Internet connection. l Name Generator: A unique Scrivener tool which will generate names based on a wide variety of criteria. Read more in The Name Generator (section 20.4). Special Characters Loads the OS X Unicode character browser. Use this to insert char- acters that are not found on your keyboard. A.4 View Menu The View menu contains all of the commands related to changing the way documents are viewed, allowing you to show and hide various elements, navigate between views and customise the way information in the current project is displayed. A rule of thumb is, if you want to change the way something in your project looks or acts, and it’s not a setting in the main options, chances are it is in the View menu.
- 392. 384 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS View Modes are various ways in which you can view the presentation of multiple items in the editor. For and overview of how view modes work, see View Modes (section 5.2). Document/Scrivenings ( – 1) If multiple items are selected in the editor, displays the current editor as a Scrivenings text editing session, showing the text of each doc- ument as if they were a single file. Also sets your preferred collection view mode to Scrivenings. See also, Editing Multiple Documents (section 14.12). Note this option is only useful if the editor is displaying documents, media will not be mixed into an Scrivenings session. If a single item is selected in the editor, or if the editor is currently displaying a Scrivenings session, this menu item will be labeled Document, and switch the editor focus to its text or media view. Corkboard ( – 2) Display the current editor as a corkboard. If the selection is a con- tainer, its children will be shown as index cards. Also sets your preferred collection view mode to Corkboard. See also, The Corkboard (section 12.1). Outline ( – 3) Display the current editor as an outline. Also sets your preferred collec- tion view mode to Outliner. See also, The Outliner (section 12.2). The menu items, “Go To” and “Text Bookmarks” sub-menus are also available from the header bar icon menu (subsection 14.5.2). 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 section is hoisted, for instance, will let you navigate to other areas of the project without having 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. Holding down the Option key while selecting an item from this menu will cause it to be opened in a QuickReference panel, instead of changing the current editor. l Previous Document: ( – UpArrow) Jumps to the previous document in the binder, according to strict outline order (ignore hierarchy). l Next Document: ( – DownArrow) As with Previous Document, but selects the next document in the strict outline order.
- 393. A.4. VIEW MENU 385 l Enclosing Group: ( – R) Will display the currently edited item in context with its siblings using the current view mode. In most cases, this will select the immediate parent of the document, selecting the document’s index card or outliner row that you came from, for your convenience, or expand your current scrivenings session to include the siblings and parent of the current text item. l Editor Selection: ( – 4) jumps directly to the text component of any selected item. This works as an isolation feature in Scrivenings, or can also be used to quickly open selected item(s) from Corkboard or Outliner as text (even if they are containers). The difference between this command and – O or –O is that these latter two will respect the typical view load priority setting. In other words, if the selection is a container, these commands will load that item in a view. – 4 will always load the selected item as a text file. When more than one item is selected, they will be loaded as a composite Scrivening in Multiple Selection mode. QuickReference Similar to the Go To menu, except that the selected item will be opened in a QuickReference panel, rather than replacing the contents of the editor. The contents of this menu will be populated by the binder in all cases. Collections Provides commands for setting visibility and options of the Collections feature. For documentation on how to use Collections, see Using Collections (sec- tion 8.3). Show (Hide) Collections Reveals or hides the collection interface which will ap- pear above the binder. Note the sidebar will need to be visible for this menu option to be available. Convert to Standard Collection When a Search Result Collection is the active tab, this command will “freeze” the results and turn it into a regular collec- tion that is no longer dynamically updated. This is a one-way process that cannot be undone. To freeze a search result list without converting the origi- nal collection, simply select the entire list of items and add a new collection. The selected items from the search result will be added automatically to this new collection for you. Next Collection Select the next Collection tab in the stack Previous Collection Select the previous Collection tab in the stack
- 394. 386 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS 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 as- signing keyboard shortcuts to oft-used collections. 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 combined in a long list, when using a Scrivenings session. Zoom Provides shortcuts to the zoom menu, located in the footer bar for text docu- ments. Temporarily zooms the display of the font up or down to increase legibility, without adjusting the underlying font size. This will also increase or decrease the size of a viewed PDF. l Zoom In: ( – <) makes the text larger. l Zoom Out: ( – >) makes the text smaller. Layout The commands in the Layout sub-menu affect the main window elements. Show (Hide) Binder ( – B) Toggles whether or not the binder (subsec- tion 5.1.2) sidebar is visible on the left of the main window. You can hide the binder to concentrate on editing or composing the current document if you so wish. Show (Hide) Inspector ( – I) Toggles whether or not the Inspector (subsec- tion 5.1.5) is visible on the right of the main window. The inspector displays all meta-data for the current document, including synopsis and notes. The inspector is hidden by default. No Split ( – ’); Split Horizontally (’ – =); Split Vertically ( Command-") These commands allow you to choose how to view the main editor in the main window. For more information on using splits, see Splitting the Editor (section 14.8).
- 395. A.4. VIEW MENU 387 Swap Editors Only available when Split Horizontally or Split Vertically is se- lected (see above). This commands swaps the position of the two split panes. For example, so that the view on the top will become the view on the bottom and vice versa. Show (Hide) Header & Footer View Toggles the visibility of the header and footer bar. Both are elements of the editor and can be toggled independently for each split. See Writing and Editing (chapter 14) for more information on what these do. Show (Hide) Layouts ( – )) Toggles the Layouts panel, which allows you to manage view settings by saving the current settings, or retrieving other set- tings you’ve saved in the past. See Layouts Panel (section 9.7). Editor Options and commands for controlling the main editor. 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. Scroll to Next/Previous Page These menu commands will only activate when Page View is enabled on the active editor. They will flip the scroll bar by page, rather than by relative position, as the keyboard PageUp and PageDown keys do. Show Titles in Scrivenings When enabled, editable titles of documents will be placed in the editing session along with their associated texts. Titles can be independently styled to set them apart in the Formatting tab (section B.8). These will only appear in Scrivenings mode. Forward/Backward in Document History ( – [ and – ]) Like a Web browser, the editor keeps track of everything you’ve visited. Using these commands you can navigate back and forth in the history. Note you can also use the Forward and Backward buttons in the header bar. Each split keeps its own history. When selecting a number of documents in the binder prior to entering com- position mode, the history queue will be pre-stocked with these selected items, so long as the main editor is not set up in Scrivenings mode. Other Editor Provides controls to manipulate whichever split is not currently active.
- 396. 388 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS l The Forward and Backward in History commands ( –] & – ]) op- erate just like the above commands, only in the opposing split without moving focus there. l The Scroll Up and Down commands ( – UpArrow & – DownArrow) act like PageUp and PageDown, only in the opposing split, again without moving focus there. Clear Document History Use this command to wipe out the document history for 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 mech- anism, 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). Show Page View ( – P) Toggles Page View on and off. These two options toggle between using your global page size preferences (which can be entirely fictional, if you desire), or your print settings for a more accurate depiction of the page. 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.7). 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.7). Two Pages Across When enabled, instead of displaying pages in vertical column, two will be placed beside each other as though reading a book. Media Controls and options for various types of media. These commands will only become available when viewing the appropriate type of media. * 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.
- 397. A.4. VIEW MENU 389 l Automatically Resize: Keeps the PDF sized to the width and height of the editor window. l Actual Size: Zooms the PDF to 100%, even if it is too large to display all at once. l 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. l 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. l 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 be- tween a text document and a media file, and you are typing in the text docu- ment, 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. * Fast Forward/Rewind ( –] / – [) Will jump playback forward or backward by two seconds. This shortcut works while playback is running, or while paused. In the latter case, it will stay paused at the new position. As with Play Media File, will work in the opposing split while typing, providing further aid for transcription. Corkboard Options Features and visual options for the corkboard. The settings in this menu are project specific, and some of them will only impact a single split, allowing you to have different view settings for each editor. For more information on using the corkboard, see The Corkboard (section 12.1). Note that further op- tions 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
- 398. 390 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS three. Auto-fit 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. Show (Hide) Pins ( – P) Toggles whether the coloured pins are displayed on the index cards. Pins take on the colours associated with the labels that have been assigned to the documents represented by the index cards. If you are using the Rounded Card theme, pins will be displayed as colour swatches on the upper right side of the card. The appearance of pins can be adjusted in the corkboard tab (section B.4) of preferences. Show (Hide) Stamps ( – S) Toggles whether stamps are displayed on index cards. Stamps show the current status associated with the document repre- sented by the index card as though it has been “stamped on” the index card. The appearance of stamps can be adjusted in the Corkboard tab (section B.4), and the Appearance tab (section B.3). Show (Hide) Keyword Colors ( – K) Keywords assigned to a document can be visually indicated along the right-hand side of the index card as coloured pieces of tape. The number of keywords that can be shown at once can be changed using the corkboard display options button. For more information on using keywords, see Setting Up Meta-Data (chapter 10). Show Card Numbers Cards will be numbered according to their sequence in the binder outline structure. Ordinarily, this will match the order in which the cards appear, but in Freeform mode, this can be a valuable tool as the order of cards are likely to become desynchronised with the actual manuscript struc- ture. Number Per Section When more than one container has been selected, and the corkboard is displaying cards in Multiple Selection mode, card number will be re-started for each new section. Otherwise, cards will be numbered in the order they appear from start to finish. 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. See also: Freeform Corkboard (subsection 12.1.3). Commit Freeform Order It is possible to instruct Scrivener to use the current freeform layout to re-order the actual manuscript outline structure. Scrivener
- 399. A.4. VIEW MENU 391 will provide several options for how this should be done. For more informa- tion on how to work with Freeform Corkboards, see The Corkboard (sec- tion 12.1). Outliner Columns Displays a list of toggles which will reveal or hide the correspond- ing 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. See also: Managing Columns (subsection 12.2.1). 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 interface elements throughout Scrivener. This menu contains a list of toggles which will en- able tinting to the corresponding elements. The intensity of all background tinting can be adjusted in the Appearance preferences tab (section B.3). l 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. l 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. l 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. l 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 navigating 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 between com- mon elements, while the rest will jump immediately to that element of the inter- face, 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 visible. These shortcuts will not automatically reveal parts of the interface that are currently hidden.
- 400. 392 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS l Left/Right/Top/Bottom Editor & Binder: ( Tab) This menu item follows a chain of the three most common areas of desired focus, the primary split, secondary split, and the binder. It will cycle between these three going left to right, and the label of this menu item will be changed to indicate where the next target will be. l Binder: ( – B) Moves focus to the binder sidebar from anywhere in the interface, if visible. l Left/Bottom Editor: ( – E) Moves focus to the Left or Bottom editor, if the editor has been split. Otherwise selects the primary editor if there is no split. l Right/Top Editor: ( – R) Moves focus to the Right or Top editor, if the editor has been split. If it has not been split, this shortcut will not be available. Inspect A continuation of the navigation functions, these deal solely with the reveal- ing and focussing of elements within the Inspector. All of them work on the fol- lowing principle: if the keyboard shortcut revealed the item (it was hidden 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 necessary, which counts as a “reveal” action. l Synopsis: ( – I) Reveals or switches to the index card in the inspector (will use the last inspector pane coupled with the synopsis and meta-data panes, if necessary). l Notes: ( – H) Reveals or switches to the notes editor within the inspector. l References: ( – N) Reveals or switches focus to the references table. * Key- words: ( – J) Reveals or switches focus to the keywords table. Arrow keys can be used to navigate amongst keywords; Return can be used to add new key- words; and Delete to remove keywords. l Snapshots: ( – M) Reveals or switches focus to the snapshot text area, al- lowing quick copy and paste of its contents. l Comments and Footnotes: ( – K) Reveals or switches focus to the comment list. Arrow keys can be used to navigate amongst contents; and expand and collapse notes. Outline Provides navigation and disclosure commands which work in both the out- liner 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
- 401. A.4. VIEW MENU 393 folders” is enabled in Navigation preferences (section B.6), the definition of con- tainer will be expanded to include document stacks as well. l 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. l 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. l Previous Container: ( UpArrow) Will select the previous visible container in active outliner, no matter what the depth. In this case, previous means a con- tainer higher on the list than the current position. If a container 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. l Next Container: ( DownArrow) Works the same as Previous Container, only selecting the next visible container downward from the current position. Reveal in Binder ( – R) This command is available the editors and any collection view in the sidebar. It will show the location of the currently edited (or selected) file(s) in the binder, opening containers as necessary to do so. This is most useful when the method you used to arrive at the current document did not involve click- ing in the binder. This menu command is also available from the header bar icon menu. Binder Affects Adjusts which split binder sidebar clicks will be opened in. 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. When any of the following options besides “Current Editor” is selected, a small icon will be placed at the top of the binder sidebar. This icon will provide a visual aid in demonstrating which editor is currently receiving clicks. l Current Editor: Default behaviour as described above. l Other Editor: Whichever editing split is not current active.
- 402. 394 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS l Left/Top Editor: The left/top editor no matter which editor is active. l Right/Bottom Editor: The right/bottom editor split, no matter which editor is active. Enter (Exit) Full Screen [10.7 (Lion) Only] Utilises Lion’s full screen implementa- tion, expanding the main project window to occupy the entire screen. In this mode, the project window will be moved to its own “Space3 ”, and cannot be resized until Exit Full Screen has been invoked. Exiting Full Screen mode will return the project window to the original Space that it came from. [New in 2.1] The menu command by this name was previously used to invoke Scrivener’s full screen text editing mode. The name of this feature has been changed so as to not conflict with Lion’s standard naming convention. Enter (Exit) Composition Mode ( – F) Enters the full screen writing environment, switching to text editing mode if necessary. If the editor is displaying a Scrivenings session, the entire session will be opened in full screen. Note this option is not available to media and web pages, or any other view modes. [New in 2.1] This feature used to be named “Full Screen”. It has been changed to avoid conflicts with the Lion feature by the same name. Even if you are not running Lion, the new name will be in use for the sake of consistency. Composition 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 re- sources in the project will be listed in this menu, or you can select Choose... to select an image from your computer. To remove an image you’ve already set, select None. Show (Hide) Toolbar Toggles the visibility of the main application toolbar. 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. 3 Apple’s term for virtual desktops, where you can create a fresh empty desktop for a particular session of work.
- 403. A.5. PROJECT MENU 395 A.5 Project Menu The Project menu addresses commands and configuration options which are specific to the active project, such as document format over-rides, custom meta-data, statistics, and more. If more than one project is open, this menu will target the foremost project win- dow. 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 below the current selection, or the location of the document that is being edited. New Folder ( – N) Creates a new folder document at the current selection. Folders will always be created as a sibling to the current selection. For more information on the differences between files and folders, see Project Planning (chapter 12). 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 tem- plate folder is set, this menu will also be populated with the children of that tem- plate folder, which may need to be set with Project Set Selection As Templates Folder, below. Read more about Document Templates (section 8.4). For tricks on how best to use text and project statistics, read Goals and Statistics Track- ing Tools (section 20.3). Show (Hide) Project Targets ( – T) Toggles visibility of the targets floating panel, which lets you track a few simple metrics in real-time as you type and edit. This can be left open while you work. Project Statistics ( – S) Opens a window displaying the statistics for the current project, including the word and character count for the draft and for the current binder selection. Text Statistics ( – S) Opens a window displaying statistics for the current document (and thus only available when a text document or Scrivenings are focussed). Project Notes ( – P) Displays the project notebook in a separate window. For more information on using project notes, see Project Notes (section 12.3).
- 404. 396 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Show (Hide) Project Keywords ( – H) Displays or closes the Project Keywords (section 10.2), for managing all of the keywords in use by your project. [New in 2.1] This feature has been renamed from “Keywords HUD”. Meta-Data Settings. . . ( – ,) Displays a sheet which lets you adjust the two main doc- ument meta-data fields (Label and Status by default, but these can be renamed), as well as the custom meta-data columns for this project. See also: Setting Up Meta-Data (chapter 10). Text Preferences. . . Displays a sheet which presents a configuration pane very similar to the one found in the Formatting tab (section B.8) of application preferences. 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. Additionally the linked footnote mode can be modified to use an anchor marking, instead of highlight words and phrases in the main text editor. Read more about Text Preferences (section 10.4). Edit Auto-Complete List. . . Displays a sheet which lets you manually add and remove terms to the project’s auto-complete list. Depending on your auto-completion set- tings, this will let you add custom names, places, and workflow indicators to assist in typing out repetitive items. Modify how agressive auto-complete should behave in the Corrections preference tab (section B.9). Set Selection 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. 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.
- 405. A.6. DOCUMENTS MENU 397 A.6 Documents Menu The Documents menu contains all commands relating directly to documents, such as duplicating and splitting documents, viewing them in combination, moving them, and hoisting the binder to view isolated parts of the draft. 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 vertical. For example, if the focus is in the bottom editor of a horizontal split, the label for – O will be “in Bottom Editor”. as QuickReference Opens the selected document in a QuickReference panel, rather than any active or inactive splits. in Quick Look This menu command is only available for types of files which Scrivener does not recognise. It will hook into the Mac’s Quick Look sys- tem and display that file according to its Quick Look settings. With All Subdocuments as Flat List If the selected item has subdocuments (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. This command is essentially a macro for selecting the container and all of its chil- dren at once, producing a flat corkboard in Multiple Selection mode. l On Editor Corkboard: ( – O) Replaces the current editor view with the selected item’s contents. This is similar to pressing – O to open selected cards on the corkboard, only it also will add all of their descen- dants to the corkboard as well.
- 406. 398 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS l On Other Editor Corkboard: As with above, but uses the split editor to open the item, instead of replacing the current view, creating a split if necessary. (With) Compilable Subdocuments Working in a manner similar to “With All Subdocuments as Flat List”, this creates a view with only those items which have been set to Include in Compile (subsection 10.1.5). Unlike the previ- ous tool, this command uses your current view mode, so this will produce a Scrivenings session, corkboard, or outline view depending on your prefer- ence, though if the result of the action produces only one text document, it will revert to using the text editor. Read more about Filtering Items in Views (section 9.9). in External Editor ( – O) This command is available on any type of item that is not a text or folder document. It will open the file using the default editor for that type of file. An example would be opening a picture in Preview. Opening items this way allows them to be edited in their native applications, and the results of those edits (if Scrivener can display the file type) will be visible upon saving that file, if Scrivener can display that file type in the editor. Snapshots Provides commands to manage a document’s snapshots, make new ones, and commit large-scale snapshot actions on selected items. For more information on how to use snapshots, see Using Snapshots (section 14.9). Note that in some cases these shortcuts will not be available. Generally this happens when the selec- tion includes items which are not text items, or the text of the item(s) are empty. Take Snapshot ( – 5) Available when viewing any text or folder document, this command will take a snapshot of the current text and store it for later use. When more than one item is selected, the title of this item will change to “Take Snapshots of Selected Documents”. All selected items will be snapshot. Take Snapshot With Title ( – 5) As above, but will prompt you for a descrip- tive title prior to taking the snapshot, which will be displayed next to it for future reference. When more than one item is selected, the title of this item will change to “Take Titled Snapshots of Documents”. The supplied title will be applied to each snapshot taken for all selected items.
- 407. A.6. DOCUMENTS MENU 399 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 func- tion in View Inspect Snapshots provides the shortcut key, – M. Show Changes When a snapshot is selected from the snapshot list, it is possible 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. l Compare/Original: Toggles visibility of the change tracking mode. l Comparison Granularity: These options can be toggled on and off in- dividually 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 avail- able. Use these settings to fine-tune the results if what you are getting is too precise or vague to be useful. l Next Change: ( – ]) Scrolls the view to the next available difference in texts. l Previous Change: ( – [) Scrolls the view to the previous difference. The following two commands will only activate when a snapshot selection is active in the Snapshot Inspector pane. Roll Back Rolls back to the selected snapshot, replacing the text in the main edi- tor. The option to snapshot the current editor text, before making this revi- sion, will be given in a pop-up dialogue box. Delete Permanently removes the selected snapshot from the disk. You will be asked to confirm this action as it cannot be undone. You may also delete snapshots with the backspace key, or by clicking the - button in the Snapshots Inspector. Duplicate There are two different methods you can use to duplicate the selected item(s). l with Subdocuments and Unique Title: ( – D) This is the default method in most applications. The entire item (including all of its children if it has any) will be duplicated, and it will be provided with a unique name automatically.
- 408. 400 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS l without Subdocuments: ( – D) Also referred to as “Simple Duplicate” in prior versions of Scrivener, this is most useful when you only want to du- plicate the container of an item by itself, such as a chapter folder, but not all of the scenes within it. In this case, a unique name will not be provided. Set Selection as Title ( – T) Available when text has been selected in the main edi- tor, the title for the current document will be replaced with whatever text has been selected. Move to Trash ( – Delete) As you no doubt guessed, this moves selected items to the trash. It will use active selections in the Outliner or Corkboard, as well as in the binder sidebar. Split Provides a couple of methods for splitting the current document into two differ- ent documents. In both cases, everything below the current cursor position will be moved into a new document below the current one. Everything above the cur- sor will remain unchanged. This action cannot be undone (except via the Merge command, below). l 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. l 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 document in the selection as the “template” for any of the merged document’s meta-data that cannot be otherwise combined, such as labels and status. This action cannot be undone (except via the split command). 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 controlled in the General preferences tab (section B.2), under Separators.
- 409. A.6. DOCUMENTS MENU 401 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. l 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. l Left/Right/Up/Down: Use – with the appropriate keyboard arrow key to move items around in the outline. Left and Right will promote or demote the item in the hierarchy; Up and Down will change its order in context with its siblings. On the Corkboard, which does not show hierarchy, the arrows will move cards around spatially amongst one another. Add to Collection Displays a list of all standard collections in the project. The cur- rently selected item(s) will all be added to the collection you choose. This com- mand is also available in the binder contextual menu. Sort Sort acts on the children of a selected container, and sorts items alphanumeri- cally, 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 another 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. In other words, hoisting will display the selected container all by itself in the binder sidebar. 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.3) instead.
- 410. 402 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Unhoist Binder Returns the binder to full display. Favorites Provides commands to manage your favourite documents. Favourites will be displayed in various places around the interface, particularly in item selection menus, at the top of the list, such as “Go To”, “QuickReference”, “Scrivener Link”, and more. Add to Favorites Adds the selected item(s) to the favorite list. Remove from Favorites Will remove the selected item(s) from the favorite list, ignoring those selections which are not already there. Clear Favorites Wipe out the entire favourite list with one command. Manage Favorites. . . Displays the Favorite Management Palette wherein you can change the order in which they will appear in the interface, remove one or more selected items, or drag new items into the palette to add them to the list. Convert Provides tools for converting the document’s type, writing mode, or format defaults. l to Folder/File: Converts the selected item(s) to folders or files. Note that these two are very similar in Scrivener, so this tool makes it easy to change your mind later about whether or not something should be a folder or a file. l Web Archive to Text: Activates when viewing a WebArchive item. Will anal- yse the archived page for its text content and create a rich text alternative that is editable and considered a text document from that point onward. Note this cannot be undone, create a duplicate of the web archive, first, if you wish to retain a copy with its full layout. l Formatting to Default Text Style: If the font and ruler styles of the document do not conform to the application or project defaults, you can use this com- mand to use those to reset its appearance. Read more about this feature (sub- section 14.4.5). l 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 docu- ment 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 19).
- 411. A.7. FORMAT MENU 403 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 auto- mated 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. Append Synopsis to Main Text Operates in an inverse fashion from above. The con- tents of the index card’s synopsis field will be appended to the end of the main text editor, corresponding to the selected card(s). Useful if you’ve done a little pre- composition in Outliner or Corkboard mode, and now wish to push those ideas into the manuscript text. This command will be inactive unless the selection contains at least one card with a synopsis. Selected cards without a synopsis will be ignored. 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. l 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. l Manage Icons. . . : Reveals the Manage Icons Palette, where you can add or remove your own custom icons either to the project, or make them available globally to all Scrivener projects. For more information on managing and creating icons, see Custom Icons (section 12.4). A.7 Format Menu The Format menu contains all commands that deal with formatting the text of an indi- vidual document. It contains all of the usual OS X commands (previously found in the Text menu in older versions of Scrivener) for changing the font, setting line spacing, cre- ating tables and lists and controlling the ruler, along with commands for highlighting and setting the current text colour. Additional Scrivener specific tools for formatting the text can be found here as well, including various forms of notation, text conversion utilities, and bibliography software integration.
- 412. 404 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Font Displays the standard OS X Font submenu, which contains useful tools for con- trolling the character-level appearance of your text. Fonts family, variant, and size can more easily be controlled with the The Format Bar (subsection 14.4.2). l 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. l Bold/Italic/Strikethrough: all of these operate in the same fashion by either modifying the future behaviour of typing if there is no selection, or toggling the selected text between the various styles. Note that not all fonts support these styles. If it appears that one of these is not working, check your font for proper variant support. l Underline: has been expanded from the system default menu item to provide additional support for underlining styles, including dotted, dashed, and by word. l Remember Typing Style: use to set up fonts and ruler styles in blank docu- ments. Ordinarily, if you change formatting settings on a blank document, 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 empty Document Templates (section 8.4). Since having text in a file preserves any formatting made to that text automatically, this menu com- mand will be unavailable in file that has content in the main text editing area. l Outline: changes the style of the font to outlined instead of filled. l Bigger: ( – =) increases the size of the font by one point. l Smaller: ( – -) decreases the size of the font by one point. l Kern: supplies access to the OS X typographic kerning engine. l Ligature: if the font family supports typographic ligatures, they can be en- abled or disabled here. l Baseline: adjust the baseline height of the text, most commonly referred to as superscripting and subscripting. l Character Shape: if the font family supports typographic shape alternates, they can be adjusted here, such as Old Style Numerals. l Show Colors: ( – C) toggles the visibility of the colour selection palette. Note that Scrivener uses this palette in a number of different places, not strictly related to text colour.
- 413. A.7. FORMAT MENU 405 l Copy/Paste Font: ( –C / – V) copies the font settings from the current cursor position. Use Paste Font to apply these settings to other selections of text. Text Displays the standard OS X Text submenu, which contains useful tools for con- trolling the paragraph-level formatting of your text. Paragraph alignment and spac- ing can also be controlled with the The Format Bar (subsection 14.4.2). l Align Left/Center/Justify/Right: controls the text alignment of the current paragraph, or all paragraphs falling within a selection range. l Writing Direction: toggle between Left-to-Right and Right-to-Left writing styles. l Keep with Next: inserts an invisible character which will keep this paragraph together with the next paragraph, so that they will not become separated by a page break. l Copy/Paste Ruler: ( –C / – V) Copies the ruler and paragraph format settings from the current paragraph. Use Paste Ruler to apply these settings to other selections of text. l Spacing. . . : accesses the advanced paragraph and line spacing palette, which can also be found on the Format Bar, off of the line-spacing sub-menu. Indents Handy controls for indenting text in a variety of fashions, or to glob- ally increase or decrease the indentation level for the selected paragraphs. All method adjust indentation in increments of 0.5cm; 0.25in; 1.5pc; and 18pt. l Increase/Decrease Indents ( – RightArrow or – LeftArrow): moves the indent level for all items inward or outward. This command will maintain the overall indent format of the paragraph. If it is a hanging in- dent, for example, it will remain a hanging indent, only with both indent settings moved one way or the other. l Increase/Decrease First Line Indent: adjusts the first-line indent marker inward or outward. l Increase/Decrease Hanging Indent: adjusts the indent value independent of the first-line indent, forming a “hanging indent” where the first line is leftward of the rest of the paragraph. l Increase/Decrease Right Indent: adjusts the block indent level, moving both the first-line and main indent markers at an even increment. Useful for block quotes.
- 414. 406 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Table Inserts a default table into your document at the cursor position unless you are already in a table. In both cases it will also open a floating configuration window containing 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 window, 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. The management commands in this menu are also available by right-clicking on a table in your editor. Lists Supplies basic list styles, and few advanced controls for bullet and enumerated list management. The list creation aspects of this menu are also available when clicking on the list button in the Format Bar. l Next/Previous List Style: ( – RightArrow / – LeftArrow) selects the next or previous built-in list style available and converts the current list to that style. l Custom List. . . : build your own custom list type using the standard OS X tool for doing so. Formatting Provides tools for creating and applying ruler and font presets4 to your text. For more information on using the presets system, including its menu com- mands, see Formatting Presets (subsection 14.4.3). Scriptwriting Although Scrivener is not a dedicated script writing application such as Final Draft or Montage, the Scriptwriting submenu does make it relatively straight- forward to create first drafts which can be later fine-tuned in these applications. For full documentation on this, see Scriptwriting (chapter 19). 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 paragraph formatting bar, which provides quick access to many of the most common types of formatting tools. 4 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.
- 415. A.7. FORMAT MENU 407 Highlight The highlight menu lets you place a background highlight behind the se- lected 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 provided colour until you disable the revision mode. This menu provides access to these lev- els. For more information on using this, see Marking Revisions (section 17.5). The first menu slot will alternate depending on whether or not you have any selected text in the active editor. The two entries will be marked accordingly below. Remove Current Revision Color (No Selection) Only active when one of the revision levels has a checkmark beside it. This will strip the active colour from the active editing session. As with many commands that work on this level, it works across an entire Scrivenings session if applicable. Mark Revised (Selection) When a text selection has been made and a revision level is in use, this will let you mark text ranges with the current revision colour. This can also be done by clicking on the text colour tool in the Format Bar, as it it will be reset to the current revision level while in use. Select the text you wish to mark, and click the text colour chip, or use this menu command. Remove All Revisions Indiscrimintely removes all five revision level colours from the active editing session or text selection. 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 footnotes, it is possible to export them as endnotes during compile. Comment ( – 8) Attaches a comment to the selected text (or previous word), making 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. Inline Annotation ( – A) Converts the selected text into an inline annotation, or tog- gles the writing mode to annotation mode. Useful for placing notes right in the editor, alongside the relevant text.
- 416. 408 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Inline Footnote ( – F) Converts the selected text into a footnote, or toggles the writ- ing 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. To Uppercase Converts the selected text to all uppercase characters. To Lowercase Converts the selected text to all lowercase characters. To Title Case Converts the selected text to title case, which takes into account common English grammar conventions. To Small Caps If the current font supports proper small caps, the text will be converted to that variant. However it will fake the results using font sizes otherwise. If your workflow requires true small caps, be certain the font you are using can handle them. Quotes to Smart/Straight Quotes Converts between typographic “curly” quotes and straight inch and foot marks. 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 sending off to the printer. Inline to Inspector and Inspector to Inline Conversions These four com- mands allow you to convert inline annotations to linked Inspector comments, vice versa, and footnotes. These commands work on the entire current document. Options Provides options which impact the display or behaviour or the text editor. l Show (Hide) Invisibles: toggles visibility of hidden control characters, such as paragraph breaks, tabs, spaces, page breaks, and so on. A few control charac- ters do not have associated special characters
- 417. A.8. WINDOW MENU 409 l Show Line Numbers with Ruler: adds a paragraph (line feeds within a para- graph will not be counted) numbering feature to the standard and composi- tion mode Ruler ( – R), which must be visible for this feature to work. Para- graphs will be numbered in the left column. You can also optionally elect to have Scrivener only count every fifth paragraph. Line numbering is not available when Page View is in use. l Show (Hide) Compile Footnote Numbers in Inspector: On by default, after you compile and all footnotes have been counted up, their numbering will be printed in the Inspector alongside the footnote itself. You can also optionally instruct the compiler to ask you if these numbers should be updated, every time you compile. l Typewriter Scrolling: ( – T) toggle a feature which keeps the currently edited line of text in the middle of the screen, vertically centred. This setting is global, but will impact composition or the regular editors independently, de- pending upon the current mode. Bibliography/Citations. . . ( – Y) If a citation manager has been set up in the General tab (section B.2) of Scrivener’s preferences, this command will launch or activate the set manager, allowing you to select a citation and paste it back into Scrivener using whatever system that application provides. A.8 Window Menu The Window menu contains commands for controlling windows and panels along with a list of all open window 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.
- 418. 410 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS Layouts / This Sub-menu is populated by the saved layouts you’ve created with the Layouts panel. It allows easy access to switching these sets of view configurations. This menu will not appear if no layouts have been saved on your computer. 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. Float QuickReference Panels ( – Q) Toggles whether or not QuickReference panels should float over the project windows. This setting impacts all QuickReference panels created from the current project. Panels from another open project will behave in accordance with that project’s settings. Show (Hide) Scratch Pad ( – ) Displays or closes the floating Scratch Pad Panel (sec- tion 11.4); useful for collecting information while using other applications. Bring All to Front Brings all Scrivener windows to the front. Hold down the Option key to change to Arrange in Front. The rest of this menu will be populated by all of the windows (excluding panels, like the Project Keywords window) that are currently open in Scrivener. Selecting from this list will bring that window to the front. QuickReference panels will be separated into their own section, if any are open. Closed Panels During a single session, any QuickReference panels that have been closed will be saved into this sub-menu, giving you quick access to them if you need to re- open them. A.9 Help Menu The Help menu provides standard access to Snow Leopard’s menu search utility, as well as useful tools and links for learning Scrivener. A note on performance: large projects that contain many items in the binder will cause this menu to exhibit a noticeable delay, thanks to the menu search feature. This is a limitation in Apple’s code, and there is no good way around it.
- 419. A.9. HELP MENU 411 The Search menu is the only menu that can be directly activated from the keyboard. Tap – to call it up. This will place the cursor in the search field (on Snow Leopard only), so you can begin searching immediately. Scrivener Manual A quick link to the PDF that you are likely reading. The version that ships with Scrivener will be kept as up to date as possible, but newer revisions might also be available on the web site’s support page5 . 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 tutorial 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, so long as it hasn’t been deleted or moved. Video Tutorials A handy hyperlink to our web site’s video page6 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 window 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. 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 page7 which provides easy access to everything else we offer on our web site. Scrivener Home Link to the main Scrivener page8 , where you will find useful download 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 address and name to subscribe to our newsletter. This is a low volume list that we use to 5 http://www.literatureandlatte.com/support.php 6 http://www.literatureandlatte.com/videos.php 7 http://www.literatureandlatte.com/ 8 http://www.literatureandlatte.com/scrivener.php
- 420. 412 APPENDIX A. MENUS AND KEYBOARD SHORTCUTS send out important updates and news. Please take care to whitelist “litereatureand- latte.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.
- 421. Appendix B Preferences Like most applications, Scrivener installs in a “ready to use” state. The default prefer- ences have all been carefully selected to present a cohesive and useful writing environ- ment. Preferences should thus be considered an optional, and perhaps even slightly more advanced way of using Scrivener. This manual has described the application in reference to its defaults, but there are a great many ways to tweak the interface and behaviour of the application to suit your preferred working style. This appendix will thoroughly doc- ument every single preference item, as presented to you in the Preferences window itself. This way, if you wish to seek clarification on a particular option, you can find it using the manual’s list of preference tabs, and then within that section, sub-sections will separate groups of preferences in accordance with their visual grouping in the application. Because Scrivener is a multi-project application, preferences are sometimes split into different areas so that you can supply new projects with some starting preferences, but allow some of them to deviate from the norm, if needed. 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 can diverge from the project and application preferences in certain ways. Not all preferences work in this “cascading” fashion. The ones that do will be indicated as such in their notes. Many of the preferences that are wholly project specific make no appearance in the application preference system at all. A good example is whether or not labels 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 globally1 . All of the project specific preferences are located in menus or in the Footer Bar for the respective view, and of those in menus, most are in either the Project menu or the View menu. This section will not cover these specifically, though some might be mentioned in 1 Actually, initial project settings are handled by the template you choose when creating a project, so you should consider project templates a form of “secondary” preference. Read more on Templates (section 7.6) to learn how to use these to adjust Scrivener’s behaviour with a brand new project. 413
- 422. 414 APPENDIX B. PREFERENCES passing where applicable. Instead, this section strictly focusses on the application prefer- ences dialogue. For information on specific menu options, see the appendix Menus and Keyboard Shortcuts (Appendix A). In the preference tab, you will be presented with row of icons along the top. Each of these icons leads to a sub-section, or tab, of the application preferences. The rest of this appendix will deal with each of these sub-sections in turn. If you close and re-open the preferences window later in a single session, the last sub-section you were looking at will be preserved. As with many Mac applications, preferences are enacted and saved as soon as you change anything. This means you do not have to worry about clicking any buttons once you are done; just close the preferences window. It also means that if your screen is large enough, you can leave the preferences open to the side and tweak things until you get them looking and acting the way you want. Along the bottom of the preference window you’ll find a Manage... drop-down menu and a button labelled Defaults. The latter button will do a “factory reset”, returning everything in the preferences to their default states. This cannot be undone, but you will be warned after clicking the button and given a chance to cancel. B.1 Preference Presets and Themes The Manage... drop-down menu has several options available for organising or backing up preferences, as well as access to any presets you might have saved. This can be partic- ularly useful if you work on more than one computer, and in the case of themes, if you prefer to use darker colours at night and brighter colours in the day. Load/Save All Preferences Save your preferences to an external file for either backup purposes, or to synchronise your settings between multiple computers. Preferences can be loaded, replacing the current settings completely, with the Load command. Save All Preferences as Preset. . . Presets are simply a convenience feature for organ- ising different preference sets. In cases where you need to use varied settings for different projects, this will make it easy to switch sets on the fly. The name that you provide will be displayed in this menu in the future. If you wish to update an existing preset, make any changes you see fit, and then use this command to save the preset under the same name. You will be asked for confirmation before the old preset file is overwritten. Load/Save Theme Preferences Themes differ from the above in that they only save and load partial preferences. They only operate on those preferences which govern ap-
- 423. B.2. GENERAL 415 pearance, such as interface colours (standard and composition mode), corkboard and outliner appearance, and optionally, fonts. Fonts can be saved into a theme by checking off the appropriate boxes in the Save Theme window. These commands work with files, and so are useful when synchronising settings between computers, sharing your theme settings with others, or loading theme settings you’ve down- loaded from the Internet. Save Theme Preferences as Preset. . . Similar in function to saving all preferences as a preset, this makes it easier to store and switch between multiple theme settings without having to manage individual files. B.2 General General preferences govern the application’s basic behaviour, its integration with other programs, and how appending or merging text with existing documents should be pre- sented. B.2.1 Startup Options Reopen projects that were open on quit Whenever Scrivener is launched, projects that were not closed when you last quit will be automatically reopened, bringing you straight to what you were last working on. 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. Reopen QuickReference panels when opening projects Ordinarily, QuickReference panels (section 20.2) are session based. If you close the project and come back later, they will all be gone. With this preference enabled, all projects will remember any QuickReference panels left open when it was closed, and will re-open them for you the next time you load the project. Automatically check for updates If this is checked, whenever Scrivener is launched it will check the website to see if there is a newer version available and, if so, will ask you if you want to update. Note that if you do not have this checked, you can still check for updates by choosing Check for Updates... from the application (Scrivener) menu. The drop-down menu beside this option governs how frequently Scrivener will check for new versions. If you want to stay on top of the latest updates, “Daily”
- 424. 416 APPENDIX B. PREFERENCES is generally good enough, but if updating frequently is disruptive to your work habits, you can set this down to check by week or month. B.2.2 Saving Auto-save after n second(s) of inactivity Scrivener automatically saves changes made to projects, but so that it is not constantly saving—and to avoid any slowdown and interruption to your work this might cause—Scrivener waits to save until you stop interacting with the program for more than two seconds (by default). You can change the period Scrivener waits to auto-save with this preference. If you increase the period significantly, be sure to use File Save regularly to force saves to your project. Scrivener will always auto-save when you close a project. Automatically name untitled text documents upon saving When enabled, text docu- ments that have been left untitled will acquire the first few words from the docu- ment. This will not trigger until you have added a second line or typed around one complete sentence into the first line. This way, your documents do not get titled until the wording has settled down a bit. B.2.3 Services Options for how Scrivener’s clipping services should work. For more information on available services, read Scrivener Services (section 11.2). For the least amount of inter- vention, set both of these options to off. Bring Scrivener to front when using Services Choose between active and passive clip- ping. When this is checked, clipping from other applications will be “active” in that it brings you to Scrivener after you’ve used a Service. When unchecked, it will work “passively”, staying in the background and allowing you to work in other programs while you add material to Scrivener. Show title prompt when using clipping Services Normally, when you use a service that requires the creation of a new item in the binder, you will be asked what you wish to call it. When unchecked, this option will defer that task until later, when you are ready to think about names. B.2.4 Separators This table lets you configure how Scrivener will combine individual texts when certain actions bring them together. In all cases, you have three choices of divider available:
- 425. B.2. GENERAL 417 1. Single Return: Inserts a single paragraph break between selections. If two para- graphs appear together, there will be no whitespace between them, save for any style-based paragraph spacing in use. 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. If you wish to insert carriage returns along with the custom separator, use Return to do so. You can assign separators to four different instances: 1. Merged documents: Determines how documents will be merged when using the Documents Merge command. Note that this setting only affects the main text. The inspector 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 Doc- ument command, the selection will be separated from the existing text by this op- tion. 4. Scratch pad notes: When appending text to documents from the scratch pad, incom- ing text will be separated from existing text by this option. B.2.5 Scratch Pad Hot key Sets the global hot key for showing or hiding the Scratch Pad. Since this key will be accessible from any application on your Mac, you might need to change this if it is conflicting with another application you use. This tool will warn you if you select a shortcut that is already registered globally on your Mac. Notes location Your scratch pad notes are stored on the hard drive using RTFD files. This option lets you choose where those files will be automatically saved. By de- fault, they will be stored in your Documents folder, under a special folder that Scrivener will create for them. In secured working environments, you might wish to alter the location of this to reside in an encrypted drive or disk image on your system. If you do use an encrypted disk image, add it to your login start up list so that it will always be available.
- 426. 418 APPENDIX B. PREFERENCES B.2.6 Miscellaneous When you first start using Scrivener, actions which have a destructive or unusual nature (such as importing in such a way that original formatting might be lost) will produce a warning dialogue. You can often choose to disable these as you see them from within the warnings themselves. The Reset All Warnings button will clear all of these dismissals and make them appear again the next time it is appropriate. Bibliography/Citations Manager Scrivener can integrate with several popular bibliog- raphy management programs. Use this option to select your favourite from the Applications folder. The reset button will clear your choice. Pro Tip: This merely links which application will launch to the – Y shortcut. If you do not use a citation manager, but frequently use another program along with Scrivener, you could use this feature to quickly launch or switch to that program. B.3 Appearance Most preferences relating to Scrivener’s appearance can be modified here. In a few cases, options which modify appearance, but are more related to the specific function they fall within, will be located in the special section for that function. A good example are the colour settings for composition. Other than this option, all interface colour settings are in the Appearance pane. The appearance theme for index cards is set in the Corkboard tab, for another example. B.3.1 Binder Uses source list style If this checked, the highlight bar in the binder takes on the gra- dient 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 and a grey gradient when it doesn’t. If this option is not checked, the binder’s selection highlight uses the system highlight colour. 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 Beside each container in the binder, a number will be dis- played showing how many documents it contains. This number is recursive, mean- ing that it will not only count the container’s immediate children but any descen- dants beneath those children as well.
- 427. B.3. APPEARANCE 419 B.3.2 Outliner Options for adjusting the appearance of the outliner view mode. Most settings that im- pact the outliner are project specific and can be accessed either in the outliner footer bar or the View menu. Uses alternating row colors Draws alternating 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 Draws separators between rows in the outliner. Has vertical grid lines Draws separators between columns in the outliner. B.3.3 Notepad Lines In documents notes Turns on notepad-style ruling for document notes, giving it the appearance of a pad of paper In project notes Use rule lines in the project notes pane and the project notes window. Keep text on lines in index cards and notes When enabled, Scrivener will adjust the ruling beneath the text 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. Line rules can also be completely disabled with the above options. Lines in index cards are changed in the Corkboard preference tab (section B.4). B.3.4 Other QuickReference panels use black translucent “HUD” style Switches QuickRefer- 2 ence panels (section 20.2) to using the original black HUD style of window. This is an aesthetic choice which makes little difference on window functional- ity. You will need to reload your project for this change to make an affect on QuickReference panels that have already been opened once during the session. 2 “Heads-up Display” is an avionic acronym originally used in a military context. HUDs were first employed in the cockpits of fighter pilots, giving them the ability to see their attitude, altitude, speed, radar, and other important flight details without removing their eyes from the horizon and looking down at a console. HUDs have been employed in civilian cases since then. Some luxury cars have HUD style speedometers and tachometers on the windshield so you can stay focussed on the road. In computer usage (and more specifically, Mac software), the term has come to mean any sort of window that provides features or information to the user in a utility role, displayed in a floating window.
- 428. 420 APPENDIX B. PREFERENCES Smooth text and line art in PDF documents Anti-aliasing is used by default to keep your PDF documents smoothly rendered at all levels of magnification. If your computer runs slowly while viewing PDFs, disable this to increase performance. Target progress bars use smooth transition between colors By default, the three colours you use for progress bar display (in the editor footer bar and Project Targets window) will be gradually blended as you type. When this feature is disabled, the progress bar will “snap” from one colour to the next at the 50% and 100% marks. If you prefer a more noticeable indication of when you’ve reached a goal, this can be a useful option. Opacity of label colors when used in backgrounds Define how much blending Scrivener should use between label colour and the underlying background colour. Moving the slider right toward “High” will cause labels to be coloured more vividly; moving the slider left toward “Low” will cause the effect to be more subtle. B.3.5 Fonts Options for setting application interface fonts. If you wish to adjust the editor fonts, visit the Formatting tab (section B.8). These settings are optionally saved into preference Themes. Header bar This font is used in the editor header bar to print the title of the selection you are currently viewing. Binder Choose the font which will be used to display the titles of items in the binder and in Collections. Outliner title Sets the display font for all text in the outliner except synopsis text. Synopsis Sets the display font for the synopsis text within an outliner. Below these controls, you can also select formatting attributes to alter the appearance of container items in the binder and outliner, which can increase their visibility in long lists of items. Folders and document containers are treated separately. Note that if the fonts you have chosen above do not have a bold or italic variant, the conflicting option will be disabled. (In cases where you choose separate fonts for the binder and outliner, the formatting option will be enabled if the variant exists for either font, but the formatting will only apply to that element.) These options will only impact the outliner if it is set to not show embedded synopses, or if the Embolden all titles in outliner when showing synopses option is disabled.
- 429. B.3. APPEARANCE 421 B.3.6 Customizable Colours Custom interface colours are chosen using a column view. To alter the default colour for the desired interface element, first select the major category in the leftmost column and then the item itself from the middle column. Click on the colour well in the right column to assign a new colour, or click Use Default Color to reset the option to the application default. Since the program updates in real time as you alter the preferences, it is often beneficial to display the area you wish to customise, then adjust the colours while viewing the changes. There are a few extra options located around the main table: Use different colors in full screen [10.7 (Lion) Only] When using the new Lion full screen feature, you can optionally choose to use a different set of colours for most, but not all, of the colour settings. When this checkbox is enabled, a “Full Screen” section will be added to the left-most column. Any changes made within this cate- gory will only be used when the project window is in full screen mode. Use dark gray theme Adjusts a number of interface detailing to use a darker grey theme, which can improve the appearance of colour themes which are darker in mood. Additionally, if you use the Graphite system theme, you might prefer its graphite toned active header bar, which replaces the blue active header bar. Use dark gray theme in full screen only [10.7 (Lion) Only] When enabled, the dark gray theme will only be in effect when using Lion’s full screen mode. In conjunc- tion with using different colours to establish a darker overall palette in full screen, you could create an effective day mode vs. night mode. Note: Some categories have identical settings, such as both the Editor and Composi- tion Mode sections containing “Scrivening Titles”. Where duplication exists, the refer- ence tables (Table B.1) will list only the first entry. Some background colour options also allow a texture. When you see the button Choose Texture..., you can set this particular element of the interface to use a tileable graphic for its background instead of a colour. Many tiling graphics can be found on the Internet for free. It is best to choose textures that are relatively small, as larger textures can slow down the interface. To clear a texture you no longer want to use, just click the Use Default Color button. The elements which take a texture are: l Editor: Text Background l Editor: Page Background
- 430. 422 APPENDIX B. PREFERENCES l Editor: Fixed Width Background l Composition Mode & QuickReference: Paper l Composition Mode: Background For a full list of all options, refer to the Appearance Colour Settings (Table B.1) table. These options are all saved into preference Themes. B.4 Corkboard Provides options and settings which impact the way the corkboard functions and appears. B.4.1 Appearance These options are all saved into preference Themes. 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 inspector). Allow two lines in title areas When you require longer titles, the single-line truncation method that index cards use can be constrictive. Turning on this option will allow an additional line of word-wrapping before truncation occurs. Also see below for a font option to permit automatic shrinking of larger titles. Display images as photographs Media files such as QuickTime movies and images are displayed by default as “Polaroids”, and any document can be individually set to a graphical synopsis. Disabling this option will always show the standard synopsis index card on the corkboard. Always show synopsis rather than image by default in inspector While the synopsis image will continue to be used in the corkboard with this option, the version of the card in the Inspector will always show the text synopsis instead. This can be useful if you are still using the text synopses as well as the image, as you can see both versions at once with a Corkboard and Inspector arrangement. 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.
- 431. B.4. CORKBOARD 423 Table B.1: Appearance Colour Settings Category Interface Element Description Views Binder Background Background colour for the binder Search Results Background Background colour for the search results collec- tion and its tab Outliner Background Background colour for the outliner Outliner Grid The horizontal and/or vertical grid lines colour Media Background Colour displayed around images, PDFs, movie clips, etc. in the editor Comments Pane Background colour for the comments and foot- notes pane in the inspector Scratchpad Text BG Background colour for the scratch pad text- editing area Editor Text Background Main editing background, or “paper colour” Page Background “Gutter area” that is drawn behind the page when using View Page View Show Page View Scrivening Titles Text colour for titles in Scrivenings mode as displayed in the editor when View Editor ShowTitles in Scrivenings is enabled Scrivening Titles BG Background colour behind titles when enabled in Scrivenings mode; requires “Use title back- ground color” to be enabled in the Formatting pane Fixed Width Background Colour displayed around the pseudo-page in fixed width mode Notes Background Document notes editing background, or “paper colour” Project Notes Background As above, but for project notes; also affects the project notes window Footnote Comments BG Background colour used for inspector footnotes Search Highlights Highlight used to accentuate search results in the editor Invisible Characters Text colour used to draw special symbols depict- ing invisible characters Insertion Point Colour of the insertion point, or caret, that indi- cates where you are currently typing Text Selection Background highlight colour used when select- ing text in the editor; the Use Default Color but- ton will pull the preference from your OS X sys- tem Appearance settings
- 432. 424 APPENDIX B. PREFERENCES Table B.2: Appearance Colour Settings Cont’d Category Interface Element Description Current Line Highlight Colour of the bar that highlights the entire line you are currently editing; visible when “High- light current line” is enabled in Editor prefer- ences Links Colour of linked text Notes Text Default text colour in the document and project notes Outliner Synopses Text colour for the synopsis field in the outliner Index Cards Index Card Background The “paper colour” for index cards. Will be blended with the label colour when View Use Label Color In Index Cards is enabled, so it is often best to choose a subtle shade Image Background Background colour of the card when in graphi- cal mode, used when no image exists or to fill in areas around an image that does not fill the card space Index Card Status Stamp Base colour used to render the stamp text across the face of the card; the opacity can be adjusted in the Corkboard tab Snapshots Background The “paper colour” for the snapshot text area. Note this will apply both to snapshots shown in the inspector and snapshots displayed in the main editor Deleted Text Text colour used to indicate text that has been deleted in the difference between the snapshot and the current version New Text Text colour used to indicate text that has been added in the difference between the snapshot and the current version Revision Colors All elements Set individual colours for the revision level text tool Target Progress Bars Start Color By default, progress bars blend through three colours; this is the colour of the progress bar when at its lowest End Color The final colour of the progress bar Midway Color The second colour of the blend. This will be the colour of the progress bar when it is at 50%.
- 433. B.4. CORKBOARD 425 Corkboard background Lets you customise the standard corkboard background. Se- lect “Corkboard pattern”, “Beige Graph Paper”, or “Slate Graph Paper” to use one of the provided background patterns; “Custom color” to choose a background colour using the colour well to the right of the pop-up button; or “Custom back- ground. . . ” to select your own image file to use as the background. For better performance, use smaller, tileable textures rather than large images. The Freeform background setting is identical but applies to freeform corkboards only. Index card theme Lets you choose the line colours used in the index card. “Red and blue” divides the title from the text with a pinkish-red line and draws blue lines in the text area; “Blue and black” divides the title from the text with a blue line and draws black lines in the text area. These represent the most common colours of index cards in the real world. The “Rounded” theme displays cards in a more stylistic fashion, with rounded edges, lines drawn in grey, and labels represented as a colour block in the corner instead of as a pin. This setting will also impact the index card in the inspector (though it will always have square corners). Position pins 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 is not used. Status stamp opacity Allows you to set the opacity of status stamps on the index cards within the corkboard. The stamp, unlike a real one, is drawn beneath the text, so even at full opacity it will not obscure synopsis text. This only impacts how boldly the stamp will be drawn. Corkboard shadows Sets the intensity of the shadows around the cards and borders of the corkboard view. Slide all the way to the left to disable shadows. B.4.2 Fonts Options for altering the fonts used to draw index cards. To change a font, click in the preview panel 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 panel immediately. These settings are optionally saved into preference Themes. Index cards title Lets you set the font used in the title area of index cards (affects index cards both in corkboard mode and in the inspector).
- 434. 426 APPENDIX B. PREFERENCES Photographs title If you have enabled the “Display images as photographs” option, the title of the image will be drawn below the thumbnail using this font choice. Automatically shrink titles to fit with minimum font size As an alternative, or in ad- dition to “Allow two lines in title areas”, this is another option that can help accom- modate longer titles in the index card, without excessive truncation. As the title grows beyond the size of the allotted space, the font size will shrink until it reaches the minimum amount specified. Once it reaches that point, it will truncate the ti- tle as per normal. Combined with two-line titles, very long titles can be used with little or no reduction in text. Index cards text Lets you set the font used in the text area of index cards (affects index cards both in corkboard mode and in the inspector). Small text Alternative font which will be used for both the title and text of index cards on the corkboard. The use of this font is determined by the project, not the pref- erences. To set this and other corkboard display options, see Corkboard Options (subsection 12.1.4). Status stamp Lets you set the font family and typeface of the stamps that can be drawn diagonally over index cards in corkboard mode to show the status. Font size set here is ignored, as Scrivener automatically resizes text in stamps to fit the index cards. B.4.3 Dragging and Double-Clicking Options for how index cards react to click-and-drag events and to double-clicks. 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. Double-clicking on the corkboard background Adjust the behaviour of what should happen when double-clicking in a blank area of the corkboard. “Opens the parent corkboard” will display the parent of the current corkboard. If the corkboard you are viewing is already at the top level of the binder, it has no parent and nothing will happen. The keyboard shortcut for this is – R, and will remain in effect even when this option is not selected. “Creates a new card” follows a common behaviour amongst diagramming applica- tions, where you can indicate the position of a new card by double-clicking with the mouse.
- 435. B.5. COMPOSE 427 “Does nothing” ignores all double-clicking on the corkboard background. Always creates a new card in freeform mode When checked, freeform corkboards will ignore the above setting and always create a new index card under the mouse pointer when double-clicked. Uncheck this to have freeform corkboards follow the behaviour of the above setting. B.5 Compose These options affect the appearance and behaviour of the composition mode, which can be used to block out distractions and focus on writing. B.5.1 Composition Mode Set-Up Fade between modes Gracefully fades the screen between composition mode and regu- lar editing mode. Hide main window in composition mode Check this to hide the main window dur- ing composition. If this is unchecked, you can see the main window beneath the translucent areas of the composition background (unless you have set the opacity to opaque using the slider in the control strip), 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 background to look at the contents of the windows of other applications. Note that in some circumstances, having the main window visible in composition mode can slow down typing, so it is usually best to leave this checked as it is by default. Full screen uses secondary screen If this is checked and you have more than one dis- play, the composition window will be opened on the secondary screen. Blank out other screens When using more than one display, select this option to reduce distractions from the other monitors. This merely draws the background colour over the screen, and thus the monitor’s energy saver will not kick in, so this is only useful if you’d rather not turn off your monitor. Escape key closes composition screen When disabled, you will need to use either the View Exit Composition Mode command or its keyboard shortcut ( – F) to toggle between modes.
- 436. 428 APPENDIX B. PREFERENCES B.5.2 Editing Options Highlight current line Enabling this will place a background highlight colour beneath the current virtual line (not paragraph), making it easier to see where you are in your text. The current line highlight colour can be set below, in “Customizable Colors”. Show Growl notifications when saving If you have Growl installed, this option will register a notice with the Growl bulletin system whenever you manually save the project, as there would otherwise be no indication of when save completed. Disable insertion point blinking When checked, the cursor will be always visible on the screen. Use block insertion point of n pixels Adjusts the width of the insertion point from its default of 1 pixel. This will dramatically increase the caret’s visibility; however, with variable-width fonts (like Cochin), this setting can produce odd results. It is best used with a fixed-width font like Courier. B.5.3 Appearance Paper margins Sets the margin spacing between the text and the “paper” edge. 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 on the page, and so will not be visible if you have scrolled into the middle of the file. Scroller type Customise how the scroll bar looks in composition mode. l Regular scroller: the standard operating system default scroller will be used. The appearance of this may be very similar to the “Minimalist scroller” option on OS X Lion, except in that its appearance behaviour will conform to the global Mac settings l Standard full screen scroller: the scroller will look like the ones in the full screen modes of iPhoto and other iApps and will always be visible if there is enough text to warrant a scroller. l Auto-hiding scrollbar (uses text color): the scroller will take on the colour of the text if “Override natural text color” is selected within the “Customizable Colors: Text Color” setting (it will use black otherwise) and will only appear when the cursor is moved over it at the edge of the paper area. l Minimalist scroller (uses text color): uses a simple rounded grey bar, matching Mac OS X Lion’s scrollbar appearance. This scrollbar, like the above, hides
- 437. B.5. COMPOSE 429 unless you move the mouse over the paper edge where it appears. Also as above, it will use any text colour override that is supplied. l No scroller: composition mode will not feature a scroll bar under any circum- stances if this is selected. B.5.4 Customizable Colors This table (Table B.3) only shows a sub-set of the available options, where they are unique or differ from the settings in the Appearance Colour Settings (Table B.1) table. Refer to it for any settings you are unsure of. Table B.3: Composition Mode Colour Preferences Interface Element Description Text Color To activate this option, you will need to enable the “Override text color with color” checkbox. the text in composition mode will use the actual text colour—that is, the colour it is normally in the main editor. If this option is checked, you can choose a dif- ferent colour for all text in composition using the colour palette. Note that this merely temporarily displays the text in the selected colour; the real colour of the text remains unchanged. This will also temporarily re-colour annotations, links, and linked note markers too, reducing their level of impact on your vision. The override colour can have an opacity assigned to it, which will al- low you to blend the text colour with the page background. Paper The “paper colour” for the editing area, or pseudo-page, in com- position mode Background Colour displayed around the pseudo-page in composition Inspector HUD backgrounds Synopsis, Notes, Project Notes, and Comments can all have their background colours set independently from the main preferences to match the composition colour scheme B.5.5 Default View Settings You can dynamically adjust most of the visual options while in composition mode, using the control strip at the bottom of the screen (you’ll need to move your mouse down to the bottom if you cannot see it). Once you have your settings the way you would prefer for all projects (at least as a starting point), you can use the provided button here to save the following settings into your preference file as defaults.
- 438. 430 APPENDIX B. PREFERENCES l Paper position: There are three possible choices: “Left”, “Center”, and “Right”. This is useful if you keep documents open in QuickReference panels or fade the composition background to view other applications alongside the psuedo-page. l Default text zoom: Dynamically scale the size of the text font for composition mode. This will not impact the underlying font settings, letting you view your text larger or smaller only while in composition. l Paper width: Adjusts the overall width of the virtual page. 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. l Paper height: Brings the top and bottom of the page away from the edges of the display, keeping the text block centred on the screen. To set the paper height in the composition screen, with the Control Strip (section 16.2) visible, hold down the Option key and the “Paper width” slider will be replaced by “Paper height”. l Background fade: Lets you adjust the blend between the rest of your desktop and the chosen background colour. Move the slider all the way to the right to make the background opaque or all the way to the left to make it entirely transparent. Paper fade, the alternate form of this slider that appears when a backdrop is in use, is not saved into preferences. l Typewriter scrolling: Enables this feature by default in new projects. Typewriter scrolling keeps the text you are currently editing in the middle of the window. It can be toggled on and off with Format Options Typewriter Scrolling ( – T) while in composition. B.6 Navigation The navigation settings allow you to alter how Scrivener responds to the various actions you can take to navigate through your project. There are numerous ways to move around in the interface—for example, clicking directly on items, jumping straight to a specific place in your book via the menu, or using buttons to scroll through documents like a flip-book. Unless otherwise indicated, these navigation options will apply to all methods of se- lecting an item in the interface. If you are coming to Scrivener 2 from older versions, you may note that a lot of the preferences pertaining to default group modes have been removed. This is because they have been replaced with a smarter, dynamic system that no longer requires maintaining preferences. This more intuitive behaviour is described in View Modes (section 5.2).
- 439. B.6. NAVIGATION 431 B.6.1 Folders and Files Treat all documents with subdocuments as folders When this is checked, any docu- ment that has subdocuments will act like a folder and will open in whatever view mode folders are set to use (the last group view mode selected). If this isn’t checked, normal text documents or media files that have subdocuments (any type of docu- ment can act as a “container” for other documents in Scrivener) will be opened in single text mode. Include folder text in Scrivenings (composite text mode) When clicking on a folder (or file group, if “Treat all documents with subdocuments as folders” is enabled), by default the text contents of that container will be included in the Scrivenings session at the very top. If you never use folder text, or document stack text, then disabling this will remove the empty entry at the top of the Scrivenings session. Show folder text when selected from search results Overrides default behaviour of opening folders (and if “Treat all documents with subdocuments as folders” is set, file groups as well). When this is enabled, all container style search results will reveal their text when clicked on in the search results, rather than revealing their children in accordance with the selected view mode. This option is enabled by de- fault, 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. Always create new items as siblings Ordinarily, when a container is selected, creating a new text item will place that item within it as a child, at the end of the list. (This will hold true for document groups as well as folders if “Treat all documents with subdocuments as folders” is enabled.) When this option is set, all newly created items will be created at the same level, below the selected item, no matter what the circumstances. Folders are always created as siblings, even when this option is off. B.6.2 Dragging Option-dragging creates duplicates Enable this feature to cause the various organisa- tional 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. In cases where the Option key is used to alternate or inhibit other behaviour, this will take precedence. For instance, if “Allow drop-ons” is turned on in Corkboard
- 440. 432 APPENDIX B. PREFERENCES preferences, the ordinary use of Option to disable drop-ons will be inhibited, al- lowing you to create a duplicate of a card as a child of another card. Collapse auto-expanded outline items after drag and drop When dragging items into the binder or outliner, if you pause over a collapsed container, Scrivener will helpfully reveal its contents so you can drop items several layers deeper than you could initially see. This option will close all automatically-opened containers after you have dropped the items. This setting impacts both the binder and the outliner view. B.6.3 Locked in Place Binder selection affects other editor when focussed editor is locked Typically, when a split is locked, if a binder click would have impacted that editor, the click action is blocked and nothing happens. Thus this does not include cases where the click would not have impacted the locked editor, such as when Binder Affects is engaged and targetting the unlocked editor, or the unlocked editor is not the active split. When this option is enabled, unless both editors are locked, a binder click will always load something, even if it has to redirect the click action to the inactive editor to do so. B.6.4 Media Rewind when paused by. . . Use the slider to set how many seconds Scrivener should rewind the media stream back, when using Auto-Rewind (subsection 14.7.3). This preference is not used unless the media player has been set to automatically rewind on pause. B.6.5 Return Key Ends editing synopsis in corkboard and outliner By default, the Return key will sub- mit the edits being made to the synopsis in corkboard index cards and the synop- sis outliner field. To add carriage returns to the synopsis, use Return. If this is unchecked, the Return key will add carriage returns, and you will need to use the Esc key to submit changes. 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, hitting Return once ends the editing; hitting Return again will then create a new item.
- 441. B.6. NAVIGATION 433 B.6.6 Corkboard and Outliner Space Key Behavior Space key opens selected document in. . . The spacebar can be used to quickly open se- lected items in Corkboard or Outliner. By default this opens the 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.7 References and Scrivener Links Create back-link references when creating Scrivener Links and references When you create links or references to internal items, Scrivener will automatically place a “back-link” to the originating document in the References table for the target. In other words, if you link from “Scene 81” to a character sheet named “Joseph”, a reference link to “Scene 81” will be added to the “Joseph” document’s reference table in the inspector. If you would prefer to maintain all of your references by hand, disable this option. The following three settings have the same set of three options (with the exception of “Open newly created Scrivener Links in”, which can be set to not do anything at all). You can choose to handle them by opening the target in a QuickReference Panel, which will preserve the current editing session, the Current Editor, which will replace the current editing session (this was the default behaviour in Scrivener 1.x), or the Other Editor, which will open the link in the other split, creating a new one if necessary. Open references in. . . References to supported internal project items, which have been activated from the inspector reference table, will open using the instructions pro- vided here. The default is “Other Editor”. In Full Screen mode, the Inspector panel will always open items as QuickReference panels. This is also true for any references activated from within a QuickReference panel itself, though References can be dragged from a QuickReference panel into the header bar of the main editor to load them manually, there. See References (subsection 18.4.2) for full documentation on how to use this fea- ture. Newly created Scrivener Links refers to the creation of new documents with the – L shortcut, the wiki link style syntax, or the menu command Edit Scrivener Link New Link.... New links have an additional option, “Do not open”, which simply makes the link without opening the newly created document. With the exception of “Do not open”, creating a link within a QuickReference panel will ignore these settings and always open a linked item in a new QuickReference panel.
- 442. 434 APPENDIX B. PREFERENCES Likewise, full screen will use a QuickReference panel instead of the “Other Editor”, be- cause it has no split view, and when opening linked items that are not text documents, because full screen can only display text. B.7 Editor The options for the main text editor control how text is displayed (not to be confused with formatted) within the editor itself. For options pertaining to default text formatting, see the Formatting tab (section B.8); for options pertaining to text input and typography, see the Corrections preference tab (section B.9). B.7.1 Editing Options Smart copy/paste This functions in the same way as TextEdit. When enabled, extra whitespace around the words will be stripped out and the word buffered with a single space if necessary, cleaning the pasted text significantly. Typing clears search highlights When using the Project Search feature, Scrivener will highlight the matching search results for you. If this is enabled, the highlights 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 editor’s Back button ( – [) to return. Highlight current line Enabling this will place a background highlight colour beneath the current virtual line (not paragraph), making it easier to see where you are in your text. To change the colour of this highlight, select Current Line Highlight in the Editor section of the Appearance tab (subsection B.3.6). Use hyphenation Enabling hyphenation when using full justification can increase read- ability but at the expense of not being as “pure” to the actual text you have keyed in (the hyphens will not be literally placed into the text; they are only drawn on in real-time to improve word-spacing flow on a line). Consequently this is off by default. This feature uses your system localisation preferences to determine optimum hy- phen placement. If you are writing in another language and getting odd results, make sure your OS is set up accordingly. 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.
- 443. B.7. EDITOR 435 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 for future projects. Addition- ally, 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) used by the ruler in the main editor, full screen, and QuickReference panels (available by hit- ting – R when the editor has the focus or by selecting Format Show Ruler). Rulers for the scratch pad and document and project notes use your system’s settings at the time the project is opened. Typewriter scroll line Selects the anchor point that Scrivener uses to reset the currently edited line’s position within the editor. A default setting of “Middle of screen” thus positions the currently line in the vertical middle of the editor. See Typewriter Scrolling (subsection 14.3.4) for further details. 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 its visibility; however, with variable-width fonts (like Cochin), this setting can produce odd results. It is best used with a fixed-width font like Courier. B.7.2 Wrap to Editor Mode There are two primary editor modes. Wrap to Editor works in a fashion familiar to most text editors. In this mode, text is wrapped according to the width of the editor view or to an artificial limit when “Use fixed width” is enabled. Wrap to Page mode emulates a printed page much like many word processors, though unlike word processors, it makes no attempt at accuracy, and is thus more an aesthetic choice for most. 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; it will not be seen if you have scrolled to the middle of a long document. 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
- 444. 436 APPENDIX B. PREFERENCES the binder and, if it is open, the inspector. Click the Use Current button to capture the current width of the editor you were last using. 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). Use fixed width When this is enabled, Scrivener will also use the above setting to 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, of the Appearance tab (section B.3). B.7.3 Wrap to Page Mode Show page view in new projects By default, new projects use Wrap to Editor mode. Enabling this will force Wrap to Page mode in all new projects. Center pages 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. Use facing pages in new projects Activates the two-page spread as the default for new projects. To change existing projects, use View Page View Two Pages Across. Disable Keep with Next At the expense of performance, you can deselect this option to preview manual orphan control. Keep with Next codes can be placed into a document using the Format Text Keep with Next command. Show margin guides Will draw a border around the printable area within the virtual page. Draw shadow around pages Adds a shadow around the virtual page, offsetting it from the background colour. Spacing between pages When more than one page of text is displayed (or more than two, if using Two Pages Across), the number of pixels entered here will buffer each page from the one above it. If you enter a value of 1 (one), and “Draw shadow” is enabled, a single line will separate pages horizontally. If you enter a value of 0 (zero), and “Draw shadow” is enabled, pages will flow from one to the next (but will still have top/bottom margins separating them).
- 445. B.8. FORMATTING 437 “Printed Page Size” uses Determines the page settings if View Page View Use Printed Page Size is selected. There are two ways to print from Scrivener. “Doc- ument printing Page Setup settings” will use the settings provided in the standard File Page Setup... window. The other choice is to use the “Compile settings”, which is how you will most likely be publishing your work. If page proportions are important to your workflow (such as in screenplays), be sure to choose the option which you will be using to distribute copies of your draft. The following two Custom Page Size options are used when “Use Preferences Page Size” from the View Page View menu is selected. This will let you work in a different layout configuration than what will eventually be printed. Page Size Define a custom page size for working in the editor. This will have no impact on your print settings; it is purely aesthetic. Margins Sets the margin spacing between the text and the edge of the page. You can select a different distance for horizontal and vertical margins. B.8 Formatting B.8.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 al- ways 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 precedence, starting with the “weakest” and ending with the “strongest”: 1. Application preferences as set in this tab 2. Project preferences as set in Project Text Formatting Preferences 3. The document’s text formatting itself will always override either of the above (and within that each paragraph can have its own ruler settings).
- 446. 438 APPENDIX B. PREFERENCES To reset a document to either the project preferences (if applicable) or the application preferences, use the menu command, Documents Convert Formatting to Default Text Style. The top half of the window 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 fonts button (the italicised ‘A’). 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. B.8.2 Formatting Editor Options 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. Notes font The default font for all notes. This setting impacts Project Notes and Doc- ument 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. Underline links When disabled, Scrivener Links, hyperlinks, and notation links will not be underlined in the editor. 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. The bubble outline will turn into a filled background highlight, when this option is enabled. Inspector comments font Sets the default font for inspector comments. Since these fields are rich text, this setting will only impact new comments. Inline annotations will always take on the styling of the text around them.
- 447. B.9. CORRECTIONS 439 Use different footnotes font When enabled, the font within an inline 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”, beneath it. B.8.3 Scrivenings The first option, Separate with single line breaks sets a lower-profile and more vertically accurate divider marker, rather than the default full-width divider. This option is use- ful 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. When View Editor Show Titles in Scrivenings is enabled, the following font settings and background colour option will adjust how the text used to show titles in the edit scrivenings session will appear: l Center: the title will be centred in the editor, rather than left-aligned l Underline: standard single-stroke underlining will be used on the title l 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 (subsection B.3.6) for the standard editor, and the Full Screen tab (subsection B.5.4) for composition mode. B.9 Corrections The Corrections tab contains optional typing aids, such as typographic enhancements (superscripted ordinals, em dashes, smart quotes, etc), word completion, and control of the spelling engine. Not all of the places you can type in Scrivener will support these aids. The main text editors (standard, composition mode, QuickReference) support ev- ery option. B.9.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.
- 448. 440 APPENDIX B. PREFERENCES Check grammar with spelling in new projects 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. Correct spelling errors as you type Will correct common spelling errors and typos au- tomatically. This feature can be trained with new words you’ve added to the dic- tionary. B.9.2 Auto-Capitalization Fix capitalization of sentences Will fix letter case issues if a lowercase letter follows a period and a space. Capitalize ‘i’ Will automatically capitalise the letter ‘i’, if typed by itself. B.9.3 Auto-Completion Word completion is usually used to speed up the entry of places and names and other common project specific terminology. However, it can be set up to use the entire lan- guage dictionary and attempt to complete every word you start typing. By default this is not enabled as most users find it too intrusive. Suggest completions as you type Enables auto-completion in general. When this is unchecked, no auto-completion will ever be dynamically performed, but you can always manually request word-completion by pressing the Esc key, or – .. 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.9.4 Substitutions Enables a wide array of commonly used symbols and typographic conventions, by de- tecting when their use is appropriate. Not all text entry areas are capable of using substi- tutions, but they will always be available in the main text editors. 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. Most of the options are self-explanatory. Those requiring explanation follow:
- 449. B.10. IMPORT ANDEXPORT 441 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 language set- tings. To customise these, click the System Text Preferences... button that is pro- vided at the bottom of the window. Disable smart quote, em-dash and ellipsis substitution in script mode The three op- tions above this one 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 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. Automatically detect [[Scrivener links]] Scrivener document titles can be linked to by surrounding the title in double-brackets. For more information on this feature, see Linking Documents Together (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. B.10 Import and Export Scrivener supports a wide variety of file formats, both for import into a project and for exporting or compiling. The options in this tab adjust how these functions operate. B.10.1 Import Options Import supported file types only By default, Scrivener will only allow you to drag file types into the binder3 if it can internally display them. Scrivener will store un- supported files with the rest of the project, but will not be able to display them, though with Mac OS X 10.7 (Lion), you’ll see a Quick Look preview of the file, if it provides one. You will still be able to load them using external applications. This option prohibits importing unsupported file types. If any have been imported into projects in the past, they will remain. RTF These two options set how RTF comments and footnotes will be converted to Scrivener’s notation format. By default, they will be formatted as linked notation. 3 You can only ever drag text files, or folders with text files, into the Draft
- 450. 442 APPENDIX B. PREFERENCES If you prefer inline