• Introduction


    • Philosophy

      The word processor, that staple of writers' tools, is the digital age's equivalent of the typewriter. And as with the typewriter before it, the word processor is a great tool for typing up a letter, for writing from a plan created somewhere else, or for hammering out words to see where they lead you.

      Ultimately, however, a word processor assumes a predominantly linear approach: you write the beginning first, the end last. You enter text, cut and paste, perhaps even work with a basic outline, bu...

    • About This Manual

      Scrivener has a wide variety of features to accommodate many different purposes, including novels, screenplays, academic papers and dissertations, general non-fiction, journalism, 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 concepts and features, the manual itself has been split into four...


      • Terms & Conventions

        Screenshots and terminology will be based upon the default Windows appearance. Ordinarily this will not represent a discrepancy between the descriptions and what you see on your computer, but if you are using a Windows Classic theme or an older version of the operating system, the interface can look quite different from what you will see in this manual.

      • Terms & 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 with the following markers:

        • Standard retail version of Scrivener: <$s...


        • Interface & Menus

          Whenever the documentation refers to an interface element that can be interacted with, such as a button, the visible name for that element will be formatted in dark red, such as "Click on the OK button to save changes". Button labels, menu items, and keyboard shortcuts will all be displayed in this fashion.

          Menus will be displayed in a hierarchy using the "\interface{{\menusep}}" character to separate top-level, submenu, and items. Example: To convert a range of selected text to uppercase, invo...

        • Keyboard shortcuts

          Keyboard shortcuts will use the following symbolsterms:

          • Cmd-: The Command key, or the Apple key, is the one located directly to the left and right of your spacebar.

          • Opt-: 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.

          • Ctrl-: Control is usually located to the left and right of the Option keys on their respective side. Some laptops only have one Control key betw...

        • !Preference labels

          NOTE//WINDOWS// This will of course need to all be checked when the Windows UI is done. Scrivener has many !preferences, and as a result they are organised into a hierarchy starting with a major category along the top of the window (like "Behaviors"), and sometimes into a secondary tab, either along the top or if there are several sub-categories, along the left in a list. To refer to a specific category then we will say "Behaviors: Navigation". If a subcategory has further tabs within it, then ...

        • Filenames & Paths

          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.

        • Filenames & Paths

          In cases where file paths are printed, the standard convention of providing a shorthand to describe your C: drive will be used as a generic placeholder for whichever disk that data might actually be stored upon. An example might look like:

          C:\Users\\Documents

          Where `` should be replaced with your account user name. You can often also use the following instead of the full path:

          %userprofile%\Documents


      • Finding Things in this Manual

        Since this PDF has been birthed within the age of digital documentation a proper index has never been compiled for it. Despite this, in practice you should have little difficulty in locating the topic you are interested in. Modern PDF reader software features excellent searching capabilities; most things can be discovered merely by searching for the proper names of things as labelled in menus, buttons or dialogue boxes.

        Alternatively, the appendices have been written to be used as a sort of top...

      • Spot a Problem?

        A user manual is a living document. It evolves constantly as the software itself evolves, and as a result it can oftentimes be difficult to keep edited to the same calibre we'd expect of a finished and published book. If you spot a problem, or have a suggestion that would make this a better resource for you, we'd love to hear about it. Drop us a line at .


    • Installation & Upgrading


      • Installation

        <$stdonly> If you purchased Scrivener through the Mac App Store (MAS), then this section will not be relevant to you, as it pertains to the registration, installation, and maintenance of the standard retail version. When purchasing software through the MAS, installation and maintenance of the software is generally handled for you. If you require assistance installing or updating Scrivener through the Store, consult Apple's documentation on the matter.

        1. If you have not already downloaded the ...


        • The Trial Version

          You can try out all of the features of Scrivener for 30 non-consecutive days without having to pay or register. During that period, Scrivener will be **fully functional**. After 30 days of use (and one grace session so you can export your work), you will no longer be able to access Scrivener at all 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] and [Exporting], for det...

        • Purchasing Scrivener

          Should you choose to purchase the software, registration will be a seamless process of unlocking the copy you've already downloaded, meaning all of your settings and work will be right where you left them. Use the Help//Purchase Scrivener... menu command to navigate to the Literature & Latte online store.

          When you buy a licence for Scrivener online, you will be emailed your unique serial number, which will have the following format If the initial block of letters is different you have an old se...

        • 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 demo window that appears whenever you launch Scrivener, or by using the Scrivener//Registration... menu command.

          MISSING_IMAGE:/path/to/gfx/ui-registration_window.jpg

          The registration panel for unlocking a copy of Scrivener

          1. In the "Serial Number Name" box of the [registration window](#ui-registration_window), enter the exact name used to register ...

        • Application Updates

          The second time Scrivener is launched you will be presented with a panel asking whether or not Scrivener should automatically check for updates. To use this feature, you must have a connection to the Internet.

          • Click the Check Automatically button to have Scrivener perform a daily check to see if there is a newer version available and will prompt you to update if one is found.

          • Click the Don't Check button to disable automatic checks. You can always manually have the software check for an ...

        • Portable Installations

          We do not recommend installing Scrivener on a portable drive that you routinely remove from your computer. It is best to install and register Scrivener on *each* machine independently and keep your data portable. In most cases this can be done with a single user licence, but you should check with [our licensing details to verify](http://www.literatureandlatte.com/licence).


      • Setting Up Your System

        For most uses, Scrivener will be ready to go as soon as you install it. However if you're interested in some of the optional extras it provides, this section will describe how to set them up.


        • Setting Up System Services

          Scrivener comes with a number of system-wide Services that you may use to more easily capture information from other software. As with all Services, they can be configured in System Preferences: Keyboard: Shortcuts, within the "Services" pane. You will find all of our services located within the "Text" subsection of this pane. Read more about [Scrivener Services].

        • Use of System Contacts

          When you first create a new project (such as the tutorial) you will be asked by the operating system if it is okay for Scrivener to access your Contacts. This is a standard request for permission that is generated by all programs that use your contact list. Scrivener only uses this access to generate your name into page headers, for "signing" comments as well as generating cover sheets and the like when creating templates. If you would rather not grant Scrivener the ability to do this, you will ...

        • Installing Extras

          <$MASOnly> If you are using the MAS version and wish to use the "Print PDF to Scrivener" feature from print panels Mac-wide, you will need to install the alias yourself:

          1. Open two Finder windows, one pointing to the Applications folder where Scrivener is installed, and the second to the "PDF Services" folder in your user Library folder. Hold down the Option key when using the "Go" menu in Finder to get there.

          2. Drag the Scrivener icon from the Applications window to the PDF Services windo...

        • Setting up MultiMarkdown or Pandoc

          <$stdOnly> Scrivener comes with MultiMarkdown embedded within it, and all of the extra files necessary to produce documents of any type, directly out of Scrivener. However you may want to update MMD to a newer version if the one we provide is older. Additionally, those using the !LaTeX document typesetting system will get cleaner compile results by installing the diverse !LaTeX support files that MultiMarkdown uses to build different document types. You will find instructions for [downloading in...


      • 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 email will be sent to the address you provided. You will need to click a link within this email before you will be officially added to the list. If you cannot find the confirmation email after 24 hours, check your spam folders, and consider adding "literatureandlatte.com" to your white-lis...

      • Upgrading to Scrivener 3

        Major paid upgrades to the software represent large overhauls to the software. You may be alerted to this in the standard update panel, leading to more information on our site, rather than offering to replace your current copy of Scrivener 21. If you wish to merely audition the new version, it might be a better idea to download the demo from our website directly, and run it alongside the older version.

        It is our hope that you find major upgrades to be familiar to use in most regards, but if yo...


        • Running Multiple Versions

          While it is possible (and safe) to run more than one version of Scrivener at once on your computer, it is advisable to first delete older versions prior to 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.

          In some cases, you may need to keep an older copy around. When running multiple versions of a program, you'll want to keep the following in mind...


          • (mac registration advice)

            For best results, you should download the latest copy of Scrivener 2.9 from the [legacy downloads page], and use the following instructions. If you have already registered Scrivener 2.9 with your new 3.0 serial number, then you may skip these instructions; likewise if you are running into no issues with activation when launching either version, you may have no need of the following procedure. This is only necessary if you are continually running into activation issues, as both versions do share ...


        • Upgrading Projects

          The project file format has been updated considerably, and new or upgraded projects cannot be opened in older versions of the software. The first time you load each of your older projects you will be presented with a dialogue box asking if you wish to upgrade the project format. Review the instructions and advice provided in [Project Format Upgrades] for further information on that process.

        • Recovered Files

          Older versions of Scrivener's project format were designed before the concept of synchronisation, or "cloud" servers, became popular. A common method of handling conflicts with these systems is to duplicate files that have been edited in two different places at once. In the past, these duplicate files were left unremarked, and left to accumulate within Scrivener's project format.

          Scrivener 3 includes a much more thorough project repair system that runs whenever you open a project, and this will...

        • Saving Your Projects for Older Versions

          As noted, once you have upgraded your project to the new format, it will no longer be directly accessible to Scrivener 2.x for macOS, or 1.x for Windows. However it is possible to save a copy of your project in a format that can be read with these older versions, and even later load the modified project back into v3 with minimal loss of new settings and features.

          The procedure is simple, but it's important to understand that you won't be able to share the project *directly*. If you've been work...


    • Interface in Overview

      Screenshots of the interface; establishment of terminology and *brief* overview of elements. The sections should all link to more detailed discussions on the interface; but provide enough to get a new user started.


      • The Project Window

        Simple Binder with editor (header/footer) and format rule.


        • Selection & Focus

          Selection, and the areas of the project window have focus, are often important in Scrivener. There are features that only work when certain types of things are selected in the interface, or when the cursor is in a particular area of the window---what we refer to as "focus". A good example of this is the Edit//Transformations//Make Uppercase menu command. It has no meaning when a selection of index cards is currently active, as it works upon selected text. If there is a selection restriction on a...

        • Toolbar

          Briefly describes the application toolbar and how to customise it.


          • The Default Button Set

            We've curated a selection of buttons out of the box for quick access to commonly used functions, and a few tools suited to this prominent placement in the window. We'll go over these buttons in brief, pointing you to additional reading material if you are curious to read more on the feature itself. You aren't stuck with any of our choices, any of the buttons can be removed and there is a wide selection of alternative buttons available to be added. NOTE// add the following once the section exists...


        • Left to Right Navigation

          Before we take a look at the three main interface components within the project---the binder, editor area and inspector---it would be worthwhile to spend a moment examining how these three elements interact with one another. The rules are very simple, and should work in a manner you may find familiar from other programs:

          • A panel or sidebar works with what has been done to the immediate left of that panel:

          ⁃ If you click on a folder in the binder, it is loaded in the main editor to its *righ...

        • The Binder

          Brief description of the Binder: what it is and how to use it.


          • (see also)

            • [The Binder & its Outline].

            • [Project Navigation].

            • [Using Collections].

            • [Project Search].


        • Editor

          Brief description of the Editor interface elements and handling editor splits.


          • (see also)

            • [View Modes]: the editor is also host to "group views", like the corkboard. Visit this topic for further information on the various group and text view modes available and how to make use of them.

            • [The Editor & its Views]: the editor itself, as one of the central components of the project window, is discussed in-depth in this chapter, along with everything you need to know about the corkboard, outliner, splits and copyholders.

            • [Writing and Editing]: if you're mainly looking for help on ...

          • Format Bar

            Discusses the various tools available in the Format Bar, and provides cross-links to more thorough sections on various text editing features.

          • Copyholders

            In addition to the two main splits, you can also pin a document to either (or both, for a total of four panes) of the editor splits in what we call a "copyholder"; like the thing you'd clip to the side of your computer monitor. Copyholders are not full split editors, and are thus only capable of display the media itself or the text content of an item---as depicted in [](#overview-editor). Want to check it out quickly?

            MISSING_IMAGE:/path/to/gfx/copyholder-control_buttons.jpg

            The copyholder head...


        • The Inspector

          Introductory article in the Interface portion of the manual.

        • Blocking Out Distractions

          With all of this interface going on (never mind the Internet in the background!), it would be nice to be able to just blot out everything and focus on the words. Scrivener has some tricks up its sleeve---let's take a look at themit.


          • !Composition Mode

            Introductory statement.

          • Full Screen Mode

            Main article on Lion Full screen mode


            • Slide-out Sidebars

              Main article

            • Full Screen & Layouts

              Saved layouts (which will discuss in the following section) will remember if they have been configured while 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 rearrange the window. If you do not wish for a layout to transition the window to full screen, you can hold down the Option key when selecting the layout for use.

              If no layout has been selected as a full screen default, then the current window settings will ...


        • Saving Window Settings

          Now that we've gone over the basic capabilities of the project window, you might be wondering whether something as flexible as this can have its configuration saved for future use. The answer is of course, yes you can. We provide a few simple layout examples out of the box that you can experiment with, but eventually you're probably going to want to learn how to save your settings so you can get them back. Refer to [Saved Layouts] for the details.


      • View Modes

        Description of the three main view modes; what they are in general; and how they interact.


        • The Group Mode Toolbar Button

          Included in the default application toolbar is a three-way toggle button. It is in the middle of the window, and contains [three buttons embedded in a single row](#ui-toolbar-group_view_control). They are: Scrivenings, Corkboard and Outliner, respectively.

          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 on the far left will depict a single page, representing "document ...

        • Corkboard

          Scrivener has made the corkboard metaphor popular in modern writing software. The concept of representing ideas or segments of writing as index cards and arranging them to represent the structure a book is useful enough that writers have been doing similar with real corkboards for decades. Let's see what a digital version can do for you.

          MISSING_IMAGE:/path/to/gfx/overview-corkboard.jpg

          Corkboard view: the cards are titled at the top, with short descriptions written for the first two.

          The impo...

        • Outliner

          Introductory explanation of the outliner.

        • Scrivenings

          MISSING_IMAGE:/path/to/gfx/overview-scrivenings.jpg

          Scrivenings mode: showing the text content of our example folder.

          The last of the three view modes is unique in that it displays the group of items as a long text document, one file after the other. It is thus only available to selections of more than one text document (or folder)---images and other forms of media will be ignored by the tool. All of the text content (even empty documents) will be stacked together as if on a long spool of paper...


      • Keyboard & Trackpad

        Now that we've covered most of what you'll encounter on the screen, let's turn to a part of the interface we don't often think as much about: what goes on beneath our fingertips. If you're using a regular old keyboard and mouse, then chances are Scrivener won't be throwing any surprises at you---though in general it might be good to know that we put a lot of effort into making Scrivener a keyboard friendly program. It comes packed with hundreds of shortcuts out of the box, and is designed so tha...


        • Trackpad Gestures

          Scrivener supports two of Apple's built-in gestures, if you have the hardware to support them and the preferences set to default:

          Force Touch

          : A force click on any word will bring up Apple's "Look Up" interface, including quick access to dictionary definitions.

          Pinch Zoom

          : When viewing PDFs or images, you can use the pinch zoom gesture to adjust the magnification of editor for that particular document.

        • Touch Bar

          When using Apple's Touch Bar hardware, Scrivener will provide a number of useful functions depending on what you are currently doing within the software, or what we will refer to here as "contexts".

          Some buttons will be available in all contexts, and can be thought of as being global in that sense. Depending on what you are doing with the software, you may find more specific buttons listed per context that provide access to functions that only make sense within that area of the software, like t...


          • Global Buttons

            Adding or removing these buttons from *any* context will impact all contexts collectively.

            MISSING_IMAGE:/path/to/gfx/touch_bar-global_buttons-w.jpg

            Global buttons: Layout, Project Search and Add.

            • Layout: quick access to toggling the visibility of the binder, collection list and inspector. This feature also has a three-way control for changing how the editor [views should be split](#touch_bar-layout-w).

            • Project Search: moves the cursor to the project search field above the binder, or if ...

          • Binder Sidebar

            The binder, along with the other various views that can occupy the left sidebar, have a few special buttons available. The binder button set itself cannot be customised, though additional global buttons can be added while using this context.

            MISSING_IMAGE:/path/to/gfx/touch_bar-binder-w.jpg

            Binder: Collections, Labels, Status and Search Result Sorting.

            • Collections: quickly select between the different available binder views. By default this will consist of the binder itself and the most rec...

          • Corkboard Buttons

            This bar also has the Icon, Labels and Status buttons available to it.

            MISSING_IMAGE:/path/to/gfx/touch_bar-corkboard-w.jpg

            Corkboard: Selection Affects, Open, Corkboard Layout

            • Selection Affects: causes the active selection in this group view to be automatically opened in the opposing split view or attached copyholder (just like how the binder works). If you have both a copyholder and a split view then this button will rotate between targeting the two options and no auto-load. Refer to [Lin...

          • Outliner Buttons

            This bar also has the Icon, Labels and Status buttons from the binder view, as well as the Open and Select Affects buttons from the corkboard view, above.

            The outliner bar otherwise only contains one unique button, the Hide|Show Synopsis toggle. This button correlates with the option found in the footer bar of the outliner and simply toggles whether or not synopses [will be displayed beneath the title line][Special Columns].

          • Text Editing Buttons

            As you might expect, the text editing areas of Scrivener are where most of the Touch Bar buttons dwell. Additionally, you will be provided with five separately configurable bars for different areas of the software:

            1. Document notes in the inspector.

            2. Comments and footnotes in the inspector.

            3. When editing the contents of a table in the main editors.

            4. Editing rich text in the scratchpad.

            5. And finally of course the main text content itself, which can be accessed through the main edit...

          • Table Editing Buttons

            When the cursor is within a table in the editor, the Touch Bar takes on a discrete context from the text editor itself, with table adjustment tools and a few editing buttons by default. This bar can be customised separately from the editor touch bar to hold any of the buttons from the editor that you desire.

            In addition to the Table button itself (described before), there are [two provided buttons](#touch_bar-editor-table_buttons-w) for modifying tables:

            MISSING_IMAGE:/path/to/gfx/touch_bar-ed...

          • Inspector Buttons

            The last major area of the interface to cover is the inspector (which also pertains to the inspector split in quick reference panels, and the floating inspector in composition mode). Just as the inspector does more than a few tricks, its Touch Bar support varies depending on what you are doing within it.

            With the exception of the few text editing areas, touch bar buttons in the inspector are not directly customisable, but you can still access customisation to manage the [global button set][Glob...

          • Compile Related Buttons

            Lastly, the compile window has a few buttons to help you manage your compile settings more easily.

            • Assign Section Layouts: corresponds to the button along the bottom of the layout preview area. Use this to change the look and feel of your document when it compiles.

            • Close: simply closes the compile window without saving any of your settings.

            • Reset: use this if you don't like where things have gone in this session, and wish to restore your settings to how they were when you first opened ...


      • Interface Language & Localisation

        Note on: Support for New Languages


    • All About Projects

      Don't worry, we won't attempt to go into every facet of what can be *in* a project in this chapter, you could safely say that's the rest of the manual! Instead we will focus on the project itself, as the largest unit of measurement in Scrivener; a container for the text you write and the material you accumulate to support your writings. As a citizen of the folders and files on the computer you write with, a project is the most important first thing to learn how to work with. It represents the fi...


      • The Basics of Using Projects

        Covers the various ways of saving and backing up project files, as well as opening existing files. Also discuss how project files work on the disk.


        • Creating a New Project

          When you first start Scrivener, you will be presented with a [Project Templates window](#ui-project_templates_window), which also includes a handy "Getting Started" section at the top. You may hide this category (or choose to reveal it again) using the Options button in the lower left of this window. In addition to providing an easy selection mechanism for new projects based on templates, you can also start from scratch with "Blank" or open existing projects from your disk with the buttons along...

        • Saving and Making Copies

          Your projects automatically save the work you do in them on a frequent basis. By default, this means that after two seconds of inactivity, the project will 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 ofThe name of the project in the title bar will have an asterisk after it whenever the project contains pending edits that need to be saved to the disk. If you stop typing or clicking in the progr...

        • Opening Existing Projects

          Existing projects can be opened in a variety of ways. For convenience, your MacScrivener keeps track of the last several projects you have opened, and stores them in a list, accessible from File//Recent Projects.... This list can also be accessed from the Project Template window, via the Open Recent button along the bottom.

          Secondly, by default Scrivener will remember any projects you leave open when you quit, and will re-open these for you next time you start the software. This behaviour can b...


          • Finding and Managing Projects as Files

            Finally, 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. In Finder, double-click the project you wish to open. 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 or where you saved it, you can search for "kind:Scrivener Project" to find every Scrivener project in your Spotlight index. If you're using the d...

          • Finding and Managing Projects as Files

            Projects can also be opened directly using Windows Explorer, or any shortcuts to the project file that you have saved in your quick launch bar or desktop.

            1. To open an existing project from your disk, you will first need to find the main project folder, which will be an ordinary folder with ".scriv" on the end of the name.

For example, if you named your project "Short Stories" in the My Documents folder, then you would expect to find a folder named "Short Stories.scriv" in My Documents.

            2. ...


        • Setting Favourite Projects

          For those projects you wish to always keep track of, no matter how frequently you may use them, you can "pin" a project to the main File menu:

          1. Open the project you wish to set as a favourite.

          2. Use the File//Add Project to Favorites menu command.

          The project will now be tracked (even if you change the name of it or move it to another location) and listed in the File//Favorite Projects// submenu. To stop tracking a project:

          1. Open the project you wish to stop tracking as a favourite.

          ...

        • Moving and Deleting Projects

          Despite technically being folders full of files, you can otherwise treat the 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 main folderproject file, and so moving it will have no detrimental effect on it. This also makes it easy to copy all of the work you need from one machine to another, since all of your research and working material is self-contained in the project. There are some exceptions if yo...

        • Project Format Upgrades

          Note on: Project Format Updated


      • 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---and in fact by default it will protect your work from basic mistakes like accidentally trashing an entire chapter, or using a global search and r...


        • Configuring Automated Backups

          By default, Scrivener will automatically back up every project that you work on, whenever you close it. These backups will be stored in your user folder:

          ~/Library/Application Support/Scrivener/Backups

          For those using the Mac App Store version, you will need to set up a backup folder yourself, as the software cannot do so automatically.

          C:\Users\Account\AppData\Local\Scrivener\Scrivener\Backups

          This location can be changed in preferencesoptions, and could even be set to save into a folder ...

        • Managing Backups for Large Projects

          Very large projects can conflict with what would ordinarily be good settings for the automated 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][project settings - backup].

          Once this project is excluded the automatic backup system will ignore it entirely. It will then be up to you to keep manual backups of the proj...

        • Manually Backing Up

          Backups can be created whenever and wherever you want. Use File//Back Up//Back Up To... and select a backup location and filename. The "Backup as ZIP file" option in the file dialogue 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 a file server or through cloud sync. By default, backup file names will be timestamped, making it easy to find a precise version later on and reducing confusion over which versio...

        • Restoring from Backups

          In the unfortunate event that a backup is needed to fix a problem with your current working project, you can make use of Scrivener's automatic backups to restore from an earlier version. As noted previously, Scrivener will create a full duplicate of your project every time you close it, retaining a select number of them in successively older revisions. Furthermore, these copies will be tucked away in a safe out-of-the-way place, to help avoid them being inadvertently opened and modified.

          If you...

        • Tips for Using Time Machine

          Methods for using Time Machine effectively with Scrivener.

        • Tips for Using Windows Backup

          Similar article as "Tips for Using Time Machine". Requires research into how this feature works.


      • Beyond the Basics of Using Projects

        In this section we'll go over some of the more advanced workflows you might require, if you need a little more out of Scrivener than what you might expect by just opening it at the beginning of a session, working on your project, and closing out the session. We'll go into splitting and merging projects, sharing them with others, discuss how much content you can reasonably put into a project and more.


        • Tips for Working with Projects

          This section contains a list of tips for handling different workflow requirements.

          At this point in your reading (if you are going through this like a book---and if so I commend you!) some of these tips might be arcane knowledge, so feel free to skip over this section unless you see an entry that looks like it might be useful to you.


          • Splitting Projects Up

            Brief advice on how to fork a project where one bit of it has outgrown the parent project.

          • Working Cross-Platform

            Tips for working with Windows; what the project file looks like on both systems; and what to copy when transferring data from one computer to another.

          • Sharing Projects Over the Internet

            If you wish to share a project using the Internet, you might think to attach it as an email, or upload it to a file sharing service so that one can download it or save a copy to an online backup service. Given that a project is a folder of files the best way to send a project is as a single "document", and the easiest way to do that is to use zip files (or whatever archive format you prefer). This can also prove a reliable way of copying projects to some types of external storage, such as USB th...

          • Project Size Limitations

            Since Scrivener was primarily written with the long-form author in mind, much effort has been put into making the project format as robust as possible. It can handle book-length manuscripts with ease, store large quantities of research material, and handle many thousands of individual 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...

          • Sandboxing and Authorised Folders

            <$MASOnly> Sandboxing is a technology used by all software sold through Apple's Mac App Store. Sandboxing works by limiting the tasks that applications are allowed to perform. One such limitation is that applications can only access files and directories that the user has granted access using an Open or Save panel.

            For the most part you shouldn't notice this restriction. When you open a Scrivener project, in most cases all of the files it needs are contained within that project file and by open...


            • How to Grant Scrivener Access to More Files

              Fortunately, there's an easy way to grant Scrivener permission to various locations on your computer so that Scrivener can still use all of these files seamlessly. Here's how:

              1. Use the Scrivener//Authorize Folder Access... menu command to open the directory access panel.

              2. To grant Scrivener permission to access external files, simply click on the Add Folders... button. This will bring up an Open panel from which you can select the directories you wish Scrivener to have access to. Alternat...

            • Tips for Authorising Folders

              When you grant Scrivener permission to access a directory, it will be able to access all of the files inside subdirectories of that folder too. Thus, you need only select the highest level folders that you feel comfortable giving to Scrivener.

              The main thing to consider when adding folders to the list is which files you need Scrivener to access. For instance:

              • If you tend to import many different files into Scrivener as aliases (using File//Import//Research Files as Aliases...), or if you ma...


        • Merging Projects

          NOTE//Maybe move this section to another part of the project? It's a bit advanced, and goes over some topics that at this point in the reading the user will not be familiar with. On the other hand it does fit in best within this chapter. It is possible to merge edits from one project into another for cases where these two separate projects have come from the same source at some point in the past. For example, if you take a copy of your project with you on a trip using your laptop and return hom...


          • Effective Use of Project Merge

            The following procedure outlines best practices for the use of this feature. Deviating from this procedure should only be done with care:

            1. Create a copy of the project using one of the above methods.

            2. At this point is safe to work in either or both projects simultaneously. For the best results you will want to avoid editing the same precise binder items while the two copies are "forked".

            3. Once you are ready to merge the projects, open the copy you consider to be the "master" copy, and ...

          • (see also)

            • [Restoring from Backups]: when things don't go as planned, use these instructions to get back to a better starting point.

            • [Copying Files and Folders Between Projects]: it might sometimes be best to only copy a few things rather than perform a full merge, or maybe you only need to restore a portions from a backup. These instructions can help with both cases.

            • [Using Snapshots]: the project merge feature will take a snapshot of an item whenever the main text of it has been altered by the p...

          • Collaborating with the Import Project Feature

            This capability could allow for a limited form of collaboration between two people. If you provide someone with a copy of your project and continue working on it, while they make revisions to the project on their own, you can later on merge their changes back into your project.

            It is possible to limit what you send to a collaborator, and have the additions or changes they've made merged back into the full project later on. For example you can use the File//Save As... command to create their cop...


      • Project Templates

        Simply put, project templates are ordinary projects that have had some basic starter material added to their binders and some settings tweaked to reduce how much work you need to exert to get started on a new project. They are in a word, well, two words: starting points.

        In some other applications, templates are almost a way of modifying the way the entire application behaves and so in a way they provide novel *features* that define the shape of what the software can do. With Scrivener, it's be...


        • Getting Started with Built-in Templates

          In our built-in templates you will find a help document at the very top of the Binder that explains what the purpose of the template is, how best to use it and in some cases, step-by-step instructions for popular modifications that can be made to its design. Most also contain a sample PDF in the Research folder showing how the final draft will look, using its default settings.

          MISSING_IMAGE:/path/to/gfx/templates-click_on_help.jpg

          Look for the blue "information" icon to get help on a template.

          ...

        • Converting a Project to a Different Template

          The short answer is that there is rarely a need to do this as there would be little benefit in doing so. Everything about a template can be exported into other projects, and so the best approach may be to bring select elements of the template *into* your project, rather than moving your project into a template. The specifics of how to do so are better documented in relation to those features themselves, so below you will find a handy list of cross-references to areas of a template that you might...

        • Creating Your Own Templates

          Instructions for creating new templates, either by customising existing ones, or building them from scratch.


          • Template Placeholders

            There are [several placeholders][Project Template Placeholders] that you can type into the editor that 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 ...

          • Project Template Placeholders

            NOTE//WINDOWS// However this information is populated in the future, it probably won't be from Contacts.app!

            Placeholder

            Description

            <$template_firstName>

            First name from Contacts.app

            <$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 Contacts.app

            <$template_street>

            Street address

            <$template_city>

            City

            <$template_ZIP>

            Postal code

            <$template_stat...

          • Custom Categories

            The project templates that you create, or acquire from others, can sort themselves into custom categories, which will appear in the template chooser sidebar along with the built-in categories (Fiction, Non-Fiction, and so forth). Categories are defined by the templates themselves, rather than being something you create first and then put templates into. This way, if you download a category from the Web, it can set up its own category for you.

            If you are still using Scrivener 21, these categorie...


            • To create a new category:

              You will need to assign a template to a category to create one. This will be done either in the process of [making a new template with the File//Save As Template... menu command][Creating Your Own Templates], or [updating one that has already been created by right-clicking on it and selecting Edit Info... from the contextual menu][Revising Templates]. Either way you will arrive at [the "Save as Template..." dialogue](#templates-new_template_window):

              1. From the "Save as Template..." panel, cli...

            • To rename an existing category:

              1. Open the new project template chooser.

              2. Right-click on the category and select "Rename Custom Category...".

              3. Type in the new name and click OK.

              This will update all templates found within that category. If you copy these templates to another machine, they will assign themselves to the revised category name. As noted above: categories are defined by templates, so if you were to edit the information of one template to use a different category name, and it was the only template in that c...


        • Revising Templates

          If all you wish to do is modify the way a template appears in the new project chooser, or to enable or disable whether its built-in styles are used when creating new projects, then you need only edit the template in place:

          1. Bring up the new project window with File//New Project... (<$custom:shortcut>).

          2. Right-click on the template you wish to modify and select the Edit Info... command.

          3. Make the changes you desire, and click OK to save them.

          Can I Modify the Built-in Templates?

          Built-...

        • If you've developed a number of templates in previous versions of Scrivener, the good news is that you won't have to do much of anything to use them in Scrivener 3, and if you leave them alone you'll be able to continue using them in the older version as well. Upon use, you may notice that the project created by the template will be upgraded seamlessly for you. You might eventually want to update these to the version 3 format to avoid this step; simply follow the same directions you would to mak...

        • Managing Templates

          Explanation for the Options button in the New Project interface.


          • Set Selected Template as Default

            Changes the default template selection to the template you currently have selected. Once set, the next time you call up this window it will highlight that template for you for quick access.

          • Hide Getting Started

            Hides the "Getting Started" category at the top of the category list. The functions it provides can also be accessed from the Help menu at any timefrom within any open project, so it is safe to remove the category once you've familiarised yourself with the program. You can also reveal it again using this same option menu.

          • 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 automatically.

          • Export Selected Template...

            Useful for sharing your templates on the Web, with other authors or for transferring templates to another working computer.

          • Edit Info...

            If you want to modify how the template appears in the template chooser, such as its title, icon, category or whether or not it builds predetermined styles into the new projects created with it, use this command. Refer to [Revising Templates] for further information. Built-in templates cannot be modified.

          • (reveal in Finder | Windows Explorer)

            Reveal in the FinderWindows Explorer

            : Reveals the selected template on the disk, using your file manager. NOTE//WINDOWS// note sure what nomenclature Windows version will be using here.

          • Delete Selected Template

            When a custom template is selected, you can use this menu item to remove it from your system. Built-in templates cannot be removed.

          • For those interested in managing these as files directly, rather than using the above commands, templates are stored in Scrivener's support folder (use the Scrivener//Reveal Support Folder in Finder menu command to get here easily), under the "ProjectTemplates" subfolder. Changes made to this folder will be reflected in the template chooser window after it has been closed and reopened.


      • Adjusting a Project's Settings

        Each individual project that you create will have many settings available to it, both as on-the-fly adjustments that can be made using the main application menus (primarily the View menu), as well as those options found within the Project//Project Settings... panel. Refer to [Project Settings] for full documentation on the following settings:

        • [Section Types][project settings - section types]: concerning how documents within the project are categorised into types, such as "chapter", "scene", ...


    • The Binder & its Outline

      The Binder is the document browser on the [left of the main project window](#ui-basic_window) where you can organise your work as individual topical pieces, or files. This is going to be like your ring-binder in the real world, where you would stash all of the notes, documents and maybe even the work in progress itself. Everything that represents information in your project, from an idle thought to a formal paper on a topic you are writing about, will be stored somewhere in the binder.

      To that...


      • What is Outlining?

        If like many authors you are accustomed to working in word processors for most of your writing, you no doubt have a few habits and ideas that you'll inevitably bring with you to Scrivener. If you intend to get the most out of what this program offers, there are a few key fundamentals worth learning, mulling over and eventually applying to your approach. Fear not, we aren't going to say you have to learn how to plot out your outline in advance before dipping the quill into the ink pot! The point ...

      • The Three Root Folders

        The binder has three default root folders which cannot be deleted or moved from the top level. They can be renamed and moved around among each other, but not within each other or other folders. To use Scrivener effectively, it is very important to understand the significance of these folders.

        MISSING_IMAGE:/path/to/gfx/binder-root_folders.jpg

        The three default top-level folders


        • The Draft Folder

          As the name suggests, the Draft folder is where you place all of the files you want to include in the actual work that others will read. 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.

          At a basic level, everything that goes inside the Draft folder will be compiled into one long text file when you use the "Compile..." command from t...

        • The Research Folder

          The Research folder is the default import location 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 needed to organise your research, or you can rename it and create other folders in the root level to hold different types of research or supporting material. Technically speaking, anywhere outside of the draft folder is a valid place to organise research, old drafts, notes and inspirational materials.

          As noted,...

        • The Trash Folder

          Whenever you delete a file in Scrivener (by pressing Cmd-Shift-Delete, for instance, or by selecting the Documents//Move to Trash menu item), the file is not actually removed from the project but is instead moved to the special Trash folder (it works just like the Recycle Bin in Windows). You can tell at a glance if the trash folder has anything in it, as its icon will appear like an overflowing trash can. Permanently purge all trashed files from the project with the Project//Empty Trash... menu...


      • Using the Binder

        Now that we've got some theory out of the way, let's get down to brass tacks. Effectively working with the resources in your project is essential in a program that encourages you to accumulate them. While the basics may serve everyone well up to a certain point, if you ever find Scrivener starting to feel a little awkward, you might want to come back to this section and review the various tools available for selection, modification of selection, focus of view and movement of items through mouse,...


        • Adding New Items

          Before you can go about working with items in your binder, you'll need a few to start with. You should now be aware of the three basic *types* of item native to Scrivener's binder: files, folders and file groups---or what you get when you indent one file under another---let's talk about how to make these things and what to expect while doing so.

          Although this is a section about the binder, it is worth noting that you can add new files and folders from nearly every context within the project win...


          • The Many Ways to Add Things

            Since making new documents is such a vital part of Scrivener we've provided numerous ways to go about doing so, from toolbar buttons, to keyboard shortcuts to simply pressing the !Return key. Let's go over the options:


            • The "Add" button in the toolbar

              This is a multipurpose button, as indicated by the downward facing [arrow on the right-hand side](#toolbar-add_button). That means if you click on the left side, it will create a new text file. If you click on the arrow, you'll get a selection of available types for this project. By default that will be files, folders and web pages (the latter will be disabled if you're trying to add within the Draft folder area), but if you've added [Document Templates][] you'll see those listed here as well, a...

            • (figure: add button)

              MISSING_IMAGE:/path/to/gfx/toolbar-add_button.jpg

              The "Add" button on the default toolbar.

            • Footer bar buttons

              Along the bottom of the binder sidebar, corkboard and outliner views you will find [a footer bar with a few buttons for adding files and folders](#binder-footer_bar_buttons).

            • (figure: footer bar)

              MISSING_IMAGE:/path/to/gfx/binder-footer_bar_buttons.jpg

              Binder footer bar: Add Text, Add Folder and access to the contextual menu.

            • Contextual menu

              The "Add" submenu in the right-click contextual menu provides all of the basic options found when clicking the downward arrow on the toolbar "Add" icon. In addition, it also provides quick access to the File//Import//Files... menu command (<$custom:shortcut>), when adding files outside of the Draft folder area.

            • Menus & keyboard shortcuts

              There are several shortcuts available for adding new items:

              * Project//New Text (<$custom:shortcut>): adds a new text file. In cases where the selected item has [Default Subdocument Template][] assigned to it, the name of that template will be printed instead. In the Novel template, if you click on the "Characters" folder to add a new character sketch, the menu command will read, "New Character Sketch".

              * Project//New Folder (<$custom:shortcut>): adds a new empty folder.

              * !Return: by defaul...

            • Dragging text

              If you select text in any program and drop it into Scrivener's binder, corkboard or outliner views, a new item will be created in that location with the text you dropped. If this is done from within Scrivener's editors, then text will be *moved* into the new file. This is a great way to break apart a larger file: you can scroll through, selecting chunks of text and moving that text to new files wherever you drop them. Where you drop the text will matter:

              * Onto a folder or file group or in bet...

            • Adding items with the Touch Bar

              Last but not least, if you own a Mac with a Touch Bar, one of the default buttons provided universally is the "Add" button, again represented with a "AddButton" sign. With the exception of importing web pages, it essentially replicates the options provided by the "Add" button in the toolbar, when clicking the downward arrow. Refer to the Touch Bar's [Global Buttons][] for more information.


          • Figuring Out Where Things Will Go

            The most basic concept to be aware of is that Scrivener will create new items relative to your current selection in the active view (be it the binder, editor or its copyholder). For example if we select a file in the binder and add a new text file, the file will be created after the selected file. When the focus is in another area of the project window, the selected item in the active editor view will be used. For example, if you create a new item while typing in the Document Notes tab of the in...


            • How Things Are Nested When Added

              You may have noticed that sometimes files seem to be nested when you create them and other times they aren't. The logic behind this is very simple, though it is a little unorthodox if you're used to file managers or other outliners. Scrivener's logic is designed to produce the most often desired result, and can be simply understood by what *type* of thing you are creating:

              • When creating a folder, the behaviour will always be to add the folder as a sibling to the selected item.

              • When creati...


          • Renaming Items

            To rename an item you've created, double-click the title to toggle editing mode. You can also use EscF2 key to toggle editing mode on the selected item. You can click elsewhere to save the modified title, or use the !Return key to confirm your changes.

            If a title is left blank, Scrivener takes a dynamic approach to how things are named. You can read more about titles in [Titles and Adaptive Naming].


        • Selecting Items

          Any single item can be selected by pointing the mouse at it and clicking, I think we can all agree about that one. While that does the trick for most of the things we need to do, Scrivener was also built around the concept of selecting and working with multiple items at once. Not only does this make it easy to do tasks with many items simultaneously (say, to move ten files from one section of the outline to another with drag and drop), but the editor itself will react accordingly, displaying tho...


          • Keyboard Navigation

            The four arrow keys by themselves will move the selection around in the outline according to the following rules, and can be augmented with a few modifier keys:

            • UpArrow and DownArrow move the selection up and down the list from one visible item to the next.

            • LeftArrow will move the selection leftward in the hierarchy, selecting the parent of whatever was selected when pressing the key. The left key will also collapse the selection, if any of the selected items are expanded. If a group (or ...

          • With the Mouse

            Selecting items with the pointer (whether it be controlled by mouse, trackpad, tablet or joystick) is a standard set of functions that are broadly useful in many applications. The rules are simple, but can be combined to produce selections of items that would be difficult or even impossible to produce with the keyboard.

            • As noted above, simply clicking on an item will select it and simultaneously remove the previous selection, meaning you'll only ever have one item selected at a time when cli...


        • Finding Where You Are in the Outline

          When you click on items in the binder and then move over to the editor, the last thing you selected or clicked on will remain highlighted in the binder until you yourself change it. This means that if the editor ends up viewing something other than what you clicked on in the binder (for example, loading an index card so you can write), the highlight will no longer be pointing at the thing the editor is working with.

          There are a few advantages to this behaviour, all which work together to mainta...

        • Moving and Copying Things Around

          Once you've got things selected, you might want to move them from one place to another. Simple drag and drop with the mouse will often suffice, but there may be times when more precision is required, or in some cases, where the distance between here and there is too far to easily drag. As you might be coming to expect by now, there are a few different tools in this chest.


          • Moving with the mouse

            Items can be moved around in the binder with drag and drop. Pick up the item by clicking and holding the mouse button down, then drag the mouse pointer to where you wish to drop the items, releasing the button. The binder will display a blue target underneath the pointer, showing where the drop will end up. Slide the mouse left or right to control the indent level of the drop point, and leave the mouse along the top or bottom edge of the view to dynamically scroll it.

            If the place you want a dr...

          • Copying with the mouse

            Although not enabled by default, you can toggle this capability with the "Option-dragging creates duplicates" option.

            Another approach is to duplicate the files with the Documents//Duplicate submenu (<$custom:shortcut>), which will create a copy right alongside the original that you can drag and drop to the intended location.

          • Moving items with the keyboard

            NOTE// If shortcuts for moving items ever change, you'll need to fix these hard-coded references. Ctrl-Cmd-ArrowCtrl-Arrow keys can be used to move an item around spatially in the binder, step by step. Up and down will increase or decrease its placement in the outline, while left and right will promote and demote the item. For example, selecting a folder that holds the contents of chapter eight, and pressing <$custom:shortcut> will move it down one spot, swapping its position with the chapter b...

          • With the Toolbar

            Although not present in the default set of toolbar icons, you can add item movement buttons to the main toolbar, provided as either a four-way set of movement buttons, or two pairs of up/down and left/right buttons. These operate in a similar fashion to keyboard movement, one step at a time in the indicated direction.

          • By the icon

            A bit of knowledge that can save you a lot of time is that everywhere you see an icon in Scrivener, you can drag it, and in doing so it will act as a proxy for that item, just as though you dragged it from the binder or any other view. You might be writing in a file in the editor and realise you want to move the section to a spot in the binder on your left. You could attempt to locate the item in the binder and then drag it from point A to B, but instead you can drag the icon straight out of the...

          • Moving Multiple Items

            If you've selected multiple items, most methods for moving them will gather these items together at the target location, in the order they appeared in the selection (in most the binder order). There are some important exceptions:

            • It's an extension of the above, but bears reiteration: if the view the you selected from has been sorted (such as in the search results sidebar or the outliner) then the moved items will be assembled in the target location using that sorted order. For example, if yo...

          • Long distance travel

            When you need to move a file so far that the point of its destination is out of sight from the point of origin, sometimes neither the keyboard nor the mouse can be convenient all by themselves. To fill in that gap, we have two methods that should help:

            1. The Documents//Move To submenu presents a list of all the items in your binder, each and every one of them a potential target for your drop. The item you select will become the parent for the moved item, and it will be places as the last sibl...

          • Copying Files and Folders Between Projects

            The easiest way to copy a file from one project to another will be through the following steps:

            1. Open both of the projects at once.

            2. Drag the item icon from the binder, corkboard or outliner view, or anywhere where you can see its icon and it is draggable.

            3. Drop the icon into the project you wish to copy the item to, into a location where files can be dropped.

If you drop into a text editor you'll get a link instead, if you drop into a bookmarks list you'll get a handy link---but if y...


        • Expanding and Collapsing the Tree

          Once the number of elements in your binder exceeds a certain point, it may prove beneficial to learn a few of the tools available for controlling large amounts of items. The most recognisable of these is one you've already been introduced to: the "tree" view, or outline, where you can collapse portions of that tree to decrease the amount of information on your screen at once.

          The ability to collapse and expand larger areas of the outline, either surgically or in bulk, can mean the difference be...


          • By elements

            We might as well get the basics out of the way first. To expand or collapse portions of the outline, click on the arrow (when using the classic Windows theme, this will be a "+" or "-" icon instead) to the left of any group to reveal or hide its contents. The *state* of every arrow in the binder will always be remembered, meaning you can expand or collapse areas within larger chunks of the tree, and then collapse the whole thing, assured than when you expand it again it will be as you left it. T...

          • Incrementally by level

            Sometimes fully expanding a section of the tree will be more than you want, but you still wish to expand down two or more levels. This can be done by alternating between two different complementary commands:

            1. Press RightArrow to expand the tree one level.

            2. Use the Edit//Select//Select Subgroups menu command to move your selection from the main group to all of the items within it that are also groups.

            3. You guessed it, RightArrow again to expand the second level. Repeat until the tree is...

          • Reveal and hide everything

            The menu commands "Expand All" (<$custom:shortcut>) and "Collapse All" (<$custom:shortcut>) in the View//Outline submenu will expand or collapse every container in the view at once. Both of these commands work in many areas of the interface where it is possible to expand or collapse items.

          • Collapse all to current level

            <$include>

          • Hoisting the Binder

            Although not technically an operation that falls under managing the tree outline---where it comes to corralling an ever-growing corpus of information and writing material---being able to focus the binder on only one portion of the larger outliner deserves mention here. If the idea of blotting out everything in your binder save for the contents of one folder (like one chapter in the draft) appeals to you, hoisting is what you're looking for.

            To hoist the binder, select one single container of an...

          • Marking Items as Separators

            In longer outlines it might prove useful to add visual separators so that you can easily scroll between them, as landmarks in a large tree. This is done not by inserting a special separator item, but by marking existing items as being separators. The effect is to display this item's title in a bolder font and draw a shaded box around it. This is an item setting, and as such will be duplicated along with the item, or included as part of a [document template][Document Templates].

            MISSING_IMAGE:/p...


        • Typing in the Binder

          • To end editing at any point: Esc, Shift-Return

          • Tab to move between text fields, Shift-Tab to cycle in the other direction.

          • Return to add a new item when in synopsis field or if editing isn't active (prefs).

          • Return to move from title to synopsis (when applicable).


      • Multiple Selections

        Cover how MS differs from standard single-point selections for all view modes and cross ref to relevant features where appropriate, like corkboard stacks.


    • All About Files and Folders

      If you're looking for the basics of how to use the binder to create new files and folders, refer to [Adding New Items][]. In this section we will be taking a deeper look at what files and folders represent and how to use them in your project.


      • Folders are Files are Folders

        As you no doubt instinctively know from other programs, a folder is a place where you organise files. You can create folders on your disk and then 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 it...

      • Binder Icons

        Basic introduction to the various default icons that will be found in the Binder.


        • File and Folder Binder Icons

          Icon

          Explanation

          **Text Document Icons**

          MISSING_IMAGE:/path/to/gfx/TextBlank.jpg

          An empty text document.

          MISSING_IMAGE:/path/to/gfx/IndexCard.jpg

          A synopsis has been added to the document, but nothing has been typed into the main text.

          MISSING_IMAGE:/path/to/gfx/Text.jpg

          This text file has text content.

          MISSING_IMAGE:/path/to/gfx/ScriptBlank.jpg MISSING_IMAGE:/path/to/gfx/Script.jpg

          Scriptwriting documents.

          MISSING_IMAGE:/path/to/gfx/TextBlankGroup.jpg MISSING_IMAGE:/path/to/gfx/IndexCardGroup...


      • Titles and Adaptive Naming

        The title of an item is featured prominently in every location where items are represented together, even in the editor header bar. There are many ways to change the title of an item:

        • In the binder, double-click on the item to edit its name. You can also use the EscF2 key to toggle editing mode from the keyboard on and off.

        • When viewing the item in the main editor, Quick Reference panel or a Copyholder, you can click into the editor header bar where the title is printed to edit its name (...

      • Custom Icons

        Custom icons can be used to embellish the appearance of your binder items. Anything can have a custom icon, even the three root folders: Draft, Research, and Trash.

        There are a few ways you can change the icon for an item:

        • Select it in the Binder, Corkboard, or Outliner, and use the Documents//Change Icon submenu.

        • Access the item's contextual menu, and use the "Change Icon" submenu.

        • Use the quick icon selection menu by holding down the OptionAlt key when right-clicking on it.

        • While...


        • Creating Your Own Icons

          In adding your own icons to Scrivener you have the choice of installing them into individual projects or making to them available to all of the projects you use. To add an icon of either type:

          1. Load the icon manager with Documents//Change Icon//Manage Custom Icons...

          2. Then either:

          a. For global icons made available to all projects, click the AddButton button below the lower table. Icons install this way will only be visible while using this computer account.

          b. For adding icons to the c...


          • Tips for Sharp Icons

            After you add an icon to the manager, what you see in the window is what you will see in the binder and other views. If the icon looks distorted or blurry to you in this window, then it will look that way everywhere. You can remove a bad attempt and try again using the following tips for creating sharp and great looking icons:

            • Common problems are files with lots of white or transparent padding around them. Open these files in a graphics editor (even PreviewMS Paint will do for simple croppin...

          • Creating High-Resolution Custom Icons

            NOTE//WINDOWS// This has been opened up to both platforms as the new version of Scrivener for Windows will support hi-res. It will need to be verified if the specs are right, and if this method of importing icons works. If you intend for your icons to look good on both RetinaHi-Res and standard displays you will need to supply two different icons (16 px square for standard; 32px square (at 144 DPI) for high resolution). Importing a dual-purpose icon is simple:

            • Name the low-resolution version...

          • Creating Your Own Icon Sets

            How you name your custom icons will determine whether or not they are grouped together as a set in the custom icon menu (like the built-in "Flag" set). The format for this naming convention is "Category (Icon Name)", such as "Flag (Blue)". This causes this particular icon to be grouped together with the Flag set and displayed in the menu as "Blue".

          • Making Icons iOS Compatible

            Naturally, icons that are installed on your computer will not appear on iOS if you take your project to that platform. However if you load your icons into the project, it will use them if it can.

            The iOS version of Scrivener uses a different size icon than either macOS or Windows versions. This can mean that making an icon that looks crisp and clean between all platforms isn't viable, but a reasonable compromise can be made by using the larger 90 x 90 pixel size and letting each system downsize...

          • Icons from Other Sources


            • Using Mac Finder Icons

              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 Cmd-I to get info on that file.

              3. Click once in the small icon in the upper-left corner of the info palette. You will see a halo surround it when it is properly selected.

              4. Press Cmd-C to copy the icon.

              5. Open Preview.app and pres...

            • Using Emoji for Icons

              NOTE//WINDOWS// Marked as macOS only for now, as I don't think Windows even does this. You can use Emoji, or indeed any character at all including Unicode symbols or even regular letters and numbers, as icons in Scrivener. These will be visible on iOS as well, and owing to their scalable size, will be crisp on all screen resolutions. To create an icon from a character:

              1. Select the binder item you wish to apply the new icon to.

              2. Use the Documents//Change Icon//Icon from Text... menu comma...

            • Using ICO Files

              NOTE//WINDOWS// This needs research before it can be written up.


        • Managing Your Icons

          Icon Assignments are "Sticky"

          It is good to keep in mind that when you assign a custom icon to an item, it will remain assigned to that icon *by name* even if an icon by that name cannot be located. This is what keeps your assignments safe no matter where the project is taken, but it also means that when you rename or delete icons and then later add them back or change their names to what they were, old items that had been assigned to them will start showing these icons again.


          • Renaming icons

            You are not stuck with an icon name if you don't like it, but take the caution above to heart. If you have already used this icon for some time in your projects, all of those items referring to it will lose the assignment (unless you change the name back), as they will only ever be looking for the old file name on the disk.

            1. Open the icon manager with Documents//Change Icon//Manage Custom Icons...

            2. Double-click on the name of the icon you wish to rename.

            Take care to not edit the extensi...

          • Removing icons from Scrivener

            You can remove an icon from either the current project or globally from your computer. This will not strip the assignments to that icon from other projects, and so if you ever change your mind and add the icon back, you'll find all of those items go right back to working the way they used to.

            1. Open the icon manager with Documents//Change Icon//Manage Custom Icons...

            2. Select the icon(s) you wish to delete (Shift and CommandCtrl work here).

            3. Click the respective DelButton button beneath ...

          • Copying Icons Between Global and Project

            Icons can be dragged between the lower and upper sections 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 lower table. If you try to drag an icon with an identical ...

          • 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 your computer, in the lower half of the pane, then when you take your project file to another computer all of those icons will not be displayed. 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 global ...

          • Icons on the Disk

            Scrivener merely checks a couple of locations for files when working with icons, meaning you can manage icons yourself directly with a file manager if you prefer to do so over the user interface in Scrivener. Global icons will be located in Scrivener's support folder, use the Scrivener//Reveal Support Folder in Finder menu command, and then double-click on the "Icons" folder.

            For project-specific icons, they will be stored directly in the project itself. With the project closed, right-click on ...


      • Document Templates

        Main article


        • Using Document Templates

          As with most things in Scrivener, templates are a feature of your project and its binder. Templates are not something you create separate from your project, or in a panel somewhere---they are normal documents right in the mix with everything else in the project. This means they can take advantage of everything a normal item in your binder can---from custom metadata to label colours to even compile settings.


          • Setting a Document Template Folder

            Templates are designated by placing them into a special folder, marked as being a template folder. Each project can only have one template folder at a time. To set it up, you'll need a folder to start with, it can be empty or already contain a few items you wish to use as templates. This folder can be placed anywhere in the binder except for within the Draft and Trash folders. Once you've created the folder, you will need to designate it as being the official templates folder for this project:

            ...

          • Creating Document Templates

            Creating new templates is as easy and no different than 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 add to the templates folder will be available for usage within the project.

            Any type of file that you can add to the binder (which is just about everything) can become a template. For many types of files this wouldn't serve much purpose---who needs dozens of copie...

          • Creating New Items with Templates

            Once a container is designated as a template folder, and items have been added to it, you can create copies of these files elsewhere in the project via the Project//New From Template submenu, or by using the green AddButton button in the toolbar. The items in this menu will be arranged precisely as they have been organised in the binder, with groups becoming further submenus. Creating new items from templates will follow all of the same rules and behaviours used to create built-in types like tex...

          • Clearing Document Template Folder

            Use the following instructions to clear the document template folder:

            1. Open project settings with the Project//Project Settings... menu command (<$custom:shortcut>).

            2. Click on the Special Folders tab.

            3. Using the dropdown menu in the Templates Folder section, select "No Templates Folder", at the very top of the menu.

            4. Click the OK button.

            This action will not delete anything in your project. It will merely remove the special status from the previously designated templates folder. It...


        • Default Subdocument Template

          Note on: Documents Menu


          • Cascading Default Templates

            Each folder (or file group as the case may be) can have its own default type assignment. Where subgroups are concerned, the default type "cascades" into all subgroups, no matter how deeply nested. The exception to this is when a subgroup within that hierarchy has its own default template type assigned to it.

            MISSING_IMAGE:/path/to/gfx/org-doctemplates-subdocument_types.jpg

            A demonstration of multiple subdocument templates in action.

            In the [provided illustration](#org-doctemplates-subdocument_...


        • Shared Templates on the Disk

          For cases where you would like to provide a set of default file types for all of the projects you use, the shared templates folder might be your best bet. This feature keeps watch of a specified folder on your disk, into which you can place any files that are valid to be imported into Scrivener.

          1. In the [General: Templates !preference pane][general - templates], click the Choose... button.

          2. Select the folder you wish to place your shared template files within.

You should now see any file...

        • Copying Templates Between Projects

          If you would like to copy some templates you created into another project, you can very easily do so by dragging and dropping the templates folder (or individual items from one template folder to another) between open project binders---just like you would copy any sort of binder item from one project to another.

          Scrivener will not copy the templates folder *setting* across, so if you are copying the entire folder, you will need to set it up as described [earlier in this section][Setting a Docum...


      • Section Types

        The intention of this section is to focus on the use of section types as it pertains to working with items in the binder. The section in the compile chapter will cover how they get used, while the section in project notes will cover how they are set up.


        • Applying Section Types Manually

          There are three ways to change a section type, one of which is suitable for adjusting many items at once. All three methods use the same menu, so we'll take a look at that first:

          Structure-Based

          : This is a built-in option that causes the item to inherit its type based on the project's settings. If for example the project is set up so that all folders are assigned to the "Chapter" type, then using this setting on a folder would cause it to act like a chapter---if we converted that item to a fil...


          • In the Inspector

            MISSING_IMAGE:/path/to/gfx/section_types-inspector.jpg

            The inspector is a handy way to view and adjust the section types of individual items.

            Click the [Metadata inspector tab][Metadata Tab].

            Expand the "General Metadata" section if necessary.

            Click the dropdown control to open the section type selection menu.

          • In the Outliner

            As we have seen [previously](#project_settings-section_types-in_practice), the outliner view with the "Section Type" column added to it (use the View//Outliner Options//Section Type menu command if you don't see it) is a great way to get an overview of the type assignments for large groups of items. To change an assignment for an item, click into the section type cell for that item's row and make your selection from the menu.

          • With the Contextual Menu

            When you need to change the section type assignment for many items at once, the right-click contextual menu is the way to do it:

            1. Select the items you wish to change in any group view or in the binder sidebar.

            2. Right-click on the selection, and use the "Section Type" submenu to change the type.

            When you have a mixed selection, the "Default Subdocument Type" portion of the menu will never be shown. Keep your selections confined to containers of any type if you need access to it.


        • Combining Section Types with Document Templates

          Although you typically won't have to bother with section types for items outside of the draft folder, [document templates] are one place where they can prove useful. When you use a document template with a manually applied section type, the newly create documents will also be so assigned. Here are a few examples of this concept:

          MISSING_IMAGE:/path/to/gfx/section_types-combined_with_document_templates.jpg

          A few document templates with predefined section types, including some boilertext, display...

        • (see also)

          <$include>


  • Preparation

    A driving goal behind Scrivener is to be your first stop when a new major project is embarked upon. Much of its design is pitched toward tools that address the early phases of a writing project---when you're still putting together basic ideas and investigatory research and you need tools that can be as vague as you are, tools that can, as you refine your ideas, become richer and more attuned to the intricacies of your work in progress.

    Another Scrivener principle is that what works best for you...


    • The Editor & its Views

      The editor in Scrivener is a multi-function viewer, organisational and editing tool; it is where you will be spending most of your time in the software. In this chapter we will first cover the editor itself as a tool, and then dive into its flexible organisation tools, the corkboard and the outliner. For topics relating to text editing itself, head over to [Writing and Editing], including coverage on the ability edit multiple text files at once, in [Editing Multiple Documents].

      Looking for a ba...


      • The Editor

        Before getting into what one does with the editor in practical terms, there is plenty of ground to cover in the many things the editor *itself* can do. In this section we'll go over header and footer bars, which adapt their controls to what you are working on in the main viewing area itself; how to split the editor in two (and the various ways in which we can integrate those two panes with each other and the binder); how to attach additional documents to each editor with "copyholders" and finall...


        • Header Bar

          The header bar appears at the top of each editor pane. It is the primary tool for project and document navigation within the editor, finding out where you are or what you are looking at and controlling split view states of the editor.

          MISSING_IMAGE:/path/to/gfx/editor-header-buttons.jpg

          The editor header bar

          It contains the following functions; we'll go into detail on each of them in the rest of this section:

          *History*: much as in a Web browser, scroll back or forward through the history of d...


          • The Active Editor and Targeted Editor in Split Views

            There are two concepts to be aware of when using splits:

            • Targeting: the split that is targeted will have a blue background. This means anything you click in the binder sidebar will be loaded within that split; clicking "targets" that split.

            • Active: this is the split you are working in, or where you have clicked into the editor last. In some cases that may not be the split that is targeted (by default the two conditions are one and the same). The active split is indicated by an underscore ...

          • History

            On the left side of the header bar, marked (a) in [](#editor-header-buttons) are the history navigation buttons, which should be familiar in usage from any Web browser. Use these to navigate backward (<$custom:shortcut>) and forward (<$custom:shortcut>) through the navigation history.

            If you right-click (or click and hold) on 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 poi...


            • With Quick Reference and Copyholders

              Although there are no buttons for navigating history in these panes, the menu commands and shortcuts are both available for use. Unlike in the editor, panes will only store their history lists for the duration of the session, but within that session, each Quick Reference window and copyholder pane will remember its history even after you close them.

              Copyholders will have a history when you've opened subsequent documents into the same pane over the course of the session. Although one need merely...


          • Header Bar Icon

            Proceeding left to right, after the navigation buttons you'll see an icon (between markers (a) and (b) in [](#editor-header-buttons)). This is not merely ornamental, the icon can be dragged and in doing so the action is identical to dragging the item from the binder. You can thus move a file you have open by dragging this icon to another folder in the binder or a corkboard in another split---and any other task that can be done with drag and drop in Scrivener.

            For binder items that you are view...


            • Header Bar Status Icons

              Icon

              Explanation

              MISSING_IMAGE:/path/to/gfx/headerbar_icon-scrivenings.jpg MISSING_IMAGE:/path/to/gfx/headerbar_icon-corkboard.jpg MISSING_IMAGE:/path/to/gfx/headerbar_icon-outliner.jpg

              [Multiple selections] will display an icon in accordance with the current view mode in use: scrivenings, corkboard and outline, respectively.

              MISSING_IMAGE:/path/to/gfx/headerbar_icon-collection.jpg MISSING_IMAGE:/path/to/gfx/headerbar_icon-search_collection.jpg

              The first icon indicates that you are [viewing the...

            • Icon Drag and Drop Functions

              As with nearly every depiction of an icon in the software, it can be dragged and dropped, serving in most cases as a proxy for the file it represents. Here are a few practical examples of how dragging an icon out of the editor could be used:

              • Into the text of the opposing split to create a hyperlink pointing back to the document in this split, or into that document's bookmark list in the inspector.

              • Into the header bar of the other split to load it a second time, or with the OptionAlt key h...


          • Header Bar Contextual Menu

            The main editor header bar itself can be right-clicked (anywhere except for the history buttons, which have their own right-click functions) to reveal a contextual menu with a number of commands from the main menus, but also some unique commands you won't find elsewhere. The following is a listing of all the commands that are available and their uses:


            • Reveal in Binder

              Displays the location of the currently edited file in the binder, opening the sidebar and switching to the binder if necessary (you can also use the <$custom:shortcut> shortcut). It will also expand any containers to reveal the position of the item if it is nested. When used from the icon header bar menu with a multiple selection, all of the entries included in the selection will be highlighted in the binder. If you wish to reveal an item in the collection you are viewing instead, use the "Revea...

            • Reveal in Collection

              If the item is located within any collections (even search results collections), then this submenu will list them. Selecting one of the options in the menu will open that collection in the binder sidebar and highlight the document within the list.

              Given that it also finds copies from search result collections, projects with a large number of items or several saved search collections may experience a little lag when displaying the contents of this menu to allow time for each search tab to refres...

            • Reveal in Other Editor

              If the item you are viewing in the editor is listed in the *other* editor---for example if the other editor is showing a corkboard with this document somewhere in it---then this command will be available and it will function precisely as Reveal in Binder does, only targeting the other editor's view instead.

            • Path

              Operating in a fashion similar to Reveal in Binder, this command instead allows you to select and reveal from the full path of the current document. The top entry will always be the current document; the entry below that its immediate parent; and so on until the root of the project binder is reached. When a selection from this menu is made, in addition to revealing the selected item in the binder, it will also be loaded into the main editor, replacing whatever you were viewing previously.

              This ...

            • Go To Document

              This menu functions precisely the same as [the Navigate//Go To// submenu does][Navigate Menu], and is thus provided as a convenience to using the main application menu. If the binder is hidden or you would rather not scroll and open folders, for instance, you can navigate the editor to other areas of the project without having to alter your window layout.

            • Go To Collection

              This menu functions precisely the same as the Navigate//Go To//Collection// submenu does, and is thus provided as a convenience to using the main application menu. <$include>

            • Take Snapshot

              If the current thing you are viewing in the editor is text, this command will take a [snapshot][Using Snapshots] of the text in the main editor and archive it for future reference. This command always impacts only one text file. When used in a Scrivenings session, only the constituent portion of the session your cursor is currently within will be saved to a snapshot.

            • View Snapshot in Other Editor or Copyholder

              The next two submenus provide the same exact contents, listing any snapshots found for the current document. Selecting one of the entries will load the specified snapshot in either the other editor, opening a split if necessary to do so (you can read more about that capability in [Viewing Snapshots in the Editor]). The second menu option will of course load the snapshot into the current editor's [copyholder][Using Copyholders]. Hold down the Option key to load the snapshot with [comparison mode ...

            • Match Split Documents

              Opens viewed content in the other editor, in essence cloning the view but without enforcing any view settings. E.g. if you have a corkboard view on the left editor and a Scrivenings session on the right, cloning the left view into the right editor displays the contents of that corkboard in an editing session instead. This command will not be available if no splits are open.

              You can also drag and drop the icon into the other split's header bar to clone the view.

            • Lock In Place

              Locks the active editor so that no binder clicks or other external navigation requests will affect it. When an editor is locked, [its header bar will turn a shade of red][Locking the Editor]. This can also be done with the <$custom:shortcut> keyboard shortcut.

            • Lock Inspector to Editor

              Refer to [Locking the Inspector] for information on how this works.

            • Lock Group View Mode

              When viewing a container or collection group, this command will be activated. It will lock the currently used view mode for this container so that no matter what you change it to at a later time, [you will always return to it with the selected view mode][Locking the Group View Mode].


          • Header Bar Title

            Continuing along our journey of the header bar, we arrive at the name of the thing being viewed itself, marked (b) in [](#editor-header-buttons). As you navigate through the project, the title here will update to reflect the current contents of the editor. In most simple cases, it will display the title of the document you are currently viewing or editing.

            When viewing a group of items in a corkboard or outliner, the name of the viewed container will be displayed. For example, if you click on a...


            • Editing the Title

              If the presented title is printed in black lettering as opposed to grey In Scrivenings mode the title would be both grey and black. You can interact with the black portion of the title field. , you may edit the name of the object it represents by clicking into the text area, making your edits and then pressing !Return to confirm the changes and send the cursor to the editor viewer area. You can also use the Navigate//Move Focus To//Header Bar Title menu command (<$custom:shortcut>) to move the c...


          • Inspector Locked to Editor Indicator

            The red button to the left under the (c) marker in [](#editor-header-buttons) will appear when the inspector has been locked to this editor split, and thus serves as a visual indicator of which split the inspector is making use of. You can click the button to dismiss the lock.

          • Jump to Scrivening or Corkboard

            The button on the right side, marked above (c), will only appear under two distinct conditions:

            • If the editor is displaying a [Scrivenings session][Editing Multiple Documents], this is the "Jump to Scrivening" button. One entry for each chunk of text (or "scrivening") will be displayed, offering quick navigation within a section, or mere reference of where you are within the overall session.

            • When viewing a [stack of corkboards][Stacked Corkboards] the tool will generate a list of every co...

          • Sidebar Navigation

            Next, you will find two chevron style arrows pointing up and down, under the (d) marker in [](#editor-header-buttons). These arrows provide sequential navigation within the project sidebar (be it the binder, search results or collection list).

            Clicking the up arrow (or using the <$custom:shortcut> shortcut) will move you to the document immediately above the current document in the sidebar. The selected document will always be the one immediately above, even if that item is currently hidden and...

          • Split View Button

            The last button on our tour, marked (e) in [](#editor-header-buttons), is a multi-purpose button for controlling editor splits. What will happen when you click on it will change depending upon the current layout of the application and your last preferred split orientation.

            MISSING_IMAGE:/path/to/gfx/editor-header-split_buttons.jpg

            The three split button states: split horizontal, vertical and close split.

            The function of the buttons as shown in [](#editor-header-split_buttons) are:

            1. Change ...


        • Footer Bar

          Below each editor pane is the footer bar. This is the most dynamic element of the editor, in that it will change depending on the type of document visible and the current editor mode. When a text document is being viewed, for instance, it will display the word and character count along with a dropdown menu 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 media is displayed, it shows the current play...


          • Group View Controls

            MISSING_IMAGE:/path/to/gfx/editor-corkboard_outliner_footer.jpg

            The footer bar controls for outliner and corkboard.

            Both the corkboard and outliner will feature the same cluster of controls on the [left side of the footer bar](#editor-corkboard_outliner_footer):

            • The AddButton button creates a new text item---the same as would do when using any of the other methods for doing so, such as <$custom:shortcut> or Project//New Text.

            • As well, the next button creates a new folder in the same fash...

          • Text Zoom

            You can make the text in the main editor larger or smaller without changing the font by using the text scaling pop-up in the left side of the footer bar. See [Scaling Text] for more information.

          • Quick Text Statistics

            In the middle of the footer, the word count 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) te...

          • Text Goals

            When you are editing a single document in standard (not scriptwriting) mode, a small target icon will appear on the [right side of the footer bar](#editor-text_footer_bar). This button brings up the target options for the current document where will let you set the numeric word or character goal you intend to achieve with the section. Refer to [Document Goals] for further documentation on this feature.

          • Included in Compile Indicator

            The last element on the footer bar, which appears in text editing mode for all text and group items in the binder, is an indication of whether or not the active document will be included in compile. If the document has a small checkmark in the corner then (unless other conditions exclude it, such as selecting a different chapter as a target) it will be included in the output. A small "X" icon means this document will never be included.

            MISSING_IMAGE:/path/to/gfx/editor-footerbar-include_in_comp...


        • Viewing Media in the Editor

          Brief survey of media viewing tools.


          • Viewing Images

            The image viewer is displayed in the main editor area whenever an image document is selected or opened. The current magnification of the image will be displayed in the footer bar of the editor, along with the customary controls for external editing and refreshing.


            • Zooming and Rotating Viewed Images

              • Pan around within a large image by clicking and dragging with the mouse; moving the image beneath the pointer.

              • Zoom in and out with the standard View//Zoom// commands and shortcut keys.

              • Further zoom and rotation settings can be accessed by double-clicking anywhere within the image, bringing up the [Image Tools palette](#editor-image_tools).

              MISSING_IMAGE:/path/to/gfx/editor-image_tools.jpg

              Double-click on an image to bring up the "Image Tools" palette.

              The slider at the top of the pa...


          • Viewing PDFs

            The main editor serves as a basic PDF viewer, suitable for referencing works while you write.

            MISSING_IMAGE:/path/to/gfx/editor-footerbar-pdf_controls.jpg

            Editor footer bar displaying PDF controls.

            The PDF view is displayed when a PDF document is selected. You can control the display of the PDF document via the controls provided at the bottom of the editor, in the footer bar, and with the contextual menu.

            • Use the page selector on the left to skip from one page to the next with the arrow bu...


            • PDF Contextual Menu

              When right-clicking on a PDF, additional options will be provided:

              Copy Selection

              : The current selection will be copied to the clipboard as plain-text. Selections are made using a rectangular selector. Click and drag with the left mouse button to create a rectangle so that it encloses all of the text you wish to copy.

              Copy Page Text

              : Alternative to selecting text specifically, you can use this command to copy the entire *current* page you are viewing, as plain-text.

              Encode Copy As

              : Sets th...

            • PDF Contextual Menu

              When right-clicking on a PDF, a number of display options will be provided. These are chiefly documented in the [View Menu], under "PDF Display". Additionally you will find commands for navigating to the next/previous page, along with some useful commands for copying text, looking up the word in Dictionary.app, or searching the Web.


          • Viewing Multimedia Documents

            The QuickTimemultimedia view is used to display movie and sound files. From the control interface (which will appear when the mouse is moved within the viewing area) you can play or pause the movie, change the volume, or step backwards and forwards through it.

            There are further tools to further aid transcription:

            • You can use the <$custom:shortcut> shortcut key to pause and resume a media stream, even while you are typing in the other editor, never having to leave the keyboard.

            • You may s...

          • Viewing Web Pages

            The web view displays archived web pages, which will in most cases be a preserved copy of the page at the time it was imported. Even if the page changes live, or is subsequently removed, your copy will be safely stored. Some pages do not follow Web development standards as well as others, and you may find they do not archive properly or at all, resulting in missing content after a while, or even blank and malfunctioning pages shortly after archival. There is unfortunately nothing we can do about...

          • Viewing Unsupported Document Types

            Scrivener will let you import files into the Binder that it cannot display in the editor. Unsupported file types will use any Quick Look preview provided by Finder, or the default system icon if available.

            MISSING_IMAGE:/path/to/gfx/editor-footerbar-research_files.jpg

            The footer bar when viewing media: Quick Look, Open in External Editor and Reload.

            To view the file in its default viewer:

            • Double-click the icon to load the file in the default external editor for that file type.

            • Click the...

          • Reloading Edited Research

            When viewing most forms of media the editor will feature [a "refresh" icon on the far right of the footer bar](#editor-footerbar-research_files). Clicking this button will reload the file off of the disk; something you will need to do when editing the file externally. This works for files that have been imported fully into the project as well as those that have been linked from the disk using an aliasshortcut.

            Documents are refreshed automatically whenever you navigate to them in the editor (ev...


        • 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---unless you have fond memories of Norton Commander from days of yore. Rather than arbitrarily splitting the interface any number of times and ways, the editor uses a two-way split system designed to be capable of working together, providing one unified way of doing...


          • Horizontal and Vertical Splits

            MISSING_IMAGE:/path/to/gfx/editor-splitting_views.jpg

            The editor can be split vertically (left) and horizontally (right).

            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 with content on the top and bottom. In either case, both sides of the split have the same degree of power in loa...

          • 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//Editor Layout//Swap Editors menu command. This swaps *everything* about the editors, including history queue, view modes, display settings and so forth.

            To clone the contents of both splits, right-click the document icon in the header bar for the side you wish to clone, and select the "Match Split Document" command. This will duplicate your...

          • 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 Navigate//Editor//Other Editor// submenu, and have shortcuts for handy usage:

            • *Remote history access*: Just as you can quickly flip through the history with <$custom:shortcut> and <$custom:shortcut>, you can cause the other editor the jump back and forth in its own history queue with <$custom:shortcut> and <$custom:s...


        • Using Copyholders

          Much like a document clip that you can mount to the side of your desktop monitor, the Copyholder is a way of clipping a something from the binder to an editor. It will stick until you remove it, even if you navigate on to other things---and navigation events will only ever take place on the main editor, not its copyholder. Only the main editor will be changed if you click on something in the binder or use the history buttons.

          MISSING_IMAGE:/path/to/gfx/copyholders-three_panes.jpg

          Adding to spli...


          • Loading an Item in a Copyholder

            There are a few different ways to load an item into a copyholder:

            • Using the Navigate//Open//in Copyholder menu command. This command is also available as a contextual menu item from an editor's outliner or corkboard views.

            1. Select the item you wish to load in any binder, corkboard or outliner view.

            2. Use the menu command to load the copyholder into the active split (the one with a blue underline beneath its header bar).

            • Click to drag an item's icon, and while dragging hold down the O...

          • Creating an Item from a Copyholder

            If a new text or folder item is created while the focus is within a copyholder, the item will be created relative to the binder position of the item the copyholder is viewing, not the main editor. This will always be done in accordance with [the normal rules for placing new items][Figuring Out Where Things Will Go].

          • Changing the Orientation

            To adjust a copyholder's position, use the View//Editor Layout//Copyholder Position// submenu, or simply right-click on the copyholder's header bar, selecting one of:

            • Left

            • Right

            • Top

            • Bottom

            Your choices will be necessarily limited if the editors are split. For example if the editors are split vertically, you would only be able to position a copyholder on the top or bottom of current the editor. This also means that a copyholder might change its orientation automatically to make spac...

          • Changing a Copyholder's Content

            Although a copyholder pane will resist automatically changing its content based on navigation commands made to the editor, you can of course manually change what you are working on. The copyholder header bar is a valid target for dropping item icons to.

            Once you have started viewing different things within the pane, the standard history keyboard shortcuts (<$custom:shortcut> and <$custom:shortcut>) can be used to flip between recently viewed items.

            If the document in the main editor has other ...

          • Detaching a Copyholder to a Window

            To detach a copyholder and convert it to a Quick Reference panel, click the second icon from the right in its header bar. This is a great way to free up space in the main project window without losing access to the content you are working with.

            To do the inverse, embed a Quick Reference window into an editor split as a copyholder, there is no one-click trick for doing so, but you can drag the icon from the Quick Ref's header bar into an editor split with the OptionAlt key held down, and then cl...

          • Closing a Copyholder and Reopening Content

            When you are finished with a copyholder and its content, click the CloseButton button in the right-hand corner of pane. Closing a copyholder in this way will add the item you were viewing to an internal list of recently viewed items within the current editing session.

            If at a later point in time you would like to view the content again, you needn't hunt it down. Open the copyholder pane again using whatever is most convenient (you can simply OptionAlt-drag a header bar's icon onto itself for in...

          • Linking Copyholder Content to a Split

            MISSING_IMAGE:/path/to/gfx/copyholders-autoload_from_split.jpg

            The corkboard in this editor has been linked to the copyholder above it. Cards selected in the corkboard are automatically loaded in the copyholder.

            In addition to providing a semi-static reference while you work in the primary split, the copyholder feature can also be used to automatically display the content you have selected in its primary editor. You can think of this as being a bit like the relationship between the binder and a...


      • 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 binder order using either a grid view or label view, or alternatively as a freeform corkboard where cards can be freely moved about without directly impacting the structure of the book. 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) por...


        • So What are Index Cards, Anyway?

          One of the principles 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.

        • The Corkboard Modes and its Footer Bar

          MISSING_IMAGE:/path/to/gfx/editor-corkboard_footer.jpg

          The right-hand side of the editor footer bar in corkboard mode.

          There are three distinct modes the corkboard can be set to. These modes are considered a form of per-folder view preference---rather than a split view or project preference like most editor settings. In other words, if you select a particular way of working for one folder in your draft, whenever you return to that folder in the future it will be set up in that mode for you (ass...

        • Linear Corkboard

          MISSING_IMAGE:/path/to/gfx/corkboard-three_different_ways.jpg

          The same story told three different ways: linear, freeform and arranged by label.

          The standard---what we could also call a linear or grid---corkboard displays a linked representation of one level and section in your binder hierarchy. As displayed in the back of [](#corkboard-three_different_ways) with a red background, the cards are arranged in rows and columns where the first card in the folder is in the upper left corner and the la...

        • Freeform Corkboard

          Pictured in the middle of [](#corkboard-three_different_ways) with a blue background, freeform corkboards have the same "single layer" method of looking at your binder structure, but they do not have a rigid linked relationship with it its ordering. Instead you can move cards around freely, like you might on a desk or actual corkboard on a wall (remember those?). Freeform mode is thus useful for playing with an ordering idea without actually impacting binder order. You might wish to see how a se...


          • Snap to Grid

            Do you like how you can move cards around freely in freeform mode, but wish you could keep things lined up a little neater? The View//Corkboard Options//Snap to Grid menu toggle might suit you. This setting impacts all freeform corkboards in the project. There are a few things to be aware of:

            • Cards will not be snapped to a grid until you move them yourself.

            • If you select several cards at once, only the card that your mouse was over when you start the drag will be snapped to the grid. The ...

          • Commit Order

            If you reach a point where you would like to make the ordering of cards permanent in the binder, you can choose to commit the freeform order back to outline order. Click the Commit Order button in the footer bar, or use the View//Corkboard Options//Commit Freeform Order menu command.

            You will be given a few options to define your ordering style. Some work left to right, others right to left or top down; this panel will let you apply the ordering no matter which way you work. Once you click the ...


        • Arrange by Label

          MISSING_IMAGE:/path/to/gfx/corkboard-arrange_by_label-simple.jpg

          Labels form "threads" on the corkboard and dragging cards onto the threads assigns them to that label.

          The final corkboard mode is one that can be used in alternation with either freeform or linear corkboards. When making use of the label feature to mark sections of your draft for one purpose or another, label view turns that particular piece of metadata into a "axis", by which we can visualise the distribution of cards along it.

          ...


          • How Cards are Display in Label View

            There are two axes used to display cards:

            Across the tracks

            : When viewing label tracks in horizontal orientation, such as in [](#corkboard-arrange_by_label-simple), the *columns* represent the position of items within the folder. Column 1 is the first card in the folder, "Contents" in this case, which does not have a label assignment. Column 2 is a card assigned to the first label thread and is the second card in the folder.

            : Therefore, you can only have one card per column---having more tha...

          • Moving Cards Across and Along Label Threads

            Just as with the other corkboard views, you can freely drag and drop cards among the other cards. As with linear view, movement can directly impact the order of the cards among their group, so long as movement is done on a tangent to the label tracks themselves.

            Referring again to [our example corkboard](#corkboard-arrange_by_label-simple), if we selected the card in the second column (the one marked "Done") and dragged it to the right of the card in the fourth column---or the second card on it...

          • Creating Cards on a Thread

            When the Double-clicking corkboard background option is set to "Creates new card", in [the Behaviors: Double-Clicking !preference tab][behaviours - double-clicking], you can double-click directly on a track to create a new card automatically assigned to that label in the position you double-click on, pushing the stack of cards to the right (or down when using vertical orientation) to make space for it in the place where you double-clicked.


        • Corkboard Options

          MISSING_IMAGE:/path/to/gfx/cork-display_options.jpg

          Corkboard appearance options are available in the footer bar.

          The corkboard options pop-up contains settings which are specific to each split, making it possible to have different visual appearances for each view. Any changes made will be saved with the project, meaning you can save your preferred defaults into a custom project template for future use. They can also be stored into [Saved Layouts].

          Using Zoom to Adjust Card Size

          The Zoom In (<...


          • Card 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.

            In the freeform and label modes, only the card size method applies as there is no automatic wrapping or f...

          • Ratio

            Determines the size ratio 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

            This option is not relevant to the freeform corkboard mode.

            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.

          • Cards Across

            This option is only relevant to standard corkboards.

            Set this to the number of cards you would like to appear in each row. Use "Auto" to have Scrivener determine this amount based on the size of the cards. When Size to fit editor is disabled, it is possible for corkboards to grow larger than the editor size, which may be desired for some purposes, and will require horizontal scrolling in order to see the entire corkboard contents. You can choose any number between 1 and 10 cards across, or use ...

          • 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. You will need View//Corkboard Options//Show Keyword Colors enabled to see the effects of this.

          • Size to fit editor

            This option is only relevant to standard corkboards, and is not available if 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. 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.

          • That's not all!

            There are a number of other appearance related preferences that you can set, which can dramatically alter the look and feel of the corkboard and its index cards. Most of these options are located in [the Appearance: Corkboard][Appearance - Corkboard] and [Appearance: Index Cards][appearance - index cards] !preference panes.

            If you enable the Allow drop ons in corkboard setting in [the Behaviors: Dragging & Dropping !preference pane][behaviours - drag and drop]---you'll also be a...


        • Images on the Corkboard

          When working in an area of the binder outside of the draft folder, it is possible to import graphics and other media into your binder, and they will be displayed on the corkboard as thumbnails of those graphics.

          Image can also be used instead of a text synopsis for all other items as well. Refer to [Synopsis Images vs Text] for more information, and the section following it for tips on adjusting the size, position and cropping of the thumbnail image within the index card.

        • Stacked Corkboards

          Feature which allows multiple containers to be selected and show their cards in rows, columns, or wrapped.


      • The Outliner

        Primary article.


        • Managing Columns

          To add or remove columns from the display, click [the small chevron button in the far-right column header bar](#outliner-column_management_button), right-click the column header row, or use the View//Outliner Options// submenu. 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. Column settings can also be stored in [Saved Layouts...

        • List of Available Columns

          Title Column: these three options specify how the compound Title column should appear. This column will be named "Title and Synopsis" when the "with Synopsis" column is checked.

          • Title

          ⁃ and Synopsis

          ⁃ with Icons

          ⁃ with Numbers

          Corresponding to the general metadata: 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.

          • Label

          ...

        • Special Columns

          In addition to the standard columns, there are three choices which impact the main Title column. They are indented beneath the Title option in the column menu.

          • 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 (or Touch Bar) provides a shortcut to turning this special column on or off. T...

        • 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 a way of viewing information in the Outliner. It will not impact the underlying order of the items in the Binder, so you can safely use it in conjunction with other methods of gathering items or viewing them, such as search results or multiple selections, without fear of disrupting your book structure. This is ...

        • Using a Fixed Row Height

          The outliner can be altered to use a display mode more akin to a list on iOS, or in a program like Apple's Mail.app, where each entry in the list occupies a fixed height rather than like an ordinary outliner, where each row has its height adjusted to fit the text in the row.

          This alternate display mode provides a more consistent experience at the expense of truncating content---or using empty space to buffer out rows that are otherwise largely empty. For items lacking a synopses, [a little of t...

        • Centring Outliner Content

          The Center Content setting converts the outliner from a spreadsheet looking device to something more like a text editor---if you're looking for a comfortable environment to focus on the text of your outline with, this may be the option for you. When checked, the data of the outliner will be centred within the [full width of the split](#outliner-centred_column). Since it is still the outliner, you can add any additional columns you need to organise your thoughts, but this option will not do much ...


    • Gathering Material


      • 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 laying around that you want to bring into an existing project, 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 possibly tr...


        • Supported File Formats

          Scrivener supports the following text document types. Some document formats will require additional documentation and be documented in the pages following this list:

          • RTF (rich text format): the universal rich text standard. This is often the best format to use for importing from word processors, purely upon the basis of speed and compatibility. It is a format designed by Microsoft specifically so that third-party programs like ours can effectively communicate with Word without having to reve...

        • Web Page

          The File//Import//Web Page... command lets you enter the URL of a web page that you would like to import into Scrivener. The web page will be fully downloaded and archived on import, meaning you will no longer need to be connected to the Internet to view it, and even if the original page is removed or changed, your personal copy will be protected.

          If you wish to save an editable copy of the page, convert it into a text file by using Documents//Convert//Web and PDF Files to Text. If that's how ...

        • Plain Text Formatted Screenplay

          Not to be confused with the Fountain format, this import method is for specially formatted plain-text screenplays from Movie Magic Screenwriter and other programs that export plain-text scripts. Use this utility to have them converted into Scrivener's screenplay scripting format automatically.

        • OPML and Outline Files

          Description of the import dialogue box.

        • Scrivener Project

          It is possible to import an entire Scrivener project off the disk into the binder of the current project, using the File//Import//Scrivener Project... menu command. The full binder structure of the other project will be imported into a folder, named after the project, at the bottom of the binder. All of the text, synopses and notes will be imported, along with snapshots and most other forms of metadata. This tool can be of use if you work with software capable of exporting Scrivener projects, su...

        • Import and Split

          Use the File//Import//Import and Split... menu command when the document you are importing contains structural elements that could be used to automatically break up the imported file into a more detailed binder outline, without you having to go through the process of splitting up the long document yourself.

          The specific mode of operation will be triggered depending upon the file extension. For example if you import a .docx file, options pertaining to the stylesheet import will be presented. If...


          • Word Processing Files with Stylesheets

            Used by files with .docx, doc, .rtf and .odt file extensions.

            Word processing documents that use a stylesheet to establish a heading outline (such as "Heading 1", "Heading 2" and so forth) can be imported into the project as a structured outline. Each heading will generate a new document in the binder, named by the text of that heading, and nested according to its stylesheet outline depth. All text following the heading, up until the next, will be inserted into that item's main text content.

            I...

          • Split by Separator

            Used by all standard text document extensions, except for scriptwriting documents. This includes word processing and Markdown files, which can use this alternate behaviour instead of stylesheet/heading splitting by enabling the Split into sections by finding separators in the text option.

            Type in the separator that was used in the text to define sections. A common example might be a "#" character, used to break scenes in a standard manuscript. Any line in the document that begins with the text ...

          • Markdown Files

            Used by files with .markdown, .md, .mmd and .txt file extensions.

            In similar theory to the use of a stylesheet in a word processing file, Markdown headings describe a document structure that can be recreated in the binder. If a MultiMarkdown or YAML metadata block is found, it will be inserted as the first document at the top level. When exporting, the Compiler can use this file to merge metadata found in the draft folder with any fields supplied in compile settings. Below that, each header fo...

          • Final Draft and Fountain

            Used by files with .fdx and .fountain file extensions.

            When Final Draft files are imported using this tool the file chooser options will provide a selection of elements to choose from. You can select any one element to split by. The imported script file will be split into multiple binder items at the requested break points, in addition to splitting at any scene headings (select "Scene Headings" to only break on those). Scene summaries will be imported into synopses and scene titles will replace...


        • From Scapple Documents

          [Scapple][scapple page], the freeform text editing software from Literature & Latte, gives you an easy to use interface for roughing out a new idea.

          At some point, it may be advantageous to move your idea from Scapple into Scrivener. There are three ways of doing so:

          1. If individual notes are dragged from an open Scapple document into the Scrivener binder, or into a freeform corkboard, they will be converted into individual binder items, one per note.

When dropping into a freeform corkboar...


      • Linking to Research Material

        As mentioned before, the typical methods for bringing research material into your project fully duplicates those records into the project container. No connection to the original file on the disk is retained. In this way it becomes a part of the project. If you move or sync the project to another computer, your research material will follow. There are a few downsides to this approach:

        • When you need to continue refining and editing these external resources on a regular basis, it can be less e...

      • Scrivener Services

        Cover the various services Scrivener provides and how to integrate idea and research collection into the workflow.

      • Scratchpad Panel

        General overview of the Scratch Pad tool in Scrivener.


        • Copying Notes Into Projects

          When projects are open, the Send to Project... button will provide you with a list of all opened projects, each providing two methods of bringing notes into the project:

          1. *Append Text To*: the contents of the selected note will be appended after any existing text of the document you select in the project submenu. 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 ...

        • Using the Scratchpad Beyond Scrivener

          The scratchpad has a two-way relationship with the folder it is linked to on your disk. You may have been asked to set this folder up when you first started using it, but if you didn't make note of where that was, you can find its location in [the General: Scratchpad !preference pane][general - scratchpad].

          If you save files of the same type (RTF, TXT, etc.) into this folder, using other programs, the Scratch Pad will immediately pick them up and display them in the list. Likewise, edits made t...


      • Text Appending Tools

        Text selections in your project can be easily appended to other texts within the same project:

        Append Selection to Document

        : This command is available in the contextual menu when right-clicking on selected text and from the Edit menu. The command will provide a binder item selection submenu. Best used when the target document is not visible, or you want to remain in the source document after the append action. The menu will also have a "New..." command at the top of it which will let you creat...

      • Print as PDF to Scrivener

        If the information you wish to import into Scrivener is locked in a format that cannot be used, a common way of capturing this information is to print the document from the source application, and when the print dialogue appears, use the PDF dropdown menu to select the target application. You should see option to "Save PDF to Scrivener". Upon selecting this choice, the Mac will save the document to a PDF file and then transfer that file to your active project. The imported PDF file will appear i...


    • Organising Your Work


      • Linking Documents Together

        Much like hyperlinks on the Web, internal links make it easy to create and use a network of cross-references within your project, within notes for personal usage, or even the main text editor, where you can choose whether they will be used by the reader to help in their navigation of the work, or even purely for your own benefit, stripped from the output when you finalise the work.


        • Creating Internal Links

          There are several ways to form hyperlinks between items in Scrivener, ranging from methods that rely purely upon the keyboard, to methods that make use of menu systems, to the simple dragging and dropping of items from nearly any view into any editor capable of linking. We'll go over each method in this section, describing their pros and cons, and how they can be modified with preferences.


          • Drag and Drop

            To create a link to a specific item, or list of items if several are selected, drag the item into a text editor In this case that means the main text editors, the Notes sidebar or Bookmarks preview areas in the inspector, copyholders or those panes within Quick Reference panels. dropping them where you would like to create a link. The blinking cursor beneath the mouse pointer will indicate where the link(s) will be inserted. When creating links in this fashion, they will be automatically titled...

          • Select Text and Link

            For cases where the item you wish to link to doesn't exist yet, or isn't readily available for drag and drop, you can also create links using a browsable menu to select the link target:

            1. Either select the text you wish to link from, and then right-click on the selected text, or right-click at the point in the text where you would like to insert a named link.

            2. Use the Link to Document submenu to create a new link to a chosen item. (This submenu is also located in the Edit menu.)

            The conte...


            • New Link

              [Brings up a dialogue](#sheet-new_document_link) which gives you the option between creating a new item (choosing where to place it) or to navigate through a list of items that already exist. Since the main submenu already provides that capability, the secondary tab is of more interest to those who prefer using keyboard shortcuts to create links to existing items. In the provided figure, we might have selected the name "Sònia Casasús" in the scene we were writing, used the <$custom:shortcut> sho...

            • (figure:new link sheet)

              MISSING_IMAGE:/path/to/gfx/sheet-new_document_link.jpg

              Creating a new character sheet in a folder, using the "New Link" command.

            • Suggestions

              Back to the "Link to Document" submenu, below the New Link entry is a "Suggestions" area that will appear if the selected text contains text found in any existing binder item titles. 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 titles suitably similar to the selected text are found. Going back to our prior example, if we refer to "Sònia" in the text and wish to link to her character sheet again, [then select...

            • (figure:link suggestions)

              MISSING_IMAGE:/path/to/gfx/text-new_link-suggestions.jpg

              Main contextual menu removed for brevity.

            • Bookmarks

              If any items have been added to the Project Bookmarks list they will be given priority access at the top of this submenu. Consider [bookmarking frequently linked to items to make it easier to access them][Project and Document Bookmarks].

            • Binder List

              The remainder of the list will be organised into a binder item selection submenu. Containers will be converted into submenus listing their child items from the binder, but can be themselves selected as link targets.


          • Select Items and Copy

            To create links to multiple items as a list, there are two approaches you can take beyond the already discussed method of dragging and dropping multiply selected items:

            1. For a list of items indented by their outline levels use the Edit//Copy Special//Copy Documents as Structured Link List menu command and then paste the indented text into an editor.

            2. If instead you need a flat list of links, then use the standard Edit//Copy (Cmd-Ctrl-C) command.

          • Wiki Link Style

            If you've ever used a wiki to organise your ideas, then you know the use of links can even be a good brainstorming tool, as you can build a to-do list of things to write "remotely" with links while writing. Scrivener provides a similar mechanism via an optional method for typing in new links, even to files that don't exist yet, while you write. To enable this method, visit the Corrections tab of Scrivener's preferences, and turn on Automatically detect [[document links]] in the Data-Detection se...

          • Linking Without Linking

            Have you ever wished you could have an automatically generated network of topical cross-reference between research, written material and notes without having to make your own links or drag your own bookmarks around? Scrivener gives you precisely that capability with its title scanning capability. Here is a simple example:

            1. Create two documents in your binder, calling one whatever you want, and the second document "Link to me".

            2. In the first document, type in the word "Link", or even "Link...

          • Links are Circular

            By default, whenever you link to another document in your binder, a [Document Bookmark][Project and Document Bookmarks] will be created for the item you linked *from*, in the bookmark list of item you linked *to*. If I have a document called "Links are Circular" (and so are my references, it seems) and create a document link to another file called "Textual Marks", then if I were to click on the Textual Marks item in the binder and view its bookmark list, I would find an entry for "Links are Circ...


        • Using and Managing Links

          To use links, simply click on them with the mouse pointer, as you would in a web browser. By default, internal links will open in the other split, using the ordinary view mode for doing so, just as if the item had been clicked in the binder (so linking to a folder and clicking on the link may load a corkboard). How the link loads in the project window can be changed in the Behaviors: Document Links preferenceoption pane, with the Open clicked document links in setting.

          If you would like to see ...


          • Removing Document Links

            Removing pre-existing links

          • Changing a Link Target

            Drag & drop and menu methods to change the link target.

          • Updating Link Text Automatically

            When using internal links as a form of cross-referencing, a mechanism for updating the link text with revised section titles will prove useful. For example, if you change a section name from "Absinthe" to "Chartreuse", with another link pointing to it using the text, "exotic liquors", you might want to fix the link that refers to it by literal name, but not the second link which remains accurate in description.

            This action requires an action from you (the software cannot determine whether "exot...

          • Configuring How Links Look and Feel

            Most of the configuration options for links are located within the [Behaviors: Document Links preferenceoption tab][behaviours - document links]. There you can configure how links will act when they are clicked, as well as what will happen when new links are created.

            The appearance of links can can be customised in the [Appearance: Textual Marks preferenceoption tab][appearance - textual marks]:

            • Change the colour of "Links" in the color tab.

            • Select whether links should be underscored in ...


        • General Referencing with Bookmarks

          It is worth mentioning that hyperlinks in the text or notes are not the only way to tie two different items together. If you would prefer a general link between two items, stored as a list in the inspector sidebar, then [Document Bookmarks][Project and Document Bookmarks] are the way to do so.

        • Compiling with Document Links

          Depending upon the file format used (RTF and DOC, with DOC set to "RTF-Based", and with Microsoft Office converters enabled, DOCX and PDF are also supported), when compiling your work into a single file, links can be a feature that reside entirely within the realm of Scrivener, being stripped out of the final product, or something that can be used for cross-referencing that your readers can make use of. Some examples range from tables of contents, cross-references, hyperlinks to the web, and mor...


          • Creating Cross-References for your Readers

            Sometimes you may need a link to adjust the hyperlink text---what your readers will see---to match the given title for the section it refers to. For example, you might need the Table of Contents list to print the chapter numbers, which won't exist until you compile the draft. This method requires a few conditions to function properly:

            • Link text which is solely the title of the document they link to.

            • A title prefix or suffix applied to the document level that contains the links.

            • Finally...

          • Combining Links with Placeholders

            Scrivener comes packed with many useful placeholder tags that can be typed into your work and substituted for dynamic information when you compile. A simple example of this is the `\<$modifiedDate>` placeholder, which prints the modification date of the binder item you type it into. You can read more about this capability with the Help//List of All Placeholders... menu command.

            An interesting capability you have at your disposal is combining these placeholders with document links. When selecti...


        • Including Text From Other Documents

          In cases where multiple areas of your intended document will include identical information, it can at times be advantageous to keep only one single source for those multiple instances, whether in the binder or as a file on the disk (meaning multiple *projects* can all use the same source). The idea being, if you need to fix a typo or make a factual correction to all of the different places in the book that text is used, you can do so in one single location rather than tracking down every instanc...


          • Creating Textual Links

            There are several approaches to using the `<$include>` placeholder, each with their own distinct advantages:

            * The simplest is to use document links:

            1. Type the `<$include>` placeholder into the document where you wish to have the mirrored or cloned text printed. The placeholder can be the only content in that document or inserted somewhere inside of a longer text---even into a very specific context such as an inline footnote.

            2. Select the placeholder in its entirety and use the document li...

          • How Included Text Formatting Works

            Since included text can represent formatted information, styles and formatting will be determined based on usage:

            • The included text will always use its character styling---even if that means "no style".

            • Included text brings along is paragraph styling if the placeholder is on a line of its own. A block quote will remain a block quote when inserted.

            • The paragraph style will be omitted if the included text is inline within another paragraph. It will however still bring in its own characte...


        • External Links

          It is not only possible to link to and from individual items within a project, but between projects as well. In fact, the special type of URL used to create these links can be used in any program or context where links can be used, not just Scrivener.

          Any software that has a concept of linking should allow you to create useful links back to individual components of your project. This is done via the use of a special type of URL, much like a link to the Web, only designed to work locally on your...


          • Linking Items Between Projects

            To create a link to an item in another project, you have two different approaches available, both of which should be familiar from your reading of the above techniques. There really is no difference between creating an internal link between documents in one project, and creating a link between projects, in terms of what steps you need to take:

            • As bookmark:

            1. Open the inspector in the project you want the link to be, and click on the bookmark icon (second from the left) to load the [bookmar...

          • Linking From Other Programs

            • To copy an external link, select the item you wish to link to and use the Edit//Copy Special//Copy Document as External Link. This plain-text URL can be pasted into link fields, text editors and so forth.

            • Alternatively, right-click on the item directly in the binder, and select Copy Document Link from the contextual menu.

          • Advanced External URL Options

            Those familiar with editing URLs may notice that the scheme uses the familiar key and value attribute system. The basic URL produced by the following commands specifies an 'id' with the UUID for the selected item. Most people will be perfectly happy with the above tools for creating links automatically, but if you would like to exert a little more control over how the links works, such as loading multiple items at once, or using splits, then the following section is for you.

            The link is compris...

          • External URL Options

            Key

            Values

            Description

            id

            Valid UUID

            The UUID of a specific binder item within the project. This comes supplied with the URL when using the Edit//Copy Special//Copy Document as External Link menu command, and in most cases that will be the practical way to get that information.

            doc

            Binder title

            Instead of referring to the internal ID you can refer to the binder title of an item. The first item in the binder matching that name will be selected. Note this is a URL, all rules pertaining to encodin...


      • Using Collections

        Collections are a way to further organise the content in your binder using lists, which can pull from anywhere in the project and be displayed in any order you please. These lists can even be automatically gathered for you using search criteria you save into them. If you'd like to have a concise list of every document flagged with the status of "Needs Rewrite", or if you want to focus on the flow of text within a chapter and play with the structure without changing the original, never mind endle...


        • The Collection Tab List

          To reveal the collection interface, click the View icon in the toolbar and use the Show Collections command, or use the View//Show Collections menu command.

          MISSING_IMAGE:/path/to/gfx/org_collections-basic_interface.jpg

          The collection tab list with (a) the binder selected and (b) a collection.

          Each entry in the tab list represents a single collection. In the [figure](#org_collections-basic_interface), the "Binder" tab is selected on the side marked (a). While not a true collection, this is one...


          • The Collection Header Bar

            MISSING_IMAGE:/path/to/gfx/binder-search_results_header.jpg

            Search results header: (a) close and return to binder, (b) load results in editor and (c) sort results.

            The header bar which appears between the tab list interface and the main content area (or simply at the very top when the list is closed) contains a [number of useful functions](#binder-search_results_header). In the figure, we're viewing the built-in "Search Results" list, but the same buttons will be found in all collections.

            The ...

          • Disappearing Collection Tabs

            On account of how scrollbars are hidden by default on a Mac, unless scrolling, it may not be obvious that the Collection tab interface can be scrolled, causing tabs to mysteriously disappear. If you do not like this behaviour, you can change your Mac's system settings in the General preference pane to always show scrollbars.

          • Viewing the Contents of a Collection in the Editor

            The contents of a collection are not stuck within the sidebar. If you would like to make use of the rich capabilities afforded by the main editor's group view modes, there are three ways to do so:

            1. While viewing a collection it will be simplest to click the HookArrow button in the collection header bar. If you hold down the OptionAlt key when clicking on it, the list will be loaded in the other split, opening one if necessary.

            2. You can also load a collection into the editor at any time vi...


        • Standard Collections

          Standard collections are just the ticket for storing ad hoc lists of items. You have full control over what is listed within them as well as the order in which they appear. There are a few ways to create a new collection:

          1. Click the AddButton button in the tab list header, marked (a) in [](#org_collections-standard_collections). Any items that you have selected in the active view (including the binder, search results, or even other collections), will be automatically added to it. It is perfe...


          • Adding To and Managing a Collection List

            Here are the ways you can add items to an existing collection:

            • With the tab list revealed, drag and drop a selection of icons from anywhere icons can be dragged from. They will be added to the bottom of the collection list.

If you hold over the target tab for a moment, Scrivener will switch to the tab allowing you to drop the items precisely where you want to place them in the list.


            • In variation to the above, if you hold down the OptionAlt key while dragging a container to a collection ...

          • New items created in a collection

            Within a standard collection, 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 a folder, created for you if necessary, with a name corresponding to the collection title they were created from. These folders will be created at the top level of the binder, at the bottom of the list, above the Trash. An example might be a new text file called "Joseph" in the "Charact...

          • Removing Items from the List

            Remove items by selecting them in the collection sidebar, and then clicking the DelButton button in the lower header bar marked (b), or by simply pressing !Delete on your keyboard.

            Trashing Items From a Collection

            To not only remove an item from a collection but send it to the trash as well, then use the <$custom:shortcut> shortcut.

          • Deleting the Collection

            To delete the entire collection:

            1. Select the collection from the tab list that you wish to remove.

            2. Click the DelButton button in the upper title bar, marked (a).

            3. You will need to confirm this action as there is no way to undo it.

          • Backing Up Collections

            You can "back up" a standard collection by storing the list into another document's bookmark list. This can be useful if you have a lot of collections bulking up the list, and have a few that are seldom used. Here is an example of how this can be done:

            1. Create a new document in the binder to store your collection list.

            2. Open the [inspector sidebar and click on the bookmark tab][bookmarks tab], or press <$custom:shortcut> twice. If the list is not showing "Document Bookmarks" click the hea...


        • Search Result Collection

          Just cover the dedicated search result collection

        • Saved Search Result Collections

          When search results are saved to a dynamic search collection


          • Sorting the Results in the Sidebar

            The contents of search lists can be sorted by clicking on the button marked (c) in [](#binder-search_results_header). All search lists share the same sort settings. The following criteria are available:

            • *Binder Order*: this is the default setting. No sorting will be done on the list, with each item listed in the order they appear within the binder from top to bottom.

            • *Sort by Title*: the list will be sorted by the given names of items. If titles are changed while working in the list, it w...

          • Updating the Saved Search Query

            You can refine or modify the search settings stored into a saved search collection:

            1. You will need to start with an active search. Most likely you will wish to do so by clicking on the tab you want to modify.

            2. Open the project search field if it is not visible: click the search button in the toolbar, or use the <$custom:shortcut> shortcut.

            3. Modify the search settings with the magnifying glass menu. Your changes will be automatically saved into the collection.

            When resetting all search...

          • Converting a Saved Search to a Standard Collection

            Given their dynamic nature, the contents of a saved search list cannot be added to, removed from or reorganised (outside of sorting). If you wish to "freeze" a search list so that you can play with it freely, or simply to store it for later reference, there are two ways you can do so:

            1. Convert the saved search to a standard type: This will destroy the saved search, so only use this method if you no longer need the search criteria. To convert a saved search result to a standard collection, se...

          • Deleting Saved Search Collections

            Saved search collections can be removed in the same fashion as standard collections, by selecting the tab and clicking the DelButton button, marked (a) in [](#org_collections-standard_collections). Since clicking on a saved search collection automatically loads its search parameters into the project search tool, you can effectively undo this by switching the Search Results tab and recreating the collection from the magnifying glass menu.


        • Back to the Binder

          Often you might wish to know the overall disposition of a collection list in the binder, or where a select few items in the list are located in the overall structure of the project. The Navigate//Reveal in Binder menu command (<$custom:shortcut>) works from collections and search results. Since this command can be used on many items at once, it makes for a handy way to see what *isn't* in large collections, too.

          It is possible to select some or all of the items in a collection and instruct Scri...


      • Project and Document Bookmarks

        No doubt you've encountered the concept of bookmarking web sites in your browser. We could say that at its most basic level, bookmarking binder items is similar to this concept in that you can create and organise lists of important or frequently used items, making it easier to use them or navigate to them in the future. They can also be used to refer to files on your disk or resources on the 'net.

        If you're searching this manual for "Favorites", "Project Notes", "Project References" or "Documen...


        • The Bookmark List and Floating Panel

          The list that pops up when you click the bookmark icon is simple, but provides for more flexibility than you might imagine at first glance:

          • Click on a bookmark to load a binder item in the active editor.

          • Double-click to load the bookmark into a Quick Reference panel. You will also need to double-click if the bookmark is to an external resource such as a web page or file on your disk.

          • Hold down the OptionAlt key when clicking to load the bookmark in the inactive editor split, opening on...

        • The Inspector's Bookmarks Tab

          There is already a whole section dedicated to documenting this tab, but given their crucial role in how bookmarks can be used in your project, it would be important to outline what it can do for you here, before sending you over to that section for further information.

          MISSING_IMAGE:/path/to/gfx/bookmarks-using_the_inspector.jpg

          View bookmarks in the inspector by (1) revealing the inspector, (2) switching to the bookmarks tab, (3) selection between project or document bookmarks and (4) using th...

        • Working with Bookmarks in a Quick Reference Panel

          MISSING_IMAGE:/path/to/gfx/bookmarks-panel_and_qr_sidebar.jpg

          The bookmark list can be expanded into a Quick Reference panel for quick access to your notes and research.

          NOTE//WINDOWS// no doubt there will not be an Option command with windows, so some of this may need some editing. There are three ways to browse bookmarks in a separate window, two of which are demonstrated in [](#bookmarks-panel_and_qr_sidebar):

          1. Click the button in the upper right-hand corner of a floating bookmark pane,...


          • Default New Bookmarks Folder

            When creating a new bookmark note from the sidebar you will be asked where you would like to save the new note. This part of the process can be bypassed by clicking the Do not ask again checkbox below the group selection tool. From that point on, new notes created in the sidebar will automatically be filed into this folder for you.

            If you prefer to have a "scratch pad" area of your project rather than using the feature to elevate globally notable files no matter where they are, you might prefer...


        • Managing Bookmarks

          With the main areas that bookmarks are worked with now covered, the following serves as a reference for performing basic management tasks throughout these elements of the project.


          • Adding and Removing Bookmarks

            There are several ways to add a bookmark to something:

            • Click on the bookmark button in the [main application toolbar](#bookmarks-toolbar_list), or use the <$custom:shortcut> shortcut to bring up the list in a floating panel. Drag and drop the resource you wish to bookmark into the list.

            • When using the floating bookmark panel, you can also click on the GearMenu button to add new bookmarks. This button is functionally identical to the button featured in [the inspector][Adding Bookmarks]. It...

          • Removing Bookmarks

            • In the bookmark list, the floating panel version of it, Quick Reference sidebar and inspector bookmark tab, you can always delete a selected bookmark with the same Cmd-DeleteShift-Delete shortcut you would use to trash an item from the binder sidebar.

            • Another universal method is to right-click on the bookmark you wish to remove and select the "Delete Selected Bookmark" contextual menu command.

            • As with the menu command to add a bookmark to one or many files, outlined above, the Documents...

          • Editing Bookmark Titles

            When adding a bookmark to an external resource, a title will be generated for you depending on the type of link it is. If it is a bare URL you might get a generic title such as "Link", but files will use the file name for the title, and hyperlinks will try to use website titles or the link title automatically.

            You may want to edit the title once you've added a link by right-clicking on the bookmark and selecting the "Edit Bookmark" option. If you own a keyboard with a Touch Bar, you will find a...

          • Organising Bookmarks

            Bookmarks are organised by default in the order they were created. You can adjust their organisation to suit your uses of them. The order of bookmarks within the lists will impacts their order in every context where they are displayed. In some cases it can be a productivity boost to keep frequently used items near the top of the list, where they will be more easily accessed from tools like Navigate//Go To// submenu, which only displays the top five bookmarks.

            • Click and drag to reorder bookma...

          • Renaming Internal Bookmarks is Renaming Items

            Be aware that if you rename a bookmark that is a link to another item in the project binder, you will be renaming the *original item* as well. This is in fact less like a "bookmark" in the traditional sense of the word, and more like the kind of entry you will find in a collection: an additional placement of original the binder item.

          • Copying Links and URLs

            Sometimes you just want a link from the bookmark, rather than doing anything with it immediately. Perhaps you want to store it in another program or load a URL into a browser that isn't your default.

            1. To copy a hyperlink, suitable for pasting into documents as a clickable link with a friendly title, you can use the Cmd-CCtrl-C shortcut on any selected bookmark:

            ⁃ File and URL links will use the bookmark name for the link title.

            ⁃ Document bookmarks will use the document name. When pasted b...

          • Copying Bookmarks Between Items

            Bookmarks of all types can be freely copied and pasted between lists, both project and document alike. They can also be dragged from one list to another---a possibility between Document Bookmarks when [Quick Reference panels][Quick Reference] are in play.

            [Collection lists][Using Collections] and internal bookmarks are very similar to one another. You can almost think of bookmarks as being private collection list each item in the binder has available for use. You can freely drag and drop items ...

          • Sharing Bookmarks Between Projects

            If you drag items from the binder of one project, into the bookmark tab of another (either project or document bookmarks are a valid target), this will store a special external direct link to the individual items you dropped. Double-clicking this bookmark will load the project if necessary and open the item you linked to within it. Read more about cross-project item links in [External Links].

            External bookmarks can be copied and pasted from one project's bookmark tab to another, and in most cas...


        • Bookmarks in Binder Item Menus

          Adding items as project bookmarks will elevate their presence in some menus that allow you to select binder items from a submenu hierarchy:

          • Edit//Link to Document: for creating hyperlinks to documents. This menu is also available when right-clicking on text in the editor.

          • Navigate//Go To: navigation the active editor to any spot in the binder. This menu also appears in the editor header bar icon menu and the !composition mode control strip along the bottom of the screen.

          • Navigate//Quic...


      • Organising with Metadata

        Documents of any type in Scrivener can have various metadata associated with them. Metadata is a way of talking about something without changing it directly. 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 metadata, as is the paper-clip. Just as with a piece of colourful tape affixed to the edge of an envelope, metadata can help us more easily search for tagged items, either visually or through the use of digital m...


        • Metadata Types

          Introduction to the concept of metadata and the basic types available to every Binder item.


          • The Title of an Item

            The most important piece of metadata any item has is so fundamental you might not even instinctually think of it as being metadata: its title. The title will be used to identify the document in the many views, menus, and export methods.

            Refer to [Titles and Adaptive Naming] for further information on using titles.

          • The Synopsis of an Item

            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 three prominent areas:

            1. Corkboard: used to display the content area of the card.

            2. Outliner: will be placed beneath the title.

            3. Inspector: if you need to reference an item's synopsis without finding it in a list somewhere, the inspector sidebar's Notes tab, or the special Synopsis split in a Qu...

          • Setting Up Label & Status

            The next two forms of metadata, Label and Status, are flexible in how you can refer to them within a project. You can give these fields custom names and the interface and menu commands will adjust accordingly. If you wanted, you could have "POV" and "Location" instead of label and status, or "Focus" and "Type", or "Monkeys" and "Bananas" for that matter.

            The documentation will of course continue to refer to them as labels and status for the sake of simplicity. They are also, after the title, th...

          • Label Colours

            Labels are one of the most flexible metadata 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. For example, richer more vibrant colours can be used among pastel choices to indicated tension, or priority.

            Label colour can be expressed in the following ways:

            • On the corkboard, index cards will bear a strip along the left edge of the card indicating label assignment. Use View//Corkboard Options//Show Label Color Along...

          • Status Stamps

            As with labels, 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. On the corkboard, they can be displayed as an optional "stamp" across the face of the card with the Vi...

          • Keywords

            Each document can have a list of keywords associated with it (what you might be more familiar with as "tags" in some other programs). These are useful for making 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.

            Their biggest advantage is in non-exclu...

          • Custom Metadata

            For all of the things we couldn't think of. With four different types of fields and extensive support for searching and filtering, custom metadata picks up where the stock tools let off. Four different field types can be used to create however many fields you need in a dedicated form built into the inspector pane, and as sortable outliner columns or tools for filtering corkboard and outliner views and project searches:

            • Text: a simple text field. This tool is great if you need to mark section...


            • (see also)

              <$include>


          • Exporting Metadata

            All metadata 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. Metadata can be exported in the following fashions:

            • Compiling: when compiling the Draft, enabling metadata export is an optional feature of the Formatting pane. The various types of metadata will be exported into the Draft in a variety of ways best suited to the type of data involved. Additi...


        • Using Keywords

          Add note about using "Reverse Keywords" to in effect create searches for negatives. If everything gets a keyword, then searching for that keyword and removing them once the condition is satisfied will keep a list maintained of everything *not* yet addressed.


          • Project Keywords Panel

            The Project Keywords panel holds all of the keywords in use by the project. As you assign keywords to items, using the [Inspector's Metadata tab][Keywords Pane], they will be added automatically to the central project list, making it a complete reference of all keywords in use within the project (you can also create keywords for future use here, without assigning them to anything yet). The panel is also how you will handle bulk management of keyword assignments for many items at once.

            You can a...


            • Organising Keywords

              The Project Keywords panel is a freeform work space where you can organise your keywords into groups and arrange them sequentially, by topic or however you see fit.

              • To change the order of keywords within the list, use drag and drop, or the keyboard shortcuts from the Edit//Move// submenu.

              • You can also drag any keyword onto any other keyword to nest keywords.

In the example figure, we have nested "Software", "Writing" and "Blogs" into a keyword called "Topics". This relationship is merely...

            • Assigning Keywords with the Panel

              Use one of the following methods to assign keywords from the panel to documents in the main project window:

              • Select and drag the desired keywords from the panel and drop them into the keywords pane in the inspector, a Quick Reference keyword split, 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 then all selected keywords will be applied to all selected documents.

              • H...

            • Removing Keywords with the Panel

              If you need to remove a specific keyword from an item, it will be easiest to do so from its keyword list in the inspector's metadata tab. However in cases where you need to remove a keyword from several documents at once, the project keywords panel is the best place to do so:

              1. Select the documents you wish to remove the keyword from, in the binder, outliner or corkboard.

              2. Open the Project Keywords panel and select the keywords you wish to remove from the selected documents.

              3. Right-clic...


          • Changing Keywords Globally

            Keywords can be centrally managed from the project keywords panel. Intuitively, if you change the name of a keyword it will be altered throughout the entire project rather than becoming a new keyword that nothing is assigned to. Likewise changing the colour is a global setting. To do either, first use the Project//Show Project Keywords menu command to load the keywords panel.

            To change the name of a keyword:

            1. Double-click on the name of it in the panel, or press the Esc key, and edit the la...

          • Deleting a Keyword from the Project

            To fully remove a keyword from a project, not only from the master keyword list but from every item that was using it as well, you will need to use the Project Keywords pane:

            1. Open Project//Show Project Keywords (<$custom:shortcut>).

            2. Select the keyword(s) you wish to remove. You can select multiple keywords with the Shift and CmdCtrl keys.

            3. Click the DelButton button in the footer bar, or press the !Delete key on your keyboard.

For keywords that were not assigned to any items in the ...

          • Searching by Keywords

            Although it is always possible to create your own searches for keywords by hand, the project keywords window provides a convenience for keyword usage in your project. Simply click on the keywords you need to hunt down, and click the magnifying glass button in the bottom right-hand side of the panel.

            There are optional search modes that can be accessed by right-clicking on the button. Upon selection of one of these modes, the desired search will be immediately used, or updated if the search list...

          • Importing and Exporting Keywords

            If you would like to copy keywords from one project into another, follow these steps:

            1. Open both projects, and in each, use the Project//Show Project Keywords menu command to open their respective keyword lists.

            2. Select the keywords you wish to copy from one list and drag and drop them into the other project's keyword list. Colour assignments will be preserved.

This will always duplicate the keywords into the new project, so existing keywords with the same name will not be overwritten.

            ...

          • (see also)

            • [Project Search]: although the panel has a useful button for invoking a project search, it might be a good idea to know how that feature works as well, so you can fine-tune results if needed.

            • [Keywords Pane]: where you will most often interact with keywords is in the inspector pane, assigning them to documents directly.


        • Exporting and Printing Metadata

          You need never fear of having your valuable tagging and other markings lost within the Scrivener project. All forms of metadata can be exported along with the content itself, and most forms of metadata can be printed as well:

          • With File//Export//Files... metadata can be [exported as sidecar .txt files along with the content][Metadata and Options].

          • Using File//Export//Outliner Contents as CSV... every single type of metadata in the software can be exported to spreadsheet format.

          • When pri...


    • Searching and Replacing

      Being a tool design to bring research, writing materials and the work itself all together into one interface, methods for searching through the haystack and finding your needle of the moment are paramount, and Scrivener recognises that with filtering and searching tools at every level of the program, from the binder on down to finding specific images within your text.

      The first two methods of searching will cover most basic needs for searching within a project:

      • [Project Search] is a binder ...


      • Project Search

        With the Project Search tool, you can quickly scour the project and get a list of every matching document in the sidebar. This can be as simple as typing in the word "hello" and finding every item that has that word in it (and by that we mean nearly everything about a document that consists of text, from assigned keywords, labels, the title to its synopsis and so on). There are a bounty of options for putting together some fairly surgical searches too, should you need them.


        • The Basics

          Unlike the standard text find tool, which steps through a document one match at a time in one direction or another, project search returns everything at once in a list in the left sidebar, temporarily replacing the binder (don't worry, you can get back!). You can think of it as a way of "filtering" the binder so that it only shows those items that match the search. Searching in this fashion is more like searching the web for hits, or your email inbox. As with those tools, once you get into a spe...


          • Starting a New Search

            There are two ways to start a new project search:

            1. Click the ["Search" button in the toolbar to reveal the search field](#binder-project_search_button).

            2. Use the command, Edit//Find//Search in Project... (<$custom:shortcut>), to open the field and place the cursor there in one move.

            MISSING_IMAGE:/path/to/gfx/binder-project_search_button.jpg

            The default project search field, with the "Search" toolbar button above.

            Now all you have to do is start typing, and as you type matching document...

          • Finding matches in the editor

            In addition to highlighting all matched text for easy visual recognition, for your convenience, the text you searched for will be automatically loaded into the text find tool for you. This means you can immediately use the keyboard shortcut to find the next search result within the document (Cmd-GF3). Since searching the project can examine many different types of elements, the search result itself may not be in the primary editor---it might be a label or a keyword ...

          • Browsing and Sorting Results

            While typing, you can flip through search results with the UpArrow and DownArrow keys on your keyboard, loading the result into the currently active editor. Otherwise, you can use a search result list just like you would use the binder normally. Refer to the section on [Selecting Items][] for tips on viewing multiple items.

            MISSING_IMAGE:/path/to/gfx/editor-next_previous_doc.jpg

            Use the "Previous" and "Next" document buttons to flip between search results.

            While working in the editor, the you ...

          • Locating Results in the Binder

            In addition to locating and reviewing content itself, you might want to use the Project Search feature purely as a way of locating and selecting matching items in the binder itself. Since searching uses the binder sidebar itself to show the result list, you will need to use the Navigate//Reveal in Binder (<$custom:shortcut>) command to close search results and return to the binder with each selected result highlighted in the binder. This command will expand any hierarchy necessary to fully revea...

          • Refreshing Results

            As you type, the contents of the search result list will refresh dynamically, narrowing down the result efficiently. However once you've stopped typing, actions taken elsewhere in the project window that might impact search results will not update the list. This allows you to work off the list without it constantly changing. If you do want to refresh the results, simply click into the search field and hit the !Return key.

            For cases where you've loaded search results into an editor (as above), y...

          • Taking Results to the Editor

            In some cases you may want a little more space to work with your search results, or access to some of the powerful capabilities afforded by the outliner and corkboard view modes. At any time, click the HookArrow button marked (b) in [](#binder-search_results_header) to load the contents of the sidebar list into the active editor.

            This is also a great way to search *again*, if the initial search result was too broad and you want to search by a second factor. With the focus in the editor, press <...


        • Search Settings

          All project search settings are accessed via a menu interface. Bring it up by clicking on the magnifying glass to the left of the search field.


          • Search In

            The initial section of the options menu is for selecting the type of element that project search should look within. NOTE//WINDOWS// Perhaps they will create a way for doing this, but it probably won't be the Alt key. Select multiple elements by holding down the Option key and clicking on a type. Option clicking can also be used to turn off an extra field without disturbing the total selection. To return to using a single element, either select "All", or select any field without using the Optio...

          • Operator

            Select the method by which your text will be used by the search engine:

            • Any Word: the default search method. Queried documents must contain at least one of the words typed into the search field. Analogous to logical OR.

            • All Words: every word entered into the search field must be present. Documents which only match some of the words will not be returned. Words can be entered in any order. Analogous to logical AND. You can also enter double-quoted phrases mixed in with single words, working...

          • Options

            Provides a few extra options, as well as setting scope limiters. Scopes instruct the search engine to only scan select parts of your binder.

            • Search Draft Only: will only look in the "Draft" folder of the binder. Note that if the name of draft folder has been changed in the project, the title of this option will reflect that name change.

            • Search Binder Selection Only: preselect items in the binder and then perform the search against those items only. This selection is explicit, not implicit...

          • Resetting Search Options

            To reset all search settings to a few simple default settings, select the "Reset Search Options" command in the magnifying glass menu. This will change the settings to the following settings:

            • Search in: All

            • Operator: Any Word

            • Options: all disabled, save for the two toggles to search for both "included" and "excluded" documents.


        • Special Search Terms

          Beyond simply typing in the text you want to find, there are some useful tricks you can use to narrow down your search further, or even mix certain types of search together.


          • Mixing exact phrases with all words

            If you want to find every document containing a word as well as a particular phrase, put the phrase in double-quotes while leaving the search operator set to "All Words". The term `Bob "black car"` would locate all documents referring to a "black car" that also mention Bob. The quotes cause the phrase to be treated as a word.

          • Finding things that don't have a word

            Sometimes the most efficient way to make a long list of search results shorter is to omit the most common word that you aren't looking for. Place a hyphen directly in front of such a word to remove it from the list of possibilities. A simple example would be to search the "Text" for `Lydia -Dovahkiin`, to find all documents mentioning Lydia that do *not* also refer to a certain individual named Dovahkiin.

            This technique can be used with the Any Word and All Word operators. It can also be combin...

          • Finding everything

            To search for everything, type in a single asterisk (\*) into the search bar. It can sometimes useful to build a flat list of everything in the entire project, usually in conjunction with loading the search result into an editor, where you can do such things as sorting by label to view your binder clustered by label assignment, or by Modified Date to review recently changed files.

          • Finding everything by type

            The above method of using an asterisk can be combined with all available search options. For example: you can find all items in the draft folder alone, or all items that have had a label (any label at all) assigned to them, or with the "Invert Results" option, you can find all item's that *don't* have a label assigned yet.

          • Searching by modification and creation date

            A common desire is to locate items that have been modified recently, or to find files that were created within a certain window of time. Scrivener supports these operations and many more besides, using its special date search syntax.

            When suffixing a search term with either of the keywords `mdate:` or `cdate:`, project search will combine the current "Search In" settings to also search for Modified Date or Created Date respectively. When used alone, they will simply return a list of all documen...

          • Combining Search Terms

            Most of the techniques we've discussed can be combined together to create more specific and complicated search criteria. Here are some examples:

            • If you are searching in the "Notes" field for the word "ToDo", but only want to find those documents that haven't been modified recently, you would use the term, `ToDo mdate:<6m`, which would find every document with "ToDo" in the inspector notes that hasn't been modified in the past six months.

            • You can search for all documents with the "Needs Fo...

          • Date Search Syntax

            Search Term

            Description

            **By a Given Date**

            YYYY-MM-DD or YYYY/MM/DD

            Find everything from a specific day, such as 2017-04-08, which will find everything on the 8th of April, 2017.

            YYYY

            All edits found within the specified calendar year.

            **By a Relative Date**

            #d

            Find everything written since the number of days specified. Eg. "7d" would find everything edited within the last week.

            #m

            As above, but using months. Eg. "6m" will find everything edited in the past half year, or six months.

            #y

            As abov...


        • Using a Saved Search Collection for Further Searching

          With all of these options available, a good method of storing your search settings for future use is with [a saved search collection][Saved Search Result Collections]. Whenever you click on a saved search tab (or use any method at all to load a saved search into the binder sidebar), all of the settings that were used to establish that list will be loaded into the project search settings for you, meaning the collection tab could be less about the list of documents it generates when you click on i...

        • Save Search As Collection...

          With so many different options you might be looking for a way to save "smart folders" or searches. The command at the bottom of the options menu will save your current search settings into a [search result collection][Saved Search Result Collections]. As with search results, these collection tabs will build a list of results whenever you load them.


      • Document Find and Replace

        Using basic the basic Find panel for the text editor.


        • Find and Replace Options


          • Replace All Scope

            These two options determine the scope of how much text will be impacted when clicking the Replace All button:

            * Entire Document: all of the text in the current view (which may be multiple documents when using Scrivenings mode) will be searched and replaced.

            * Selected Text: only the selected text will be searched and replaced. Since this command will remove the selection, it means you will need to apply a new selection if you intend to continue searching and replacing this way.

          • Find Options

            These options impact how the text within the "Find" field is treated. They are used for both regular searching and replacing:

            * The mode dropdown at the top contains the following options:

            * Contains: the tool will find any sequence of text that matches what has been typed into the "Find" field, even if it is found within a word.

            * Starts with: text will only be found if a word begins with the supplied text.

            * Whole word: only words that match the text from start to finish will be matched. ...


        • Searching with the Keyboard

          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. These commands are also available in the Edit//Find// submenu:

          • !Return: nearly synonymous with clicking the "Next" button, with one important difference, the Find window will be automatically dismissed after you press Return. The search term will be saved however, allowing you to continue using the two following...


      • Project Replace

        The menu command, Edit//Find//Project Replace... provides the utility of replacing text throughout the entire project. 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.

        There's No Going Back From Here!

        Given that this process must go through all of the internal files in your project, opening and closing them as it goes, Project Replace cannot be undone (and you will be warned when you...

      • Filter Outliner & Corkboard Views

        MISSING_IMAGE:/path/to/gfx/editor-filtering_options.jpg

        Outliner and corkboard views can be filtered by a variety of criteria.

        The corkboard and outliner views are capable of simple filtering, making it a cinch to do such things as narrow down a project search with additional constraints, quickly find that one text file you know is somewhere in a list of a hundred cards in a folder, or only showing those rows in the outliner for items that have been labelled a certain colour, to name a few.

        A ...


        • Starting a New Filter

          Start a new filter on the current corkboard or outliner by using the Edit//Find//Filter... menu command (<$custom:shortcut>), type in the text you're looking for, and Scrivener will start scouring through all visible text in the view and present a list of only those items that contain matching text.

          The results, in other words, will be based on the information shown, according to the settings you use within the view. If you add a column to the outliner, or show status stamps on the corkboard, t...

        • Filtering by Compile Status

          To get started, click the disclosure arrow on the far right-hand side of the filter panel. The first two dropdown menus along the top contain filters for whether a document is in the draft folder, and whether it is set to be compiled:

          Draft folder status

          : The first dropdown is for filtering whether or not the items in the view are currently located within the draft folder. This will most often be useful when filtering collections or search results, where the items in the corkboard or outliner ...

        • Filtering by Metadata

          Although you can add the appropriate column in outliner view to search within it, it may sometimes be desirable to make certain you are only finding results from within that particular metadata field---or on the corkboard to be able to search for fields that cannot be displayed within it. To get started, click the disclosure arrow on the far right-hand side of the filter panel, and look to the bottom row of dropdown menus provided.

          Enable Metadata Filtering

          : In the first dropdown menu you will...

        • Resetting and Refreshing Results

          To clear the current search term, either press the Esc key on your keyboard, or click the CloseButton button on the right-hand side of the typing area. If the text field is already empty then pressing Esc an additional time will close the filter panel.

          If items themselves change in such a way that their presence in the filtered list would change, either to be added or excluded, the result will not automatically refresh. You will need to do so yourself by clicking the RefreshButton button, to th...

        • Closing the Filter Bar

          When you are finished filtering the view, click the Done button on the far right of the filter bar to close the panel and restore the view. From the keyboard you can use the Esc key to clear the text from the current filter, and when the filter text is empty, Esc will also close the panel.

          Filters will also be closed automatically whenever navigating away from the filtered view, or when closing and opening the project.

        • Working with Results in Extended Usage

          Given how filters will be dismissed when opening search results into the editor being filtered, you may wish to sometimes freeze the list of results so that you can hop back and forth between results using the history buttons without losing your place. There are a few different approaches you can take:

          • Naturally there is the other split. We've assumed it is being used for something else at the moment however, but this basic approach of selecting a search result and hitting the <$custom:short...


      • Quick Search Tool

        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 maybe you are already using project search and don't want to change the settings for just one thing. Quick Search is a new capability in Scrivener that addresses the desire to quickly locate and navigate to items based on their titles, synopsis or text. It is [located front and centre in the applica...


        • Starting a New Quick Search

          You can start using it much like you would any search tool:

          • Click into the bar to place your cursor there.

          • Or use the <$custom:shortcut> shortcut to move the cursor into it.

          Once you start typing, search results will start appearing, narrowing down in scope the more you type. The search method used will always be "Exact Phrase", and it will prioritise results that match what you have typed in completely, as well as titles that begin with what you've typed so far. These two exceptions asi...

        • Using Quick Search Results

          Once you have found the item you are looking for anywhere in the list, it will often be easiest to click on it, loading the item directly into the active editor. It is also possible to use the arrow keys to move the selection bar up and down through the list, pressing !Return once you have the one you want to load. The selection bar automatically highlights the first result in the list. Either of these methods can be modified in the following ways:

          • Add the Shift key to load the search result...

        • Project Targets and the Quick Search Tool

          When you aren't using it for searching, this tool also serves as a convenient means of tracking progress toward any goals you have set toward draft or session totals. To get started with goals, hold down the OptionAlt key on your keyboard and click in the Quick Search tool itself. This will bring up [the Project Targets panel][Project Targets], where you can edit your goals and change options on how those goals should be met. This can also be brought up with the Project//Show Project Targets men...

        • Quick Search Settings

          There are a few settings that adjust how project target tracking works in this tool. They are located in [the Appearance: Target Progress Bars !preference pane][appearance - targets]:

          • If you'd rather not be distracted by progress bars while writing, but still wish to make use of goals, you can disable feedback by disabling the Show progress bars in Quick Search toolbar item option.

          • The default colours are designed to fit in with the rest of the system. If you would prefer they use the col...


      • Find by Formatting Tool

        The "Find by Formatting" utility can be invoked from Edit//Find//Find by Formatting... (<$custom:shortcut>). It gathers together a number of powerful project-wide search tools for otherwise difficult to locate things, such as inline images by name; cross-reference links; text by style; annotations & footnotes; and so on. The anatomy of the tool is quite simple, [let's take a look](#find_by_formatting):

        MISSING_IMAGE:/path/to/gfx/find_by_formatting.jpg

        Find by Formatting: for finding stuff other...


        • Highlighted Text

          In relation to Find by Format.

        • Comments & Footnotes

          Search within any inspector-based comments or footnotes in the project. By default both will be considered for 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:

          • *Any Color*: No limits will be made on the search results.

          • *Limit Search to Color*: will only find annotations of precisely the specified colour.

          • *Exclude Color from Search*: any annotations precisely matching the provided colour will be excluded from the search.

          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 dropdown menu, matching those used by the Format//Revision Mode// submenu while editing. Since these colours can be changed in the Editing: Revisions !preference tab, inconsistencies between stored markings and current settings can result if collaborators are not using the same preferences, or if you change these settings midway through a project. If you intend to make use of Revisions in general it will be a good idea...

        • Colored 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. The colour choice needs to be precise, so using custom swatches or built-in presets will generally be easiest. As with the highlight tool, right-click on the colour chip to select from Scrivener's standard stock colours, or left click to open the colour chooser directly.

        • Style

          The stylesheet for the current project will be presented in the Style Name dropdown. If you wish to search only within block quotes, code blocks or headings, this is where you would do so. This tool will mainly be of use if you want to walk through style usage throughout the project, or hunt down specific text found within a specific style. There are additional search capabilities if you're mainly interested in selecting or finding all text assigned to a specific style. Refer to [Selecting and S...

        • Character Format

          Common text-level formatting can be searched for using this tool. Any number of options in the additional criteria can be stipulated. They work in an additive 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//Paragraph//Keep With Next marker added.

        • Links

          You may search for hyperlinks of any sort 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 dropdown to make this choice. The "Web/File Link" will in fact locate *all* links, save for internal document links. Beyond the Web, mail, ftp, protocol links to other software (or other Scrivener projects) and so forth will also be found.

          When using the "Document link" link type, the Replace with Title button ca...

        • Images

          Inline images in text files will be found by this tool. This includes fully embedded graphics that have been pasted or inserted into the file, as well as images that have been linked to files on the disk, via the Insert//Image Linked to File... menu command, or images linked to binder files via Insert//Image Linked to Document. This will *not* find images referenced with a placeholder---given that placeholders are simple text, you can use the regular text searching tools to locate these.

          In thi...

        • Tables

          Tables inserted into text documents will be found with this tool. Matching text contained within any cell of the table will cause it to be found. In all cases the entire table will be selected.

        • Preserved Formatting Text

          This will find text which has been marked as "Preserve Formatting", via the Format//Preserve Formatting command. Since there are no optional qualities to these blocks of text, no additional criteria is required.


      • Regular Expressions

        Regular expressions are an advanced search syntax that can also be used to do complex replacements. If you know what they are, you are probably delighted to hear we support them. If you don't, we could not even begin to document this search syntax; entire books even larger than this user manual have been written on the topic! If you would like to learn how to use them, there are plenty of recipes, learning resources and tutorials on the Web, as well as those aforementioned books.

        Regular expres...


    • Project Navigation

      Moving around within a large project is an important part of writing efficiently, and especially in an application like Scrivener where cutting your work up into many small pieces is second nature. It's such an important aspect of the software, we have an entire top level menu devoted to [navigation][Navigate Menu].

      An average book might have anywhere between several dozen, to hundreds or even thousands of sections arranged into many levels of groups in the Draft folder alone, and that's not co...


      • General Navigation

        Navigation introduction; features which are common to multiple views; general concepts


        • Header Bar Drag and Drop

          As mentioned before, Scrivener has extensive support for the concept of drag and drop. There are many areas where you can drag icons from and nearly just as many that you can drag *to*. The header bars on the editor splits are one such target, and they have two basic modes of usage:

          1. Dropping binder items: in this case the items (if plural, it will form a multiple selection) are loaded in the editor, much as though you had selected or clicked on them in the binder. When holding down the Opti...

        • Go To Menu

          In most cases, it will be easiest to use the binder, or the group views in the main editor, to select and navigate to various components in your project. There will be times when this is not true. If you prefer to work with the binder hidden or are using a collection, are working in !composition mode, or just would rather not drill down to a particular spot solely to select an item, the Go To submenu is an handy substitute for other methods, and in some cases can even be faster than traditional ...


      • Controlling Sidebar and Editor Integration

        With few exceptions, whatever you click on in the binder sidebar will be automatically loaded into the active editor. This can become more complicated when there is more than one editor split in use. Occasionally you'll want to load things in another split so as to not disturb your current environment. Or you may even want everything to load in the other editor as a matter of course, no matter which editor is currently active. You may also want the binder to be completely decoupled from the edit...


        • (see also)

          • [Splitting the Editor]: much of what we'll be talking about in this section will only be beneficial if you're working with split views.

          • [The Active Editor and Targeted Editor in Split Views]: for more information on how the editors signal their integration with the binder.

          • [Selecting Items]: the basics on how the binder works with the editors in general.

        • Locking the Editor

          Main article

        • Locking the Group View Mode

          Main article

        • Adjusting What the Binder Affects

          Earlier we spoke of adjusting whether the binder should interact with a particular split or leave it alone. Let's take a look at two different ways of doing that---one for quick one-offs and another for altering how the binder interacts with splits.


          • When Loading Items

            At any time you can modify how selection works in the binder sidebar and other contexts, causing the action to impact the other split, by holding down the OptionAlt key when clicking. Here are the contexts and methods this blends with:

            • Clicking on individual items in the binder.

            • With the combiner modifier keys, add or remove from [Multiple Selections] in the other split. Opt-Cmd-ClickAlt-Ctrl-Click will add or remove the item you clicked on to the other split's group view (forming a group...

          • Changing How the Binder Works Persistently

            By default the active split is synonymous with the targeted split. If you click in the top editor the header bar is shaded blue and is underlined in blue. You wouldn't be blamed for thinking that was one visual effect, but in fact it is two. The blue shade indicates the binder will load things into that editor when you click on them (targeted), and the blue underscore indicates that this is the split you're currently working within (active). If we can tell the binder to only target one split but...


        • Making Splits Load by Type

          If you would like to use the split views to achieve a stricter form of navigation, where one is dedicated to primarily secondary navigation (such as browsing the contents of a folder) and the other to content itself, the Navigate//Binder Selection Affects//Open Non-Group Items in Other menu toggle may achieve what you are looking for.

          This option is subsidiary to setting the binder to affect only one split (from that same submenu), and impacts how the *other* split, not affected by the binder, ...

        • Linking Splits Together

          In addition to tuning how the binder sidebar works with splits, you can also adjust how splits work together, or with attached copyholders within either split.

          MISSING_IMAGE:/path/to/gfx/nav-auto_load_button.jpg

          The "auto-load" button appears in blue when activated.

          Both corkboard and outliner views have an auto-load feature that when enabled, will load any selected item(s) in the other split or the editor's copyholder, much like when clicking on an item in the binder. There are three modes of...


      • Saved Layouts

        MISSING_IMAGE:/path/to/gfx/layouts-examples.jpg

        Scrivener's diversity and flexibility benefits from being able to save your workflows into Layouts.

        In the course of using Scrivener, you may find that you shift how you use the project window, depending on what you are doing, or which phase of the project you're in. In the early stages of a project 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 t...


        • Creating a New Layout

          MISSING_IMAGE:/path/to/gfx/ui-layouts_panel.jpg

          Layouts panel with the interactive tutorial's window settings saved.

          To get started, open the [Layouts panel](#ui-layouts_panel) with the Window//\\Layouts//Manage Layouts... menu command (<$custom:shortcut>). If you do not have any layouts saved yet, you won't see much beyond some help text.

          1. If you have more than one project open, make sure the project you wish to capture is the active window by clicking anywhere within it. Whether or not th...

        • Switching Between Layouts

          First off, it's important to know that when you apply a layout to your project window, you'll be overwriting all of its current display settings with what has been saved in the layout. Consequently if your current view settings are important, you might want to save them into their own layout first. There are three ways to switch between layouts:

          1. Use the Window//Layouts// submenu and select the saved layout from the list.

          2. The "View" button in [the main application toolbar](#interface-too...

        • The Built-In Layouts

          Scrivener comes with several built-in layouts that demonstrate the various navigational features of the project window. Some are intentionally quite simple, designed to help you focus on a particular way of working, others gather a number of individual settings into more complex workflows that may not obviously achieved by their parts.

          Unlike regular layouts, these built-in layouts will in general not change your window size or position, unless the layout causes any main editor splits to become...


          • Default

            MISSING_IMAGE:/path/to/gfx/layouts-builtin-default.jpg

            The "Default" built-in layout.

            The first and most important layout to be aware of is the one that gets things back to ground zero. The "Default" layout is designed restore a project window to a basic look, removing the non-active split view, closing all copyholders and opening the inspector and binder. It will also clear those navigation settings that modify how the project window behaves when you click on things---in the exact same fashion...

          • Three-Pane (Outline)

            MISSING_IMAGE:/path/to/gfx/layouts-builtin-3pane_outliner.jpg

            The "Three-Pane (Outline)" built-in layout.

            Three-pane browsers are a popular way of navigating through large amounts of information. They typically feature a sidebar (much like the binder) for selecting folders, then display the contents of that folder in a second view, and finally clicking on things inside of that view will automatically load the contents of what you click on into the third pane. Here are the settings it applies:

            ...

          • Three-Pane (Corkboard)

            This layout is functionally identical to the "Three-Pane (Outliner)", save for using a stylised corkboard view for primary navigation, rather than an outliner. If you prefer the additional visual display of metadata that the corkboard affords you, this can make a good alternative. It temporarily changes the following aspects of the corkboard:

            • View//Corkboard Options//Cards Across will be set to "1".

            • The Size to fit editor setting will be enabled, from within the [Corkboard Options] panel....

          • Editor Only

            MISSING_IMAGE:/path/to/gfx/layouts-builtin-editor.jpg

            The "Editor Only" built-in layout.

            Does what it says on the tin. This very simple layout simply removes both sidebars, closes the split view and any copyholders. Which split it chooses will depend on what you are currently working with. It will favour the split that is showing a text editor or Scrivenings session. If both (or neither) splits match that description, then the active split will be used. Lastly it will set the group view mode to...

          • Corkboard Only

            MISSING_IMAGE:/path/to/gfx/layouts-builtin-corkboard_only.jpg

            The "Corkboard Only" built-in layout.

            Much like the "Editor Only" layout, but aiming to provide a clean view for focussing on structure, rather than content. If relevant, when choosing which split to focus on, the layout will select the split with a corkboard. It will otherwise use the active split, changing the view mode to Corkboard if necessary. If you were editing a file then the layout will select the *parent* group, scrolling t...

          • Centered Outline

            MISSING_IMAGE:/path/to/gfx/layouts-builtin-centered_outline.jpg

            The "Centered Outline" built-in layout.

            The main purpose of this layout is to quickly and simply display a very clean outline view with only the Title (and optionally Synopsis) column visible and the View//Outliner Options//Center Content menu toggle enabled. The editor space will be cleaned up, closing splits if necessary and removing any copyholders.

            As with the "Corkboard Only" layout, the split showing an outliner will be pref...

          • Dual Navigation

            MISSING_IMAGE:/path/to/gfx/layouts-builtin-dual_navigation.jpg

            The "Dual Navigation" built-in layout

            If you've ever found yourself wishing that you could have a kind of second binder, so that you could browse and edit more than one file at once, this layout may do the trick. You can think of this layout as roughly dividing the project window down the middle into two separate workflows:

            • On the left side, the binder and the left split will be bound together exclusively. You can use it for tex...

          • Refining A Built-In Layout

            You may very well find that you like the basic idea of one of our built-in layouts, but would like to make adjustments to how it works. Although you cannot modify the built-in layouts, for the most part this can be done simply by creating your own layout after making the desired modifications to the project window, as described earlier in this section.

            Although they work similarly, built-in layouts are not the same as the layouts you create, and they have some characteristics you won't be able ...

          • Hiding the Built-In Layouts

            Once you've established a number of your own layouts, you may want to hide these starter layouts to clean up the menus:

            1. Use the Window//Layouts//Manage Layouts... menu command (<$custom:shortcut>) to bring up the layout management window.

            2. Click the GearMenu button and select the "Hide Built-In Layouts in Menus" command.

            You can always bring them back with the "Show Built-In Layouts in Menus" command.


        • Setting a Full Screen Default

          It is possible to select a layout for use by all projects that are taken into Full Screen mode, as a kind of default layout for that way of working. This is a special behaviour that breaks some of the rules with regards to how project layout in general works:

          • The designated Full Screen layout will be used when taking a project into Full Screen mode. When taking that project out of Full Screen mode (or even simply closing it), it will resume using its original layout settings. Thus the full s...

        • Managing Layouts

          All layout management is done within the "Manage Layouts" panel, which can be loaded with the Window//Layouts//Manage Layouts... menu command (<$custom:shortcut>).

          To remove a layout you no longer need, select the layout and click the DelButton button along the bottom of the layout list on the left. 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 using the current p...


      • Viewing Only Compilable Items

        How to filter out items from a view, depending on whether or not they can be compiled.

      • Clearing Navigation Settings

        If for any reason you wish to clear all of the settings that impact how clicking works in the project window, the Navigate//Clear All Navigation Options command is a handy way to do so in one move. The following changes will be made:

        • The Navigate//Binder Selection Affects mode will be set to "Current Editor".

        • The Navigate//Outliner Selection Affects mode will be set to "None".

        • Navigate//Editor//Lock in Place will be disabled.

        • Finally, the inspector will be unlocked from working with...

      • Quick Reference

        If you've been looking for a way to load a document into its own window, this is the section for you. Quick Reference panels (sometimes shortened to "Quick Ref") are simplified editors and media viewers, and you can have as many of them open as you want. The software even keeps track of which you've used during the session, so that closed windows can be very easily reopened from the Window menu.

        MISSING_IMAGE:/path/to/gfx/quickref-example_window.jpg

        With Quick Reference, open bits of your proje...


        • Opening an Item in Quick Reference

          There are fivefour easy ways to open a document in Quick Reference mode:

          1. Select one or more documents in the sidebar or a view and tap the Spacebar. If more than one document is selected, multiple Quick Reference panels will be opened at once.

When selected from one of the editor views (including the text editor), use the Navigate//Open//as Quick Reference instead. You can also make it so Spacebar works in the corkboard and outliner with the Space key opens selected documents in... setting...

        • The Elements of the Panel

          Before we go into the various elements of the panel, it would be good to make note of how they all fit together. Each Quick Reference panel you open will remember the settings you've used within it, as well as the overall size of the window and split placement. If you left the inspector open and dragged it down to the shortest possible height, and you open that panel again in two years it will be just how you left it.

          When you open a document in a Quick Reference panel for the first time ever, ...


          • The Header Bar

            MISSING_IMAGE:/path/to/gfx/quickref-header_bar.jpg

            The Quick Reference header bar.

            Along the top of the window, below the Format Bar if you have displayed it, you will find [a simplified header bar](#quickref-header_bar).

            The icon to the left of the title can be dragged, acting as a proxy for the file it represents. It can be dragged to the binder to move the file to the location you drop it, it can be dragged into a bookmarks inspector pane, etc. To "dock" a Quick Reference panel back into th...

          • The Footer Bar

            The footer bar, running along the bottom of the view, has three primary elements:

            1. The "Project Bookmarks" button. This is described [below][The Bookmark Sidebar].

            2. This area will display either statistics or scripting element dropdown menu (which can be called up with the <$custom:shortcut> shortcut, just as in the main editor), depending upon the editor mode.

When viewing a multimedia file, [the "Pause and Rewind" toggle button][Viewing Multimedia Documents].


            3. Finally, along the ri...

          • Quick Reference Mini-Inspector

            Quick Reference panels can display inspector metadata for the document you are working with in the panel.

            MISSING_IMAGE:/path/to/gfx/quickref-example_window-with_metadata.jpg

            A Quick Reference window can display a simplified inspector along the bottom or to the right (as shown).

            The panes you can make use of here are not organised in precisely the same fashion as the inspector itself, on account of their being divided into specific areas of content. For example the "Notes" tab in the inspector...

          • The Bookmark Sidebar

            Any Quick Reference window can easily browse through project bookmarks (assuming it can display the type of bookmark in question). Click the bookmark button, marked (c) in [](#quickref-example_window) to toggle the sidebar visibility, or use the <$custom:shortcut> shortcut. Click on the bookmarked document you wish to edit to view it in window.

            For detailed reference on the sidebar itself, refer to [Working with Bookmarks in a Quick Reference Panel].

            When using the bookmark sidebar, the earlie...


        • Tips for Using Quick Reference Panels


          • Floating Panels for Maximum Visibility

            Quick Ref panels have an additional capability in the Window//Float Quick Reference Panels menu toggle (<$custom:shortcut>). When set, all of a project's panels will "float" over all other windows in Scrivener. Floating can be particularly useful when the project window itself is as large as the entire screen, or in !composition mode, where the backdrop would ordinarily hide the panels. Consider toggling float on and off as needed to bring the panel workspace to the front, and then disable it an...

          • Displaying Research in Quick Reference

            It's not just about the text. These windows can also act as capable PDF and image viewers, as well as working with other multimedia. For further information on the particulars of how they work inside the editor area, refer to [Viewing Media in the Editor].

            The Window//Zoom menu command, when use on a Quick Reference panel that is viewing an image or PDF will expand or contract the size of the window to fit the content. If you would prefer things work the other way around, double-click on the im...

          • Setting Text Zoom

            Although there is no place for the visible zoom control like in the main editor footer bar, you can independently zoom the text scale within each Quick Reference panel as needed, using the View//Zoom// submenu, or the <$custom:shortcut> and <$custom:shortcut> shortcuts to decrease and increase the magnification levels, respectively.


    • Inspector

      The Inspector is the panel on the right-hand side of the project window that displays all metadata, snapshots, cross-references, notes, compile settings and other sundry associated with the selected binder item.

      You can also display project bookmarks in this pane, making it a handy place to work with global notes. In this chapter we'll go over each element within the inspector and how to use it, referring you to further discussions on the topic if necessary. First, we'll take a look at using th...


      • Inspecting Items

        With a fairly basic project window, using the inspector to examine a document's metadata and other auxiliary information should be straightforward. You click on a thing in the binder, it loads in the editor, and its metadata loads into the inspector on the right.

        What the inspector works with becomes more complicated as additional elements are added to the project window. For example if the editor view is split and you're using the right half, but you've set the menu setting Navigate//Binder Se...


        • When I click on a folder something else gets inspected?

          When it comes to groups, Scrivener will remember what you were doing the last time you used that group, which often means it will remember a selection within that group. In turn that means the items in the corkboard, outliner, or the section of text you are editing within a Scrivenings session is what ends up being inspected, not the folder. If you'd like to inspect just the group you clicked on, use the Edit//Deselect All menu command on t...

        • Locking the Inspector

          In cases where you do not want the inspector to use the active split, it can be locked to a specific split so that when the other editor becomes active, the inspector will continue to display information about the selection in the editor you locked it to. Either use the Lock Inspector to Editor command from the split's [header bar contextual menu] or right-click in the inspector header bar itself to lock it to the current editor.

          MISSING_IMAGE:/path/to/gfx/editor-header-inspector_lock.jpg

          The s...


      • Using the Sidebar

        Now that we've established how to use the inspector in general, let's take a look at the stuff it actually does---what these individual tabs represent, and how to use the sections that appear within them.


        • The Inspector Tabs

          MISSING_IMAGE:/path/to/gfx/inspector-tabs_and_title.jpg

          The inspector header with the Bookmarks tab selected. The name of the document will be printed below, on all tabs but the first, which has a built-in index card.

          In order of appearance, the tabs as shown in [](#inspector-tabs_and_title) are:

          1. *Synopsis & Notes*: the first tab, shaped like a notepad, contains the "index card" that will represent this item on any corkboard viewing it, and below that a scratch pad where you can jot down n...

        • (figure: label & status)

          MISSING_IMAGE:/path/to/gfx/inspector-label_and_status.jpg

          The label & status fields at the bottom of the inspector.

        • Label and Status assignments

          At the very bottom of the inspector you'll find universal access to the "label" and "status" fields. In the [example figure](#inspector-label_and_status), we've marked this document as having reached the first draft point, but we clearly aren't very happy with it and would like to rewrite it at some point.

        • (figure: collapsed section)

          MISSING_IMAGE:/path/to/gfx/inspector-keywords_collapsed.jpg

          Appearance of a collapsed inspector section.

        • Collapsing sections within a tab

          Whole sections can be collapsed within the tab, if the section header has an arrow icon to the left of it. You might never use keywords in a particular project, but have a lot of custom metadata fields. Click the [arrow to the left of the section's label](#inspector-keywords_collapsed) to collapse that section, allowing the others to use the space it was taking up.

        • Resizing sections

          All of the sections within an inspector tab can be resized vertically to suit your usage and the demands of the content in these areas. For example if you tend to use longer synopses and only a few notes now and then, you could drag the synopsis card area in the notes tab downward, giving you more space to work within it.

        • Inspector Keyboard Usage

          Tips for using the keyboard with the Inspector


          • Inspector Keyboard Shortcuts

            Shortcut

            First Use

            Second Use

            <$custom:shortcut>

            Notes & Synopsis tab

            <$include>

            <$custom:shortcut>

            Bookmarks tab

            <$include>

            <$custom:shortcut>

            Metadata tab

            <$include>

            <$custom:shortcut>

            Metadata tab

            <$include>

            <$custom:shortcut>

            Snapshots tab

            <$include>

            <$custom:shortcut>

            Comments & Footnotes tab

            <$include>

            <$custom:shortcut>

            Notes & Synopsis tab

            <$include>

            Inspector Keyboard Shortcuts


      • Notes Tab

        MISSING_IMAGE:/path/to/gfx/inspector-notes_tab.jpg

        Inspector: Synopsis & Notes tab.

        Each and every document in Scrivener has its own separate scratch pad that you can use to jot down notes to yourself. There are two types of notes you can use:

        1. The summary, or "Synopsis" card, in the upper half of [this tab](#inspector-notes_tab), will be visible throughout the project in the form of index cards, in the outliner and other areas. How you use it is up to you, but it's public presence in the p...


        • Synopsis Card

          The index card found in the inspector will be simpler than what you may see on the corkboard. Special display features, such as the label strip, keywords and status stamps, will not be rendered, as they can be readily viewed (and of course modified) elsewhere in the inspector. However if you are using the View//Use Label Color In//Index Cards option, the card will be likewise tinted in the inspector. As with the corkboard, you can edit the title and synopsis right on the card, updating the docum...


          • Synopsis Images vs Text

            In the "Synopsis" section header, along the right-hand side, is a button that when clicked will toggle between using a text or image synopsis for this item. You can also use the Cmd-7Ctrl-7 shortcut, or the matching button on the Touch Bar, when keyboard focus is in the inspector and this tab is showing. Graphics that have been imported into the binder show a thumbnail of themselves on the corkboard and inspector by default. Use this same button to disable that behaviour for an image and use a t...

          • Adjust Synopsis Image Cropping and Size

            You can adjust the size, placement and cropping of the image by right-clicking on it within the inspector. These adjustments also impact the way the image will be displayed on the corkboard:

            Scale to Fit

            : The longest edge of the image will be sized so that it fits within the shape of the index card in the inspector, thus showing the entire image.

            Fit Horizontally

            : The width of the image is sized to fit the width of the synopsis image area. This may mean portions of the image are cropped alon...

          • Auto-Filling Synopsis Text

            If you would prefer to use an excerpt from the main text area, there are two ways to go about doing so:

            1. Select some text in the main editor and use the Documents//Auto-Fill//Set Synopsis from Main Text menu command (<$custom:shortcut>) to fill the synopsis with that text.

            2. Drag and drop text from any source into the synopsis text area to append it at the drop location---just as with any text editing area.

            What if I just want the first bit of the text shown?

            If no selection is made, a po...

          • (see also)

            • [So What are Index Cards, Anyway?]: introductory text on the anatomy of an index card---primarily as it relates to the corkboard, but since this copy in the inspector is your portal to that "same" card it's good to know what it represents.

            • [The Corkboard] & [The Outliner]: knowing where this synopsis card shows up is essential to using it effectively.

            • [Appearance: Index Cards !preference pane][appearance - index cards]: where much of how an index card looks & feels will be configured.


        • Document Notes

          The "Notes" section in the lower half of this tab (it has a yellow background by default) is a small but nearly fully capable rich text editor, much like the main text editor you do your principal writing within. You can embed images, use lists, tables and most other things you might need. It is thus a suitable place to copy and paste text from the main editor, if you wish to set aside passages you aren't sure about.

          Document notes are always attached to the current document in the sense that y...


          • (document notes settings)

            • [Editing: Formatting: Notes][Editing - Formatting - Notes]: select the default font and size for all new document notes (also impacts scratch pad).

            • [Appearance: Inspector & Notes][appearance - inspector & notes]: adjust the text colour, background colour and whether or not rules are added, for a "canary pad" look.


      • Bookmarks Tab

        MISSING_IMAGE:/path/to/gfx/inspector-bookmarks_tab.jpg

        Inspector: Bookmarks tab.

        Bookmarks are, much like the role they provide in a Web browser, a place to store links or references to material. Where Scrivener goes a bit further than the bookmark system in your browser is that in addition to URLs, you can also store links to things within the project itself---forming useful cross-references between related material---elsewhere to files your hard drive, or even between other programs if they s...


        • Adding Bookmarks

          To create links, simply drag documents from the binder, files from the system or URLs from your browser, into the list in the upper half of this tab. Scrivener will try to use the best title it can when doing so, but if you would prefer something else refer to editing bookmarks below.

          Another simple way to add a bookmark to a URL is to copy and paste. For example, you can copy the URL out of a browser's address field, click into any bookmark tab, and paste with Cmd-VCtrl-V and no further ado.

          ...

        • Opening and Using Bookmarks

          Double-clicking on a bookmark, or selecting it and hitting the !Return key, will open the document, either inside Scrivener or in the default application or browser depending on type of bookmark. How internal links are opened is determined by the Open inspector bookmarks in setting in the [Behaviors: Document Links !preference pane][behaviours - document links]. By default they will be loaded into their own Quick Reference panel.

          You can also drag a bookmark into the header bar for either pane....


          • Viewing Bookmarked Folder Contents

            MISSING_IMAGE:/path/to/gfx/inspector-bookmarks-folder_menu.jpg

            Easily preview child items from bookmarked folders.

            When bookmarking folders you will find a [chevron button to the right of the row](#inspector-bookmarks-folder_menu). Click this button to choose from a menu displaying a list of subdocuments from that folder. The chosen item will be displayed in the bookmark preview area below the list. You can more easily include whole categories of information in your inspectors with this capabil...

          • Editing Bookmarks

            Any existing bookmark's title can be edited by pressing the EscF2 key with a single bookmark selected. To finish editing, press the same key or click elsewhere to confirm.

            <$include>

            MISSING_IMAGE:/path/to/gfx/inspector-bookmarks-edit.jpg

            Sometimes giving a file a friendlier name is essential.

            For external bookmarks (those pointing to any resource not located within the current project's binder) there is an additional editing method for when you need access to or wish to modify the URL:

            1. ...

          • Deleting Bookmarks

            To delete bookmarks, select the ones you wish to remove and click the DelButton button, right-click and select "Delete Selected Bookmark", or tap <$custom:shortcut>.

          • Further Bookmark Management Tips

            For more bookmark management techniques (such as copying and pasting) which can make use of addition tools beyond the inspector tab, refer to [Managing Bookmarks].


        • Bookmark Viewer

          The lower portion of the bookmark inspector tab is a fully-capable media viewer and text editor, very similar in fact to a Quick Reference panel or copyholder, in that all formatting capabilities will be present, but with a focus purely upon the text or media content of the thing you're working with. As you click on bookmarks in the upper half of the tab, they will be examined---to the best of its ability---in the lower half.

          For external file links, not all types can be previewed in this fashi...

        • (bookmark settings)

          • [Behaviors: Navigation][behaviours - navigation]: solely adjusts whether links to the Web load immediately or not.

          • [Behaviors: Document Links][behaviours - document links]: adjusts whether back-link bookmarks are created when new links are created pointing to an item, or in graphics files when they are used in text. This pane also controls where an internal bookmark will load when pressing !Return to load it, or when double-clicking on the bookmark.

          • [Appearance: Inspector & Notes: Color...


      • Metadata Tab

        MISSING_IMAGE:/path/to/gfx/inspector-meta_data_tab.jpg

        Inspector: Metadata Tab is packed with goodies.

        TODO//LOW// remake this screenshot as the labels were changed to "Metadata". This tab sports a collection of built-in fields such as when the item was created or last modified, to a freeform list of keywords, to a middle section that is entirely up to you. Need a checkbox on everything you do? No problem. Keeping track of dates in a convoluted TV series narrative? We can help you with that to...


        • General Metadata

          This section contains basic document metadata and provides controls for how (or if) it will compile.

          Created

          : The point in time in which the binder item was created, or if it was an imported file, the creation date on the original file.

          Modified

          : Every time you adjust any part of an item (even the stuff in the inspector), the modification date will be incremented to reflect that change. If you would prefer a more static date to be stored for an item, consider creating a custom metadata date ...

        • Custom Metadata Pane

          Access to a project's custom metadata fields in an easy-to-edit linear format.

        • Keywords Pane

          Keywords function very similarly to what you might see referred to as "tags" in some other programs. They are a way of adding short bits of information to a particular item so that it can be cross-referenced with other items that have those keywords assigned, and are particularly useful for finding intersections in keyword assignments. For example we could search for all items that have the keywords, "Lindsay", "Paris", "Rewrite" assigned to them.

          Read more about [using keywords] for general di...


          • Assigning Keywords

            There are several ways to add new keywords to your document:

            • Click the AddButton button in the keywords table header bar to type in a new keyword. As you type, any existing keywords that match what you are typing in will be suggested as an auto-completion (this is case-sensitive). You can also use the !Return key in the table to add new keywords.

            • Drag the keywords from the [Project Keywords Panel] panel to the document header bar, its name in the binder (this latter use allows you assign ...

          • Managing Keywords

            Keywords can be reordered within the list using drag and drop. The order will impact the following areas of the project window and elsewhere:

            • Index cards on the corkboard, when View//Corkboard Options//Show Keyword Colors is enabled. Since only a few keywords can be shown in this context, putting the most important keywords you track visually near the top of the list will be beneficial.

            • The order of display in the View//Outliner Options//Keywords listing of the outliner view.

            • When expo...

          • Removing Assignments

            Keywords can be unassigned from an item by selecting them in the keywords list of the inspector and clicking the DelButton button above them, or pressing the !Delete key on your keyboard. You can also [bulk remove multiple keywords from many items at once using this panel][Project Keywords Panel].

            This will not remove the keyword from the project, even if it is the last item that was using it. To fully remove a keyword (and remove it from all items using it), see [Deleting a Keyword from the Pr...


      • Snapshots Tab

        MISSING_IMAGE:/path/to/gfx/inspector-snapshots.jpg

        Inspector: snapshots tab.

        Available only to items with editable text in the binder, this tab of the inspector provides access to any existing snapshots for the item, the ability to create new ones, load up comparative displays between them and the current editor, and delete them permanently. Read more about snapshots in [Using Snapshots].

        Need More Space to See the Snapshot?

        Firstly, do note the inspector as a panel can be resized a great deal...


        • Creating and Removing Snapshots

          To snapshot the current state of the text editor, click the AddButton button at the top of the tab. You can also use the <$custom:shortcut> shortcut at any time, even with this tab closed.

          To remove a snapshot, select it in the table, and click the DelButton button, or use the <$custom:shortcut> shortcut. For cleaning out large quantities of older snapshots, [The Snapshots Manager] will be the best tool for the job.

        • Renaming Snapshots

          Each snapshot can be optionally named either at the time of its creation, with the Document//Snapshots/Take Titled Snapshots of Selected Documents menu command, or at any time after that point right here in the snapshot list. To rename an existing snapshot double-click on its current name in the Title column of the list. Click elsewhere or press !Return to confirm the change. Snapshots can also be renamed from within the Snapshots Manager.

        • Rolling the Text Back

          If you've decided that the contents of a snapshot are preferable to what you current have in the main editor, there are two ways you can roll back text from a snapshot

          1. Using the preview area, select the text you wish to restore, copy it and then paste the text into the main editor.

          2. A more thorough approach is to completely replace the text of the editor with the contents of the snapshot---"rolling back the editor" to a previous point in time (though as with *Back to the Future*, we can ...

        • Comparing Changes with Main Text

          MISSING_IMAGE:/path/to/gfx/inspector-snapshots-comparison.jpg

          Snapshot comparison mode shows additions and deletions.

          Showing changes that have been made between the point in time where the snapshot was taken and the present-tense state of the text is a secondary function of this panel, and also something you can do in the main editors as well. In addition to this form of comparison, and exclusive to this tab, you can also show the changes made between two selected snapshots.

          To compare the te...


          • Browsing and Adjusting Change Markings

            When in comparison mode, two arrow buttons which will appear to the right of the GearButton. With these you can jump from one change to the next within the snapshot preview area. You can use <$custom:shortcut> and <$custom:shortcut> to navigate between changes, as well---and when viewing a comparison in the main editor or copyholder you will always need to use these shortcuts.

            As for how changes are marked, in some cases, the type of editing done in between snapshots will present a confusing re...


        • (snapshot settings)

          \par \vspace{1em}

          There are a number of settings that impact snapshots, both in their automatic production when certain actions are taken, and how they appear or behave in use:

          • [Appearance: Snapshots !preference pane][appearance - snapshots]: adjust the snapshot background colour (used in both the inspector sidebar and the main editors) and comparison changes.

          • [Behaviors: Snapshots !preference pane][behaviours - snapshots]: squelch the camera snapshot noise and select whether you should ...


      • Comments & Footnotes Tab

        MISSING_IMAGE:/path/to/gfx/inspector-comments_and_footnotes_tab.jpg

        Inspector: Comments & Footnotes tab.

        The last tab in the inspector is also exclusively available to those items with editable text. All linked comments and footnotes assigned to text within the editor will be listed in the order they are found. This list will not include inline annotations and footnotes. In Scrivenings mode, where multiple documents are represented, this display will show a combined view of *all* notes across ...


        • Using Linked Notes in the Inspector Pane

          Each note will have its own box representing it. They act a bit like corkboard index cards in that you can click once to select them and then a second time to start editing the note (or a quick double-click to edit immediately). You can also use the !Return key to start editing a selected note. Interacting with a note in any way, even to just passively select it, will automatically scroll the editor to the note's associated highlight.

          There are two ways to stop editing a note:

          1. Tap the Esc ...


          • Hiding and Revealing Notes

            Notes can be independently collapsed or revealed using a few different methods:

            • Click on the triangle to the left of the heading of the note you wish to expand or collapse.

            • The LeftArrow and RightArrow keys will expand or collapse all selected notes.

            • OptionAlt-Click on any of the note disclosure arrows to expand or collapse all notes in the direction taken for the note arrow you clicked on.

            • The View//Outline//Expand All (<$custom:shortcut>) and Expand All (<$custom:shortcut>) shortc...

          • Note Formatting

            When working between multiple sources and programs, you may notice that footnotes will take some rich text formatting, and may end up looking mismatched with the other footnotes you've created. You can revert footnote and comment formatting to default settings:

            1. Select the notes you wish to clean up.

            2. Right-click on the selected notes and select the "Convert to Default Formatting" command.

            The global default font for footnotes and comments can be modified in the [Editing: Formatting !pre...

          • Setting Colours for Linked Comments

            Linked comments, as with inline annotations, can be assigned a colour. By default, 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, right-click on it in the inspector sidebar, or in the shaded header bar area when using...

          • Inspector Footnote Numbering

            The View//Text Editing//Show Compiled Footnote Numbers in Inspector project setting will add a static footnote number to the upper-right corner of each footnote, when compiling with this feature enabled. Refer to [Compiled Footnote Numbering] for further information on this capability.

          • Convert to Comment or Footnote

            Right-click on any selection of notes to convert them between footnote and comment types. This can be done freely at any time, and if a custom colour has been applied to a comment it will be remembered in the background in case you convert it back from a footnote in the future. For further information, refer to [Converting Notation Between Types].


        • Zooming Inspector Notes

          As with the main text editor, inspector notation can be scaled with a zoom feature in a way that does not disturb the underlying formatting, in one of two separate modes:

          • Coupled with the editor zoom scale: this is the default setting. If you change it from the default, right-click on any comment or footnote and select the Zoom//Use Editor Zoom contextual menu command to get it back.

          • In some cases this can produce undesirable results, such as when each editor split is using its own zoom s...

        • (comments & footnotes settings)

          • [Editing: Formatting !preference tab][editor - formatting]: adjust the default font and font size used to create new footnotes and comments in the pane. Note that in most cases compile settings will handle footnote formatting for you, so this setting is more for your benefit rather than establishing print settings.

          • The Open comments in inspector if possible option, in the Editing: Options !preference tab. <$include>

          • In [Appearance: Main Editor: Colors][appearance - main editor], the "Co...


    • Cloud Integration and Sharing

      Various tools and methods available for sharing work or keeping yourself synchronised with Internet-based storage.


      • Scrivener Everywhere

        Placing your Scrivener project into a cloud folder, so that it is available to every computer you own, is today a natural concept that by and large works well with Scrivener There are a few cloud services you should be wary of, in terms of how well they handle a complex format like Scrivener's. Visit our [knowledge base](http://scrivener.tenderapp.com/kb) for up-to-date information on specific services, before settling on one to use with your important work. . Without going into great technical ...

      • Working with Scrivener for iOS

        This chapter will *not* go into how to use the iOS version of Scrivener, save for where its usage intersects with the macOS or Windows versions. We've prepared a tutorial/reference for you, built right into the iOS app. If you'd like to learn how to use it, that's the place to go!

        As for here, we'll dig in to the ramifications of what iOS now means from the perspective of using your computer, whether you wish to use the mobile version to edit your own projects, or if you intend to work with oth...


        • Basic Usage

          The Scrivener project format has been designed to support seamless mobile usage between device and computer. The iOS app comes with Dropbox integration built-in---which will make for the most convenient option---but the syncing system was specifically built to withstand all forms of file transfer (seeing as how Dropbox is a file-based system, this is no mere side-effect!). You can package the project up by exporting it from the app, send it to yourself via email, AirDrop or even copy the project...


          • Sync with Dropbox

            This should probably go without saying, but there are two basic ingredients you'll need to get this all working:

            • First thing you will want to do is set up Scrivener for iOS so that it is hooked up to your Dropbox account. If you are unsure of how to do that, please consult the built-in tutorial on your device, or tap on the circular arrow icon in the main project screen and walk through the setup screens.

            • On your computer, you'll need Dropbox installed and running in the background.

            In t...


            • Using Multiple Sync Folders

              Although we do not recommend switching sync folders frequently (you will need to download everything all over again every time you switch), if you need it, you've got it. This may be useful if you're collaborating with another person over Dropbox, or if you use your device for personal writings as well as using a shared work folder, and wish to keep the two separate.

              1. On your iOS device, return to the main project screen.

              2. Tap the Edit button at the top of the project list (in the sidebar...

            • Where is iCloud Support?

              If iCloud were compatible with the format we use to store your project, we'd support it, that's the simple fact. At this time, Apple's interface for working with iCloud is designed around a model which presumes one single file stores all of the information needed to open and save the document. To be fair, in most cases this is a safe assumption! Scrivener's format, designed with the capacity to store gigabytes of research data, uses a special folder-based format used by ...


          • Managing Projects Directly (iTunes)

            Dropbox may not work for all of your projects, or you might be unable or unwilling to use it at all. No fear! You still get all of the goodies, but you'll need to handle copying projects to and fro.


            • iTunes and other file managers

              The easiest option will be with the iTunes software itself, using its "File Sharing" to access documents stored by the various apps on your device. With Scrivener's document list loaded, you can copy projects directly onto the device over WiFi or USB cable, and copy updated projects down to your computer in the same way, with drag and drop to or from the FinderExplorer.

              1. With your device plugged in or connected via WiFi, open iTunes.

              2. Select your device.

              3. Select "File Sharing" in the s...

            • Do not merge project folders

              Some file management tools may merge a project folder when copying a project into a location where a project by that same name already exists. Merging should never be done. If necessary, delete or rename the older version of the project first, and then copy the updated version of the project so that it creates the project from scratch.

            • Third-party sync

              You may also find that other cloud services with an iOS app work, albeit in a manual fashion (more like copying than "syncing"), as a way of transferring projects on or off the device. If the iOS sync app lets you send folders to other apps on your device, then try sending the project folder, ending in ".scriv", to Scrivener for iOS, from that app.

            • Export as Zip

              Finally you can export projects from your device by sharing them as Zip files:

              1. On the device, from Scrivener's main project screen, tap the Edit button.

              2. Select the project you wish to send.

              3. Tap the "Share" button at the bottom of the project list.

              At this point a number of services are available to you, depending upon what you have installed on your device. At a basic level you'll be able to email a copy of the project. Other programs may allow you to store the .zip locally, as a b...

            • Using AirDrop to Transfer Projects

              AirDrop can be used to easily copy projects between an iOS device and your Mac. To copy a project to your mobile device:

              1. Enable AirDrop on your iOS device (by default you can swipe up from the bottom of the screen, tap the AirDrop button below the volume slider, and select your privacy setting).

              2. Now open the AirDrop window on your Mac, using the Finder's Go///AirDrop menu command (Shift-Cmd-R).

              3. You should see your iOS device appear as an avatar, to send the project, drag and drop it...


          • Updating Projects with Mobile Changes

            Main section describing what happens when a modified project is synced.


        • Avoiding and Resolving Conflicts

          What a conflict is, how to fix them, and how to avoid them.

        • Storing Settings and Fonts on Dropbox

          You can store iOS compile appearance settings, custom fonts and formatting presets in your Dropbox folder, making them automatically available to every device hooked up to this sync folder. Whenever changing or adding files, you should sync your devices with the server, and to play it safe, restart Scrivener for iOS (press the Home button twice quickly, then swipe the Scrivener tile *up* to remove it from the running apps list, then tap on its icon to load it again).

          • *Fonts*: instead of havi...

        • Working with Fonts

          Some fonts may not work between platforms.

        • Limitations

          Scrivener for iOS contains a much smaller feature set than is available in the macOS and Windows versions. This is mainly on account of the limitations of the operating system that runs on iPhones and iPads. The good news is that even though you may not be able to see and work with some of the more advanced aspects of Scrivener, they will be preserved. For example, if a binder item has keywords assigned to it, you won't be able to see or user the keywords on iOS, but if you edit that item, upon ...

        • Options

          Cross-reference to relevant appendices.

        • Linux Support

          Since the Linux version was discontinued, it will be unable to sync projects that have been edited on the go. We recommend running Scrivener for Windows under something like WINE or a virtual machine, to at least sync the changes in. Once the changes have been synced, the project could be edited with the last Linux version made available, if you prefer.


      • Synchronised Folders

        You may at times need to share bits of text from your document in such a way that other people can edit them using traditional text editors or word processors, or even as a way of making your text available while on the go.

        <$include> NOTE// Message about getting a sync folder working with 3.x

        This technique uses simple files and folders on your disk, making the system well-suited for a wide variety of uses, such as the following common examples:

        • Integrating with various cloud sharing ser...


        • Setting Up Folder Sync

          Configuration and explanation of sync sheet


          • Preparing the Folder

            The first thing you will need to do is select a new, empty folder on your disk. Scrivener will manage all aspects of this folder from this point forward; it should be used for no other purpose. Click the Choose... button, and point the file browser at the location where you would like to host the sync folder. Keep in mind that the folder you create will need to be dedicated to this Scrivener project, and so must be initially empty. **Never select a folder which has already been used to synchroni...

          • Options

            Sync the contents of the Draft folder

            : Enabled by default, the contents of the "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's text files (only) up-to-date with this option. This also activates the settings in the "Import" section, below.

            Sync only documents in collection

            : The project must have at least one collection (other than Search Results) in order to enable the option. When enabled, onl...

          • Import

            This section will be disabled unless the Sync all other text documents in the project option is enabled, above. The setting determines where new files you've created within the "Notes" subfolder will be imported into the binder (the "Research" folder by default).

            The dropdown will only display eligible folders and file groups, unless you disable the Only show containers in destination list option, below the dropdown.

          • Format

            In the final section of the sync folder window, we can set up how the files themselves will be created and read from the sync subfolders. You could set the draft folder to use Fountain format for screenplays, but leave your research and notes as RTF files, for example.

            There are four file formats available, and depending on your intended purpose, selecting the right option will be important:

            • *Plain text (TXT)*: The resulting files will be standard, plain-text files in the UTF-8 encoding. If...


        • Usage

          Usage notes for synced folders. How to use the feature, from initial generation of the sync folder, to round-trip return of files back into the project.


          • First Run

            Once the "Sync" button is clicked, Scrivener will export a file for every item set to be synced. The feature will create one or more of the following three subdirectories within the folder to store the synced files:

            1. "Draft" - stores documents contained inside the project's Draft folder. New files placed into this folder will be imported into the very bottom of the draft folder in the binder when syncing them in.

            2. "Notes" - stores text documents contained elsewhere throughout the project....

          • Working with the Sync Folder

            This is the most open-ended part of the process, given that we're working with regular old files and folders at this point. They can be edited using other software, shared with colleagues or your editor, posted to a cloud share, or even zipped up into an archive and sent via email. The important ingredients are the modification dates on the files, the file names themselves and their organisation into folders.

            Can I change the names of the files?

            It is very important to never change or remove th...

          • Bringing Changes Back to the Project

            The default setting, Check external folder on project open and automatically sync on close, will keep the project and the disk up to date with each other automatically whenever you open the project or close it. Beyond this, there are three ways to ask the project to sync with its external folder immediately:

            MISSING_IMAGE:/path/to/gfx/toolbar-folder_sync.jpg

            Add the "Folder Sync" button to the toolbar for one-click syncing.

            • The File//Sync//with External Folder Now menu command.

            • Click on ...

          • Working with Updated Documents

            MISSING_IMAGE:/path/to/gfx/sync-comparing_changes.jpg

            Comparing synced changes using snapshots.

            In [](#sync-comparing_changes) we see a few different features coming together to create one example workflow for reviewing changes:

            *Updated Documents list*: this is a listing of every binder item that was changed during the synchronisation (it will always appear automatically when applicable). It temporarily replaces the main binder until you click the CloseButton button on the left side of the si...

          • Disabling Synchronisation

            If you merely wish to disable syncing for a time, the entire feature can be rendered temporarily inert by unchecking the Sync files in this project with external folder option at the very top of the folder sync settings window.

            To sever the connection with between the project and the sync folder permanently, click the Clear button in the setup screen, alongside the area where you would choose where the sync folder resides. You will be presented with two options:

            Clear Only

            : The folder that th...


        • Tips for Working with Synced Folders

          A few guidelines and tips for safe sync folder practices.


          • Managing Automatic Snapshots

            When Scrivener creates snapshots it will use standard naming conventions. If Scrivener makes a mistake and syncs text in the wrong direction these snapshots can be used to restore that text where needed:

            • "Pre-Sync External File Version": when the copy on the disk is scheduled to be updated by revisions from the project, this snapshot will contain the contents on the disk prior to doing so.

            • "Pre-External File Sync Overwrite": this snapshot records the state of the text from the binder item...


            • Getting Rid of Old Snapshots

              You can use [the Snapshots Manager] to periodically purge these automatically generated snapshots out of the project once you are done with them:

              1. Use the Documents//Snapshots//Show Snapshots Manager menu command.

              2. Search for "Pre-Sync" or "Pre-External" in the upper left hand corner of the snapshot manager.

              3. Follow the provided instructions for [deleting snapshots with the manager].


          • Limitations

            There are a few general limitations that you should be aware of:

            • This is a *content based* tool. It exports files with the text content of the binder items you select for syncing. Only the main text area will be exported, no meta-data such as notes, synopsis, keywords and so forth will be included.

            • In extension of that concept, this is not a tool for implementing binder-level changes. The sync folder creates a flat list of files containing the content of those items, from wherever they ma...


            • Rich Text Limitations

              When using the RTF sync format, you can expect zero to minimal loss of formatting when used in conjunction with a good word processor. There are a few features in Scrivener that have no comparison in RTF and will be lost when editing the file:

              • Inline annotation and comment colour cannot be restored from external files. 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 t...

            • Plain Text Limitations

              Since it is impossible to convey formatting in plain-text without some sort of visible mark-up, Scrivener takes steps to protect as much of your formatting as it possibly can by only swapping in edited paragraphs rather than the entire file.

              • 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 bot...


        • Folder Sync Settings

          Most of the settings pertinent to this feature are project-specific, and thus located within the panel brought up by the File//Sync//with External Folder... menu command.

          There are also global preferences available that impact the basic functioning of this tool. They are found within the [Sharing !preference pane, under the "Sync" tab][sharing - sync].


  • Writing

    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 collabo...


    • Writing and Editing

      Overview of using the text editor.


      • (Notes on macOS text engine)

        Scrivener uses the standard macOS text editor, and therefore all of the features of its rich text editing system (which are showcased in Apple's TextEdit application) are available The only exception to this is that in Scrivener, you are not allowed to paste media files, such as video clips, into the text. This is because of a bug in macOS that can cause crashes or strange behaviour when a media file is contained inside a single piece of text that is being viewed in two panes, such as Scrivener'...

      • 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, however, 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][Compiling the Draft], but suffice to say that you can work in one font, say the NOTE//WINDOWS// check out Windows default font once it...

      • Editing Basics


        • Caret Movement and Selection

          [][Character Selection Shortcuts] shows the shortcuts for changing the current selection. To simply instead move the current insertion caret position, omit the shift key where applicable.

          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 unw...


          • Character Selection Shortcuts

            Action Taken

            Keyboard Shortcut

            Extend current selection in the direction of the arrow key that is used.

            Shift-Arrow

            Extend the selection by word.

            Shift-Opt-LeftArrow or RightArrow

            Extend the selection by paragraphs.

            Shift-Opt-UpArrow or DownArrow

            Select from the caret position to the top or bottom of the editor, respectively

            Shift-Cmd-UpArrow or DownArrow

            Select from caret position to beginning or end of the soft-wrapped line respectively.

            Shift-Cmd-LeftArrow or RightArrow

            Select from the caret...

          • Character Selection Shortcuts

            Action Taken

            Keyboard Shortcut

            Extend current selection in the direction of the arrow key that is used.

            Shift-Arrow

            Extend the selection by word.

            Ctrl-Shift-LeftArrow or RightArrow

            Extend the selection by paragraphs.

            Ctrl-Shift-UpArrow or DownArrow

            Select from the caret position to the top or bottom of the editor, respectively

            Ctrl-Shift-Home or End

            Select from caret position to beginning or end of the soft-wrapped line respectively.

            Shift-Home or End

            Extend the current selection using the mous...


        • Deletion

          Simple character deletion can be performed with the deleteBackspace key to delete the character prior to the cursor. On some keyboards, an additional Del key, that deletes the character *after* the caret position, is provided. On many compact and laptop keyboards, you may be able to use Fn-deleteBackspace to delete the following character.

          Refer to [][Character Deletion Shortcuts] for further shortcuts.


          • Character Deletion Shortcuts

            Action Taken

            Keyboard Shortcut

            Delete to beginning of current word

            Opt-delete

            Delete to end of current word

            Opt-Fn-delete or Opt-Del

            Alternate forward character delete

            Ctrl-D

            Alternate backward character delete

            Ctrl-H

            Delete to beginning of soft wrapped line

            Cmd-delete

            Delete to end of paragraph (not line)

            Ctrl-K

            Transpose letters around caret

            Ctrl-T

            Character Deletion Shortcuts

          • Character Deletion Shortcuts

            Action Taken

            Keyboard Shortcut

            Delete to beginning of current word

            Ctrl-Backspace

            Delete to end of current word

            Ctrl-Del

            Character Deletion Shortcuts


        • Marking Text for Deletion

          If you want to simply mark text for deletion without fully deleting it from the editor, there are a few ways to do so:

          • Using [Inline Annotations], you can select the text you want to delete and mark it as annotated. This turns it into a "comment" that will ordinarily be stripped out of the text when compiled.

At a later date, if you are sure you want to delete the text, you can use the Edit//Copy Special//Copy without Comments and Footnotes menu command (<$custom:shortcut>) and then paste o...

        • Sorting Paragraphs

          Paragraphs can be sorted in ascending or descending order via the Edit//Sort// submenu. This feature requires a text selection in the currently active editor of more than one line.

        • Spell Checking

          Spell checking in Scrivener can be accomplished either as you type or after you are done writing a section. You can toggle this behaviour on and off with the Edit//Spelling and Grammar//Check Spelling While Typing menu toggle (<$custom:shortcut>). The last setting you made will determine whether newly created projects have spell check while typing enabled or not. For example, if you disable spell check in your current project and then create a new one, spell check will be disabled in the new pro...


          • Using the Spell Check Window

            MISSING_IMAGE:/path/to/gfx/editing-spell_check_window.jpg

            The traditional spell check window is useful if you prefer to spell check at the end of the session.

            If you prefer to spell check in one go at the end of a writing session, you might prefer to use [a traditional window](#editing-spell_check_window) for doing so. Use the Edit//Spelling and Grammar//Show Spelling and Grammar menu command (<$custom:shortcut>). (You can also use the Check Document Now command (<$custom:shortcut>), to jump fr...

          • Spell Check Contextual Menu

            With active spell check while typing enabled, when 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.

            When right-clicking on a misspelled word, a few convenience commands will also be provided, for "Learn Spelling" and "Ignore Spelling". These function the same as the analogous buttons described in the p...


      • Editing with Scrivener

        Beyond the basics of text editing, which are similar to many applications, Scrivener provides 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 at hand. You could read this section from start to finish, but it is meant to be a collection of individual nuggets...


        • Scaling Text

          The text of the editor can be scaled up and down visually, without affecting the underlying font size, making it easy to increase legibility or zoom out for a bigger picture. Each split, as well !composition mode, preserve their own independent zoom settings, which are saved between sessions as part of your project settings.

          MISSING_IMAGE:/path/to/gfx/editor-text_zoom_menu.jpg

          The text zoom menu provides handy presets as well as precise control.

          In the standard text editor interface, zoom can ...

        • 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 and dictionary access will be located in the "Writing Tools" submenu. If a selection has not already been made, right-clicking will select whatever word (or words connected by a hyperlink) is under the mouse pointer.

          The Scrivener-specific commands (the appearance of which will de...


          • Text Editing Contextual Menu


            • Look Up 'word'

              When right-clicking on a word, or a selected phrase, the "Look Up" menu item will be inserted at the top. This will open the Dictionary and Thesaurus pop-over that can otherwise be accessed with default system-wide shortcut, Ctrl-Cmd-D when hovering the mouse over a word.

            • Open "Document name"

              When right-clicking on selected text that happens to match one or more binder item titles, a special "Open" command will appear at the top of the menu. If the text only matches one document in the binder then it will be listed as a single command. Click on that to jump straight to the document---no links required---in the current editor. But if there are two or more document titles that contain some of the text you right-clicked on, you'll get a list of items to choose from. Read more about the ...

            • Style

              Offers the same list of paragraph and character styles available from the Format Bar, or main Format//Style// submenu (excluding the management functions found there). Use this menu to quickly apply styles to the selected text.

            • Select Annotation/Footnote

              When right-clicking within an inline annotation or footnote, this option will appear, making it easy to select the entire contiguous range of text that has been marked as notation. When two inline annotations of different colour fields are located adjacent to one another, this command will only select up to the edge of the current colour right-clicked upon.

            • 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). Also available as <$custom:shortcut>.

            • Split with Selection as Title

              Splits the current document into two documents using the 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 [Splitting and Merging Documents]. Also available as <$custom:shortcut>.

            • Append Selection to Document

              Provides a menu of all documents in the binder. Selecting 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] 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. Also available as <$custom:shortcut>.

            • Add Selection to Auto-Complete List

              Adds the selected text to the project's auto-complete list, which can be maintained in [the Project//Project Settings... Auto-Complete List tab][project settings - auto-complete].

            • 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. Read more about this and the highlight feature in [Text Colour and Highlights].

            • Highlight Color

              Provides the text highlight menu, allowing you to select a highlight colour for the selected text, or to clear it.

            • Spelling and Grammar

              : Quick access to spell check tools.

            • Font

              Provides basic character attributes, such as bold and italic, as well as access to the main font chooser.

            • Speech

              Quick access to the Edit//Speech// submenu functions.

            • Writing Tools//

              This submenu contains links to a few handy web searches and the system dictionary and thesaurus application. The current word, or selected text, will be sent to the search engine or reference site of your choice.

              It also contains statistics entries at the bottom of the submenu, displaying the word and character count when an active text selection exists in the editor. If the footer bar is hidden, or you have statistics removed from it, this is an alternative way of getting this information.


          • Hyperlink Selections

            When the selection is entirely or partially within a hyperlink (not an internal document link), then additional link management options will be provided for at the top of the contextual menu:


            • Open Link

              The same action as left-clicking on the link with the mouse. This method is here primarily for accessibility purposes.

            • Copy Link

              Copies the underlying URL of the link, as in many web browsers, so that it can be pasted bare or used in other contexts such as the creation of new hyperlinks, or to import the web page into Scrivener using File//Import//Web Page....

            • Edit Link...

              When a hyperlink is fully selected, brings up the URL edit panel, or if the link is an internal document link, brings up a column browser so you can select a new target for the link, or create a new document that the link should point to.

            • Remove Link

              When a hyperlink is fully selected, this command will appear. Using it will strip the link, leaving the visible text left behind. If you are looking to clean out multiple links from a selection, try the Edit//Unlink command.


          • Images Contextual Menu

            These options appear when right-clicking on an image that has been placed [inline in the text editor][Working with Images]:


            • Reveal in...

              Depending on whether the image is linked to a file on the disk or an item in the binder, this command will refer to "Reveal in FinderExplorer" or "Reveal in Binder".

            • Open in External Editor

              When the image is linked to either the binder or the disk, the image will be opened using the system's default image editor. This will edit the *original file*, since it is merely linked into the editor from either the binder (and thus a file inside your project) or to your disk.

              After editing an image, the changes will not immediately appear in the editor (it refreshes cached thumbnail per session). You can optionally use the "Reload from Original Image" command, below, to show the changes you...

            • Convert to Embedded Image

              Imports the graphic from either the binder or the disk and fully embeds the graphic into the editor. You will not longer be able to access it from these external resources, or load it directly into an editor after doing so.

            • Reload from Original Image

              Automatically reloads [a linked image][Linked Images] from the original on the disk, or in the binder. This will update the cached thumbnail being used to present the image in the editor, but more importantly it will also refresh Scrivener's record of the image's dimensions and resolution.

            • Save As Picture...

              This command is available if you have clicked on an embedded image. You will be provided with a file chooser to specify the location and name of the graphic to save to the disk. This will create a disconnected copy---it won't be linked to the editor. You can also drag images into the binder to create them as files in your project.

            • Scale Image...

              Available to all types of images. This brings up a tool for [resizing inline images and naming them], as well as locating their position in the binder or on the disk, if applicable.


          • Document Link Selections

            When right-clicking on document links, that is internal links pointing to another resource within the same project, a few additional commands will be added to the menu.


            • Open Document Link In//

              When right-clicking on an internal document link, offers three choices for opening the link: "Current Editor" replacing the current text file with the linked resource, "Other Editor" which opens a split if necessary and loads the target there, and "Quick Reference panel" as a new window.

              If you find yourself consistently using this menu to bypass the default behaviour of loading links in the other editor, consider changing the default behaviour for clicked links in [the Behaviors: Document Link...

            • Remove Link

              <$include>

            • Edit Link...

              <$include>

            • Link to Document

              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]. When right-clicking on an existing document link, the action will be to reassign the link to the selected target.

            • Update Links to Use Target Titles

              Only appears when one or more document links are contained anywhere within the current selection. This command updates the link text to match the binder titles of the items they respectively link to. Read more about the feature [here][Updating Link Text Automatically].


          • Tables Contextual Menu

            When right-clicking within a table in the editor, additional options will be provided in a "Table" submenu:

            Table...

            : Accesses the table palette, which provides formatting, cell dimension, 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.

            Move Row|Co...

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


        • Moving and Copying Text Around

          The simplest answer for copying or moving text between sections of your binder will often be the venerable Cut, Copy and Paste commands. However you may find a few of Scrivener's additional techniques and optional behaviours to be easier to use in some contexts:

          • Text can be appended to other documents, as discussed in [Text Appending Tools].

          • Within an editor context (including across section boundaries in a Scrivenings session) you can drag a selection of text to another location to move ...

        • Typewriter Scrolling

          You can turn "typewriter scrolling" Typewriter scrolling was originally an innovation of the The Soulmen's *Ulysses*. on for the main editors, Quick Reference panes, and for the !composition mode editor independently via the View//Text Editing//Typewriter Scrolling menu command (<$custom:shortcut>). When enabled, the line you are typing on in the editor will advance only down to the middle of the screen (by default), where it will remain in a fixed position thereafter, rather than advancing all...


          • Typewriter Scrolling Settings

            There are a couple of settings that adjust how typewriter scrolling works, both found in the [Editing: Options !preference tab][editor - options]:

            • It is possible to adjust vertical position of the typing line if you'd rather something other than the middle. Use the Typewriter scroll line option to select from quarters, thirds or the middle.

            • If you would rather typewriter scrolling rigidly adhere to the scroll line rather than adapting whatever line you position the cursor on, then enable ...


      • Splitting and Merging Documents

        For some authors, the ability to expand and contract how detailed your master outline is can be an important part of using one: so there are two tools that make it easy to fashion your outline into as broad or detailed a map as you require, by systematically breaking down longer chunks of text into a more detailed outline, and later merging them back together in a less detailed outline chunk, but a seamless block of words.

        Before discussing how to split and merge it would be useful to also look...


        • Splitting the Document

          Splitting documents into two or more pieces.


          • Splitting Manually

            To split a chunk of text in Scrivener into two pieces you will first need to place the caret at the precise point in the document where you wish the split to occur. 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 (<$custom:shortcut>): <$include> It can be useful to think of splitting in terms...

          • What Splits Off

            Splitting a document is considered to be a text-based operation. The text itself will be split at the cursor or selection, and the Synopsis and Notes content will remain in the original half. Snapshots, also being a component of the document's text, will remain in the original half.

            As for the rest, you can think of splitting as being very similar to duplication. Document attributes and metadata will all be copied into the second half. This includes label colour, keywords, custom metadata, comp...


        • 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, using the Documents//Merge command (<$custom:shortcut>). Unlike the split function, 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 ...


      • Formatting Tools


        • 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 the View//Text Editing//Show|Hide Ruler command (<$custom:shortcut>). The ruler provides a simple indenting and [tab stop interface](#editor-ruler).

          MISSING_IMAGE:/path/to/gfx/editor-ruler.jpg

          Example ruler and paragraph indent settings.

          If you would prefer more precision with these settings, use [the Format//Paragraph//Tabs and Indents......


          • Tab Stops

            Left stops can be created by double-clicking anywhere in the numbered area, 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 mouse pointer as you drag. These will be depicted by type using icons. The four tab stop types available are:

            1. Left: This is the standard type. Text will be left-aligned, with the first character indented to the position of the tab stop.

            2. Center...

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

          • The Tabs and Indents Tool

            MISSING_IMAGE:/path/to/gfx/formatting-tabs_and_indents.jpg

            The "Tabs and Indents" tool allows for precision adjustments.

            If you find working with the ruler tool difficult in terms of getting precise placement, or seeing what you are doing with overlapping close-by markers, the Format//Paragraph//Tabs and Indents... utility provides a place where you can insert measurements directly and even create stock tab stops on an interval.

            All measurements are made from the left edge of the ruler as show...


        • The Format Bar

          The Format Bar provides quick access to common formatting features. The visibility of the Format Bar is toggled with View//Text Editing//Show Format Bar (<$custom:shortcut>). If you are looking for tab and margin controls, the Ruler is available per text view with View//Text Editing//Show Ruler (<$custom:shortcut>).

          Designed to collapse when the editor width is too narrow for the full bar, the first segments [will become clickable icons that open up menus or palettes providing the same level of...

        • Hyperlinks

          Scrivener has broad support for creating hyperlinks in the text, [either to other areas within the project itself][Linking Documents Together], between projects, and of course to other software, files and websites. This section will concern itself with the latter form of linking.

          If you paste a URL into the text editor, in most cases the editor will recognise it as a URL and automatically create a clickable link for you. If you would prefer full control over when links are created, disable this...


          • Adding Links Manually

            Links need not be attached to visible URLs in the text. You can attach a link to any form of text:

            1. Select the text you wish to link from in your editor.

            2. Used the Edit//Add Link... menu command.

            3. Select the type of link you wish to create (if you have the full URL ready to paste, use the No Prefix option).

            4. Type or paste the URL into the text field and click OK.

            This method can also be used to create a fully linked and visible URL in the editor as well. Omit the first step and cal...

          • Editing Links

            To edit an existing link, including one created automatically by the software:

            1. Place the cursor anywhere within the range of a link, or select it completely. If you select only a portion of the link, just that portion will be changed.

            2. Use the Edit//Edit Link... menu command, or right-click and select the command from the contextual menu.

            3. Modify the link settings and click OK.

          • Removing Links

            To get rid of a link, or maybe many links at once (perhaps to clean out links from a web page pasted into the editor or imported as text):

            1. Select the text from which you want to remove links, or right-click on the link you want to remove.

            2. Use the Edit//Unlink menu command, or select the same command from the contextual menu.

            Links Aren't Fully Removed?

            Some browsers and text editors will not only link text, but add formatting to the text that looks like a link as well. If you strip out...


        • Font Palette

          The font palette is a standard tool provided by macOS, and can be toggled with Format//Font//Show Fonts (<$custom:shortcut>). This palette provides full access to the font typesetting engine, including many OpenType features and custom font effects. For basic font changes, [the Format Bar] 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 provide...


          • Managing Font Sizes in the List

            If you would like to add or remove font sizes from the format bar, you would do so to the entire macOS via the system palette:

            MISSING_IMAGE:/path/to/gfx/system-font_size_editing.jpg

            Adding "16pt" as a new font size to the system.

            1. Bring up the Format//Font//Show Fonts panel (<$custom:shortcut>).

            2. Click the GearMenu button and select "Edit Sizes..."

            3. Type in a new font size in points in the New Size field, and click the AddButton.

            4. When finished, click Done.

            You should now see 16p...


        • 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 [Editing: Formatting !preferences tab][editor - formatting], 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...

        • Preserve Formatting

          If you are planning on letting Scrivener's compiler do all or most of the final formatting for you, it can sometimes be useful to preserve ranges of text from the formatting engine. In most cases it will be easier and better to use [styles for this purpose, which have a built-in capability of preserving their formatting][Styles and Stylesheets], but there are a few niche and legacy cases where this tool is used to achieve some effect.

          To specify a range of text for preservation, select the tex...


      • Styles and Stylesheets

        You might say it only a matter of time before a Scrivener and styles got together. Scrivener has always been about separating the way we write from how text is formatted as we work with it. Much of the design is premised on the notion that a creative writing space shouldn't be difficult to modify or forced to look a certain way because of how we need things to look when we print. Stylesheets are a way of making that nebulous goal a little more detailed and practical.

        In the past, Scrivener used...


        • Think Different

          If you are familiar with styles in other word processors, you may have a few habits to unlearn. If you're new, you should read this anyway because you'll want to know how this system was designed to be used, even if this is all new to you. Scrivener's styles have a very similar concept to what you'll find everywhere else---you tag some text with a named format like "emphasis", later decided emphasis should be green, and all the emphasised text turns green---but one very crucial difference betwee...

        • The Basics of Styles

          Each new project you create will have its own stylesheet set up for it. If you are starting from one of our built-in templates or the "Blank" starter, this will mean [a stock set of basic styles intended to get you started with the concept](#blank_styles).

          No doubt if you decide to start using them, you might find yourself wishing something was slightly different. No problem! That's what styles are good at, read on to see how you can update individual styles in your project---and in doing so up...


          • Paragraph and Character Styles

            As in many programs with stylesheets, there are two fundamentally different types of style that get used, though one can have attributes of both:

            MISSING_IMAGE:/path/to/gfx/styles-paragraph_and_character_types.jpg

            The two style types and their combinations, as they would appear in the Format Bar.

            • *Paragraph styles*: chiefly concerned with the overall shape text within the unit of measurement referred to as a paragraph. The indents settings, first-line indents, block indent, hanging indent, ...

          • What About Fonts?

            With the exception of the code block mention above, you have noticed that I haven't used the word *font* yet, which might seem a peculiar omission in a section about styles. Fact is, in Scrivener fonts---and font size for that matter---can be treated as separate from styles. Most of our built-in styles in fact do not mess with fonts at all, leaving that part of the equation up to you. They might change the *size* of the text, or how much space falls around it, but font can be left alone.

            It is ...

          • The Styles Panel

            MISSING_IMAGE:/path/to/gfx/blank_styles.jpg

            The stock starting kit provided to you in every new project---including those upgraded from older projects.

            The [styles panel](#blank_styles) is a convenient floating tool that can be used to apply styles to your text as you write, inform you of which styles are applied to the text you are working on and manage the styles as you go. Open this panel using the Format//Styles//Show Styles Panel (<$custom:shortcut>).

            1. In the upper portion of the pane ...

          • Styles for Authors Using Markup

            Scrivener has always been a tool that contains methods for those who work using markup systems, such as Markdown (and its variants MultiMarkdown and Pandoc), XML, HTML, LaTeX, DocBook and so forth. Of particular use in technical writing, Scrivener's style feature has been carefully designed to not only provide a traditional look and feel for those coming from word processors, but a powerful platform for defining ad hoc semantic types into the editor and then exporting those types into meaningful...

          • Styles That Do Nothing

            Styles do not necessarily have to perform a formatting function in Scrivener. When compiled they can be removed conditionally, used to pass through instructions to the output format (raw HTML to ePub for example) and a few other tasks---but even beyond that they can simply do nothing at all and leave the text in a state where your readers will never even know it was tagged in the first place.

            Consider that marking a text with a named style is a way of tagging text with meaning. You can use form...


        • Using and Managing Styles

          In this section we will discuss the application, creation, deletion and modification of styles to text, and within your project in general.


          • Applying Styles

            While writing, whether you come across a phrase that needs to be styled or you are preparing to write a phrase is a certain style, your usage of the tools will be similar---and familiar from how you might something simpler like changing the font size: you can either do so while typing, changing the way you type at the cursor from that point forward---or you can select some text and only apply those changes within the selected range of text.

            How text is selected will have an impact on how styles...

          • Creating New Styles

            Creating a new style is done by first formatting text in an editor (use dummy text if you do not have an example yet) using the standard formatting tools. Next, select the text (or merely position the cursor within the paragraph for paragraph styles) and then using one of the following methods to create a new style from it:

            • The Format//Style//New Style From Selection... menu command.

            • Click the AddButton button in the footer area of the style panel.

            MISSING_IMAGE:/path/to/gfx/styles-add_n...


            • Name

              This is the title by which it will appear in all menus and the style palette. The name of a style can be important when it comes to copying and pasting between projects, as well as when compiling. Scrivener relies upon names to look for matching styles in these contexts. You can for example cause text tagged as "Glossary Entry" to have its appearance altered by compile settings that modify all text tagged as "Glossary Entry", regardless of the project they came from or the formatting in that pro...

            • Shortcut

              Select a number key to associate with your style. All shortcuts will use the same modifier keystrokes, so all you have to choose is a number. Any numbers already assigned to other styles will be marked as such. You can overwrite an assignment from here, but will be warned when doing so.

            • Formatting

              Here is where you set [the *type* of style][Paragraph and Character Styles] and the scope of what formatting it will store and apply to future text:

              * *Save character attributes*: the type of style will be Character. Only those settings that impact the letters and words themselves will be saved.

              * *Save paragraph style*: the type of style will be Paragraph. Only the settings that impact how paragraphs are displayed will be saved.

              * *Save all formatting*: the type of style will be Paragraph+C...

            • Highlight Box

              In some cases it might be advantageous to draw visual attention to a style, either as embellishment or to act as a crucial signifier in cases where the actual formatting of the style itself doesn't matter or isn't meant to be visible to the reader. Enable the Draw highlight box around text checkbox, and then click on the colour chip to select what will be used as a background fill behind the text.

            • (style highlight box)

              MISSING_IMAGE:/path/to/gfx/styles-highlight_box.jpg

              Highlight boxes can visually accentuate styles in the editor, and are particularly useful if the style itself being used for something other than formatting.

            • Next Style

              This final option determines what style will be set when ending the current paragraph. The default is "None", which will return you to default un-styled text. You might for example wish to have the Block Quote style transition into the Attribution style on the following line.

              It is also possible to select the same style you are creating with the "This Style" option. This will be useful for styles that tend to span more than one paragraph or line, such as code blocks.

              Since character styles nat...


          • Redefine a Style

            Modifying a style follows much the same procedure that creating a new one does. Text is formatted the way you would like the style to look (use dummy text if you do not have an example yet) using the standard formatting tools. Select the text (or merely position the cursor within the paragraph for paragraph styles) and then using one of the following methods to update an existing style:

            • Use the Format//Style//Redefine Style From Selection// submenu to select the style you wish to overwrite.

            ...

          • Deleting a Style

            Deleting a style can be done at any time by using the Format//Style//Delete Style// submenu. This command cannot be undone, but since it does not actually remove formatting from the text, if you do accidentally delete an important style you can re-create it by finding an example in your text, and creating a new one from scratch from its formatting.

          • Removing Styles from Text

            Removing styles from existing text is very similar to what you would do when you are done typing in a particular styled range. The Format//Style//No Style menu command and its shortcut, <$custom:shortcut>, also strips out the style from the selected text or the paragraph.

            • For character styles, you must always select the entire range of text you wish to remove the style from (just like how you would need to select an entire range of italic text to remove italics from it). If you use this comm...


        • Working with Styled Text


          • Selecting and Searching for Styles

            Marking text as styled is useful for many reasons, chief among them the ability to locate bits of text that have been tagged under a particular style. There is of course great appeal in easily walking through every figure caption in your dissertation or every block quote in a biography.

            The styles panel itself has several of these tools gathered together into one place, by either right-clicking on a style and using the "Select All Text with Paragraph Style" command (which selects all ranges of ...

          • Copying and Pasting Styled Text

            When working within the confines of one project, the matter of copying and pasting styled text is of so little consequence it hardly bears mention. It will happen, and you don't have to worry about styles getting lost between individual chunks of text.

            What will require more attention to detail is when copying text *between projects*. The first thing to know about this process is that Scrivener will use name matching, not formatting, to look for style assignments within the same type (paragraph...

          • Importing from Other Word Processors

            In general, importing documents from other word processors that have stylesheets will follow the same rules as described for copying data between Scrivener projects. The software will be looking for styles by their names, and thus you will need to have styles already created in the project's stylesheet by those names in order for them to import.

            Not every document format may have the same results. If you find some styles are not importing as expected, try another format like RTF, ODT or DOCX.


        • Copying Stylesheets Between Projects

          If you need to copy a stylesheet from one project to another, the Format//Style//Import Styles... menu command (also accessible from the GearMenu button in the floating styles panel) will be your way of doing so.

          • Styles that are identical in both name and formatting will be ignored.

          • If the project you are importing from contains styles that have the same name but different formatting, you will be asked how to handle the import:

          ⁃ Keep Existing Styles: no styles as defined in the current ...

        • (table and list limitations)

          Styles, Tables and Lists

          Owing to technical conflicts that exist between the style system and how lists (using bullets or numbering) and tables are constructed, paragraph styles should not be expected to work properly within them, or to modify how how they work. Character styles will work as expected within table cells and list lines, so if the intention is to modify the character formatting for an entire cell, you would be better off using character styles for such things as table headings or k...


      • Working with Images

        While images themselves cannot be placed into the draft folder as binder items, you can insert an image into the text either by dragging an image file in from the FinderWindows Explorer; dragging an image document in from the binder, outliner or corkboard; or by selecting 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 i...


        • Resizing Inline Images and Naming Them

          To resize the inline image, double-click on itright-click on it, and select Edit Image.... This will bring up the image scaling panel. Use the controls to shrink the image or increase its size, and then click on OK. Unchecking "Lock aspect ratio" allows you to adjust the width and height independently and therefore distort the image. Clicking Cancel restores the image to its former size and returns you to the editor. The Reset button will return the image settings to the state they were in when ...

        • (embedding images with iOS)

          Embedded Images and Scrivener for iOS

          If you intend to use the iOS version of Scrivener to edit your project, then it will be best practice to make use of one of the image linking techniques described in the following sections. The text editing engine provided by iOS is incapable of working with high-res graphics (greater than 72 DPI), and will drop the resolution of them when editing text that contains such images. Be aware that "resizing" images in Scrivener by definition changes its DPI, and ...

        • Saving an Image Out of the Editor

          To save the image to the disk, right-click on the image and select "Save as Picture..." from the contextual menu. This option will not be available with a linked image, which naturally is already on the disk---instead a command to "Reveal in FinderExplorer" will be provided.

          You can also simply drag and drop an image into the binder to create a copy of it in your project.

        • 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 documents 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 (on...

        • Linked Images

          Linked images are useful when the actual graphics in your project text are incomplete or placeholders for larger, production-ready graphics---or if you just wish to maintain your image repository external for the purposes of ongoing edits and batch processing. 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 th...


          • Resizing Linked Images

            Just as with embedded graphics, you can [adjust the display size of the image][Resizing Inline Images and Naming Them]. It is important to know that doing so will alter the original image's meta-data on the disk. The image will not have its pixels touched, but its print size information will be altered. If it is important to you that Scrivener not adjust the original files then do not use the resize tool in the editor, or consider using [image placeholder tags], where sizes can be specified as c...

          • Updating the Image from the Disk

            For increased performance, Scrivener uses a cached version of your image when you first view it (or initially link to it) within a session. Whenever you re-open the project, this thumbnail will be updated with the current image on the disk automatically. However if you have updated an image on the disk and wish to see the results in your editor without reloading the project, right-click on the image and select the "Reload from Original Image" menu command.

            This will also reset Scrivener's recor...

          • Renaming an image on the disk

            You can of course freely rename images whenever and however you like, but you will find that upon reloading the project at a future point, the links will have broken. A technique for safely renaming an image name while preserving the link is to do so from within Scrivener:

            1. Double-click the linked image to edit it.

            2. Click the Change... button to bring up the file chooser.

            3. Right-click on the name of the image (which will be selected automatically for you) and select the "Rename" option...

          • Utilising Links on Multiple Computers

            Those familiar with the use of linked resources will already know that using links means that the position of those external resources must remain stable, in order for the host program (Scrivener in this case) to maintain a connection with them. If the files are moved or renamed, the link breaks and you will need to manually update them. This means that in most cases, links will only work on one machine, since the full path name of a file tends to vary, given that it includes the name of the com...

          • Fixing Broken Links

            If the name or position of the image changes on the disk then the link to it in the editor can become broken. A broken image will fall-back to a warning message, printed in red highlighted text, with a special token identifying it as an image link, and the expected path to the image printed following:

            MISSING_IMAGE:/path/to/image.jpg

            The simplicity of this system means that if you fix the path to the image right in the text editor and the reload the project it will link back up. This also mea...

          • Images Linked to Binder Items

            You may at times wish to use linked images to keep your text files trim rather than bloated with large files---but at the same time not have any need for the advantages using the file system gives you, and would prefer not to have to deal with the disadvantages, such as fixing broken links or having to contend with issues between synced systems across multiple platforms.

            Linking to images in your binder is the solution to this problem. The graphic is not placed into your text directly, keeping ...


        • Image Placeholder Tags

          It can at times be desirable to not include the graphic in the source text at all, but rather to specify its name or file path, using text, similar to how one would link to an image in a web page or forum post. You can also specify the dimensions of an image precisely, using text, which is important for getting them right the first time, if you do not intend to polish off the compiled document after compiling. Using tags allows you to bring images into areas of the document that otherwise wouldn...


          • Image Identification

            NOTE//WINDOWS// this will no doubt need some heavy editing once there is something to test on Windows. The image must be specified either by its imported name, as displayed in the binder, or by a valid system path to the image's location on your computer. Path names can be relative to the location of the Scrivener project, so if the graphics and the project are stored in the same folder, you would only need to declare the path as 'image_name.png' for it to work. You can also use the UNIX shortc...

          • Specifying Image Width and Height

            The width and height of the image is an optional value, declared in points. If you have already sized the graphics correctly in accordance with your printer's specifications and output quality, then you will not need (or indeed want) to change the image size using Scrivener. However if you are not concerned with pre-sizing the images and just want to let Scrivener handle them for you, you can specify the width and height of the image in the placeholder tag, to instruct the compiler to resize it ...

          • Tips for Usage

            Here are some ideas for how this feature can be used, as well as some handy tips for common uses.

            • *Using Replacements to Change Images*: use of [replacements in the compiler][compile - replacements] will be evaluated prior to any images being included. That means you could use the feature to scan for the placeholder tag and remove it from the document, or perhaps change the path of the image to something else, which could be useful if you have two different groups of images, one optimised fo...


        • Images for Output


          • Handling Print-Ready Images

            General tips for how to handle large images, and when not to try and handle them in the editor itself.

          • Images and Compiling to Markup

            When using Web Page (HTML), or any of the MultiMarkdown and Pandoc compile formats, inline images (and linked images for that matter) will be converted appropriate syntax in the text and exported into the compile folder along with the text file itself. For formats that end up combining the source files into a bundled format like WebArchive or DOCX (via Pandoc), these intermediate files will be handled in temporary folders and won't appear in your output folder.


      • Using Snapshots

        The theory behind a Snapshot is very simple, and similar in principle to how you might use the "save as" feature in a traditional text editing program.

        As with many modern programs, Scrivener saves automatically as you work, whenever you pause for a couple of seconds. In comparison to the older method, where one loads a file and saves periodically, you lose the benefit of being able to work "off the disk" for a while, choosing when to save and when to revert to what has been saved.

        Snapshots h...


        • Creating Snapshots

          While working on a document, there are three easy ways to snapshot it for future reference.

          That aside, it is simple to quickly snapshot multiple documents:

          1. Select the documents you wish to snapshot in the binder sidebar, corkboard, or outliner.

          2. Use the Documents//Snapshots//Take Snapshots of Selected Documents menu command (<$custom:shortcut>) to create a snapshot for each selected binder item.

Snapshots can later be accessed in the Inspector pane. You can jump straight to them with ...

        • Managing Individual Snapshots

          Existing snapshots are all managed in the inspector pane on a per document basis. To jump to snapshots, click the button with the camera in the inspector tab list or use the Navigate//Inspect//Snapshots menu command. More details on the functions available in the inspector can be found in the documentation on the [Snapshots Tab].

        • Viewing Snapshots in the Editor

          It is possible to load snapshots as read-only text into the main editor splits. There are a few ways of doing so:

          • Drag the snapshot you wish to view into the header bar for the editor split or copyholder you wish to load it in.

          • Right-click on the header bar icon menu for the item whose snapshot you wish to view, and use one of the "View Snapshot in Other Editor" or "View Snapshot on Copyholder" commands. The submenus for these will display a list of available snapshots to load.

          When you'...

        • Comparing Changes in the Editors

          The comparison feature lets you analyse the differences between versions of your text. There are several places that allow for comparison. Chief among them is within [the inspector's Snapshots Tab itself][Comparing Changes with Main Text], where most of this capability and adjustments to its behaviour will be documented.

          As noted previously, you can load snapshots straight into one of the split editors, or one of their copyholders. It is also possible to use these locations for comparison, mean...

        • The Snapshots Manager

          While being able to click on any chunk of text in the binder to examine its history is undeniably useful, a tool that can examine *snapshots* themselves, as entities across all files within the project, can greatly enhance your overall sense of how the text as a larger whole has evolved, and can make pruning old and unwanted snapshots a snap.

          MISSING_IMAGE:/path/to/gfx/snapshots-manager.jpg

          The Snapshots Manager makes it easy to browse versions across documents.

          To bring up the manager, use th...


          • Renaming Snapshots

            You can easily rename snapshots right in the Snapshot Manager. Double-click on the name of the snapshot, or press Esc to toggle editing mode. When you have finished editing the name, click elsewhere to confirm or press !Return.

          • Comparing and Rolling Back Changes

            All of the capabilities available to you in the Snapshots tab of the inspector are in the manager as well, along the footer area of the snapshot content viewer itself. For documentation on how to use these specific features and settings, refer to the following:

            • [Rolling the Text Back]: for setting the selected snapshot to be the text used for the main item in the binder.

            • [Comparing Changes with Main Text]: for comparing two snapshots together, or one snapshot with the current state of the...

          • Searching for Snapshots

            Above the snapshot list sidebar is a search tool that you can use to quickly locate snapshots by their snapshot name, the name of the binder item they are associated with or even by fragments of text within the snapshot itself. The search tool is fairly simple, and has a few rules and capabilities to be aware of:

            • The mode of this form of search will always be "exact phrase", meaning the text you type in must be found in the order you type it in, case-insensitive.

            • You do not need to speci...

          • Finding Where Snapshots Came From

            If you locate a snapshot you are interested in, but aren't sure where its parent item came from in the binder:

            1. Select either the snapshot in question or its associated parent in the sidebar.

            2. Click the GearMenu button in the sidebar footer.

            3. Select the "Reveal in Binder" option, or use the standard <$custom:shortcut> shortcut.

            The result of this behaviour is identical to how "Reveal in Binder" works in general, though leaving the project window in the background---meaning if it is n...

          • Exporting Snapshots to Files

            To save your snapshots as individual files to the disk:

            1. Select all of the snapshots you wish to export using the sidebar.

            2. Click the GearMenu button in the sidebar footer.

            3. Select the "Export Snapshots..." command.

            4. If more than one snapshot has been chosen, you will be asked for the name of the folder you would like to insert them within, and the location for where that folder should be saved.

Otherwise, you will be asked to name the snapshot itself that you selected.

            5. Choose ...

          • Deleting Snapshots with the Manager

            In addition to deleting individual snapshots (which you can also do right in the inspector), one very useful capability of the snapshot manager is the ability to purge many snapshots from across multiple documents at once. This becomes particularly powerful when combined with searching---for example locating and deleting all snapshots from a year ago or earlier.

            1. To select multiple snapshots, you can use the traditional CmdCtrl and Shift keys to add or remove from the selection individually ...


        • Automatically Created Snapshots

          There conditions where snapshots can be optionally created for you. Automatic snapshots will name themselves logically, to indicate why there were created. This kind of consistent naming scheme also makes it easier to clean them up later, using the snapshots manager.

          • *Synchronisation*: [Synchronised folders] are set by default to take snapshots of any documents that are changed (either on the disk or in Scrivener). When this sort of action is taken, the snapshot will be titled appropriately ...


      • Auto-Completion

        Main article.


        • 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 macOS' built-ina customisable substitution engine. Most of these can be set in the [Corrections !preference pane][prefs - corrections].

          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.

        • Custom Auto-completion

          Completions can be requested by typing in a little bit of the word and then using the keyboard shortcut, <$custom:shortcut>, to trigger the Edit//Completions//Complete menu command. If you would prefer Scrivener present completions automatically as you type, set the Suggest completions as you type option and make sure In script mode only is disabled, in [the Corrections !preference pane][prefs - corrections].

          Each project has its own custom auto-completion list. There are two ways to add items ...

        • 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, <$custom:shortcut>, or by using the Edit//Completions//Complete Document Title menu command. A list of all the titles that start with what you have typed in so far will be presented (only text up to the closest space will be considered, so you must issue completion with the first word of the title alone). You can use the arrow keys...

        • Scriptwriting Auto-Completion

          Scriptwriting mode, by default, engages a more aggressive auto-completion method that scans as you type and looks for completions, matching the behaviour of most scriptwriting programs 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 suggested within the element you are currently typing in. For example, "MOMENTS LATER" will appear whilst typing in a Scene Heading element, but will not app...


      • Editing Multiple Documents

        Documentation for the Scrivenings feature.


        • Viewing Multiple Texts as One Document

          Scrivenings mode is, like corkboard and outliner view modes, another way to work with multiple selections of documents. Editing more than one document in the editor can be as simple as clicking on a folder and using one of the following methods to switch to Scrivenings view:

          MISSING_IMAGE:/path/to/gfx/toolbar-group_views-scrivenings.jpg

          The Scrivenings group view mode button in the toolbar.

          • Click the left-most icon in [the Group View toolbar button set](#toolbar-group_views-scrivenings).

          •...

        • Editing with Scrivenings

          For the most part, editing in Scrivenings mode is just like editing single documents one at a time. 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.

          Can't edit some selected text?

          Some editing commands are prohibited if your selection falls across file boundaries. For example, you cannot overtype or delete such a selection, or perform search and replace operations that would fall across the...

        • Quick Navigation Through Scrivenings

          Scrivener's approach of working with smaller chunks of text to create larger text editing sessions affords it with some unique tools for jumping around within that text. Here are a few ideas for how its many tools can be combined to boost your efficiency while writing in this view:

          The sidebar navigation buttons

          : If you click one of the [navigation buttons][Sidebar Navigation] in the header bar (marked (d) in [](#editor-header-buttons)), and that action will result in movement within the bound...

        • Useful Tips

          Selecting only the section you are editing

          : Use the Edit//Select//Select Current Text (<$custom:shortcut>) command to select the text area for *only* the binder item you are actively editing within the larger session.

          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 chunk of text is to select the section and then use the LeftArrow to jump to the beginning, or the RightArrow to jump to the end....

        • Scrivenings Settings

          As a mode intended to augment creative writing, there are many settings and adjustments that can be made to this view mode:

          • Add the the binder names of items as titles to the text, with the View//Text Editing//Show Titles in Scrivenings menu toggle.

Whether titles are shown is a project setting, and thus if you always prefer them, consider adding that option to your [start project templates][Creating Your Own Templates].

          • [The Appearance: Scrivenings !preference pane][appearance - scriven...


    • Page View

      By selecting View//Text Editing//Show Page View while editing a text document, you can transform the visual presentation of the editor to using a virtual page, which can optionally show two opposing pages at once, with View//Text Editing//Two Pages Across. Since Scrivener does not keep track of actual post-print layout 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....


      • Page View Dimensions

        Page View will by default place your text in a to-scale representation of your project's print and margin settings, found in the File//Page Setup... dialogue---which is incidentally what most compile formats will defer to for those file types that use page dimensions.

        It is possible for compile settings to override page setup (for example, the built-in preset designed to emulate a standard paperback novel), so if you would prefer page view always use your compile settings, use the Base page vie...

      • Tips for Accuracy

        When used in conjunction with precise 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...


    • !Composition Mode

      Full article.


      • The Control Strip

        The control strip is a slide-away panel along the bottom of the screen. It contains various controls for changing appearance settings or providing navigational and reference tools without having to leave the comfort of !composition mode. All of these settings operate on a project-by-project basis, though you can choose to save most of the appearance adjustments you make as your defaults for new projects, in [the Appearance: Composition Mode: Options tab][appearance - composition - options].

        It ...

      • Floating Inspector Panel

        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 panes. 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 [Organising with Metadata], and the [Inspector].

        The top selection dropdown will provide you with the following options:

        ...

      • Composition Mode with Multiple Displays

        When using multiple monitors, you can configure Scrivener to target specific displays with the composition view instead of the primary display. This can be adjusted with the Open composition mode on... setting in [the Behaviors: Composition Mode !preference pane][behaviours - composition].

        If you don't mind taking a performance hit, you can choose to leave the main Scrivener interface visible on another display. Disable the Hide main window in composition mode setting to keep it from disappeari...

      • Customising Appearance

        There are a great many colour settings available for adjusting !composition mode. You will find them all located in the [Appearance: Composition Mode !preference pane][appearance - composition mode].


        • Using Background Image and Textures

          The default solid background colour can be replaced with an image of your choosing, using the Composition Mode Backdrop setting in [the Project Settings: Background Images tab][project settings - background images]. 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 th...


    • Annotations and Footnotes

      Introduce and explain the variety of ways in which a document can be marked up.


      • Inline vs. Linked

        A list of pros and cons for each method.

      • Inline Notation

        Scrivener sports an unusual method for taking notes and indicating footnotes, by placing them directly into the main text stream itself. If you've ever used the LyX document processor, you may recognise the concept as this was the source of inspiration for Scrivener's inline annotation feature. 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 ...


        • Inline Annotations

          Inline annotations are a way of marking text so that it will not appear (by default) when you compile.

          MISSING_IMAGE:/path/to/gfx/editing-inline_annotations.jpg

          Annotated text will appear red with a "bubble" around it.

          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). The provided [example](#editing-inline_annotations) exhibits a fe...


          • Tables and Lists Don't Mix

            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 place tables or bulleted lists inside annotations or footnotes in Scrivener, when you export these elements will be stripped out.

          • Changing Annotation Colours

            Inline annotations can have their colours changed independently. This makes for an easy way to create "types" of notes that you can spot at a glance. High priority notes might use bright red, while deleted text could use light grey. To change the colour of annotation:

            1. Placing the cursor anywhere within the annotation you wish to colour, *or* select only a portion of the annotation to effectively split it into two adjacent differently coloured annotations.

            2. Use the Format//Color... menu c...

          • Want to get back to default red?

            In the direct-sale version of Scrivener (sorry, the Mac App Store doesn't allow software to install colour palettes), bring up the system color tool with Format//Color... and click on the "Color Palettes" tab. From the dropdown menu at the top, select the "Scrivener" set. You will find an "Red Annotation" swatch in this palette.


        • 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 annotations are meant to be omitted when compiling or printing (though do not have to be) whilst footnotes are typically placed somewhere on the page or at the end of the document or ebook---precisely how is determined by the compile format you use, though there are also considerable options available for styling footnotes ...

        • Referenced Inline Footnotes

          For those that prefer the concept of keeping footnote content within the main editor, where it can be easily searched for and edited without mouse clicking, 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 that works in a cross-referencing manner (similar to how Markdown-based footnotes work, if you are familiar). To use this method:

          1. Create an inline footnote in the intended location of the marker within the text body, a...

        • Finding Inline Notation

          Scrivener provides tools for stepping through your entire project, searching for annotations and footnotes. Read more about this feature in [Find by Formatting Tool][fbf-inline].


      • Linked Notation

        Creating and reviewing linked notation is made very simple with Scrivener's innovative sidebar approach. Unlike methods that use the margin areas beside the text to display the note, or typesetting driven methods that attempt to display a footnote exactly as it will appear in print, linked notes combine the power of placing meta text outside of the base text, with a stack of notes that is ordered as they appear in the document, does not otherwise reflect the spatial distance between notes; a foo...


        • Note Highlighting and Accessibility

          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 highlight around the word, making it easy to spot the location of notes as you scroll through your text

          2. For footnotes, a grey highlight 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 app...

        • Creating Linked Notes

          To create a new note, either:

          1. Select the text you wish to notate and then invoke the appropriate menu command or keyboard shortcut. Linked comments and footnotes cannot be placed atop other kinds of linked text. You should either use inline annotations or contrive some way to place the comment alongside the hyperlink.

          ⁃ To make a comment, use Insert//Comment (<$custom:shortcut>).

          ⁃ To create a footnote, use Insert//Footnote (<$custom:shortcut>).

This approach is quite useful for comment...

        • Deleting Linked Notes

          Deleting notes can be accomplished by selecting the note(s) in the inspector and then using one of the following methods:

          • Click the DelButton button in the header bar.

          • Click the small CloseButton button in the top-right of each note you wish to delete.

          • Use the delete keyShift-Del on your keyboard.

        • Moving Notes to New Anchor Text

          There are three ways to move a note from one text anchor to another:

          1. 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 to the selected text: "Move to Selection".

          2. Alternatively, drag and drop the note from the Inspector pane into the text where you wish it to appear. When using t...

        • (see also)

          \par \vspace{1em}

          Refer to the documentation on the inspector's [Comments & Footnotes Tab], for further information on working with the notes themselves in this area of project window.

        • Popup Notes

          By default, and has been described thus far, if you click on a comment or footnote highlight range within the text editor, the inspector will be opened if necessary, the tab switched to "Comments & Footnote" and the specific note you clicked on scrolled to and expanded so that it can be read.

          An alternate method for interfacing with your notes is in a popup, [right over the highlighted text you clicked on](#comments-popover_form). Popups will always be used when clicking on notes from within th...

        • Linked Footnotes

          As with inline footnotes, linked footnotes will by default appear with a grey background, and will likewise appear grey in the inspector and in popup form. Footnote colours cannot be individually changed, though you can adjust the global colour used by the software with the Inspector footnotes setting in [the Appearance: Textual Marks: Colors !preference tab][appearance - textual marks].

          MISSING_IMAGE:/path/to/gfx/footnotes-anchor_position.jpg

          Where the grey highlight terminates determines the ...


          • Footnote Highlight Style

            If you find the default appearance of footnotes too heavy for the quantity of footnotes in use, there is an alternate way of working with them that will be more familiar to those accustomed to how word processors typeset in the manner they will be printed. This method will place a simple footnote marker [after the current selection, or current word, rather than highlighting the relevant phrase](#footnotes-marker_style).

            MISSING_IMAGE:/path/to/gfx/footnotes-marker_style.jpg

            Footnote markers dema...

          • Compiled Footnote Numbering

            MISSING_IMAGE:/path/to/gfx/inspector-footnote_numbering.jpg

            Footnote numbering in the inspector is based upon the previous compiled order.

            Since footnotes can be scattered across hundreds of files throughout the draft, Scrivener does not number footnotes as you create them. Instead, they will counted as the software compiles your draft, and you can choose to have these numbers displayed in the inspector list, as depicted in [](#inspector-footnote_numbering).

            To enable footnote numbering, use t...


        • Finding Linked Notations

          Scrivener provides tools for stepping through your entire project, searching for inspector comments and footnotes, either in general or to find only those with specified text in them. Read more about this feature in [Find by Format and Text][fbf-comments].

          It is also possible to use the [standard text search tool][Document Find and Replace]. With the inspector open, searches will be highlighted in the sidebar for you, and the replace function will also search and replace matched text in any app...


      • General Usage Tips for Notation

        These tips apply to both inline and linked notes, whether they be for your own internal commentary or for the reader, in the form of footnotes or endnotes.


        • Stripping Out All Notation

          To clean out all notation from the text you are working with:

          1. Select the text you wish to clean out notes from.

          2. Use the Edit//Copy Special//Copy without Comments and Footnotes menu command (<$custom:shortcut>).

          3. This will leave the original text selected in the editor, so if you wished to replace it you could paste immediately following the above command. The cleaned text can of course be pasted anywhere you like.

        • Resetting Linked Note Formatting

          Both comments and footnotes allow formatted text within them. This means you can apply whatever formatting you wish into these, and they will be exported with this formatting when you compile (assuming your compile settings have not overridden footnote font and size). Consequently, adjusting the [Editing: Formatting !preferences tab][editor - formatting] for notes will not immediately impact them, as this might wipe out your formatting. You can however, just as with documents, reset the formatti...

        • 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. Within the file output selection dialogue you will be given an option to restrict this 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.

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

          However when pasting into other programs the footnotes and comments will may be converted to a format suitable for where it is being pasted:

          • For most word processors you will get real footnotes that show up at the bottom of the page with numbers linked to them within the text.

          • Pasting into many othe...

        • Pasting Into Word 2011

          If you use Word 2011 or greater, and when you paste footnotes and comments find you get the flattened form, you'll want to enable the Use Word-2011 compatible copy setting in the [Sharing: Conversion preference tab][sharing - conversion]. Do note that when this option is enabled, it will cause native macOS software which would ordinarily use flattened formatted text (like Mail) to omit all formatting entirely, as that flattened version will no longer be provided.

        • Converting Notation Between Types

          Both inline and linked notation can be freely converted between footnote and comment/annotation forms. This can be used to "soft delete" notes you may not need the reader to see, but haven't decided on yet---or to make a note you originally meant for yourself something that annotates the finished copy.

          To convert inline notation:

          1. Select the full range of inline notation you wish to convert in the editor. This can be most easily done by right-clicking on the note and using "Select Annotatio...

        • Document links in notation

          Owing to technical limitations in how inspector notes work, it is not possible to create or store such links within them. Consequently, if you convert your inline notes to linked notes, you will lose any internal links that had been set within them. If you want to use links inside notes, inline notation supports the ability to create document links within them. This is a handy way to "hide" link text from the final manuscript, keeping these links purely for your own benefit.


      • 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 Format//Color... (<$custom:shortcut>), or use the text colour selector in [the Format Bar] 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 alre...


        • Naming Text Highlights

          How to rename highlighters and text colours, and add your own custom colours to the menus.


      • Marking Revisions

        Note on: Format Menu


        • Setting a Revision Level

          There are five revision levels available, and each are accessible in the Format//Revision Mode// submenu. 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. Paste text into the editor using the revision colour with the Edit/Paste and Match Style command (<$cu...

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

        • 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 appropriate revision level from the menu, and then without selecting any text, use the Format//Revision Mode//Remove Current Revision Color menu command. This command will work on the entire text session that is in the active editor, so if you are editing multiple documents in Scrivenings, ensure you wish to wipe out markings for ...

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

        • Changing the Revision Colours

          It is possible to change Scrivener's associations for the colours to use for the various revision levels, in the [Editing: Revision Colors !preference pane][Editing - Revisions].

        • 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][fbf-revisions].


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


      • Formatting a Script in Scrivener

        To format a script in Scrivener, select the format you want to use from the Format//Scriptwriting// submenu, or create a new project using one of the pre-built project templates in the "Scriptwriting" category. When in scriptwriting mode, the top item in the Scriptwriting submenu will be checked and will display the name of the format you are using. This preferred format can be toggled on individual documents with <$custom:shortcut>.

        By default, the standard "Screenplay" format is selected and ...


        • Auto-Completion

          Using auto-complete features with scriptwriting tasks.

        • Dual Dialogue

          If you intend to use the Final Draft FDX compile format for exporting, you can designate text as being dual dialogue by surrounding both bits of dialogue (including the character names) in a Format//Preserve Formatting block. This will not negatively impact the text if you decided to use PDF or another format for proofing, prior to moving to Final Draft. Under normal conditions, it merely informs the compiler that the text in the blue box should not have its formatting altered. Since scripts are...


      • 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 used by most scriptwriting formats, and a few optional settings, it is possible to get very close to an accurate page count, when using [Page View] mode.

        The first thing you will need to do is switch Scrivener's default Scrivenings separator from a divider line to "Minimal", which can be set in [the Appearance: Scrivenings...

      • Importing a Script from Final Draft and Other Programs

        Final Draft Users

        Refer to [the section on exchanging files with Final Draft, version 8 and greater][Working with Final Draft]. 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 the FCF script to the elements in the current script format. For projects that use the basic screenplay formats, this...


        • 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. Im...

        • Importing Plain Text Formatted Screenplays

          A number of screenplay-oriented programs (such as Movie Magic Screenwriter) support what is known as a plain-text formatted screenplay. Since the roots of this format come from the days of the typewriter, it is in fact a simple matter to use nothing more than a raw text file to print a screenplay.

          Looking for Fountain Support?

          Plain text screenplays are not Fountain files. They in fact look just like the screenplays you'll be printing from software like Scrivener or Final Draft. Refer to [Worki...


      • Printing or Exporting a Script

        You can use the compiler 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 Scrive...

      • Working with Final Draft

        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.


        • Importing Formatting from a Final Draft Document

          Optional Step

          For basic scripts or those that will use Final Draft's standard screenplay formatting---indeed, for most screenplays---this step can be omitted, as it is mainly concerned with setting up the formatting for custom scripts. Proceed to the next section if this is the case.

          Whenever you import a script from Final Draft into Scrivener, all of its elements will use the formatting specified in Scrivener's script settings. These can be set up by selecting "Script Settings..." from the Scr...

        • Importing 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....

          2. Go to File//Import//Import and Split... and select the FDX file that you want to import. See [Import and Split] for further details.

          Many features will be retained...

        • Exporting Individual Documents to FDX

          To export individual scripting 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 (.fdx)" as the export format.

          The exported file should open in Final Draft with all features intact.

          More commonly you will want to combine all of the scripting documents in the Draft folder of your project into one FDX file:

          1. Use the File/Compile... menu command.

          2. Select Compile for: "Final Draft (.fdx)" at the top...


      • Working with Fountain

        [Fountain] is a simple markup language (based loosely upon [Markdown]) designed just for screenwriters who need or prefer to work in a plain-text environment (which will be of particular interest to scriptwriters who prefer to write on the go with a mobile device). Fountain helps with composing and editing without losing the individual meanings behind the elements (character name, action, transition, etc.). From the Fountain website:

        > Fountain is a simple markup syntax for writing, editing and...

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

        MISSING_IMAGE:/path/to/gfx/scriptwriting-script_settings_panel.jpg

        All aspects of script formatting and behaviour are established in the Script Settings window.

        To create your own script format mode, use the Format/Scriptwriting/Script Settings... menu command to bring up the script editin...


        • Managing Scripts

          In the bottom left-hand corner of the script settings panel is a dropdown menu entitled Manage.... The menu provides several management functions not found elsewhere:

          Reset to defaults

          : Reverts all customisations that you have made to the Script Settings panel to the Screenplay default. If you wish to revert to a saved script setting, simply select that script from the Format//Scriptwriting// submenu, instead of using this tool.

          Use current font & paragraph settings

          : Attempts to import all a...

        • Format Tabs

          On the right of the panel is the tabbed view containing all of the options used to configure each element in your script format. Select the element from the list on the left, and then select the appropriate tabs needed to make your adjustments. This section will describe the settings available in each of these tabs.


          • Font Tab

            The Font tab provides options for setting the character appearance for the selected element, as follows:

            Font

            : Allows you to set the font family for the current element, and the size of the font (in points) to the right. Scrivener does not use the font to identify elements, so you can change the font here without messing up Scrivener's recognition of script elements. This also holds true for font changes made in the editor.

            : Scrivener comes with [Courier Prime] installed within it, and will...

          • 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 line-height multiplier (single, 1.2, 1.5 or double). Some script formats (such as Screenplay) will have a Fixed Line Height setting, behind the Options button in the lower right-hand corner of this pane. You will need to set the fixed line height to 0pt to disable that feature, before seeing any effect on this setting...


            • Options

              Further options for advanced paragraph settings and compile output options for this element are accessible by clicking on the Options... button in the lower-left corner of the tab.

              Writing direction

              : Set right-to-left, left-to-right or "natural" (detect based on the system language input settings).

              Fixed Line Height

              : In most cases this should be set to the font size in use (12pt by default), to keep lines absolutely consistent, as is expected in most scriptwriting standards.

              : This should b...


          • 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 writing. 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 te...

          • 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 AddButton and DelButton buttons below the list to add or remove new words to the auto-complete list, and double-click on words to edit them. By default, these phrases will be suggested automatically while you type, and the first letters typed in will match a phrase in this list, you will be presented with the auto-complete list. Note that the auto-comp...


      • 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 engine. This means it can be used for a variety of purposes having nothing to do with scriptwriting.

        We have included two such examples in the software:

        • *Interview*: simply alternating boldface and normal formatting, as is common for indicating dialogue between an interviewer and interviewee.

        • *Transcript*: if you ar...


    • Writing Tools


      • 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, depending upon the scope you require:

        • To get detailed statistics and word frequency tabulation for the whole of the draft (that is, the contents of the Draft folder as it will compile given the current settings) or for any documents selected in the binder, use Project/Statistics... and click on the "Compiled" ta...


        • 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 as you work, whether to grow the word count or trim it down. To bring it up, select Project//Show Project Targets or press <$custom:shortcut> to toggle its display.

          MISSING_IMAGE:/path/to/gfx/project_targets.jpg

          The blue progress bar shows overall progress for the project, while the green prog...


          • (Mac features)

            In the Project Targets panel, you will see a Twitter icon, where you can share your progress. Scrivener will automatically generate a short sentence for you, based on any activity (or lack thereof) that has happened during the session. If you write 800 words, then it will select a phrase extolling how much you've written. If you've subtracted 800 words it will assume you have been editing that day. If there is no change, it will assume you have just started working for the day. By default it wil...

          • 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. NOTE//WINDOWS// these are likely both Mac-only options, but I'm leaving them there for now so as to ask about them later. There are a couple of common options available at the bottom of the pane, below the tabbed areas:

            Show target notifications

            : System notifications will be posted when the status of your targets change. For example...


            • Draft Target

              Count current compile group only

              : Off by default, when enabled, only those files descending from the "Compile" group selection designated in [the contents tab of the compile settings area][compile - contents]. By default his will be the entire "Draft" folder, but it can be set to any subfolder, or even to dynamic sets of files such as the results of the last project search you ran, or your current binder selection. In the case of collections and search results, the list of items designated to b...

            • Session Target

              Reset session count

              : There are four available options for how the session counter should behave. The counter can be reset every time a project is closed, you can have it track the time of day and reset it for you, or turn off automatic reset entirely and handle it manually with the reset button.

              * *At set time each day*: the default behaviour is to reset the session target at 1:00 in the morning. This will occur even if you are writing mid-sentence, so if you're a night owl you might want to ...


        • Document Goals

          Each document in your binder is capable of storing its own independent goal, which can be great tool if you're trying to meet ration out how many words different sections of your chapters should have in order to stay below a larger target. To set a goal for a document, click the target icon[on the right hand side of the footer bar](#editor-footerbar).

          MISSING_IMAGE:/path/to/gfx/editor-footerbar.jpg

          Click the "bull's eye" target icon to set a goal for this document.

          When a goal has been set the...


          • Tracking Goals for Groups

            When using Scrivenings mode, a progress bar will be shown if any documents in the session have a goal set. In this mode the progress bar becomes a "total progress" tracker, adding all of the goals and various settings together and using the grand total in the editor against that goal. This can have unintended results if, for example, you set a goal of 200 words for one document but then form a session including it and other files for a total of 1,200 words. It would be better to set goals for ea...


        • Statistics

          Project and text statistics can be called up at any time with the Project//Statistics... menu command (<$custom:shortcut>). This pane has two info tabs and some options:

          1. *Compiled*: with one exception, this will list statistics for a total reckoning of all documents in the Contents tab [of the compile overview's settings area][compile - contents]. The main exception is that by default if you choose only one part of your draft to compile from, this setting will be ignored. Thus you can compi...


          • Project Statistics Options

            RSRCH// see if the Statistics compile option pane has any bearing on this section. I think it just impacts tokens. To access options for how project and selection statistics are calculated, click the "Options" tab in the window. The first group of options, under the "Compiled Statistics Options" heading, impact how the statistics in the first tab of this pane are calculated:

            Count current compile group only

            : Only calculates off of documents that have been chosen in the Content pane of the Com...


        • Writing History

          This feature, accessed via the Project//Writing History... menu command, offers a thorough reckoning of the daily word count progression (or regression as the case may be) on a daily, monthly or combined basis. Even if you do not make use of the session tracking feature, Scrivener will dutifully record your net increase or decrease in word count (both in and out of the draft folder) on a daily basis. This information is then used to provide monthly summaries and produce overall averages.

          The to...


      • Proofreading Tools

        Scrivener has a few tools available to make the process of proofreading your work a little easier. Whether you prefer to generate a static copy of your text, so that it can be read in a different context than where you write, or if you prefer to proofread and edit directly in the same text editor you use to write, we have two different tools available.


        • Cleaning the Editor View

          Being able to proofread and edit in the same environment is convenient, but depending on how you work, you may find some of the tools Scrivener uses to aid in the writing process to be a distraction. There are rulers and toolbars, hyperlinks in the text, comments, style markers and so on.

          1. Firstly, the traditional and longstanding tool available for paring down the interface is [!Composition Mode]. With a simple command you can be whisked away into an environment where all you see by default...

        • Linguistic Focus

          The Linguistic Focus panel can be brought up with the Edit//Writing Tools//Linguistic Focus... menu command (<$custom:shortcut>). This tool will fade out the text in the main editor, leaving only the selected part of speech highlighted. In this way you can highlight all adjectives, adverbs, pronouns or whatever else you wish to focus on, and freely edit the text while in this focussed state.

          Adjust the amount of fade used to dim out unmatched text with the Fade slider, at the bottom of the Ling...

        • Inserting Section Links Into Proofing Copies

          For those that prefer a "hard copy" (even if entirely dealt with digitally), you can have the compiler insert a link pointing back to every section of the binder that was used to compose that copy. If for example you are proofing chapter 18 and it is comprised of 30 some subdocuments, this option would insert 30 hyperlinks into the compiled file, each pointing back to the specific chunk of text that follows the link. Here is a simple way to test the feature and see if it is right for you:

          1. U...

        • Converting Document Links to Scrivener Links

          In a similar vein, you can have all document links in the text converted to external links, meaning when you click on the link it will load that section of text in your original project. This options allows you to carry over your internal link usage to proofing copies, though of course since it relies upon the original project being where it was when you compiled, the method will likely not work once you take the proofing copy off of the original computer.

          For example, a cross-reference from a ...


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

        MISSING_IMAGE:/path/to/gfx/tools-name_generator.jpg

        The name generator:...


        • Managing Your Own Name Lists

          You can add your own custom name lists to the generator. They 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,...

          1. 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.

          2. Click the AddButton button, below the name list area of the Name Generator window.

          3. Locate th...


      • Bibliography Management

        Scrivener offers simple integration with your favourite bibliography or citation manager (such as EndNote, Bookends, Sente or Zotero) for academic work. To set it up:

        1. Open [the General: Citations !preference pane][general - citations].

        2. Click on the Choose... button and use the file chooser to locate the application you use for citation management.

        Once the citation manager has been set up, you can use the Insert//Bibliography/Citations... menu command (<$custom:shortcut>) at any time, ...

      • Using Equations with MathType

        If part of your writing involves the addition or construction of equations, one alternative is to make use of Scrivener's MathType][Design Science] integration to insert editable 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 Insert//MathType Equation. You can also add an optional "Equation" button to the main application toolbar if you use this feature a lot. If you have MathTyp...


    • Using MultiMarkdown and Pandoc

      For those who prefer structural or semantic writing methods to rich text, Scrivener allows you to import and export using two different Markdown dialects: Fletcher T. Penney's MultiMarkdown (MMD) and John MacFarlane's Pandoc. These systems make it easy to generate documents in any number of formats, from clean and modern HTML5 to LaTeX to DocBook to standard word processing files like Word's DOCX or ODT---all while using a simple and easy to type in mark up.

      If you are curious about the process...


      • What is Markdown?

        "Markdown" is an easy to learn syntax created by John Gruber, and the good description of what Markdown is comes from his site, [Daring Fireball](http://daringfireball.net/projects/markdown/):

        > Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, 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, writte...

      • What are MultiMarkdown and Pandoc?

        Markdown's goal is primarily toward Web publishing and similar uses. Systems like [MultiMarkdown] and [Pandoc] arose out of a desire to use a similarly simple syntax for the production of formats more suitable to traditional and electronic publishing. The syntax was extended to include constructions desirable to authors, such as footnotes, tables and better cross-referencing. Of the many formats these systems provide, Scrivener supports:

        • !LaTeX via MultiMarkdown: a well established document ...

      • Getting Started with the Tools

        <$stdOnly> There is very little you need to do to prepare for using MultiMarkdown with Scrivener. It comes pre-loaded with a recent version of it (we tend to lag behind development a bit so as to keep Scrivener's version stable and well integrated). This means that even if you intend to use a more advanced workflow, like !LaTeX, you won't need to install anything extra. You are of course free to, and Scrivener will cross-check your system for you. If it detects installed components, it will grac...

      • Importing Markdown Files

        You can import any existing Markdown documents into Scrivener using the typical methods for importing files---they are simply text files and so there is really nothing special required to get that text into Scrivener.

        But if you would like to have the document split by headings instead of as one long file, use the File//Import//Import and Split... menu command. This command can break up the document so that it is imported into the binder with its heading hierarchy converted to nested documents ...

      • Markdown and Scrivener

        Scrivener's support of this writing method is built with three different approaches in mind:

        1. *Purist*: those that enjoy using the format itself and plan to not make much use of Scrivener's rich text editing features---or intend to use those in an editorial fashion rather than for the purposes of formatting.

Using this method, you would treat Scrivener like a plain-text editor with benefits. You get things like inline highlights, revision modes, annotations, comments and other affordances u...


        • Images

          As you could probably see from [](#markdown-images_and_captions), placing an image in the editor ([using any of the methods Scrivener provides for doing so][Working with Images]) is a simple way of generating Markdown image syntax when compiling. What you couldn't see from the screenshot is that the compiler also produced the image itself into a folder, such that the reference to "bair_island-wetlands.jpg" would link up and be available for any further post-processing.

          Also as with rich text, i...


          • Referencing Images with Document Links

            There may be cases where you might *not* want the image to be in the editor, or maybe you prefer using text syntax to refer to images rather than working around them as visual objects in your text---but you would still like to take advantage of the automation that produces images on output into a folder. While you could use the [image placeholder tag that is available to rich text authors][Image Placeholder Tags], you might as well use native Markdown for its extended syntax:

            1. Write out the ...

          • Cross-referencing Images

            The method Scrivener uses to generate image syntax is conducive to MultiMarkdown cross-referencing. At the time of this writing, Pandoc does not have an automatic method for cross-referencing images. You would need to use the referenced image technique described in the previous section to create the necessary Pandoc syntax to create an HTML ID that can be linked to. It will use the image filename for the Markdown reference handle (or ID), which in turn can be used as an anchor link. All figures...

          • Captions

            When images fall upon their own line, you can supply a caption to them using one of the following techniques:

            • Place the caption within straight (not typographic) double-quotes, or in matched square brackets, on the same line after the image, separating the image from the caption text with a space.

            • Alternatively, place the square bracketed caption on the line *directly* following or preceding the graphic.

            • Use a designed caption style on the line directly preceding or following the image...


        • Lists and Tables

          This is an optional compile behaviour, set with the Convert tables and lists to MultiMarkdown setting in the [compile options for Markdown-based formats][Markup Options], or when the broader Convert rich text to MultiMarkdown option, in that same area, is applied. If you use tables or lists at all in your document, you should probably enable this option, as the plain-text output of these two constructs by themselves will not produce results in line with their original usage in the editor.


          • List Support

            The compiler can generate Markdown style bullet and enumeration lists based on lists found in the text, when the option is applied to do so.

            MISSING_IMAGE:/path/to/gfx/markdown-list_examples.jpg

            Example list formatting converted to Markdown text (invisible characters shown for clarity).

            • All list types found in Scrivener will be expressed as either bullets (using asterisks) or enumeration (using digit + dot formation). For example, a list type in Scrivener using "a. b. c." formatting will ge...

          • Table Support

            Table conversion is relatively simple, and like most aspects of conversion to Markdown, disregards the particulars of formatting and converts the basic structural data expressed by the table. For example, in [](#markdown-tables-merging_cells), we see a table with a grey fill being used to indicate the header row. It is a header row merely by being the first row, and requires no styling to become that way in the output, nor will the styling have any bearing. There are three exceptions where table...


        • Footnotes

          You needn't worry about footnote syntax and identification when using Scrivener to compose MMD or Pandoc Markdown documents. [When using the built-in tools for handling notes][Annotations and Footnotes], the compiler will automatically generate sequenced identifiers for you and place the markers and references where they should go.

          Whether they will ultimately become footnotes or endnotes is not dependent upon anything Scrivener can do, but depending on whether you use inline or linked footnote...

        • General Styled Text Support

          Beyond the types of formatting Scrivener supports for conversion, there is also a freeform capability that opens up the realm of possibilities far beyond what we could anticipate ourselves. Scrivener's stylesheet system, the usage of which is documented in the [Styles and Stylesheets] section, was designed not only for rich text use, but specifically for plain-text writing as well. As a semantic system for tagging text in the editor, it forms a natural coupling with formats like Markdown that ar...

        • Heading Styles

          When the Convert rich text to MultiMarkdown option is enabled , in [the General Options tab of the compile overview screen][compile - general options], it is possible for heading styles that you within the text to be converted to Markdown-style hashmark headings. In most cases you would want to use the compiler's ability to generate Markdown-style headings with Section Layouts, but for cases where smaller documents need to be further subdivided without creating additional outline hierarchy, usin...

        • Hyperlinks and Cross-References

          This is an optional compile behaviour, set with the Convert rich text to MultiMarkdown setting, in the [compile options for Markdown-based formats][Markup Options]. With it, regular hyperlinks to URLs will be converted to equivalent Markdown links, and internal document links to other titled items in the draft will use MultiMarkdown/Pandoc style [cross-referencing](#markdown-hyperlinks).

          MISSING_IMAGE:/path/to/gfx/markdown-hyperlinks.jpg

          Links can be optionally converted to Markdown syntax.

        • Keeping Cross-References in Parity

          One of the things that Scrivener can help you with that otherwise requires manual labour with MultiMarkdown and Pandoc is keeping cross-references to headings correct, even if heading names change. For example if you change the name of a heading from "Browsing the Web with Lynx" to "Browing the Web from the Command Line", you'd have to go back and fix every case in the text where you used \[Browsing the Web with Lynx\]. With Scrivener, consider using its built-...

        • Annotations and Comments

          For most uses, inline annotations and linked comments will serve much the same purpose when using MMD as they would otherwise. They are a convenient way for you to apply notes to your document, or to share and receive thoughts from those who are editing your work.

          If you wish to insert these comments into your compiled document, Markdown itself does not have a convention for inserting comments into a document, but there are a few approaches you can take, using the [Annotations compile format pa...

        • Preserve Formatting

          MultiMarkdown treatment of Preserve Formatting blocks.


      • Compiling

        This section of the documentation will not cover compilation in detail. You should consult the chapter on [Compiling the Draft] for detailed information on the various options that will pertain to you. Most of the MMD options are built into the existing option panes, often replacing those that are not relevant, or changing options as necessary. This section will instead focus on the various formats available, and which compile panes to check for best harnessing Scrivener's compile automation.


        • Compile Folder

          Note on: Cross-referencing Images

        • The "Overwrite preserves other existing files" Checkbox

          In the compile file save dialogue box which appears after clicking the Compile button---for MMD formats which have the potential to produce folders instead of singular files---you will find a checkbox labelled "Overwrite preserves other existing files". This option accomplishes the same as above with one slightly different variation in that you use it to compile to the parent folder containing the compile folder, not to the file *within* th...

        • Plain MultiMarkdown

          While the built-in compile options that go directly to a specific format are incredibly handy, there are occasions when exporting a plain MMD document can be useful and even valuable. The Markdown text format makes for an excellent long-term archival document. It is compact, easy to read, and easy to transform into a variety of formats. It's also very portable, being plain-text. While dropping an archived Scrivener project into a backup system is something you should always do at the conclusion ...


          • Post-Processing and Custom Formats

            One big advantage of the plain "MultiMarkdown" approach We call the compile file type "MultiMarkdown" for simplicity, but it's also capable of producing Pandoc format, and as you will shortly see from this section, literally anything that can be constructed out of plain-text. is its post-processing option. This won't be something you find in the compile overview screen, but instead when modifying or creating your own compile formats. Refer to [the Processing compile format pane][compile - proce...


        • LaTeX

          MultiMarkdown's LaTeX support is premised by the concept of using boilerplate .tex files, rather than describing the document as a single large .tex file. This leaves the base document, the part you've written and that Scrivener will be compiling, clean and focussed on the content. Ordinarily you would need to install and manage these boilerplate files yourself, but Scrivener offers the ability to manage these details for you. It will set the MultiMarkdown metadata up and handle the gathering o...

        • HTML

          Produces a clean, semantic HTML5 document. If you are blogging or using a CMS to publish your work online, this is a great option to use (if the system doesn't take Markdown itself) as the result makes no assumptions of formatting, allowing the site stylesheets to handle that part of the job.

          If you do wish to supply style to your HTML output, you can set the appropriate metadata keys for doing so in either the [Metadata compile format pane, as part of the format's settings][compile - metadata ...

        • Flat XML (.fodt)

          This format can be opened by LibreOffice, and from there converted into any other word processor format you desire. For most word processing workflows, you will be better served by the OpenOffice (ODT) format for MultiMarkdown, or Pandoc's MS Word (DOCX) format. The Flat XML file approach provides a better route for those looking to further automate the output with post-processing.

          When exporting to .fodt, you should use the UTF-8 text encoding.

        • PDF (via LaTeX)

          <$stdOnly> The PDF output choice utilises the !LaTeX typesetting engine, and simply offers a streamlined way of going from Scrivener to a printable PDF in a single step. It is fundamentally identical to compiling as a .tex document, and then opening that document in a TeX editor and typesetting it with no alterations. This method requires a full .tex document to be compiled, not [a partial, or "snippet" content-only output][Exporting in Snippet Mode].

          If the document has no extra requirements, ...


          • Where is it?

            If you do not have a !LaTeX distribution with *pdflatex* installed on your computer in an executable path, then this option will not appear in the compile format dropdown. Scrivener looks for pdflatex in `/Library/TeX/texbin` and `/usr/texbin`, and if it isn't found in either of those places, it will use the *which* command-line tool to try and locate a copy in the executable path. If nothing is found in any of those places, the file type will be removed as a compile option.


        • Exporting in Snippet Mode

          MultiMarkdown offers the possibility of compiling what is referred to as a "snippet", as opposed to a full document. A full HTML document is one that includes a header and body tags around the content you compile; a full !LaTeX document is ready to typeset. Snippets on the other hand only contain the *content* and as such are useless all by themselves. They are however useful for post-processing and pasting (or in the case of !LaTeX, including) into pre-existing boilerplates.

          To cause the com...


      • MMD & Pandoc Metadata

        Note on: Creating a Table of Contents


  • Final Phases

    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, eBooks, 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 that comprise it.

    At a basic level this is done by choosing a ...


    • Creating a Table of Contents

      How to create a static table of contents.


      • How to Create a ToC

        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 before compiling, as any changes in outline order or the addition or removal of sections will not be reflected in the list:

        1. Select all of the items that you wish to have included in the ToC. It may be easiest to do this in outliner view mode, so you can collapse and expand the various containers until the outliner looks roughly like what you want t...


        • Things to Watch Out For

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

          • This feature requires word processors capable of understanding bookmarks and cross-references. Page numbers may appear as question marks in the list if the software do not.

          • If you are not using title generation in compile, and are instead relying on a formatted title within the draft text it...


      • Contents in eBooks

        The ePub and Kindle compile export formats have an automatic built-in table of contents generator which should be used instead of the methods described in this section. If you are publishing to an eBook platform and wish to set up a ToC, please read about [the Table of Contents compile settings tab][compile - toc].

        In cases where that solution does not produce the desired results (perhaps you use section breaks for reasons other than purely to create new sections), you can create custom (albeit...

      • (see also)

        • [Compiling the Draft]

        • [Linking Documents Together]: the crucial glue used to make contents interactive, so readers can jump straight to the listed sections.

        • [Table of Contents][compile - toc]: a special compile tab used for setting up eBooks.


    • Compiling the Draft

      The main purpose of Scrivener is to provide a place that will help you write a long work---whether that be a novel, thesis, screenplay, non-fiction book or a series of technical manuals. This work will nearly always be structured as individual pieces in the binder, sometimes a great many, but no matter how many, they can easily be saved as one large file for working with "the rest of the world". If you're looking for a way of exporting individual files from your binder rather than turning them i...


      • Compile Overview Screen

        MISSING_IMAGE:/path/to/gfx/compile-overview_screen.jpg

        A set of short stories being prepared for compilation to a blogging site.

        For most projects you will rarely need to go any deeper than what you can do with the compile overview screen. It has everything you need to change the file type---such as [word processing files for programs like Word and LibreOffice, Web, ePub and more][Supported File Types]---the basic look of the document, how those looks will be applied to your work, and then a nu...

      • Compile Formats

        The left sidebar contains a list of formats applicable to the current file type you have chosen along the top of the compile overview screen. For example, if you select "Plain Text (.txt)", then you will only see those few formats that are useful to this file type (without a concept of formatting or fonts, the "Modern" format paired with a .txt file would be meaningless). This list is broken up into three sections---not all of which may be visible:

        1. *Project Formats*: compile formats that ha...


        • Selecting a Format

          Applying a format to your project may be as simple as clicking on it in the sidebar. If you started with one of our built-in templates, you may only need to attend to a few "author" and "title" sorts of details over in the [Compile Settings] area.

          If you get a yellow warning in the middle column, that means none of your projects section types are set up to work with the format yet, and will simply print their associated documents verbatim. You will need to set up the format to work with your pr...

        • Built-In Formats

          If you started your project using one of our built-in templates, it may already have special compile settings designed for it, but beyond that, Scrivener comes with a number of useful built-in formats. Some of these have been designed to conform to common industry standards in terms of manuscript submission and working with agents and editors; others have been designed as useful working tools, such as the ability to export an indented outline, or the distribution of proofreading copies. Others a...

        • Creating a New Format

          We won't go into all of the sordid details involved in designing a format right here and now. Refer to [The Compile Format Designer] for all of that. We will however go over the creation and management of formats themselves within this sidebar. To create a new format:

          1. Optionally, first select a format you want to use as a basis for your own.

          2. Click the AddButton in the footer bar, and select "Duplicate & Edit Format..." if starting from another, or "New Format...", to begin a new format ...

        • Editing Formats

          To edit a custom format you've made in the past, simple double-click on the format in the sidebar to open the format designer. You cannot edit built-in formats directly, so use the previous instructions to duplicate and then edit the new format.

        • Importing and Exporting Compile Formats

          Formats (even the built-in examples) can be exported from the sidebar and imported into other projects, or other computers entirely. If you have downloaded a ".scrformat" file from the Internet for example, you could import it using the following procedure:

          1. Click the GearMenu button (or right-click anywhere in the sidebar) and select the "Import Formats..." option.

          2. Navigate to the .scrformat file(s) on the disk and select them, clicking Open to continue.

          3. Finally, choose whether to i...

        • Deleting a Format

          You can remove formats from the sidebar that you no longer need:

          1. Select the format you wish to remove in the sidebar.

          2. Either right-click and select "Delete Format" from the contextual menu, or click the GearMenu button and select it from there.

          This will only delete the copy for the format from the "My Formats" list, or "Project Formats" list. Thus if you had a copy saved into the former list, any projects that still have that format saved into their own settings will not lose it, and ...

        • Resolving Duplicate IDs

          MISSING_IMAGE:/path/to/gfx/compile-duplicate_formats.jpg

          Duplicated formats will be indicated as needing resolution with this icon.

          Duplicating Formats from within Scrivener is safe and often useful to do. Problems can arise if the files used to store formats on your disk are duplicated outside of Scrivener. This could happen if the associated file is restored from a backup and one chooses to keep both copies, as a result of sync conflicts, or just manually duplicating formats as file on the di...

        • Importing Legacy Presets

          If you have been using Scrivener for some time, you may have built up a library of compile formats that you like to update, or you may have specific settings in some projects you would like to import as a starting point for getting them retrofitted for v3. You will first need to have [your compile settings available as a formal preset in the legacy version][Importing Legacy Compile Presets], as a file on your disk.

          1. Click the GearMenu button in Formats footer bar.

          2. Select the "Import Sc...


      • Section Layouts

        The next major component falls within the centre column of the compile overview screen. It contains a stack of tiles depicting how [the various different types of document of your draft][section types]---what you can see listed in the right column of the compile overview---will be formatted. By the way, you can click on any preview tile in this column to highlight which sections will be impacted in the contents list to the right, and hover the mouse over the tile to read its name in a tooltip.

        ...


        • Choosing the Global Font

          Many formats will include their own font choices for the text, headings and so forth. These will be used so long as the Font setting along the top is "Determined by Section Layout".

          If you want a different font used throughout the document then use this menu to select your preferred font. The scope of this setting is quite simple: it impacts everything, from the page number on down even to section types that would ordinarily leave the text alone and pass the formatting straight through from th...

        • Assigning Section Layouts

          When switching to a format not yet set up to work with your project, you may get [a yellow warning above the preview tiles](#compile-assign_section_layouts). This merely means that none of the section types in your project have been "mapped" to a particular look in the Layouts section.

          It is perfectly fine to compile in that state; the look of the format will not be used but other aspects of it may be, such as paper size, footnote settings and so forth. But to fully take advantage of a format ...


      • Compile Settings

        Returning to the main compile overview screen, the right-hand column is separated into several different tabs, where you will set up information about the work you are compiling:.

        1. The first tab, starting from the left, is [the Contents tab][compile - contents], where you can adjust which pieces of the binder to include in your compiled document, and as well adjust how they may be formatted by surveying section types. By default this pane pulls from the "Draft" folder with no other adjustmen...


        • Contents Tab

          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 dropdown menu at the very top of the pane, [marked as 1][compile-contents.png]. Ordinarily this will have the Draft selected (which might be called something else if you have rena...

          Expanded options for managing the compile group selection, such as whether or not to include the selected group, or if the binder selection should also use any children of the selected items, too.


          • Compile Group Options

            Depending upon the type of choice made with the Compile dropdown menu, secondary options may appear at the top of the content list.

            Two additional settings will be provided whenever an individual container from the "Draft" folder is selected:

            1. Treat compile group as complete manuscript: ordinarily when a portion of the draft folder is selected for compile, counter numbering will be displayed as though the rest of the manuscript existed; chapter 13 will remain 13. When this option is enabled...

          • Content Item List

            The item list is the large table in the middle, marked (c) in [](#compile-settings-contents_tab), displaying the contents of the current compile group. In the provided example the "Draft" folder has been selected, and so the entire Draft contents are revealed in the list below it. The items in this list will be indented just as they are in the binder, hierarchically.

            There are three columns within the table. It is usually a good idea to initially scan these columns to make sure everything will ...

          • Filtering

            Filtering makes it possible to supply certain criteria by which the compile contents list will be modified. For example you can have it only include those items which have a "Red" label set to them, or conversely, remove all items from the list marked with "Red". Start by clicking the filter button, marked (b) in [](#compile-settings-contents_tab), alongside the main Compile group dropdown.

            MISSING_IMAGE:/path/to/gfx/compile-settings-filtering.jpg

            The "Filter" button reveals options for further...

          • Front & Back Matter

            The main matter (or body matter) is a publishing term for the core content of a book, from the first chapter to the last. Front and back matter are defined as the material preceding and following the main content of a book. Front matter (also known as preliminaries or just prelims) will typically include everything from the title page and copyright page to the preface and introductions. In print publishing, this often includes a different header and footer style, such as Roman numerals for the p...


            • Additional Formatting Impacts

              Besides swapping out sets for multiple outputs, these features will also commonly be used to impact other compile settings:

              • When publishing to the Kindle formats the compiler will by default set the point where the book will first open to fall after the front matter contents---traditionally at chapter one. This can be altered in the [General options tab of the compile overview screen][compile - general options - ebook].

              • For formats with a page header or footer, different settings can be a...

            • Setting Up the Folders

              The Front & Back Matter features, marked (d) in [](#compile-settings-contents_tab), make it a simple task to swap out sets of files depending on what your current compile file type is. To get started:

              1. Create a folder in your binder that will contain different sets of front or back matter. In some cases you'll want to put separate subfolders within this, one for each type of front matter you'll need, such as "Amazon", "PDF" and so forth.

              2. Move your title pages and other materials into the...

            • Locking Settings to File Type

              As noted above, it will often be desirable to have different sets of front and back matter depending on which type of file you are creating. By default, when you set the contents pane to use a particular front/back matter folder it will stick no matter which choice you make with the Compile for dropdown at the top of the overview screen. TODO//LOW//Screenshot// fix hyphenation in "E-book" to "Ebook".

              MISSING_IMAGE:/path/to/gfx/compile-contents-locked_frontmatter.jpg

              The "eBook" front matter fo...

            • Linking Front/Back Matter to Compile Groups

              You can set the compiler to automatically select a front matter folder based upon the current compile group, so long as the group is itself set to [function as a complete manuscript][Compile Group Options]. A common case for where this might be useful is if you are working with a series of related works in one project, and regularly switch between them when compiling.

              MISSING_IMAGE:/path/to/gfx/compile-automatic_frontback_matter.jpg

              Matching front/back matter folder names will promote automatic...


        • Metadata Tab

          MISSING_IMAGE:/path/to/gfx/compile-settings_tabs-metadata.jpg

          The "Metadata" compile settings tab.

          Metadata in this context refers to information that will be embedded in the file you create, using whatever properties or fields the selected file type has at its disposal for recording metadata. This information can sometimes be used by file managers and to enhance search tools like Spotlight.

          This pane also sets the information that will be used by placeholders that insert information such as t...


          • Book and Author Information

            Title

            : If nothing has been provided in this field, the title will be taken from the name of project itself on the disk. Use this to set the formal title of your work; it will be used wherever the `\<$projecttitle>` placeholder has been typed in.

            Abbreviated Title

            : POST//WRAPPING Especially useful in headers, long titles often need to be shortened to fit in the header area, so you can optionally use the placeholder, `\<$abbr_projecttitle>`, to display a shortened version of it. If nothing is ...

          • Word Processing and Web Metadata

            The RTF, RTFD, DOC, DOCX and ODT formats all support additional fields that can be saved into the properties of the file. For example, the information filled out in this area will appear in the document's File//Properties... command. You may need to consult guidelines for how they should be used if submitting documents to a central repository. Some of these fields may be used by search indexers to better categorise the documents among others.

            When used with HTML files, the information supplied...

          • Ebook Metadata

            The additional fields provided to eBooks will be inserted into appropriate book description fields, often available to e-readers to display in whatever manner they provide, and used to automatically sort the book within electronic catalogues. Most of the fields allow for freeform entry; you should consult with your publisher or distributor on best practices for using these fields.

            Contributors

            : As with the Authors field, each person's name should be separated with a semicolon. Amazon's Kindle...

          • Fountain and Markdown-based Metadata

            The Metadata pane for Fountain and the Markdown-based file types provides a front-end to the preliminary metadata block found at the top of these kinds of files. Pandoc format uses a [YAML] block, which for the purposes used in Scrivener matches the format used in MultiMarkdown and Fountain's metadata block. Each line in the block is prefaced by a key, such as "Title", followed by a colon, some whitespace and the value.

            MISSING_IMAGE:/path/to/gfx/compile-markdown-metadata.jpg

            The Fountain and M...


        • General Options

          Gear tab; this will list options available to all formats in general.


          • Common Settings

            There are a few options in this tab that pertain to all types of documents that can be produced with Scrivener, or are used by a large majority of them.


            • Remove footnotes

              The exported manuscript will have all footnotes (inline or linked) stripped out.

            • Remove comments

              All linked comments from the inspector will be stripped out. When disabled, comments will be included in accordance with the current compile format, or to a format most suitable for the type of document being exported (for example, with the rich text formats you might get a "margin note" or comment box in your word processor when opening the file).

            • Remove annotations

              All inline annotations will be stripped out. As above, when this option is disabled the annotations will be formatted in a manner suiting the type of document and the compile format settings.

            • Delete struck-through text

              Any text that has been struck-through in the output will be stripped out of the compiled copy. If you use these marking for editorial purposes, to "soft delete" text, this is the option to use to implement those edits. When disabled (as it is by default), the text will be formatted as struck-through text if the document type supports that form of formatting. They will otherwise look like ordinary text in formats like plain-text.

            • Remove trailing whitespace from documents

              When enabled, this option makes it viable to not worry so much about whether or not there are empty lines at the bottom of individual chunks of text in the binder. They will be stripped out, so that only the separators inserted by the compile format will be present between chunks of text. If you use empty lines for some important purpose, you'll probably want to leave this option off.

            • Insert links back to Scrivener in each section

              Using whatever mechanism is most appropriate for displaying a hyperlink in the target file type, Scrivener will insert a special link at the top of every chunk of text used to build a compiled document, pointing back to that item in the project itself. This link will work anywhere from the same machine that project is located on. You can for example compile to PDF and use your favourite PDF reader to proof, clicking on these links to load sections up in Scrivener when coming across areas that ne...

            • Insert unique document identifiers only

              This subsidiary option to the prior will not create a usable link in the exported file. However it will print the internal identifier (in UUID format) for the binder items used to build the compiled document. When importing such files back into Scrivener, it will scan for text that matches this notation and build document links based upon them. This is a safer approach to distributing proofing copies to readers, as some software might disturb the hyperlinks inserted using the option above---as w...


          • Rich Text Options

            Unless otherwise noted, in this case, "rich text" refers to not only the word processing document formats (such as RTF, DOCX and ODT), but eBooks, HTML, PDF and Print.


            • Export inspector/inline footnotes as endnotes

              These two checkboxes, one for footnotes linked to the inspector and the other for footnotes typed directly inline into the text, will toggle whether or not that particular style of footnote will be exported as *endnotes* instead. The manner in which this is done will be determined by the compile format in use.

            • Remove highlighting

              Text highlights will be stripped from the compiled document in all cases, save for when highlights are used for other purposes, like indicating commented text.

            • Remove text color

              Likewise, this option will strip all custom colouring from the compiled document and force all text to default (black in most cases), without exception.

            • Remove all hyperlinks

              Strips out all hyperlinks from the produced document. If you primarily use links as a form of internal referencing, rather than as something you would like the reader to be able to jump from one section of the book to another with, you will want to use this option. It will also be useful when printing to paper, as you'd likely not want light grey underlined text wherever a link appears.

            • Convert Markdown to rich text in titles and synopses

              Simple [Markdown](http://daringfireball.net/projects/markdown/) for `**strong**` and `*emphasis*` (or `_emphasis_`) found within titles or synopses will be converted to bold and italics respectively. When using the underscore formation with the Convert underscores to underlines when converting Markdown setting in [the Sharing: Export !preference tab][sharing - export], then the end result will be formatted underlines rather than italics.

            • Convert MultiMarkdown to rich text in notes and text

              If you have written your text using MultiMarkdown syntax (some Pandoc may also work, so long as it overlaps with MMD), then use this option to have your work converted to rich text so that it can be used with one of Scrivener's own native formats, rather than using one of the dedicated MultiMarkdown compile file types. With the exception of the formatting Scrivener has native conversion support for (like images), this option requires a project to be written with proper with syntax throughout. If...

            • Scale images to fit page width

              Available to the word processing formats, images in your text editor will have their dimensions adjusted to fit within the set paper and margin settings rather than overflowing the page. In nearly every case it will be better to actually resize those images graphically, so that they print the way they are supposed to, as this will reduce processing overhead and result in smaller documents.

            • Convert document links to link back to Scrivener

              This proofing option is available to PDF and the word processing formats. All document links, those that point from one section of text to another within the binder, will be converted to links that point back to that chunk of text in your project, rather than links that navigate you around within the document you exported. Read more about this capability, and other [Proofreading Tools].

            • Convert linked images to embedded images

              Available for the RTFD format alone. 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.


          • Markup Options

            These settings pertain the Markdown-based document types at the bottom of the Compile for dropdown. Pandoc to ePub also supports some options described in the next section.


            • Convert rich text to MultiMarkdown

              Enables a broad spectrum of rich text to MMD conversions, with the intention of providing as much conversion as there is overlap between these two systems. That is to say, things that RTF does that Markdown-based formats do not do will not be converted (you can't have red text for no reason, for example), and things that Markdown can do that RTF cannot do will not be addressed. But if both can do a thing, like create a text link to a web page, then we strive to convert it.

              This option will prim...

            • Convert tables and lists to MultiMarkdown

              When enabled, converts rich text tables and bullet/enumeration lists to MultiMarkdown and Pandoc Markdown (lists will be Markdown compatible). For further information on how this feature works, refer to [Markdown and Scrivener][mmd - lists and tables].

              Operating as a conversion subset, this will be disabled when the Convert rich text to MultiMarkdown is enabled. This option otherwise treats your text as Markdown, unlike the previous option. You can freely use your own markup, and thus it is me...

            • Treat "Preserve Formatting" as raw markup

              Requires the Convert rich text to MultiMarkdown checkbox to be ticked. If now and then you need to do something that Scrivener's converter cannot handle, use this setting to insert your own hand-typed markup into a document that is otherwise entirely rich text. Mark such blocks of text with the Format//Preserve Formatting menu command to cause the compiler to leave these spans of text alone, rather than "escaping" the markup so that it prints verbatim.

            • Show PDF log

              <$stdOnly> When using the MMD RightArrow PDF conversion option, this option will print the LaTeX log file that is generated when typesetting the document. Use this to help locate and fix problematic formatting, figure out errors that block output and so forth.

            • Save source files in a folder with exported file

              Available to Pandoc RightArrow DOCX, DocBook and ePub. Ordinarily Scrivener will discard all of the files it generates when producing an encapsulated format or one with embedded source files. The graphics, CSS, Markdown and other peripheral files used to create the requested document will be saved along with it. In this way you can tweak the output using additional tools for doing so, processing the files yourself using the command-line or other tools.


          • Ebook & HTML Options

            With the exception of the first option in the following list, these settings are only available for eBooks.


            • Convert document links to HTML links

              Internal references to other items also located in the compiled output will be cross-references for the reader. In web pages and eBooks, this means people will be able to tap on the linked text and be taken to the section you refer to. This will even work if the sections themselves have been glued together into one longer formal section---like subsections within a chapter.

              This option has no impact on the automatically generated table of contents in eBooks, or a designated contents section in t...

            • Downsize and resample inline images to visible size

              To cut down on the overall size of your eBook, you may wish to have Scrivener resample the graphics when compiling. This is distinct from the ordinary behaviour, where images will always *appear* to be the size you have set them to in the editor, or the size they appear as naturally. This is done by setting the visible size of the picture without changing its underlying pixels. This option on the other hand will physically resize the graphics for the compiled version *only*. It is not destructiv...

            • Use pop-up footnotes

              There is no reliable part of the ePub specification that can be used to present footnotes in a pop-up bubble, as opposed to a link that will take the reader to another point in the book. But there is a loose convention that some readers will follow, and this option adds the necessary syntax to the HTML to do so. The option is only available to ePub 3.

            • Include standard Adobe Digital Editions page template

              Only relevant to the legacy ePub 2 format. : [Adobe Digital Editions](http://www.adobe.com/products/digital-editions.html) uses a special proprietary file (page-template.xpgt) for setting the type and controlling layout look. Without this file, the appearance of your eBook may suffer in ADE and devices that use that technology, such as Sony, Nook and Kobo readers. This file is not considered part of the official ePub specification however, and can conflict with some validation and publishing ser...

            • Optimize for Kindle conversion

              For cases where you wish to publish to Kindle format, but are using a third-party agent only accepts ePub files, this option will enable additional tweaks to the structure and formatting of the ebook that will produce a better result on Kindle devices and apps.

            • Save source files in a folder with exported Kindle or ePub file

              This is an advanced feature intended for those who wish to customise the look and feel or structural layout of their eBook after compiling it. The actual files used to create the eBook will be output as plain folders and files for you. These can then be edited freely, and then turned into a .mobi file using KindleGen or Kindle Previewer. If you are intending to modify an ePub file further, it may be easier to use an ePub editor, such as [Calibre].

            • Save KindleGen log file with exported 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 saved right alongside the compiled .mobi, or where it would have been saved were it not for the errors.

              If no log file is created, there may be a problem with KindleGen itself and you should try reinstalling it. NOTE// there used to be instructions about checking the link to see if KindleGen is even the thing assigned ...

            • Book begins after front matter

              For this feature to work, the [Front Matter feature must be enabled][Front & Back Matter]. The book will initially open at the first section that follows the material added as front matter. This can be useful if the front matter you are inserting with the feature is not essential for the reader to see, and you wish for them to start right at chapter one. When unchecked, the book will open at the start of the entire book, and so is thus useful when the front matter contains text that is important...


          • Scriptwriting Options

            The Fountain (.fountain) and Final Draft (FDX) formats offer some unique capabilities that various components of your project could be used for.


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

            • Include document titles as scene titles (section headers)

              Enabled by default, the names of draft items as listed in the binder will be used as scene titles in Final Draft, or as section headers in Fountain. When Scrivener imports an FDX or Fountain file (via the File//Import//Import and Split... menu command), these will be used to generate binder item names.

            • Section headers use binder indenting levels

              Fountain section headers can optionally use outline depth, although this is not used in any way beyond the purely visual.

            • Include document synopses as scene summaries

              The content of the synopsis field will be used to populate information into the "scene summaries" feature in Final Draft, and using Fountain syntax for the same.

            • Include footnotes as script notes

              Inline and linked footnotes will be converted to script notes. Footnotes will be removed from the compiled document if this option is not enabled.

            • Include comments and annotations as script notes

              Inline annotations and linked comments will be converted to script notes. All comments will be removed from the compiled document if this option is not enabled.


        • Project Replacements

          Upgrading from 2.1 notice


          • Creating Replacements

            To create a new replacement:

            1. Click the AddButton button in the lower right-hand corner of the table, or click into the table and use the !Return key to create a new row.

            2. Type in the text you want to have changed when compiling.

            3. Press Tab or click into the With field and type in what the text should be changed to.

            4. Press Esc or click elsewhere to commit your changes, and tick any relevant checkboxes to the right of the text columns.

            Looking for what you cannot see?

            If you need to...

          • Removing and Disabling Replacements

            To delete a replacement permanently (if you merely wish to disable the replacement, click the checkbox in the leftmost column of the corresponding row):

            1. Select the row you wish to delete by clicking on it in the table, or using the arrow keys on your keyboard.

            2. Click the DelButton button in the lower right-hand corner, or press the !Delete key.

          • Modifying Replacement Order

            The order of replacements in the list can be significant as they will be evaluated one after the other from the top of the list to the bottom. This means you can use use earlier replacements in your subsequent replacements, if you are feeling brave. Thus you can change the order of replacements by dragging and dropping them in the table.

          • Copying Replacements Between Projects

            You can copy and paste selected replacements (use the Shift and CmdCtrl keys to select with the mouse or keyboard arrows, or CmdCtrl-A to select them all) between projects using the ordinary methods for copy and paste. Just make sure to click into the replacements table so that when you paste Scrivener knows where you meant to paste the replacements.

            If both projects have their compile overviews open at once and you have enough screen space to do so, you can also drag and drop between tables.

          • Advanced Replacements Usage

            Replacements can also take a special placeholder (or wildcard), `$@` which will be used to match everything between the rest of what you type in the search field. The matching text will be temporarily stored and pasted into the With field if you use the same wildcard placeholder there. This wildcard only works when surrounded by text to match with, it cannot be reliably used at the start or end of the Replace field, though the placeholder can be positioned anywhere you like in the With field, e...


        • Cover Options

          How to assign a cover graphic to eBooks


          • Cover image

            Click the dropdown menu below this label to select an image from your project and designate it as the cover image. The image you choose will be displayed in the preview area below.

            If you want to copy your cover image to another project you can drag it from the preview area into that project's binder, where you can then be assigned as the cover image in its compile settings.

          • Add HTML cover page

            Some ePub book readers will not discover an image that has been marked as a cover graphic in the book's metadata. For these readers you will need a literal page in your book that contains the graphic, like a sort of title page. They will typically look for the first graphic in the book and use that for the thumbnail, which this option will enable. If you are unsure of whether the service or reader you will be working with supports regular covers, it will be safest to turn this option on.

          • Cover page title

            This option is only relevant to the ePub file types, and if the previous option has been enabled. 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.

          • Tips for Good Covers

            Graphics for cover art should be in a standard RGB raster format, such as JPEG, and not a vector format, such as EPS, nor CMYK colour space which is designed for printing. 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, and let them know which devices they should design for (iPad, etc.).

            In particular, watch out fo...

          • SVG

            This is an advanced feature for ePub books 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 ...


        • Table of Contents Tab

          Layout compile pane description for eBooks.


          • Generate HTML table of contents

            The compiler can automatically generate a table of contents into the text of the book itself, typically somewhere near the front of the book. It is a good idea to provide this in addition to the menu-based navigation that most book readers now support, as older devices may lack the latter, leaving your readers without any way of getting around in the book. If you know your book will only be read on modern devices and want to clean up the front matter a bit, it is safe to disable this option.

            If...

          • Contents Depth

            Applicable to the Pandoc ePub file type, this setting refers to the *heading depth* in the HTML itself, rather than Scrivener hierarchical representation of depth in the binder, or by the [internal section breaks that cut one file from the next]. A single flat file might have four levels of heading depth within it, and all of those up to the number specified in this field will be displayed in the ToC.

          • Center body text of HTML table of contents

            Centres all of the titles rather than left aligning them.

          • Use flat table of contents

            This only impacts the internal menu-driven contents, not the HTML formatted ToC. By default, the listing will be nested according to the depth of the items in the binder, which might either cause navigation to be presented as an indented list, or involve the reader drilling down into subsections, depending on the reader. For shorter works, it may be desirable to have all points of navigation in the book visible at once and in a simple flat list. Enable this option to achieve that look.

          • Bold top-level items

            Within the HTML contents page, those items located at the top of the current compile group will be emboldened. If the outline has several layers of depth, this can be a good way of visually distinguishing the major sections of the work.

          • Omit "landmark" guides

            By default, Scrivener will use modern referencing for various landmarks in the ebook, such as the contents, cover image and the starting position that the reader will open a newly acquired book to. In some cases, such as when displayed using Amazon's "Look Inside" feature, these markers will become visible. Disabling this option will use the older markers for these sections.

          • Table of contents title

            Determines the title readers will see for the generated HTML contents, as well as what it will be referred to in navigational menus of some readers and eBook software. If you have created your own table of contents page using the method described in [Contents in eBooks], you will need to ensure that the name of the item in the binder used for that custom ToC matches what you provide here.


        • KindleGen

          Setup instructions for Kindle export


      • Supported File Types

        Tables and explanations of available compile formats.


        • Text and eBook Types

          Format

          Ext.

          Description

          Print

          N/A

          Used to immediately print the compiled draft

          PDF

          .pdf

          The Portable Document Format can be opened on nearly any platform and device with minimal to no loss of display quality.

          Rich Text

          .rtf

          General purpose rich text format. The native format for Scrivener, used for most conversions to other formats.

          Rich Text with Attachments

          .rtfd

          Useful mainly for exporting to other native macOS apps such as TextEdit, especially if image support is needed.

          Microsoft Word

          .doc...

        • Markdown Compile Types

          Format

          Ext.

          Description

          **MultiMarkdown Conversion**

          MultiMarkdown

          .md

          Export a plain-text MultiMarkdown file, useful for archival. In combination with post-processing, this file type can be used to generate Pandoc flavour syntax as well.

          LaTeX

          .tex

          Exports a !LaTeX format file with full MultiMarkdown parsing. Note that if you are intending to export a !LaTeX file that has been handwritten in Scrivener (without MMD), you should use the plain-text format, above.

          OpenOffice

          .odt

          Exports an OpenOf...

        • Files Missing Some Features?

          With the default macOS configuration, when you double-click on RTF files in the Finder, they will be opened in TextEdit, which doesn't support all RTF features. To open an RTF file in your desired word processor, you should open the word processor first and use File//Open.... You can use the "Get Info..." palette in Finder to change the software association with RTF either for one or all files.

        • Using RTF

          All formats useful in the word processor / graphical layout workflow.

        • Enhanced Import and Export Engine

          Note on: Import and Export

        • Exporting Scripts

          The screenplay formats

        • Using Post-Processing to Expand File Type Support

          <$stdOnly> Scrivener supports full command-line access, either through embedded scripts or by calling upon external utilities. This is a special feature provided to compile Formats, via [the Processing compile format pane][compile - processing], which is itself available when using the Plain Text and MultiMarkdown compile file types. The former can be used to construct any type of syntax conceivable. Refer to our built-in General Non-Fiction (LaTeX) project template for a live example of this. ...

        • Choosing an eBook Format

        • Script Format Recommendations

          Application

          Best Format

          Notes

          Final Draft & compatible

          FDX

          Supports comments and footnotes (as script notes), synopses (which become scene summaries), titles, dual dialogue (dialogue marked using “Preserve Style” in Scrivener becomes dual dialogue in Final Draft), revision marks, custom element formats. If a program supports Final Draft format and doesn't have its own format, this will nearly always be the best format to use.

          Plain-text editors

          Fountain

          Fountain is a Markdown inspired plain-tex...


      • Compiling and Saving Settings

        Once you have everything set up the way you like, the Compile button will automatically save all of your settings into the project, dismiss the window, and compile the project in accordance with your specifications. When you change settings and compile, they are saved automatically into the project.

        You can cancel any changes you've made by clicking the Cancel button at the bottom of the compile window. This will exit the overview screen without compiling and discard all changes made (though if...


    • The Compile Format Designer

      To open the format designer you will either [need to create a new format][Creating a New Format], possibly duplicating an existing one, or edit a custom format you've made or imported in the past by double-clicking on it in the Formats list. You will be greeted by the [compile format designer window](#compile-format_designer_window).

      MISSING_IMAGE:/path/to/gfx/compile-format_designer_window.jpg

      The compile format designer window, showing the "Styles" pane.

      The provided built-in formats and set...


      • Setting Up the Format

        Once you have [created a new format][Creating a New Format], the first thing to do is give it a public name---how it will be shown in the "Formats" sidebar. Type the name into the the Format name field.

        If you are building a format designed for plain-text output, you will notice an Extension field in the upper-right corner of the designer window. This will set the default file extension used when compiling. If your purpose is to create a specific format such as XML, LaTeX, reStructured Text and...


        • Project vs My Formats

          At the top of the format designer, right beneath where the name of the format is set, you can choose where the format itself should be saved, under Save to:

          • *Project Formats*: the format will be saved directly into the project you are working on, and will only be available to that project. This is best for formats that are very specific to one project. Although since project formats can be saved into [project templates][Creating Your Own Templates], that means you can use a format you've cre...

        • Setting the Scope of the Format

          Next you will need to decide the scope of what this format is meant to address in terms of file types (such as PDF, RTF and so on). You do not need to create a different format for every type of file, and in fact by default newly created formats will be set up as relevant to *all* file types. Many settings will be shared between file types, such as font choices (where applicable) and separator styles, but some settings will be specific to only one type of file (such as Final Draft). An example o...

        • Switching Between File Types

          As you probably have guessed by now, using the dropdown menu marked (a) in the figure will switch the compile designer's focus to the chosen file type (.txt, .rtf, .docx and so forth). When you switch from one file type to another, particularly if they are quite different in capabilities, you will notice the available panes may change in the list below the dropdown, and certain options may appear or disappear from within those panes. Some panes may look utterly different depending on which file ...

        • Saving and Testing Your Designs

          As you work on the format you may want to periodically test the results against the current project you have open. The Test... button along the bottom left of the format designer window lets you do precisely this. It will run a full compile, and so ask you where files should be saved. The file type will be determined by which selection you have made in the header bar of the format pane list (marked (a) in [](#compile-format_designer_window))---if you choose "Print" the Test button will not ask f...


      • Section Layouts

        MISSING_IMAGE:/path/to/gfx/compile-section_layouts.jpg

        The Section Layouts pane showing the "Enumerated Outline" layout list.

        The Section Types pane (available to all but the scriptwriting document types) is where you will define the available parts of a document, what text if any will be included within them and design how that text will be formatted (or structured, in the case of plain-text formats). In [](#compile-section_layouts) we can see the list of layouts available from the "Enumerated...


        • Section Layout List

          Each of the entries in this list are what will be provided in [the Section Layouts column of the compile overview screen][Section Layouts] as "tiles". This can be seen most easily with a simple format, such as ["Enumerated Outline"](#compile-section_layouts-and-assignment). The listed items in the pane (lower right excerpt) determines the names of the tiles and the order in which they appear in the assignment panel (behind and to the left in the figure).

          MISSING_IMAGE:/path/to/gfx/compile-secti...


          • Adding New Layouts

            To create a new layout:

            1. Select the layout that most closely resembles the new one you'd like to create. You'll be able to change everything about it, but if it is just a variation on a chapter heading it would be easiest to start from another chapter heading layout.

            2. Click the AddButton button in the upper right-hand corner.

            3. Give the new layout a name and click elsewhere to confirm your change.

          • Renaming and Managing Layouts

            Changing their order: the order of layouts isn't of great significance, but they will be listed in the order they appear within this list, when assigning types to layouts in the compile overview screen. If you want to change their order, just drag and drop.

            To rename a layout: double-click on its name in the "Layout Name" column. This will not affect any projects using that layout for their types, they will automatically adjust to using the new name.

          • Deleting a Layout

            To remove a layout you no longer want in the format, select the layout from the listing and click the DelButton button. This action cannot be undone, but you can of course close the format editor without saving changes by clicking the Cancel button along the bottom.

          • Layout Content Columns

            In all cases, these checkboxes merely add or remove the content itself from the layout. The formatting of that content, embellishment of it (such as adding decimal numbering to the title) and so forth are done using the tabbed settings below this list.

            Title

            : Prints the binder title of each item assigned to use this layout. The title will typically be placed on a line of its own at the very top of the section, much like a heading or chapter break would be. This checkbox is only used to bring t...

          • Duplicating Settings Between Layouts

            With so many options available in regards to the specific Layout itself it would be useful to have management tools for copying these settings from one layout to another. Say you've set up a meticulously designed layout for chapter breaks, and realise that with the exception of the title prefix, you want everything else to be applied to a variation use for interludes. You can use the following techniques for copying some or all settings (and remember that when creating new layouts you can always...

          • Changing How a Layout Works

            When you select a Layout in the list, its settings will be loaded into the tabbed configuration area below (showing a preview by default). You can thus switch between layouts and easily compare settings between them.


        • Global Section Layout Options

          In the upper right-hand corner, by the buttons used to add and remove Layouts, you will find a GearMenu button with a few options that will impact how all section layouts work.


          • Include placeholder titles for untitled items

            Those binder items that have been left untitled can optionally use the adaptive name generated from their content or synopses, as they are shown in the binder and outliner. The default behaviour is for these items to never show titles, even if they are assigned to a section layout that chiefly exists to generate a title.

          • Do not add prefix or suffix to placeholder titles

            When untitled documents are encountered, if the section layout they are assigned to generates a generic title (such as a chapter number), then that part of the title will still be used. Thus an untitled document may still have a structural presence in the final result. If you would prefer untitled elements be entirely anonymous and not contribute to the structure, then enable this option.

          • Insert subtitles between text elements

            If more than one type of content (excluding the Title) is included for a layout, then Scrivener will insert subtitles between those elements to help set them apart. These titles can be formatted like everything else in the formatting editor below. You only need to edit the formatting of one subtitle to impact them all. Disable this option if you would prefer to a seamless approach.

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

          • Add closing hashes to titles

            This option only pertains to the Markdown-based formats. When adding formal titles to the document, Scrivener will enclose the title in hashes:

            ### This is a Third Level Document ###

            Disable this option to use the following format:

            ### This is a Third Level Document


        • Formatting

          This contains the content for "Title Settings" or "Section Layout"; titles generated by the two empty items above.


          • Using Styles with Layouts

            The Styles button on the far left of the Format Bar will refer to styles provided by the *format itself*, via the [Styles format pane][Styles], not any styles in the project. Remember, Compile Formats are self-contained and know nothing about the projects they are applied to.

            They also function a little differently to styles in the main editor in that if you modify the formatting of the text at all after applying a style, the assignment to that style will be removed, and it will no longer updat...

          • Overriding Text and Notes Formatting

            The checkbox by the same name along the bottom of the preview area will toggle whether or not you can format the main text element in the preview area (assuming you are including either Text or Notes via the checkboxes in the layout list above). There are a few important things to be aware of with this feature:

            • Text that is styled in the main text editor will *ignore* any settings made here. Styles in Scrivener are a way of declaring a range of text as special, or anything other than body te...


            • Preserve uncommon alignment

              Enabled by default, this option will cause any paragraph alignment other than Left or Justified to be preserved, no matter the alignment of the formatting defined in the sample text above. Left and justified text will always be transformed to match the look of the sample, regardless of this setting.

              In most cases you can use Styles to achieve this same effect.

            • Preserve tabs and indents

              Enable this option to have tab stops and paragraph indents preserved on a per-paragraph basis. This can be useful in cases where you want to generally override the formatting of a section, but the content of that section uses a variety of different indent and tab settings that wouldn't otherwise be applicable to Styles usage. An example of this could be a table of contents section.


          • Plain-text

            You may be wondering if you can skip this when working with plain-text. Naturally in most cases if you were to set the title to 24pt bold it will not do anything to the compiled document. There are a few notable exceptions that could be of use to you:

            • If converting paragraph and indent formatting to whitespace [in the Transformations format pane][Transformations].

            • Where styles are applied to text in the preview area and those styles are set to modify the text somehow, in [the Styles forma...

          • ePub 3 and KF8 (Mobi)

            When working with either of these modern and fully semantic file types as your output, the "Formatting" tab will be a little different. Instead of providing full rich text formatting controls, you will only be able to apply styles to text (this will be most useful when assigning styles to [HTML Elements][compile - html elements]), and overall formatting should be done in the [CSS compile format pane][compile - css].


        • Title Options

          The second tab in the layout configuration area provides options for adding a prefix or suffix around the title (or even instead of the title), adjusting the letter case of these elements and other options specific to different file types.

          The following examples are available in the Extras Pack

          If you would like to install the format used to demonstrate the following examples, import the "6-Title Options Examples.scrformat" into your copy of Scrivener (or a test project) from the [Extras Pack]....


          • 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 merged into 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 prefix or 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.

            This option will no...

          • Title Case

            This setting, along with the Case settings that appear below each of the prefix and suffix text boxes, will dynamically adjust the letter case of these title elements. The following options are available to most file types:

            * *Normal*: letter case will not be adjusted. However the title elements were typed in will be passed through.

            * *Uppercase*: all letters will be converted to UPPERCASE.

            * *Small Caps*: this uses faux small caps, by converting all letters to uppercase and then changing th...

          • Title Prefix

            Anything typed into this box will be printed directly before either the binder title, or the suffix if the title has been omitted. 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.

          • Title Suffix

            The contents of this box will be printed directly after the binder title or 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.

          • Place prefix/suffix inside hashes

            Available only to the Markdown-based file types. The title prefix and suffix will ordinarily be placed within the hash marks that Scrivener generates to indicate title depth---thus as part of the heading itself. If you prefer, you can disable the Place prefix/suffix inside hashes options to [allow text entry outside of the header line itself](#compile-section_layouts-mmd_prefix_and_suffix). Prefix and suffix placement remains literal and directly adjacent to the title element. Thus for proper fo...

          • (MMD Prefix and Suffix)

            MISSING_IMAGE:/path/to/gfx/compile-section_layouts-mmd_prefix_and_suffix.jpg

            The placement of the prefix and suffix around automatically generated hashes with them inside and outside, respectively.

          • Number of hashes

            Available only to the Markdown-based file types. Adjusts the number of hashes to use for titles in this section layout. This can be a way of coercing a layout to always print a heading of a certain depth no matter its literal depth in the binder outline. A "Part" section might always want to use a setting of "1", for example. By default, the "By Level" setting inserts a number of hashes indicating the depth of the item in the outline, regardless of its layout type.

            Setting this to "0" will remo...


        • New Pages

          This pane contains settings for adjusting how this Layout will act when a new page (or section break, for those file types that are not built around paper) is generated for it by [the Separators compile format pane][compile - separators].


          • Pad top of page with *n* blank lines

            Adds the defined quantity of empty lines above the title and section prefix. This will have the effect of pushing the title down into the page and leave an area at the top blank. Since the setting uses lines this can be used with any file type. This option will be previewed in the section layout's tile, in the compile overview screen.

            Even though this option is available to the Markdown-based formats, it should be noted that these systems generally disregard blank lines and they will appear to ...

          • Number of opening words to make uppercase

            If your formatting requirements are such that the first few words of the paragraph following a title need to be uppercase, then specify how many words should be set to uppercase with this setting.

          • Use small caps

            You can also opt to use faked small-caps instead of all upper case, using the checkbox below this setting. This only works with file types that can use font sizes.

          • Uppercase even when section is not after a page break

            This is the one setting that will trigger even if the section does not generate a page break. Use this if you need to capitalise words following a regular heading or soft break, like a divider or empty line.

          • Add "first-letter" span style to the first letter

            Available to ePub 3 and KF8 Mobi, this wraps the very first letter of the section in a span with the "first-letter" class assigned to it. This can be used to style drop-caps or other visual effects. You can either create the CSS yourself in [the CSS compile format pane][compile - css], or you can create a style called "First Letter" and use the WYSIWYG formatting in [the Styles pane][Styles]. For true drop-caps you will need to use CSS directly as Scrivener itself cannot create floating boxes.

          • Setting which page a section falls on

            Using the next two options (only available to print and PDF), you can set up common typesetting techniques, such as setting a "part" page to be displayed all by itself on the recto side, with the chapter page following it on the recto side as well and a blank page in between them to do so.

          • Always start section on

            The new section can be forced to always start on the verso (left) or recto (right) side of the book. This will in some cases cause an empty page to be inserted, in order to keep the chapter on the chosen side.

          • Start next section on

            If the *following* chunk of text also generates a page break, this setting will control how it behaves if it otherwise doesn't use the prior setting itself.


        • Prefix

          Use this area to add content to the beginning of the section, directly before the title area (you will need to insert carriage returns into this field if the prefix should be on a separate line). The prefix can be independently formatted using the standard controls provided. With plain text formats, this can be useful for inserting markup around entire sections. The prefix will be previewed in the layout's tile, in the compile overview screen.

          You can optionally use the Place prefix after title...

        • Suffix

          The suffix tab works similarly to the prefix tab, only inserting the text you provide here at the very end of the section. You will need to add your own separation at the beginning of the suffix field if it should be on its own line. The suffix will be previewed in the layout's tile, in the compile overview screen.

          Use the Place suffix after subdocuments setting to have the suffix placed after all descendent items in the binder have been printed. In other words, this will place the text at the ...

        • Using Placeholders in the Prefix and Suffix

          I'm leaving this out for now. I think this might be handy information to know, but it could be better placed in the knowledge base rather than bulking up this already extremely large section.

        • Settings

          This final tab will not appear for any plain text or Markdown-based formats.


          • Paragraph first line indents

            Utilises the common typesetting practice of discarding 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 checkbox. This adjustment is handled globally, rather than per specific section type in the ePub 3 and KF8 Mobi formats, via [the Text Layout compile format pane][compile - text layout - ebooks]. If you require a more granular approach, consider providing the section layout a CSS class na...

          • Include in RTF bookmarks

            This option is used by all of the word processing formats, which are derived from RTF initially. It is enabled by default for all section layouts, and thus those items not using the "as-is" assignment in your binder will get an RTF bookmark.

            These will create handy navigational references throughout the document in word processors, and is also used to cross-reference document links in Scrivener. It may not always be desirable to have bookmarks at every level of your outline, especially if you u...

          • CSS class name

            This and the following setting are available to ePub 3 and KF8 Mobi. When a class name (it is up to you to provide a valid class identifier here) is assigned to a section layout, a `

            ` element will enclose the entire section (including its prefix, title and suffix, if the suffix is not set to fall after subdocuments). This can be used to provide more specific CSS instructions, in [the CSS compile format pane][compile -css].

          • Hide section in e-book

            Available to ePub 3 alone. This setting will remove the documents that use this Layout from all forms of navigation in the ebook, including next/prev chapter functions, the internal table of contents, and the automatically generated HTML contents if applicable. It will be referred to as a "non-linear section" in eBook editing programs.

            Support for this specification may vary between readers. Some may allow the reader to navigate through these "hidden" sections, but by and large it will not be p...


      • Script Settings

        This pane is only available to the Final Draft (FDX) format. It provides options for configuring a few details that impact how a few elements of a script should be formatted.


        • 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 formatting. This could result in a compile that looks different from what you've been writing, but in most cases there will be no visible chan...

        • Break dialogue and action at sentences

          Use this option to adhere to the standard of keeping action and dialogue sentences together, rather than breaking them up between pages. If a sentence would have ordinarily been split, it will instead be moved entirely to the following page.

        • Include revision colors from Preferences

          Your preferred revision colours, which can be set in [the Editing: Revisions !preference tab][Editing - Revisions], will be supplied to Final Draft's revision palette, maintaining a consistent revision system between the two applications.

        • Summaries and Script Notes 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 something else that is commonly available.


      • Separators

        Separators are used to automatically insert space, breaks, or custom symbols between the various elements in the list which will be compiled. The important aspect to note is that by the time Compile gets to this point, your document is being considered as a flat list of files. It doesn't matter if a text file is four layers deep, if the next item in the list is a folder, it will still use the **Text and Folder Separator** rule. There are four types of possible combin...


        • Managing Layouts from the Separators Pane

          You may at times find you need to create a new layout on the fly to accommodate a special form of separation. In the lower left hand corner of the Section Layout list are a pair of AddButton and DelButton buttons. Section Layouts can be managed from this pane:

          • When adding new layouts it works in the same fashion as the Section Layouts pane would---select the layout you want to duplicate and then click the AddButton. You may of course need to further tweak it in the Section Layouts panel afte...

        • Separator Types

          The simplest way to use and think of separators is of having them inserted above the section layout that uses them, thus placing it in between the preceding chunk of text and the current one. This is the usage we referred to before, where a common (and default) behaviour is to insert a page break before all folders. If you add a folder and put some files into it in your draft, it will automatically act like a major section break when compiled.

          There are three other options for where or how sepa...

        • Separator Settings

          Each of type of separator that can be made use of in defaults or per layout will have the same four options available to them:

          • *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". In essence this is the "no separator" option.

This can have an adverse effect in Markdown-based and Fountain formats, where a clear empty line is expected between all elements, including paragraphs.

          • *Empty line*: tw...


      • Styles

        Where it comes to compiling stylesheets from your project, Scrivener takes a somewhat unique approach to the problem in that every compile format can potentially change every aspect of the styles in your project as you see fit. Another unique aspect of its stylesheet system is that this panel will be available to every file type in the list save for scriptwriting formats. That means even plain text and Markdown-based files can use stylesheets (though naturally they will ignore those settings de...


        • Creating a New Compile Style

          To create a new style in the list:

          1. Click the AddButton button in the upper right-hand corner of the pane.

          2. You will be presented with a list of options divided into the following categories:

          ⁃ Generic new styles for paragraph, paragraph+character and character. For more information on the distinction between these types, refer to [Paragraph and Character Styles].

If applicable, the starting attributes and settings for the new style will be determined by the selected style in the list--...

        • Renaming and Removing Compile Styles

          Styles can be freely modified in the list once they have been created. To rename a style:

          1. Double-click on the name of the style in the style list.

          2. Once the edit is complete, press !Return or click elsewhere to confirm your edit.

          Removing a style from the list will in most cases simply remove the instructions provided to the compiler for handling a style by that name. In some case, if the style has been made use of in other compile format panes, the result will be to reset those areas t...

        • Compile Style Options

          The sidebar to the right of the main style list contains a number of options that can modify the behaviour of the text assigned to that style, sometimes even radically---you could for example have a style that deletes the styled text entirely and replaces it with a counter using one of the prefix or suffix options. These settings will impact not only styled text found in the project using this format, but text that has been dynamically assigned to a style by the compile format itself.

          To modify...


          • Delete text of this style

            All text that has been associated with this style will be removed from the output. A practical example of this feature is in use with this user manual, where specific phrases of text relating to macOS or Windows alone can be selectively omitted depending upon which format it has been compiled with.

          • Treat as raw markup

            This option is available to all file types that make use of or are capable of generating markup: TXT, HTML, the eBook formats and the Markdown-based file types. In all cases the effect of this option is to fully suppress any compile behaviours that might modify the text as you typed it in, allowing you to inject raw markup as intended to the final output.

            To provide a very simple example, if you manually type in `` into your editor it would end up as visible text when you comp...

          • Flatten first indent

            This and the following two settings are available to print, PDF, the word processing formats, HTML, ePub 2 and legacy Mobi. Both ePub 3 and KF8 Mobi depend upon CSS for this level of behaviour adjustment.

            The first paragraph within the assigned range of text will have any first-line indenting removed.

          • Looking to adjust indent settings globally?

            These features are not intended to be used for handling large and dynamic amounts of text (such as all body text), but rather smaller ranges such as individual block quotes, monologue formatting and so on. For bulk indent management, you should use [the Section Layout: Settings tab][compile - section layouts - settings], and for ePub 3 and KF8, [the Text Layout pane][compile - text layout].

          • Single paragraphs only

            The first-line indent will only be removed from one line uses of this style.

          • Flatten next indent

            The paragraph of text *following* the paragraph using this style will have its indent removed. A common use case for an ability like this would be to suppress the indent of the paragraph of text following a figure caption, meaning the "Caption" style itself would be responsible for declaring that rule.

          • Prefix/Suffix

            The start of the styled range will have the text of the Prefix field added to it---styled in the same fashion as the text that generated it. Likewise the Suffix will be added to the very end of the assigned range of text. If the range spans multiple paragraphs, there will only be one prefix and suffix at the very beginning and end of the assignment. This (and the following) setting can be useful for a number of different applications:

            * In plain-text technical formats, such as XML, this can es...

          • Paragraph prefix/suffix

            Operating in a similar fashion to the previous set of options, this setting only applies to Paragraph and Paragraph+Character styles, and it will insert a prefix or suffix around each line of text *within* a styled range.

            To use HTML as an example, you could wrap an entire block quote in `

            ` and `
            `, and then individual paragraphs within that quote with the `

            ` and `

            `.

          • Override name

            Available to all of the word processing formats, except RTFD. For cases where the style name used by compile settings (which in turn is how it will be worked with in the project itself) must be presented differently in the output document, use this field to completely overwrite the visible name of the style. For example if you are working with a Word template that expects "Blockquote" instead of Scrivener's "Block Quote", you could override its name to that, here.

          • CSS class name

            Available to ePub 3 and KF8 Mobi. This will be of considerable use if you intend to write your own CSS. The ranges of text you assign with a style will be classed (either as `p` or `span` elements accordingly) with the name you provide here. If you do not provide a class name, Scrivener will attempt to automatically generate one based upon the style's name.

            It is up to you to select a valid CSS class name. If you type in invalid punctuation or uses spaces, then you will likely break your styles...


        • Compile Style Formatting

          Below the style list and options sidebar you will find a text formatting editor with all of the various tools needed to fully format text. This works in the same fashion as the [Formatting control in the Section Layout tab][compile - section layouts - formatting], with two exceptions:

          1. Naturally, there is only one element to work with. So you need only worry about clicking into the text area once to activate the formatting controls, rather than clicking in a particular area like you might i...


          • Include font family

            For cases where you merely wish to adjust some aspects of the character formatting but leave the font family alone, enable this checkbox.

          • Include font size

            Likewise, if the inherent font size should be left alone---either to be established by the compile format or the underlying text in the project---check this box.

          • Include styles information in exported file

            Available to the word processing based formats (excluding RTFD), this option is enabled by default and will cause the stylesheet that is generated by combing both the underlying project's styles, and any styles added or modified by the compile format, to the exported document. This will greatly enhance the flexibility of your file after it has been compiled, and in some workflows will be a requirement for submission or collaboration.


      • Text Layout

        This is where a few general decisions about the overall layout of the document can be made, and as such it presents different options depending on the file type you are working with. This panel is available to all file types except Final Draft and Fountain.

        Document suffix

        : This option is available to all file types. It will place the provided 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...


        • For PDF and Print

          One extra option is available when printing or using the PDF file type:

          Empty Lines Across Page Breaks

          : Enable the following checkbox and then supply a custom separator to be used as a stand-in when an "Empty Line" [Separator][compile - separators] 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.

        • For Word Processing

          With the word processor formats (excluding RTFD) this pane allows for some advanced page layout options, such as widow and orphan protection where applicable and column based layout.

          Avoid widows and orphans

          : When used with a compatible word processor, this will enable widow and orphan 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 ...

        • For Web Page

          Web pages (.html) have two exclusive options available (refer to the eBook options section for documentation on the Use 100% width for images wider than... setting):


          • Use centered column to restrict body text width

            Instead of allow text to flow from one edge of the browser window to the other, this option will enable the common tactic of constraining the text column to a maximum width in the middle of the viewer.

          • Body text width

            You can set the width of that column with this setting, in points.


        • For eBooks


          • Use 100% width for images wider than...

            Determines the effective maximum width for images by leaving it up to the e-reader after the width you set (in points, not pixels). Images narrower than that size will use a fixed width no matter how wide the e-reader's display might be. Note that some readers might always display images a certain way regardless of your settings here, particularly if the image is wider than the display.

          • Include scriptwriting CSS

            This setting is available to ePub 2 and legacy Mobi formats; if you need scriptwriting elements in your ePub 3 or KF8 Mobi book, refer to [the CSS compile format pane][compile-css]. If your eBook is composed of, or contains any script formatting, you should enable the "eBook contains script formatting" option. Scrivener will insert special formatting rules that match the script format settings you are using in that project, and typeset these elements appropriately.

            In most cases, the default st...

          • Embed MathType equations as MathML

            This is a default setting, and is only available, for ePub 3 and KF8 Mobi type books. Any MathType images found in the compiled text will be inserted into the eBook as a `` element, conforming to the specifications for MathML syntax. You should test your intended target readers for compliance with this format. If they do not display MathML equations correctly, or satisfactorily, you might wish to turn this feature off and have Scrivener convert equations to raster images (PNG) for maximum ...

          • Remove first line indents

            Available to ePub 3 and KF8 Mobi. This is a global setting for setting the behaviour of first-line indents that follow different types of elements in the book. The effects of this setting are implemented in [the CSS compile format pane][compile - css], and can be further tweaked there if necessary:

            * *From all paragraphs following other elements*: anything other than another a paragraph will cause the first-line indent to be removed. This uses the HTML definition of the `

            ` element, which ma...


      • CSS

        This pane is available to ePub 3 and KF8 (Mobi) formats only. It provides complete access to your book's [Cascading Style Sheet (CSS)][CSS Reference], which means you can apply your own custom-designed look and feel and go well beyond what Scrivener itself is programmed to handle in terms of design. You can also make minor modifications to Scrivener's automatic output as you see fit.

        You don't need to be a CSS guru to set up the Basic text formatting, in the upper half of this pane, and you mig...

      • Document Title Links

        This is a special option pane in that it will only appear if at least [one Section Layout requests the use of a title prefix or suffix in its settings][compile - section layouts - title options]. The options in this pane refine how these titles should appear when referring *to* the items via an internal document link---such as in a table of contents listing or in general cross-references.

        These settings will be useful in cases where what you are linking to is important to identify by its full n...


        • Update titles in document links with prefix and suffix settings

          The rest of this panel depends on this switch being enabled. It defines the base behaviour described above, where a hyperlink to "The Folder" may become "Chapter 21 - The Folder".

          Carriage returns will be stripped out of the prefix or suffix as necessary, in order to keep links from turning into multiple paragraphs in the text.

        • Links use title prefixes only (exclude title and suffixes)

          With this option enabled, the title and suffix will be discarded from the link text even if it prints more fully at the point of the title itself. Using the above example, our hyperlink would simply refer to "Chapter 21", even though at the chapter bring "The Folder" is printed on a second line below that.

        • Do not include title suffixes in updated links

          With this option enabled, the suffix will always be dropped from the link. This will be of use if you use the suffix to print some decorative elements below the titling.

        • Override title prefix separator in links

          This will insert the character provided in the Prefix separator field below, between the prefix and the main title. When this option is used without the following, all forms of punctuation and whitespace between the prefix and the title will be replaced by the separator. For example, "Chapter 21: The Folder" will become "Chapter 21 - The Folder".

        • Only override prefixes containing return characters

          In some cases the prior option by itself may be too aggressive as it will replace portions of the title you wish to leave intact. This secondary option forces the definition of "separator" to only those cases where the prefix terminate with a return character. All other characters will be left alone, meaning a prefix such "Chapter \<$n>: " will end up in the hyperlink as "Chapter 21: The Folder".


      • HTML Elements

        This pane is available to ePub 3 and KF8 (Mobi) formats only. It is used to map a compile format's styles to the sorts of styles used in eBooks. Since Scrivener cannot guess what you mean by the name of a style or its formatting alone, it needs a little help in getting them to look and work the way they should in the eBook.

        It is worth reiterating that compile formats are not "aware" of any particular project's settings, and as such you cannot use styles from the project's stylesheet directly. ...

      • Markup

        This pane is available only to the plain-text (.txt) file type. If you are looking to use Scrivener to generate markup files, but aren't a fan of using one of the Markdown-based approaches for doing so, then you will very likely find this pane to be of considerable use to you.

        This pane will nearly always be one of several you will want to use together in concert to create your own file types from scratch:

        • [Section Layouts][compile - section layouts] serve as a nexus for how many of the oth...


        • External link prefix and suffix

          The text of any hyperlink pointing to an external resource will be surrounded by the markup you add to these fields. You can supply the URL itself within this markup using the `<$url>` placeholder. An example prefix could be `` with the suffix being ``.

        • Internal link prefix and suffix

          For internal document links, those pointing to other items within the compiled draft, you can supply different markup, and make use of the `<$linkID>` placeholder for referring to the internal section by name. This placeholder is also valid for use in other contexts---for example in the title prefix of a section layout---making it possible to effectively identify or label nodes of text and cross-reference to them from elsewhere.

        • Enclosing markers for unstyled italics

          Raw italic text---not text made italic by a semantic style, can be treated specially here with a prefix and suffix. This will work better with simple ranges of text, naturally. Long blocks of italic text spanning paragraphs or other elements may produce invalid syntax depending on your target file type.

        • Replace images with text

          Images can be handled in two different fashions: you can either embed the graphic directly into the output file as hexadecimal (`$hex`) or Base-64 (`$base64`).

          The other method is to have the image exported as a file with the Export images checkbox, and then refer to the exported image by name with the `$filename` placeholder. When using this method, the compiler will create a folder to contain both the generated .txt file and all of the images, so you will be linking to images relatively from ...


      • Metadata

        This pane is used by the Markdown-based formats. Both MultiMarkdown and Pandoc are capable of defining format-specific information with their metadata systems. The functioning of this panel is identical to [the Metadata tab in the compile overview screen][compile - metadata - mmd].

        The principle exception is that this metadata table will have an uneditable marker in the upper list, labelled "Insert Project Metadata Here". This can be freely dragged around among other formatting keys, and as you...

      • LaTeX Options

        This pane, available to the MMD (LaTeX) document type, is used for selecting which of the three built-in document classes Scrivener has boilerplates for, along with a few custom options. The settings for the LaTeX document class dropdown are:

        • *None (Use Metadata)*: you will be in full control over the process when using this option. Use this option if you have your own boilerplate files, or would rather use none at all.

        • *Article*: the Memoir class, with tweaks to present text similarly to...


        • Header

          The initial preamble should be placed here. Typically anything that needs to be declared prior to establishing document variables, such as the title and author, should be put in this field.

        • Begin Document

          This gives you a second preamble field for working with anything that would require additional document metadata such as the title or author. This field will traditionally end in `\begin{document}`.

        • Footer

          Anything that would need to be declared at the end of the main and back matter. Commands to generate glossaries, indices and other footer material can be placed here.


      • Transformations

        The Text Options pane provides a number of useful text and format conversions, as well as a few presentation options. 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.


        • Convert "Smart" punctuation to \"dumb\" punctuation

          The three forms of punctuation that Scrivener can automatically generate as you type (and will by default), can be converted to ASCII-safe equivalents. This will be necessary for some programs like Final Draft, or for technical formats like LaTeX and XML. If you require different or more precise transformations, consider using [the Replacements compile format pane][format - replacements].

          * Typographic, curly or smart quotes will be straightened. The punctuation marks that will be used to repr...

        • Convert to plain text

          This option is provided to plain-text (.txt) and the Markdown-based file types. It is used to convert visual spacing found in the source text to literal whitespace characters, using approximation to add a number of spaces or carriage returns to emulate that visual spacing.

          This feature will make use of the formatting that results from any compile settings. If the layouts you use to print text do not modify the formatting, then the original formatting in the text editor will be used for conversi...

        • Convert italics to underlines

          For all rich text document types. If the submission process requires underlines to be used instead of italics, this feature will let you write in italics but produce a properly underscored manuscript.

        • Convert underlines to italics

          For all rich text document types. Use when you have produced a document with underlines, but need an italic version for compile.

        • Superscript ordinals in titles, synopses & metadata

          When enabled, ordinal indicators (such as "1st" and "2nd") will be detected and made superscript in fields that do not otherwise have formatting, such as titles, headers and footers. This detection is primarily tuned to English usage; you may find it has no effect or disrupts formatting in other languages.

        • Underline hyperlinks

          This and the following option are only available to the print and PDF file types. Hyperlinks pointing to external resources will be underlined by default. If you're looking to customise internal cross-reference style links in PDF files, refer to [the PDF Settings compile format pane][compile - pdf settings]. Disable this to make links less obvious to the eye.

        • Color hyperlinks

          External hyperlinks will be coloured blue, as per standard behaviour. Disable this for documents you intend to print in black & white format.

        • Add indent per outline level

          This special setting adjusts the formatting of each paragraph or line of text by increasing the *base* amount of indenting that will be applied to it, as determined by how deep the document is in the outline itself, relative the compile group selected.

          Thus if the "Draft" folder is selected for compile, a text file that is on level three will have three times the amount of points requested by this setting. At the default of 18pts, that would be 54pts of indent---exactly 3/4 of an inch or roughl...


      • MultiMarkdown and Pandoc Options

        The name of this pane will differ depending on whether the Use Pandoc syntax option is enabled in the Processing compile format pane. The difference is largely cosmetic, as the contents of this pane will be the same for either format.

        The "Basic MultiMarkdown" Format

        The built-in "Basic MultiMarkdown" format that ships with Scrivener will have these settings already wired up to named styles. If you use our default stylesheet while writing, you won't have to set these up! It's also a good starti...


        • Pandoc ePub Options

          When using the Pandoc (ePub) file type, a few additional options will be available from this panel:

          Format

          : Select between the older ePub 2 standard and the modern ePub 3 standard, as a basis for how the book should be constructed.

          Custom CSS

          : Optionally provide a stylesheet to alter the appearance of the book, which will otherwise use native appearance entirely left up to the e-reader device or software.

          It should be noted that when using the Pandoc ePub generator, you will have access to...


      • Replacements

        Format replacements are fundamentally identical to those replacements you can assign to your project's compile settings. Refer to [its documentation for complete usage notes][compile - replacements]. In terms of the purpose, you may find it better to use this list for the types of replacements that work in union with a specific format, rather than how a specific project works. To provide a few examples:

        • Changing the abbreviation of a place noun to its full proper name is probably better done...

      • Statistics

        The options in this pane fine-tune the working of those special placeholder tags that expand to display various statistics about the compiled document. 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 Insert//Draft Word Count// and Insert//Dra...


        • Exclude front and back matter

          These two checkboxes are enabled by default; they exclude any material in the selected front matter folder from statistics. Typically included would be items like the table of contents, acknowledgements, preface, and other material which is not generally counted as being a part of the main book. If for some reason you are using front matter for material which should be counted, then disable these options.

        • 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 Synopsis export for a [section layout][compile - section layouts], the note text will be added to the global count as well.

        • Only include...

          If instead you'd rather adjust the scope of what is counted, enable this option 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.

          * Main text. To adjust counting for footnote, endnote, or comment text, see below.

          * Notes

          * Synopses

        • Count footnotes, comments and annotations

          Footnotes and endnotes will be included in the total count; this is the default. Likewise if enabled, comments and annotations will be included in the count.

        • Do not count spaces in character count

          Enable this option if you require strict character counts. If you are unsure, check with your publisher for which standard they use.


      • Tables

        Contains options pertaining to the adjustment or presentation of tables.


        • Stitch together adjacent tables if possible

          This option (and its subsidiary options) are mainly useful for formats that require a single table for the whole document (such as certain documentary script formats), and should otherwise be left off. This capability will make it possible to use Scrivener's outline features freely, with numerous table based documents, and sew them all back together in the final compile.

          Causes any tables that are separated by only empty lines and blank spaces to be merged into a single table, provided that the...

        • Insert blank row between stitched-together tables

          A table row will be inserted with its border cell highlights hidden.

        • Restrict width of stitched-together tables to page width

          Use this to cause the table to resize itself if you change the page size.

        • Convert tables to images with maximum width

          Available to the word processing formats (excluding RTFD) ePub 2 and legacy Mobi. Tables can be converted to static graphics for a more consistent display on older readers that otherwise cannot display native tables properly. You can specify the maximum width, in effective pixels, used to generate the graphic.


      • Tables & Lists

        This pane is only available to ePub 3 and KF8 Mobi formats. You can set the style of table and bullet formatting used to generate the CSS for the eBook. The CSS itself will be presented in [the CSS compile format pane][compile - css] (in the "Default Stylesheet" section), where it can optionally also be tweaked, or replaced entirely by your own style. For those that would rather not do so however, several aesthetic options have been created for your selection here.

        For each type of element in t...

      • Footnotes & Comments

        Compile options for footnotes and annotations.


        • Footnote & Endnote Options

          Some of the options in this pane will, if the format allows for the distinction, be used to set up endnote and footnote formatting separately. Whether to use endnotes or footnotes is up to project's settings, in the [General Options tab of the compile overview screen][compile - general options], this pane only concerns itself with how these forms of notation should be formatted, should it become relevant.


          • Common Options

            This list of options pertains to common settings and those that impact footnotes specifically (not endnotes). Given how these options are scattered around in different places depending on which file type you're currently working with, the listing of options will be in alphabetical order, rather than attempting to adhere to interface order.


            • Footnote format

              Using the dropdown menu, you can select how footnotes should be numbered in the final manuscript. For the word processing formats (excluding RTFD) this option sets how footnotes should be displayed and numbered dynamically in the software you load the compiled file in. For formats that use static numbering, like PDF and TXT, this setting determines how Scrivener will do the counting.

            • Override font

              To use a separate font and size to print footnotes or endnotes, enable the checkbox and then click on the font button to bring up the font selection tool. This option will read "Override endnotes font" if the file type is only capable of using endnotes. As with all other font settings inside of a compile format, if the compile settings request a global font family instead of using the format fonts, only the size from this setting will be used.

            • Separator Style

              Lets you choose what form of separation you would like between footnotes and the [main text body](#compile-footnote-separator_types).


              • (footnote separator types)

                MISSING_IMAGE:/path/to/gfx/compile-footnote-separator_types.jpg

                Footnote separation as "None", "Full Page", "Centered" and "Default", from top down.


            • Footnote numbering restarts after page breaks (on each page)

              There are two forms of this option, in both cases, instead of keeping a running tally throughout the manuscript, footnote numbering will be restarted periodically. This can be done on every single page with the word processing formats, or after each page break with print and PDF.

            • Indent (footnotes and) endnotes to match text

              By default, footnotes will be first-line indented to the same degree as the last paragraph on the page preceding their listing. When disabled, footnotes will be flush left at the margin, regardless of any contextual formatting settings.

            • Use period and space style instead of superscript in markers

              This option conforms to the Chicago Style, where the foot or endnote is displayed full size. The marker in the text itself will remain superscripted. When used with the plain text format, the effect will be to use `42.` style numbering in the endnote listing, instead of `[42]` style listings.

            • Footnotes/Endnotes use single line spacing

              Available to RTFD, print and PDF. Ordinarily endnotes will acquire paragraph spacing settings from the paragraphs they were referenced from. Thus a double-spaced manuscript will have double-spaced endnotes as well---which is typically the desired look. However in some cases you may need single-spaced endnotes, even if just to provide uniformity in cases where endnotes came from texts with disparate base formatting.


          • Common Endnote Options

            As with the previous section, the options here will be listed in alphabetical order.


            • Endnote format

              Likewise to Footnote format, endnote numbering is adjusted with the dropdown menu. If a document is using both footnotes and endnotes, they can be printed using their own numbering streams. Even if the format is the same, they will not share numbers and will both start at "1".

            • Endnotes placement

              Available to RTFD, print, PDF and plain text. This determines where endnotes will be gathered in the document:

              * *End of document*: this is of course the default setting.

              * *Before page breaks*: the endnotes for the current section of text, counting from the last page break, will be gathered directly preceding the next page break (what would typically be a chapter or other major break in a longer work).

              * *Before last page break*: this option will insert endnotes at the end of the second to ...

            • Insert separator before endnotes

              Available to RTFD, print, PDF and plain text. Inserts a separator between the endnote list and the final document in the compile group list. This will be a series of hyphens when using the plain text file type.

            • Group endnotes by section with subheadings

              Available to RTFD, print, PDF, plain text and all of the eBook formats. Wherever the endnotes are gathered, their listing will be subdivided by the section (as defined by section breaks or page breaks) they came from.. Without this option, all endnotes will be displayed together in one long list.

            • Endnote subheadings font

              When the prior option is enabled, this setting becomes available. Use it to adjust the font and size of the text that will be used to subdivide endnotes into sections.

            • Center subheadings

              Use centre alignment for the endnote subsection headings, instead of ragged right.


          • Plain Text Endnotes

            In plain text files, endnotes will be used by necessity as there are no pages to place end of page notes on. Footnote markers in the main text will be printed using a conventional square bracket to denote them, such as `[42]`.

            Plain text endnotes can be gathered somewhere other than the end of the document, with the Endnotes placement setting. For the case of plain text, where these options refer to "page breaks", the meaning is where a page break *would be*, were the document compiled to a fil...


            • Embed footnotes inline

              This checkbox broadly changes how Scrivener will export endnotes, by placing their content inline with the base text instead of using a reference marker with the content located elsewhere. While the default behaviour will be better for producing .txt files meant for reading or long-term archival, this alternate method will allow for technical formats that embed footnote syntax directly into the text (typically displaying it more traditionally once the source files are typeset).

            • Enclosing markers for footnotes

              This is used to wrap the entire footnote text in markers, [to distinguish it from the main body text around it](#compile-footnote_markers). Both fields are optional, and if left blank there simply will not be a visible delimiter on that side of the range of text.

              Carriage returns can be inserted (using the usual OptAlt-!Return trick) into these fields if needed, though it should be noted that with some formats this may break the source paragraph it came from in two.


              • (Enclosing footnote marker example)

                MISSING_IMAGE:/path/to/gfx/compile-footnote_markers.jpg

                Footnotes are enclosed ASCIIdoc syntax, with the compiled results colour-coded for clarity.


            • Enclosing paragraph markers for footnotes

              If footnotes comprise multiple paragraphs of text, some forms of syntax will require them to be marked as paragraphs. Scrivener will insert these markers around *every* footnote line, even if a footnote does not have multiple paragraphs. [](#compile-footnote_para_markers) demonstrates the capability using pseudo-XML.


              • (Enclosing para markers for footnotes)

                MISSING_IMAGE:/path/to/gfx/compile-footnote_para_markers.jpg

                Caption for the image.


          • HTML and Legacy eBook Endnotes

            By and large eBooks make use of endnotes, since they do not have literal pages to draw "footnotes" upon. Endnotes are typically handled as cross-references using hyperlinks to and from the note and original text. Scrivener will handle all of that wiring for you, and will use conventions that with some book readers will be used to present endnotes in popup bubbles when your readers tap or click on them

          • ePub 3 and KF8 Mobi Endnotes

            The previous notes on how eBooks work with endnotes all apply to these more modern formats as well. The main difference is that Scrivener affords you additional formatting control when using them, through the use of compile format styles rather than a few hand-selected options.


            • Reduce marker font size

              The reference marker in the main text will be shrunken when this option is enabled. With ePub 3 and KF8, you also have direct control over this via the `.fn-marker` with CSS.

            • Endnotes page title

              The section name for the table of contents entry that will contain the endnote list. By default this uses the conventional "Notes". The formatting for this heading will be determined by the Page title style setting, in [the compile format pane][compile - html elements].

              For this and the following two options, the CSS class used for these elements in ePub 3 and KF8 will match the name of the style you created and selected for them. Refer to the `/* Styles */` section of [the default stylesheet][...

            • Endnotes style

              Available to ePub 3 and KF8 Mobi. Select from the list of paragraph styles in the compile format to use for formatting endnotes in the book. This dropdown will be empty if you have yet to define any [compile format styles][Styles]. The default "Base text formatting" setting will use normal eBook text settings to display the note font.

            • Section subheadings style

              As above. When Group endnotes by section with subheadings is enabled, use this dropdown to select a paragraph style to format these headings by.


        • Comment & Annotation Options

          As with footnotes, whether inspector comments or inline annotations appear in the output is entirely up to the project's compile settings. The format merely determines how these elements should be formatted or handled.


          • Export Comments and Annotations as...

            This dropdown menu is only available to the word processing file types.

            * *Margin comments*: exports your notes into a format that most word processors will display as a margin comment or "speech balloon" style comment. For most workflows this will be the most desirable option, and it is the default.

            * *Inline comments*: if comments are not showing up for you using the above option, this method will print them as inline text, and will cause even comments to use the Enclosing markers for annot...

          • Enclosing markers for annotations

            Annotations will be enclosed in two markers that will be used to delineate them from the rest of the text. In conjunction with a plain-text system, you could modify these to conform to the target file type's commenting conventions. Someone who is publishing in HTML might for instance wish to use the open and close syntax for HTML comments.

            Most of the built-in compile formats use square brackets to denote annotations. The "Basic MultiMarkdown" format will use CriticMarkup syntax: `{>>annotation...

          • Use format for comments

            Available to plain-text as well as the Markdown-based format. When ticked, linked comments will be formatted using the following text field as a template. You can supply syntax to wrap around the content of the comment, and even refer to the hyperlinked text in the editor that has the comment highlight, [as well as make use of a few placeholder values for comments][Comment Syntax Placeholders].

            A simple example would be for the generation of CriticMarkup syntax:

            {==<$lnk>==}{>><$cmt><<}

            A mo...


            • Comment Syntax Placeholders

              Placeholder

              Description

              `<$cmt>`

              The content of the comment itself, as it appears in the inspector or popup bubble when clicked on.

              `<$lnk>`

              The visible text that was highlighted as associated with the comment in the main editor.

              `\<$n>`

              Although it resembles the main auto-number counter that can be used elsewhere in the manuscript, when used in this context it will automatically be scoped to comments alone (similar to using `\<$n:comment>` by hand), and it will only be incremented *once* per c...


          • Markdown-Based Annotations

            When using the MultiMarkdown and Pandoc compile formats, the name of this format panel will be changed to "Annotations", as it will only pertain to the formatting of inline annotations and comments. In addition to the relevant options documented in the prior section there is one exclusive option available to these file types:


            • Convert annotations to HTML-style text

              Available for plain MultiMarkdown/Pandoc, MMD (HTML) and Pandoc (ePub). This option will cause inline annotations and comments to be exported into the text as HTML, using either a span or div element depending on whether the annotation is embedded within another line of text or if it embodies the entire paragraph, respectively. The HTML elements will have an inline style applied to them, setting their colour to match the annotation colour as seen in the editor, and will be classed as "annotation...

            • Using Markdown inside HTML-style annotations

              In cases where an annotation falls entirely on its own paragraph, Scrivener will use a div instead of span elements to wrap the comment within. 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...


      • Page Settings

        The file types that work with a concept of physical paper, this is where you will set up that paper size itself (or defer that setting to the project, which is most often the preferred use since whoever uses your template may want A4 instead of Letter or vice versa) and the width of its margins. The Final Draft format can also handle simple headers and footers.

        The print, PDF and word processing formats (as usual, excluding RTFD) also have page header and footer capabilities, as well as offset ...


        • Previewing your Settings

          The Preview button on the right-hand side can be used to get a feel for the margin settings and paper shape. When using formats that allow for header, footer and page layout options, the settings in the "Headers and Footers" section can add additional variations to the preview, and the headers and footers you design will be previewed in this tool as well. For example, if the Use facing pages option is ticked, then the preview will let you flip between a preview of the recto page followed by the ...

        • Use project page settings

          The project's print settings (made in the File//Page Setup... menu, including those under the "Scrivener" section at the top) 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 and cause the format to use a fixed paper size. This will be useful when creating formats for a specific purpose, like printing a mass-market paperback novel.

        • Choosing Paper Settings

          Click the Page Setup... button to bring up a dialogue for setting paper size, orientation, scale and other basic printer settings.

          The Use default paper size checkbox can be used to selectively defer that option to the project, and ultimately the individual writer's system printer settings. Use this if paper size doesn't matter to the format and all you want to do is define the layout and content of the margins, headers and footers.

        • Setting Margins

          Click the Margins button to set how far from the edge of the paper stock the text container will extend to.

          For file types that support the Use facing pages option, symmetrical margins will be used. The settings you input will be for the *recto* page, with the *verso* page mirroring the left and right margin values.

          The current margin settings will be printed in lighter grey text alongside the button for your reference.

          There are additional options available when using the "Print" compile typ...


          • Header & Footer margin

            Designate the distance of the header from the top of the paper, and from the bottom of the paper for the footer. This distance does not take the margins into account, and should not exceed the margin size so as to avoid running headers or footers into the body text.

            To disable this feature, set the distance to "0". The result will be to place the header or footer within the top or bottom inch (regardless of units used) of the paper.

          • Confine to printable area of page

            With this option disabled, the non-printable area of the paper will be ignored, meaning you can place elements into that zone. This may be of use if you are intending to create a digital-only copy that will never be printed. When enabled, measurements will be adjusted to keep all text within the printer's ability to print it.


        • Header and Footer Options

          The first tab in the header and footer section governs broad settings for how headers and footers should work, as well as enabling additional features in the second tab. For example you won't be able to set up where the page number is located on facing pages, in the second tab, if you don't first enable Use facing pages here.


          • Different header and footer on first pages

            Enables the "First Pages" header and footer configuration section in the second tab. "First pages" generally refers to front matter, and is how you would use for example lowercase Roman numerals for page numbering if need be. It can also be used for simply omitting headers and footers through the coversheet and title page of a manuscript, too.

          • Page numbers count first pages

            This option will cause the page counter token to start counting the first pages, rather than skipping them, even if they do not display a page number. If you are using Roman numerals in the front matter, then regular numbering will begin where they left off. For example if there are four pages of front matter the page numbering would go from "IV" to "5", instead of from "IV" to "1", which would be more traditional.

          • Main body header and footer starts...

            This setting defines what is meant by "first pages" elsewhere in the panel. You can choose to offset the alternate header & footer settings by a strict number of pages (for example, "2" to consider a coversheet and title page as separate from the main body), or have the starting point determined automatically, using the "After front matter" setting.

            [Front matter is defined by the Front Matter dropdown in the project's compile contents settings][Front & Back Matter]. If the project does not hav...

          • Use facing pages

            Enables the "Facing Pages" header and footer configuration section in the second tab. If your margin settings are asymmetrical, as illustrated in [](#compile-page_settings-facing_pages), this will also have the effect of mirroring those settings from one page to the next, creating a narrower inner or outer margin (in the sense of how both pages would look in an opened book side by side) as you require. If you require symmetrical margins, such as in PDFs meant for digital use only, make sure to k...

          • (facing pages example)

            MISSING_IMAGE:/path/to/gfx/compile-page_settings-facing_pages.jpg

            Margin settings, using the classic Van de Graaf Canon layout, as demonstrated in Scrivener's preview feature.

          • Different header and footer on pages following page breaks

            Enables the "First Pages" header and footer configuration section in the second tab. This will allow for a different header and footer configuration on new pages---a common use here is to place the page number at the bottom of the page instead of at the top, to keep the chapter heading clean but still leave the page numbered.

          • Different header and footer for back matter

            Enables the "Back Matter" header and footer configuration section in the second tab. All pages that have been inserted using [the Back Matter dropdown in the project's compile contents settings][Front & Back Matter] will use these settings instead of the main body settings.

          • No header on new pages following page breaks

            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 area for part and chapter breaks clean; a common typesetting technique, as shown in [](#compile-page_settings-no_header).

          • (suppressed header on new pages)

            MISSING_IMAGE:/path/to/gfx/compile-page_settings-no_header.jpg

            The page header is suppressed (blue emphasis) on the chapter break page, but otherwise displays the name of that chapter in subsequent pages (tan emphasis).

          • No header or footer on...

            When these checkboxes are enabled, both the header and footer will be removed from the pages that match their respective checkboxes:

            * *Single pages*: when the amount of material between two page breaks amounts to a single page; this would most often be seen in cases like book or part level breaks, where a full page is dedicated to some sort of title.

            * *Blank pages*: where blank pages are generated in the book, they can also have the header and footer removed from them, as is typical. A com...

          • Header and footer fonts

            At the bottom of the "Headers and Footers" section are two settings for controlling the font and text size of these respective fields. The font family itself can be overridden by the project's compile settings.

          • The font I've chosen is ignored in my word processor

            Make sure the font you select here is used within the document somewhere other than the header or footer as well. Limitations in how this feature work require the font be defined somewhere other than the header or footer fields alone.


        • Print and PDF Settings


          • Draw dividers for...

            A margin-width rule (similar to the appearance of the header in this user manual) will be inserted below the header text, or above the footer text, when these respective checkboxes are enabled.

          • Use vertical headers and footers

            Both the header and footer will be rotated vertical, so that the header is along the left edge of the paper and the footer is along the right. The text itself (and a divider is used) will also be rotated 90°.


        • Header and Footer Text

          MISSING_IMAGE:/path/to/gfx/compile-page_settings-header_and_footer.jpg

          The header and footer fields are used to place information on six predetermined points around the edge of the page.

          The header and footer area is divided into sections, or types of header and footer assignments, listed in a sidebar. The number of available sections will be determined by which settings you have enabled in the Options tab, previously. In [](#compile-page_settings-header_and_footer), we have selected the Use fa...

        • Sectional Page Headers

          For use with print, PDF and the main word processing formats, the `\<$pageGroupTitle>` placeholder tag can be placed into the header and footer field to print out the title of the current section (including any suffix or prefix modifications made by the section layout) of the item which last caused a page break. This header will be used for all subsequent pages until another page break is generated.

          Looking to get rid of section breaks?

          Use of this feature in conjunction with the word processin...

        • Useful Header and Footer Placeholders

          Placeholder

          Description

          **Available to Header and Footer fields**

          `\<$compilegroup>`

          The current compile group. If you wish for this to be more descriptive than "Draft", you can change the name of the Draft in the Binder to be the name of your book.

          `\<$projecttitle>`

          Project Title, as set in the project's compile settings in the overview screen, or falls back to the name of the project file itself if none has been specified.

          `\<$abbr_title>`

          Also defined in the project's metadata settings tab....


      • RTF Compatibility

        Scrivener's default RTF exporter supports features that may not be supported in other word processors. 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 available to RTF, DOCX, DOC and ODT formats.


        • 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 themselves will be. This results in a block of text that "flattens" the table contents into a long list. Generally you will not want to use this unless the target application completely fails to render tables.

        • Flatten footnotes and comments into regular text

          Use this feature when the target word processor fails to properly display footnotes and/or comments. For example, Apple's free TextEdit program cannot display these kinds of notes at all, and if a file is opened with them, edited and then saved, they will be lost.

          When enabled, all footnotes and comments will be converted to formatted text instead of proper numbered notes. Since the notion of a footnote requires pagination to place the footnote at the bottom of the page, the end result is that ...

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


      • Processing

        The Markdown-based workflow allows for compile post-processing through this pane.


        • Use Pandoc syntax

          Available when using the MultiMarkdown compile file type. Adjusts the syntax that Scrivener generates, where it does so, to produce Pandoc compliant Markdown dialect. This will mainly impact the metadata block (producing YAML format) and image scaling codes.

        • Post-process on command-line

          Tick this checkbox to enable the remainder of the options in this panel. This will alter Scrivener's compile behaviour significantly, in that it will no longer solely produce a text file where you choose to compile. Instead that file will be further processed by the settings you specify in the fields below.

          The values you provide will be saved even if the checkbox is later disabled. This can be useful if you wish to provide post-processing as an optional behaviour in the compile Formats you dis...

        • Script & Path

          This dropdown provides two selection options, "Script" and "Path", which determine whether to point Scrivener to an external utility or script on the system, or use a script stored directly within its compile settings:

          * Path: The full path to the executable script or binary should be supplied in the text field to the right. Shortcut notation will not be handled as the execution environment will not be a full shell. An example full-path would be `/usr/local/bin/pandoc`.

          * Script: when this op...

        • Edit Script

          The Edit Script button, which will appear when Script is selected above, contains an interface for you to input your custom script.

          Shell

          : by default Scrivener will pass the script to `/bin/sh`, so if you intend to write a simple shell script, you can leave this field blank. You may also leave this field blank if you intend to provide a "hash-bang" line on the first line of your script, such as `#!/usr/bin/ruby -Uw`.

          Script Entry Area

          : Input your script into the large text editing field prov...

        • Arguments

          All necessary command-line arguments (or flags) should be supplied in this field. In order to provide your script or utility with the necessary input file to be processed, as well as the name of the output file chosen by the user, you will need to use a couple of placeholder tags that only work in the Arguments field:

          • `<$inputfile>` will provide the full path to the file that Scrivener would output normally. This will typically be the file that is used as primary input for the script.

If om...

        • Environment

          As the script will be executed in a very limited non-interactive shell, you may need to supply a fuller path environment, which will be added to the existing default PATH variable. For example:

          `/Users/myaccount/bin:/Library/TeX/texbin`

          If you need to set additional environment variables other than the PATH, you should set them up in a wrapper script.

        • Delete source file after processing

          The plain-text file created by Scrivener can be optionally removed after it has been processed. This file will be provided to the post-processing script via the `<$inputfile>` placeholder in the Arguments field. Ordinarily it will be included along with the final output for your reference, but if all you want is the eventual and final output itself, enable this option to omit the source file.

        • Delete exported image files after processing

          When the compiled document includes images, using one of the methods described in [Markdown and Scrivener][mmd -images], or when exported via the [Markup] pane for Plain Text, those images will be exported into the compile folder for optional use by the source file. As with the source file itself, the presence of these images may be undesirable if all you want to get when you compile is, for example, an .epub file that already has those images included within it. Use this checkbox to have all of...


      • PDF Settings

        Note on: Portable Document Format (PDF)


        • Generate PDF outline

          Assembles a nested list of items that will appear in many PDF readers which support a content tree. It *will not* generate a visible table of contents in the printable work itself, only in the menus and sidebars of applications which utilise PDF content lists. For visual table of contents, read the [chapter on quickly making your own][Creating a Table of Contents].

          For an item to appear listed in the PDF contents, it must be assigned to a section layout that generates a visible title. The titl...

        • Underline internal links

          If you intend to print the PDF at any point, you will probably not want to colour or underline internal cross-reference style links, so this feature has been disabled as a default. For PDFs which are intended to be used purely digitally, underlining and/or colouring links is an important and valuable way to communicate clickable links to the reader.

        • Color internal links

          Enables internal link colouring. Hyperlinks to URLs will always be coloured in blue, as is the standard. You can select a different colour for internal cross-reference style links to set them apart. Click the colour chip to select a colour.


    • 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]. 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 us...


      • 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 (<$custom:shortcut>). This will by default also export any descendants of the selected items as well. You can change this behaviour by enabling the Do not export subdocuments setting, found in the "Options" tab of the Export panel itself.

        When exporting more than one file, Scrivener creates a folder on the ...

      • Metadata and Options

        The export panel features the following settings in two tabs. The Metadata tab enables additional material to be exported, and will be useful if you are preparing an archival backup that can persist long beyond your use of Scrivener:

        Notes

        : Document 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). The naming convention will be "(Binder Title) Notes".

        Metadata

        : The creation & modification dates,...

      • Exporting to an Outliner with OPML

        Many outliners support a common format known as OPML. It can describe "headings" which are what you see in the binder as names of items, and the relationship between those headings in terms of order and depth. This method is intended for exporting an indented outline, rather than exporting metadata. If you wish to export tabular metadata lists, try [Exporting Metadata to a Spreadsheet]. There is a loose convention followed by some outlining programs to attach plain-text "notes" to outliner hea...


        • Usage

          Usage notes for OPML export.


      • Exporting Metadata to a Spreadsheet

        Outliner views can be exported to files suitable for loading in spreadsheet software, like LibreOffice Spreadsheet or Microsoft Excel; many databases and other miscellaneous programs that support tabular data, such as DEVONthink Pro, may also read the file. This method is primarily intended for tabular data export. If you would prefer a hierarchal export more suitable for outlining, you might want to try [Exporting to an Outliner with OPML][exporting - opml]. To export spreadsheet information:

        ...


    • Printing

      Introduction to the basic concept of printing items straight out of the binder, as opposed to printing as a function of the compile system.


      • Document Printing

        Concept of printing text content out of documents.


        • Text Document Print Settings

          Available options for Mac text document printing.


          • Header


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

            • File name and date

              Inserts the selected binder item's name next to the page number in the header area. If more than one document has been selected the project's file name will be printed instead.


          • Content

            This section is similar to [the "layout content columns" in the upper half of the Section Layouts compile format pane][Layout Content Columns]. You can optionally add metadata 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.

            Title formatting will be determined by your current Scrivenings title font settings (even if you do not display titles in Scrivenings), in [the Appearance: Scrivenings !preference pane]...

          • Options


            • Remove annotations

              By default inline annotations will be removed. Tick this option to include them, using their original colour, and enclosed in square brackets to help identify them when using a black and white printer.

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

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


      • Printing Index Cards

        Introduction to the concept of printing a visible corkboard as physical 3x5" stock index cards, either on a sheet of paper, perforated stock, or individual index cards fed into the machine.


        • Index Card Print Settings

          Mac specific tuning options for index card printing.


          • Content


            • Include titles

              By default the title of each binder item will be printed at the top of the card. Untick this option to focus more on the synopsis content. The following two options will have no effect when this is disabled.

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

            • Highlight titles with label color

              The background of the title area will be highlighted with the card's assigned label colour, if relevant.

            • Add card numbers

              This is similar to View//Corkboard Options//Show Card Numbers feature. Each card will be numbered relative to the visible cards, starting at 1.

            • Include keywords

              When enabled, all keyword names will be printed out in a comma-delineated list below the title.


          • Options


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

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

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

            • Print using font

              Override the default font with your preferred font family and size.


        • Tips for Printing to Individual Cards

          Tips on how to set up the printing settings for individual index cards, fed into the printer one by one.


      • Printing Outlines

        Introduction to the concept of printing from the outliner.


        • File name

          The name of the container that is having its contents printed will be placed in the header of the page. If the editor contents are from a selection rather than a particular folder or other group, then the file name of the project will be printed.

        • Titles

          Each item's binder title will be included in bold text. Tick the Prefix titles with number checkbox to include a simple number count (non-hierarchical) for each item in the outline.

        • Synopses

          The full synopsis will be printed for each item.

        • Label and status

          If the label and status have been set they will be added to the title. 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 metadata area.

        • Keywords

          Keywords will be added on the line above the synopsis, in the content area, in a comma-delineated list.

        • Custom metadata

          Any custom metadata assigned to the item will be added in the metadata area, one field per line for each metadata 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.

        • Word counts

          The word count for each item individually will be placed into the metadata area. Optionally ticking the Include targets with counts checkbox will print the goal for each item individually following its word count.

        • Character counts

          As above, only printing the character count (and optionally goals as well) instead.

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

        • Font

          Select which font and text size you would like used for the printout.


      • 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 most of the options available to you when compiling a PDF will be functional. The few options that are not available pertain to such things that are not relevant to a printout, such as hyperlink appearance and behaviour, and the PDF's built-in table of contents. To p...


        • (see also)

          • Read [Compiling the Draft] for more details on how to compile.

          • If you want to print a script, read [Printing or Exporting a Script] for tips.


      • Other Print Settings

        Secondary options available for when printing web page archives, PDFs and graphic files.


  • Appendices


    • Menus & Keyboard Shortcuts

      This appendix will address each entry in every menu, and will display the keyboard shortcut for it where available. 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 where necessary.

      The menus in Scrivener are divided into several domains, into each we attempt to organise groups of functions respectively. If you are looking for a particular feature and are not sure w...


      • Menu Organisation

        Menu Title

        Purpose of Menu

        Scrivener

        <$macOSOnly> The main application menu is where overall application settings and information can be accessed. Changing preferences, setting up registration information, and quitting the software can be done from here.

        File

        Concerning the management of projects, including the transfer of information into and out of them, either manually with import, print & export, or automatically with backups and synchronisation.

        Edit

        If a function will work with the *conte...

      • Custom Keyboard Shortcuts

        There may be certain menu items that you find yourself using a lot that have no keyboard shortcut, or maybe you find the assigned shortcut overly convoluted. Scrivener includes many menu commands which are meant to be used with custom shortcuts. The ability to change or assign keyboard shortcuts to menu items is built right into macOS itself:

        1. Go to your System Preferences (available from the Apple menu in any application).

        2. Load the "Keyboard" panel and select the "Shortcuts" tab.

        3. Se...


        • Resolving Conflicts

          Keyboard shortcuts on macOS work by scanning the menus from left-to-right looking for a menu item matching the shortcut pressed. If you find that the shortcut you assigned doesn't work, or does something unexpected, it may be that the keyboard shortcut you chose is already assigned to a different menu item. In that case, you can either pick a different shortcut, or you can locate the menu item that it clashes with and go through the above process again to assign a different shortcut to the clash...

        • Menu titles that change dynamically

          Some menu items change name depending on the context; for such items, you may need to assign the same keyboard shortcut for each of their possible names. For instance, the Edit//Add Link... menu item can sometimes change its title to become Edit//Edit Link... Therefore, to add a keyboard shortcut to that item that would work consistently, you would need to add the same shortcut twice, once for `Add Link...` and again for `Edit Link...`.

        • Menu titles that are duplicated

          Sometimes a menu title will be used more than once. This most often happens with titles that are created dynamically from your project information. A good example of this is Navigate//Collections//Name Of Your Collection and Documents//Add to Collection//Name Of Your Collection. If you created a shortcut called `Name Of Your Collection` alone, this would be bound to the initial shortcut that shows the tab in your binder, not the command that files the current document into that collection. To ta...


      • Scrivener Menu

        Much like the application menu in any other macOS 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. Click on the version number to copy this information to the clipboard and dismiss the window.

        • Preferences...

          Accesses the main application preferences window. For a complete list of all available options, see [Preferences][]. POST// make sure this cross-ref works properly with the replacements going on.

        • Themes//

          This submenu will list any preset themes that you have created or installed into Scrivener. To switch appearance settings, select the desired theme from this list. Refer to [!Preference Presets and Themes] for further information on managing themes.

        • Reveal Support Folder in Finder

          Opens Scrivener's "Application Support" folder, where it stores your presets, custom project templates, custom icons, and so on. Use this if you wish to transfer settings between machines, or if asked to do so for troubleshooting reasons.

          test

        • Authorize Folder Access...

          <$mas> Opens a window where you can manage a list of folders to grant Scrivener additional privileges in accessing your disk. If you make use of file links, research aliases or image links, you might wish to authorise the folders they are in, or even your entire user folder so that Scrivener can make use of these files without explicit permission per session.

        • Registration...

          <$direct-sale> When you purchase the application, use this menu item to copy and paste your registration information from the email that you will receive from Literature & Latte. In case you have lost the original email 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.

        • Check for Updates...

          <$direct-sale> You can use the Check for Updates menu item to see if there is a newer version of Scrivener available for download (3.x updates are free). If any are found, you can update the software conveniently from this tool. You can also choose to have updates applied automatically in the future, and this check can be performed routinely as well, in the [Startup tab of the general preference pane][general - startup].

        • 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][] for further documentation.

        • Quit Scrivener

          Leaves the program. Any projects that are left open will be saved to the disk, and by default, backed up for you. Under the default preferences, these projects will be remembered and opened automatically the next time you run Scrivener.

        • Quit and Close/Keep Windows

          Whether this will "Close" or "Keep" open projects upon next reload depends upon whether your preferences are set to [reopen projects that were open on quit][general - startup]. Which is displayed will be the opposite of whatever your standard settings are. This will not change your preference, it only influences how the software works this one time.


      • File Menu

        The File menu contains everything that handles creating files on your computer, including creating new projects, saving, backing up, importing and exporting. It also deals with printing and project-specific settings.


        • Project Management


          • New Project...

            Brings up the Project Templates window which will walk you through creating a new project in the location you specify.

          • Open...

            Brings up a file selection dialogue for opening an existing .scriv project on your hard disk. Full read-write permissions must be set for a project to be opened successfully. Older projects may need to be updated; you'll be walked through that process if necessary.

          • Recent Projects

            Here you can review a list of projects that have recently been used recently and select one to open it (you can also specify in the [General Preferences][general - startup] whether Scrivener will reopen all projects that were open in a previous session when it is launched).

            The number of items listed in this submenu is governed by your macOS' global preference, which can be set in the "General" system preference pane.

          • Favorite Projects

            Displays a listing of all the projects on this machine that have been flagged as a "favourite". Use this to load or activate the window of the project you select. Read more about it in [Setting Favourite Projects].

          • Add|Remove Project from Favorites

            Adds or removes the currently active project to the aforementioned "Favorite Projects" list.

          • Show Project in Finder

            The active project will be located and presented to you in a new Finder window. This information can also be acquired from the project window title bar, by right-clicking on the name of the project itself.

          • Find All Projects in Spotlight

            <$direct-sale> Runs a Spotlight search, bringing up a Finder window with the search results of all Scrivener projects included within the remit of the Spotlight index. It is important to distinguish the difference between this and searching your entire computer for projects. The Spotlight index may not include drives you have specifically omitted, or external drives you have plugged into the computer. It will also not locate zipped projects (usually a result of automatic backups).

          • Close Project

            Closes the current project and all of its associated windows. The project will be automatically saved upon close, and under default settings will be backed up.

          • Close Project and Clear Interface Settings

            When holding down the Option key and viewing the File menu, you'll see this command for closing a project. This will safely shut down the project and as a final step, trash the project's "UI" preference file. All options such as visible elements (rulers, inspector, etc), splits, label tinting, columns, and other settings will be factory reset. Ordinarily, 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

            Closes the currently active window (e.g. Quick Reference, or utility panel). However if the project window has focus or is the only open window for the project, the entire project will be closed instead. Composition mode must be exited explicitly, it does not respond to this command.

          • Save

            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 the save command to force an immediate save whenever you want.

          • Save and Rebuild Search Indexes

            When holding down the Option key you can manually rebuild the search index while saving. This is sometimes useful in cases where you suspect the project has lost synchronisation with the search index. There is typically no need to do this as Scrivener will automatically maintain indexes, and it will rebuild its index if something appears to have gone awry since the last session.

          • Save As...

            Will prompt you for a new project name and/or location. When you submit this dialogue box, Scrivener will immediately start working with the *new* copy, closing the version you had been working on up until that point. If instead you want to generate a backup copy and keep working with the original project, use File//Back Up//Back Up To... instead.

            For more information on managing projects, refer to [All About Projects][].


        • Import & Export


          • Import//

            Commands for importing a variety of existing information, from your drive or even from the Internet, into your active project. For full documentation on importing information into Scrivener, refer to [File Import].


            • ↳Files...

              Importing files

            • ↳Web Page...

              Import a web page from the Internet by supplying Scrivener with its URL. By default it will be archived to an offline format, retaining its look and feel using the WebArchive format (same as when saving a page from Safari). You can optionally choose to import only the [raw text of the page][sharing - import].

              This method of importing is also available from the Add button in the main application toolbar.

            • ↳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 about [Linking to Research Material] for further details.

            • ↳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 programs like Movie Magic Screenwriter that work with plain-text files for import and export. This does *not* support the Fountain format. Fountain files can either be imported normally with the File//Import//Files... command, or with the File//Import//Import and Split... command, to break the imported file up by slugline.

            • ↳Scrivener Project...

              Import a selected Scrivener project into the current project's binder. All binder items will be imported, as well as some metadata: keywords, references, and notes. If it is detected that the imported project appears to be an older version of the same project you are importing into, you will be offered a chance to merge the projects together. Refer to [Merging Projects][] for further information.

            • ↳Import and Split...

              This is a multi-use tool which can either takes a standard plain or rich text file and allows you to supply a character sequence (such as "#") which will be used to split the document into sections, or for some formats, intelligently break the file up by logical sections based upon the internal format of that file. For example a Word document with a stylesheet based outline can be converted into a nested binder outline, a Markdown file can be split into an outline via its heading structure, whil...


          • Export//

            Provides tools for exporting elements of the binder to the file system. For more information on exporting your work, see [Exporting][].


            • ↳Files...

              Exporting files

            • ↳OPML File...

              Exports the current binder selection as an Outline Processor Markup Language file. OPML files are commonly read by applications that work in outline oriented data, like Scrivener, and is thus a convenient way of transferring hierarchal information (or the file tree) between such programs. See also: [Exporting to an Outliner with OPML][exporting - opml].

            • ↳Outliner Contents as CSV...

              When an Outliner view is selected, this menu command will activate. It will export the current outliner in a format that is readily accessible to spreadsheet software and other programs capable of tabular display. See also: [Exporting Metadata to a Spreadsheet][].

            • ↳Comments and Annotations...

              Exports only the comments and annotations from the project into a single file. You can optionally choose to export only pre-selected binder items and select whether the list is organised by binder titles.

            • ↳as Scrivener 2 Project...

              Save a copy of your project in the legacy Scrivener 2.x format, capable of being freely worked upon with this older version of Scrivener, as well as version 1.x for Windows. Refer to [Saving Your Projects for Older Versions] for usage tips.


        • 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][], and [Working with Scrivener for iOS][]


          • ↳with Mobile Devices

            Forces Scrivener to check the current project for mobile changes. In ordinary usage this will not be necessary as these checks are performed automatically when switching to the project from another window and of course when loading the project. If the project window has been open and active while using iOS to edit it remotely, then you will want to use this command to bring the project on your computer back in sync.

          • ↳with External Folder...

            Method for creating folders with plain-text, rich text, Fountain or Final Draft files on your system. The export location can be anywhere, including network mounted drives or synchronised folders such as provided by Dropbox, Google Drive, iCloud Drive and SpiderOak. It is thus useful for coordinating with collaborators or even just working on pieces of your project while on the go. See also: [Synchronised Folders][].

          • ↳with External Folder Now

            Runs the external folder sync tool immediately without loading the configuration window. If External Folder sync has not been previously set up, it will load the configuration window for you.


        • Back Up//

          Functions for managing backup copies of the current project. For more information on back up strategies, see [Backing Up Your Work][].


          • ↳Back Up To...

            Generates a complete 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. Optionally, you can choose to compress the backup in a zip archive, which takes longer, but is the recommended method for storage of backups, particularly if you intend to copy the backups over the Internet in one form or another.

          • ↳Back Up Now

            Triggers the automatic backup system to produce a backup immediately, using the established preferences for backup location and rotation scheme. Customise how this works in the [Backup preferences tab][prefs - backup].


        • 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. Every single aspect of the project will be saved, including any content you leave in the binder. For more information on creating templates, read [Project Templates][].

        • Print & Compile


          • Page Setup...

            Accesses the standard page layout setup sheet. Additionally accesses Scrivener specific features from the Settings dropdown menu within this sheet. Most compile formats will use these settings to determine paper size and margins, as well as for current document printing (below). Compile formats can be further configured to use their own settings, including full two-page layouts with offset margins. For full documentation on the standard printing process, read [Printing][].

          • Print Current Document...

            Prints the current editor view. How this will be printed depends on the view mode, with all of settings for this accessed through the File//Page Setup... command, above.

          • Compile...

            Compile is the standard method for producing a manuscript out of all the individual pieces in the Draft. This feature provides an immense degree of flexibility, and is fully documented in [Compiling the Draft][].


      • Edit Menu

        The Edit menu contains options related to editing content. 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.


        • Basic Editing Commands


          • Undo & Redo

            This and the followings section use As-Is formatting as they are compound entries to multiple standard commands. They cannot be used for shortcut cross-referencing.

          • Cut, Copy, and Paste

            Cut, Copy, and Paste Cmd-X, Cmd-C & Cmd-V

            : Cut, copy and paste act exactly as they do in other applications. These commands will not act upon documents that you have selected. They will work primarily with text, but can sometimes also be used to copy and paste metadata like bookmarks or keywords. This manual will make note of where copy and paste can be used for non-textual edits. For editing documents, refer to the [Documents Menu][].

          • Copy Special//

            This menu allows you to copy text or binder items using functions to create specially formatted lists of items, remove markings from the text or convert the text to different formats.


            • ↳Copy Document as External Link

              Copies a URL to the clipboard which can be used to link to the selected item from any other software supporting links on your computer. You could for example paste this URL into the hyperlink URL field of your word processor, creating a link from that document to a particular item in your project binder. These links are static references to the project's location on your disk. They will not work from other computers, or if the project has been renamed or moved from the location it was in when th...

            • ↳Copy Text of Documents

              The text content of the selected documents will be copied together into one continuous text in the clipboard using the order they appear in at the time of copying. If copied from the binder, this would be the binder order, but if copied from a sorted outliner view then they could be copied, for example, in chronological order.

            • ↳Copy Documents as ToC

              To aid in the creation a basic formatted table of contents with page number references, using the selected documents. This list can be pasted into a file within the draft. See [Creating a Table of Contents][] for further information.

            • ↳Copy Documents as Structured Link List

              Generates a list of links pointing back to the selected documents, formatted into an indented list. This form of list can be used to create a basic table of contents in a digital book, where hyperlinks are used instead of page numbers, such as ePub and Kindle.

            • ↳Copy without Comments and Footnotes

              Strips out inline and linked notation, while retaining all other formatting. Most often this is useful for producing "clean" [snapshots][Using Snapshots] after an editing session. This command will remove all notation, including footnotes.

            • ↳Copy as Markdown

              The selected text will be converted from rich text to Markdown format (using the MultiMarkdown dialect). This command produces markup in a fashion described in [Markup Options][].

            • ↳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.

            • ↳Copy as HTML (Basic, using `

              ` and ` `)

              Applies minimal inline CSS formatting. 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.

            • ↳Copy as HTML (Basic, using `
              `)

              Applies very basic, HTML 4.01 compliant code. When constructing HTML emails, or working with an older web site, this is what you will want to use.


          • Paste and Match Style

            This pastes the contents of the clipboard without any of its existing fonts, styles and other attributes such as links, tables and lists; 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, such as when gathering material from the Web.

          • Paste Plain Text as Screenplay

            When the active editor is showing a scriptwriting document, this menu command will become available. It can be used to paste plain text formatted screenplays, from the likes of Movie Magic Screenwriter, or even plain text screenplays you compiled from Scrivener in the past. The pasted text will be analysed and converted to the script format. It is only intended to work properly with standard Screenplay based formats.

          • Delete

            In some contexts this command can be used to remove items from lists, such as individual keywords in the inspector pane, and is usually passively bound to the DeleteBackspace key NOTE//WINDOWS// verify the standard shortcut used for removing items from lists on Windows. Is it always Shift-Del? . In similar cases, such as the Bookmarks pane in the inspector, where the removal cannot be undone, it is necessary to use the Cmd-Shift-Delete shortcut instead.

            This menu command can also be used to per...


        • Selection


          • Select All

            Edit menu

          • Select//

            Contains several commands to aid in the selection of items and text. In views where things are listed, such as the binder or a list of keywords, and where it is possible to select multiple items, there are a few modifier keys that can be added to mouse clicks to form basic selections:

            * Command: toggles whether or not one item beneath the mouse pointer is selected. This can be used to effectively deselect everything, if the one and only selection is Command-clicked. It can also be used to add ...


            • ↳Select Word

              The next three commands will select the nearest word, sentence or paragraph that the cursor or current selection is found within, or when a selection exists, it will be expanded in both directions until reaching the requested unit of measurement. For example, if the a few letters of two words are selected, the Select Word command would [expand the selection left to encompass the first word entirely, and rightward to encompass the second word entirely](#editor-select_word).

              Given the wide range ...

            • (illustration of word selection)

              MISSING_IMAGE:/path/to/gfx/editor-select_word.jpg

              [Before and after usage of the Edit//Select//Select Word command.]

            • ↳Select Sentence

              As noted above, if you start with two partially selected sentences then you would end up with two fully selected sentences when using the Select Sentence command.

            • ↳Select Sentence with Spaces

              Similar to the above, this alternate behaviour which will select one space from around the sentence (whichever is most logical), so that it can be more easily cut or moved with drag and drop to a new position without clean-up.

            • ↳Select Paragraph

              Selects the current paragraph, including the carriage return on the end of it, unless of course the paragraph is at the end of the file.

            • ↳Select Style Range

              The current selection will be expanded to encompass the style range around it in a contiguous fashion. This works locally first, looking for character styles, and then expands to any paragraph styles that exist around that selection. If no styled text exists around the cursor or selection, then expansion will encompass the contiguous un-styled text around it.

              For more documentation on this and the following two commands, refer to [Selecting and Searching for Styles].

            • ↳Select All Style

              Selects all non-contiguous text within the same text view using the current style beneath the cursor, or as found beneath the leftmost edge of the selected range (the selected text itself will be ignored). As with the previous command, the nearest character style range will be preferred over the paragraph character range, in cases where the cursor sits within text that has both character and paragraph styles applied to it. Also as with the prior command, if the cursor or selection encompasses te...

            • ↳Select Next in Same Style

              Using the same criteria as Edit//Select//Select All Style, this command will select the next phrase of text found within the current editor using the same style. If the cursor is within block quote, then the next block quote will be selected. This form of selection will wrap around from the bottom of the document back to the top if necessary, which means if only one example of the style exists, the very context the cursor currently sits in may be the "next" available example of text using this s...

            • ↳Select Similar Formatting

              Using the same logic as Edit//Select//Select All Style, this command checks for the type of formatting located beneath the cursor and then scans the document for similar examples, selecting all such non-contiguous text simultaneously. This command is handy for turning simple formatted text into styled text. Given the wide variety of possibilities that fall under "formatted text", we cannot expect this command to function flawlessly in all cases.

              If the cursor or selection falls upon text that i...

            • ↳Select Annotation/Footnote

              This command will alternate depending upon whe-ther the cursor or leftmost selection edge is located within an inline annotation (of the same colour) or inline footnote. If so, the inline note will be fully selected. The command will be disabled if no such inline notation range can be found.

            • ↳Select Subgroups

              Applicable only to the outliner and the binder when a container of any type is selected, this command will reselect any descendant container items that are currently visible *and* that contain subdocuments, ignoring any items that are not containers or that are empty. If a folder has three other folders beneath it that are collapsed and one text document, this command would select the three collapsed folders. If one of those folders was disclosed and it contained file group within it, then the t...

            • (illustration of subgroup selection)

              MISSING_IMAGE:/path/to/gfx/edit-select_subgroups.jpg

              [Before and after results of selecting the subgroups of the "Appendix" folder.]

            • ↳Select Current Text

              When the current context is a text editor instead of the binder or outliner, this command will appear in the menu. It can be used to select only the text in the section you are currently editing within a Scrivenings session, rather than the entire session.

            • ↳Select with Subdocuments

              When a container has been selected in either the binder or the outliner, use of this command will appear in the menu. Use it to select all descendent items of that container, opening as necessary all levels of hierarchy from that point downward in order to do so. This command is useful in conjunction with other commands that work on specific item selections, such as taking snapshots or setting metadata.

            • ↳Select 'Included' Subdocuments

              All subdocuments of the currently selected container (to all depths) will be selected, only if they have their respective "Include in Compile" checkbox enabled. Easily filter out all notes, old revisions and other nonessential items from your draft folder with this command.

              If you wish to filter a collection or hoisted binder view by included items only, you can hold down the Option key and XREF// If you can make this one more specific that would be good. [click on the button in the binder hea...


          • Deselect All

            If possible, removes all active selections from the current view. In some cases there will always be a default selection that cannot be removed. In a text editor, the cursor position takes on that role, and certain commands and tools will use the cursor position as a form of implied selection. In the corkboard and outliner views the underlying container that is being viewed will occupy the default selection, mainly for deciding what the Inspector will examine.


        • Completions//


          • ↳Complete

            Manually calls up the word-completion service, regardless of word auto-completion settings. Can optionally be invoked with Cmd-. or simply Esc by itself on some keyboard layouts.

          • ↳Complete Document Title

            With the first part of a document titled typed in, you can use this command to cause Scrivener to search your project for matching titles and suggest alternatives. This is useful in conjunction with the Corrections preference to automatically detect internal 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. For more information, read [Auto-Completion][].


        • Move//

          RFACT// it could be that most of this would be better placed in a section, or even a series of sections devoted to the various contexts in which things can be moved. There is quite a lot of ground to cover here in terms of the various particulars, many of which pertain only to one single view. Movement commands are applicable to text as well as items. In some types of views, certain types of movement will be disabled if there is no logical form of movement in that direction. For example in coll...


          • ↳Move Up

            With **text** the selected lines will be transposed together with the line directly above them. On the **corkboard**, the card will be moved directly up, advancing all cards between where it was and where it will be moved, one position to make room for it. In both the **binder & outliner** views, the selected items will move up within the current list of "siblings", or within a folder and without changing levels. They cannot be move "up" beyond the top of the group they are within. With **label ...

          • ↳Move Down

            As with moving the selected items *up*, only in this case all movement will be done downward.

          • ↳Move Left

            NOTE// If the keyboard shortcut changes, this will impact ↳Indents. **Text** will have its block indent level shifted outward by 0.25" increments. Any amount of first-line or hanging indent will be respected by this command. The levels of indent for all forms will be incremented equally, and once the left margin is reached by the leftmost portion of text, the command will be disabled. Items in the **binder & outliner** will be move out of their current container to become a sibling to it, inse...

          • ↳Move Right

            NOTE// If the keyboard shortcut changes, this will impact ↳Indents. As with moving the item *left*, only in this case all movement will be done in the opposite direction. In the case of **text**, the indent will be incremented 0.25" per usage and has no effective upper limit. The action of moving an item right in the **binder & outliner** will be to nest the selected items beneath the item directly preceding the topmost selected item.


        • Sort//

          Sorting can be done wherever there is a flat list of adjacent items that can be arranged in a view, when a single item is selected that is a container to other items, or when more than one line of contiguous text has been selected in an editor. Possible applications include items in the binder, outliner or corkboard views, keywords, bookmarks and so forth.


          • ↳Sort Ascending (A-Z)

            This command will sort eligible items in alphanumeric order (0-9a-z) with most punctuation and symbols falling before numbers.

          • ↳Sort Descending (Z-A)

            Sorting by descending order follows all of the same rules, only sorts in (z-a9-0) order, with most punctuation and symbols falling at the end of the list.


        • Append Selection to Document//

          This command presents a binder item selection submenu of everything capable of having text added to it. It requires an active text selection, which will be added to the end of chosen document selected through the submenu. This menu will keep track of your usage of it within the project, tagging frequently used targets in a "Favorites" section at the top of the menu.

          Use the "New..." command to create a new document containing the selected text. You will be asked where to place this new document...

        • Linking

          For links between internal project items, or between Scrivener projects, refer to [Linking Documents Together]. For general hyperlinks to files, web sites and so forth, refer to [Hyperlinks].


          • Add/Edit Link...

            Add an external hyperlink of any types to the text. If the cursor is not already placed within a link, you can use this command to insert a new link at the cursor position. When existing text is selected, the hyperlink will be applied to the text rather than inserting the URL directly into the editor. The URL editing sheet will provide you with several common prefix options For the sake of simplicity, both HTTP and secure HTTPS links are considered one and the same. You can also paste a URL with...

          • Unlink

            If the cursor is placed within the text of a link, this command will destroy it. If you select a range of text, all link formatting within that range will be removed. Links only partway selected will remain as trimmed around the bits of the link left unselected.

          • Link to Document//

            Presents a binder item selection submenu for the creation of a hyperlink to a chosen document within the same project at the current cursor position, using the target's binder title, or if you have text already selected, it will be turned into a hyperlink.

            Using this menu, you can also create a link to a document that doesn't exist yet, with the New Link... command (<$custom:shortcut>) In the first tab it will ask you for the title of the new document, and where to place it. After providing thi...


        • Find//

          As a program designed for working with bulk text, Scrivener has many tools in its chest for searching, collecting items, and organising and reviewing the results. For full documentation on how to use Scrivener's extensive searching facilities, see [Searching and Replacing].


          • ↳Quick Search

            Provides a shortcut for using the toolbar's quick search field, which [otherwise prints the name of the binder item you are currently viewing](#ui-toolbar-quick_search). If the toolbar has been hidden, a separate window will be opened for your convenience. Read more in [Quick Search Tool][].

          • (figure)

            MISSING_IMAGE:/path/to/gfx/ui-toolbar-quick_search.jpg

            [The "Quick Search" tool displays the document title prior to being clicked on.]

          • ↳Search in Project

            Provides a shortcut for the project search tool, which will appear as a text pane above the binder sidebar. Type text into this field to search the project for matches, in accordance with the current search settings, set in the magnifying glass icon menu to the left of where you type. There is a lot to this tool! Read more about [Project Search].

          • ↳Project Replace...

            Shows the Project Replace panel, for the bulk replacement of text throughout the entire project or selected portions of it, even including the otherwise immutable snapshots. This operation cannot be undone; use with care. Read more about its usage in [Project Replace].

          • ↳Find...

            Brings up a standard find and replace panel. This panel works within nearly every context where you can edit text, even within the inspector sidebar. In the main editors this often means only one document at a time, but in the case of Scrivenings session it could mean many documents. Read more about [Document Find and Replace].

          • ↳Filter...

            When the active view is a corkboard or outliner, the "Find" command will be replaced with the "Filter" command. This brings up a panel at the top of the view that can be used to filter which index cards or outliner rows you see, based on various criteria. Read more in [Filter Outliner & Corkboard Views].

          • ↳Find Next / Previous

            Find Next/Previous Cmd-G & Shift-Cmd-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

            Sets the selected text as the current find term, copying it into the "Find" text field even if the find panel is closed. It can thus be combined with the previous commands to search for text without using any interface.

          • ↳Jump to Selection

            Scrolls the editor view so that your cursor position is centred on the page. Useful if you have used the scrollbar, or PageUp/PageDown to briefly check other areas of the text.

            When [typewriter scrolling] is enabled this command will use the selected Typewriter scroll line, from the Editing !preference pane, rather than the centre of the view.

          • ↳Find by Formatting...

            Opens the Find by Formatting panel. This tool is quite powerful and has a wide range of options documented in [Find by Formatting Tool].

          • ↳Find Next / Previous Formatting

            Find Next / Previous Formatting Shift-Opt-Cmd-G & Ctrl-Opt-Cmd-G

            : As with Find Next and Find Previous, this command will jump from match to match, even without the "Find by Formatting" panel open. Unlike document find however, this command will seek matches from adjacent documents once the end of the current document is reached. In this way, you could step through the entire project looking for matching formatting.


        • Spelling and Grammar//

          Accesses global macOS' spelling and grammar tools. These settings are stored on a per project basis, though their use will establish the settings used to set up your next project, when it is created. Existing projects will always store whatever setting you left them at, regardless of the current default for new projects.


          • ↳Show Spelling and Grammar

            Opens the standard Spelling and Grammar panel. If you wish to change the base language the spelling and grammar checker uses, you can set that here.

          • ↳Check Document Now

            Start checking for misspellings from the current cursor position on downward. Once the bottom of the document is reached, it will wrap around to the top.

          • ↳Check Spelling While Typing

            Toggles the automatic spell\\ checker that underlines in red unrecognised and misspelled words as you type, unless Correct spelling errors as you type has been enabled in the [Corrections preference pane][prefs-corrections], under "Auto-correction".

          • ↳Check Grammar With Spelling

            Toggles the grammar checking feature that looks for poor style or grammatical errors as you type and underlines them in green.


        • Substitutions//

          These options control whether or not typographic punctuation will replace easier to type basic punctuation as you write. These settings are stored per individual projects, and their defaults are established in the Corrections preference pane, under "Punctuation".


          • ↳Smart Quotes

            If necessary, typographic punctuation will be substituted for basic speech mark punctuation as you type. In English for example, the \" character would be substituted with a matching pair of “ and ” characters. The quotation style used are typically set by your macOS localisation settings, or quote settings established in the "Text" tab of the Keyboard System Preferences pane.

            For those cases where the text editor produces the wrong type of quote, such as after em-dashes, press the Option key i...

          • ↳Smart Dashes and Ellipses

            With this option enabled a sequence of two or three hyphens in a row will be substituted with an em-dash (---) character, and three full stops will be converted to an ellipses (...) character.


        • Transformations//

          For the transformation of text from one form to another in a permanent fashion.


          • ↳Make Uppercase

            Converts the selected text to all uppercase characters.

          • ↳Make Lowercase

            Converts the selected text to all lowercase characters.

          • ↳Make Title Case

            Converts the selected text to title case, capitalising each word in the selected range.

          • ↳Make Small Caps

            Creates fake small caps by capitalising all of the letters in the selection and then using font sizes to produce the effect. If your workflow requires true small caps you should use the typography features of your font to display this format, instead.

          • ↳Remove Small Caps

            In opposition to the previous command, removes the faux caps effect, restoring the original letter case and normalising the font size based on the larger letter found within the selection (ignoring letters using a smaller font to the left). Given how this command requires precise expected measurements between large and small letters, it will only work on text that has not had its overall font size modified after applying faux small caps.

          • ↳Quotes to Smart/Straight Quotes

            Converts between typographic\\ "curly" quotes and straight speech marks.

          • ↳Inline to Inspector and Inspector to Inline Conversions

            These four\\ commands allow you to convert inline annotations to linked Inspector comments, vice versa, and footnotes. These commands work on the current editing session as a whole or the current selection if applicable.


        • Speech//

          Access to macOS' built-in text-to-speech synthesis is provided through two menu controls for starting and stopping speech. The active text editor will be used as source text with these commands starting with the cursor and reading downward, or if text is selected, only the selection will be read aloud.

          Settings pertaining to this feature, such as which voice to use and how rapidly it should speak, are found in the Accessibility System Preference pane, under the Speech tab.

        • Text Tidying//

          A few useful tools for cleaning up text and fixing links.


          • ↳Delete Struck-Through Text

            Within a range of selected text, any that has been marked for removal with the Format//Font//Strikethrough command will be deleted. Struck-through text can also be filtered out of compiled text as an option, without removing the original text in the editor. This command is only necessary if you wish to clean up the source.

          • ↳Update Document Links to Use Target Titles

            Any internal links found wi-thin the selected text will have visible text of the hyperlink changed to match the names of the documents that they are pointing to. Thus, a line of text reading "Update this" which has been selected and linked to a document named "To this", will have the visible text changed "To this". If you are using links to display cross-references in the compiled output, this command will be useful when the names of sections have been revised. Read more about compiling cross-re...

          • ↳Replace Multiple Spaces with Single Spaces

            Useful for cleaning up a document that has been typed up with multiple spaces in between sentences and so forth.

          • ↳Remove Empty Lines Between Paragraphs

            Strips out empty lines between paragraphs, as will often be found in emails and plain-text documents.

          • ↳Strip Leading Tabs

            If the original document was typed in the fashion one might do when using a typewriter, with tabs in front of every paragraph, this command can be used to strip them all out.

          • ↳Zap Gremlins

            Strips Unicode and ASCII control characters from the selection. If you are having difficulties compiling, or have found areas in your text where the cursor seems to get "stuck" when moving through ranges of text, your document may have acquired these invisible control characters from somewhere. This command will strip out all of the Unicode characters falling within the range of `#x00` to `#x1F`, save for the necessary `#x09`, `#x0A`, `#x0C` and `#X0D` characters, which are used to print spaces,...


        • Writing Tools//

          Provides access to few macOS tools, as well as some common search utilities.


          • ↳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 Ctrl-Cmd-D to do quick spot-checks, or use a "force click" action on compatible hardware.

          • ↳Search in...

            Uses the currently selected text or active word to search the selected resource for results. Your preferred Web search tool (as set in Safari) will be used and, along with Wikipedia searching, will require an active Internet connection to make use of.

          • ↳Linguistic Focus...

            Brings up a floating panel that provides access to macOS [linguistic word highlighting features][Linguistic Focus].

          • ↳Name Generator...

            A tool which will generate names based on a wide variety of criteria. Read more in [The Name Generator][].


        • Start Dictation...

          For computers capable of recording audio and making use of the macOS speech-to-text dictation system, this can be used to speak words aloud and have them turned into editable text in the current editor. Settings pertaining to this feature are found in the Keyboard System Preference pane, under the "Dictation" tab.

        • Emoji & Symbols

          Loads the macOS Unicode character browser. Use this to insert characters that are not found on your keyboard.


      • Insert Menu

        The Insert menu is concerned with the addition of images, equations, tables, notation, special characters and placeholders into a valid text editor or field. Some general rules of thumb can be applied for how inserted items will be placed within the text:

        • The cursor position or text selection will be used to place the selected element from this menu.

        • Commands that place objects or text snippets, such as images, lines or breaks, will replace the selected text with that object.

        • Those tha...


        • Table

          Inserts a starter table (3 columns by 2 rows) into your document at the cursor position unless the cursor is already within a table. In both cases the command will also open a floating configuration palette containing tools for adding and manipulating tabular data in the text editor. With a preexisting text selection, the selected text will be placed within the first and leftmost cell.

          For further table manipulation commands, use the Format//Table// submenu, or right-click within an existing ta...

        • Image From File...

          This brings up a file dialogue for selecting an image from your computer to be inserted and stored within the current text document. Images can also be dragged into the editor from nearly any source capable of dragging images, such as Scrivener's binder itself, Finder and many Web browsers. Read [Working with Images] for more information on working with images in your text.

        • Image Linked to File...

          As with the above, only the inserted image file will be *linked* to the original file on your hard disk, rather than stored it in the text document. This allows you to keep image files easily accessible to other tools as well as keeping the file size of your project trim. Refer to [Linked Images] for further information.

        • Image Linked to Document//

          This submenu presents a list of all images found within the current project. As with the above command, the image will be inserted into the editor as a link to the original image, only in this case to a file within your project binder, rather than to an external location on your disk.

          It is also possible to adjust Scrivener's settings so that any images dragged from within Scrivener into an editor will be linked, rather than embedded: with the Link to images dragged from binder into editor opti...

        • Comment

          Opens a new comment attached to the selected text (or nearest word), which can be written to in either a popup box or the inspector, depending upon your preferences. This keeps notation text out of the main text and in a more traditional "bubble" or margin note format. For more information on annotating your text, see [Annotations and Footnotes][].

        • Inline Annotation

          Converts the selected text into an inline annotation, or toggles the writing mode to annotation mode. Like using a proverbial red pen, these are useful for placing notes right in the editor, alongside the relevant text..

        • Footnote

          This feature is functionally identical to attaching a Comment to the text, although for the purposes of eventually exporting the content of the note to the reader in the form of an end-of-page footnote or endnote of some variety. How this will be done depends upon your compile settings and the type of work being produced.

        • Inline Footnote

          Working similarly to inline annotations, this command converts the selected text into a footnote, or toggles the writing mode to footnote mode. Useful for keeping footnote content directly alongside related text.

        • Bibliography/Citations...

          If a bibliography manager has been set up in the "Citations" tab of the General preference pane, this command will launch and bring the set utility to the foreground, facilitating the process of selecting a citation and pasting it back into Scrivener using whatever system that application provides.

        • MathType Equation

          Create a MathType image equation at the current cursor location. When inserting an equation inline, it will attempt to match the baseline of the current text. If MathType is not properly installed, a window with a link to the download will be provided. See also: [Using Equations with MathType][].

        • Break//

          Invisible characters, or whitespace characters, that can be inserted into the text to control the flow of it. The View//Text Editing//Show Invisibles command will cause most them to be visible in the editor as special symbols][Supported Invisible Characters with Symbolic Depictions]


          • ↳Line Break

            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. Page breaks can be previewed with the View//Text Editing//Show Page View mode. In most cases, Scrivener's compile system will insert page breaks for you, relegating use of inserting them manually to niche cases.

          • ↳Non-Breaking Space

            Inserts a special space character which will prohibit word-wrap from dividing the words joining that space. I.e. 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, ensuring the two characters to the left and right of it are never broken between lines by word wrap.


        • Horizontal Line//

          Provides a few rule lines that can be inserted at the cursor position, replacing any selected text.


          • ↳Centered Line

            Inserts a sequence of 100 underscored non-breaking spaces with centre-alignment formatting applied to the line. You can increase or decrease the size of the line by adding or deleting non-breaking spaces.

          • ↳Page-Spanning Line

            Uses an underlined tab stop, set to the width of the page as it will be compiled, to draw a line across the page. Given how Scrivener's text editor may not depict the width of the page in terms with how it will compile, the tab stop may in some cases fall before or after the editor width or simulated text block in Page View, causing the rendering of the line to collapse and become invisible.

            It is also important to note that since this uses a tab stop with a fixed measurement, if the paper size...

          • ↳Signature Line

            Inserts a sequence of 40 underscored non-breaking spaces with left-alignment formatting applied to the line. As with centred lines, you can adjust the width by adding or removing non-breaking spaces to the line.


        • Auto-number//

          Inserts a placeholder that will be used to generate numerical sequences in the chosen format when compiling. A sequence such as `\<$n>\<$n>\<$n>` will print as `123`. For full documentation on how to use the various placeholders, use the Help//List of All Placeholders... menu command.

        • Draft Word Count//

          Inserts a placeholder that indicates the word count for the entire document as compiled The particulars for what constitutes the "entire document" are defined by the compile format. Some may include footnotes or front matter in their counts where others may not. . There are a number of rounding options available, for cases where precise counts are less important.

        • Draft Character Count//

          As with "Draft Word Count", this command inserts a token for the total character count with various rounding options available.

        • Endnote Marker

          For supported formats (print/PDF/RTFD/TXT/HTML), this special placeholder will collect all of the endnotes in a project and place them at the location of the marker during compile. 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 inline and inspector notation to compile both footnotes and endnotes simultaneously, this marker will not impact footnotes.

        • Current Date & Time

          Inserts a plain-text date-stamp based on your system's Long Date and Short Time format.

        • Media Time Stamp

          Inserts the current time stamp from the active media player in the opposing split. This can be done while playback is in operation, or while paused. The format for the time stamp can be modified in [the Behaviour: Playback !preference pane][behaviours - playback], under Media Time Stamp format.


      • View Menu

        The View menu contains 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 found in [project settings] nor in the main !preferences, chances are it is in the View menu.

        As with project settings, the options you select here will only impact the ac...


        • View Modes

          The three view mode selections at the top of this menu are different ways you can view the the contents of the editor. Setting a view mode determines how the active editor will view groups of items (such as when clicking on a folder or selecting two or more items) going forward, until you change view modes again. Within the menu, a checkmark will be placed beside the view mode currently in use.

          When selecting a container and switching to corkboard or outline mode, the child items of that contai...

        • Document/Scrivenings

          If multiple text documents are selected in the editor, this choice displays the current editor as a [Scrivenings session][Editing Multiple Documents], showing the text of each document one after the other, viewable and editable as if they were a single file. Any media or research files included in the selection will be skipped over.

          When a single non-group item has been selected in the editor this menu item will be labeled "Document", and switch the content to its text or media view.

        • Corkboard

          Display the current editor as a [corkboard][The Corkboard].

        • Outline

          Display the current editor as an [outline][The Outliner].

        • Show|Hide Binder

          Toggles whether or not [the binder sidebar][overview_binder] 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 Collections

          Reveals or hides the collection interface which will appear above the binder. Note the sidebar will need to be visible for this menu option to be available.

        • Show|Hide Inspector

          Toggles whether or not the inspector is visible on the right of the main window. The inspector displays all metadata for the current document, including synopsis and notes, and is hidden by default. Read more [about this sidebar][Inspector].

        • Editor Layout//

          These commands impact the overall layout of the editor space, between the binder and inspector sidebars. Splitting the editor to show more than one thing at a time, as well as attaching "copyholders" to clip files to the editor splits and cleaning up the editor to provide a distraction-free interface are all located here. For what goes on *inside* the editor, you might be more interested in the following View//Text Editing// submenu.


          • ↳Show|Hide Header & Footer View

            Toggles the visibility of the header and footer bar in the active editor.

          • ↳No Split

            Removes the inactive split from the editor, returning it to one. For more information on using splits, see [Splitting the Editor][]. This command does not remove copyholders directly.

          • ↳Split Horizontally

            Initiates a new horizontal split, or converts the split orientation to horizontal. When creating a new split, the current content will be loaded into that split.

          • ↳Split Vertically

            As with splitting horizontally, only vertically instead.

          • ↳Swap Editors

            Only available when Split Horizontally or Split Vertically is enabled. This command swaps the editors from one side to the other, so that the view on the top/left will become the view on the bottom/right and vice versa. This swaps the entire editor session, its history, settings and so forth. What was the left editor will now be functioning on the right side instead.

            If you would instead prefer to merely mirror the content into the other editor without swapping settings, use the "Match Split Do...

          • ↳Copyholder Position//

            Also accessible by right-clicking on the copyholder's header bar directly, you can set which side of the editor it favours using the options in this submenu. A copyholder cannot be positioned parallel with a split, so some options may not always be available, or be swapped for you when the spit configuration changes.


        • Supported Invisible Characters with Symbolic Depictions

          Invisible Character

          Symbol

          Space

          MISSING_IMAGE:/path/to/gfx/invisible-space.jpg

          Carriage Return

          MISSING_IMAGE:/path/to/gfx/invisible-pilcrow.jpg

          Line Feed

          MISSING_IMAGE:/path/to/gfx/invisible-linefeed.jpg

          Tab

          MISSING_IMAGE:/path/to/gfx/invisible-tab.jpg

          Non-breaking Space

          MISSING_IMAGE:/path/to/gfx/invisible-nbsp.jpg

          Page Break

          MISSING_IMAGE:/path/to/gfx/invisible-pagebreak.jpg

          Word-Joiner

          (Not depicted.)

          Supported Invisible Characters with Symbolic Depictions

        • Text Editing//

          Formatting tools for working with text can be toggled in this submenu, as well as visualisation tools like page view, line numbers, vertical writing mode and so forth.


          • ↳Show|Hide Format Bar

            Toggles the visibility of the character and paragraph formatting bar, which provides quick access to many of the most common types of formatting tools. Refer to [The Format Bar][] for more information on this tool.

          • ↳Show|Hide Ruler

            Toggles the visibility of the [tab-stop and indent ruler][The Ruler] for the active editor.

          • ↳Show Titles in Scrivenings

            When enabled, editable titles of documents will be placed between documents in a scrivenings session above their associated texts. Titles can be formatted, and the divider style changed, in the [Appearance: Scrivenings pane][appearance - scrivenings].

          • ↳Only Show Scrivenings Titles for Folders

            The editable titles added by the former menu toggle will only appear on folders, with all other items will use a regular divider.[^ <$include>]

          • ↳Show|Hide Invisibles

            Toggles visibility of hidden control characters, such as paragraph breaks, table cells (when otherwise set to have no borders) tabs, spaces and [page breaks][Supported Invisible Characters with Symbolic Depictions]. You can modify the colour used to depict these symbols in the [Appearance: Textual Marks][appearance - textual marks] pane.

          • ↳Show|Hide Markup

            Toggles the display of textual markings, to produce a cleaner copy suitable for proofreading. The markings that will be hidden by default are comment highlights, links, highlight boxes around styled text and preserve formatting boxes. You can adjust which markings are hidden in the [Appearance: Textual Marks !preference pane][appearance - textual marks].

          • ↳Show|Hide Page View

            Toggles displaying the text editor as a virtual page on and off, rather than text in a long column. It is not intended to be used as a layout mechanism, though it can provide a reasonable estimate of how your pages will look under certain conditions, once printed. This setting is specific to each split editor, as well as composition mode. Read more in [Page View][].

          • ↳Two Pages Across

            When enabled, displays two pages side by side in a familiar book-style arrangement.

          • ↳Use Vertical Layout

            This is a global setting that toggles the rotation of the main editors (including composition mode) to vertical alignment, as is sometimes used in Eastern scripts like Japanese.

          • ↳Show Line Numbers

            Adds a paragraph (line feeds within a paragraph will not be counted) numbering feature to the standard editor. This feature is unavailable to Page View mode.

          • ↳Only Count Every Fifth Line

            As an option to showing line numbers above, you can elect to have Scrivener only count every fifth paragraph.

          • ↳Show|Hide Compiled Footnote Numbers in Inspector

            When enabled, after you compile and all footnotes have been counted, their [numbering will be printed in the Inspector alongside the footnote itself][Compiled Footnote Numbering]. This option can slow down compile times, and is thus off by default.

          • ↳Prompt Before Updating Footnote Numbers

            In conjunction with footnote numbering, optionally instruct the compiler to ask you if these numbers should be updated, every time you compile. This can be of use if the project is very large, as adding numbers takes time and may not always be necessary.

          • ↳Typewriter Scrolling

            Toggles a feature that keeps the currently edited line of text at a set position on the screen, much like typing on a physical typewriter. This setting is specific to each split editor, as well as to composition mode (the latter has the feature enabled by default).


        • PDF Display//

          This submenu controls how PDFs are displayed in the editor. Most of these options should be familiar as they are common to many PDF viewers.


          • ↳Automatically Resize

            Keeps the PDF sized to the width of the editor window even when changed.

          • ↳Actual Size

            Zooms the PDF to its native scale.

          • ↳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 zoom level.

          • ↳Single|Facing Pages

            In Single Page mode, will show one page per row like an ordinary digital file. In facing mode, two pages will be placed side-by-side in a column, more like reading a book.

          • ↳Continuous / Page Breaks

            These two scrolling modes affect how the document 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.


        • Corkboard Options//

          Provides features and visual options for [the corkboard][]. Most of the settings in this menu are specific to each split, affording different view settings for each editor. Note that further options can be accessed via the corkboard display options button, which is located on the right-hand side of the footer bar for each corkboard.

          Also refer to [So What are Index Cards, Anyway?][], for more information on the index card itself.


          • ↳Cards Across//

            The Cards Across submenu allows you to define how many index cards you would like to appear in each row on the corkboard. The default is three. Auto-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.

          • ↳Arrange by Label

            Toggles a mode whereby index cards are [arranged by label on the corkboard][Arrange by Label]. Each label forms a "rail" that matching cards are placed upon in the order they appear within the corkboard naturally. Whether these rails form rows or columns can be adjusted with the following menu options.

          • ↳Arrange by Label Layout//

            These choices select between the rotation of the corkboard layout or whether it wraps cards to the view, as described in [Stacked Corkboards][]. Grid orientation (or how the corkboard behaves by default) is only available when stacking, never when Arrange by Label is enabled, even if stacking a label-arranged view. These options are also available as buttons along the bottom right in the corkboard footer bar, and on the Touch Bar with appropriate hardware.

            The name of this menu will change depe...

          • ↳Show Label Colors Along Edges

            Toggles whether a coloured strip is drawn along the edge of index cards. These strips are associated with the label colour assigned to the item the card represents. When no label has been assigned to a card no strip will be drawn on it.

          • ↳Show Status Stamps

            Toggles whether stamps are displayed on index cards. Stamps show the current status associated with the document represented by the index card as though it has been stamped on the index card. The appearance of stamps can be adjusted in the "Fonts" and "Colors" tabs of the [Appearance: Corkboard !preference pane][Appearance - Corkboard].

          • ↳Show Keyword Colors

            Keywords assigned to a document can be visually indicated along the right-hand side of the index card as colour chips. The number of keywords that can be shown at once can be changed using the corkboard display options button.

          • ↳Show Card Numbers

            Cards will be numbered according to their sequence in the selection or container they are within. In Freeform mode the numbers will not change according to where the card is positioned in the view. This can be a valuable reference as the order of cards are likely to become shuffled up. This option impacts both splits.

          • ↳Number Per Section

            When this option is enabled, if the corkboard is displaying multiple containers in a "stack", card numbering will be restarted for each new section. When disabled card numbering will be linear across sections.

          • ↳Freeform

            Activates the [Freeform Corkboard][] mode, allowing unrestricted movement of cards around on the corkboard without any immediate impact on their underlying order in the binder. This can also be toggled in the footer bar, and on the Touch Bar with appropriate hardware.

          • ↳Snap to Grid

            Toggles whether or not cards in freeform mode will snap to a background grid, rather than allowing for pure freeform placement.

          • ↳Commit Freeform Order

            Uses the current freeform layout to reorder the actual manuscript outline structure. Scrivener will provide [several options for how this can be done in a dialogue box][Commit Order]. If card numbers are enabled, they will be renumbered at this time to reflect the new underlying order. This command can also be invoked via the Commit button in the corkboard footer bar.


        • Outliner Options//

          Displays a list of toggle commands that reveal or hide the corresponding [columns in the active Outliner view][Managing Columns]. These settings are stored per split, affording different view settings for each editor. You can also manage columns using the RightChevron button above the scrollbar area in the outliner itself.


          • Center Content

            Toggles whether the current outliner view will have its content horizontally centred (much like the text editor centres the text column by default). This will be more useful with a limited number of columns, and will have no visible effect if there is more outliner width than the current view affords. This behaviour can also be toggled via a [button in the outliner footer bar][Centring Outliner Content].

          • Use Fixed Row Height

            Toggles whether or not the current outliner view will used a fixed height cell for each row, rather than an adaptive height that conforms to the amount of content in various columns. For more information, refer to [Using a Fixed Row Height].


        • Use Label Colour In//

          An item's label colour can be applied as a tint to various interface elements throughout the project window, toggled by the choices in this menu, listed below. The intensity of most background tinting can be adjusted in the [Appearance: General Interface !preference pane][Appearance - General Interface]. Read about the different options available in this menu in [Label Colours].


          • ↳Show as Background Color in Binder

            When ticked, this option causes the binder title to be coloured with the label background, rather than using a dot to the right of the name. This option has no impact on the other sidebar views. The intensity of this background can be modified by the opacity slider (which impacts the label tint used in other background areas) in [the Appearance: General Interface !preference pane][Appearance - General Interface].


        • Zoom//

          This all purpose tool zooms the display of a compatible view up or down, and also allows for precise selection for text view types. Each split records its own setting, as well as !composition mode. The menu adds shortcuts and extends access to this capability into areas that lack that a visible zoom control, such as Quick Reference panels and inspector panels with text. Refer to [Scaling Text][] for more information.

          The tool will also increase or decrease the size of viewed media, such as PDF ...


          • Zoom In

            Increases the magnification of the current view by a set amount. In text views this amount correlates with the provided values in the "Text Zoom" section of the menu, or what can be seen in the zoom tool in the text editor footer bar.

          • Zoom Out

            Decreases the magnification of the current view in an inverse pattern to zooming in.

          • Text Zoom

            The "Text Zoom" section of the menu lists a number of convenient and popular zoom settings for text.

          • Fit Width

            Adjusts the magnification so that the page width (including margins) fits the current editor width. This and the following option are only available when using [Page View mode in the text editor][Page View].

          • Fit Page

            Sets the magnification so that both the short and long edge of the page can be seen within the editor.

          • Other...

            Provides a field where you can type in a precise magnification amount yourself. If you'd prefer a number between 200% and 300% say, this would give you the option for doing so.


        • Outline

          This submenu provides commands for working with groups in both the outliner and binder, followed by settings and navigation commands for the binder.


          • ↳Expand All

            Expands all collapsed items recursively within the current view. When this command is used in the binder, it will expand the entire binder. If you instead wish to only expand or collapse one single section of the outline, you can use the OptionAlt key in conjunction with a mouse click or the LeftArrow (to collapse) or RightArrow (to expand).

            This command can also be used in the Footnotes & Comments inspector pane to expand all collapsed notes to full height.

          • ↳Collapse All

            As with Expand All, this works the other way, closing all visible open items recursively.

            This command can also be used in the Footnotes & Comments inspector pane to collapse all notes to single lines.

          • Collapse All to Current Level

            Working in a similar fashion to Collapse All, this command will collapse the entire outline below the currently selected item's level. Thus if you if have an outline that has six levels of depth, and select a folder on level 3, running this command will completely collapse all items except those at levels one, two and three, which will be ignored.

            When multiple items are selected, the first item in the selection will be used to determine the level by which the tree will be collapsed.

          • Show Subdocument Counts in Binder

            When enabled, each container in the binder will display a number to the right of it showing how many subdocuments it contains. This number is recursive, meaning that it will not only count the container's immediate children but any descendants beneath those children as well.

          • Hoist Binder

            With this command, 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. Changes made to ordering and structure while hoisting will be made to the book outline itself. Read more about it in [Hoisting the Binder].

          • Unhoist Binder

            Returns the binder to full display. You can also click the CloseButton button in the binder sidebar header to return to the full binder.


        • Enter|Exit Full Screen

          Utilises macOS' full screen implementation, expanding the main project window to occupy the entire screen, and moving it to its own virtual desktop (or "Space" as Apple refers to them), segregated from the rest of the applications running on your system. The window cannot be resized or moved until Exit Full Screen has been invoked.

          Exiting Full Screen mode will return the project window to the original position and size (and when using a [default full screen layout][Setting a Full Screen Defaul...

        • Enter|Exit !Composition Mode

          TODO//WINDOWS// check that all of these replacements work in Windows---particularly the one with an apostrophe in point 3 below. Toggles [the distraction-free writing environment][!Composition Mode], switching to text editing mode if necessary. Being a text editing mode, this option is not available to research files or the corkboard and outliner group view modes. There are three methods of invocation:

          1. In the simplest case, if you are editing a single document or have one file selected in ...

        • Show|Hide Tab Bar

          Toggles the visibility of Apple's Tab Bar interface, which allows for the merging of similar windows together into a single tabbed window. In Scrivener, this means you can combine projects into a single window, and Quick Reference panels together into their own groupings. The Window//Merge All Windows command is used to combine two or more alike windows together. For further information on how to use this feature, consult Apple's documentation.

        • Show|Hide Toolbar

          Toggles the visibility of the main application toolbar.


          • Customize Toolbar...

            Opens the configuration panel for the main application toolbar. This can also be done by right clicking on the toolbar itself.


        • Customize Touch Bar...

          Brings up the standard interface for customising keyboard buttons on Apple's Touch Bar technology. As with most software, you will need to activate the area of the interface first in order to customise the button set that is available to it. For example to adjust which buttons are available in the binder, click in the binder first. Read more about [touch bar][].

          This command will not be visible without the proper hardware.


      • Navigate Menu

        The Navigate menu focusses on all aspects of getting around inside of a project, from flipping between available binder sidebar tabs, to jumping from one place to the next in the editors, controlling media playback to moving your cursor around within the project window itself in a mouseless fashion. It also contains a few project settings that impact how navigation works with the split editors and copyholders available.


        • Reveal in Binder

          <$include> %BinderContext

          This command is available in a few different contexts, and is also available from the [header bar contextual menu]:

          * Editors

          * Copyholders

          * Quick Reference panels

          * Binder sidebar views like Search Results, collections and hoisted containers.

        • Reveal Draft Folder

          Opens the binder sidebar if necessary, switching the main binder view out of any collections, search results or hoisted containers, and selects the draft folder.

        • Go To//

          The resulting action of this command will be similar to clicking on an item in the binder: the active editor will *go to* the item you specify. If the binder is hidden, a collection is selected, or a section is hoisted, for instance, you can use this menu to navigate to other areas of the project without having to alter your work environment. The menu also provides a few contextual navigation and focus functions as well as listing any project bookmarks for convenient access.

          Beyond the commands...


          • ↳Previous Document

            Jumps to the previous item in the binder sidebar list. When used with the main binder view visible, this command ignores hierarchy.

          • ↳Next Document

            As with Previous Document, but selects the next document in the binder sidebar list.

          • ↳Enclosing Group

            Will display the currently edited item in context with its siblings using the current view mode, and can be thought of as a way of moving your editor "up" in the hierarchy one step at a time. 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, or expand your current Scrivenings session to include the siblings and parent of the current text item.

          • ↳Selection

            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 items from the corkboard or outliner as text (even if they are containers). When more than one item is selected, they will be loaded using Scrivenings mode as a multiple selection.

            The difference between this and the Navigate//Open// commands (<$custom:shortcut> or <$custom:shortcut>) is that they will respect the current view mode preference...

          • ↳Collection//

            This submenu contains a list of all available collections in the project. Rather than loading the collection in the sidebar, as would ordinarily be done, this command loads the contents of the collection into the editor, where it can be worked with using any of the group view modes.

            If the collection is already being displayed in the sidebar, you can also load it into the editor by clicking on the HookArrow button in the sidebar header (beside the CloseButton button) . Read more about this capa...


        • Open Quick Reference//

          This provides a similar list of project bookmarks and binder items as the Navigate//Go To// submenu, except that the selected item will be opened in a Quick Reference panel, rather than replacing the contents of the editor.

        • Collections//

          Provides commands for navigating to collections in the binder sidebar, as well as one conversion command. This menu will be populated by a list of the collections in this project, in reverse order from how they appear in the tab list. 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 collection tab list] is not visible, or for assigning keyboard shortcuts to oft-used collec...


          • ↳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 collection that is no longer dynamically updated. This is a one-way process that cannot be undone, and the original stored search settings will be discarded. Refer to [Converting a Saved Search to a Standard Collection] for more.

          • ↳Next Collection

            Select the next collection tab in the stack, as shown in the tab list.

          • ↳Previous Collection

            Select the previous collection tab in the stack, as shown in the tab list.


        • Open//

          The Open submenu provides a number of ways to open a selected item. These menu items are relevant from the binder or collection views, as well as within the corkboard and outliner views, but note that in most cases, a single click in the sidebar or double-click on the icon in the editor, will open a file more directly. %BinderContext


          • ↳In Current Editor

            The actual labels of this and the next menu command will change depending upon the current editor that is active, and whether or not split orientation is horizontal or vertical, to make it more clear which editor the item will be loaded in.

            Use this command to open the selected items in the current split, replacing what you are currently working with.

          • ↳in Other Editor

            Open the selected items in the inactive split, opening a new split if necessary to do so. For example you can select a card in a corkboard and use this keyboard shortcut to open a split and load the contents of that card into the split.

          • ↳as Quick Reference

            Opens the selected document in a [Quick Reference panel][Quick Reference]. When in a Scrivenings session, the current segment of the overall session that is currently active will be opened as a Quick Reference panel.

          • ↳in Copyholder

            Opens the selected document in the [copyholder for the current split][Using Copyholders], opening a new one if necessary. When used in a Scrivenings session, the currently active segment of text will be loaded alone.

          • ↳in Quick Look

            This menu command is only available for types of files that Scrivener does not support with its built-in viewer. It will make use of your Mac's native Quick Look viewer, similar to having selected a file of that type in Finder and opening Quick Look from there.

          • ↳(with) Compilable Subdocuments

            Working in a manner similar to "With All Subdocuments as Flat List" (below), this loads into the view only those items that are set to [include in compile][General Metadata]. Read more about [filtering items in group view][Filter Outliner & Corkboard Views].

          • ↳With All Subdocuments as Flat List//

            Useful for cases where you'd like to see all of the cards in a particular section of your outline, even if they are nested several layers deep. The result of this command is a multiple selection, which means the items cannot be reordered as all depth information is lost by viewing cards this way.

            * *On Editor Corkboard*: replaces the current editor view with the selected item's contents. This is similar to pressing <$custom:shortcut> to open selected cards on the corkboard, only it also will a...

          • ↳in External Editor

            This command will open a file using the default editor for that type of file (for example, loading a PDF in Preview). This command is available on any type of item that is not a text or folder document. Opening items this way allows them to be viewed and edited in their native applications. Any edits made externally will be saved back into the project seamlessly. If Scrivener can display the type of file you edited, you might need to [refresh the viewer to see your changes][Reloading Edited Rese...


        • Editor//

          This submenu contains navigation commands that impact the editor and any content that it is viewing. When multiple splits are open, the commands target the active split. Some of the commands may also be available from Quick Reference and copyholder panes, and will be noted if so.


          • ↳Lock in Place

            Locks the editor (or split) so that no external navigation commands (such as clicking in the binder) will affect it, causing the other editor split, if available, to load the request instead (this behaviour can be adjusted in the Behaviors: Navigation !preference pane, by setting When focused editor is locked in place to "Binder selection does nothing"). When an editor is locked, its header bar will turn a shade of red. Read more in [Locking the Editor].

          • ↳Lock Inspector to Editor

            Available when the editor is split, this command locks the inspector sidebar to the currently active split. Ordinarily the inspector tracks the selection within whichever split you are currently working in. When this is engaged, the inspector header bar will turn red and the split it is locked to will be indicated by a red "inspector" dot in the header bar. You can now use the other split while leaving inspector material alone and available for reference. Read more about [Locking the Inspector].

          • ↳Lock Group View Mode

            Available only when the active editor is displaying a group view, or if the selected item is a container (folder, or file group acting as a folder). Any view mode can be locked, including single text document mode. Locking is a per-item setting, and is saved into the folder or container itself. The view mode will stick to what was in use at the time it was locked. You can change its saved view mode by simply switching the view mode while viewing the item. Read more about [Locking the Group View ...

          • ↳Scroll to Previous Page

            These menu commands will only activate when Page View is enabled on the active editor, or when viewing a PDF. This command will scroll the view so that the top of the previous page is flush with the top of the viewer, keeping the reading area stable as you browse.

          • ↳Scroll to Next Page

            This command scrolls the view so that the top of the next page is flush with the top of the viewer, keeping the reading area stable as you browse.

          • ↳Forward in Document History

            Much like a Web browser, the editor keeps track of everything you've visited within the project. Using these commands you can navigate back and forth in the history. You can also use the Forward and Backward buttons in the header bar (right-click on them to access the full history as a list). Each split keeps its own history.

            This command visits the document you were looking at prior to having gone back in history to the current document.

          • ↳Backward in Document History

            This command visits the document you were looking at before you navigated to the current one, and if you use it again, to the one you were visiting before *that*, and so on.

          • ↳Other Editor//

            There are a few commands accessible as keyboard shortcuts while typing in one editor that have an impact on the *other* editor without removing your typing focus from the current editor. I.e. You can scroll the other split and operate its history even while writing in another document.


            • Other Editor//Forward in History

              Visits the document that was being viewed prior to having gone back in history in the other split.

            • Other Editor//Backward in History

              And as you might expect, this visits the document being viewed in the other split prior to whatever you are viewing in it currently.

            • Other Editor//Scroll Up

              Scrolls the other editor back a page, similar to having pressed the PgUp key with it active.

            • Other Editor//Scroll Down

              Scrolls the other editor forward a page, similar to having pressed the PgDn key with it active.


          • ↳Clear Document History

            Use this command to wipe out the document history for the active editor.


        • Media//

          Controls and options for various types of playable media. These commands will only become available when viewing the appropriate type of media. Read more in [Viewing Multimedia Documents].

          If the editor is split this shortcut will start and stop the media even from the *other* split, allowing you to easily transcribe or reference the media while working elsewhere. When two media files are open at once, the shortcut will affect the active split.


          • ↳Play Media File

            Functionally, this acts like clicking the Play or Pause button in the media viewer, for either audio or video files.

          • ↳Fast Forward

            Jump playback forward by two seconds. This shortcut works while playback is running or paused. In the latter case, it will stay paused at the new position.

          • ↳Rewind

            Jump playback backward by two seconds, and otherwise follows all of the rules outlined above.

          • ↳Rewind on Pause

            This project setting toggles the behaviour whereby whenever media playback is paused, upon resumption it will be rewound by a determined number of seconds in the [Behaviors: Playback !preference pane][behaviours - playback].


        • 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 project window without using the mouse. The first lets you cycle between common elements, while the rest will jump immediately to that element of the interface, no matter where focus is currently placed. Note that in all cases, the elements you wish to cycle or jump to must actually already be visible. These shortcuts will not automatically...


          • ↳Rotate through main views

            This menu item follows a chain of the three most common areas of desired focus: the two editor splits 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.

          • ↳Binder

            Moves focus to the binder sidebar from anywhere in the interface, if visible.

          • ↳Left|Bottom Editor

            Moves focus to the Left or Bottom editor, if the editor has been split. When the view is not split, this command will be named "Editor" and will select the main editor.

          • ↳Right|Top Editor

            Moves focus to the Right or Top editor, if the editor has been split. When the view is not split, this command will be named "Other Editor", and will naturally be disabled.

          • ↳Header Bar Title

            Moves focus to the editor header bar title area where you can edit the name of the item you are currently viewing in the editor. If you are viewing something that cannot be renamed (such as a multiple selection) then the command will be disabled. Use !Return to confirm your changes and bring the typing focus back into the main viewing area of the editor.

          • ↳Copyholder

            If only one copyholder is visible on the screen (or none), then this command will be named "Copyholder", and target it no matter which split the focus is current in. Otherwise it will target the copyholder that is attached to the editor that is currently active, and the menu name will be altered accordingly.


        • Inspect//

          In continuation of the keyboard navigation functions, these deal solely with the revealing and focussing of tabs, and occasionally panes within, of the [inspector]. The shortcuts work on the following principles:

          1. The inspector itself will be revealed if necessary when the command is used.

          2. If the keyboard shortcut cause the inspector to switch to its respective tab, then the action will simply reveal it without disturbing your original typing focus.

          3. If the tab is already visible, the...


          • ↳Notes

            Reveals or switches focus to the notes tab. Use the Synopsis command below to focus the upper portion of this tab.

          • ↳Bookmarks

            NOTE//WINDOWS// Look up shortcut used for switching scope.

          • ↳Metadata

            Reveals the metadata tab, and switches focus to the Custom Metadata pane within it. Use Tab and Shift-Tab to navigate between text and date fields. Use the Keywords command below to switch focus to the lower third of this tab.

          • ↳Snapshots

            Reveals or switches focus to the snapshot list. Use arrow keys to flip between available snapshots and view their contents in the preview area below.

          • ↳Comments and Footnotes

            Reveals or switches focus to the comments & footnotes tab. The UpArrow and DownArrow keys can be used to navigate through the list, and RightArrow and LeftArrow to expand and collapse selected notes.

          • ↳Synopsis

            Reveals the notes tab and switches focus to the synopsis text area. Use the Notes command above to focus on the lower portion of this tab. Use the Cmd-7Ctrl-7 keyboard shortcut to switch between viewing the synopsis as an image or text.

          • ↳Keywords

            Reveals the metadata tab, and switches focus to the Keywords pane within it. Arrow keys can be used to navigate amongst keywords; !Return can be used to add new keywords; and !Delete to remove keywords.


        • Outline Groups//

          These commands make it easy to jump from one group to the next, where group is defined as any folder in the binder. This behaviour can be altered to also include all containers with subdocuments, in the [Behaviors: Folders & Files !preference pane][behaviours - folders and files].


          • ↳Previous Group

            Jumps the selection to the previous visible container in the active outliner or binder, no matter what the depth. 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.

          • ↳Next Group

            Working in the same fashion as Previous Group, only selecting the *next* visible container downward from the current position.


        • Binder Selection Affects//

          These project settings toggle which split binder sidebar clicks will be opened in. By default when you click on something in the sidebar it will be sent to the targeted 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

            This is the default behaviour out of the box. Whichever split you worked in last will be targeted.

          • ↳Other Editor

            Whichever split is *not* currently active will be targeted. This way your current work space is never disturbed by usage of the binder.

          • ↳Top|Left Editor Only

            The top or left split (depending upon orientation) will always take binder clicks no matter which split is active.

          • ↳Bottom|Right Editor Only

            The bottom or right split (depending upon orientation) will always take binder clicks no matter which split is active.

          • ↳Both Editors

            In this special case, *both* editors will update whenever you click on something in the binder. This will most often be useful when using two different group view modes. You could have an outliner in the left view and a Scrivenings session in the right, both showing the same area of the binder in their own unique ways.

          • ↳None

            Neither editor will update when using the binder. In this mode of usage, you will always need to manually open items into an editor. This can be done by using the Open commands in the right-click menu or Navigate menu, or by drag and drop into the header bar.


        • Outliner|Corkboard Selection Affects//

          The project settings in this submenu impact how splits interact with one another. When active, the effect is to cause the active split to act a bit like the binder sidebar, in that whatever you click on within it will automatically be loaded in the other split.

          This behaviour can also be toggled in the footer bar with a toggle button that rotates between [the available modes in this menu][Linking Splits Together], and from the Touch Bar. If there is neither a split editor or a copyholder then t...


          • ↳None

            This is the default behaviour. Clicking on rows in the outliner or cards in the corkboard will never automatically open those items in other views.

          • ↳Other Editor

            When selecting items in the corkboard or outliner view, they will be automatically loaded into the other split view using its preferred view settings.

          • ↳Copyholder

            If a copyholder has been attached to the current editor, you can elect to have any individually selected items loaded within it automatically, turning it into a viewer for the split.


        • Clear All Navigation Options

          Removes all settings from the active project window that impact navigation, as described in [Clearing Navigation Settings].


      • Project Menu

        The Project menu addresses commands and configuration options specific to the active project, such as document format over-rides, custom metadata and statistics. If more than one project is open, this menu will make use of the foremost project window.

        The initial commands listed here that add new items to the binder are also accessible within an "Add" submenu in the binder contextual menu.


        • New Text

          Creates a new text document below the current selection or list of documents within the current view. When a folder is selected, the new file will be created within the folder.[^ <$include>] Otherwise the new file will appear as a sibling below the current selection, or the location of the current document that is being edited.

          When the current position for a new item is within a container that has a [default subdocument template][Default Subdocument Template] assigned to it, the menu label w...

        • New Folder

          Creates a new folder below the current selection or list of documents within the current view. Folders will always be created as a sibling to the current selection, save for when that selection is either the Draft or Research special root folders.

          For more information on how items are placed when creating them, read [Figuring Out Where Things Will Go].

        • New From Template//

          This submenu displays all of the document templates found within the current project in hierarchical order. If no template folder has been assigned, the menu will simply contain a message to that effect. Read more about [Document Templates] if you'd like to create your own document types.

          If you select a container from this menu, not only will that container be created as a new document, but all of its child templates will be brought along as well. You can thus create complex boilerplate struct...

        • Project Settings...

          If a setting isn't established in the main application !preferences, or in one of Scrivener's menus, then chances are it can be found within the Project Settings panel. Section types, labels, status, custom metadata, text formatting, auto-completion lists, document templates, backdrop images and individual project backup settings can all be made here. For detailed documentation on the various tabs within this panel, refer to [Project Settings].

        • Show Project Targets

          Toggles visibility of the floating [project targets panel][Project Targets], for tracking a few simple metrics in real-time as you type and edit that can be left open while you work. These progress bars themselves can also be found in the toolbar's [Quick Search tool] by default.

        • Statistics...

          Opens a window displaying text statistics for the current project, including the word, character and page counts for the draft, the current binder selection or when called from a text editor, statistics for that section of text you are editing. Refer to [Statistics] for more information.

        • Writing History...

          As you work in your project from one day to the next, Scrivener will record your writing progress in the background and keep a number of statistics available to you within this panel. You can also export the raw data to a CVS file, where you can then take the numbers into a spreadsheet for further visualisation or analysis. Read more in [Writing History].

        • Show Project Keywords

          Displays or closes the [project keywords panel]; for managing all of the keywords in use by your project or assigning them to items.

        • Show Project Bookmarks

          This command has a few different results based upon the context of its usage. Refer to [Project and Document Bookmarks] for full documentation on this feature.

          * *Project window is active*: if not already shown, a list of bookmarks in a floating window will be opened, where they can be managed or navigated to. If it is shown but you are working in the project window, then this command brings the panel to focus. You can also open this panel by clicking on the Bookmarks button in the toolbar an...

        • Empty Trash...

          Permanently discards the current contents of the project Trash folder. You will be warned before this is done, as once contents have been deleted, there is no way to undo that action. This can also be done by right-clicking on the trash folder itself in the binder.

          If you instead wish to only delete some items from the trash, select them from within the trash folder and use the Edit//Delete menu command.


      • Documents Menu

        Contains all commands relating directly to existing documents, such as duplicating and splitting, moving and copying them, converting between types, bookmarking, setting icons, cleaning up formatting, titles and synopsis, managing snapshots of text milestones and so forth.


        • Snapshots//

          This submenu provides commands to manage a document's snapshots, make new ones, and commit large-scale snapshot actions on selected items. There are some circumstances where these shortcuts will be unavailable. Generally this happens when the selection includes items that are not text items, if the text of the item(s) are empty or no changes have been made to them since the last snapshot. For more information on how to use snapshots, see [Using Snapshots].


          • ↳Take Snapshots (of Selected Documents)

            When viewing any text or folder document, this command will take a snapshot of the current text and store it for later use. When selecting items from a list of any sort, the title of this item will change to "Take Snapshots of Selected Documents", and all selected documents will have a snapshot taken of them.

          • How to snapshot an entire folder

            Selections must be precise, but you can easily select a folder and all of its subdocuments with a single command, Edit//Select//Select with Subdocuments (<$custom:shortcut>), from an outliner or binder view, and then take the snapshots.

          • ↳Take Titled Snapshots (of Selected Documents)

            You will be asked to provide a name for the snapshot before it is taken. This name will be displayed in the snapshot list. It is always possible to adjust the names of snapshots after they have been taken.

          • ↳Show Snapshots

            Switches to the snapshots tab in the inspector, revealing the inspector if necessary. This command is functionally identical to Navigate//Inspect//Snapshots.

          • ↳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. If two snapshots are selected, these two snapshots will be compared between each other, using the oldest snapshot as the original.

            Comparisons can also be performed in the main editor or copyholders. Refer to [Comparing Changes in the Editors] for more information.


            • Show Changes//Compare

              Toggles visibility of the change tracking mode.

            • Show Changes//Comparison Granularity//

              These options can be toggled on and off individually to determine how closely changes will be tracked, with the finest level selected being the used method. "By Paragraph" will only mark changes at the paragraph level; "By Clause" only marks changes made at the phrase level; "By Word" is the most detailed level of change tracking available. Use these settings to fine-tune the results if what you are getting is too precise or vague to be useful.

            • Show Changes//Next Change

              Scrolls the view to the next available difference in texts. This and the following command can also be used from the copyholder or main editor if they are viewing a snapshot in comparison mode.

            • Show Changes//Previous Change

              Scrolls to the view to the previous available difference in text.


          • ↳Roll Back

            Rolls back to the selected snapshot, replacing the text in the main editor. The option to snapshot the *current* editor text, before reverting the text, will be given in a 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 DelButton button in the Snapshots Inspector.

          • ↳Show Snapshots Manager

            Opens [the Snapshots Manager] window, where all snapshots in the project can be browsed and managed from a convenient central location.


        • Duplicate//

          There are two different methods you can use to duplicate the selected items.


          • ↳with Subdocuments and Unique Title

            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. If the current title ends in a hyphen + numeral, Scrivener will use an incremented number in the copy. For example is the document you are duplicating is called "scene-5", duplicating it would result in a file called "scene-6". It will otherwise add "-1" to the end of the duplicated item, starting a new sequence if further duplications are made. %BinderConte...

          • ↳without Subdocuments

            This is most useful when you only want to duplicate 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.


        • Split//

          Provides a couple of methods for splitting the current document in two. In both cases, everything below the current cursor position will be moved into a new document below the current one. Everything above the cursor will remain unchanged. This action cannot be undone (except via the Merge command, below). Refer to [Splitting and Merging Documents] for more information.


          • ↳at Selection

            Split the new document off from the current one, using all text after the current caret position (this can even split a paragraph in two). In cases where text has been selected, the caret position will be considered as the start of the selection range.

          • ↳with Selection as Title

            In all details this command works identically as the above, but in this case the currently selected text will be used to title the new document that is created, rather than leaving the title empty.


        • Merge

          The opposite of splitting, merge will take two or more selected files or folders and concatenate 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 metadata 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 met...

        • New Folder From Selection

          Takes one or more selected items and groups them into a new folder. You will be given the option to name that folder after invoking the command. When used from a selection of index cards on the corkboard, the selected cards will "disappear" from the current corkboard into the newly created folder card. %BinderContext

        • Ungroup

          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 change or move the original container, allowing you to move the items back in, if it was made in error. %BinderContext

        • Move To//

          Provides a binder item selection submenu, used to select a target item to nest the currently selected items beneath. Since any document can be selected in this menu, the action may result in the selected item becoming a file group.

          The upper portion of this menu, labelled "Favorites", will track the most commonly and recently used targets in this project. When a new item is used, it will be given priority display in this area, but will fall off more quickly than the other more frequently used t...

        • Move To "X" Again

          This convenience command will appear if during the current session you have moved an item using the "Move To" submenu above it. It will use the last location you used with this command, making it easy to file additional documents to the same location. %BinderContext

        • Copy To//

          Operating in a very similar fashion to the Documents//Move To// submenu, the selected documents (and all child items beneath them) will be *copied* to the target location. %BinderContext

          If you would prefer to use drag and drop with the mouse to perform this action, you will need to enable that behaviour in [the Behaviors: Dragging & Dropping !preference pane][behaviours - drag and drop]. You can then hold down the OptionAlt key while dragging to create copies of the selected items in the drop...

        • Add to Collection//

          Displays a list of all [standard collections] in the project. It is not possible to add items manually to search collections---they would need to be altered to match the search criteria to be included. The currently selected items will all be added to the collection you choose from this submenu. %BinderContext

          At the top of this menu (or as a sole entry if there are no standard collections yet in the project) will be a "New Collection" command. When used, the collection tab list will be reveal...

        • Add to|Remove from Project Bookmarks

          The selected items will be appended to the [project bookmarks][Project and Document Bookmarks] list if they are not already listed within it. If the entire selection is already listed then the "Add to Project Bookmarks" command will be disabled. Use the opposing command, "Remove from Project Bookmarks" to remove all selected items from the list.

          When the selection is mixed, containing some items that are bookmarked and some that are not, these commands will still be made available. This way you...

        • Convert//

          This submenu provides tools for converting the document's type, scriptwriting mode, or text formatting.


          • ↳Text to Default Formatting...

            Resets the text of the selected files and folders (or the text in the active editor session, including multiple documents in Scrivenings) to the default formatting used for new files, as established either globally in the [Editing: Formatting !preference pane][editor - formatting], or on a per-project basis in [project settings][project settings - formatting]. You may also wish to read more about [Resetting Formatting] in general.

          • ↳Script Format...

            Useful when you need to switch from one scripting standard to another. Note that if all you wish to do is change the current document writing mode, you should use Format//Scriptwriting//Script Mode (<$custom:shortcut>) 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].

          • ↳to File|Folder

            Converts the selected items to folders or files respectively. Note that these two document types 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. If the selection contains a mix of types, or items that are neither files nor folders, then the command will be disabled. %BinderContext

          • ↳Web and PDF files to Text

            Activates when viewing an MHT format WebArchive or PDF item. Will scour the file for its text content and create a rich text file from it that is editable and considered a text document from that point onward. Note this cannot be undone. Create a duplicate of the original beforehand if you wish to retain a copy with its full layout.


        • Auto-Fill//

          These commands can be useful for managing the titles and synopses of files in conjunction with text found or selected in the main editor.


          • ↳Set Selected Text as Title

            When text has been selected in the main editor the title for the current document will be set to that selection. If you are splitting up a longer document into a format more useful within Scrivener, consider using the Documents//Split//with Selection as Title (<$custom:shortcut>) menu command instead.

          • ↳Clear Titles

            Removes the titles from all selected documents, leaving them blank. This has the effect of causing them to print the first few words from either the synopsis or main text content (in that order of precedence) in various contexts such as the binder sidebar.

          • ↳Set Synopsis from Main Text|Selection

            This command has two modes of operation:

            * *Set Synopses from Main Text*: when the active selection is a quantity of files in a group view, such as the corkboard or binder, each item will have its synopsis updated to use the first few lines of text in that folder or file (it will be left blank if there is no text). This command also works if a text editor is active, and will in that case be considered a selection of one file. In Scrivenings mode, the document the cursor is within will be affec...

          • ↳Send Synopsis to Main Text

            The contents of the selected items' synopses fields will be appended to the end of the main text in each item, respectively. 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 unavailable if the selection doesn't include any items with synopses.


        • Change AliasShortcut Source...

          : If the selected binder item is an aliasshortcut to some other file on your disk, this command will allow you to point it to a different file. This will most often be useful if the original file has gone missing and has been restored.

        • Replace Media File...

          When anything other than a native folder or file has been selected in the binder, this command allows you to swap out the stored data with another file on your hard drive. A practical example where this could be useful is if you have a cover image for your book in the binder and you receive an updated copy from the artist. The new cover would be imported, replacing the old image within the project. In all other regards, such as links and preferences pointing to this image, the item itself will b...

        • Default Template for Subdocuments//

          Select any existing group in the binder and use this command to make it so that new files created within that group will use the selected document template instead of the stock vanilla file type. To revert its behaviour to default, select the "Text" choice at the top of this submenu. In projects that lacking any templates, this menu will simply offer "Text" as the sole choice. Refer to [Default Subdocument Template] for further information.

        • Change Icon//

          This submenu displays all built-in and any custom icons added to the project or installed on your machine. Select items in any group view and then choose an icon from this menu to change their icons. When called from the editor or copyholder, the active document will have its icon changed. %BinderContext


          • ↳Reset Icon to Default

            Select this option to remove a custom icon from the selected documents, or the active document from the current editor or copyholder.

          • ↳Icon from Text...

            Using this tool, you can take any text and turn it into an icon. This will work best with single characters, such as Unicode symbols or Emoji. Refer to [Icons from Other Sources]. This command will automatically bring up the Mac's Emoji & Symbols"Special Characters" Windows utility. If you need to open it again, you can [click the "smiley face" button](#icons-new_from_text).

          • (new icon from text)

            MISSING_IMAGE:/path/to/gfx/icons-new_from_text.jpg

            Adding the "Paperclip" Emoji as an icon.

          • ↳Manage Custom Icons...

            Opens the Manage Icons dialogue, where you can add or remove your own custom icons. You can manage both those icons loaded into the project as well as those installed on the system from here. For more information on managing and creating icons, read [Custom Icons].

          • ↳Text Based Icons//

            This submenu will list any text-based (such as Emoji) icons that have been found within the project, or that have been used in the current session. As you add or remove such icons from the project, this menu will list it so you can conveniently add them to new items.


        • Move to Trash

          Moves the selected binder items to the project's Trash folder. Scrivener works in the same fashion that the FinderFile Explorer does. Periodically, you can review the contents of this and empty the trash to clear up space, using the Projects/Empty Trash... command. %BinderContext


      • Format Menu

        The Format menu contains all commands that deal with formatting the text of an individual document. It contains all of the usual commands you would expect to find for changing the font, setting line spacing, creating tables and lists and controlling the ruler, along with commands for highlighting and setting the current text colour. Additional tools related to formatting will be found here, such as revision markings, scriptwriting tools and style commands.


        • Font//

          All commands relating to ad hoc character formatting will be found in this section of the menu. This includes basic settings like bold and italic, adjusting the size, kerning and other typographic features. Use these to set up new styles or modify text on the fly. Many of these tools can also be found on [the Format Bar].


          • ↳Show Fonts

            Access the standard system font palette. Use this to change the font settings you type in from that point forward, or alter the existing font of a selected range of text.

          • Bold/Italic (CmdCtrl-B, CmdCtrl-I)

            : These basic formatting commands in the same fashion by either modifying the cursor attributes if there is no selection, or toggling the selected text between the various styles. Note that not all fonts support bold and italics. If it appears that one of these is not working, check your font for the proper typefaces.

          • ↳Underline//

            This submenu provides several underlining styles. The default command with the shortcut is what most people will wish to use when underscoring text. Use the "By Word" option to omit underscoring across whitespace characters.

          • ↳Strikethrough

            Crosses out the text you have selected. When used in conjunction with [marking revisions], the current revision level colour will be used for the strikeout. Strikethrough can also be applied to text in PDF documents.

            The setting can be more than merely cosmetic. Struck-through text can be easily deleted at a later time via the Edit//Text Tidying//Delete Struck-Through Text menu command, and can be dynamically stricken from the output with the Delete struck-through text setting in the compile ov...

          • ↳Outline

            Changes the style of the font to outlined instead of filled. This will be more useful with larger, heading size fonts with heavier weights.

          • ↳Bigger

            Increases the size of the font by one point.

          • ↳Smaller

            Decreases the size of the font by one point.

          • ↳Character Spacing//

            Adjust the kerning of the selected text, or between the two characters around the cursor. The "Use Default" selection allows the font to choose the kerning based on the designer's metrics (this will nearly always be the best choice), while "Use None" disables the font's built-in kerning. It would be advantageous to set keyboard shortcuts to the "Tighten" and "Loosen" commands if you intend to use these frequently.

          • ↳Ligature//

            If the font family supports typographic ligatures, they can be enabled or disabled here. Most fonts default to using standard ligatures (ff, fl, fi and so on). Some include rare ligatures, which may be enabled by the "All" setting. It will usually be better to use the Format//Show Fonts panel, click on the GearMenu button and open the "Typography" panel, for more precise and extensive options.

          • ↳Baseline//

            Adjust the baseline height of the text, most commonly referred to as superscripting and subscripting. In addition to jumping straight to those presets with respective commands, you can also incrementally raise and lower the baseline. "Use Default" will reset the baseline to the normal.

          • ↳Character Shape//

            If the font family supports typographic shape alternates, they can be adjusted here, such as old style numerals and traditional forms.

          • ↳Copy Font

            Copies the font settings from the current cursor position. We use this term liberally, to include all forms of inline formatting, such as bold, underscore, overstrike, text colour, highlights and of course all of the font settings found within this menu.

            This command does not overwrite the current standard clipboard; it uses a special clipboard reserved for these settings alone.

          • ↳Paste Font

            Use this command to apply format settings, copied using the above command, to other selections of text.


        • Paragraph//

          Displays the standard macOS Text submenu, which contains useful tools for controlling the paragraph-level formatting of your text. Paragraph alignment and spacing can also be controlled with the [the Format Bar].


          • ↳Align Left

            Sets alignment on the selected paragraphs to flush left, or ragged right.

          • ↳Center

            Centres the alignment of the current paragraph.

          • ↳Justify

            Sets alignment on the selected paragraphs to fully justified, or flush left and right.

          • ↳Align Right

            Sets alignment on the selected paragraphs to flush right, or ragged left.

          • ↳Tabs and Indents...

            Brings up a panel that can be used to manually insert tabs and set paragraph indenting using precise measurements, rather than using a visual ruler. For more information on using this panel, refer to [The Tabs and Indents Tool].

          • ↳Increase/Decrease Indents//

            The commands in this submenu all operate on the current paragraph or selection of paragraphs, as the case may be, and is provided primarily so that you can supply you own custom keyboard shortcuts to the most frequently used commands. They independently adjust the three different indent aspects of a paragraph (the fourth, hanging indents, is a shorthand for adjusting the two left-side indent controls in an inverse fashion than is typical, causing the first line to be further left than the body o...


            • Indents//Indents

              Increase/Decrease Indents Ctrl-Cmd-RightArrow & LeftArrow

              : As a block indent, all left-side indent settings are moved left or right uniformly. If it is a hanging indent, for example, it will remain a hanging indent, only with both indent settings moved one way or the other.

              : This command is synonymous with the Edit//Move//Move Left and //Move Right commands, and that is where the keyboard shortcuts for it will be found.

            • Indents//First Line Indent

              Increase/Decrease First Line Indent Ctrl-Opt-Cmd-RightArrow & LeftArrow

              : Only the first line the paragraph will have its indent increased or decreased. When the rest of the paragraph is indented it is possible to decrease the first line indent beyond the rest of the paragraph, forming a hanging indent (though in general it will be easier to use the next command to create these).

            • Indents//Hanging Indent

              The main body of the paragraph will have its indent level adjusted while leaving the first line indent alone. If the paragraph is already indented then it may be possible to decrease the indent level beyond the first line, resulting in a normal looking paragraph.

            • Indents//Right Indent

              The right-hand indent of the paragraph will be increased or decreased. It is important to be aware of the fact that a right indent is measured from the left of the page, not the right. In other words if you move the right indent inward 2cm, the indent setting might be more like 16.5cm, which could have implications if the margins or paper size change.


          • ↳Remove All Tab Stops

            A convenience tool to delete all tab stops in the current paragraph or selection.

          • ↳Line and Paragraph Spacing...

            Brings up a handy tool for setting paragraph and line spacing attributes in the selected or current paragraphs. You can also access this tool from [the Format Bar].

          • ↳Writing Direction

            Toggle between Left-to-Right and Right-to-Left writing styles. This will usually be automatically done for you when changing keyboard input modes.

          • ↳Keep with Next

            Inserts an invisible character which will keep attempt to keep this paragraph glued with the next paragraph, so that they will not become separated by a soft page break.

          • ↳HTML Header Level

            This will only be of interest in conjunction with styles in eBook and Web publishing, as well as the Markdown-based formats. For the latter case, one must have the Convert rich text to MultiMarkdown option enabled, in [the General Options tab of the compile overview screen][compile - general options]. They will set the heading level for the selected text in these outputs when compiling, and of course will be saved into any styles you create from that text. Unless you intend to use headings dire...

          • ↳Copy Paragraph Attributes

            Copies the ruler and paragraph format settings from the current paragraph. These settings can be pasted into any rich text view, even compile settings panels that take formatted text.

            This command does not overwrite the current standard clipboard; it uses a special clipboard reserved for these settings alone.

          • ↳Paste Paragraph Attributes

            Pastes any stored ruler and paragraph settings to the selected or current paragraphs.


        • Style//

          Styles are a way of assigning meaning to your text, and optionally formatting or other visual cues. Once text has been assigned to a style it will stay in sync with any future updates made to that style's settings. Read more about [Styles and Stylesheets].


          • ↳New Style From Selection...

            Starts the creation process for a new style, using the formatting of the selected text, or from the paragraph the cursor is located within. Read more on [Creating New Styles].

          • ↳Redefine Style From Selection//

            Takes the formatting from the currently selected text or paragraph and updates the designated style you choose from this submenu. Read more on how to [Redefine a Style].

          • ↳Delete Style//

            Deletes the style you choose from this submenu. The formatting applied to text that is assigned to this style will be left alone, but the style assignment itself will be stripped from all text throughout the project.

          • ↳Show|Hide Styles Panel

            Toggles the display of the floating styles panel. If you use styles frequently, you may wish to keep a window like this open off to the side so you can see at a glance which styles are applied to the text you are working with, and apply styles to text with a single click. You can also easily modify and manage your styles from within this pane. Refer to [The Styles Panel] for further documentation on this feature.

          • ↳Pop Up Styles Menu

            Reveals the "Apply Style" menu directly on your screen without having to go to a separate menu or format bar to access them. It is not accessible when the document is in script writing mode, as the shortcut will be reassigned to the scripting elements menu.

          • ↳Set Default Formatting...

            Loads the [Project Settings: Formatting pane][project settings - formatting], where you set what un-styled text should look like via the Main text formatting area.

          • ↳Import Styles...

            Brings up a file selection dialogue box. Use this to select the Scrivener project from which you want to copy its stylesheet. Refer to [Copying Stylesheets Between Projects] for further detail on how to manage merging when importing styles.

          • ↳No Style

            Depending upon the context, this command has different effects. When used upon selected text the styling from that selection will be stripped out, returning it to either the look of the paragraph style beneath it, or to standard un-styled text. When used without a selection within a paragraph that has a paragraph style applied to it, the paragraph style will be simply removed from the entire line.

            When used while typing, the effect is to cease typing in the style that was being used up until th...

          • The remainder of this menu will list the paragraph and character styles available in this project. Use of them will apply the chosen style to the selected text, or alter the formatting of the cursor.


        • Table//

          Use the "Table..." command to insert a starter table (more easily access with the Insert//Table... command). The remaining commands in this menu are documented in the [tables contextual menu] section, and of course are also available when right-clicking directly inside of a table in the editor.

        • Lists//

          Supplies basic list styles, and few advanced controls for bullet and enumerated list management, from the "Custom List...". The list creation aspects of this menu are also available when clicking on the list button in [the Format Bar]. You can cycle through the various list styles from any existing list in the editor with the following commands:

          * *Next List Style* (Opt-Cmd-RightArrow): selects the next list style from the currently selected style.

          * *Previous List Style* (Opt-Cmd-LeftArrow):...

        • Scriptwriting//

          Although Scrivener is not a dedicated script writing application such as Final Draft, Fade In Pro or WriterDuet, the scriptwriting submenu makes it relatively straightforward to create first drafts which can be later fine-tuned in these and similar applications. For full documentation on this feature, refer to [Scriptwriting].


          • ↳Script Mode (Format)

            Toggles the current scripting mode on or off for the selected documents in any group view or the binder sidebar, and for the current document in the main editor---or all documents within the current Scrivenings session. Toggling script mode on and off only changes how text input is formatted while writing, not any aspects of text that has already been written. You can thus switch to normal prose and then back again, making this a great shortcut to learn when writing treatments.

          • ↳Script Settings...

            Brings up the script settings window, where all aspects of the project's script settings can be modified, and new scripts and elements can be created from scratch. Read more about this tool in [Creating Your Own Script Formats].

          • ↳Re-capitalize Script

            Any elements in the current script mode that are set to be capitalised will be converted to all-cap text if they are not already. This will mainly only be of use when importing text that isn't already capitalised, as this is done automatically for you when using and writing with elements normally.

          • ↳Change Element To

            Converts the selected text to a different scripting element. Note that if the previous element set the text to all-caps, and the element you are changing to should not be capitalised, you will need to fix the text yourself, making use of the tools in the Edit//Transformations// submenu.

          • ↳Show Script Elements Menu

            Reveals the script element selection menu, also available by clicking in the lower left corner of the editor footer bar. Single-letter shortcut keys can then be used to select an individual element, if the script settings have been configured to use them. For example in our built-in screenplay script, the "C" key will switch the line to Character mode.

            This command will only be available when script writing mode is enabled in the active editor. The shortcut will otherwise bring up the styles me...

          • The remainder of this menu will list all of the scripting styles installed on your computer, along with a number of built-in styles that ship with Scrivener. Each project can only use one script at a time. Thus you will be asked to convert existing script documents upon selection. If you haven't written anything yet you can ignore that dialogue, but if you have substantial writings already committed you will want to pay close attention to the element conversions table and other options provided ...


        • Color...

          Toggles the visibility of the colour selection palette. Note that Scrivener uses this palette for all cases where a custom colour can be set by you, but when invoked with a text editor active, the effect will be to colour the selected text or the cursor attributes.

        • Highlight//

          The highlight menu lets you place a background highlight behind the selected text, much like using a highlighter marker on paper. In addition to the five provided presets, this menu also displays any favourite colours that have been set on your system. For more information on how to use highlights, see [Text Colour and Highlights].


          • ↳Highlight Text

            Highlights the selected text, or alters the cursor's attributes, using whatever colour you used last. If the text is already highlighted and you are using the same highlight colour then the effect will be to remove highlighting from that text. Otherwise the text highlight will be switched to the new colour. Highlighting (in basic yellow) can also be applied to text in PDF files.

          • ↳Remove Color

            Strips all highlighting that has been applied to the selected text.

          • ↳Show Colors...

            This choice will appear at the very bottom of the list of colours. Use this to select a custom colour using the standard colour picker. Note that if you right-click the highlight tool in [the format bar, you will be provided with a number of handy presets][The Format Bar].


        • Revision Mode//

          Revision modes force anything you type to be displayed in a provided colour until you disable the revision mode (it also impacts strike-outs). Select one of the five revision levels in this menu to enable the mode, and again to toggle it off. For more information on using this, see [Marking Revisions].


          • ↳Mark Revised

            When a text selection has been made *and* a revision level 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.

          • ↳Remove Current Revision Color

            This command is only available when one of the revision levels is active. It will strip the current level from the active editing session, leaving the rest alone.

          • ↳Remove (All) Revisions

            Indiscriminately removes all five revision level colours from the active editing session. When text has been selected, the command will read "Remove Revisions" and only strip markings from within the selection.


        • Copy Formatting

          Combining both the effects of Format//Font//Copy Font and ...//Paragraph//Copy Paragraph Attributes, all formatting from the selected text will be placed on a special clipboard, for pasting to other text.

        • Paste Formatting

          Pastes all formatting from the formatting clipboard. This will include anything you've copied using the Format//Font//Copy Font, ...//Paragraph//Copy Paragraph Attributes or Format//Copy Formatting commands. In essence they all share the same clipboard, but ordinarily only use portions of it depending on which command you use to paste.

        • Preserve Formatting

          This is a legacy feature from older versions of Scrivener. It will protect all formatting found within the range of text you apply it to, when compiling through formats that would otherwise change that text. Most of this capability is now provided through the stylesheet system, but there are still a few niche special-purpose uses for this command. Read more about them in [Preserve Formatting].

        • Make Formatting Default

          This will make the currently-selected formatting in the editor the default formatting for all new documents, without otherwise going through and changing these settings in [the Editing: Formatting !preference tab][editor - formatting] (or [the Project Settings: Formatting pane][project settings - formatting] if the project is overriding the application defaults). Upon use of the command you will be asked whether you want the attributes of the selected text to be used in your global application !...


      • Window Menu

        The Window menu contains some standard commands for controlling windows, tabs and panels. It concludes with a list of all open projects.


        • Minimize

          Minimises the window to the Task BarDock. Hold down the Option key to minimise all.

        • Zoom

          NOTE//WINDOWS// need to check these behaviours on Windows. 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.

        • Zoom to Fit Screen

          Zooms the window so that it fully fills the screen, excluding the Dock and menu bar.

        • Show Previous Tab

          Scrivener supports macOS tabbed window features. Projects can be combined into the same window as tabs, and Quick Reference panels can be combined into their own window. The following three commands will be disabled unless you have merged windows and have tabs in that active view.

          This command selects the previous (left) tab in the current window.

        • Show Next Tab

          Selects the next (right) tab in the current window.

        • Move Tab to New Window

          Separate the current tab back out to its own window.

        • Merge All Windows

          Merges all open windows of a like kind (project vs Quick Reference) into a single window. If you wish to only merge select project windows together, first open the tab bar for each project with the View//Show Tab Bar menu command, and then drag and drop the tab from one project into the other's tab bar.

        • Layouts//

          This submenu is populated by the saved layouts you've created and a few built-in layouts to get your started. This menu provides an easy mechanism for rapidly converting your project window to different workflows, depending on what you are currently doing. Read more about [Saved Layouts].


          • ↳Manage Layouts

            Opens or activates the Layouts panel, where you can save, update, export/import or recall project window view settings.


        • Float Window

          Toggles whether or not the current project window should "float" above all other windows. This will make it visible at all times, even when switching to other programs.

        • Float Quick Reference Panels

          Toggles whether or not Quick Reference panels should float over all project windows for this specific project. This setting impacts all Quick Reference panels created from the current project. Panels from another open project will behave in accordance with that project's settings.

        • Show|Hide Scratchpad

          Displays or closes the floating [Scratchpad Panel], useful for collecting information while using other applications. You can assign a keyboard shortcut to this command in [the General: Scratchpad !preference pane][general - scratchpad].

        • Bring All to Front

          Brings all Scrivener windows to the front. Hold down the Option key to change to Arrange in Front.

        • The next portion of the menu only appears if the currently active project has open Quick Reference panels. They will each be listed in this section by name.

        • Close All

          Close all open Quick Reference panels for the current project.

        • Closed Quick Reference Panels

          During a single session, any Quick Reference panels that have been closed will be saved into this submenu, giving you quick access to them if you need to re-open them.

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


      • Help Menu

        The Help menu provides access to the standard Mac's menu search utility, as well as useful tools and links for learning Scrivener, checking for software updates or getting in touch with us if you require technical support.


        • Scrivener Manual

          A quick link to the PDF that you are likely reading this from. 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 page](http://www.literatureandlatte.com/learn-and-support/user-guides).

        • Interactive Tutorial

          If you have not yet gone through the tutorial (you should!) this menu command will create a project designed to walk you through the process of learning the basics of Scrivener. 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 link to our web site's [video page](http://www.literatureandlatte.com/learn-and-support/video-tutorials).

        • List of All Placeholders...

          There are many placeholders 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

          Jump to our web site's [support page](http://www.literatureandlatte.com/learn-and-support). Here you can download the latest copy of the PDF in US Letter or A4 (as well as the project used to create them), find contact email addresses, links to our forums and wiki, after-sales support from our vendor, eSellerate, and more.

        • User Forums

          Jump 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.

        • Release Notes

          Jump to the official [release notes](http://www.literatureandlatte.com/scrivener/release-notes?os=macOSWindows) web page on the web site.

        • Literature & Latte Home

          Jump to our [home page](http://www.literatureandlatte.com/) which provides easy access to everything else we offer on our web site.

        • Scrivener Home

          Jump to the main [Scrivener web page](http://www.literatureandlatte.com/scrivener), 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 email address and name to subscribe to our newsletter. This is a low volume list that we use to send out important updates and news. NOTE// this may not be accurate; we'll need to see where emails come from once they are coming from the new listing service. Please take care to whitelist "litereatureandlatte.com" in your spam filter, prior to submitting this form, as you will be sent a confirmation email which must be responded to before you will ...

        • Purchase Scrivener...

          Jump to our web store, where you can purchase Scrivener through our secure vendor (eSellerate) and the other software or materials we have for sale.


    • !Preferences


      • Like most applications, Scrivener installs in a "ready to use" state. The default !preferences have all been carefully selected to present a cohesive and useful writing environment, and most of this manual will presume you are using them. We know that a creative working environment should bend to your working habits as much as possible, however, and so there are a great many ways to tweak the look and feel of the interface. This appendix will go over every setting and point you to any further di...

      • !Preference Organisation and Management

        For ease in finding documentation on the setting you are looking for, this appendix we will be organised in the same manner as the !preferences panel itself. To get started, use the Scrivener//Preferences...Tools//Options... menu command (<$custom:shortcut><$custom:shortcut>). NOTE//WINDOWS// cross-ref keyboard shortcut for tools/options

        MISSING_IMAGE:/path/to/gfx/prefs-tab_layout.jpg

        The "Editing" category is divided into three sections as tabs.

        Along the top of the window are the major pref...


        • !Preference Presets and Themes

          Along the bottom left edge of the !preference window you will find a Manage... button with a dropdown menu containing several options available for organising or backing up your settings, as well as access to any presets you might have saved. This can be particularly useful if you work on more than one computer, and in the case of themes, to switch up your working environments between favourite sets of colours and even fonts.

          Load/Save !Preferences as Preset

          : Presets are a convenient way to st...


      • General

        MISSING_IMAGE:/path/to/gfx/prefs-general_tab.jpg

        The General !preference pane

        General preferences govern the application's basic behaviour, its integration with other programs, designating global folders such as the scratchpad and how appending or merging text with existing documents should be performed.


        • Startup


          • Reopen projects that were open on quit

            Whenever Scrivener is launched, projects that were left open when you last quit will be automatically reopened, bringing you straight back to what you were last working on.

            Hold down the Shift key while launching Scrivener to temporarily suppress this behaviour and open the software without any projects opened.

          • Show template chooser when there are no projects open

            Toggles the automatic display of [the start panel, for the creation of new projects][Creating a New Project], when all project windows have been closed, or if the software loads without any projects to open. You can always completely quit the application by using the File//Exit menu command, to avoid encountering this window unnecessarily.

          • Reopen Quick Reference panels when opening projects

            Ordinarily, [Quick Reference panels][Quick Reference] are session based---when their related project is closed they will not be reopened the next time you load the project. With this preference enabled, all projects will remember any Quick Reference panels left open and reopen them automatically when the project is loaded.

          • Automatically check for updates

            If this is enabled the software will periodically 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 enabled, you can still check for updates yourself by using the ScrivenerHelp//Check for Updates... menu command. The dropdown menu beside this option governs how frequently Scrivener will check for new versions.


        • Saving


          • Auto-save after *n* second(s) of inactivity

            Scrivener automatically saves changes made to projects as you work, but so that it is not constantly saving---and to avoid any slowdown and interruption to your work that might cause---it will wait to save until you stop interacting with the program for more than two seconds (by default). Adjust this if the two second default conflicts with your natural rest-work cycle and causes halting when you try to resume typing.

            If you increase the period significantly, be sure to use File//Save regularly...

          • Take snapshots of changed text documents on manual save

            This option will cause the project to [snapshot all text items][Using Snapshots], and only those, that have had their main text content altered during the session or since the last time you saved with the File//Save (<$custom:shortcut>) command. Auto-save will never trigger this behaviour, nor will closing the project.

            Snapshots that have been automatically generated in this way will have their name set to "Untitled (Save)" to differentiate them from any "Untitled" snapshots you take yourself m...

          • Show notifications when saving in !composition mode

            Register an alert through Notification Center whenever you manually save the project in !Composition mode, as there would otherwise be no indication of when save completes.


        • Author Information

          This information will be used for filling in placeholders in project templates (for example, some templates generate cover sheets for you) and compile placeholders such as \<$author>. Individual projects can also use specific pseudonyms or other details, set up in the [Metadata Options area of the compile overview screen][Metadata Tab].

        • Services

          Options for how Scrivener's global clipping Services should work. For more information on available services, read [Scrivener Services]. For the least amount of intervention, set both of these options to off.


          • Bring Scrivener to front when using Services

            Choose between active and passive clipping. When this is checked, clipping from other applications will be active in that it brings you back to your project after you've clipped some text from another application. When unchecked, it will work passively, keeping the project in the background and allowing you to continue work in other programs while you add material to the project.

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

          • Include screenshot when using Twitter service in Project Targets

            Includes a screenshot of the Project Targets panel along with your tweet. It should be noted that this screenshot will include the working title of your project. If you wish to obscure that information from the public, you should disable this option.


        • Language

          Interface Language

          : By default, Scrivener will attempt to select the appropriate interface language based upon your system settings. If this does not work, or you would like to use another interface language directly, you can use this setting to manually adjust the language. This setting has no impact on the production of information that is controlled by system localisation, such as date stamps and auto-number placeholders.

          : Use the "System Default" selection to return the interface to the m...

        • Scratchpad


          • Hot key

            Sets the global hot key for showing or hiding the [Scratchpad Panel]. Since this key will be accessible from any application on your Mac, you might need to change this setting if it is conflicting with another application you use.

            To clear the shortcut entirely, click the DelButton button.

          • Notes location

            Your scratch pad notes are stored on the disk using normal text files. This option lets you choose where those files will be automatically saved and loaded from. By default, they will be stored in your Documents folder.

            If you select a synchronised folder, such as Dropbox or iCloud OneDrive you can effectively create a universal scratchpad that every machine you use Scrivener with can access and share, or even jot down notes from a mobile device.

          • Default format

            This setting impacts which file format to use for new notes created from within the scratchpad. For the plain-text format, you can supply a custom file extension in the ext field. This can be useful for Markdown-based formats.

            Files saved into the folder from external sources will be editable in the scratchpad window and remain in their original format. You can thus mix rich text with plain-text notes if you desire.

            If you use Scrivener for both Windows and macOS, and intend to share your note...


        • Templates

          Shared templates folder

          : Click the Choose... button to define the location on your disk where Scrivener will check for files to be used as globally accessible document templates. For more information on the usage of this feature, refer to [Shared Templates on the Disk].

          Click the Clear button to reset the folder, removing this feature from the software. The Open shared templates folder... button will load the folder using FinderExplorer.

        • Citations

          Bibliography Manager

          : Scrivener can integrate with several popular bibliography management programs. Click the Choose... button to select your preferred manager from the Applications folderProgram Files. The Reset button will clear your choice.

          General purpose usage

          This merely links which application will launch with the Insert//Bibliography/Citations... menu command.. If you do not use a citation manager, but frequently use another program along with Scrivener, you could use this feature to ...

        • Separators

          Text Separators

          : This table lets you adjust how Scrivener will combine individual texts when certain actions bring them together. In all cases, you have three choices of divider available:

          1. *Single Return*: inserts a single paragraph break between selections. If two paragraphs appear together, there will be no whitespace between them, save for any paragraph spacing in use.

          2. *Empty Line*: a full empty space will be inserted between selections. If you prefer or require working with double-...

        • Automatic Quit

          Automatically quit after a period of inactivity

          : If the software has been left alone for a determined amount of time it will be shut down normally, meaning all open projects will be closed and backed up (by default). This can be of use if you tend to leave the program running unintentionally, and wish to access these projects from another machine using a cloud service. Ordinarily if you accidentally leave a project open it would be unsafe to open them a second time. This feature ensures that af...

        • Warnings

          Show internal error alerts

          : 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.


      • Editing

        MISSING_IMAGE:/path/to/gfx/prefs-editing_tab.jpg

        The Editing !preference pane

        The options for the main text editor control most aspects of how text is displayed, how the editors work, the default font and paragraph formatting for new documents, footnotes and other notes and finally the colours used in revision mode. For options pertaining to text input and typography, see the [Corrections !preference pane][prefs - corrections]. The [Appearance !preference pane will also contain numerous option...


        • Options

          Preference: Editing: Options


          • Default Text Zoom

            Dynamically scale the size of the text font in the editor. As is typical for word processors, zooming will not impact the underlying font settings. This setting impacts the main text editors, the inspector notes and bookmarks preview area, Quick Reference panels (and the inspector panels within it), footnotes & comments and copyholders. !Composition mode uses its own independent zoom setting, described in the [Appearance: !Composition Mode: Options pane][Use current composition settings for new ...

          • 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. You can also manually override individual paragraphs as well with the Format//Paragraph//Writing Direction submenu. Authors working in both Arabic and German, for example, will probably want to leave this setting at Natural and change individual paragraphs as needed.

          • Ruler Units

            Choose between the common units of measurement (centimetres, inches, picas, or points) used by the tab and indent ruler (available with the View//Text Editing//Show Ruler menu command, <$custom:shortcut>). This setting also impacts various utilities that use measurement, such as Format//Paragraph//Tabs and Indents....

          • Typewriter scroll line

            Typewriter scrolling mode keeps the line you are currently typing in fixed to a certain position on the screen. This setting lets you adjust the vertical point where the line will be positioned, with the default being in the middle of the screen.

          • Typewriter scrolling always jumps to scroll line

            By default, when typewriter scrolling is enabled and you start typing in another line, it will adapt to using the current line as the scroll point. With this option enabled typewriter scrolling will become strict, and always reposition the current line to a fixed point.

            Read more about [typewriter scrolling].

          • Smart copy/paste

            When enabled, this cleans up the whitespace left behind when cutting text, and when pasting text it will ensure that words have a space on either side as appropriate. Disable this feature if you prefer cutting and pasting to only use precisely what you selected.

          • Typing clears search highlights

            When the binder sidebar is displaying a search result, text views will highlight any text matching the search term. When this option is enabled, the highlights in the current editor will be temporarily removed as soon as you start typing. They will be restored when you revisit the document in the future.

          • Use hyphenation

            Enabling hyphenation when using full justification can increase readability 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 hyphen placement. If you are writing in another language and getting odd results, make sure your ...

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

          • Live counts show...

            Determines which units of measurement to display in the editor footer bars, which display statistics about your text as you write. The "Pages" option will only be displayed when View//Text Editing//Show Page View is enabled.

            If all checkboxes are disable then no live statistics will be shown. You will still be able to click in the middle of the footer bar area to bring up the extended statistics popover.

          • Do not color the text of inline notes (faster)

            Inline annotations will be drawn with a shaded background set to the colour of the annotation, rather than changing the colour of the text. If you use a lot of annotations in your text and find the text editing slows down, this option may increase performance.

            When this option is enabled the effective tools for [changing annotation colours] is be text highlights instead of text colour tools.

          • Terminate footnotes and comments before punctuation

            Some typesetting styles call for footnote markers to be placed before the terminating punctuation for a sentence, rather than after it, or for when individual words are referenced rather than the entire sentence. Select this option if you require this format. You can always manually define where the marker will be placed by selecting the range of text you wish to comment on, prior to making the note. This only alters the behaviour used when selection is made automatically in lieu of a selection.

          • Open comments in inspector if possible

            When this option is disabled, and the inspector sidebar is hidden, notes will open in a popover right over the text in the main editor. When enabled, the inspector will be revealed if necessary and switched to the Footnotes & Comments pane to show the content of the note you clicked on. Refer to [Popup Notes] for more information.

          • Disable insertion point blinking

            When enabled, the cursor will be always visible on the screen rather than blinking on and off.

          • Use block insertion point in...

            Set the width of the insertion point from its default of 1 pixel, increasing its visibility.

          • Block insertion point width

            Set the width of the cursor in pixels. With variable-width fonts (like the default), this setting can produce odd results where the cursor sometimes overlaps thin characters like punctuation marks. It is best used with a fixed-width font like Courier, or with a narrower setting like two or three pixels.


        • Formatting

          Preference: Editing: Formatting


          • Main text style for new documents

            MISSING_IMAGE:/path/to/gfx/prefs-default_text_formatting.jpg

            The Editing: Formatting !preference pane is where you establish default fonts for your writings.

            The top half of this pane (marked (a) in [](#prefs-default_text_formatting)) is dedicated to setting up the default font, character attributes and paragraph formatting 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 Aa button on the far...

          • Notes font

            Establishes the default font and font sized used by all newly created document notes. As with the main text editor, if you change this setting later on old notes will remain as they were formatted before.

          • Comments & Footnotes


            • Inspector comments font

              Sets the default font for inspector comments. Since these fields are rich text, this setting will only impact newly comments. This setting will also be used by inspector footnotes unless you modify the following setting. Inline annotations will always take on the styling of the text around them.

              To update existing comments and footnotes to the defaults established here, refer to [Resetting Linked Note Formatting].

            • Different inline footnotes font

              When enabled, the font and font size within newly created inline footnotes will use this setting.

            • Use inline footnotes font for inspector footnotes too

              To use this alternate font for newly created inspector footnotes as well, enable this option.


          • Set Styles Defaults...

            Click this button to have the software use the current project's stylesheet (you can review that with the Format//Styles//Show Styles Panel menu command). Alternatively, if you would prefer to return to the stock defaults that ship with the software, then click the Reset to Defaults button in the subsequent dialogue box. To take no action at this time, click the OK button in the dialogue.


        • Revisions

          The colour choices made here establish how revision mode will appear when typing in new text or using overstrike to schedule text for deletion. For each level, click the colour tile to the right to open the colour palette.

          Keep revision markings consistent

          It is important to consider that the revision feature solely uses text colour to establish the revision level of text. Once changed from previous colours, Scrivener will no longer associate existing coloured text as being a part of a revision...


      • Behaviors

        MISSING_IMAGE:/path/to/gfx/prefs-behaviours_tab.jpg

        The Behaviors !preference pane


        • !Composition Mode

          Preferences : Behaviors


          • Open composition mode on...

            If you have more than one monitor attached to the computer, the composition writing interface can be opened on a designated screen. The default "Current Screen" option refers to whichever screen the project window is located within. Scrivener supports configurations with up to four physical screens.

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

          • Open composition mode in its own Space

            Use macOS' native full screen feature to isolate composition mode on its own Space. The advantage of doing so is that Notifications can be displayed while you are writing, whereas the standard "presentation mode" suppresses even those notifications coming from Scrivener, letting you know when you have met your daily writing goals and so forth. The disadvantage is being unable to multitask, so using Dictionary to look up words will mean having to switch to a different Space.

          • Fade between modes

            Gracefully fades the screen between composition mode and regular editing mode.

          • Hide main window in composition mode

            Check this to hide the main window during 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 oth...

          • Escape key closes composition screen

            TODO//WINDOWS// make sure this replacement upon replacement upon replacement works with the Windows shortcut. When disabled, you will need to use either the View//Exit !Composition Mode command or its keyboard shortcut (<$custom:shortcut>) to toggle between modes.

          • Dock Hiding

            By default, !composition mode will force the Dock to be hidden even if you move the mouse over to the edge of the screen where it would appear. Since the Dock ordinarily appears along the bottom of the screen, it can get in the way of the control strip used to adjust composition settings. However if you place the Dock along the left or right edges of the screen, setting this to "Automatically hide and show Dock" will grant access to it. You will need to re-enter to composition mode for this chan...


        • Document Links

          This pane adjusts how internal document links and linked images function within the software. You can change what happens when you click a link, and whether or not circular links are created for you automatically, using the bookmarks feature. Read more about [Linking Documents Together].


          • Document links and bookmarks create back-link bookmarks

            When you create document links or bookmarks to other items in the binder, Scrivener will automatically place a "back-link" to the originating document in [the Bookmarks inspector tab for the target][Bookmarks Tab]. For example, if you link *from* "Scene 81" to a character sheet named "Maria", then "Scene 81" will be bookmarked from the "Maria" document. In this way, every cross-reference you create will become a circular link. If you would prefer to maintain all of your bookmark lists by hand, d...

          • Image links create back-link bookmarks

            In the same fashion as the above, [inserting a linked binder image into a text editor][Images Linked to Binder Items] within the same project will establish a bookmark from the image to the document that uses the image.

          • The following three settings impact how links and bookmarks load their targets within (or even outside of) the project window. The default settings strive to preserve the content that is loaded into the text editor the link was activated from (including from the inspector), by either using split views or Quick Reference panels. The three different link actions all feature the same three core options to choose from:

            • *Quick Reference Panel*: the clicked link will open in a new window, thus pre...

          • Open clicked document links in...

            When clicking a hyperlink in the main editors and document notes in the inspector, the linked item will be loaded as established with this setting. This setting applies to all of the areas within a project window that can store clickable hyperlinks in the text.

          • Open new document links in...

            Determines what will happen after a new document is created as a result of inserting a hyperlink via the Edit//Link to Document//New Link... menu command (<$custom:shortcut>) or the optional [wiki link style]. This behaviour does not impact the creation of hyperlinks to *existing* binder items. It also has a special setting beyond the core three, "(Do not open)", which causes links to new documents to behave just like links created to existing documents: you will be able to continue writing in...

          • Open Inspector bookmarks in...

            When pressing the !Return key on a selected bookmark in the inspector, or double-clicking it, it will be loaded in accordance with your setting here. Note this only refers to the bookmarks themselves in the upper half of the [bookmarks tab]. The editable preview area in the lower half will use your main setting for how clicked document links should work, above.


        • Double-Clicking


          • Double-clicking on the corkboard background

            A couple of useful actions can be assigned to the background of the corkboard itself, when double-clicking on it:

            * *Opens the parent corkboard*: navigates the editor "upward" in the outline hierarchy to 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. This action can also be performed with the Navigate//Go To//Enclosing Group (<$custom:shortcut>) menu command.

            * *Creates a new ca...

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


        • Dragging & Dropping


          • OptionAlt-dragging creates duplicates

            : When enabled, hold down the OptionAlt key while dragging items to create copies of those items in the location where you drop them, rather than moving the items. This preference impacts any case where you can drag and drop an item icon, or a selection of items, into the binder sidebar, corkboard or outliner---thus it even applies to dragging from bookmark lists, the editor header bar, QuickReference panels and so forth.

          • Collapse auto-expanded outline items after drag and drop

            When dragging items into the binder or outliner, and pausing over a collapsed container, Scrivener will helpfully reveal its contents so you can drop items several layers deeper than you could initially see when you started dragging. This option will close all automatically-opened containers after you have dropped the items---restoring the outline to its original state. It impacts both the binder and the outliner views.

          • Allow drop ons in corkboard

            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.

          • Link to images dragged from binder into editor

            When dragging an image from the binder into a text editor, instead of fully embedding that image into the editor the software will link to that image instead. If the image is updated in the future, the updates will automatically appear in the editor after a reload of the project. This is synonymous with [the Insert//Image Linked to Document// submenu][Images Linked to Binder Items].

          • Delete text dragged to other areas

            By default, when dragging text *from* any of the following editor contexts, the dragged text will be *moved* to the drop point in the same way text would be moved when dragging it from one position to another within a single editor. With this option disabled, text will be copied to the drop location instead, leaving the original text untouched. This option has no affect on the behaviour of dragging text within a single editor, but it will adjust the behaviour used when dropping text into the bin...


        • Folders & Files

          Concerns the treatment of file and folder items in Scrivener, particularly in how their behaviour in the project interface differs, including options for negating these differences.


          • Treat all documents with subdocuments as folders

            When this is checked, any document type at all that has subdocuments will act like a folder in all ways. If this isn't checked, normal text documents or media files that have subdocuments (any type of document can act as a "container" for other documents in Scrivener) will be opened in single text mode.

            This setting has broad implications throughout the interface. For example the following options that refer to modifying how folders work will now also apply to file groups. It is a safe assumpti...

          • Include enclosing folder text in scrivenings mode

            When clicking on a container, 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 then disabling this will remove the empty entry at the top of the Scrivenings session.

          • Show folder text when selected from search results

            Enabled by default: when clicking on folders in search results, the editor will display text content for that folder, rather than revealing their children in accordance with the preferred view mode. 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 might likely be in any text stored in the folder, which a corkboard or outliner might obscure.

            If desired, you can always switch bac...

          • Always create new items as siblings

            This option overrides the default behaviour by causing all newly created items to be created at the same level as the selection. The only exception is when one of the three special root folders are selected. By default, if you select a folder and create a new text or media document, it will be placed inside that folder as a child item.

            Refer to [Figuring Out Where Things Will Go] for more detail on how Scrivener places new items.


        • Navigation


          • When focused editor is locked in place...

            By default, if you have the editors spits and lock one of them, the behaviour of Scrivener will change. Ordinarily the binder sidebar will only ever impact the targeted split, but when the target split is locked the binder will load clicks into the *other* split.

            Change this setting to Binder selection does nothing if you would prefer split targeting to remain literal and simply do nothing when the targeted split is locked.

          • Automatically load web pages in bookmarks preview

            Bookmarks to web sites or other online resources will require you to click a button to load them within the inspector pane. This way as you switch through documents in your draft or browse through the bookmark list, you will not automatically be downloading websites. If you would prefer otherwise, enable this option.

          • Allow limited navigation in web pages

            Hyperlinks found within archived Web files and hyperlinks that are being viewed in the Bookmarks preview pane will attempt to navigate within the same view, rather than sending the clicked on URL to your default browser.

            Scrivener is not a dedicated browser, and any will not have the same level of protection and security that a browser does. As with the above option, take care when using any feature that downloads data raw from the Internet.

            Use the Option key to temporarily override this sett...

          • Space key opens selected document in...

            The Spacebar can be used to quickly open selected items in the corkboard and outliner views. By default this opens the item in the editor, replacing the current view (synonymous with the <$custom:shortcut> shortcut). If you would prefer it to match the binder behaviour, change this to "Quick Reference Panel".


        • Playback


          • Rewind when paused by...

            Use the slider to set how many seconds Scrivener should rewind the media stream back, when using the [Auto-Rewind][Viewing Multimedia Documents] feature.

          • Media time stamp format

            Establishes the time stamp format used by the Insert//Media Time Stamp menu command. If you are writing subtitles for example, you might wish to use `HH:mm:ss.SSS`.

            : If you are looking for other tokens to use than the few basic ones we have provided in the help text, click the "?" button to the right of the Custom format field. This will open a web page containing the complete list of tokens that are recognised by the software. The page itself is very long and technical, the only pertinent sec...


        • !Return Key

          Scrivener's binder, outliner and corkboard views treat the !Return key in a fashion more like a dedicated outliner or mind-mapping tool might do. If you find this gets in the way of how you work, these options can tune how it works.


          • Ends editing synopsis in corkboard and outliner

            By default, the !Return key will commit edits made to the synopsis in the corkboard and outliner. To add carriage returns to the synopsis, use Opt-!Return. If this is unchecked, the !Return key will add carriage returns, and you will need to use Esc to submit changes.

          • Creates new item in list, outline and corkboard views

            Pressing the !Return key (when not editing the title or synopsis) will create a new item in the outliner, binder, corkboard as well as in certain list views (such as the keywords list). Disable this if you would prefer the creation of new items to require specific commands or the clicking of buttons.


        • Snapshots


          • Play shutter sound when snapshots are taken

            Disable this setting to remove the audible camera shutter cue that is played when you take a snapshot. This sound will not be played when automated snapshots are taken (such as when using folder sync).

          • Show notification when snapshots are taken

            Enable this option to display and record a visual record of when snapshots have been taken and to which items. This will even record automated snapshots. Given how notifications may also play a sound of their own, you may want to disable the above option as well.


      • Appearance

        Main appearance preference pane lead-in.


        • General Interface

          These options affect the overall project window reacts to a few different appearance settings.


          • Options


            • Adjust window size to accommodate binder and inspector

              This setting causes the inspector and binder sidebars to be added or subtracted from the sides of the project window, leaving the middle part untouched. When disabled, the overall window width will remain the same, causing internal elements of the project window to expand or contract to make space for the sidebars. The latter behaviour can be better when the project window fills the screen.

              In [](#prefs-appearance-window_width) we can see the two different settings in action. In the middle we a...

            • (window width adjustment examples)

              MISSING_IMAGE:/path/to/gfx/prefs-appearance-window_width.jpg

              Example of difference between adjusting the window size for sidebars or not.

            • Always resize editors proportionally when resizing window

              The ratio or proportion of space given to each split will be preserved when changing the size of the window or when changing the width of the inspector or binder. If you prefer the more standard behaviour where the split position remains fixed and the bottom or right elements within the window expand, then disable this option. The bottom frame marked (b) in [](#prefs-appearance-window_width) demonstrates the behaviour as disabled. Note how the index cards and corkboard remain the same size, but ...

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

            • Draw border around current line highlights

              When the currently edited line is highlighted (as set in the Appearance: Main Editor, Quick Reference and Composition Mode !preference panes, with the Highlight current line setting), you can opt between a line-width highlight with a subtle border, or a full "page"-width highlight, as show in [](#editor-line_highlight_border).

            • (current line highlight border)

              MISSING_IMAGE:/path/to/gfx/editor-line_highlight_border.jpg

              The currently edited line can be highlighted with a border or as a simple full-width highlight.

            • Opacity of label colors when used in backgrounds

              This setting impacts most cases where the label colour is optionally used as a background colour (for example, with View//Use Label Color In//Index Cards). 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. The default setting is tuned for Scrivener pale label colour defaults. If you prefer stronger label colours you may want to reduce the opacity.


        • Binder

          The options in this section impact the display of the binder sidebar in general, including search results and collections.


          • Options


            • Show current editor document indicator

              If the document you are viewing in the currently active editor is visible within the binder, then a secondary highlight will be placed on the item (separate from the larger highlight that indicates your last selection), making it easy to spot where you are in the overall outline. If find this behaviour distracting, disable it here to only see a highlight on the last thing you selected yourself.

              Refer to [Finding Where You Are in the Outline] for more information on this concept.

            • Base selection color on background color

              The colour for both the selection and current document indicator is ordinarily derived from whatever colour the binder sidebar is currently using. So a collection that is bright yellow will use a darker yellow highlight, but if you switch back to the binder with its default pale lavender, the selection will be a darker version of that.

              Disable this option to use your computer's default selection highlight settings.

            • Row spacing

              Fine-tune the amount of vertical spacing between lines of text in the binder. This can be useful when using a custom font that uses more or less leading than default.


          • Fonts


            • Binder font

              The font and text size used to display the binder hierarchy as well as various collection lists and search results. If you wish, you can fine tune the amount of spacing between rows as well, with the Row Spacing setting in the "Options" tab.

            • Use bold font for...

              If the font you have chosen is capable of displaying boldface characters, the two provided checkboxes will have containers printed in bold, making it easier to spot them in long lists as you scroll through. These settings only impact the main binder view. In collection lists, where hierarchy is not displayed, all items are considered equal.


          • Colors

            Collections can be independently coloured according to taste, but for the sake of familiarity and consistency, the binder and search result lists will display in a unified colour across every project you use. You can adjust the colours used by these two special tabs in this section.


        • !Composition Mode

          Preferences : Appearance


          • Options


            • Highlight current line

              Editing options for Composition Mode.

            • Scroller type

              Customise how the scroll bar looks and behaves in composition mode.

              * *Regular scroller*: the standard operating system default scroller will be used and will follow macOS system preferences for whether it will always be visible or only appear when used.

              * *Full screen scroller*: this scrollbar remains visible on the screen at all times, providing a good alternative to those that like knowing where they are in the editing session without scrolling.

              * *Auto-hiding scroller*: remains hidden un...

            • Editor 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. If you are looking for a way to add a little vertical padding that is always present, refer to the "Paper Height" setting in !composition mode's [Control Strip][The Control Strip].

            • Use current composition settings for new projects

              You can dynamically adjust most of the spatial options, such as with width of the typing column or the opacity of the background, while in composition mode itself. Refer to using [The Control Strip] for more information on these various settings. If you achieve a look you would like to see in all new project, click this button to save the current project's composition view settings into your defaults. The following options will be saved:

              • *Default text zoom*: the dynamic amount of scaling use...


          • Colors

            Most aspects of what you can see in the !composition view can be adjusted to taste, including even the colour of text, as an override to its natural text colour. Scrivener's defaults use a "night mode" dark blue theme meant to evoke some of the earliest monochrome black and white monitors. Settings are also available for altering some aspects of the [floating inspector panel], used exclusively in !Composition mode to provide access to all inspector tabs but snapshots.

            Refer to [][Composition Mo...


            • Composition Mode Colour Settings

              Interface Element

              Description

              Editor

              The background colour of the "paper" area behind the text column. An image texture can be chosen, overriding any colour choice made.

              Text

              Enable the Override text color with color checkbox to activate the colour swatch. Disabling this feature will cause the natural text colour to be used, just as it would appear in the main text editor. This option also extends to highlights, revision markings, annotations, hyperlinks.

              Scrivenings Titles Text

              Adjusts the tex...


        • Corkboard

          Provides options and settings impacting the corkboard views (including freeform and label view). Since index cards appear in a few other contexts as well (such as the inspector), the settings governing their appearance specifically will be located in the [Appearance: Index Cards][appearance - index cards] pane.


          • Options


            • Allow two lines in title areas

              If you tend toward longer titles for your items, the single-line presentation in index cards can get a little claustrophobic. This option allows for an additional line of word-wrapping before truncation occurs.

            • Automatically shrink titles to fit

              Enable this option to cause the index card title text to shrink to a smaller font size if the title does not fit on one line. This option can be combined with the above.

            • Minimum font size

              Sets a limiter on how small a font the above option should use.

            • Arrange cards from right to left

              If you are accustomed to working in right-to-left languages, this will make the corkboard more intuitive.

            • Display images as photographs

              Video, image files and documents using an synopsis image are displayed by default as "Polaroid" thumbnails on the corkboard. Disabling this option will always show the standard synopsis text on the corkboard. This can improve performances on larger corkboards with many graphics.

            • Freeform grid size

              Determines the grid resolution used by the View//Corkboard Options//Snap to Grid option. The opacity of the grid can be adjusted below.

            • Draw shadows around cards

              Toggles whether or not index cards use a 3D effect on the corkboard. Disable this to achieve a more modern flat look.

            • Status stamp opacity

              Adjust the opacity of status stamps on the index cards within the corkboard. The stamp, unlike a real one, is drawn beneath the synopsis text, so even at full opacity it will not obscure what you've written.

            • Freeform grid opacity

              Adjust the opacity of the displayed grid, when View//Corkboard Options//Snap to Grid is enabled. Drag the slider all the way to the left to disable grid display (it will still function as normal).


          • Fonts


            • Photograph titles

              For those items displaying themselves as an image thumbnail on the corkboard, you can use a different font from the standard index card title. To change the title font for normal index cards, refer to the [Appearance: Index Cards: Fonts tab][appearance - index cards - font].

            • Status stamps

              The status text can optionally be printed on the face of the card, with the View//Corkboard Options//Show Status Stamps menu option. Set the font used for that "stamp", here. The font size will be ignored, as Scrivener automatically resizes the stamp to fit within the index card.


          • Colors


            • Corkboard, freeform and label view backgrounds

              Each of the three different corkboard modes can have different background colours, images or use the traditional corkboard texture:

              • If "Color" is chosen then the swatch to the left of that row will be what is used in the background for that particular mode.

              • The "Corkboard Texture" option revives the classic Scrivener corkboard look, if you are so inclined. If you have your own image you'd like to use in the background.

              • Select the "Custom Background..." option and select an image from t...

            • Status Stamps

              Alter the colour used to print the "stamp" in diagonal fashion across index cards.


        • Full Screen

          Appearance Preferences section


          • Options


            • Hide binder and inspector when entering full screen mode

              The binder and inspector, if visible upon entering full screen mode, will be hidden, drawing full attention to the content in the editors. Upon return to normal windowing mode, the original state of the sidebars will be restored if necessary. One can always call upon these sidebars in full screen if they wish, using the ordinary commands for doing so.

            • Slide in binder and inspector when hidden

              When these sidebars are hidden in full screen, moving the mouse to the left or right edges of the screen will cause them to appear temporarily as a slide-out panel. Read more about this behaviour in [Full Screen Mode]. When disabled, the only way to use these sidebars will be reveal them with the ordinary commands for doing so.

            • Always auto-hide toolbar in full screen mode

              You can opt to always hide the toolbar strip at the top of the project window when placing it on a full screen space. When hidden, the toolbar will be revealed along with the main menu by moving the mouse to the top of the display. The default behaviour is to display the toolbar at all times.

            • Attach format bar to toolbar in full screen mode

              The format bar can be included in the main toolbar, when moving the mouse to the top of the screen. It can otherwise be toggled on or off in a static fashion when this option is disabled.


        • Index Cards

          The appearance of index cards themselves are adjusted in this section. Since they can also appear in the inspector these settings are separate from the corkboard itself.


          • Options


            • Index card theme

              Select from a variety of index card looks. This setting will also impact the index card in the inspector (though it will always have square corners). The five variations are demonstrated in [](#prefs-index_card_themes).

            • (Index card themes)

              MISSING_IMAGE:/path/to/gfx/prefs-index_card_themes.jpg

              The five index card appearance themes.

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


          • Fonts


            • Index cards title

              Set the font and text size used in the title area of index cards.

            • Index cards text

              Set the font and text size used in the synopsis area of index cards.


          • Colors

            There are two adjustments that can be made to the colours used by index cards:

            • *Index Card Background*: impacts the "paper" colour, if you will, of index cards in all contexts. This can be overridden by the label colour, when View//Use Label Color In//Index Cards has been enabled in the project on a per card basis, and by !composition mode colour settings in its floating inspector.

            • *Status Stamps*: the colour used for the status text, stamped diagonally across the index card when View//Co...


        • Inspector & Notes

          These settings impact the appearance of the inspector sidebar, inspector split in Quick Reference panels and the floating inspector panel in !composition mode.


          • Options


            • Draw notepad lines in document notes

              Turns on notepad-style ruling for document notes, giving it the appearance of a pad of paper. The rules will adjust their height depending upon the height of the lines of text or images within them.


          • Colors

            The following areas of the inspector and Quick Reference splits can have their colours customised. To modify the appearance of the !composition mode floating inspector, use the [Appearance: Composition Mode: Color !preference tab][appearance - composition - colors].

            • *Notes Text*: the text colour for new notes will be set to your choice here. This changes the text colour itself, so existing notes will go on using their original formatting.

            • *Notes Background*: the background colour of the n...


        • Main Editor

          Provides controls for the basic default look of the text, background "paper", margins and whether or not the text column should have a fixed width or expand to fit the size of the window.


          • There are three additional Appearance tabs involved in the matter of text editing:

            2. [Appearance: Page View][appearance - page view]: <$include>

            3. [Appearance: Scrivenings][appearance - scrivenings]: <$include>

            4. [Appearance: Textual Marks][appearance - textual marks]: <$include>

          • Options

            MISSING_IMAGE:/path/to/gfx/prefs-appearance-main_editor.jpg

            The areas of the editor that can have their spacing adjusted.

            Scrivener's default settings use a simple white background for all of the zones you can adjust in Main Editor preference pane. For the sake of illustration, we've adjusted two of the !preferences in the respective "Colors" tab, and the text itself in [](#prefs-appearance-main_editor) has had a white highlight applied to it, to distinguish between the very edges of the text f...


            • Highlight current line

              <$include>

            • Default editor width

              This setting affects two different behaviours. When using the Window//Zoom command, the overall project window size will be adjusted so that the editor areas match this width. The value is also used to set how wide the text column itself is within the editor, when the viewer is wider than that.

              Click the Use Current button to capture the width of the active editor in the foremost project window. Setting this to "0" (zero) will cause the project window to always maximise to fill the screen. If y...

            • Use fixed width editor

              By default Scrivener will restrict the width of the text editing column no matter how wide you make the editor itself. The padding area to the left and right can have its colour modified with the Fixed width background setting in the respective "Colors" tab. If this option is disabled then text will start at the leftmost edge of the viewer and continue all the way to the rightmost edge before wrapping.

            • Center the editor when using a fixed width

              Keep the writing column centred to the middle of the editor view, when it is wider than the preferred width (set above). When this option is disabled, text will have a more traditional look, flush along the left edge of the view.

            • Editor Margins

              Sets a visual margin or padding area between the text and the edges of the text editing column (or the view itself if the Use fixed width editor option is disabled). You can select a different distance for horizontal and vertical margins. The top and bottom margin will only pad 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.


          • Fonts


            • Header bar

              The font used to print the name of the item you are currently viewing in the editor. Given how different fonts are drawn into the interface, you may need to play with sizes and different font variants before finding a combination that sits evenly with the icon.


          • Colors

            The editor backgrounds and the comment and footnote inspector can be changed in this section:

            • *Editor*: Main editing background, or "paper colour". An image texture can be chosen, overriding any colour choice made.

            • *Fixed Width Background*: Colour displayed around the pseudo-page in fixed width mode. An image texture can be chosen, overriding any colour choice made.

            • *Media Background*: Colour displayed around images and PDFs when displayed in the main editor.

            • *Comments Area*: Adjus...


        • Outliner

          Many of the settings that impact the type of content shown in the outliner are project-specific, and set up with the View//Outliner Options// submenu. The options here alter how the outliner looks in all projects.


          • Options


            • Outliner has horizontal grid lines

              Draws rules between rows in the outliner.

            • Only when using fixed row heights

              The prior setting will only be applied to the outline view when the View//Outliner Options//Use Fixed Row Height menu toggle is enabled. This particular look will match common iOS design-inspired lists, where all cells have a uniform height and are separated by a rule. For more information, refer to [Using a Fixed Row Height].

            • Outliner has vertical grid lines

              Draws rules between columns in the outliner.

            • Outliner 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. The shade used for alternating rows will be derived from the Background colour setting, made in the respective "Colors" tab.

            • Alternating row colours and labels

              If the project you are working with has the View//Use Label Color In//Outliner Rows menu toggle enabled, then alternating rows will not be visible in that project.

            • Always indent title column if available

              If a title column is present in the outliner then it will always have indents and disclosure arrows drawn in that column, even if other columns precede it in the list. The default behaviour is off, which will follow a more traditional approach of indenting the beginning of the row, no matter what kind of content may be found there. With some column layouts, it may be easier to see the outline [if the initial columns are flush](#prefs-appearance-outliner_title_column).

            • (always indent title column example)

              MISSING_IMAGE:/path/to/gfx/prefs-appearance-outliner_title_column.jpg

              Forcing the title column to indent can bring clarity in some layouts.

            • Total columns only count documents included in Compile

              The various "Total" statistic columns, such as View//Outliner Options//Total Word Count can be set to ignore the counts for any subdocuments that have had their Include in Compile checkbox disabled, in the Inspector metadata pane.

            • Row spacing

              Adjust the amount of vertical padding between rows with these settings. You can optionally choose to use a different amount of padding, depending upon whether or not the synopsis text is shown below each title.


          • Fonts

            There are three areas where fonts can be set within the outliner. The Titles and Synopses settings configure the font and size used for these two elements of the outline. The Other selection sets the font for text in any other columns, such as dates, labels, custom meta-data and so forth.

            By default, the Other font will be used for titles as well when synopses are hidden, giving the outliner a more uniform feel.


            • Use bold font for...

              These options will cause the software to dynamically select a bold version of the font selected above, when the following conditions are met. The checkboxes will be disabled if you have chosen a font that lacks a bold variant.

            • When synopses are hidden

              If the synopsis field has been hidden via the View//Outliner Options//and Synopsis menu toggle, then titles will use the Other font as stipulated above, providing a more uniform look to the outliner. The default settings allow for greater visual emphasis on titles when synopsis text is embedded around them.

            • When synopses are shown

              By default, if an item has only a title supplied to it, and titles are otherwise set up to displayed bold text, they will instead use regular text. Disable this if you would prefer titles to use a more consistent format. This option is overridden by the Use bold font for... selections above.


          • Colors

            The following areas of the outliner can be coloured to taste:

            • *Background*: the area behind the text and other content in the outliner.

            • *Grid*: determines the shade used to draw grid rules between rows and/or columns. These rules are disabled by default, and should be first enabled with at least one of the Outliner has horizontal|vertical grid lines options.

            • *Group Titles*: folders (and optionally all containers, when the Treat all documents with subdocuments as folders option is ena...


        • Page View

          Contains visual settings for the optional page view (View//Text Editing//Show Page View menu toggle), such as paper size, and whether to use this mode in new projects.


          • There are three additional Appearance tabs involved in the matter of text editing:

            1. [Appearance: Main Editor][appearance - main editor]: <$include>

            3. [Appearance: Scrivenings][appearance - scrivenings]: <$include>

            4. [Appearance: Textual Marks][appearance - textual marks]: <$include>

          • Options


            • Show page view in new projects

              When enabled, new projects you create will have the View//Text Editing//Show Page View menu toggle enabled.

            • Use facing pages in new projects

              Activates the two-page spread as the default for new projects. To enable this behaviour for existing projects, use the View//Text Editing//Two Pages Across menu toggle.

            • Center pages

              The page will be centred within the view. Disable this option to pin the paper edge to the left side of the editor.

            • Show margin guides

              Causes a border to be drawn 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. With Draw shadow around pages enabled, using a value of "1" will place a thin border between pages, and "0" will seamlessly flow from one page to the next.

            • Base page view size on...

              The shape of the page and margin areas are set using either your project's print settings (in File//Page Setup...), or the current compile settings for the project. In many cases compile settings will refer right back to the print settings meaning there will be no visual difference between settings.


          • Colors

            The Background colour is used to drawn the padding area around the pages themselves. To adjust the page colour itself, use the Editor setting in the Appearance: Main Editor: Colors tab.


        • Quick Reference

          Quick Reference panels are stand-alone windows that feature a simple text editor or media viewer and a built-in simplified inspector viewer. There are a subset of options available to them, from both of these elements, that override settings made in their respective !preference panes.


          • Options

            Quick Reference panels will inherit basic settings from the Appearance: Main Editor pane, as well as the Appearance: Page View pane. For example, if Use fixed width editor is disabled in the Main Editor options tab, then new Quick Ref panels will wrap to the width of the window. If Show page view in new projects is enabled in the Page View options tab, new Quick Ref panels will come up in page view (even for projects that have already been created).

            Quick Reference settings are persistent throu...


            • Highlight current line

              <$include>

            • Text editor margins

              <$include>


          • Colors

            As with options, there are a few colour choices here that override inspector and editor settings:

            • *Page Background*: used when View//Text Editing//Show Page View is enabled within a Quick Reference pane, and refers to the padding around around the edge of the virtual paper.

            • *Notes Background*: the background colour of the notes pane in the inspector.

            • The remainder of the settings are identical to those documented in [the Appearance: Main Editor: Colors tab][appearance - main editor - c...


        • Scratchpad


          • Colors

            The Scratchpad Notes Background setting adjusts the background colour for the text editor in this Window//Show Scratch Pad utility.


        • Scrivenings

          Adjust the separators drawn between files as well as the font and appearance of section titles within a Scrivenings session.


          • There are three additional Appearance tabs involved in the matter of text editing:

            1. [Appearance: Main Editor][appearance - main editor]: <$include>

            2. [Appearance: Page View][appearance - page view]: <$include>

            4. [Appearance: Textual Marks][appearance - textual marks]: <$include>

          • Options


            • Scrivenings Separator

              Within a Scrivenings session, individual binder items will be separated using [one of the global presets you select here](#prefs-appearance-scrivenings_separators), depending on the type of documents in use within the session---scriptwriting or normal prose documents. When both kinds of documents are present in the same session, the kind representing the bulk of the documents will determine the divider style used.

              The "Divider" and "Dashed Line" settings provide a greater degree of visual disti...

            • (scrivenings separator styles)

              MISSING_IMAGE:/path/to/gfx/prefs-appearance-scrivenings_separators.jpg

              Corner, Dashed Line and Divider separator styles for Scrivenings mode.

              The "Bookish" format is unlike the others in that it changes how it appears when titles are included within the Scrivenings session. In [](#prefs-appearance-scrivenings_bookish), we see an example with the View//Text Editing//Only Show Scrivenings Titles for Folders menu toggle enabled. In this case the visible title that we can see at the top of the figu...

            • Use page break separators in page layout view...

              If you tend to use longer text sections that represent logical chunks of structure in the final work (such as a chapter or subsection), you might prefer the editor cut to a new virtual page, when using the View//Text Editing//Show Page View editing mode. Select whether this should be done Before folders and/or Before text documents. If a page break is inserted on account of this feature, no additional divider will be used.

            • Scrivenings Titles

              The settings in the remainder of this panel become relevant when the View//Text Editing//Show Titles in Scrivenings menu toggle is enabled for a project. The font itself, as well as the text size, can be set in the respective Fonts tab. You can opt here to keep titles centre-aligned as well as underlined, should you wish to draw further visual distinction between the main text and titles inserted by this feature.

            • Use title background color

              When checked, a filled box will be drawn around the title, accentuating it from regular text in the editor. The colour can be changed in the respective Colors tab.

              When View//Use Label Color In//Scrivenings Titles is set, this feature will automatically enable itself for those items in your session that have a title *and* a label applied to them, with the label colour being used for the background fill. Items with a title but no label [will use the stock flat editor look](#prefs-appearance-scri...

            • Do not show separators above titles

              Enabled by default, when the View//Text Editing//Show Titles in Scrivenings menu toggle is enabled, those items with assigned titles (not adaptive titles) will omit the divider to present a cleaner overall look. Disable this if you find the result visually confusing or use a title style that is very close in appearance to the main text.

            • (scrivenings title backgrounds)

              MISSING_IMAGE:/path/to/gfx/prefs-appearance-scrivenings_title_backgrounds.jpg

              Label colours are being used in Scrivenings titles with title backgrounds otherwise disabled.


          • Fonts

            The Scrivening titles setting determines which font and font size will be used for drawing titles in the editor, when View//Text Editing//Show Titles in Scrivenings is enabled.


            • Reduce font size per level by...

              This setting will reduce the font size by the given amount (in points) for each level of nested hierarchy in the session. This reduction is performed in an absolute sense rather than relative. If you select a number of titled subdocuments at level four, they will use the full reduction in font size even though no larger font sizes are in use.

            • Minimum font size

              Use this setting to keep the font size from becoming illegibly small when working in very deeply nested areas of the outline. This means that at some levels there will no longer be a reduction in font size.


          • Colors

            The two colour options here configure the appearance of titles when inserted into the Scrivenings session:

            • *Scrivening Titles Text*: the text colour itself can be adjusted. This has no bearing on output.

            • *Scrivening Titles Background*: when Use title background color is switched on in the respective Options pane, this sets the default background highlight.


        • Snapshots


          • Colors

            The Text Background colour is used to adjust the overall display of snapshots. This adjusts their appearance in the Snapshots Manager, inspector pane, main editors and copyholders.

            MISSING_IMAGE:/path/to/gfx/prefs-snapshot_colours.jpg

            Example snapshot comparison view with customised colours.

            The settings for Deleted Text & New Text adjust how revisions are marked up when using comparison mode.


        • Target Progress Bars

          Progress bars are used in a few places: the Project//Show Project Targets... floating panel, the Quick Search utility in the main application toolbar and in View//Outliner Options//Progress and //Total Progress.


          • Options


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

            • Show progress bars in "Targets and Search" toolbar item

              By default, the Draft Target and Session Target will be displayed in the main application toolbar, [integrated into the Quick Search utility](#prefs-targets-quick_search). Disable this option if you would prefer a cleaner look. You can hover the mouse over this tool to bring up a numerical display of your progress.

            • (quick search targets)

              MISSING_IMAGE:/path/to/gfx/prefs-targets-quick_search.jpg

              The Quick Search tool is capable of displaying project goals as minimal progress bars.

            • Use custom colors in toolbar progress bars

              Instead of using the default blue, designed to match Apple's default bright blue interface accents, have the Quick Search tool use your preferences in the respective Colors tab.


          • Colors

            These settings impact the appearance of progress bars in the outliner and Project Targets panel. They can also optionally be used in the Quick Search tool, when Use custom colors in toolbar progress bars is enabled in the respective Options tab.

            Progress bars blend between three different colours. The Start Color is used when the word count is at its lowest. As you write toward your goal, the bar will gradually blend up to the Midway Color, finally moving toward the End Color as the word count ...


        • Textual Marks

          Settings for how the text will be marked up, including invisible characters, hyperlink appearance, the cursor and so on.


          • There are three additional Appearance tabs involved in the matter of text editing:

            1. [Appearance: Main Editor][appearance - main editor]: <$include>

            2. [Appearance: Page View][appearance - page view]: <$include>

            3. [Appearance: Scrivenings][appearance - scrivenings]: <$include>

          • Options


            • Show invisible characters when selecting text

              By default, when select text in the main editor views and Quick Reference panels, invisible whitespace characters will be automatically highlighted for you. This will include carriage returns, line breaks, page breaks and tabs---not spaces or non-breaking spaces.

            • Underline links

              When disabled, document links, hyperlinks, and notation links will not be underlined in the editor.

            • "Hide Markup" hides...

              The View//Text Editing//Hide Markup menu toggle is useful for presenting a cleaner version of your text, sans editing markings and digital markings. Disable any of the provided options if you would prefer to have that type of marking visible in all cases.


          • Colors

            A few types of textual markings can have their colours adjusted. Some of these settings can be further overridden by !composition mode settings.

            • *Insertion Point*: the cursor, caret or insertion point can be adjusted to adjust its visibility. Also note you can disable blinking and set its thickness in the [Editing: Options !preference pane][editor - options].

            • *Invisible Characters*: displayed when the View//Text Editing//Show Invisibles menu toggle is enabled. They are also by default dis...


      • Corrections

        MISSING_IMAGE:/path/to/gfx/prefs-corrections_tab.jpg

        The Corrections !preference pane

        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. For more information on corrections and auto-completion, read [Auto-Completion].

        Looking for the setting that changes whether or not spelling and ...


        • Auto-Correction


          • Correct spelling errors as you type

            Menu

          • Fix capitalization of sentences

            Will fix letter case issues if a lowercase letter follows a period and a space. You may need to temporarily switch this off to correctly key in some phrases, such as "10 a.m. to 12 p.m.". In that case the period after the "a.m." would cause the word "to" to be capitalised incorrectly. Disable the option to key in the phrase, and then enable it again.

          • Capitalize 'i'

            Will automatically capitalise the letter 'i', if typed by itself.

          • Superscript ordinals (1st, 2nd, etc)

            When numbers are typed with a following ordinal, the ordinal will be superscripted and set to a smaller font.

          • Symbol and text substitution

            Enabled the native macOS text substitution engine. To configure your abbreviations and expanded text, click the System Text Preferences... button at the bottom of this preference pane.


        • Punctuation

          Enables commonly used symbols and typographic conventions, by detecting when their use is appropriate as you type. Not all text entry areas are capable of using substitutions, but they will always be available in the main text editors. Scrivener itself does not generate typographic punctuation. To adjust how smart quotes are generated, click the System Text Preferences... button at the bottom of this preference pane.


          • Use smart quotes (“ ”) in new projects

            Will convert inch and foot characters into typographic quotes (also referred to as "curly" quotes) as you type, according to your system's keyboard settings. To customise these, click the `System Text Preferences...` button that is provided at the bottom of the window.

          • Use smart dashes and ellipses in new projects

            This uses the Mac option to toggle this behaviour, which also includes ellipses on 10.8 systems and above. Subsequently, the following option, **Replace Triple periods with ellipses**, is only of use to those using older versions of macOS.

          • Disable smart quote, dashes and ellipses in script mode

            The three options above this one will be ignored in script mode.


        • Data-Detection


          • Automatically detect web addresses

            When you conclude typing in text that looks like 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 \[\[document links]]

            Scrivener document titles can be linked to by surrounding the title in double-brackets. If the text between the brackets does not match any existing binder item, you will be taken to an interface for creating a new linked document. For more information on these feature, see [Linking Documents Together].

          • Auto-detect dates, addresses, etc

            Switches on the operating system's data detection capabilities, which will attempt to scan for common text patterns and treat them appropriately. For instance if it finds a sequence of text that looks to be a postal address, it will give you the option to add it to your contacts list. Dates can be turned into events in Calendar.


        • Auto-Completion

          Settings pane in the Corrections preference tab.


          • 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 with the Edit//Completions//Complete (<$custom:shortcut>) menu command.

            Words will be presented to you in a list of narrowing specificity the more you type. Once you've narrowed it down to the right word, or select one from the short list, you can tap !Return or Tab to select it and proceed on with the next word.

          • In script mode only

            Disable the auto-completion feature unless the editor has been set to script mode. This is the default behaviour.

          • Only suggest completions from custom auto-complete lists

            Restricts the auto-completion list to only those words that you have specified in the [Project Settings: Auto-Complete List pane][Project Settings]. When this option is disabled, the completion engine will attempt to find words using the exhaustive built-in language dictionary.


      • Sharing

        MISSING_IMAGE:/path/to/gfx/prefs-sharing_tab.jpg

        The Sharing !preference pane

        Scrivener supports a wide variety of file formats, both for import into a project and for exporting or compiling. This pane has been separated into four tabs, which will be covered individually in the following sections. It mainly concerns the file formats that Scrivener understands and can do things with. You can also import any kind of file at all into the binder's non-draft areas, but with limited support for displ...


        • Import

          Adjusts how files are imported into Scrivener as binder items, and where applicable, how their formatting will be converted to a format Scrivener can use.


          • Rich Text

            The following settings will impact not only how documents are imported into Scrivener, but how files will be synced into the project when using the RTF format in conjunction with [Synchronised Folders].

            Owing to the fact that RTF does not have a separate way of addressing these, there is no way for Scrivener to retain a mix of inline and inspector notes. When importing or syncing, they will all be converted one way or the other.


            • Import comments as inline annotations

              Any margin comments found within the imported word processing file will be converted to inline annotations by default. Disable this option if you prefer inspector comments.

            • Import footnotes and endnotes as inline footnotes

              When a document contains footnotes or endnotes they will be converted into inspector footnotes by default, keeping their content out of the main text editor. Enable this option if you prefer inline footnotes.

            • Ignore stylesheet information in imported documents

              When pasting rich text that has been styled, the style information itself will be removed from the pasted text. The formatting will remain intact in most cases, but the link tying that formatting to a specific style will be severed.

            • Update styles in pasted text to match destination styles

              When pasting styled text from one project into another, if styles with the same name are found in the target project, the text assigned to those styles will have their formatting updated to match the stylesheet in the target project. Disable this option to retain formatting from the source text and strip stylesheets from the pasted text.

              By example: some text is copied from Project A, which has a style called "Block Quote" in it using a 3cm left indent. The text is pasted into a different proje...

            • Limitations

              This capability only functions when pasting text from one project into another, not from any other source of styled text, including even within the same project or from another word processor. Further, an important distinction to be aware of is that if you use the File//Save As... command, or any other form of duplication with your file manager, then for the purposes of this feature they will be considered the same project.


          • Plain Text

            Plain text files are considered those that do not have some form of recognised formatting typed into them. For example, .html, .opml and even .rtf files for that matter are technically plain text files, but Scrivener will import them as formatted text rather than the raw codes used to mark the text as formatted.


            • Imported plain text files use font...

              When importing plain text files (usually they have a .txt file extension, but Scrivener will assume any file without an extension is a plain-text file) you can have Scrivener either apply the current default styling preferences, or optionally use a special font for these files.

            • Plain text import formats

              In addition to treating any file without an extension as plain text, Scrivener defines a number of common file formats as plain text out of the box: .markdown, .md, .mmd, .tex and .xml.

              Use this table to add your own extensions to the recognised file list. There is no need to specify the 'dot' in the extension list, just the letters (`xml` not `.xml`). This option can be useful if a file is being converted to rich text and you would rather it not be. For example, if you add 'html' to the list, ...


          • HTML


            • Convert HTML files to...

              Influences how .html files will be handled when importing them into a project binder. The "WebArchivesMHT" option will package the document into Apple's WebArchiveMicrosoft's MHTML format, which is viewable in many applications and will retain much of the document's original formatting.

              The "Text" setting will preserve basic formatting and allow editing, but complex page formatting will be lost. You can convert individually imported web documents to text at any time with the Documents//Convert...

            • Convert imported WebArchives and web pages to text

              You can also have imported web pages (via the File//Import//Web Page... command), or WebArchivesMHT files imported off of the disk, converted to rich text as well.

            • Cross-Platform Compatibility

              If you plan to make project resources available cross-platform between iOS, Windows or macOS, you should use the "Text" option in both cases. Since this option coverts the web file to Scrivener's internal rich formatting, it will at that point be the same as any other text document in your binder. Another alternative is to save the page as a PDF from your web browser.


          • OPML

            When OPML files are dropped into the binder, Scrivener will attempt to convert these outlines into Scrivener outlines. This can be useful if you do your initial brainstorming in a dedicated outliner application.


            • Import notes into...

              Some of applications support attaching notes to each outline header. If such notes exist, Scrivener can be instructed to apply these notes either to the synopsis, the main text, or the document notes for the related heading in the outline.

              When converting OPML notes into main text, all imported item types will use the document text type, so that you can more easily see the imported main text. The other two options will use folders for parent items.

            • Create folder to hold imported OPML items

              Enable this option if you want dropped OPML structures to be contained inside of a new folder, rather than being generated directly into your existing Binder structure at the selected point of import.


          • Scapple

            Import first lines of notes as titles only

            : In all cases, when dragging Scapple notes into Scrivener the first line of each note will be used to establish the binder title for each item created from the imported Scapple notes. With this option enabled, that first line of text will also be removed from the imported main text, as show in the lower editor example in [](#prefs-sharing-scapple_title). If the note consists of only one line then it will not be removed.

          • (scapple title import options)

            MISSING_IMAGE:/path/to/gfx/prefs-sharing-scapple_title.jpg

            Scapple notes can have the first line treated as a title upon import.


        • Export


          • Rich Text


            • Resolution for PDF images converted to PNG

              Since most word processing formats do not support embedded PDF files, any PDF graphics that have been embedded in Scrivener's text editor will be converted to PNG raster graphics upon compile.

              This option lets you determine what resolution the PNG should be set to. The default of 150 dpi (dots per inch) is a common standard in the publishing industry for simple illustrations and will ensure a large enough intermediate format for converting vector graphics to raster graphics with a balance betwe...

            • Convert underscores to underlines when converting Markdown

              When compiling to a rich text format, it is possible to convert Markdown found in titles or even text and notes. With this option enabled, Scrivener will convert underscore formatting (`_underline markers_` as opposed to `*asterisk markers*`) to underlined text instead of italics. It is important to note that MultiMarkdown, Pandoc and most other popular Markdown-based conversion systems will treat underline markers as synonymous with asterisk and produce emphasis styling (commonly italics), so u...

            • Include image file names for Nisus Writer (RTF only)

              If your primary word processor is Nisus Writer Pro, this option will add the names of images to their internal metadata. This option has no impact in other word processors to date, so it is safe to leave it on unless you encounter compatibility warnings with it.

            • Do not include stylesheet information

              By default, any styles you apply to text either in the editor, or automatically as part of your compile settings, will be defined in the output file if the format supports stylesheets. If you primarily use stylesheets for your own purposes, or use a word processor that doesn't support them cleanly, then enable this checkbox to strip them out of the files.


          • HTML

            These settings will affect the manner in which compile produces HTML and WebArchiveMHTML files, but not the MultiMarkdown HTML format, as that uses its own system.


            • Document type

              Refers to the web standard, or DocType, that should be used during export. If you are unfamiliar with web standards, chances are the default setting of the older "HTML 4.01 Strict" will suffice. If you intend to publish your writings within a modern blogging system, however, in most cases using one of the modern XHTML formats will be more compatible. If you require HTML5, consider using the MultiMarkdown workflow.

            • Styling

              Determines whether and how Cascading Style Sheets (CSS) should be embedded into the compiled web file.

              * *Embedded CSS*: declares CSS styles in the head of the exported file, allowing you to easily adjust them with your own custom stylesheets.

              * *Inline CSS*: places styling directly into the HTML elements themselves, and so is useful in situations where you wish to override default stylesheets.

              * *No CSS*: in many blogging and content management systems, all presentation formatting is alread...

            • Preserve white space

              Attempts to preserve tab characters by wrapping them in a style that declares them to be "pre-formatted" (`

              `). Although this technique may not work in all browsers, it is generally safe to leave it enabled. It has been known to cause some e-readers to break formatting.


          • Epub2/Mobi

            Merge all stylesheet information into a single CSS file

            : In most cases you will want to leave this option checked, as it will greatly reduce the complexity of any post-compile formatting and application of stylesheets, as well as increase compatibility with some online eBook previewers. To perform this combination, Scrivener must make logical guesses about your format that may result in the conflation of styles across documents. If you run into issues with lines or paragraphs of text acquiring ...

          • MultiMarkdown

            MultiMarkdown export language

            : The MultiMarkdown engine will handle the conversion of typography for you, which is particularly useful if you intend to keep your source documents ASCII compatible. These are language specific, so choose the language converter most appropriate to what you are writing in. This will insert a "Quotes Language" meta-data key into the MMD meta-data block. If you supply your own such key by hand in your compile settings then the compiler will defer to your request.

            : ...

          • JPEG Compression

            JPEG images compression

            : Use the slider to adjust the amount of compression used when either embedding images in the file (for rich text formats) or compiling JPEGs as loose files with HTML and Markdown-based formats. The "Min" (left) slider position will result in the best quality images, at the expense of file size (better for print). The "Max" (right) slider position compresses images as much as possible, resulting in smaller file sizes (better for online or e-publishing).


        • Sync

          Concerns the automatic import/export and merging of documents when [working with Scrivener for iOS] or using [Synchronised Folders].


          • Mobile Sync

            These options pertain to how Scrivener will open projects that have been modified by Scrivener for iOS. Synchronisation refers to the merging of changes made to a project, no matter how that project may have arrived on your computer. These options thus even have an impact when the project was zipped and emailed to you.


            • Place documents affected by sync into a "Synced Documents" collection

              This collection will be refreshed every time the project is synced. If you would prefer this list not be created or updated, disable this option.

            • Automatically show the "Synced Documents" collection after sync

              Enable this option if you would prefer to address synced documents immediately upon syncing, by having the binder sidebar replaced by this collection list.

            • Take snapshots of updated documents

              When this option is enabled, documents that have been modified on iOS will have a snapshot taken of them directly before before merging the iOS changes in. Given that iOS has no snapshot capability of its own, this feature can stand in for that capability.

              Be aware that every single edit made to the text will cause a snapshot to be created. Over time these could build up and bloat the size of your project. It might be a good idea to prune them every once in a while with [the Snapshots Manager][...

            • Check for changes every...

              If a project is left open on your computer while you take it mobile, this setting will cause the software to periodically check the internal state of each open project for incoming mobile edits (which will of course arrive automatically if Dropbox is left running and you sync while working on the go).

              Lowering the check rate will decrease the odds of accidentally conflicting the project, at the expense of using additional resources (and battery power if that is a concern) for each project you l...


          • External Folder Sync


            • Remove stylesheet information when syncing with a folder

              Given that this option will inevitably destroy any stylesheet assignments you make using Scrivener's editor, it will mainly only be of interest to those who prefer not to use stylesheets at all, and wish to ensure that any edits coming in from the synced files are likewise clean of them.

            • Convert text inside (( )) and {{ }} to inline notes when syncing plain text

              When using the plain text format, your inline annotation and footnotes will be enclosed within special brackets. These brackets will be searched for when you sync back, converting text found within them to notation format again in Scrivener. The brackets used are:

              ```

              ((Text of inline annotation))

              {{Text of inline footnote}}

              ```

              You can type in these brackets in the external files to add new notes to your text while on the go. Because this only works with inline notation, you will need to con...


        • Conversion

          The settings in this tab alter how word processing documents will be converted to and from Scrivener's core internal format, RTF. You should not ordinarily need to change these settings, but if you run into compatibility or performance issues relating to conversion, check back here for a few troubleshooting options.


          • Enable enhanced converters for Microsoft Word and OpenOffice documents

            This checkbox sets the conversion engine used for all forms of import and export activity, including drag & drop into the binder, bulk file import, export, and compilation for the DOC, DOCX and ODT type files. In most cases you will want to leave this option enabled, as the quality of the conversion will be far inferior when using the stock macOS converters instead.

            This quality does come at the expense of speed. When compiling, for instance, Scrivener must first create an RTF file---which can ...

          • Microsoft .doc

            This setting is only available when the enhanced converters are disabled. In most cases, you will want to leave this set to the default, RTF-based .doc file. Scrivener's RTF export engine supports a great many features that macOS' built-in exporter does not.

            However, if you are working with an application that cannot read RTF files at all, and cannot use the enhanced converters, you will want to change this option to use the standard macOS exporter. This will reduce the quality of the document.

          • Use Word-2011 compatible copy

            If checked, copying and pasting from Scrivener into Word 2011+ will use true footnotes and comments. Having this feature enabled can reduce the quality of copy and paste between Scrivener and other native macOS software.


      • Backup

        MISSING_IMAGE:/path/to/gfx/prefs-backup_tab.jpg

        The Backup !preference pane

        Scrivener has a fully automated backup system that keeps individual self-contained snapshots of your project set aside in case you should ever need to roll back to a previous version of the project. The options in this tab will control the various aspects of it. Individual projects can override some of these settings in the [Project Settings: Backup pane][project settings - backup].


        • Turn on automatic backups

          Enables the automated backup system. It is best to leave this turned on, unless for performance or security reasons you wish to control the process manually. Individual projects can opt out of backups in Project Settings.

        • Back up on project open

          Whenever a project is opened, a backup will be created before you can begin working. This can slow down load times with large projects, but ensures you have a snapshot of how things were before you started a session.

        • Back up on project close

          Whenever a project is closed (either directly or via application shutdown), a backup will be created. This can slow down close times in large projects, but ensures you have a snapshot of how things were when you concluded a session. When combined with the above option, you will have a complete before/after pair for each session.

        • Back up with each manual save

          Have the software create a backup copy whenever you manually save a project with <$custom:shortcut>. This behaviour will not trigger with the auto-save feature.

        • Back up before syncing with mobile devices

          When opening and syncing changes made with Scrivener for iOS, a backup will be created directly prior to sync. This backup will contain the project as it stood before merging in the mobile changes, as well as the mobile changes themselves. This option is enabled by default, but will be of no impact to you unless you work with Scrivener mobile.

        • Compress automatic backups as zip files (slower)

          If you are storing your backups on a network drive, or Internet synchronised service like DropBox, this option will not only save space and reduce data usage when uploading, but will protect the project format from the sorts of damages which can occur when lots of files are transferred over the Internet. However, it will adversely affect the performance of your backups, as Scrivener not only has to collect and assemble a copy of the project, but compress it as well, before letting you return to ...

        • Backups taking longer than it seems they should?

          The use of aliases or symbolic links in the binder, pointing to resources stored externally from the project, can slow down zipped backup times significantly, on account of how these links must have their source material excluded from the zipped backup. Disabling the zip option will be the simplest way to avoid the extra processing if you depend upon links. If you can do without them, you will see backup performance improve for the project.

        • Use date in backup file names

          In addition to a numbering token, which Scrivener uses to keep track of the rotation, the date and time of the backup will be included in the file name, making it easier to sort by recency in the Finder. It also means each backup filename will be unique, which could be of use with an external backup system.

        • Only keep *n* most recent backups

          To avoid the proliferation of hundreds of backups, a limiter is employed. Use this option to have Scrivener restrict the number of backups to a defined amount. Once this amount is reached, it will remove the oldest backup to make space for the new one. You may find this needs adjusting if your work habits cause backups to overwrite each other too quickly. It's generally a good idea to have three or four days of backups available.

          If you would rather Scrivener never delete old backups, disable t...

        • Backup location

          Determines the folder where automatic backups will be maintained. If you would prefer these backups be kept somewhere more visible, or on a synchronised, external drive, or secured area, click the Choose... button and use the folder navigator to select the destination folder. If you choose a location that later becomes invalid (a common example is external drives), Scrivener will immediately warn you as soon as it tries to back anything up.

          As a convenience, you can quickly access the backup fo...


    • Project Settings

      Where application !preferences adjust how all projects and the software itself functions, individual projects have their own settings as well, which can in some cases override global settings. We carefully designed our built-in templates and even the blank starter to be as broadly useful as possible out of the box as possible. You might never even need the stuff in this appendix! But if you like to tinker, as usual, we've got you covered.

      In addition to the settings found within this pane, ther...


      • Copying Settings Between Projects

        Several of the panels in the Project Settings window can share their settings with other projects via drag and drop. In most cases, all you need to do is open settings for both projects at once, and drag and drop items between respective panes. For example, you can use the CmdCtrl-A shortcut to select all of the labels in a project and then drag those labels into another project's label list. Here are the panels that can share settings, and any notes pertaining to them (if you do not see a tab i...

      • Section Types

        MISSING_IMAGE:/path/to/gfx/project_settings-section_types.jpg

        The Section Type settings used by the "Novel (with Parts)" project template.

        [This panel](#project_settings-section_types) is the dictionary by which you'll define items as having a *type*, in the binder. When a particular folder is set to export a chapter heading---perhaps using its name as the visible title of the chapter for the reader's benefit---it is in this panel that you'll have a type listed as "Chapter". This is also the pl...


        • (section types - see also)

          • [Section Types]: a basic introduction to the usage of section types in a project.

          • [Project Settings][project settings - section types]: how to set up section types in your project settings, and optionally configure how they will be automatically assigned to items in the outline structure.

          • [Section Layouts]: how they will end up being used when compiling your draft to a final format.

          • You can search the project for all documents of a particular type with [Project Search], and [filter t...

        • What Are These Levels?

          If you're a veteran to Scrivener, you're probably familiar with the "Formatting compile option pane" in the previous version, and you might already be seeing some similarities between how that pane worked and what you're seeing in the second tab. They in fact work very similarly (and you can probably skip [to the next section][Transferring Section Types Between Projects] if you're a pro at it)---where in the Formatting pane you were assigning the formatting directly to levels as compile settings...

        • Section Types Tab

          The first tab in this pane contains a simple list of every type defined in the project. At the most basic, in a blank starter project, you'll find two types: "groups" and "text". These have been automatically set up (in the second tab) to apply to folders for the former, and file groups and text files for the latter.

          • To create a type, click the AddButton button, marked beneath (a) in [](#project_settings-section_types). Type in the name of the type as you would like for it to appear througho...

        • Default Types by Structure

          Within the second tab is where we will take the types created in the first tab and assign them to icon types---and optionally levels of outline depth---so that we don't have to do that manually ourselves as we develop the draft. At its most basic you'll find three rows corresponding to the three basic binder item types that can be found in the draft: folders, file groups, and text files. If you leave it at that, you can have up to three automatic assignments in your project based on these types....

        • Transferring Section Types Between Projects

          Owing to the potential complexity of the second tab, it is not possible to drag and drop settings between projects. You can however save your settings into a file which can be shared with others or transferred between your own projects.

          • To export your settings to a file:

          1. Click the "Export" button, on the left side under the (c) marker in [](#project_settings-section_types).

          2. Choose a name and location to save the `.scrtypes` file to your disk.

          3. Click Save.

          • Importing settings wil...


      • Label List & Status List

        The next two panes are similar enough in their usage and purpose that we can take a look at using them together. The only difference between labels and status is that the former also associates a *colour* with an item, and that can of course be configured in its respective pane.


        • Managing Labels and Status

          MISSING_IMAGE:/path/to/gfx/project_settings-label_status.jpg

          Status and Label List panes are where you modify available values.

          In the [central portion of each pane](#project_settings-label_status) we have a list of labels and status entries for the project---these are what you will see in the selection menus for items. We provide a few basic entries to get you started, but these can all be changed or removed as you require.

          Custom Title, marked (b) in the figure, is for modifying how this fie...

        • Defaults and Fallbacks

          In both lists there is one entry ("No Label" and "No Status") that cannot be removed. This is a fallback, or what will be printed whenever an item doesn't have a label or status. You can change the name of this entry by double-clicking on the text of it, just as with a normal label or status (in the example figure, we've changed our example to "N/A", for indicating that the item isn't applicable to a PoV assignment---maybe it is a page of research). For labels, this entry cannot have a colour as...


      • Custom Metadata

        Project Settings panel.


        • Adding Fields

          1. Optionally select an existing field to insert beneath, then click the AddButton under the (a) marker, or press the !Return key.

          2. Type in the name of the field, and click anywhere else to confirm.

          3. From the Type field, marked (c), select what type of field this should be:

          ⁃ *Text*: a simple plain-text field, useful for storing information that doesn't often repeat, like descriptions or in the case of this example, the authors of the material we are tracking.

          ⁃ *Checkbox*: it works jus...

        • Deleting Fields

          1. Select the fields you wish to delete. As normal, you can use the Shift and CmdCtrl to select multiple items.

          2. Click the DelButton button marked under (a), or hit the !Delete key.

        • (custom metadata - see also)

          • Overview: how [custom metadata] can benefit your work.

          • Settings: adjusting the available fields and their settings, in [project settings][project settings - custom].

          • Inspector: editing custom metadata on a per-item basis with a [form built into the inspector][Custom Metadata Pane].

          • Outliner: [working with custom metadata] in the outliner, and making [bulk changes, when applicable][Batch Assignments to Bulk Items].

          • You can use list and checkbox type fields to [filter outliner & cor...

        • Text Fields

          Text fields are very simple plain text, and will work best with information that tends to vary from one item to the next. If you intend to use information that repeats frequently, lists might make for a better type of field.

          The [text field type](#project-settings-custom-text) has the following settings available:

          Wrap text

          : When a text field is set to wrap, it will expand the height of the field as necessary to display all of the text entered into it. In the inspector, this will push down an...

        • Checkbox Fields

          Checkboxes are simple on/off switches that you can add to your items. They will be useful for cases where a condition is either true or false, and can be set to either be ticked by default or not.

          Tick by default

          : Sets the default condition of the checkbox for all items which haven't at any point in the past been set one way or another. Whenever you click a checkbox, the result will be to toggle whether it is on or off, and doing so explicitly sets that condition to the item. It will no longer...

        • List Fields

          MISSING_IMAGE:/path/to/gfx/project-settings-custom-list.jpg

          Custom list fields are best when the possible values are of a limited set.

          Lists are fields that will present a dropdown box when clicked upon, offering you the choice between the different set values that you will define [in this pane](#project-settings-custom-list).

          The "None" item title entry at the top of the list will set what will be printed if an item has no assignment made to it yet. An empty value is permitted; be aware this ...

        • Date Fields

          MISSING_IMAGE:/path/to/gfx/project-settings-custom-date.jpg

          Custom date fields work best when you need to record a conventional calendar date and time stamp.

          For those cases where you need to record a conventional date in an item, the date field should do. If you are looking to record highly customised, historic or fictional dates, it might work best to use a regular text field instead, as this field will presume a modern time reckoning.

          When using the date field in your project, you'll be abl...


      • Formatting

        MISSING_IMAGE:/path/to/gfx/project-settings-formatting.jpg

        The Formatting pane in Project Settings is used to apply special settings to individual projects.

        Projects all use a central set of preferences (established in the [Editing: Formatting !preference tab][editor - formatting]) for determining what formatting (font, paragraph spacing and indenting, tab stops and so forth) will be used in new documents you create within them. For cases where you have a project that needs its own settings, P...


        • Use footnote marker

          This alternate form of referencing [linked footnotes] will place a custom marker after the selection or current word, rather than highlighting the phrase you wish to footnote. In documents that make use of heavy notation, this can help keep the editor clean of extraneous markings while writing. To use this:

          1. Tick the Use footnote marker checkbox.

          2. Type in the marker you would prefer to see while writing.

          Existing footnotes will not be altered and will continue to function normally. Howev...

        • Main Text Formatting

          This is where you can choose distinct formatting sections for this project, separate from those used by other projects in the application level settings. All aspects of formatting will be overridden by the choices you make here. To enable this section, tick the Use different default formatting for new documents in this project.

          Use the mock editor to set up your preferred styling for this project. This works just like the similar setting in the [Editing: Formatting][editing - formatting - main ...

        • Different inline footnote font

          As a subsidiary function of the above, this setting will additionally overrides the application setting for the inline footnote font. It will work even if you are not currently using custom font for footnotes in the main application !preferences, but it will respect the secondary option in that pane, Use inline footnotes font for inspector footnote too. When that is enabled, the choice you make here will impact both types of footnote.

          This setting is primarily for your own personal preference, ...


      • Auto-Complete List

        MISSING_IMAGE:/path/to/gfx/project_settings-auto_complete_list.jpg

        A project's auto-complete list can greatly aid keying in frequently used phrases.

        Every project has its own stash of auto-completion phrases that you can make use of. By default these will never get in your way as you type (unless you are scriptwriting, where we find most scriptwriters prefer aggressive replacement suggestions), but rather will be shown after typing in a few letters and then pressing the completion shortcut, <$c...


        • (see also)

          • [Custom Auto-completion]: details on how to trigger completions and add new ones on the fly, while writing.

          • [Scriptwriting Auto-Completion]: describes the auto-completion behaviour when making use of the scriptwriting features.

        • Auto-Completion Scope

          Scriptwriting has a concept of scope, or elements that are used to format the text. We might want certain words to be completed while typing into a character element, but not while we're typing into scene description element. Furthermore, most of Scrivener's script settings will add such key words and phrases automatically as you compose the script.

          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...


      • Special Folders

        MISSING_IMAGE:/path/to/gfx/project-settings-special_folders.jpg

        Configure which folders in your project should be used for templates and new bookmarks.

        Scrivener has a couple of features that make use of a designated folder in your binder:

        Templates Folder

        : The folders, files and other items you place into this folder will be provided project-wide as boilerplates for creating new files throughout the binder. A common example of this feature is the "Character Sketch" file, made available in th...


        • (see also)

          • [Document Templates]: everything you need to know about how they work, how to set them up and make use of them in your projects.

          • [Project and Document Bookmarks]: read more on the topic of using project bookmarks in general.


      • Background Images

        MISSING_IMAGE:/path/to/gfx/composition-backdrop.jpg

        Default Composition Mode settings (behind) vs settings with a backdrop image.

        Background graphics should be ideally sized to be no larger than the largest screen that you intend to be using. Images must be stored in memory while the project is open, so very large files can bog down the software and reduce stability.

        Composition Mode Backdrop

        : Choose a background image for your !composition environment, rather than the plain background colou...

      • Backup

        In this pane you can override the global application backup settings for this project. These settings will not enable automatic backups if they have been disabled globally, they will merely modify what settings already exist.

        Exclude from automatic backups

        : When enabled, this project will not be backed up automatically under any circumstances. It can still be backed up manually using the menu commands found within the File//Back Up// submenu; take care to do so periodically, or have another ba...


    • Scrivener's Compile Formats

      TODO//LOW// overall I would like to flesh these out a bit more, describing the different layouts within the format and maybe adding screenshots.

      This appendix will document the built-in compile formats made available in the Scrivener installation, as well as those formats that have been supplied within a few of its project templates exclusively. We hope that by and large the use of these formats is intuitive, but if you wish to modify them or better understand how they work, this section will...


      • Default

        Meant as a very simple format primarily used to pass through editor formatting and "glue together" the pieces in your draft folder with little alteration. Folders will still generate page breaks by default, and it comes with a few layout choices for adding additional headings as need be. This is a good starting point for your own formats, or as a basic way to export projects that do not require any special compilation options. It's also a good option if you'd rather defer formatting for work in...

      • Word processing and Web

        These formats pertain to the print, PDF, RTF, RTFD, DOC, DOCX, ODT and HTML types.


        • Enumerated Outline

          If you need a basic outline of topics (taken from the binder titles) alone in an indented list, this format is a good starting point. Unlike most formats, it will not export any text, only the titles of documents. The four section layouts that come with this format provide different spacing and numbering schemes for your outline. You could use a mix of styles for different types of documents in your project, but in most cases it would be best to assign all section types to your preferred format...

        • Full Indented Outline

          Presents an indented, easy to read outline that includes titles and synopses for all binder levels. The provided layouts provide a choice between alphanumeric numbering, hierarchical or no numbering at all. Refer to "Enumerated Outline" in the previous section for tips on adjusting the indent and numbering styles.

        • Manuscript (Courier)

          Formats your book using standard Courier 12pt type and a number of common conventions such as scene separators as hash marks, double-spacing, underlined emphasis (instead of italic), page numbers, standard page headers and so forth. It has broad set of section layouts capable of handling a book with parts, chapters, scenes and titled sections. It is thus equipped to work with all of our built-in book generating project templates, fiction and non-fiction alike.

        • Manuscript (Times)

          Functionally very similar to the Courier manuscript format, this uses Times New Roman, which is another commonly required typeface for submission manuscript. Scene separators remain hash marks, double-spacing, page headers and so forth. Italics will be rendered as italic text rather than underscored. It provides the same array of layouts as the courier format.

        • Modern

          Providing a fresh look, using the respectable Avenir Book typeface, coupled with Helvetica Neue Bold heading and Light subheadings, this layout is designed for printing primarily. It includes a full complement of layout designs, working with all of our book generating project templates.

        • Outline Document

          This layout is designed for printing full outline information (title and synopsis), but in a standard document layout rather than an indented format. It also has several layouts to choose from that only export the title, which could be useful for some projects where larger categorical groupings like parts and chapters may not have any specific synopses of note and just need to insert a sectional break. The page footer contains the title of the work, author's name, date and page number, separated...

        • Paperback (5.06\" x 7.81\")

          A format designed to produce a typographically pleasing layout that could be taken into a word processor or desktop publishing program for self-publication with little effort. One might also try using the system PDF output to skip that phase. As with the other book generating formats, it is designed to provide a full spread of layouts to accommodate many different book styles and structural setups.

        • 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 section heading as well as in the header, making it easy to send out "Not for distribution" copies to your proofing team.

        • Script or Screenplay

          This format is also available to the scriptwriting formats, and [is documented there][Script or Screenplay].

        • Vellum Export

          Available only to the DOCX file type, this Format is designed to convey your work to the [Vellum book creation tool][Vellum homepage].

          It is best used with [styled text][Styles and Stylesheets], which Vellum depends heavily upon to correctly format your work. For the most part, you may use Scrivener's styles intuitively and should find they all work as expected when imported into Vellum. This compile Format will check for the stock style names used by Scrivener and convert them to style names ...


      • Ebooks

        Since most eBook readers will handle the majority of the text design, font choices and layout, choosing a format will be more about getting the basic building blocks together.

        These formats apply to ePub 3, ePub 2, Kindle KF8 and Mobi types.


        • Ebook

          A suitable, simple format for eBooks. ePub and Kindle files generally require basic and flexible designs in order to be displayed on many devices, from cellular phones to tablet computers to dedicated black & white e-ink displays. This is a good starting point for your own formats when creating eBook formats.

        • Ebook Screenplay

          When publishing a screenplay intended for display on an eBook device or reader software, you'll want to use this format, which has a stylesheet designed to print the various scripting elements in a format mimicking a screenplay. Since the average reader won't have a screen large enough to truly display a standard format, some of these elements will be estimated, or designed to merely suggest what they would look like on a typical printed page.

        • Outline Document

          This format is also available to the general word processing and web formats, and [is documented there][Outline Document].


      • Scriptwriting Formats

        This format are available to the Final Draft and Fountain types.


        • Script or Screenplay

          When used with the Final Draft and rich text formats, most of the formatting will already be done in editor, so the format itself need only concern itself with page layout and converting "smart" punctuation to "dumb". Most of your script should be assigned to the "Text Section" layout.

          Fountain, as a plain-text format, does not have any text formatting built into it. Scrivener will handle the conversion to the syntax necessary to build this format.


      • Plain Text and Markdown-Based

        These formats are displayed when using the TXT, MultiMarkdown or Pandoc based types.


        • Enumerated Outline

          This format is also available to the general word processing and web formats, and [is documented there][Enumerated Outline]. The main difference of note is that the indenting used to indicate hierarchy will be converted to literal whitespace for plain-text. Those using a Markdown-based format should use the "Markdown Outline" format instead.

        • Markdown Outline

          If you are looking to convert the outline of your project into a Markdown-style indented bullet or enumerated list, then this format will be preferable to the "Enumerated Outline" format, in that it has been designed specifically to generated valid Markdown lists. This format includes a simple LaTeX design, which will be used in conjunction with the MMD to LaTeX/PDF compile file types.

          You can either assign all of your project's section types to one of the listing types, or mix and match based ...

        • NaNoWriMo (Obfuscated)

          This simple preset has only one layout that passes your text through without headings. The official NaNoWriMo word counter works best with plain-text files. The obfuscation is done via an extended list of letter-to-letter substitutions which will completely obfuscate the wording of your draft, making it nearly impossible to read, without impacting the word count. This format should not be used for backups! It is purely for submitting your draft without risking sending your actual novel to anoth...

        • Plain Text Manuscript

          Designed to serve as a basic plain-text manuscript with emphasised headers, it is a good format if you want a hard long-term backup of your manuscript. Since it is formatted using plain-text conventions, it will last for many decades to come. It's also a good format for sharing text through mechanisms that better use plain-text for transmission, such as email, newsletters, readme files and bulletin boards.

        • Plain Text Screenplay

          For integration with software that can import plain-text formatted screenplays Not to be confused with Fountain, which is a newer format with a rigid syntax, this format is more along the lines of how you would type in a screenplay using a typewriter, with tabs and spaces.. This format will convert spacing and indents to literal whitespace, as well as pad the text file with enough whitespace to print 1" margins when printed using 12pt Courier. The result should be identical to a formatted screen...

        • Basic MultiMarkdown

          Since most Markdown-based systems will be doing the bulk of the actual formatting in post-processing, this Format primarily concerns itself with establishing the structure of your document. Through the three layouts provided, you can print sections as headings, headings with text and text alone. The heading-based layouts will automatically insert the appropriate number of hashes to match your outline hierarchy with heading structure depth. For example a level three outline item will be preface...


      • MultiMarkdown LaTeX and PDF

        When selecting "MultiMarkdown → LaTeX (.tex)" or "MultiMarkdown → PDF" as the compile file type, the formats listed in this section will become available. With the exception of the "Modern (Custom LaTeX)" format, the available document classes use designs created by Fletcher Penny, the developer of MultiMarkdown.

        Looking for LaTeX Without the Pain?

        These formats can be made use of with very minimal, or even no MultiMarkdown usage at all. With the Convert rich text to Multimarkdown option in [th...


        • Article (Memoir)

          Uses a layout of the expansive [Memoir LaTeX document class][memoir-class] that has been tuned to mimic how the stock `article` class looks. The benefit of using this class is the wealth of customisation options available to Memoir in general.

          The compile format has an inherent "Base Header Level" of 2, which means the top level heading will be considered a chapter rather than a part. Chapters will be formatted more like section headings. If you would prefer a different top level heading, adjus...

        • Book (Memoir)

          A fairly stock implementation of the Memoir book class, which is generally useful for non-fiction as well. This is a great starting point if you wish to build your own design from scratch (in fact this user manual you are reading made its humble beginnings using this boilerplate).

        • Book (Tufte)

          A document class with a design inspired by the [books of Edward Tufte][tufte-class]. This format supplies a few additional optional styles that you can make use of by adding them to your project:

          • *Full Width Text* (paragraph style): This will typeset the marked paragraphs full-width, into the right margin area, using the fullwidth environment.

          • *Margin Note* (character style): Places an unnumbered margin note alongside the paragraph the marked text is within, much like a footnote, but with...

        • Manuscript (Courier)

          Using a simple design put together by Fletcher Penney, this will typeset your document using a traditional submission manuscript format: 12pt Courier will be used for all text, with 1\" margins and double-spaced lines. There are a few peculiarities of this format to be aware of:

          • This format does not handle parts, and so in most cases you should set the Base Header Level to "2", in your project's [compile metadata settings][compile - metadata - mmd].

          • Bold text has no treatment, you should ...

        • Modern (Custom LaTeX)

          Unlike the other formats, this one has been designed by Literature & Latte, based upon its "Modern" compile format for RTF and other traditional printing methods. That aside, it is a modified version of the Memoir system in article format. All of the settings for it are stored directly within the compile format itself. You can easily modify how it works from [the LaTeX Options compile format pane][LaTeX Options].

          For Best Results, use XeLaTeX

          This design makes use of system fonts, and as such i...


    • List of Tables and Figures

      ```{=latex}

      \section*{Tables}

      \listoftables

      \section*{Figures}

      \listoffigures

      ```

    • What's New

      If you are currently a Scrivener 2 user and are looking into whether you'd like to upgrade, this is the guide you want to read. We will discuss the major changes that have been made, and when necessary, cross-reference them to more detailed documentation elsewhere in this manual. Keep in mind we offer a free 30-day demo. It is safe to run this demo in parallel with Scrivener 2. You can play with the new version and learn it, while continuing to work without interruption in your ongoing use of Sc...


      • Compile Overhauled

        The second version of Scrivener represented a complete overhaul of the compile interface from version one, and we are pleased to present a third iteration of the compile concept to you. Based on years of feedback with the system you've grown accustomed to, we've designed a replacement which draws heavily upon the strengths of the old system while using it as a skeleton to develop a more intuitive and easy to use "front end".

        Given the scope of changes made to the compile system, it is not possi...


        • Front and Back Matter Locking

          Well, for one thing there is now a concept of "back matter", which will be welcome news to those in need of such. Furthermore we've made it so you can lock front and back matter folders to file *types*, meaning whenever you select between ePub, Kindle, PDF and so forth, specific different groups of front and back matter pages can be automatically applied to your compile settings. Read more about locking settings to file type, in [Front & Back Matter].

        • Preserve Formatting in Markdown Compile

          <$include>

        • Print with Footnotes

          In the past, if you wanted to print or generate a PDF out of Scrivener with proper end of page footnotes, you either had to compile to another program that could do this form of typesetting, or make use of the "Proofing" option in compile settings. Scrivener how typesets its own footnotes for Print and PDF compiling. If that's all you were needing a word processor for, that's hopefully one less tool you need to get work done!

        • Separators by Type

          In the past, inserting separators into your document was either a matter of checking off boxes in the inspector or trying to shoehorn your outline into a layout that worked with the Separator's compile option pane. For example, if you wanted an empty line between scenes in a novel you could have Scrivener insert empty lines between text chunks---but then you could only ever cut to a new chunk of text for the purposes of creating a formal scene.

          In Scrivener 3 you can now not only assign separat...

        • Markdown to RTF Conversion

          In the past, those using basic Markdown for italics and bold in their text could make use of an option in the Transformations compile option pane to convert these to rich text formatting, when using any of Scrivener's native export formats. This option has been replaced by the Convert MultiMarkdown to rich text in notes and text compile option, in the compile overview screen under [General Options][compile - general options].

          Of note, it now treats text and notes as properly formed Markdown, ra...


      • Importing Legacy Compile Presets

        We recognise that you may have invested a lot of time in your compile settings. Should you choose to upgrade a project that is a work in progress, you will find its compile settings will be reset to default. If you would like to carry over the original settings into a new format, the following procedure should help you get most of your settings converted to the new system.

        Instructions for importing your settings into a new version 3 format have been provided in [Importing Legacy Presets]. If ...

      • Section Types, Page Breaks and As-Is

        Any talk of the changes made to compile would not be complete without mentioning section types, a new way of assigning meaning to the folders and text items in your binder (mainly of relevance to the Draft), such as "chapter", "subsection" or even specific types such as "table" or "figure". Without going into detail, you can now categorise sections in your binder using natural terms, and in turn you can set the compiler to print these types of things in a logical fashion, rather than formatting ...

      • Stylesheets

        Ye olde formatting presets have become proper stylesheets. Head on over to [Styles and Stylesheets] to see what's new. You'll find much of the toolset has a similar usage from what you are used in prior versions of Scrivener. The tool drop-down is in the same location on the Formatting bar---in iOS the change is seamless---and for the most part you can use them in day to day writing similarly to how you used presets.

        It would be a good idea to familiarise yourself with how they work in the comp...


        • Converting Formatting Presets to Styles

          Do you have a bunch of formatting presets you'd like to convert up to a the new format? We won't do that for you because styles are now project-specific, but for the same reason it is easy to create a style from some already formatted text, it is easy to create styles off of text that has had presets used upon it.

          You could do this in a new "Blank" project and then save that as a project template, using File//Save As Template..., and [now you have a starter project with your preferred styles bu...


      • Project Bookmarks

        Project notes are dead, long live project notes! That's right, the feature formerly known as Project Notes, a core part of Scrivener since its early beta days, is no more. The good news is that if you've benefitted from using them in the past, then you should find it possible to continue working in a familiar fashion going forward, and in fact you may find yourself using the new features in ways you hadn't before.

        When we took a look at this feature, and what we could do to improve the Project ...

      • Writing History

        Your daily progress, whether it be in going from zero to a goal, or from a bloated work that badly needs trimming down to size, can be tracked using a new tool: [Writing History]. Accessed via the Project//Writing History... menu command, it not only does some simple summation and calculation for you, but allows for easy export to CSV format, where the raw data can be taken into a spreadsheet.

      • Custom Metadata Overhauled

        We've added three new types of custom meta-data that you can use to enhance your record-keeping. XREF//17132729 If you've been using older versions of Scrivener and would like to make use of the new field types with existing data, this section should help you do so.

        Scrivener's new date field takes natural language dates and converts them into a proper date and timestamp for you. However, it won't do this to existing text that you've stored in a text type field as there are too many different w...

      • Snapshot Manager

        If you're anything like me, you take a lot of snapshots, and furthermore you ask the software to take a lot of snapshots for you as well. This is great for keeping a track record of your progress safe as it develops over time---but it can mean a lot of clutter builds up, especially in those projects that end up being used for years at a time. Eventually even the biggest data hoarders might come to admit that a bad revision of something that was written five years ago maybe isn't worth hanging on...

      • Enhanced Outlining

        The outliner has always been a place where you can pack a lot of information into the view, and thus an integral component in getting that sense of overview that Scrivener can provide, down to the word counts of individual chunks of text or keyword listings.

        We wanted to broaden what the outliner can be used for however, as many people also prefer this sort of device as a creative tool. To that end we've added a few aesthetic options that can be used to present the outline as a more content-foc...

      • The Devil in the Details

        We've gone over most of the major differences between versions 2 and 3, what remains are a few of the smaller changes that are worth making note of. It would not be possible to list every single change in the software, so this list will concentrate on those changes that could impact how you've used version 2 in the past.


        • Subdocument counts in binder

          If you used the older feature that prints the subdocument counts as a numeral to the right of containers in the binder, you will be interested to know where that feature has been moved to. It is now a project-specific setting, toggled with the View/Outline/Show Subdocument Counts in Binder menu command.

        • Migrating Your Settings

          By default, Scrivener 3 will start you with a clean slate for settings, giving you the default out of the box experience, even if you've used Scrivener in the past. If you would prefer to migrate your settings to the new format, then use the Manage... button in the lower left corner of Scrivener 2.x's preference window to "Save Preferences to File...". Now switch over to Scrivener 3 and use its own Manage... button to "Load Preferences from File...".

          Not all preferences will be identical betwee...

        • Dragging Links into Documents

          One of the simplest methods for creating a link to a document from the text you are currently working on is to drag and drop the document you wish to link to into the text editor. In Scrivener 2, you were required to hold down the Option key while doing so. In Scrivener 3 you can just [drag and drop the document straight in][Linking Documents Together]. Meanwhile Option-dragging now pastes the *content* of the dragged document into the editor where you drop.

        • Dragging Text Out of Documents

          While we're on the subject of dragging, you will want to know that dragging selected text out of an editor and into another context (such as the binder or another editor) will now *move* the text, just as it is the default behaviour to move text that has been dragged within an editor. If you would prefer Scrivener worked as it used to and copied text dragged out of the editor, disable the Delete text dragged to other areas option, in [the Behaviors: Dragging & Dropping !preference pane][behaviou...

        • Editor Header Bar Icon Menu

          Since the very beginning, Scrivener has always presented a few useful commands pertaining to the document you are working on, in the header bar icon beside the title of the document you are editing. All of that is still there in Scrivener 3, and more besides, but you no longer have to click on the icon. Instead you can now right-click *anywhere* in the header bar (other than the history buttons).

          As for the icon itself, that is now something you can drag, just like dragging the document itself ...

        • Excluding a Project from Backups

          If you have updated a project that was excluded from automatic backups, it will go on as excluded. However you should know that the option to toggle this setting has been moved from the File menu into Project Settings, under the Backup tab. While there, you may also note it is now possible to select a custom backup folder on a per project basis.

        • Changing Composition Backdrop

          If you've enjoyed the ability to set a photograph or texture to the background of your full screen writing environment, you'll want to know that option (along with many other project specific options by the way) has been moved to the Project/Project Settings... panel, under "Background Images" in the sidebar. Everything else about the feature should be familiar.

        • Project Properties are Compile Settings

          Instead of setting up the title of your work, author's name and so forth in a project setting panel, this is now done directly in the main compile interface, under the "metadata" dog tag icon on the right hand side. For projects that have been upgraded from the 2.x format, you should find the information from Project Properties migrated over to the new location for you.

        • Modified Default Revision Colours

          If you have projects which are currently using revision markings, you should be aware that the default revision marking colours have been modernised, meaning the new version of Scrivener will not "see" your old markings, for purposes of features that search by or strip out markings. If you require consistency with existing projects, you should visit the [Editing: Revisions !preference pane][Editing - Revisions] and adjust the five levels to their previous levels.

          You will find two macOS colour ...

        • Modified Default Highlight Colours

          The set of default highlight colours that Scrivener makes available in the Format//Highlight// submenu have been modernised. If you have upgraded a project that made use of highlights in the previous version, you will find that colours do not match the old highlights. This will mainly be of impact if you use the Edit//Find//Find by Formatting... tool to locate highlights of a specific colour. If you want to "upgrade" your existing highlights, you could use that same tool to search for the old co...

        • "Go To" Menu in Header Icon Menu

          When viewing a Scrivenings session in the past, the "Go To" menu, found when clicking upon the header bar icon menu (which incidentally is now a right-click), you would be given a simplified table of contents for the current session. This was nice, as you could easily jump around from one section to another within the text you were currently working on---but it could also get in the way if you're used to the feature letting you go anywhere at all in the binder.

          We've added a new feature which i...


          • (navigation menu in header bar)

            MISSING_IMAGE:/path/to/gfx/editor-header-navigate_to.jpg

            The new "Navigate to Section" button, first in this series of buttons found on the right side of the header bar.


        • The Text Editor Uses Fixed-Width by Default

          In the past, Scrivener's default text editing mode displayed text the full width of the editor, no matter how wide it was. This meant that if the editor grew very wide, text lines could become unreadably long (and in fact fixed-width editing was set as a default for full screen mode to combat the worst cases of this). Scrivener's default way of presenting text is now to a fixed width column, one that will respect the relative number of characters that can be seen on a single line, no matter the ...

        • Custom Categories for Project Templates

          You can now organise your project templates into custom categories in the new project template chooser. Refer to [Custom Categories] for more information.

        • Locked Editors Divert Navigation

          In the past, when you locked an editor you could freely work in the sidebar without content loading in that editor or the other split. Now, if the interface is split the other editor will receive the navigation request instead. If you would prefer the older behaviour, change the When focused editor is locked in place setting in the Behaviors: Navigation !preference pane to "Binder selection does nothing".

        • Text Bookmark Feature Removed

          The Text Bookmark feature, which allowed for one to simple markings into the text and then access those markings from a menu in the header bar, has been removed. The Comments & Footnotes inspector tab is more than sufficient for placing markings in the text, and clicking on these notes in the inspector scrolls the editor to that point in the text.

          If you used this feature and have the special inline annotation markings it used still in your text, you will either need to strip them out of the co...

        • Footnote Numbering Off By Default

          In the past, when you compiled your document, all inspector footnotes would be numbered in the order they appeared in the compiled output, and this number would be printed in the upper left-hand corner of each footnote in the inspector. This still happens in the background in Scrivener 3, but the display of the numbers themselves has been disabled as a default. You will need to manually turn it on with the View//Text Editing//Show Compiled Footnote Numbers in Inspector menu toggle.

        • Sync Folders Will Need to be Updated

          If you've been using the File//Sync//with External Folder... feature in prior versions of Scrivener, you should be aware that necessary internal changes have made it so that an existing sync folder will need to be rebuilt from scratch with the new version. The best result will be to sync the project one last time to this folder so that it is fully up to date, before upgrading, and then delete the folder and create a new one after you've upgraded the project in the new version of Scrivener.

        • External Document Links Will Need Updating

          The way in which documents are referred to internally has fundamentally changed in Scrivener 3, and as a result, links pointing to items within projects with the [External Links] feature will need to be updated by hand. We apologise for the inconvenience, but given how these links are located outside of the original project that has been updated, there is no way for Scrivener to know where the original item went.

        • Typewriter Scrolling Now Weaker

          It is typical to boast of things growing stronger, but in this case we'd like to mention a feature getting a little weaker. Typewriter scrolling had one flaw with the idea: it wasn't terribly good for editing. If you were scrolling and clicking into places to fix bits of text, the behaviour to snap the typing line into the middle of the screen wasn't worth leaving on, leaving one to awkwardly toggle the option on and off.

          So in Scrivener 3 the feature now stops forcing you to one line when you ...

        • Project Settings Unified

          In the past, many of a project's settings were scattered throughout different dialogues and menu commands. While most of the view preferences that pertain to a project are still located in the standard View menu, the rest have all been gathered into a single dialogue, accessed [through Project//Project Settings...][Project Settings]. Excluding those settings previously found in the Project//Meta-Data Settings... panel And it is worth noting that a project's global metadata, such as the author an...

        • Project and Text Statistics

          The "Project Statistics" and "Text Statistics" panes have been combined into a single feature, Project//Statistics... (<$custom:shortcut>), with two tabs. The latter now has every feature the former once had exclusively, and vice versa. To get statistics on a single text document, view it in the editor alone and then use the "Selected Documents" tab. You can click on statistics in the footer bar of the editor and get much of the same information provided here.


          • Tip Box

            Compiled draft statistics may alter

            While we're on the topic, it's worth mentioning that you might see a difference in your overall compiled draft count. This is most likely going to be a side-effect of your compile settings having been reset to default when the project was upgraded. If you were using options in version 21 that added a significant amount of text (like for example all of your document notes) then upon checking your word count in version 3 that number will have dropped.


      • Menu Reorganisation

        The application menus, from File to Window, have been completely rethought. We've also introduced two new major menus, "Navigate" and "Insert", the former focussing on project window navigation of all sorts, and the latter now collects all of the various types of things that can be inserted into text, from images to the current date and time. If you make heavy use of the menus in Scrivener, you may more than a few things have been moved around, but hopefully you find the changes to be logical an...

      • Updates to Version 3

        TODO//POST// make sure the formatting of headings in this section are as you want. I did notice the sub-version headings are not in the mini-ToC and it would be nice if they were. We are constantly looking to improve Scrivener. The remainder of this section will document significant changes since its initial 3.0 release in the Autumn of 2017. For a complete list of all modifications and bug fixes, refer to the [release notes page](https://www.literatureandlatte.com/scrivener/release-notes?os=ma...


        • % Override section numbering for subsections in this area.

          \setsecnumdepth{section}

        • Version 3.0.3


          • MultiMarkdown 6 Support

            Scrivener now fully supports MultiMarkdown version 6, and integrates version 6.2.3 in the application. The most noticeable difference will be the removal of the MMD to RTF compile format, which is no longer supported, and the addition of a native OpenOffice ODT format. No longer will you need to compile to Flat XML and use LibreOffice to make the final conversion.

            The other notable difference between MMD 5 and 6 is how the metadata is handled for !LaTeX documents. If you have been using your ow...

          • Default Paragraph Style Removed

            The option to automatically apply a paragraph style to text as you write has been removed from the Project Settings: Formatting pane. Scrivener is designed to work around the concept of not styling body text, and rather leaving it flexible to be transformed by the compiler when exporting. Refer to [Think Different] for further rationale on this decision.

          • LaTeX Compile Support Improved

            For the MultiMarkdown to !LaTeX compile file type, we have added five new compile formats, to make switching between common document classes simpler. With one click you can go from formatting your work in a screen-friendly "Modern" look, to a formal article design. Further documentation on the formats is provided in [MultiMarkdown LaTeX and PDF][formats - tex].

            For those looking to print a simple outline of topics, the "Markdown Outline" compile format now has a better default look when used in...

          • Bulk Keyword Management Improved

            In the past, managing keyword assignments at a large scale was limited to bulk assignment, by dragging keywords from the [Project Keywords pane][Project Keywords Panel] onto selected items in the background window. It is now possible to right-click (or use the GearMenu button) on selected keywords to assign *or remove* keywords from the selected documents in the background.

          • ePub for... Kindle?

            While we continue to recommend the use of the native Kindle Mobi and KF8 formats for publication to Amazon services, in some cases you may find third-party publishing agencies will only accept ePub files. We have added a new option to [the general options tab within the compile overview screen][compile - general options - ebook] to "optimize for Kindle conversion". This will include a few tweaks to the underlying HTML, as well as navigation hints that will make the ePub file convert more cleanl...

          • Create New Compile File Types with Post-Processing

            <$stdOnly> Scrivener can now tap into the command-line capabilities of your system through the use of scripts embedded directly into the compile Format, making it possible to package automated workflows to wider audience who need not know how to set up scripting themselves. In addition, post-processing has been added to the Plain Text compile file type, making it possible to create wholly new file types from scratch and processing them into end formats.

            Refer to [the Processing compile format p...

          • Vellum Export Support

            For those that make use of [Vellum][Vellum homepage] for the final design and production of their books, we have created a compile Format for the DOCX file type. The format has been tuned specifically to produce optimum results when imported into Vellum. More details can be found in [the appendix listing of Scrivener's compile formats][Vellum Export].

          • Better Multivolume Support for Front/Back Matter

            For those who write more than one volume into a single project, the front/back matter feature has been modified to allow for automatic selection of preliminary and ending material, depending on which volume you currently have selected for compile. This can be combined with the already existing feature to automatically switch between front/back matter sets based on the *type* of file being compiled. Refer to [Linking Front/Back Matter to Compile Groups][Front & Back Matter] for tips on setting up...


        • Version 3.0.2


          • Inserting Media Time Stamps

            It is now possible to insert the current time stamp into the text editor, while running audio/visual media in the other split. The menu command (Insert//Media Time Stamp) does not by default have a keyboard shortcut, but [one can be added if you anticipate making heavy use of this feature][Custom Keyboard Shortcuts].

            A new script format (Format//Scriptwriting//Transcript) designed especially for the transcription of audio and video material has been added to the software. It has been set up so ...

          • Reloading Linked Images on the Fly

            Previously, if you made use of [Linked Images] in the main editor, if the image was modified on the disk or in the binder, then you would have to reload the project in order to see changes made to the file. In addition, changes made to the size of the image would not be reflected in the editor, which could cause squishing or squashing. You can now right-click on a linked image in the editor and select "Reload from Original Image" to reload the cached thumbnail from the disk, and reset the size o...

          • Browse the Web from Within Scrivener

            It is now possible to, in a limited fashion, browse the Web from within Scrivener, when starting from a page that is being viewed in the main editors or the Bookmarks preview tab. In the past, all links would load in your main browser. To enable this capability, set the Allow limited navigation in web pages option, in [the Behaviors: Navigation !preference pane][behaviours - navigation].

          • Linked inline images can be updated from disk

            For those working with inline images in the text editor that have been linked, [either to the binder or the file system][Linked Images], if one updated the image data externally they would have to reload the project to have the corresponding graphic updated in the editor. Additionally, images that had their size changed on the disk would *not* update the editor's concept of its size, causing them to appear squashed on reload.

            Both of these problems can now be solved on the fly by [updating the ...


        • Version 3.0.1


          • Imported Markdown documents can be converted to rich text

            When importing Markdown files with the File//Import//Import and Split... menu command, a new option has been provided to convert Markdown syntax into rich text, removing all Markdown syntax in the process. Internally, Scrivener will convert the text to HTML and then import the HTML to RTF format. For simple documents this should suffice, but for more complex texts, using native Markdown conversion engines (such as those provided by MultiMarkdown and Pandoc) will obviously produce the best result...

          • Appearance themes now easily accessible

            Scrivener has supported appearance themes, the ability to change the colours, fonts and other appearance settings throughout the software, for many years. It is now much easier to switch between these themes from the main Scrivener//Themes// menu. Read more about creating themes in [!Preference Presets and Themes].

          • Image size can be requested in percentages for e-books

            When using the [image link placeholder syntax][Image Placeholder Tags], it is now possible to request the size of the image in percentage points, as relative to the size of the screen it will be displayed upon, in addition to any point size measurement used for print-based output. Specifying image size in such terms as "100%", to fill the width of the display, is often more useful than trying to find precisely the right size to display it at, when the shape and scale of the display the e-book is...


        • % Resume subsection numbering

          \setsecnumdepth{subsection}


    • Extras Pack

      A number of examples throughout this manual have been provided for you to work with in a hands-on fashion. There is a downloadable "extras pack" from our website, that you can obtain using the following instructions:

      1. Visit the [User Guides download section on our web page][user manual download].

      2. Beneath "Scrivener" on the left, select the "Extras Pack" option from the "Select Format" dropdown menu.

      3. Click the red download button to the left.

      4. If your browser has not already done s...

    • Credits &`\\`{=latex} Acknowledgements

      NOTE// The messy title here is to correct for awk-ward hyphenation in the output. Do not remove unless chapter heading formatting is modified. **Concept, Interface, Design and Development**

      Keith Blount

      **Additional Design**

      Ioa Petra'ka

      **Documentation**

      Keith Blount

      Ioa Petra'ka

      **PDF Design**

      Ioa Petra'ka

      **Toolbar, Binder and Template Icons**

      Janik Baumgartner

      **Application Icon**

      Janik Baumgartner

      **Code Contributions and Help**

      Many thanks to the following people fo...

    • Markdown Links

      Central list of useful links from throughout the user manual.