UpdateBot: Nightly -> 4.4

2014-12-25T06:45:05Z

Nightly -> 4.4

New page

<noinclude>{{documentation/versioncheck}}</noinclude>
<noinclude>
__TOC__
= Extension description file =</noinclude>

An extension description file is a text file with <code>s4ext</code> extension allowing to specify metadata associated with an [[Documentation/{{documentation/version}}/Extensions/Description|extension]].

* A metadata is specified using a keyword followed by at least one spaces and the associated value.
* Multiline value are not supported.
* Empty line are ignored
* Line starting with a <code>#</code> will be considered as comment.

This file is generated by the build system in the extension build tree. It can also be generated by the [[Documentation/{{documentation/version}}/Developers/ExtensionWizard|ExtensionWizard]] using the extension metadata reported in the extension <code>CMakeLists.txt</code>

The following code block illustrates how comments, metadata and associated value can be specified:

<pre>
# This is a comment
metadataname This is the value associated with 'metadataname'

# This is an other comment
anothermetadata This is the value associated with 'anothermetadata'
</pre>

== Supported metadata ==

<table class="alternate">
<tr>
<th>Name</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td><code>scm</code></td>
<td>Source code management system: <code>git</code> or <code>svn</code></td>
<td>[[File:Yes_check.png|16px]]</td>
</tr>
<tr>
<td><code>scmurl</code></td>
<td>Read-only url used to checkout the extension source code</td>
<td>[[File:Yes_check.png|16px]]</td>
</tr>
<tr>
<td><code>svnusername</code></td>
<td>Allow to specify username associated with <code>svn</code> checkout</td>
<td></td>
</tr>
<tr>
<td><code>svnpassword</code></td>
<td>Allow to specify password associated with <code>svn</code> checkout</td>
<td></td>
</tr>
<tr>
<td><code>scmrevision</code></td>
<td>Revision allowing to checkout the expected source code</td>
<td>[[File:Yes_check.png|16px]]</td>
</tr>
<tr>
<td><code>depends</code></td>
<td>List of extensions required to build this extension. Specify <code>"NA"</code> if there are no dependency.</td>
<td></td>
</tr>
<tr>
<td><code>build_subdirectory</code></td>
<td>Name of the inner build directory in case of superbuild based extension. Default to <code>.</code></td>
<td></td>
</tr>
<tr>
<td><code>homepage</code></td>
<td>Url of the web page describing the extension. See note [1] reported below.</td>
<td>[[File:Yes_check.png|16px]]</td>
</tr>
<tr>
<td><code>contributors</code></td>
<td>Extension contributor specified as <br><code>Firstname1 Lastname1 ([SubOrg1, ]Org1), Firstname2 Lastname2 ([SubOrg2, ]Org2)</code></td>
<td></td>
</tr>
<tr>
<td><code>category</code></td>
<td>Extension category</td>
<td>[[File:Yes_check.png|16px]]</td>
</tr>
<tr>
<td><code>iconurl</code></td>
<td>Url to an icon (png, size 128x128 pixels). See note [1] reported below.</td>
<td></td>
</tr>
<tr>
<td><code>description</code></td>
<td>One line describing what is the purpose of the extension</td>
<td></td>
</tr>
<tr>
<td><code>screenshoturls</code></td>
<td>Space separated list of urls to images. See note [1] reported below.</td>
<td></td>
</tr>
<tr>
<td><code>enabled</code></td>
<td><code>1</code> or <code>0</code> - Specify if the extension should be enabled after its installation. Default is <code>1</code></td>
<td></td>
</tr>
</table>

[1] Parameter like <code>&foo=bar</code> are not supported. Use an url shortener.

== Partially supported metadata ==

<table class="alternate">
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td><code>status</code></td>
<td>Give people an idea what to expect from this code</td>
</tr>
</table>

Documentation/4.4/Developers/Extensions/DescriptionFile - Revision history

UpdateBot: Nightly -> 4.4