QOwnNotes Scripting

A QOwnNotes script is mostly JavaScript in Qt QML files (opens new window).

import QtQml 2.0
import QOwnNotesTypes 1.0

Script {
    /**
        * Will be run when the scripting engine initializes
        */
    function init() {
        script.log("Hello world!");
    }
}

You can place those QML files anywhere you like and add them in QOwnNotes by adding them in the Scripting settings (there is a button Add script/Add local script).

TIP

Take a look at the example scripts (opens new window) to get started fast.

In the Scripting settings you can also install scripts directly from the Script repository (opens new window). There is a community hosted web-application to search for scripts on beurt.github.io/QOwnNoteScriptsList (opens new window).

For issues, questions or feature requests for scripts from the Script repository please open an issue on the QOwnNotes script repository issue page (opens new window).

TIP

If you want to propose a script for the Script repository please follow the instructions at QOwnNotes script repository (opens new window).

If you need access to a certain functionality in QOwnNotes or have questions or ideas please open an issue on the QOwnNotes issue page (opens new window).

TIP

For logging, you can use the script.log() command to log to the Log panel, which you can turn on in the Window / Panels menu.