-
Notifications
You must be signed in to change notification settings - Fork 6
The campaign.json File
Joe Snee edited this page Sep 9, 2019
·
1 revision
The campaign.json
file is kept in the .dmbinder
folder and specifies the following attributes for your campaign:
- campaignName: The name of your campaign
- sourcePaths: A list of paths to files and/or folders containing the campaign documents.
- templatePaths: A list of paths to files and/or folders containing the template files.
- componentPaths: A list of paths to files and/or folders containing the component files.
- generatorPaths: A list of paths to files and/or folders containing the generator configuration files.
- outDirectory: A path to a directory to output PDF files when rendered. If omitted, PDF files will be placed in the same directory as the source file it was generated from. (for more information, see PDF rendering.)
NOTE: Any relative paths (paths starting with "./") used in the campaign.json
file are relative to the campaign root folder (the folder that the .dmbinder
folder is in, not relative to the .dmbinder
folder itself).
Below is an example Campaign configuration file:
{
"campaignName": "My Cool Campaign",
"sourcePaths": [
"./source/"
],
"templatePaths": [
"./templates/"
],
"componentPaths": [
"./components/"
],
"generatorPaths": [
"./generator-sources"
],
"outDirectory": "./out/"
}