Folder & File Structure
Here you find an overview of the files and folders that you get with the plain Xeditor package.
The only files that will be updated with npm update are contained in /node_modules.
| Folder/file | Customizable (y/n) | Description |
|---|---|---|
| /dist | n | Contains built Xeditor package for deployment. Generated with xepack. |
| /node_modules | n | Distributed Xeditor packages, tools, dependencies, and pre-configured schemas. |
| package-lock.json | n | Npm dependencies. Generated with npm install. |
| package.json | y | Npm info file (contains information like dependencies, used versions, project name). |
| /src | y | Contains the subfolder /js/config. This includes all JavaScript files necessary to build Xeditor (e.g., dialogs, plugins, roles, toolbars, schema config, etc.). |
| /WEB-INF | y | Contains /xsl, /xsd, and /xml input files. Mainly used by the server / Blackbox |
| /static | y | Constains static files for CSS, phrases, and HTML. |
| /logs | n | Contains log files generated by blackbox server. |
| xeblackbox.config.js | y | Configuration for blackbox. |
| xepack.config.js | y | Configuration for xepack build tool in order to generate /dist. Optional and downloaded separately from core Xeditor package. Automatically included in pre-configured packages (demo, DITA, etc.). |