Plugin Makeup

Every plugin must consist of the following minimum structure:

Critical Common Files:
  • pw-config.php
    • This is the main configuration file. It contains critical variables used throughout the plugin.
  • pw-claimtypes.php?
    • This is where claims are defined and mapped to internal database locations
  • infocard.css
    • This is the main CSS file. It regulates the look & feel of PamelaWare pages.
Root-Level Directories:
  • pwlib (Common code library)
    • This is where common code resides. Changes to this code base affect all PamelaWare Plugins
  • Plugin-specific library (wp, jos)
    • This is a directory containing plugin-specific code. The name of this directory is a unique plugin identifier, which is stored in the "PW_PLUGIN" variable (set up in pw-config.php). For WordPress, the plugin identifier is "wp", for Joomla, the plugin identifier is "jos".
  • legal
    • this is where the license file, and contributors file, and any other legal mumbo jumbo resides.
  • site-messages
    • this will probably be moved into the plugin-specific library. It contains site-specific user messages.

Note: there can be extra files in the root directory, depending on the needs of the plugin.