Changes between Version 6 and Version 7 of PluginRequirements


Ignore:
Timestamp:
Sep 22, 2010, 9:02:10 PM (11 years ago)
Author:
Sven Rech
Comment:

improved "plugin settings" section

Legend:

Unmodified
Added
Removed
Modified
  • PluginRequirements

    v6 v7  
    3333== Plugin Description ==
    3434
    35 Each plugin mus include a description. This description is intended as a general description of the plugin and (right now) done on XAML. In order to unify all plugin-descriptions, each description shall use the following structure:
     35Each plugin must include a description. This description is intended as a general description of the plugin and (right now) done on XAML. In order to unify all plugin-descriptions, each description shall use the following structure:
    3636
    3737 * '''Introduction'''
     38  * In this part you should describe in general which problem the plugin solves. If the problem itself is complex, it is a good idea to reference to a webpage here, which describes it in detail (e.g. wikipedia).
    3839 * '''Settings'''
     40  * A plugin mostly supports several settings that often can't be grasped too easily by beginners. These settings and their purpose should be described in detail here.
    3941 * '''Function'''
    40  * '''Relation to other Plugins'''
     42  * The functionality of the plugin (i.e. how it behaves and what it's results are) should be listed here. Of course, this shouldn't be a technical description of the implementation, but it should give the user all informations he must know to use it properly.
     43 * '''Relations to other plugins'''
     44  * Most plugins can only be used by combining them with other plugins, i.e. there functionality is only reachable or meaningful if there is a connection between this plugin and others.
     45    For instance, a lot of plugins require some kind of number input. So they have to be combined with the "Number Input" plugin.
     46    All of these relations to other plugins can be listed and described in this section to give the user a hint how he can make use of this plugin on his workspace.
     47 * '''Reference to samples'''
     48  * Most plugins have their own samples in the "project samples" directory to demonstrate their use. These samples should be listed here, together with a short description.
    4149
    4250== Testing ==