System settings

You can modify the content, path, common, plugin, and template settings in the .ewizard/settings.json file.

{
    "content": {
        "type": "edetailer",
        "subtype": ""
    },
    "screenshoter": {
        "slideWithCommonLayout": ""
    },
    "path": {
        "blocks": "node_modules/@blocks",
        "blocksFilename": "blocks.json",
        "blocksManifest": "common/blocks-library/blocks.json",
        "blocksThemes": "common/blocks-library/blocks-themes.json",
        "localBlocks": "common/blocks",
        "componentsFilename": "components.json",
        "componentsManifest": "common/components/components.json",
        "componentsThemes": "common/components/components-themes.json",
        "localComponents": "common/components",
        "modulesFilename": "modules.json",
        "modulesManifest": "common/blocks-library/modules.json",
        "bundle": "build/dev/app.js",
        "rootComponent": "App.vue",
        "slides": "slides",
        "themes": "themes",
        "themePaths": {
            "variables": "theme.scss",
            "variablesJson": "theme.json",
            "main": "index.scss"
        },
        "themesManifest": "themes/themes.json",
        "settings": "settings.json",
        "icon": "icon.png",
        "icon2x": "icon@2x.png",
        "preview": "preview.jpg",
        "assets": ".ewizard/assets.json",
        "claims": "common/resources/claims.json",
        "documents": "documents.json",
        "layouts": "layouts",
        "slide": {
            "thumbnail": "media/images/thumb.jpg",
            "screenshot": "media/images/screenshot.jpg",
            "thumbnails": "media/images/thumbs",
        },
        "common": {
            "i18n": "common/i18n",
            "references": "common/resources/references.json",
            "footnotes": "common/i18n/footnotes.json",
            "media": {
                "images": "common/media/images",
                "videos": "common/media/videos",
                "pdfs": "common/media/pdfs",
                "fonts": "common/media/fonts"
            },
            "triggeredEmailManifest": "common/resources/triggeredEmail.json"
        },
        "metadata": {
            "purpose": "common/metadata/purpose.json",
            "targetMessenger": "common/metadata/targetMessenger.json"
        },
        "icons": {
            "blocks": "common/icons/blocks"
        }
    },
    "archive": {
        "ignore": []
    },
    "cli": {
        "identifyComponents": true,
        "npm": {
            "version": "latest"
        }
    },
    "template": {
        "url": "https://git.qapint.com/ewizardjs/templates/edetailer",
        "version": "5dedb20a01fd5dc2ee129c6087cb0eab561cd58e"
    }
}

The .ewizard/settings.json file has the following fields:

Field	Description
content.type	The project type. To create an e-Detailer brief, enter brief as the project type and edetailer as the subtype.
content.subtype	The content subtype. To create an e-Detailer brief, enter edetailer as the subtype and brief as the type.
screenshoter.slideWithCommonLayout	Enter the slide ID to generate all states of e-Detailer common components in that slide. For more information, see PDF Export settings.
path.blocks	The directory where the blocks are stored. For more information, see Blocks in eWizard.js projects.
path.blocksFilename	The name of the file that defines which blocks appear on the elements panel in eWizard Editor.
path.blocksManifest	The path to the file that defines which blocks appear in eWizard Editor.
path.blocksThemes	The path to the file where you can configure which blocks you want to display for the specific theme on the Blocks tab in eWizard Editor. For more information, see Define theme-based blocks.
path.localBlocks	The directory where the local blocks are stored.
path.componentsFilename	The name of the file that defines which components appear on the elements panel in eWizard Editor.
path.componentsManifest	The path to the file that defines which components appear on the elements panel in eWizard Editor.
path.componentsThemes	The path to the file with the components that are used for specific dynamic themes. For more information, see Define theme-based components.
path.localComponents	The directory that defines where the local components are stored.
path.modulesFilename	The name of the file that defines which modules appear on the elements panel in eWizard Editor.
path.modulesManifest	The path to the file that defines which modules appear on the elements panel in eWizard Classic. The field doesn't affect eWizard Editor.
path.bundle	The path to the file with the development build.
path.rootComponent	The root file where you edit the master template layout. For more information, see Edit a master template.
path.slides	The directory where the slides are stored.
path.themes	The directory where the themes are stored.
path.themePaths.variables	The name of the file with the dynamic theme styles. Each theme has its own file.
path.themePaths.variablesJson	The name of the file with the dynamic theme variables. Each theme has its own file.
path.themePaths.main	The main file with the dynamic theme styles. Each theme has its own file.
path.themesManifest	The path to the file that defines what themes are used in the project.
path.settings	The name of the file with the e-Detailer settings.
path.icon	The name of the file with e-Detailer icon.
path.icon2x	The name of the file with the large version of the e-Detailer icon.
path.blocks	The name of the file with the block icon.
path.preview	The name of the file with the project preview image. The image is generated automatically, or you can create it manually when you upload the template to NaviGate. NOTE: that your manually created image is automatically updated when you work with it in eWizard (create, upload, or edit it, and modify metadata). When you upload an e-Detailer with a manually added image to NaviGate, and then add this channel to templates for reuse, the following behavior occurs in eWizard Library: • If you create a new e-Detailer from this template without changing any metadata, the manually added image will remain. • If you change the e-Detailer theme or other metadata field, the image will be regenerated.
path.assets	The path to the file with the asset settings.
path.claims	The path to the file with the claim settings.
path.documents	The path to the file that defines what documents are exported as PDFs.
path.layouts	The directory with the e-Detailer layouts.
path.slide.thumbnail	The path to the file with the thumbnail. For more information, see wiz thumbs [options].
path.slide.screenshot	The path to the file with the e-Detailer screenshot.
path.slide.thumbnails	The path to the directory with the thumbnails for all themes except current. For more information, see Generate thumbnails for all themes.
path.common.i18n	The directory with content localization. For more information, see Localization.
path.common.media.images	The directory with common images.
path.common.media.videos	The directory with common videos.
path.common.media.pdfs	The directory with common pdfs.
path.common.media.fonts	The directory with common fonts.
path.common.triggeredEmailManifest	The path to the file where the triggered emails are stored.
path.common.references	The path to the file that defines which references appear in eWizard Editor. For more information, see References.
path.common.footnotes	The path to the file that defines which footnotes appear in eWizard Editor e-Detailers. For more information, see Footnotes.
path.metadata.targetMessenger	The path to the file with the target messenger settings for messenger ads.
path.icons.blocks	The path to the generated block icons. For more information, see Generate icons for blocks.
archive.ignore	Use the array of glob patters to exclude the files from the archive. .
cli.identifyComponents	When the value is set to true, running wiz archive adds a data-asset-id attribute to all eWizard, Vue, and HTML components in the App.vue file of the master template and the index.vue file of a slide. The default value is false.
cli.npm.version	The npm version that affects the wiz install and wiz uninstall commands. Available options: latest or legacy. By default, or if the option isn't configured in the template, eWizard selects the version based on the package.json dependencies. For more information, read Latest and legacy npm versions.
template.url	The link to the repository with the e-Detailer.
template.version	The version of the e-Detailer. Generated randomly after you initialize an e-Detailer.

View all fields in .ewizard/settings.json

You can check all the fields available in the .ewizard/settings.json with a development build.

To view all fields from the .ewizard/settings.json file, add the console.log method to the App.vue file of your project.

<!-- App.vue -->

<script>
export default {
  mounted() {
    console.log(EWIZARDJS.SYSTEM_SETTINGS);
  },
};
</script>

You can see the object with all the fields of .ewizard/settings.json in the browser console after running the wiz dev --live command.