Dev:Py/Scripts/Guidelines/Addons/wikipage

Setup a Wiki page for your Addon

Scripts submitted to or distributed in our Blender Addon repositories should always have a wiki page linked in the script itself (in bl_info dictionary). This is very important to be sure people won't be left wondering how to use a script, and to link to release logs in a nice way.

	New to Wiki?
	Please read theWiki guidelines to get a brief introduction

Temporary Wiki Page

If you submit a script to the Blender Addon repositories, but don't have time to format a proper wiki page in the same time, please create the page anyway and add the code {{WikiTask/Todo}}, so that we see it's going to be written.

Page name

Compose the page name like this:

Extensions:2.5/Py/Scripts/ + <script category> + / + <script name>

Release logs page name

If you have a release log, don't add it to the Manual page itself to avoid information clutter. Better add a new page with the same name as the extension page, but with namespace "Dev", like this:

Dev:2.5/Py/Scripts/ + <script category> + / + <script name>

Example

Script manual page	Extensions:2.5/Py/Scripts/Animation/RotoBezier
Script development page	Dev:2.5/Py/Scripts/Animation/RotoBezier

Use the ScriptInfo template!

For the add-on wiki page, use the template ScriptInfo.

If you have a release log page, you can link it in the releaselog field.

About external links

To avoid scripts referring to broken links, we do not allow external links right in the script itself. Instead please put your Addon homepage into the wikipage. This is easier to manage for people who don't have access to the Git repositories.

Please add your homepage in the link field of the ScriptInfo template, thanks!

Add a manual!

• Take your time to write at least a brief manual, explaining how to use the script options.
• (Optional) add pictures
• (Optional) add videos.

Updates When you add new features to your addon, don't forget to update the proper documentation in your Addon wiki page. A proper reference to the addon development will help users and developers to enjoy your work.

Link your page in the catalog page

Once you have completed your script manual page, link it in the catalog page.