Plugin handbook mostly in place: RFC

• Apr 3, 2010 - 23:52

The plugin handbook is more or less there, at least for this initial phase.

1) There are some open points here and there (marked in bold)
2) English is not my mother-tongue

So, any suggestion, integration and/or editing by someone else with better knowledge of MuseScore and/or English is welcome!

Thanks,

Comments

Thomas

• Apr 5, 2010 - 10:32

Hi Miwarre,

Great work with documenting everything!

Once you feel that the plugin handbook is good enough for more exposure, feel free to create a forum post which can then be featured on the front page of musescore.org. This post could address topics such as 'what is the plugin framework', 'who can use it', 'how to get started' and more. With this post, we can attract more plugin developers and speed up the development.

[DELETED] 5

• Apr 6, 2010 - 10:00

The documentation looks great !
I have a couple of suggestions:

The explanation of the different callbacks is missing. Callback being init, run, onClosed. Same for the menu item
Having the index at the bottom of this long text at http://musescore.org/plugin-development looks suboptimal. I suggest making a "Plugin development introduction" to gather the long text and keep only the index on this page

Miwarre

• Apr 7, 2010 - 00:21

Good points, lasconic! Both done.

I re-arranged page weights to have contents arranged in 3 main areas: introductory pages, API, appendices; in each area, the order is simply alphabetic. The areas are not visually separated in the table of contents, but we may assume the sense shows up and the readers will understand. For the future, I would like to see another area with code samples and snippets...

For the moment, 2 more 'structural' points:

1) This page can probably be deleted by now and its 'childship' to [[nodetitle:Developers handbook]] removed.

2) The main Plugin Development can probably be linked in
EITHER
in the main [[nodetitle:Development]] page (easy, this page is simply text, I can do it)
OR
in the [[nodetitle:Developers handbook]] main page (less easy, as this would require the plugin handbook to be a child of the development handbook: I do not think I have the privilege to do it).

What do you think?