github/svgedit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Docs: Clarify config file instructions (in comparison to extensions)

Browse Source
This commit is contained in:
Brett Zamir
2020-07-06 21:24:24 +08:00
parent 20617d1d13
commit 66529391f6
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/tutorials/ExtensionDocs.md
View File

@@ -1,7 +1,7 @@
# Introduction # Introduction
SVG-Edit has support for extensions (as of v2.5). This is a guide for SVG-Edit has support for extensions. This is a guide for creating
creating SVG-Edit extensions. SVG-Edit extensions.
## Means to have extensions loaded ## Means to have extensions loaded
@@ -9,11 +9,13 @@ SVG-Edit extensions are standalone JavaScript files that can be either
included in the HTML file, loaded using `setConfig`, or indicated through included in the HTML file, loaded using `setConfig`, or indicated through
the URL (see [ConfigOptions]{@tutorial ConfigOptions} for usage). the URL (see [ConfigOptions]{@tutorial ConfigOptions} for usage).
Note that, as of v3.0, if you create a `svgedit-config-iife.js` file in `svgedit-config-iife.js` in the project root directory (if
the project root directory (`config.js` in the `editor` directory for through Git clone, by running `npm run build-by-config`) is the file used
v2.8), this will be used to execute commands before extensions are loaded, by `svg-editor.html` to execute commands before extensions are loaded,
e.g., if you wish to make configuration changes which affect extension e.g., if you wish to make configuration changes which affect extension
loading behavior. Normally, however, it should be preferable for modularity loading behavior.
Normally, however, it should be preferable for modularity
to use the extension mechanism, as this can allow you or users to customize to use the extension mechanism, as this can allow you or users to customize
which extensions are loaded (whereas `svgedit-config-iife.js` will always which extensions are loaded (whereas `svgedit-config-iife.js` will always
run if present). run if present).