[Comoblog-commit] comoblog/modules/mod_example/install mod_example.xml,NONE,1.1 mod_example_commented.xml,NONE,1.1

[Mark W. \(a. serialmonkey\) <mar...@us...>]

Update of /cvsroot/comoblog/comoblog/modules/mod_example/install
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14887/mod_example/install

Added Files:
	mod_example.xml mod_example_commented.xml 
Log Message:
Add mod_example module for developers

--- NEW FILE: mod_example.xml ---
<?xml version="1.0" standalone="no"?>
<!DOCTYPE module SYSTEM "http://comoblog.sourceforge.net/DTD/comoblog_mod_install.dtd">
<module>
   
   <name>
      mod_example
   </name>
   
   
   <description>
      just an example to help developers making new modules
   </description>
   
   
   <allowed_pos>
      sidebar
   </allowed_pos>
   
   
   <allowed_pos>
      top
   </allowed_pos>
   
   
   <dbquery></dbquery>
   
   
   <dbquery></dbquery>
   
   
   
   <param
      name="CFG_EXAMPLE_PARAMETER"
      description="Example parameter" 
      type="color_picker"
      accept_null="N"
      encrypt="N"
      restricted_values=""
      editable="Y"
      value="ffffff"
   />
   
   <param
      name="CFG_ANOTHER_EXAMPLE_PARAM"
      description="Just another example"
      type="select"
      restricted_values="value1|value2|value3"
      encrypt="N"
      editable="Y"
      value="value1"
   />
   
</module>

--- NEW FILE: mod_example_commented.xml ---
<?xml version="1.0"?>

<!-- refer to this file if you want to develop a new module -->

<!-- It contains all informations needed to create a module
     installation file -->




<!-- the root element -->     
<module>
   
   <!-- unique module name, must be prefixed by 'mod_' (max 64 chars) -->
   <name>
      mod_example
   </name>
   
   <!-- description of your module (max 255 chars) -->
   <description>
      just an example to help developers making new modules
   </description>
   
   <!-- if your module can appear in the sidebar (if not, omit this element): -->
   <allowed_pos>
      sidebar
   </allowed_pos>
   
   <!-- if your module can appear in the topbar (if not, omit this element): -->
   <allowed_pos>
      top
   </allowed_pos>
   
   
   <dbquery>
      <!-- you can write here a SQL query: it will be executed by the installation
      script. This is useful if you need a new db table for your module -->
   </dbquery>
   
   
   <dbquery>
      <!-- put only ONE query for each dbquery element!!! -->
   </dbquery>   
   
   
   <!-- if you need configuration parameters, use 'param' elements -->
   <!-- use a param element for each parameter!!! -->
   
   <param
      
      <!-- name of the parameter, it will be used as a PHP constant -->
      <!-- please include module name in parameter name, to avoid conflicts -->
      name="CFG_EXAMPLE_PARAMETER"

      <!-- a description of the parameter -->
      description="Example parameter" 
      
      <!-- parameter type: use one of the followin values: text, image, password, select, color_picker -->
      <!-- this will be used by the Admin Area framework to use the proper field in the 'preferences' form -->
      type="color_picker"
      
      <!-- wether to accept null (or empty string) as parameter value (Y|N) -->
      accept_null="N"
      
      <!-- wether to encrypt value in the db, use it only for password parameters (Y|N) -->
      encrypt="N"
      
      <!-- list of restricted values, use it for 'select' parameters -->
      restricted_values=""
      
      <!-- wether users can change parameter's value in Admin Area (Y|N) -->
      editable="Y"
      
      <!-- value of parameter -->
      value="ffffff"
   />
   
   <param
      name="CFG_ANOTHER_EXAMPLE_PARAM"
      description="Just another example"
      type="select"
      restricted_values="value1|value2|value3"
      encrypt="N"
      editable="Y"
      value="value1"
   />
   
</module>