Development/Season of Docs/2019/MusicBrainz Picard: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(Added suggestion for expanded plugin developer information.)
No edit summary
Line 1: Line 1:
==Ideas==
==Ideas==
* Expand the existing documentation for plugin developers to clarify the required elements (e.g.: standard license types / abbreviations to be used), and the information provided in the arguments to the various plugin types (e.g.: structure of the JSON / Dictionary for '''''AlbumMetadata''''', '''''TrackMetadata''''', etc.). Also include information about limitations (e.g.: what Python modules are built into the Picard release and available for use). Include information regarding how to include and hook settings page(s) for the plugin into the Picard option settings tree, and how the settings page is developed (e.g.: using Qt) and compiled (e.g.: using the Picard <code>setup.py</code> script's <code>build-ui</code> command).
* Expand the existing documentation for plugin developers to clarify the required elements (e.g.: standard license types / abbreviations to be used), and the information provided in the arguments to the various plugin types (e.g.: structure of the JSON / Dictionary for '''''AlbumMetadata''''', '''''TrackMetadata''''', etc.). Also include information about limitations (e.g.: what Python modules are built into the Picard release and available for use). Include information regarding how to include and hook settings page(s) for the plugin into the Picard option settings tree, and how the settings page is developed (e.g.: using Qt) and compiled (e.g.: using the Picard <code>setup.py</code> script's <code>build-ui</code> command).
* An extensive, example-rich guide explaining Picards built-in scripting language and utility.

Revision as of 16:27, 22 April 2019

Ideas

  • Expand the existing documentation for plugin developers to clarify the required elements (e.g.: standard license types / abbreviations to be used), and the information provided in the arguments to the various plugin types (e.g.: structure of the JSON / Dictionary for AlbumMetadata, TrackMetadata, etc.). Also include information about limitations (e.g.: what Python modules are built into the Picard release and available for use). Include information regarding how to include and hook settings page(s) for the plugin into the Picard option settings tree, and how the settings page is developed (e.g.: using Qt) and compiled (e.g.: using the Picard setup.py script's build-ui command).
  • An extensive, example-rich guide explaining Picards built-in scripting language and utility.