Standalone addon modules

From Sohowiki
(Difference between revisions)
Jump to: navigation, search
(Standalone addon modules)
(Standalone addon modules)
Line 11: Line 11:
 
#'''Button on the Main Menu''' - links to the plugin's management module
 
#'''Button on the Main Menu''' - links to the plugin's management module
 
#'''Management Module''' - Where you creates/edit stuff, set up the various config options for the plugin, etc. In the photo gallery example, this is where you create and edit your photo galleries, upload new images to use, etc.
 
#'''Management Module''' - Where you creates/edit stuff, set up the various config options for the plugin, etc. In the photo gallery example, this is where you create and edit your photo galleries, upload new images to use, etc.
#Page Editor Object - Draggable icon in the Page Editor that you drag-and-drop onto a site page. These typically have some sort of properties dialog that appears when you drag the object onto a page that prompts you to choose from various options related to exactly what you want to place on this particular page. Using the photo gallery example again: when you drag the "Premium Gallery" object onto a page the properties dialog that appears prompts you to choose which album you want to place on the page and how you want the pictures to be arranged (i.e. number of pics to show per row, whether to place captions above or below pics, etc).
+
#'''Page Editor Object''' - Draggable icon in the Page Editor that you drag-and-drop onto a site page. These typically have some sort of properties dialog that appears when you drag the object onto a page that prompts you to choose from various options related to exactly what you want to place on this particular page. Using the photo gallery example again: when you drag the "Premium Gallery" object onto a page the properties dialog that appears prompts you to choose which album you want to place on the page and how you want the pictures to be arranged (i.e. number of pics to show per row, whether to place captions above or below pics, etc).
#Website Display Element - This what displays on the actual website when you drop your plugin's Page Editor Object onto a site page and save/preview the page.
+
#'''Website Display Element''' - This what displays on the actual website when you drop your plugin's Page Editor Object onto a site page and save/preview the page.
  
 
===Modifications/Hacks===
 
===Modifications/Hacks===

Revision as of 12:35, 18 May 2006

Contents

Introduction

The purpose of this article is to give you a general overview of the various methods availble to you for creating plugins.

Common types of plugins

Standalone addon modules

A standalone addon module is a plugin that is almost entirely self contained. As in, it doesn't really change anything; it just adds something.

Througout this section I'll be using ViaStep's Premium Gallery Module as example of a standalone addon module:

Standalone addons typically consist of three elements:

  1. Button on the Main Menu - links to the plugin's management module
  2. Management Module - Where you creates/edit stuff, set up the various config options for the plugin, etc. In the photo gallery example, this is where you create and edit your photo galleries, upload new images to use, etc.
  3. Page Editor Object - Draggable icon in the Page Editor that you drag-and-drop onto a site page. These typically have some sort of properties dialog that appears when you drag the object onto a page that prompts you to choose from various options related to exactly what you want to place on this particular page. Using the photo gallery example again: when you drag the "Premium Gallery" object onto a page the properties dialog that appears prompts you to choose which album you want to place on the page and how you want the pictures to be arranged (i.e. number of pics to show per row, whether to place captions above or below pics, etc).
  4. Website Display Element - This what displays on the actual website when you drop your plugin's Page Editor Object onto a site page and save/preview the page.

Modifications/Hacks

Step 1: Hack it

Step 2: Figure out how best to integrate your hacks

==

Personal tools