Publication configuration directives and environment variables
The publication configuration file contains a number of required and optional configuration directives. This file is used during the publish process as a parameter for LiveContentPublish. In addition, a number of environment variables control the publication generation process.
Required directives
OutputDBName-
Description: The unique identifier of the publication: an alphanumeric string containing no special characters other than underscores (_).
Example value:
bike XMLInputDirectory-
Description: The location of all XML input files, including all data modules and the publication module.
Example value:C:\Users\johndoe\LiveContentData\publications\bike\source_xml(Windows)/opt/XyEnterprise/LiveContentData/publications/bike/source_xml(Linux)
PubModule-
Description: The file name of the publication module. This publication module must be stored in the directory referred to by
XMLInputDirectory.Example value:
PMC-BICYCLE.xml OutputDirectory-
Description: The location in which to place the publication content that LiveContent S1000D Publishing Server produces.
Example value:C:\Users\johndoe\LiveContentData\publications\bike(Windows)/opt/XyEnterprise/LiveContentData/publications/bike(Linux)
-
TempDirectory -
Description: A temporary directory used to build the publication content. This folder should be empty.
Example value:C:\Users\johndoe\LiveContentData\publications\bike\temp(Windows)/opt/XyEnterprise/LiveContentData/publications/bike/temp(Linux)
LogFileLocation-
Description: The log file name (with a complete path) in which to write the logs for this publication. The recommended value for this is the same as for
OutputDirectory, with the log file name appended to it.Example value:C:\Users\johndoe\LiveContentData\publications\bike\gen.txt(Windows)/opt/XyEnterprise/LiveContentData/publications/bike/gen.log(Linux)
DTDType-
Description: The DTD type of the publication.
Example value:
S1000D ParserType-
Description: The name of the parser configuration file to use. The parser configuration file (say, s1000d.conf) must be kept in the same directory as this publication configuration file.
Example value:
S1000D ExtraConfig-
Description: The location of a configuration file for the parser type, located in the LiveContent S1000D program files configuration directory.
Example value:C:\Program Files\LiveContent\templates\conf\system\s1000d.xml(Windows)/opt/XyEnterprise/LiveContent/s1000d.xml(Linux)
WriteXML-
Description: If set to 1, and if an environment variable of the same name is also set, this setting causes XML versions of PDOM files to be written to your publication directory for debug purposes when the
LiveContentPublishtool is run. Do not set this variable to 1 in a production environment.This setting causes XML versions of PDOM files
Example value:
1 DebugMode-
Description: If set to 1, this setting generates XML versions of PDOM files, which is intended to help in debugging.
Example value:
1
Optional directives
ExpandRefPm-
Description: If set to 1, this setting expands
<refpm>references at publish time. This setting is specific to S1000D.Example value:
1 ExpandRefDmForWCN-
Description: If set to 1, this setting expands references for warnings, cautions and notes. This setting is specific to S1000D.
Example value:
1 UseTechname-
Description: If set to 1, the techname is used in a document's title. This setting is specific to S1000D.
Example value:
1 TitleDelimiter-
Description: If
UseTechnameis set to 1,TitleDelimiterspecifies a character to use between the infoname and techname. This setting is specific to S1000D.Example value:
- TitleOrder-
Description: If
UseTechnameis set to 1,TitleOrderputs the techname before the infoname (value 1) or the infoname before the techname (value 0) in the S1000D title. This setting is specific to S1000D.Example value:
1 TocTitleDisplay-
Description: If
TocTitleDisplayis set to 1, only theinfonameappears as theTitlein the TOC of your IETP; if set to 2, only thetechnameappears; if set to blank or any value other than 1 or 2, both theinfonameandtechnameappear. This setting is specific to S1000D.Example value:
1 pdf.remove_images-
Description: If set to 1, this setting turns off default CGM handling in PDF output.
Example value:
1 EntityDefLocation-
Description: The location of a directory that contains any entity files required for the data set being passed to the LiveContent S1000D Publishing Server, which references this local library before trying to find entity files on the internet.
Example value:C:\Users\johndoe\LiveContentData\Entity_Library(Windows)/opt/XyEnterprise/LiveContentData/Entity_Library(Linux)
IncludeISOEntities-
Description: If set to 1, this setting resolves all named entities using the entity files located in the directory referenced by
EntityDefLocation.Example value:
1 CIRApplicResolve- Description: If set to 1, this setting enables processing of CIR warnings, cautions, and applicability by LiveContentPublish. The default value is 1.
ACTCatalogModule- Description: Stores the exported file name of the ACT Catalog DM. This is the CSDB object name with a prefix of DMC- and the .xml file extension.
Example value: DMC-S1000DBIKE-AAA-D00-00-00-00AA-0A3A-D_EN-US.xml
Environment variables
WriteXML-
Description: If set to the value 1, and if the directive by the same name is set to 1, this environment variable causes XML versions of PDOM files to be written to your publication directory for debug purposes when the
LiveContentPublishtool is run. Do not set this variable in a production environment.Example value:
1