Settings Schema
Description
The local settings.yaml or settings.json defines the project settings.
They will overwrite mobos default settings.
To print the current configuration of a mobo project, including inherited settings:
$ mobo -c
Available Settings
| ID | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allowAdditionalProperties | If false, mobo will warn when the development model contains unsupported/unknown properties. This is very helpful to spot typos and other accidents when modeling Type(s): boolean Default: false |
||||||||||||||||
| arrayMergeOptions | Default settings (using @annotations) for array merges Type(s): object Contains:
|
||||||||||||||||
| arraymapSeparator | Separator to seperate between multiple items Type(s): string Default: ";" |
||||||||||||||||
| autoRefreshPort | WebSocket port the server and the WebGui are using to notify the change. Change this if the port is already used. Type(s): number Default: 8081 |
||||||||||||||||
| autoRefreshWebGui | WebGui is automatically refreshed if the server makes changes to the model Type(s): boolean Default: true |
||||||||||||||||
| buildGraph | Builds graph files (.gexf) from the model. Type(s): boolean Default: true |
||||||||||||||||
| buildGraphSettings | Sets the size and weight of nodes and edges Type(s): object Contains:
|
||||||||||||||||
| compatibilityLayer | Set to false, if you want to skip the compatibility layer that migrates deprecated models to the latest standard. Type(s): boolean Default: true |
||||||||||||||||
| cwd | AUTO GENERATED, can be overwritten: Working (root) directory of the project where the settings.json is located Type(s): string |
||||||||||||||||
| debug | Turns the debug mode on. This deactivated graceful error handling. Type(s): boolean Default: false |
||||||||||||||||
| defaultTemplateDisplay | Default Template Display renderer. See mobo_template/template.wikitext to see or change how they are rendered. Type(s): string Default: "ul" |
||||||||||||||||
| deleteWikiPages | Deletes removed WikiPages from the external Wiki (use with care, this destroys the polymorphism!) Type(s): boolean Default: false |
||||||||||||||||
| displayTodos | Displays the content of todo properties from your JSON files Type(s): boolean Default: true |
||||||||||||||||
| firstAlternativeFormAsDefault | If more than one form is defined through an oneOf array, this setting will set the first form as the default if true. If set to false, no form will be used as default and the user has to choose first. Type(s): boolean Default: false |
||||||||||||||||
| force | Forces mobo to continue despite possible errors Type(s): boolean Default: false |
||||||||||||||||
| forceUpload | Forces the upload of all generated WikiPages, even if no changes were detected. This can sometimes be useful, if some changes were lost or you want to go for sure. Type(s): boolean Default: false |
||||||||||||||||
| formEditHelper | If enabled this creates **FormEdit Helper Categories** that tag the WikiPages that were generated through a form as editable by that form. Type(s): boolean Default: true |
||||||||||||||||
| generateTemplateData | Whether to generate a TemplateData (a VisualEditor extension) to describe templates Type(s): boolean Default: false |
||||||||||||||||
| generatedByMobo | If enabled, mobo appends a warning and a category to each wiki page generated. Type(s): boolean Default: false |
||||||||||||||||
| generatedByMoboText | Wikitext that will be prefixed to each mobo generated page Type(s): string Default: " This page is autogenerated, do not edit it manually! [[Category:mobo-generated]]\n" |
||||||||||||||||
| gitStatistics | Adds some git related statistics. Will only work if git is installed and the project is a git repository. Type(s): boolean Default: false |
||||||||||||||||
| headerTabs | If true, the HeaderTabs Extension will be used with the generated forms. Keep in mind that you still have to create the headings to make this work! Type(s): boolean Default: false |
||||||||||||||||
| hideFormEditHelper | If true this will hide the introduced Helper Categories from the display Type(s): boolean Default: false |
||||||||||||||||
| importModelDir | AUTO GENERATED, can be overwritten. Type(s): string |
||||||||||||||||
| logDate | Prepend the time (and eventually date) on each logging message Type(s): boolean Default: true |
||||||||||||||||
| logDir | AUTO GENERATED, can be overwritten. Type(s): string |
||||||||||||||||
| logLongDate | If true and logDate is enabled, the full date will be logged in addition to the time Type(s): boolean Default: false |
||||||||||||||||
| logObjectsAsYaml | Logging / CLI output: Prints JavaScript Object as colorized YAML Type(s): boolean Default: false |
||||||||||||||||
| mw_password | The password of your mobo bot account Type(s): string Default: "password" |
||||||||||||||||
| mw_server_path | Relative path to the MediaWiki installation without trailing slash Type(s): booleanstring Default: "" |
||||||||||||||||
| mw_server_port | The port your MW installation is using. Type(s): booleannumber Default: false |
||||||||||||||||
| mw_server_url | URL to your MediaWiki server without trailing slash. Do not include the port or relative path to MediaWiki! Type(s): booleanstring Default: false |
||||||||||||||||
| mw_username | The username of your mobo bot account Type(s): string Default: "username" |
||||||||||||||||
| overwriteImportedPages | If this is enabled, mobo in --import mode will overwrite already existing wiki pages Type(s): boolean Default: false |
||||||||||||||||
| processedModelDir | AUTO GENERATED, can be overwritten. Type(s): string |
||||||||||||||||
| serveWebApp | Serves the webGUI / app at localhost. Type(s): boolean Default: true |
||||||||||||||||
| sf_responsiveForms | If enabled, mobo renders the SemanticForms as a div layout instead of the standard table layout. This enables more control over the layout, including some responsiveness (Bootstrap grid layout). WARNING: You need to style/layout the divs by yourself, or use the Chameleon skin. SemanticForms itself does not support / supply this for a div based layout. Type(s): boolean Default: false |
||||||||||||||||
| sf_wpDiff | Semantic Forms Edit-View: Render the Diff Button Type(s): boolean Default: true |
||||||||||||||||
| sf_wpPreview | Semantic Forms Edit-View: Render the Preview Button Type(s): boolean Default: true |
||||||||||||||||
| sf_wpWatchthis | Semantic Forms Edit-View: Render the Watch this checkbox option Type(s): boolean Default: true |
||||||||||||||||
| smw_semanticDrilldown | Automatically generates SemanticDrilldown #drilldowninfo functions. Type(s): boolean Default: false |
||||||||||||||||
| statistics | Displays simple statistics about the project model. Statistics will also be written / appended to `/_processed/_statistics.csv` Type(s): boolean Default: true |
||||||||||||||||
| templateDir | AUTO GENERATED, can be overwritten. Type(s): string |
||||||||||||||||
| uploadConcurrency | Concurrent upload processes Type(s): number Default: 4 |
||||||||||||||||
| uploadLogFile | If this is enabled, mobo will upload the logfile in addition to the report Type(s): boolean Default: false |
||||||||||||||||
| uploadOutline | If this is enabled, mobo will upload an outline of the model at /User: Type(s): boolean Default: true |
||||||||||||||||
| uploadOutlineCountRefs | Adds an counter how often a template / property was internally referenced Type(s): boolean Default: false |
||||||||||||||||
| uploadReport | If this is enabled, mobo will upload a report at User at /User: Type(s): boolean Default: true |
||||||||||||||||
| uploadWikiPages | Uploads the generated WikiPages to an external Wiki Type(s): boolean Default: true |
||||||||||||||||
| useSimpleTooltipDescriptions | If enabled, descriptions will be included as SimpleTooltip tooltips. WARNING: You need to install the SimpleTooltip extension to make this work. Type(s): boolean Default: false |
||||||||||||||||
| verbose | More verbose console output. This will also tighten the model validation and display minor notices Type(s): boolean Default: false |
||||||||||||||||
| watchFilesystem | Watches the (development) project files for changed and automatically triggers re-generation. Type(s): boolean Default: true |
||||||||||||||||
| webAppPort | Port the WebApp is served on the localhost Type(s): number Default: 7000 |
||||||||||||||||
| writeExportFiles | If true mobo will write every generated file as a single file into the filesystem. This can be slow due to a lot of HDD I/O Type(s): boolean Default: false |
||||||||||||||||
| writeLogFile | If this is enabled, mobo will create logfiles in /_processed/logfiles/* Type(s): boolean Default: true |