'Variables' can be entered into the 'Publication details'. This is a great solution for publishing your specification to 'Separate sections', 'Separate systems' and 'Separate prefixes' because it gives you control over the standard behaviour for fields like the 'Filename'.


'Variables' in 'Publication details' solves the problem of wanting to publish the specification as 'Separate sections' or 'Separare systems' and include the section/ system title in the 'Filename'.


Entering 'Publication details' and saving to the publish history explains the 'Publication details'. This article explains how to enter 'Variables' into the 'Publication details'.


'Variables' can be entered into the 'Publication details', and publishing your specification to 'Separate sections', 'Separate systems' and 'Separate prefixes' can be done with 'Pro' (and above).

Variables can be added to articles, clauses, spec notes, and org notes with 'Premium'. 


How to add a variable

Variables are added using the keyboard shortcut.


To insert a variable:

  1. Click the 'Publication details' field where you want to insert the variable.

  2. Use the keyboard shortcuts:
    • For Windows PC: Shift + ~ (Shift + the Tilde key ‘~’).
    • For Apple Mac: Shift + ~ (Command + the Tilde key ‘~’).

  3. Select the variable from the menu. Either continue typing the variable name or value and select from the filtered list of variables or scroll and select from the list.


Using 'Variables' when publishing 'Separate sections', 'Separate systems and 'Separate 'prefixes'

When publishing your specification to separate documents, by default, the platform will append the 'Section code' or 'System code' to the end of the 'Publication title' and 'Filename'.


You can override this behaviour by defining your naming convention with 'Variables'.


For example, perhaps you want each file to be differentiated by the 'system title' instead of the 'System code'.


Default 'Publication details' values

By default, the platform will suggest the following values in the 'Publication details' fields.


'Publication details' fieldsDefault value
Publication title{specification title}

{specification title}-{section/ system code}
  • The platform will add the section or system code to the end of individual publication titles when publishing 'Separate sections' or 'Separate systems'.
  • You can change this, for example, by inserting the variable for '{section title}' or '{system title}' into the 'Publication title' field after the '{specification title}'.
Publication numberNot defined.
Publication statusNot defined.
Publication revisionNot defined.
Publication notesNot defined.
Filename{project doe}-{specification title}-YYYY-MM-DD

{project doe}-{specification title}-YYYY-MM-DD-{section/ system code}
  • The platform will add the section or system code to the end of individual publication titles when publishing 'Separate sections' or 'Separate systems'.
  • You can change this, for example, by inserting the variable for '{section title}' or '{system title}' into the 'Publication title' field after the '{specification title}'.
Zip filename{project doe}-{specification title}-YYYY-MM-DD


Suggested variables to use in the 'Publication details'

You can use any variables in the 'Publication details' with 'Premium'. With 'Pro' (and above), there are several organization, project, and section- or system-specific variables from which to choose.


Suggested variables for use in the 'Publication details'Details
{organization}
{project code}
{project title}
{project budget cost}
{project category}
{project cliient}
{project location}
{project main contractor}
{project nature}
{project work stage}
{specification title}
{section code} or {system code}
{system full title}The combination of the ‘code’ ‘prefix’ ‘title’ ‘suffix’.
Uniclass - work sections' only.
{system prefix}Uniclass - work sections' only.
{section title} or {system title}
{system suffix}Uniclass - work sections' only.


The yellow highlight indicates the variables that work with publishing 'Separate systems' for Uniclass Work section specifications.


Filenames with special characters

The default filename for each section will be '{project code}-{specification title}-YYYY-MM-DD-{section/ system code}-{unique incrementing identifier}.

  • The filename can be changed. Please see Entering 'Variables' into the 'Publication details'.
  • The {unique incrementing identifier} is added when two or more files have the same filename.
  • Filenames containing special characters
    • It is also important to note that filenames cannot support special characters. Special characters not supported in filenames will be removed., and all spaces will be removed from suffixes.


Publication details contain a missing variable

The message 'Contains a missing variable' is displayed when you attempt to publish your specification as 'One document' and you include section or system variables in the 'Publication details'.


When publishing your specification as 'One document', the platform cannot include a section or system-related information in the 'Publication details'. 


A screenshot of the message 'Contains a missing variable' is shown in the 'Publication details' when the field contains a section or system variable, and you publish the specification as 'One document'.

A screenshot of the message 'Contains a missing variable' is shown in the 'Publication details' when the field contains a section or system variable, and you publish the specification as 'One document'.