<$template_firstName>

User’s forename of first name as set in Address Book.

<$template_lastName>

User’s surname or last name as set in Address Book.

<$template_fullName>

User’s full name, from Address Book or account settings.

<$template_initial>

First letter of user’s forename, as set in Address Book.

<$template_street>

User’s street name, taken from Address Book.

<$template_city>

User’s city or town, taken from Address Book.

<$template_state>

User’s state or county, taken from Address Book.

<$template_ZIP>

User’s ZIP or postcode, taken from Address Book.

<$template_country>

User’s country, taken from Address Book.

<$template_phoneNumber>

User’s phone number, taken from Address Book.

<$template_email>

User’s e-mail address, taken from Address Book.

<$template_projectName>

The project title, derived from the project file name.

Page Numbers

<$p>

When used in the header or footer, gets replaced with the current page number.

When used in the main text and it has a Scrivener link associated with it, the <$p> tag will be replaced with the page number on which the linked document appears if possible.

<$p-r>

<$P-R>

When used in the header or footer, gets replaced with the current page number as Roman numerals (use <$p-r> for lowercase Roman numerals and <$P-R> for uppercase Roman numerals). Unlike <$p>, which can show negative numbers for front pages, Roman numerals always start at “i”.

Mainly intended for use on front matter pages. Note that these tags are only available for printing and exporting to PDF - they will be ignored by other formats.

<$pagecount>

When used in the header or footer, gets replaced with the page count (note that this tag only works in headers and footers).

Headers and Footers

Not all tags are supported in headers and footers. In addition to the special header and footer tags specified below (which can only be used in headers and footers), only the tags listed under the sections Page Numbers, Current Date and Time, and User and Project Information are supported in headers and footers.

<$sectiontitle>

When printing or exporting to PDF format, the “<$sectiontitle>” tag gets replaced with the title of the document that first comes after the page break most recently preceding the header or footer in which it occurs. In practice, this is useful for placing chapter titles in headers or footers. For instance, if you have a chapter in a single text document starting on a new page, then that document’s title will replace “<$sectiontitle>”; if your chapters are broken down into smaller sections placed inside folders, and the folders mark the start of each new chapter, then the folder’s title will replace “<$sectiontitle>” throughout the chapter headers and footers.

When exporting to RTF or Word, <$sectiontitle> will be replaced with the abbreviated project title, working exactly the same as “<$abbr_title>” - see User and Project Information for details on where the abbreviated project title is drawn from.

Comments, Footnotes and Layout

<$--ENDNOTES-->

Tells the compiler where to place the endnotes. If this tag is not present, the endnotes will get placed at the end - this tag just provides a way to customise the placement of the endnotes. (Note that this tag cannot be used with script, MultiMarkdown or e-book formats, and can only be used with RTF if “Flatten footnotes…” is selected in the Layout compile options.)

<$—COMMENTS-->

Tells the compiler where to place linked comments. If this tag is not present, linked comments will be placed at the end of the text before any endnotes. Note that this tag can only be used with the HTML format.

<$BLANK_PAGE>

Tells the compiler to leave this page blank. At the end of compiling the text, Scrivener goes through looking for potentially blank pages and removes them, but if it finds this tag on an otherwise blank page, it just removes the tag and leaves the page blank.

Document  Variables

Document variable tags can be placed anywhere inside the text of a document (note that they cannot be used in the Compile panel’s header and footer fields).

<$title>

Gets replaced with the document title during the Compile process (that is, the title of the document in the binder in which this tag occurs).

<$parenttitle>

Gets replaced with the title of the parent of the document (e.g. the folder in which the document is contained).

<$title_no_spaces>

The same as <$title>, but strips all spaces from the title. Potentially useful for compound tags.

<$parenttitle_no_spaces>

The same as <$parenttitle>, but strips all spaces from the parent title. Potentially useful for compound tags.

<$position>

Gets replaced with the position number of the document within its parent folder or container. Potentially useful for compound tags.

<$parentposition>

The same as <$position>, except uses the position of the parent within its parent folder or container. Potentially useful for compound tags.

<$label>

Gets replaced with the name of the document label during the Compile process.

<$status>

Gets replaced with the name of the document status during the Compile process.

<$keywords>

Gets replaced with a list of keywords associated with the document during the Compile process.

<$synopsis>

Gets replaced with the document synopsis during the Compile process.

<$linecount>

Gets replaced with the line count of the document during the Compile process. (If associated with a Scrivener link, the line count will show the number of lines in the linked document.)

<$revision>

Gets replaced with the revision number of the document. (The revision number is the number of snapshots associated with the document plus one.)

<$createdDate>

<$shortCreatedDate>

<$mediumCreatedDate>

<$longCreatedDate>

<$fullCreatedDate>

Gets replaced with the created date of the document, using one of the formatting styles specified in the System Preferences. (Note that <$createdDate> is the same as <$shortCreatedDate>).

<$createdTime>

<$shortCreatedTime>

<$mediumCreatedTime>

<$longCreatedTime>

<$fullCreatedTime>

Gets replaced with the created time of the document, using one of the formatting styles specified in the System Preferences. (Note that <$createdTime> is the same as <$shortCreatedTime>).

<$modifiedDate>

<$shortModifiedDate>

<$mediumModifiedDate>

<$longModifiedDate>

<$fullModifiedDate>

Gets replaced with the modified date of the document, using one of the formatting styles specified in the System Preferences. (Note that <$modifiedDate> is the same as <$shortModifiedDate>).

<$modifiedTime>

<$shortModifiedTime>

<$mediumModifiedTime>

<$longModifiedTime>

<$fullModifiedTime>

Gets replaced with the modified time of the document, using one of the formatting styles specified in the System Preferences. (Note that <$modifiedTime> is the same as <$shortModifiedTime>).

<$custom:…>

Can be used to insert custom meta-data in the draft. For instance, if you have added a custom meta-data field entitled “Locations” to your project, “<$custom:Locations>” will get replaced with the information in the Locations field for the document during the Compile process.

Current Date and Time

<$date>, <$shortdate>

Gets replaced with the current date during the Compile process, using the short date format defined in the user’s System Preferences.

<$mediumdate>

Gets replaced with the current date during the Compile process, using the medium date format defined in the user’s System Preferences.

<$longdate>

Gets replaced with the current date during the Compile process, using the long date format defined in the user’s System Preferences.

<$fulldate>

Gets replaced with the current date during the Compile process, using the full date format defined in the user’s System Preferences.

<$time>, <$shorttime>

Gets replaced with the current time during the Compile process, using the short time format defined in the user’s System Preferences.

<$mediumtime>

Gets replaced with the current time during the Compile process, using the medium time format defined in the user’s System Preferences.

<$longtime>

Gets replaced with the current time during the Compile process, using the long time format defined in the user’s System Preferences.

<$fulltime>

Gets replaced with the current time during the Compile process, using the full time format defined in the user’s System Preferences.

<$year>

Gets replaced with the current year during the Compile process.

User and Project Information

<$surname>, <$lastname>

Gets replaced with the user’s surname or last name during the Compile process. The information is taken from the “Project Properties” in the Project > Meta-Data Settings panel or, if that is blank, from the user’s Address Book. If the tag appears in uppercase, the surname will be uppercased too.

<$forename>, <$firstname>

Gets replaced with the user’s forename or firstname name during the Compile process. The information is taken from the “Project Properties” in the Project > Meta-Data Settings panel or, if that is blank, from the user’s Address Book. If the tag appears in uppercase, the forename will be uppercased too.

<$initial>

Gets replaced with the first letter of the user’s forename during the Compile process.

<$username>, <$name>, <$fullname>

Gets replaced with the user’s full name during the Compile process. The information is taken from the “Project Properties” in the Project > Meta-Data Settings panel or, if that is blank, from the user’s Address Book. If the tag appears in uppercase, the user’s name will be uppercased too.

<$compilegroup>

Gets replaced with the name of the group currently being compiled (as selected in the “Contents” pane of the Compile sheet). If the tag appears in uppercase, the name will be uppercased too.

<$draftname>

Gets replaced with the title of the Draft folder during the Compile process. If the tag appears in uppercase, the title will be uppercased too.

<$projecttitle>, <$projectname>

Gets replaced with the project name during the Compile process. The project name is taken from the “Project Properties” in the Project > Meta-Data Settings panel or, if that is blank, from the file name of the Scrivener project. If the tag appears in uppercase, the project name will be uppercased too.

<$abbr_projecttitle>, <$abbr_projectname>

Gets replaced with the abbreviated project name during the Compile process. The abbreviated project name is taken from the “Project Properties” in the Project > Meta-Data Settings panel or, if that is blank, from the file name of the Scrivener project. If the tag appears in uppercase, the abbreviated project name will be uppercased too.

Statistics

<$wc>

Gets replaced during the Compile process with the total word count of the text currently being compiled.

<$wc50>

Gets replaced during the Compile process with the total word count of the text currently being compiled, rounded to the nearest 50 words.

<$wc100>

Gets replaced during the Compile process with the total word count of the text currently being compiled, rounded to the nearest 100 words.

<$wc500>

Gets replaced during the Compile process with the total word count of the text currently being compiled, rounded to the nearest 500 words.

<$wc1000>

Gets replaced during the Compile process with the total word count of the text currently being compiled, rounded to the nearest 1000 words.

<$cc>

Gets replaced during the Compile process with the total character count of the text currently being compiled.

<$cc50>

Gets replaced during the Compile process with the total character count of the text currently being compiled, rounded to the nearest 50 characters.

<$cc100>

Gets replaced during the Compile process with the total character count of the text currently being compiled, rounded to the nearest 100 characters.

<$cc500>

Gets replaced during the Compile process with the total character count of the text currently being compiled, rounded to the nearest 500 characters.

<$cc1000>

Gets replaced during the Compile process with the total character count of the text currently being compiled, rounded to the nearest 1000 characters.

Auto-Numbering

<$n>

Gets replaced with Arabic numerals during the Compile process. The number is incremented each time a <$n> tag is encountered in the text, so “<$n>, <$n>, <$n>” would become “1, 2, 3” in the compiled text.

<$sn>

The same as <$n> but intended to be used for sub-numbering. The count restarts each time an <$n> tag is encountered. Thus, “<$n> (<$sn>, <$sn>), <$n> (<$sn>, <$sn>)” would become “1 (1, 2), 2 (1, 2)” in the compiled text.

<$r>

Gets replaced with lowercase Roman numerals during the Compile process. The number is incremented each time a <$r> tag is encountered in the text, so “<$r>, <$r>, <$r>” would become “i, ii, iii” in the compiled text.

<$R>

Gets replaced with uppercase Roman numerals during the Compile process. The number is incremented each time a <$R> tag is encountered in the text, so “<$R>, <$R>, <$R>” would become “I, II, III” in the compiled text.

<$l>

Gets replaced with lowercase outline (alphabetical) numbering during the Compile process. The number is incremented each time an <$l> tag is encountered in the text, so “<$l>, <$l>, <$l>” would become “a, b, c” in the compiled text.

<$L>

Gets replaced with uppercase outline (alphabetical) numbering during the Compile process. The number is incremented each time an <$L> tag is encountered in the text, so “<$L>, <$L>, <$L>” would become “A, B, C” in the compiled text.

<$w>

Gets replaced with numbers as lowercase words (using the current language settings) during the Compile process. The number is incremented each time a <$w> tag is encountered in the text, so “<$w>, <$w>, <$w>” would become “one, two, three” in the compiled text.

<$t>

Gets replaced with numbers as title-case words (using the current language settings) during the Compile process. The number is incremented each time a <$t> tag is encountered in the text, so “<$t>, <$t>, <$t>” would become “One, Two, Three” in the compiled text.

<$W>

Gets replaced with numbers as uppercase words (using the current language settings) during the Compile process. The number is incremented each time a <$W> tag is encountered in the text, so “<$W>, <$W>, <$W>” would become “ONE, TWO, THREE” in the compiled text.

<$hn>

Gets replaced during the Compile process with hierarchical numbering based on the level of the document in which the tag occurs relative to the Draft folder or compile group (depending on the current compile settings). So occurrences of the <$hn> tag in the second document in the Draft folder may get replaced with the number “2”; occurrences of the tag in the third subdocument of the eight document in the Draft folder may be replaced with “8.3”.

Restarting auto-numbering streams:

<$rst>, <$rst_…>

Place <$rst> immediately before any of the auto-numbering tags to restart the numbering. So, for instance, “<$w>, <$w>, <$w>, <$rst><$w>, <$w>” would become “one, two, three, one, two” in the compiled text. Alternatively, you can place <$rst_X> anywhere in the text, replacing the “X” with the letter used in the auto-numbering tag you wish to restart. E.g. <$rst_R> would restart the uppercase Roman numeral auto-numbering from that point onwards.

Using named auto-numbering streams:

<$n:…>, <$w:…>

You can assign names to any of the auto-numbering variables to create unique streams by inserting a colon and any name of your choosing between the auto-numbering letter and the final bracket. For instance, you could use “<$t:part>” (where “part” is the name you have chosen) as the auto-numbering tags for the titles of parts in a book, and “<$t:chapter>” for the chapters.  In this example, the text “Part <$t:part>, Chapter <$t:chapter>, Chapter <$t:chapter>, Chapter <$t:chapter>, Part <$t:part>, Chapter <$t:chapter>,  Chapter <$t:chapter>” would result in “Part One, Chapter One, Chapter Two, Part Two, Chapter Three, Chapter Four” in the compiled text.

Figure and table numbering:

<$n:table:myTableName>

<$n:figure:myFigureName>

You can create special auto-numbering tags that include a name and a keyword to enable you to refer back to auto-numbers, for instance for referring to tables and figures. The format of such auto-numbering tags is this:

<$[auto-number-type]:[name]:[keyword]>

Subsequent instances of tags that use the same auto-number type, name and keyword will be replaced with the same number as was generated for the first instance of that combination; only tags that have a different keyword will cause the number to be incremented. This is best explained with an example:

[An image]

Figure <$n:figure:myImage>

[Another image]

Figure <$n:figure:nextImage>

[A table]

Table <$t:table:myTable>

See Figure <$n:figure:myImage>, Figure <$n:figure:nextImage> and Table <$t:table:myTable>.

When compiled, this will result in the following:

[An image]

Figure 1

[Another image]

Figure 2

[A table]

Table One

See Figure 1, Figure 2 and Table One.

Note how the tag “<$n:figure:myImage>” occurring later in the text was replaced with the same number (“1”) generated for the first instance of that tag.

Using names and keywords in auto-numbering tags can thus allow you to refer back to table and figure numbers.

Restarting tagged auto-numbering streams:

<$rst_KEYWORD>

You can restart one of the tagged auto-numbering streams by using the <$rst_KEYWORD> tag anywhere before an occurrence of one of the tags. For instance, <$rst_imageNumber> would restart tags such as <$n:imageNumber> or <$n:imageNumber:myImage>.

Compound tags

You can create compound tags by using other tags inside the tagged auto-numbering or figure and table numbering. For instance, it is possible to use “<$n:figure:<$parentposition>>” as a valid figure auto-numbering tag, because the document variables such as <$parentposition> will get replaced before the auto-numbering variables.

Making tags more readable

You can use the Compile sheet’s “Replacements” pane to make compound and other tags more readable while you are writing your text. For instance, in the Stageplay UK project template, act and scene numbers appear in the text as “ACT [N] SCENE [R]”. This phrase is then replaced in the Compile sheet’s replacement pane with “ACT <$R:ACT:<$PARENTPOSITION>> SCENE <$N:<$PARENTPOSITION>>”. This allows each scene to reference its act number, because a folder is used to hold the scenes of each act, so “<$PARENTPOSITION>” can be used to give each act a unique tag. The result is this: “ACT I SCENE 1”, “ACT I SCENE 2”, ACT I SCENE 3”, “ACT II SCENE 1”, “ACT II SCENE 2”, and so on.