Customizer's Guide > Customizing Publishing Rules > Publishing Rule Parameters
  
Publishing Rule Parameters
Publishing rule parameters are stored in the rule’s definition in its rule file. The publishing rule parameters control the names of output files or directories and whether to generate log files for the publishing rule. Rule 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 executes, the publishing rule processor substitutes the appropriate value for these variables in each rule parameter. To specify a literal % in your parameter value, use %%.
Publishing Rule Parameters
Parameter Name
Parameter Values
rule.generateLog
Determines whether a rule will generate a rule log .rulelog.xml
If set to yes, then the rule will generate a rule log.
If set to no (the default), then no log is generated.
The rule set parameter generateRuleLogs can override this parameter.
rule.outputSuffix
Specifies the file extension used for published files. Specific types of output have default file extensions, so this parameter would be used to override the default values or supply a value for a rule with no default file extension for its output.
These files extensions are used as the default values for publishing:
.pdf for PDF
.htm for HTML
.rtf for exporting to RTF
.ps for PostScript
.chm for HTML Help
.xml for publishing using XSL
Publishing for Web produces an output directory.
rule.outputTarget
This parameter specifies the file or directory where the published output will be written for a publishing rule.
The default is %n%u%s.
It may be an absolute or relative path.
The ruleTargetPattern and ruleTargetOverride for a rule set can override this parameter.