Help:Howto/Add a new plugin

From Miranda NG
< Help:Howto
Revision as of 17:31, 10 April 2013 by Goraf (talk | contribs) (Template:While and Example - update)
Jump to navigation Jump to search

To add a new plugin to Plugin list and Download pages you should do the following:

  • Add the plugin to Template:Plugins as it is done for existing ones. Note that it is the plugin's filename (without .dll) to be added there.
  • Update Template:PluginInfo. Information about the plugin can be found on Plugins page of Miranda options. Details on the parameters:
name=		Plugin name
screenshot=	Screenshot filename (Use *** if no screenshot is needed)
author=		Plugin author
authors=	Plugin authors*
requirements=	(o) System requirements (e. g. necessary runtime libraries)**

* Use Template:While to list all developers (see the example below)
** (o) — parameter is optional

You might want to hide some download links in some cases (e. g. new plugins usually don't have stable versions until next stable Miranda NG is released). Use the appropriate "hide" parameter:

hide-s32=1	(o) to hide link for x32 stable
hide-s64=1	(o) to hide link for x64 stable
hide-l32=1	(o) to hide link for x32 latest
hide-l64=1	(o) to hide link for x64 latest

Also, some plugins might have download links that differ from the default ones. In this case the following parameters are used:

hideDownloadLinks=1	(o) to hide the default download links all at once
additionalLinks=	(o) to specify download links for that particular plugin

(see IM_Updater and Skype for example).

Example
|SamplePlugin = {{#hashdefine:{{#var:PluginFileName}} |name=Sample plugin;; screenshot=SamplePlugin.jpg;; authors={{while|tpl=Developer|Author 1|Author 2|Author 3}};; requirements=syslib.dll;; hide-s32=1;; hide-s64=1;; |;;|=}}
  • Template:PluginDescription/* is the last to edit. This one is localization-dependent so update its version in your language. Add a short description of the plugin as it is done for existing ones. Usually the description from Plugins page of Miranda options is enough. See Template:PluginDescription/en for example.
  • Each plugin has its own page for detailed description. To create a page for the newly added plugin go to Plugin list or Download page, select its version in your language and click the name of the new plugin (it will be written in red). Use any Plugin:<PluginFilename>/* page as example.