One of the major additions has been to include usage examples for every scripting function built into Picard. The site is currently posted on the github-pages portion of the documentation project on github. This also includes the documentation as PDF and epub files, available for download from the site (in the “Options” section at the bottom left corner of the screen), for those that prefer to read off-line. UPDATE: An initial draft of the on-line documentation project is now available for review. Also I think this could be a way to actually mark and extract documentation for those parts of Picard that can safely be considered plugin API. One idea I would like to follow is creating the actual documentation for scripting functions out of the Picard sources (should be doable with Sphinx).Limiting the scope makes it more likely we will get this finished, and we can then more easily decide if it is a good idea to move other parts of the docs as well. I think for the beginning we should strictly limit this to the area of scripting and plugins and leave all other documentation on the current website. and I had even chatted about this idea a while ago, but decided nothing had even started something similar in 2015 (using Sphinx.), see The website can still give an introduction in it’s own layout, but then link to the docs for all details. I personally would not be opposed to moving the more detailed documentation into the ReadTheDocs format. Comments and suggestions are appreciated. Please have a look if you’re interested, and let’s work together to improve it. Edit: I’ve now moved the whole thing to a project on GitHub with a new link to the docs. Picard is an extremely powerful tool, and I suspect that more people could make more effective use of it if there were more extensive documentation that is readily accessible.ĭuring this initial conceptual development stage, I’m temporarily hosting it on one of my websites under a Picard Docs directory. If there is enough interest, perhaps this can be expanded to a comprehensive Picard on-line manual, complete with detailed explanations of the settings, how to do lookups, scripting and file naming, submitting information to MusicBrainz, and anything else we want to include. This is still very much a work in progress because I need to add in most of the hyperlinks, and there are a few sections that I haven’t yet included, but I think there’s enough there for people to have a look and provide feedback. In the process, I’ve tried to expand the descriptions of all of the scripting functions, and include usage examples for each. I’ve taken a shot at some restructuring (specifically the scripting and tagging sections) using the ReadTheDocs format to see if the access to the information could be simplified. With all the changes and additions to Picard over time, I get the sense that the on-line documentation could be improved.
0 Comments
Leave a Reply. |