Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/apidocs_static/tutorials/1_getting_started.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/apidocs_static/tutorials/2_manifest.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/apidocs_static/tutorials/3_form.json

This file was deleted.

7 changes: 3 additions & 4 deletions docs/apidocs_static/tutorials/3_form.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Extension Forms

**In progress**

Forms are extensions that have a user interface. To create UI, Qml is used. For form extensions, we need to specify the appropriate type and file name using .qml in the extension manifest.
Forms are extensions that have a user interface. To create UI, Qml is used. For form extensions, we need to specify the appropriate type and file name using `.qml` in the extension manifest.
Like this:
manifest.json
```
Expand All @@ -19,7 +17,8 @@ manifest.json
}
```

To create a UI, use `ExtensionBlank` as the root element. For this we need to do `import MuseApi.Controls`.
To create a UI, use `ExtensionBlank` as the root element and the provided UI component library. For this we need to do `import MuseApi.Controls`. You can also use the various services provided, which are described in the documentation.

Example of a simple interface:
```
import QtQuick
Expand Down
3 changes: 0 additions & 3 deletions docs/apidocs_static/tutorials/4_macros.json

This file was deleted.

10 changes: 5 additions & 5 deletions docs/apidocs_static/tutorials/4_macros.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Extension Macros

**In progress**
# Extension Macros

Macros are extensions that do not have a user interface, there is only a script that does something. Usually this is a way to automate some actions.
For macros extensions, we need to specify the appropriate type and file name using .js in the extension manifest.
Expand All @@ -20,13 +18,15 @@ manifest.json
}
```

The entry point is a function named main
In the manifest you can specify the name of the function that will be called; if not specified, then the `main` function will be called by default. You can also use the various services provided, which are described in the documentation.

main.js

```
const Log = require("MuseApi.Log");
const Interactive = require("MuseApi.Interactive");

function main() {
Log.info("called main from example 2")
Interactive.info("Quick start", "called main from example 2")
}
```
3 changes: 0 additions & 3 deletions docs/apidocs_static/tutorials/5_uri.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/apidocs_static/tutorials/6_distribution.json

This file was deleted.

14 changes: 14 additions & 0 deletions docs/apidocs_static/tutorials/tutorials.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"1_getting_started": {
"title": "Quick start"
},
"2_manifest": {
"title": "Manifest"
},
"3_form": {
"title": "Form"
},
"4_macros": {
"title": "Macros"
}
}
6 changes: 2 additions & 4 deletions tools/jsdoc/conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@
}
},
"opts": {
"template_": "./template",
"encoding": "utf8",
"destination": "./out/",
"template": "./template",
"encoding": "utf8",
"recurse": true,
"search": false,
"theme_opts": {
"default_theme": "light",
"title": "Home",
Expand Down
5 changes: 0 additions & 5 deletions tools/jsdoc/template/.eslintignore

This file was deleted.

3 changes: 0 additions & 3 deletions tools/jsdoc/template/.eslintrc.js

This file was deleted.

43 changes: 0 additions & 43 deletions tools/jsdoc/template/.github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

27 changes: 0 additions & 27 deletions tools/jsdoc/template/.github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

9 changes: 0 additions & 9 deletions tools/jsdoc/template/.github/dependabot.yml

This file was deleted.

16 changes: 0 additions & 16 deletions tools/jsdoc/template/.github/pull_request_template.md

This file was deleted.

72 changes: 0 additions & 72 deletions tools/jsdoc/template/.github/workflows/codeql.yml

This file was deleted.

16 changes: 0 additions & 16 deletions tools/jsdoc/template/.github/workflows/greetings.yml

This file was deleted.

2 changes: 0 additions & 2 deletions tools/jsdoc/template/.prettierignore

This file was deleted.

5 changes: 0 additions & 5 deletions tools/jsdoc/template/.prettierrc

This file was deleted.

4 changes: 0 additions & 4 deletions tools/jsdoc/template/.stylelintignore

This file was deleted.

18 changes: 0 additions & 18 deletions tools/jsdoc/template/.stylelintrc

This file was deleted.

30 changes: 0 additions & 30 deletions tools/jsdoc/template/.travis.yml

This file was deleted.

Loading
Loading