(v13) OptionalContentOptions parameters

This page applies to Harlequin v13.1r0 and later; and to Harlequin Core but not Harlequin MultiRIP.

The OptionalContentOptions PDF parameter allows you to fine tune which OptionalContent groups the RIP prints. The entries that can be used in the OptionalContentOptions dictionary in a dictionary of PDF parameters are as follows:

`/BaseState`	(/ON or /OFF, optional), specifies the base visibility of all OCGs. This parameter is ignored when /Config is specified. When /BaseState is in use, no settings are taken from the job’s /D default OCCD.
`/Config`	(string, optional), specifies the name of an optional content configuration dictionary to use instead of /D. An error is reported if this OCCD is not in the job.
`/Event`	(/Print, optional), specifies that the /Print category from the Usage Dictionary should be applied for each group. This allows the RIP to emulate the manner in which Adobe Acrobat and other PDF file viewers (as defined by the PDF1.5 spec.) print PDF files with optional content. This is when Acrobat is printing (and not viewing), which is simulated by selecting the Acrobat layer option Apply Print Overrides. It is an error if the job does not contain the OCCD.

/IgnoreParentVisibility (boolean, optional), if true OCGs that are explicitly made visible using/ProcSteps or /ON will be visible, even when they are nested within hidden OCGs. The default value is false.

`/ON`	(array of strings, optional), the names (in string form) of optional content groups to show. A warning is issued if the OCGs are not found in the job.
`/OFF`	(array of strings, optional), the names (in string form) of optional content groups to hide. A warning is issued if the OCGs are not found in the job.
`/ProcSteps`	(`/ON` , `/OFF` or dictionary, optional), controls the visibility of OCGs via any GTS_Metadata tagging. If `/ON` or `/OFF` then all OCGs which are tagged with a GTS_ProcStepsGroup will be shown/hidden. If a dictionary, then its keys are GTS_ProcStepsGroup names, and its values are: `/ON` to show all OCGs which are tagged with that GTS_ProcStepGroup `/OFF` to hide all OCGs which are tagged with that GTS_ProcStepGroup a dictionary whose keys are GTS_ProcStepsType names and whose values are `/ON` or `/OFF` to show / hide all OCGs which are tagged with that GTS_ProcStepsGroup and GTS_ProcStepsType. The key `/GGS_AllProcGroups` can be used in place of a GTS_ProcStepsGroup name with the values /ON and /OFF to show / hide all OCGs which are tagged with a GTS_ProcStepsGroup. The key `/GGS_AllProcTypes` can be used in place of a GTS_ProcStepsType name with the values /ON and /OFF to show / hide all OCGs which are tagged with a given GTS_ProcStepsGroup name. The key `/GGS_NonProcSteps` can be used in place of a GTS_ProcStepsGroup name with the values `/ON` and `/OFF` to show / hide all OCGs which are not tagged with a GTS_ProcStepsGroup. The ProcSteps controls will turn on or off the visibility of Processing Steps OCGs. Processing Steps set to /ON are not visible unless either all enclosing OCGs are visible, or `/IgnoreParentVisibility` is `true`. When using a dictionary value for the ProcSteps key, entries are processed from least to most specific; for example, the following makes just the “Structural” Processing Steps visible and excludes those of the “Creasing” type: TEXT `/ProcSteps << /GGS_AllProcGroups /OFF /Structural << /Creasing /OFF /GGS_AllProcTypes /ON >> /GGS_NonProcSteps /OFF >>`
`/SuppressPage`	(Boolean, optional), if `true` do not show the job’s non-optional content.

Example:

TEXT

            <<
              /OptionalContentOptions
              <<
                /Config (SpecialInk)
                      % use the (SpecialInk) Optional Content Configuration dictionary
                      % instead of the /D OCCD from /OCProperties in the /Catalogue dictionary
                /Event /Print
                      % emulate Acrobat ApplyPrint Overrides
                /ON [(SpecialMarks)(CutLines)]
                      % turn ON the (SpecialMarks) and (CutLines) groups, overriding the state
                      % that was set by /Event and /Config.
                /OFF [(StaplePositions)]
                      % turn OFF the (StaplePositions) group, overriding the state that was set
                      % by /Config, /Event and /ON.
                /SuppressPage true
                      % suppress normal page content
              >>
            >> setpdfparams

The order of application of these settings when determining OCG visibility is:

/Config
/BaseState (only if /Config has not been specified)
/D ( only if neither /Config nor /BaseState has been specified)
/Event ( ignored if /BaseState has been specified)
/ProcSteps
/ON
/OF