Opensource.Platon.SK CVS: phpMyEdit/doc/sgml/extensions.sgml - diff

   Up to  [Platon] / phpMyEdit / doc / sgml
Diff for phpMyEdit/doc/sgml/extensions.sgml between version 1.2 and 1.3


version 1.2, 2002/11/14 12:03:54
version 1.3, 2002/11/14 15:00:07



Line 1 




Line 1 




 <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.1 2002/11/03 23:47:00 nepto Exp $ -->
 <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.2 2002/11/14 12:03:54 nepto Exp $ -->


 
 


 <chapter id="extensions">
 <chapter id="extensions">


 <title>Extensions</title>
 <title>Extensions</title>




Line 13  extension mechanism provided.




Line 13  extension mechanism provided.




 </para>
 </para>


 <para>
 <para>


 
 


 Extensions are phpMyEdit_&lt;something&gt; classes, where &lt;something&gt; is
 Extensions are &name;_&lt;something&gt; classes, where &lt;something&gt; is


 appropriate extension name. They extend core &name; class, but they also add
 appropriate extension name. They extend base &name; class, but they also add


 some new functionality. But they must not only to add new things. It is possible
 some new functionality. But they may not <!-- ??? must not ??? --> only to add


 also to disable such features, simply to get desirable behaviour.
 new things. It is possible also to disable such features, simply to get


 
 desirable behaviour.


 
 


 </para>
 </para>


 
 <para>


 
 


 
 In addition to normal &name; configuration options, extension configuration is


 
 provided by <varname>$opts['ext']</varname> associative array. Possible keys


 
 are described on particular extension pages in this manual. Please refer to them


 
 and feel free to improve extensions or create new ones to fit your needs.


 
 


 
 </para>


 
 


 
 <sect1 id="extensions.slide">


 
 <title id="extensions.slide.title">&name;-slide</title>


 
 <para>


 
 


 
 </para>


 
 </sect1>


 
 


 
 <sect1 id="extensions.report">


 
 <title id="extensions.report.title">&name;-report</title>


 
 <para>


 
 


 
 &name;-report extension is provided for easy table report creation. There is


 
 often a need for selecting particular fields from table with applying specific


 
 filter options and finally write out choosen subset of data (report) to HTML


 
 page.


 
 


 
 </para>


 
 <para>


 
 


 
 Navigation is easy to use. Field selection menu would be displayed if


 
 <varname>fields_select</varname> parameter is passed by GET or POST HTTP method


 
 to PHP script and it has non-empty value. This field selection menu contains


 
 list of checkboxes connected with columns, list of filtering input fields and


 
 also button for report creation. Every report page has ability to return back


 
 into field selection. It is possible to specify amount of records on report


 
 page, what is by default set to unlimited.


 
 


 
 </para>


 
 <para>


 
 


 
 To use this extension simply include


 
 <filename>extensions/&name;-report.class.php</filename> file instead of common


 
 &name; class file. Extension specific configuration parameters currently do not


 
 exist, thus all table columns are allowed to be selected in final report. This


 
 will surely change in future, because table could have columns that need to be


 
 unselectable for final report (such as password column or similar).


 
 


 
 </para>


 
 </sect1>


 
 


 </chapter>
 </chapter>


 
 









Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3


















Platon Group <platon@platon.org> http://platon.org/
  Up to  [Platon] / phpMyEdit / doc / sgml
-version 1.2, 2002/11/14 12:03:54
+version 1.3, 2002/11/14 15:00:07
 Line 1
 Line 1
 Line 1
- <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.1 2002/11/03 23:47:00 nepto Exp $ -->
+ <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.2 2002/11/14 12:03:54 nepto Exp $ -->
  <chapter id="extensions">
  <title>Extensions</title>
 Line 13  extension mechanism provided.
 Line 13  extension mechanism provided.
 Line 13  extension mechanism provided.
  </para>
  <para>
- Extensions are phpMyEdit_&lt;something&gt; classes, where &lt;something&gt; is
+ Extensions are &name;_&lt;something&gt; classes, where &lt;something&gt; is
- appropriate extension name. They extend core &name; class, but they also add
+ appropriate extension name. They extend base &name; class, but they also add
- some new functionality. But they must not only to add new things. It is possible
+ some new functionality. But they may not <!-- ??? must not ??? --> only to add
- also to disable such features, simply to get desirable behaviour.
+ new things. It is possible also to disable such features, simply to get
+ desirable behaviour.
  </para>
+ <para>
+ In addition to normal &name; configuration options, extension configuration is
+ provided by <varname>$opts['ext']</varname> associative array. Possible keys
+ are described on particular extension pages in this manual. Please refer to them
+ and feel free to improve extensions or create new ones to fit your needs.
+ </para>
+ <sect1 id="extensions.slide">
+ <title id="extensions.slide.title">&name;-slide</title>
+ <para>
+ </para>
+ </sect1>
+ <sect1 id="extensions.report">
+ <title id="extensions.report.title">&name;-report</title>
+ <para>
+ &name;-report extension is provided for easy table report creation. There is
+ often a need for selecting particular fields from table with applying specific
+ filter options and finally write out choosen subset of data (report) to HTML
+ page.
+ </para>
+ <para>
+ Navigation is easy to use. Field selection menu would be displayed if
+ <varname>fields_select</varname> parameter is passed by GET or POST HTTP method
+ to PHP script and it has non-empty value. This field selection menu contains
+ list of checkboxes connected with columns, list of filtering input fields and
+ also button for report creation. Every report page has ability to return back
+ into field selection. It is possible to specify amount of records on report
+ page, what is by default set to unlimited.
+ </para>
+ <para>
+ To use this extension simply include
+ <filename>extensions/&name;-report.class.php</filename> file instead of common
+ &name; class file. Extension specific configuration parameters currently do not
+ exist, thus all table columns are allowed to be selected in final report. This
+ will surely change in future, because table could have columns that need to be
+ unselectable for final report (such as password column or similar).
+ </para>
+ </sect1>
  </chapter>
 Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3
 Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3
-Removed from v.1.2
+Added in v.1.3


Copyright © 2002-2006 Platon Group Site powered by Metafox CMS	Go to Top