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.5 and 1.6


version 1.5, 2003/02/18 00:17:27
version 1.6, 2003/03/31 00:11:41



Line 1 




Line 1 




 <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.4 2002/12/03 21:05:51 nepto Exp $ -->
 <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.5 2003/02/18 00:17:27 nepto Exp $ -->


 
 


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


 <title id="extensions.title">Extensions</title>
 <title id="extensions.title">Extensions</title>




Line 11  these particular requirements into core




Line 11  these particular requirements into core




 extension mechanism provided.
 extension mechanism provided.


 
 


 </para>
 </para>


 
 


 
 <sect1 id="extensions.overview">


 
 <title id="extensions.overview.title">Overview</title>


 <para>
 <para>


 
 


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




Line 22  desirable behaviour.




Line 25  desirable behaviour.




 </para>
 </para>


 <para>
 <para>


 
 


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


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


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


 and feel free to improve extensions or create new ones to fit your needs.
 Please refer to them to get particular information.


 
 


 
 </para>


 
 <para>


 
 


 
 Extensions are currently not part of &name; distribution. They are only in


 
 <ulink url="http://www.platon.sk/cvs/cvs.php/&name;/extensions/">CVS


 
 repository</>, because they are still under development and they are changing a


 
 lot.  This manual chapter is provided for letting &name; users know, that


 
 something like this exists. The only way how to get extension files is to


 
 fetch them from CVS. All extensions need to be placed under <filename


 
 class=directory>extensions/</> subdirectory of place, where basic &name; core


 
 class is located.


 
 


 
 </para>


 
 <para>


 
 


 
 Several new extensions are planned to create to handle more or less specific


 
 tasks, especially these which are not appropriate for &name; core class. You


 
 can feel absolutely free to improve already existing extensions, suggest new


 
 improvements for them, or create new extensions to fit your own needs. We will


 
 be happy to add them to repository.


 
 


 </para>
 </para>


 
 </sect1>


 
 


 <sect1 id="extensions.slide">
 <sect1 id="extensions.slide">


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


 <para>
 <para>


 
 


 
 &name;-slide can create slideshow with ability to view and/or edit records.


 
 Everytime is exactly one record shown. Record is be displayed in view or edit


 
 mode. View mode looks like "view" functionality in normal &name;, change mode


 
 looks like "change" functionality in normal &name;.


 
 


 
 </para>


 
 <para>


 
 


 
 The only difference is that two buttons, <GUIbutton>Prev</> and


 
 <GUIbutton>Next</>, are displayed in addition to common view/edit buttons to


 
 provide ability of going to the next or previous record. This extension


 
 purpously disable "add", "copy", "delete", and "table listing"


 
 functionalities.


 
 


 
 </para>


 
 <para>


 
 


 
 Here are extension related configuration variables. All of these &name;-slide


 
 options are optional.


 
 


 
 <simplelist type=horiz columns=2>


 
 <member> &nbsp; <varname>$opts['ext']['rec']</></>


 
 <member> -- primary key value of record to display initially</>


 
 <member> &nbsp; <varname>$opts['ext']['next_disable']</></>


 
 <member> -- disable <GUIbutton>Next</> button</>


 
 <member> &nbsp; <varname>$opts['ext']['prev_disable']</></>


 
 <member> -- disable <GUIbutton>Prev</> button</>


 
 </simplelist>


 
 


 
 </para>


 
 <para>


 
 


 
 Following variables are not options, but they are used internally by


 
 extension. They can be used for getting some information for example in


 
 triggers.


 
 


 
 <simplelist type=horiz columns=2>


 
 <member> &nbsp; <varname>$opts['ext']['next']</></>


 
 <member> -- primary key value of next record</>


 
 <member> &nbsp; <varname>$opts['ext']['prev']</></>


 
 <member> -- primary key value of previous record</>


 
 </simplelist>


 
 


 </para>
 </para>


 </sect1>
 </sect1>


 
 









Legend:


Removed from v.1.5
 


changed lines


 
Added in v.1.6


















Platon Group <platon@platon.org> http://platon.org/
  Up to  [Platon] / phpMyEdit / doc / sgml
-version 1.5, 2003/02/18 00:17:27
+version 1.6, 2003/03/31 00:11:41
 Line 1
 Line 1
 Line 1
- <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.4 2002/12/03 21:05:51 nepto Exp $ -->
+ <!-- $Platon: phpMyEdit/doc/sgml/extensions.sgml,v 1.5 2003/02/18 00:17:27 nepto Exp $ -->
  <chapter id="extensions">
  <title id="extensions.title">Extensions</title>
 Line 11  these particular requirements into core
 Line 11  these particular requirements into core
 Line 11  these particular requirements into core
  extension mechanism provided.
  </para>
+ <sect1 id="extensions.overview">
+ <title id="extensions.overview.title">Overview</title>
  <para>
  Extensions are &name;_&lt;something&gt; classes, where &lt;something&gt; is
-Line 22  desirable behaviour.
+Line 25  desirable behaviour.
 Line 22  desirable behaviour.
 Line 25  desirable behaviour.
  </para>
  <para>
- In addition to normal &name; configuration options, extension configuration is
+ In addition to common &name; configuration options, extension configuration is
- provided by <varname>$opts['ext']</varname> associative array. Possible keys
+ usually provided by <varname>$opts['ext']</varname> associative array.
- are described on particular extension pages in this manual. Please refer to them
+ Possible keys are described on particular extension pages in this manual.
- and feel free to improve extensions or create new ones to fit your needs.
+ Please refer to them to get particular information.
+ </para>
+ <para>
+ Extensions are currently not part of &name; distribution. They are only in
+ <ulink url="http://www.platon.sk/cvs/cvs.php/&name;/extensions/">CVS
+ repository</>, because they are still under development and they are changing a
+ lot.  This manual chapter is provided for letting &name; users know, that
+ something like this exists. The only way how to get extension files is to
+ fetch them from CVS. All extensions need to be placed under <filename
+ class=directory>extensions/</> subdirectory of place, where basic &name; core
+ class is located.
+ </para>
+ <para>
+ Several new extensions are planned to create to handle more or less specific
+ tasks, especially these which are not appropriate for &name; core class. You
+ can feel absolutely free to improve already existing extensions, suggest new
+ improvements for them, or create new extensions to fit your own needs. We will
+ be happy to add them to repository.
  </para>
+ </sect1>
  <sect1 id="extensions.slide">
  <title id="extensions.slide.title">&name;-slide</title>
  <para>
+ &name;-slide can create slideshow with ability to view and/or edit records.
+ Everytime is exactly one record shown. Record is be displayed in view or edit
+ mode. View mode looks like "view" functionality in normal &name;, change mode
+ looks like "change" functionality in normal &name;.
+ </para>
+ <para>
+ The only difference is that two buttons, <GUIbutton>Prev</> and
+ <GUIbutton>Next</>, are displayed in addition to common view/edit buttons to
+ provide ability of going to the next or previous record. This extension
+ purpously disable "add", "copy", "delete", and "table listing"
+ functionalities.
+ </para>
+ <para>
+ Here are extension related configuration variables. All of these &name;-slide
+ options are optional.
+ <simplelist type=horiz columns=2>
+ <member> &nbsp; <varname>$opts['ext']['rec']</></>
+ <member> -- primary key value of record to display initially</>
+ <member> &nbsp; <varname>$opts['ext']['next_disable']</></>
+ <member> -- disable <GUIbutton>Next</> button</>
+ <member> &nbsp; <varname>$opts['ext']['prev_disable']</></>
+ <member> -- disable <GUIbutton>Prev</> button</>
+ </simplelist>
+ </para>
+ <para>
+ Following variables are not options, but they are used internally by
+ extension. They can be used for getting some information for example in
+ triggers.
+ <simplelist type=horiz columns=2>
+ <member> &nbsp; <varname>$opts['ext']['next']</></>
+ <member> -- primary key value of next record</>
+ <member> &nbsp; <varname>$opts['ext']['prev']</></>
+ <member> -- primary key value of previous record</>
+ </simplelist>
  </para>
  </sect1>
 Legend:


Removed from v.1.5
 


changed lines


 
Added in v.1.6
 Legend:


Removed from v.1.5
 


changed lines


 
Added in v.1.6
-Removed from v.1.5
+Added in v.1.6


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