Customizer's Guide > Customizing Publishing Rules > Publishing Rule Set Parameters
  
Publishing Rule Set Parameters
Rule set parameters are stored in the rule set's definition in its rule file. The publishing rule set parameters control how paths are handled, directory naming conventions for multiple rules, and generating logs and manifest files. Rule set parameter values may contain several variables, defined as follows:
• %n is the publishing rule name
• %u is a discretionary sequential numbering applied by a rule set processor to ensure a directory name is unique. %u is an empty string when a rule runs alone.
• %s is the period with file extension for a published output file (whether or not it’s accompanied by a directory of referenced content), as specified by the rule’s rule.outputSuffix parameter value. If the rule produces a directory, %s is the empty string.
When a rule set is executed, the publishing rule processor substitutes the appropriate value for these variables in each rule set parameter. To specify a literal % in your parameter value, use %%.
Rule Set Parameters
Parameter Name
Parameter Values
absoluteManifestPaths
Determines whether paths to output files and directories are specified in the manifest file as absolute or relative paths, if a manifest file is generated (see generateManifest).
If set to on, paths to output files and output directories in the rule set manifest will be specified as absolute paths.
If set to off (the default), paths to output files or directories in the rule set manifest will be specified as relative paths. The paths will be relative to the top level directory for the rule set.
Paths to files or directories that are outside the rule set's output directory will always be specified as absolute paths.
generateManifest
Determines whether a manifest file is generated for the output of a rule set.
If set to yes, manifest.xml is written to the top level rule set output directory, which lists the results of the rule set execution.
If set to no (the default), a manifest file is not generated.
generateRuleLogs
Determines whether each rule in a rule set will generate a rule log.
If set to yes, then every rule in the rule set will generate a rule log.
If set to no (the default), then each rule in the set will generate a log according to the value of its rule.generateLog parameter.
outputMode
This parameter has the value separate, which means the output for each rule in a rule set is placed in a separate directory.
outputModePattern
Specifies the string to be used in constructing an output directory for a rule in a rule set.
The default is rule-%n%u.
For example, if set to output%u, each output directory would be named ouputn (output0, output1, output2 and so on).
outputTarget
This parameter specifies the directory where the rule set output will be written.
The default is ruleset-%n, where %n is the rule set name.
It may be an absolute or relative path.
ruleTargetOverride
Determines whether to override the rule.outputTarget parameter of each rule in the rule set, and replace it with the value of ruleTargetPattern.
If set to yes, then each rule parameter value for rule.outputTarget is replaced by the value of the rule set parameter ruleTargetPattern.
If set to no (the default), then the rule.outputTarget for the rule is obeyed.
For example, if a rule is named rule23, and the rule set specifies ruleTargetPattern as output-%n, specifying yes means that output-rule23 will be substituted as the output directory.
ruleTargetPattern
Specifies the value to replace each rule’s rule.outputTarget parameter, if ruleTargetOverride is also set to yes.
The default is %n%u%s.
For example, if a rule is named rule23, and ruleTargetPattern is set to output-%n and ruleTargetOverride is set to yes, output-rule23 will be substituted as the output directory.