Plugin Header

From World Wind Wiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 11:14, 20 June 2005 (edit)
Mashiharu (Talk | contribs)

← Previous diff
Current revision (21:01, 1 September 2011) (edit) (undo)
Mkpl (Talk | contribs)
m (Reverted edits by Xadmin (Talk); changed back to last version by Shockfire)
 
(7 intermediate revisions not shown.)
Line 1: Line 1:
 +The plugin header is used by World Wind to present information about the plugin to the user before compiling/loading it, and also contains compiler related information when needed. The header isn't required, but recommended. One or more fields may also be omitted.
 +'''NOTE:''' The header is read when World Wind loads. Changes to the header will not be reflected until the application is reloaded.
 +
 +==Sample Header==
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
// NAME: Joystick control // NAME: Joystick control
Line 9: Line 13:
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
-==Name==+==Fields==
 + 
 +===Name===
A short name for the plugin. A short name for the plugin.
-==Version==+===Version===
The plugin version number string The plugin version number string
-==Description==+===Description===
A longer description of the plugin functionality. A longer description of the plugin functionality.
-==Developer==+===Developer===
The name(s) of the plugin developer(s). The name(s) of the plugin developer(s).
-==WebSite==+===WebSite===
An URL pointing to the "home" of the plugin. An URL pointing to the "home" of the plugin.
-==Referenes==+===References===
A comma separated list of additional libraries the plugin needs a refence to. These might be local (plugin directory) assemblies, or system wide assemblies located in the Glocal Assembly Cache. For local assemblies filename (no path) including extension (usually .dll) must be specified. For global assemblies omit the extension. A comma separated list of additional libraries the plugin needs a refence to. These might be local (plugin directory) assemblies, or system wide assemblies located in the Glocal Assembly Cache. For local assemblies filename (no path) including extension (usually .dll) must be specified. For global assemblies omit the extension.
-The sample on the top of this page requests references to the Managed DirectX assembly '''Microsoft.DirectX.DirectInput.dll''' in the GAC and a local assembly '''MyCoordinateSystemLibrary.dll''' located in the directory of the plugin.+Note: this isn't true at all with WW 1.4.0. In my experience the local assemblies have to be in the main WW directory and WW will append .dll to the filename whether it already ends in .dll or not (thus producing errors when you specify an extension)
- +The sample on the top of this page requests references to the Managed DirectX assembly '''Microsoft.DirectX.DirectInput.dll''' in the GAC and a local assembly '''MyCoordinateSystemLibrary.dll''' located in the directory of the plugin.
-[[Category:Dev]]+[[Category:Plugin development]]
-[[Category:Plugins]]+

Current revision

The plugin header is used by World Wind to present information about the plugin to the user before compiling/loading it, and also contains compiler related information when needed. The header isn't required, but recommended. One or more fields may also be omitted. NOTE: The header is read when World Wind loads. Changes to the header will not be reflected until the application is reloaded.

Contents

[edit] Sample Header

//----------------------------------------------------------------------------
// NAME: Joystick control
// VERSION: 1.0
// REFERENCES: Microsoft.DirectX.DirectInput.dll
// DESCRIPTION: Allow World Wind to be controlled by joystick/game controller
// DEVELOPER: John Doe
// WEBSITE: http://www.com
// REFERENCES: Microsoft.DirectX.DirectInput, MyCoordinateSystemLibrary.dll
//----------------------------------------------------------------------------

[edit] Fields

[edit] Name

A short name for the plugin.

[edit] Version

The plugin version number string

[edit] Description

A longer description of the plugin functionality.

[edit] Developer

The name(s) of the plugin developer(s).

[edit] WebSite

An URL pointing to the "home" of the plugin.

[edit] References

A comma separated list of additional libraries the plugin needs a refence to. These might be local (plugin directory) assemblies, or system wide assemblies located in the Glocal Assembly Cache. For local assemblies filename (no path) including extension (usually .dll) must be specified. For global assemblies omit the extension.

Note: this isn't true at all with WW 1.4.0. In my experience the local assemblies have to be in the main WW directory and WW will append .dll to the filename whether it already ends in .dll or not (thus producing errors when you specify an extension)

The sample on the top of this page requests references to the Managed DirectX assembly Microsoft.DirectX.DirectInput.dll in the GAC and a local assembly MyCoordinateSystemLibrary.dll located in the directory of the plugin.

Personal tools