Special fields in composed strings

A composed string (such as used in a composite field, an output file specification or a PDF password) can contain embedded field names enclosed in curly brackets e.g. Dear {name}. The value of the field is substituted at the time of invoking the string e.g. when constructing an output file name. As well as the user-defined fields there are certain special ones:

Click to expand/collapse hidden textSpecial composite symbols

_{

An opening curly bracket.

_}

A closing curly bracket.

_back

Value is BACK if on a back page or null if not a back page. Related item: _front.

_bates

The 'bates' page number as defined in the Layout page of the 'Configuration' dialog. Related item: _page.

_bin

The current output bin number. Related item: _tray.

_CR

Carriage Return (character 13 decimal, 0D hex). Related items: _CRLF _LF

_CRLF

Carriage Return & Line Feed (0D0A hex). Related items: _CR, _LF.

_day

Today's day number (1-31). Related item: _month.

_DocAuthor

The name of person who created the document, extracted from a PDF input file.

_DocCreationDate

The date that the document was created, extracted from the PDF input file.

_DocCreator

The name of the program that created the original document extracted from the PDF input file.

_DocKeywords

Keywords for the document, extracted from the PDF input file.

_DocProducer

The name of the program which output the document, extracted from the PDF input file.

_DocSubject

The subject of the document, extracted from the PDF input file.

_DocTitle

The document title, extracted from the PDF input file.

_DocUpdateDate

The most recent update date of document, extracted from the PDF input file.

_ext

Same as _Iext, see below.

_filename

Same as _Ifilename, see below.

_filenum

The current file number within a list of files being processed.

_filepages

The number of pages in a current input file. Valid only for input formats such as PDF, TIFF or DCX where the number of pages can be easily determined.

_front

Value is FRONT if on a front page, otherwise null. Related item: _back.

_GMT

Same as _UTC, see below.

_hour

Time in hours. Related items: _minute, _second.

_id

Unique numeric ID; used to construct the default output file name: {_title}{id}

_Iext

The original (Input) file extension, including the 'dot'. Related item: _Oext.

_Ifilename

The full Input file name. Related item: _Ofilename.

_IgnoredImages

A count of the number of images that were ignored by ticking the General Configuration option 'Ignore images'.

_Iname

The file name stem of the original (Input) file. Related items: _Oname, _Mname.

_Ipath

The full path of the original (Input) file. Related items: _Opath, _Mpath

_LF

Line Feed (character 10 decimal, 0D hex). Related items: _CR, _CRLF.

_local

Subsequent times are 'local'; the default time is specified in Universal Coordinated Time.

_Mext

The Main file extension. Related items: _Mname, _Mpath

_minute

Time in minutes. Related items: _hour, _second.

_Mname

For a List Of Files this is the Main (LOF) file name; note that _Iname is the current Input file name, see above. Related items: _Mext, _Mpath

_month

Today's month number (1-12). Related item: _day.

_Mpath

For a List Of Files this is the full path of the Main (LOF) file;  note that _Ipath is the current Input file's full path, see above. Related items: _Mext, _Mname

_name

Same as _Iname, see above.

_numpages

_Oext

The Output file extension, including the 'dot'. Related item: _Iext.

_Ofilename

The full Output file name. Related item: _Ifilename.

_Oname

The file name stem of the Output file. Related item: _Iname.

_Opath

The full path of the Output file. Related item: _Ipath.

_orient

The orientation of the page.

_page

The current page number. Related items: _bates, _sheets, _sides.

_paper

The name of the paper used for the page e.g. LETTER.

_path

Same as _Ipath, see above.

_PJL_

This is a special construct for extracting data from PJL commands: see PJL note, below.

_plugins

The folder containing the plugins.

_RT

This is defined by the value from the @PJL COMMENT REDTITAN DIR value. See also Preamble and PJL options.

_RTid

Returns the RedTitan PC ID.

_RTini

The full path (including the file name) of the RT.INI file.

_second

Time in seconds. Related items: _minute, _hour.

_SetPages

The number of pages in the current set.

_sheets

The number of pieces of paper that have been output. Related items: _page, _side.

_side or _sides

The current side number starting at 1. Related items: _page, _sheets.

_title

The job title; used to construct the default output file name: {_title}{_id}

_tray

The current input tray number. Related item: _bin.

_UTC

Subsequent times are in Universal Coordinated Time. Related item: _local.

_year

Today's year number. Related item: _month.

All these special 'symbols' start with the "underscore" character, followed by characters that may be in upper, lower or mixed case. The underscore characters are to distinguish predefined fields from those defined by the user, but may be omitted if there are no user-defined fields with conflicting names.

Click to expand/collapse this hidden textPJL note

{_PJL_OUTPAPER}

@PJL SET OUTPAPER LETTER

Click to expand/collapse this hidden textExamples
{_GMT}{_day}/{_month}/{_year} is a Greenwich Mean Time date in European format.
{_Local}{_Month}/{_Day}/{_Year} is a local date in U.S.A. format.
{_local}{_hour}:{_minute}:{_second} is a local time.