[Phpgroupware-cvs] CVS: etemplate/doc etemplate.html,1.16,1.17

[Ralf Becker <address@hidden>]

Update of /cvsroot/phpgroupware/etemplate/doc
In directory subversions:/tmp/cvs-serv15805

Modified Files:
        etemplate.html 
Log Message:
changed $GLOBALS['setup_info'] to $setup_info (it gets included within a 
function in setup)
remove step 2) as db-tools now show uninstalled apps to create tables for


Index: etemplate.html
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/doc/etemplate.html,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -r1.16 -r1.17
*** etemplate.html      19 Oct 2002 11:15:23 -0000      1.16
--- etemplate.html      19 Mar 2003 17:04:08 -0000      1.17
***************
*** 64,95 ****
  </pre>
  
! <h2>2. registering the app manualy</h2>
! <p>To be able to see the app in the navbar and call it we need to do the 
following steps (later this can be done via setup)</p>
! <ol>
!       <li>login to phpgw as an admin
!       <li>call the admin app (the first icon with the tower)
!       <li>start Admin/Applications
!       <li>click on Add
!       <li>type in 'et_media' for the app-name and eg. 'eT-Media' for the 
titel, leave the rest alone and hit Add
!       <li>start Admin/User accounts and enable the new app for your account
! </ol>
! 
! <h2>3. creating <b>et_media/setup/setup.inc.php</b></h2>
  <p>That files contains the necessary information for setup to install the 
app. </p>
  <pre>
  &lt;?php
!       $GLOBALS['setup_info']['et_media']['name']      = 'et_media';
!       $GLOBALS['setup_info']['et_media']['title']     = 'eT-Media';
!       $GLOBALS['setup_info']['et_media']['version']   = '0.9.15.001';
!       $GLOBALS['setup_info']['et_media']['app_order'] = 100;          
<span>// at the end</span>
!       $GLOBALS['setup_info']['et_media']['tables']    = 
array('phpgw_et_media');
!       $GLOBALS['setup_info']['et_media']['enable']    = 1;
  
        <span>/* Dependencies for this app to work */</span>
!       $GLOBALS['setup_info']['et_media']['depends'][] = array(
                 'appname' => 'phpgwapi',
                 'versions' => Array('0.9.13','0.9.14','0.9.15')
        );
!       $GLOBALS['setup_info']['et_media']['depends'][] = array(        
<span>// this is only necessary as long the etemplate-class is not in the 
api</span>
                 'appname' => 'etemplate',
                 'versions' => Array('0.9.13','0.9.14','0.9.15')
--- 64,84 ----
  </pre>
  
! <h2>2. creating <b>et_media/setup/setup.inc.php</b></h2>
  <p>That files contains the necessary information for setup to install the 
app. </p>
  <pre>
  &lt;?php
!       $setup_info['et_media']['name']      = 'et_media';
!       $setup_info['et_media']['title']     = 'eT-Media';
!       $setup_info['et_media']['version']   = '0.9.15.001';
!       $setup_info['et_media']['app_order'] = 100;             <span>// at the 
end</span>
!       $setup_info['et_media']['tables']    = array('phpgw_et_media');
!       $setup_info['et_media']['enable']    = 1;
  
        <span>/* Dependencies for this app to work */</span>
!       setup_info['et_media']['depends'][] = array(
                 'appname' => 'phpgwapi',
                 'versions' => Array('0.9.13','0.9.14','0.9.15')
        );
!       $setup_info['et_media']['depends'][] = array(   <span>// this is only 
necessary as long the etemplate-class is not in the api</span>
                 'appname' => 'etemplate',
                 'versions' => Array('0.9.13','0.9.14','0.9.15')
***************
*** 97,101 ****
  </pre>
  
! <h2>4. setting up the db-table with the db_tools and setup</h2>
  <p>To enable setup to create a db-table for us and to supply the 
<b>so_sql</b>-class with the necessary information, we need to define
  the type and size of the fields / columns in our db-table.<br>
--- 86,90 ----
  </pre>
  
! <h2>3. setting up the db-table with the db_tools and setup</h2>
  <p>To enable setup to create a db-table for us and to supply the 
<b>so_sql</b>-class with the necessary information, we need to define
  the type and size of the fields / columns in our db-table.<br>
***************
*** 111,122 ****
        <li>Click on [Write Table] (If you get the error-message like in the 
screenshot, you need to give the webserver write-permission
        to the setup-dir of et_media, leave the write-permission as it is 
necessary later on too, click on write again)
!       <li>log out and log into setup again and start manage applications
!       <li>eT-Media is shown now as installed but need upgrade, don't select 
upgrade, check remove and submit
!       <li>the next page should tell you everythings allright so click on go 
back (or if u use konqueror reload)
!       <li>now for eT-Media only install is offerd, check it and submit
!       <li>you can now log out of setup, out db-table is now created
  </ol>
  
! <h2>5. creating an eTemplates for the edit-dialog</h2>
  <p>Now we need a nice edit dialog and use the eTemplate editor to set it 
up:</p>
  
--- 100,109 ----
        <li>Click on [Write Table] (If you get the error-message like in the 
screenshot, you need to give the webserver write-permission
        to the setup-dir of et_media, leave the write-permission as it is 
necessary later on too, click on write again)
!       <li>log out and log into setup and start manage applications
!       <li>eT-Media is shown as not installed and only install is offerd, 
check it and submit
!       <li>you can now log out from setup, the db-table is now created
  </ol>
  
! <h2>4. creating an eTemplates for the edit-dialog</h2>
  <p>Now we need a nice edit dialog and use the eTemplate editor to set it 
up:</p>
  
***************
*** 134,138 ****
  <p>As you see above i added an application titel, a horizontal rule after it 
and some space (empty label's). Do so if you want.</p>
  
! <h2>6. setting up the index page</h2>
  <p>The index page is only used if someone clicks on the navbar icon (or on 
the black cross as we haven't supplied one so far).<br>
  Create the file <b>/et_media/index.php</b> with the following content:</p>
--- 121,125 ----
  <p>As you see above i added an application titel, a horizontal rule after it 
and some space (empty label's). Do so if you want.</p>
  
! <h2>5. setting up the index page</h2>
  <p>The index page is only used if someone clicks on the navbar icon (or on 
the black cross as we haven't supplied one so far).<br>
  Create the file <b>/et_media/index.php</b> with the following content:</p>
***************
*** 152,156 ****
  </pre>
  
! <h2>7. the code of class.et_media.inc.php</h2>
  <p>As a first step, we only save new entries. The code of the app is in 
<b>/et_media/inc/class.et_media.inc.php</b>:</p>
  
--- 139,143 ----
  </pre>
  
! <h2>6. the code of class.et_media.inc.php</h2>
  <p>As a first step, we only save new entries. The code of the app is in 
<b>/et_media/inc/class.et_media.inc.php</b>:</p>
  
***************
*** 322,326 ****
  We are only lacking some way to show if we get more than one match on a 
search, that's what we are going to implement next:</p>
  
! <h2>8. adding a list-dialog for the search-function</h2>
  <p>First we need to create an other eTemplate to show the list: 
<b>'et_media.show'</b></p>
  
--- 309,313 ----
  We are only lacking some way to show if we get more than one match on a 
search, that's what we are going to implement next:</p>
  
! <h2>7. adding a list-dialog for the search-function</h2>
  <p>First we need to create an other eTemplate to show the list: 
<b>'et_media.show'</b></p>
  
***************
*** 439,443 ****
  'cancel' and 'delete', a Label and a nice helpmessages by now without looking 
at a screenshot ;-).</p>
  
! <h2>9. creating the english lang-file</h2>
  <p>To get rid of the stars '*' behind each Label and to be able to translate 
the app in other languages we need to create a lang-file<br>
  There are 2 possibilties to create it automaticaly:</p>
--- 426,430 ----
  'cancel' and 'delete', a Label and a nice helpmessages by now without looking 
at a screenshot ;-).</p>
  
! <h2>8. creating the english lang-file</h2>
  <p>To get rid of the stars '*' behind each Label and to be able to translate 
the app in other languages we need to create a lang-file<br>
  There are 2 possibilties to create it automaticaly:</p>
***************
*** 466,470 ****
  </pre>
  
! <h2>10. dumping the eTemplate to a file for distribution</h2>
  <p>To be able to put the eTemplates in CVS and to ship them with your app, 
you need to dump them in a file first.
  <p>This is done in the eTemplate editor by putting the app-name or an 
template-name in the Name field and clicking on the button
--- 453,457 ----
  </pre>
  
! <h2>9. dumping the eTemplate to a file for distribution</h2>
  <p>To be able to put the eTemplates in CVS and to ship them with your app, 
you need to dump them in a file first.
  <p>This is done in the eTemplate editor by putting the app-name or an 
template-name in the Name field and clicking on the button
***************
*** 472,476 ****
  a new version automaticaly.</p>
  
! <h2>11. further information</h2>
  <ol>
        <li>the <a href="referenz.html">referenz-documentation</a> of the 
eTemplates
--- 459,463 ----
  a new version automaticaly.</p>
  
! <h2>10. further information</h2>
  <ol>
        <li>the <a href="referenz.html">referenz-documentation</a> of the 
eTemplates