The Metadata Plugin
Metadata Management for Manila
 
Site last updated
2/24/2006; 12:33:21 PM
 
Home

Why

Features

FAQ

Updates

Documentation

Download

Developers

Bugs

Feedback

Discuss

Planned
Features

 
 

Developers

Author:   John VanDyk  
Posted: 6/4/2001; 2:04:48 PM
Topic: Developers
Msg #: 733 (top msg in thread)
Prev/Next: 732/734
Reads: 13402

When adding capabilities to the Metadata Plugin, please work within the following simple code framework. This makes it easy for everyone to read and debug code.

Code Template: The code template.

Justification of template:

  • The code's original creator should be noted.
  • Change log should be under the Changes bundle.
  • Purpose of code clearly stated such that an automated process could extract the text and create a mini code manual
  • if flDebug lines will be automatically commented or uncommented by the Debugging scripts.
  • "Script beginning" and "Script ending" help pinpoint where an error occurs since Manila doesn't give tracebacks.

Also, please provide full location information when raising scripterrors. Example:

scriptError("metaDataSuite.metaDataCloud.create: could not create cloud of type " + cloudType + ". " + tryerror")

Scripts should be named according to the gridbox naming scheme:

The prefix dsp_ denotes an object that only displays information. It does not change anything.

The prefix qry_ denotes an object that queries the database and retrieves information. It does not change anything in the database.

The prefix act_ denotes an action object that reaches in and makes changes somewhere.

Those with sharp eyes will note that in the screenshot above, the script should be named act_create().

See also the page on Debugging.


This page last updated Monday, August 6, 2001 at 2:05:14 PM. (13402)