Diff for /autoform/www/development.html between versions 1.5 and 1.9

version 1.5, 2005/03/30 13:27:47 version 1.9, 2005/03/30 14:41:38
Line 37 Line 37
                 <td class="dashed" colspan="9">                  <td class="dashed" colspan="9">
                     <p>If you are <i>really</i> interested in developing autoform, please read the following informations carefully. You should have                      <p>If you are <i>really</i> interested in developing autoform, please read the following informations carefully. You should have
                     knowledge of html, javascript, XUL, XPCOM and RDF.</p>                      knowledge of html, javascript, XUL, XPCOM and RDF.</p>
                    <p>If you wanna localise the plugin, wait until it has been released.</p>                    <p>If you want to localise the extension, please wait until the new one has been released.</p>
                     <p>I'm using <a href="http://www.eclipse.org">Eclipse</a> as my IDE and I can strongly recommend it. It has built in support for <a href="http://www.cvshome.org">cvs</a> and <a href="http://ant.apache.org">ant</a>                      <p>I'm using <a href="http://www.eclipse.org">Eclipse</a> as my IDE and I can strongly recommend it. It has built in support for <a href="http://www.cvshome.org">cvs</a> and <a href="http://ant.apache.org">ant</a>
                     (which is used by autoform for packaging and deployment). There are also many plugins available to extend the standard functions. I'm                      (which is used by autoform for packaging and deployment). There are also many plugins available to extend the standard functions. I'm
                    also using the <a href="http://www.myeclipseide.com/">myeclipseide</a> plugin for eclipse to have a html and javascript editor.</p>                    also using the <a href="http://www.myeclipseide.com/">myeclipseide</a> plugin for eclipse to have a html and javascript editor. The generate the javascript doc, I use <a href="http://jsdoc.sourceforge.net/">JSDoc</a></p>
                     <p>I really appreciate every help to develop the extension, but please understand that I first must see some implementation before I                      <p>I really appreciate every help to develop the extension, but please understand that I first must see some implementation before I
                    can give you write access to the cvs. Please contact <a href="mailto:michael.kessler@swisscom.com">me</a> before starting, to prevent 'development collisions' ;-)</p>                    can give you write access to the cvs. Please contact <a href="mailto:michael.kessler@swisscom.com">me</a> before starting to prevent collisions)</p>
                    <p><b>How you get started:</b>                    <p><b>How to get started:</b>
                     <ol>                      <ol>
                         <li>Install eclipse.</li>                          <li>Install eclipse.</li>
                         <li>Check out the source code from cvs</li>                          <li>Check out the source code from cvs</li>
                         <li>Configure the build.properties and copy to your home directory</li>                          <li>Configure the build.properties and copy to your home directory</li>
                         <li>Build and install the extension</li>                          <li>Build and install the extension</li>
                        <li>Make you familiary with the code and the used technologies</li>                        <li>Make you familiary with the existing code</li>
                         <li>Implement a feature on the todo list and send me the patch</li>                          <li>Implement a feature on the todo list and send me the patch</li>
                     </ol>                      </ol>
                     </p>                      </p>
Line 67 Line 67
                             </pre>                              </pre>
                         </li>                          </li>
                     </ul>                      </ul>
                       <p>There is also a jsdoc online <a href="/jsdoc/index.html">here</a>.
                     <br />                      <br />
                     <hr />                      <hr />
                    <h3>Project setup</h3>                    <h3>Development guide</h3>
                     <hr />                      <hr />
                    <p>If you have checked out the source code, you'll have four folders in your project. The 'www' folder contains the content of this website and the 'downloads' folder contains                    <p>To avoid mistakes made in the first version and have a maintainable clean code, follow the following simple rules:
                    releases, which will be synchronized with the mozdev mirrors. The main extension resides in the folders 'new' and 'old'. Those two folders contains another two folders. The 'build' folder contains                        <ul>
                    the ant script and properties to build, install, tag and deploy new extension releases. The 'src' folder contains the chrome structure with the plugin code, locales and its skin.</p>                            <li>Make small js file with clear responsibility (no all mighty js files)</li>
                             <li>Make packages (folders) to separate the js files</li>
                             <li>Descibe every 'class' and function with the <a href="http://jsdoc.sourceforge.net/">jsdoc</a> tags</li>
                             <li>Use self-describing names for functions and variables (not cryptic)</li>
                         </ul>
                     </p>
                     <p>The whole plugin configuration with virtual users, configurable toolbar has already been rewritten in this style. Please have a look at it, there isn't any big js file, everying is separated very clearly.</p>
                     <p><b>TODO</b>
                         <ol>
                             <li>Formdata store - The old version uses the preference store, which is really a bad idea. It is hard to manage, import and export.
                             When it grows it slows down firefox. The idea to rewrite it is that each virtual user has a own RDF file with the form data. 
                             This makes it more simpler to display in a XUL Treeview, since it can be used as a datasource and import/export is only a matter of
                             copy files. It should be implemented like the preferences, a RDFService parent class which handles the storage of the data. Every
                             form element should have a own js class which inherits from the RDFService.</li>
                             <li>Autoload/Autosave/Exclude Parameters logic</li>
                             <li>Optional encryption of all form data. Add a configurable timeout for the masterpassword and a unset button.</li>
                             <li>Edit/Export/Import stored form data</li>
                         </ol>
                     </p>
                     <p>The TODO implementation techniques are only a proposal, feel free to discuss it on the mailing list.</p>
                     <br />                      <br />
                     <hr />                      <hr />
                     <h3>Report bugs</h3>                      <h3>Report bugs</h3>

Removed from v.1.5  
changed lines
  Added in v.1.9


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>