File: ext_usage.md

package info (click to toggle)
frescobaldi 3.3.0%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 24,212 kB
  • sloc: python: 39,014; javascript: 263; sh: 238; makefile: 80
file content (29 lines) | stat: -rw-r--r-- 1,143 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
=== Using Extensions ===

Obviously the actual usage of an extension is up to the extension, and so is the
documentation of its features. However, there are some common aspects about the
integration of extensions in the Frescobaldi user interface. Essentially an extension's functionality is available through *Menu Actions* and a *Tool Panel*. At least one of these must exist for any extension.

= Menus =

An extension's *Menu Actions* can be exposed in various {submenu_extensions}
submenus. It is up to the extension maintainer(s) which actions are available in
each of the following places:

* {menu_tools_extensions}
* Editor context menu
* Musicview context menu
* Manuscriptview context menu
* *Additional places may be added over time*

= Tool Panel =

If an extensions provides a Tool Panel it is accessible through {menu_panel}.
The panel behaves like Frescobaldi's built-in dockable panels, and what
functionality it provides is up to the extension.

#VARS

submenu_extensions          menu N.N. -> Extensions
menu_tools_extensions    menu Tools -> Extensions
menu_panel               menu Tools -> Extensions -> [extension-name]