Test / Demo Plugin ~ readme / help file

installation & usagesettingsmore info...history

Big Picture

Test / Demo responds to virtually all possible plugin events and provides samples of how to do stuff with your plugins.

THIS README IS A DEMO OF THE README WRITER - IT DOES NOT PROVIDE INFORMATION ABOUT THE TEST / DEMO PLUGIN!

This is the extended description field

Installation & Usage

Installation:
  1. Upload the "test_plugin" folder, the one that this file is in, to your /qp_plugins/ folder on your server.
  2. In your admin panel, go to the Global Settings -> Plugins sub-tab.
  3. Click on "Install new" (right side, near top), locate the Test / Demo plugin, and click "Install" in the "actions" column.
  4. In your admin panel, go to Global Settings -> Plugins -> Test / Demo to access the plugin's settings.
  5. This is the fifth installation field. The first 4 are auto-filled with the above bits. This one is here just because. I doubt anyone will ever need it.
Usage:
  • You have 6 "usage" fields.
  • If you leave them empty it will say something like "no usage defined" or whatever.
  • Usage field contents become list items in an unordered list.
  • Because of that you should use html stuff only if appropriate in a list item.
  • Six fields? Wow that seems like a lot.
  • Yeah it is, and this is the only time in this demo I will use all the fields for any given section.

Settings, Settings, & Settings

(Plugin) Primary Settings:
  • The text someone sees: Not the $variable name for the field.
  • each setting: gets an explanation field where you get to explain in greater detail than would be appropriate in a 'note' in the actual plugin.
  • how many settings: You get 10 (ten!) setting/explanation pairs for each plugin settings group. This is the first or primary group.
  • OMG: yeah that's what I said. You probably won't need this many but sometimes you might so it is available.
  • what about no settings?: Then leave the "Label" field blank for any given group of settings.
  • no label means ... ?: It means if you put anything in the setting/explanation pair fields it won't get into the readme, so don't leave label blank if you have settings to explain!
(Plugin) Secondary Settings:
  • secondary?: Yeah. You can group your settings with some sort of code thing, which makes it visually nicer on the plugin's settings page.
(Plugin) Additional Settings:
  • okay that makes sense: Yeah. You can also use a little separator inside a group of settings to further visually clean up the settings page. Neato eh?
User Settings:
  • on the Users tab: Your plugin might have stuff for the user to fill in or check, so identify and explain them here.
  • no user settings?: The same thing as per plugin settings applies: leave the "Label" field blank and this stuff is ignored.
  • how many here?: 10. You always get 10 setting/explanation pairs for any given group of settings.
Blog Settings:
  • blogs have settings?: Yeah they can. Same as above - explain your settings, and if you don't need this section then leave it blank, and you get 10 pairs to work with.
Widget Settings:
  • wigets too?: Yes, and same as above - explain your settings, and if you don't need this section then leave it blank, and you get 10 pairs to work with.

More Info, Credits, & Links

More Info:
  • You get 5 "more info" fields just in case something wasn't covered above.
  • Leave them empty if you got all your ducks lined up in the various setting/explanation pairs above.
  • These are list items in an unordered list so use html wisely.
Credits:
  • Giving credit where credit is due makes sense, so don't be shy about it.
  • These are also list items in an unordered list so use html wisely.
Links:

Release History:

0.1
initial release (27-Apr-10)