Template:ScriptInfo/doc

Below you have the fields you can use to describe an extension.

This template is adaptive: unrequired slots can be left blank and won't show up, in order to return a clean table.

{{#switch:wikitext

|wikitext=

{{ScriptInfo
|name= Extension name
|tooltip= Tooltip
|menu= Location in the UI
|usage= Quick explanation of how to use the script
|version= Version
|blender= Compatible Blender version
|category= The category field used in bl_addon_info dict
|author= Author(s)
|license= Extension's License
|distribution= How the script is distributed (can be: Release, Contrib, Extern)
|note= Note(s)
|exe= Executable name
|download= Download url
|modules= Used standard Python modules
|deps= External python modules or Binary dependencies 
|data= Eventual data needed by the extension
|bugtracker= Extension tracker page URL where to report bugs
|warning= Eventual warnings
|link= Useful links (author homepage, documentation pages, etc)
|releaselog= Release log page, possibly in this wiki
|issues= Known issues
}}

|

{{#if:Quick explanation of how to use the script| {{#if:The category field used in bl_addon_info dict| {{#if:How the script is distributed (can be: Release, Contrib, Extern)| {{#if:Note(s)|

Extension name
Tooltip

UI location	Location in the UI
Usage	Quick explanation of how to use the script }}
Version	Version	Author(s)	Author(s)
Blender	Compatible Blender version	License	Extension's License
Category	The category field used in bl_addon_info dict	Distribution		Category	The category field used in bl_addon_info dict }}| {{#if:How the script is distributed (can be: Release, Contrib, Extern)|			Distribution	How the script is distributed (can be: Release, Contrib, Extern) }} }}
Note(s)	Note(s) }}

{{#if:Download url| {{#if:Used standard Python modules| {{#if:External python modules or Binary dependencies| {{#if:Eventual data needed by the extension|

Executable information

File name	Executable name
Current version download	Download url }}
Python modules	Used standard Python modules }}
External Python Modules or dependencies	External python modules or Binary dependencies }}
Data	Eventual data needed by the extension }}

{{#if:Useful links (author homepage, documentation pages, etc)| {{#if:Release log page, possibly in this wiki| {{#if:Known issues|

{{#if:Eventual warnings|

Warning	Eventual warnings }}
Links	Useful links (author homepage, documentation pages, etc) }}
Release Log	Release log page, possibly in this wiki }}
Known Issues	Known issues }}

}} returns: {{#switch:

|wikitext=

{{ScriptInfo
|name= Extension name
|tooltip= Tooltip
|menu= Location in the UI
|usage= Quick explanation of how to use the script
|version= Version
|blender= Compatible Blender version
|category= The category field used in bl_addon_info dict
|author= Author(s)
|license= Extension's License
|distribution= How the script is distributed (can be: Release, Contrib, Extern)
|note= Note(s)
|exe= Executable name
|download= Download url
|modules= Used standard Python modules
|deps= External python modules or Binary dependencies 
|data= Eventual data needed by the extension
|bugtracker= Extension tracker page URL where to report bugs
|warning= Eventual warnings
|link= Useful links (author homepage, documentation pages, etc)
|releaselog= Release log page, possibly in this wiki
|issues= Known issues
}}

|

{{#if:Quick explanation of how to use the script| {{#if:The category field used in bl_addon_info dict| {{#if:How the script is distributed (can be: Release, Contrib, Extern)| {{#if:Note(s)|

Extension name
Tooltip

UI location	Location in the UI
Usage	Quick explanation of how to use the script }}
Version	Version	Author(s)	Author(s)
Blender	Compatible Blender version	License	Extension's License
Category	The category field used in bl_addon_info dict	Distribution		Category	The category field used in bl_addon_info dict }}| {{#if:How the script is distributed (can be: Release, Contrib, Extern)|			Distribution	How the script is distributed (can be: Release, Contrib, Extern) }} }}
Note(s)	Note(s) }}

{{#if:Download url| {{#if:Used standard Python modules| {{#if:External python modules or Binary dependencies| {{#if:Eventual data needed by the extension|

Executable information

File name	Executable name
Current version download	Download url }}
Python modules	Used standard Python modules }}
External Python Modules or dependencies	External python modules or Binary dependencies }}
Data	Eventual data needed by the extension }}

{{#if:Useful links (author homepage, documentation pages, etc)| {{#if:Release log page, possibly in this wiki| {{#if:Known issues|

{{#if:Eventual warnings|

Warning	Eventual warnings }}
Links	Useful links (author homepage, documentation pages, etc) }}
Release Log	Release log page, possibly in this wiki }}
Known Issues	Known issues }}

}}

while using:

{{ScriptInfo
|name= Weird mesh
|tooltip= This script adds a weird mesh in the scene
|menu= Add > Mesh > Weird mesh
|version= 1.0
|author= John Smith
|blender= 2.54
|license= GPL
|exe= weirdmesh.py
}}

returns:

{{#if:| {{#if:| {{#if:| {{#if:|

Weird mesh
This script adds a weird mesh in the scene

UI location	Add > Mesh > Weird mesh
Usage	{{{usage}}} }}
Version	1.0	Author(s)	John Smith
Blender	2.54	License	GPL
Category	{{{category}}}	Distribution		Category	{{{category}}} }}| {{#if:|			Distribution	{{{distribution}}} }} }}
Note(s)	{{{note}}} }}

{{#if:| {{#if:| {{#if:| {{#if:|

Executable information

File name	weirdmesh.py
Current version download	{{{download}}} }}
Python modules	{{{modules}}} }}
External Python Modules or dependencies	{{{deps}}} }}
Data	{{{data}}} }}

{{#if:| {{#if:| {{#if:|

{{#if:|

Warning	{{{warning}}} }}
Links	{{{link}}} }}
Release Log	{{{releaselog}}} }}
Known Issues	{{{issues}}} }}