sTEFANs Subversion Web Contol (SWC)
Inc-Resources
[ class tree: Swc ] [ index: Swc ] [ all elements ]

Source for file en_swc_help.php

Documentation is available at en_swc_help.php

  1. <?php
  2. /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. SVN Web Control
  4. Copyright ©2006 by sTEFANs
  5. Created on 17.03.2006
  6. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11.  
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with this program; if not, write to the Free Software
  19. Foundation, Inc., 59 Temple Place - Suite 330,
  20. Boston, MA 02111-1307, USA.
  21. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22. */
  23.  
  24. /**
  25.  * Body text of help page. Instead of translating the very long text,
  26.  * a 'translated' include page is used to provide the help text
  27.  * in the correct language.<br>
  28.  * This file contains the English variant of help text.
  29.  * 
  30.  * @package Swc
  31.  * @subpackage Inc-Resources
  32.  * @author Stefan Schraml
  33.  * @copyright Copyright ©2006 by sTEFANs
  34.  * @license http://opensource.org/licenses/lgpl-license.php GNU General Public License
  35.  * @version v1.0.0
  36.  * @since v1.0.0
  37.  */
  38. print '
  39.     <div class="text_low">Depending on the state of the webspace, SWC offers different 
  40.         functionalities and views. The upper part of the browser window contains SWC control panel, the 
  41.         lower, bigger, part (where also this text could appear now) contains either the project page 
  42.         or SVN related information. If no or an incorrect SWC configuration is applied, 
  43.         according error messages are displayed in that area. Please refer to    
  44.         <span class="text_low_bold">SWC installation and configuration description</span> 
  45.         for more information about SWC configuration.<br/>
  46.         If everything is set up correctly and more than one project is configured for SWC, 
  47.         the control panel offers a selection of these projects. After selection of a 
  48.         project the complete panel is visible.<br/><br/>
  49.     </div>
  50.     <div class="title">Note:<br/><br/></div>
  51.     <div class="text_low">SWC usually reacts immideately on changes of
  52.         checkboxes. Unfortunately this behaviour does not work with MS
  53.         Internet Explorer. As specified by W3C, IE reacts upon such a change
  54.         after a different element is selected. For this reason it is neccessary
  55.         to click on any area of the page to apply changes.<br/><br/>
  56.     </div>
  57.     <div class="title">SWC Control Panel - Checkout View<br/><br/></div>
  58.     <div class="text_low">SWC checks whether the selected project is already checked out. 
  59.         If no checked out files are detected, it offers 
  60.         some information about the repository and a button to check out the project.<br/><br/>
  61.     </div>
  62.     <table class="description">
  63.         <tr>
  64.             <td class="description"><div class="text_low_bold">Project name</div></td>
  65.             <td class="description">The most left text in the first line is 
  66.                 the name of the selected project as configured. Below the project name the 
  67.                 used version of <a href="http://subversion.tigris.org" target="_blank">
  68.                 <u>Subversion</u></a> is displayed.
  69.             </td>
  70.         </tr><tr>
  71.             <td class="description"><div class="text_low_bold">'.T(TK_CTRL_TITLE_HEAD).'</div></td>
  72.             <td class="description">Revision number and timestamp of the most recent revision 
  73.                 available in the repository. This revision    will be checked out. Depending on 
  74.                 localisation settings the timestamp    could contain calendar week and day of the year. 
  75.             </td>
  76.         </tr><tr>
  77.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_CHECKOUT).'</div></td>
  78.             <td class="description">Checks out the latest revision into the webspace.</td>
  79.         </tr><tr>
  80.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SWC_HELP).'</div></td>
  81.             <td class="description">This text.</td>
  82.         </tr>
  83.     </table>
  84.  
  85.     <br/><br/>
  86.     <div class="title">SWC Control Panel - Project View<br/><br/></div>
  87.     <div class="text_low">For checked out projects SWC offers its functionality in
  88.         different bars. Some of these bars could be not visible in some cases.<br/><br/>
  89.     </div>
  90.     <div class="title">Info Bar</div>
  91.     <table class="description">
  92.         <tr>
  93.             <td class="description"><div class="text_low_bold">Project name</div></td>
  94.             <td class="description">The most left text in the first line is 
  95.                 the name of the selected project as configured. Below the project name the 
  96.                 used version of subversion is displayed.
  97.             </td>
  98.         </tr><tr>
  99.             <td class="description"><div class="text_low_bold">'.T(TK_CTRL_TITLE_HEAD).'</div></td>
  100.             <td class="description">Revision number and timestamp of the most recent revision 
  101.                 available in the repository. This revision    will be checked-out. The timestamp
  102.                 can contain calendar week and day of the year, depending on the localisation
  103.                 settings. 
  104.             </td>
  105.         </tr><tr>
  106.             <td class="description"><div class="text_low_bold">'.T(TK_CTRL_TITLE_WS).'</div></td>
  107.             <td class="description">Revision number, repository path, and timestamp of revision 
  108.                 available in the webspace. Depending on localisation settings the timestamp    
  109.                 could contain calendar week and day of the year. 
  110.             </td>
  111.         </tr><tr>
  112.             <td class="description"><div class="text_low">'.T(TK_CTRL_ACTION_MINIMIZE).'</div></td>
  113.             <td class="description">Shrinks SWC panel to a compact variant of the info-bar.
  114.                 If the checkbox is checked, only a single line info bar is displayed. Version
  115.                 of subversion and timestamps are not shown in this mode.                
  116.             </td>
  117.         </tr><tr>
  118.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_UPDATE).'</div></td>
  119.             <td class="description">Updates the webspace with the latest version (SVN head) available
  120.                 within the repository. If the version of webspace matches the latest repository revision
  121.                 this button is shown as disabled but still working. If the webspace is not up to date,
  122.                 the warning "<span class="text_low_bold_red">'.T(TK_CTRL_WARN_WS_OUTDATED).'</span>" 
  123.                 is displayed in front of the button.                
  124.             </td>
  125.         </tr><tr>
  126.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SWC_HELP).'</div></td>
  127.             <td class="description">This text.</td>
  128.         </tr>
  129.     </table>
  130.  
  131.     <br/>
  132.     </div>
  133.     <div class="title">Action Bar</div>
  134.     <table class="description">
  135.         <tr>
  136.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_REFRESH).'</div></td>
  137.             <td class="description">Refreshes the information of SWC. Please note
  138.                 that also other pages, such as project page are reloaded.
  139.             </td>
  140.         </tr><tr>
  141.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_PROJECTPAGE).'</div></td>
  142.             <td class="description">Shows the project page below SWC control panel. 
  143.             </td>
  144.         </tr><tr>
  145.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_REPOSITORY).'</div></td>
  146.             <td class="description">Shows repository view below SWC control panel
  147.                 as provided by SVN Web access. 
  148.             </td>
  149.         </tr><tr>
  150.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_WEBSVN).'</div></td>
  151.             <td class="description">Opens the corresponding Web SVN view below the SWC control panel.                 
  152.                 <a href="http://websvn.tigris.org/" target="_blank"><u>WebSVN</u></a> must be installed properly 
  153.                 and the project configuration must point to WebSVN, otherwise this button is not visible at all.
  154.             </td>
  155.         </tr><tr>
  156.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_WS_INFO).'</div></td>
  157.             <td class="description">Displays information about the webspace below the SWC control panel.<br>
  158.                 Executed command: svn info. Please refer to SVN documentation for further information.
  159.             </td>
  160.         </tr><tr>
  161.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_WS_STATUS).'</div></td>
  162.             <td class="description">Displays status of webspace below the SWC control panel.<br>
  163.                 Executed command: svn status. Please refer to SVN documentation for further information.
  164.             </td>
  165.         </tr><tr>
  166.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_WS_LOG).'</div></td>
  167.             <td class="description">Displays webspace log below the SWC control panel.<br>
  168.                 Executed command: svn log. Please refer to SVN documentation for further information.
  169.             </td>
  170.         </tr><tr>
  171.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_WS_CLEANUP).'</div></td>
  172.             <td class="description">Cleans up the webspace and displays the result below the SWC control panel.<br>
  173.                 Executed command: svn cleanup. Please refer to SVN documentation for further information.
  174.             </td>
  175.         </tr><tr>
  176.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SHOW_ARCHIVE_PAGE).'</div></td>
  177.             <td class="description">Allows to create new and download existing spaceballs. Spaceballs
  178.                 are file archives in ZIP format that contains a shnapshot of the current webspace without
  179.                 .svn directories.<br/>
  180.                 This can be usefull to create e.g. file releases of a tested webspace.
  181.             </td>
  182.         </tr>
  183.     </table>
  184.  
  185.     <br/>
  186.     </div>
  187.     <div class="title">SVN Command Bar</div>
  188.     <div class="text_low">Note: This bar is not shown if it is disabled via
  189.         project configuration or if checkbox "'.
  190.         str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_SHOW_CMDBAR)).'"
  191.         is not checked.</div>
  192.     <table class="description">
  193.         <tr>
  194.             <td class="description"><div class="text_low_bold">'.T(TK_CTRL_LABEL_SVN_CMD).'</div></td>
  195.             <td class="description">SVN command to be executed.
  196.             </td>
  197.         </tr><tr>
  198.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SVN_CMD).'</div></td>
  199.             <td class="description">Executes the applied SVN command. The output of the execution
  200.                 is shown below the SWC panel.    If no command is applied or 
  201.                 the command is not an SVN command, an error message is displayed.<br>
  202.                 '.T(TK_RESULT_SVN_HELP_HEADER).'
  203.                 '.T(TK_RESULT_SVN_HELP_REP_LONG).'
  204.                 '.T(TK_RESULT_SVN_HELP_REP_SHORT).'
  205.                 '.T(TK_RESULT_SVN_HELP_WS_LONG).'
  206.                 '.T(TK_RESULT_SVN_HELP_WS_SHORT).'
  207.             </td>
  208.         </tr><tr>
  209.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SVN_HELP).'</div></td>
  210.             <td class="description">Displays help texts of SVN below SWC control panel. 
  211.             </td>
  212.         </tr>
  213.     </table>
  214.  
  215.     <br/>
  216.     </div>
  217.     <div class="title">Switch Bar</div>
  218.     <div class="text_low">Note: This bar is not shown if checkbox "'.
  219.         str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_SHOW_SWITCHBAR)).'"
  220.         is not checked.</div>
  221.     <table class="description">
  222.         <tr>
  223.             <td class="description"><div class="text_low_bold">'.T(TK_CTRL_LABEL_PROJECTS).'</div></td>
  224.             <td class="description">List of projects which are available via SWC. This list 
  225.                 is shown if more than one project is available. If a different project is selected,
  226.                 this project is loaded below SWC control panel.
  227.             </td>
  228.         </tr><tr>
  229.             <td class="description"><div class="text_low_link">'.T(TK_CTRL_ACTION_SWITCH_TO_HEAD).'</div></td>
  230.             <td class="description">Switch to the latest version (head) within the repository.
  231.             </td>
  232.         </tr><tr>
  233.             <td class="description"><div class="text_low_bold">'.T(TK_CTRL_LABEL_SWITCH_TO_TAG).'</div></td>
  234.             <td class="description">List of available tags as configured within project configuration.
  235.                 The webspace is switched to the selected tag when hitting 
  236.                 <span class="text_low_link">'.T(TK_CTRL_ACTION_SWITCH).'</span>
  237.             </td>
  238.         </tr><tr>
  239.             <td class="description"><div class="text_low_bold">'.T(TK_CTRL_LABEL_SWITCH_TO_BRANCH).'</div></td>
  240.             <td class="description">List of available branches as configured within project configuration.
  241.                 The webspace is switched to the selected tag when hitting 
  242.                 <span class="text_low_link">'.T(TK_CTRL_ACTION_SWITCH).'</span>
  243.             </td>
  244.         </tr>
  245.     </table>
  246.  
  247.     <br/>
  248.     </div>
  249.     <div class="title">User Settings Bar</div>
  250.     <table class="description">
  251.         <tr>
  252.             <td class="description"><div class="text_low_link">'.
  253.                 str_ireplace('<br/>'' 'T(TK_CTRL_ACTION_OPEN_PROJECTPAGE)).'</div></td>
  254.             <td class="description">Opens the project page in an independent browser window. This is helpful
  255.                 to prevent the project from reloading when SWC is refreshed and to proof special aspects
  256.                 of the browser window, such as title.
  257.             </td>
  258.         </tr><tr>
  259.             <td class="description"><div class="text_low_bold">'.
  260.                 str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_PIN_PROJECTPAGE)).'</div></td>
  261.             <td class="description">Pins the project page below SWC control panel and 
  262.                 prevents showing other information in that area. This option is useful
  263.                 together with "'.str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_SEPARATE_RESULT_WINDOW)).'".
  264.             </td>
  265.         </tr><tr>
  266.             <td class="description"><div class="text_low_bold">'.
  267.                 str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_SEPARATE_RESULT_WINDOW)).'</div></td>
  268.             <td class="description">Shows other information than the project page in a pop-up browser window.
  269.                 This option is useful    together with "'.
  270.                 str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_PIN_PROJECTPAGE)).'".
  271.             </td>
  272.         </tr><tr>
  273.             <td class="description"><div class="text_low_bold">'.
  274.                 str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_SHOW_SWITCHBAR)).'</div></td>
  275.             <td class="description">Shows or hides Switch Bar to make SWC more compact.
  276.             </td>
  277.         </tr><tr>
  278.             <td class="description"><div class="text_low_bold">'.
  279.                 str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_SHOW_CMDBAR)).'</div></td>
  280.             <td class="description">Shows or hides SVN Command Bar to make SWC more compact.
  281.                 This checkbox is not shown if SVN Command Bar is disabled via project configuration.
  282.             </td>
  283.         </tr><tr>
  284.             <td class="description"><div class="text_low_bold">'.
  285.                 str_ireplace('<br/>'' 'T(TK_CTRL_LABEL_FRAME_SIZE)).'</div></td>
  286.             <td class="description">Specifies the dimension of the embedded frame for project page.
  287.                 The left text field accepts the frame width and the right text field the frame height
  288.                 in pixel. The size is applied with 
  289.                 <span class="text_low_link">'.T(TK_CTRL_ACTION_SET_FRAME_SIZE).'</span><br/>
  290.                 This function is useful to determine whether the project page fits into the
  291.                 desired dimensions.
  292.             </td>
  293.         </tr>
  294.     </table>
  295.  
  296.     <br/><br/>
  297.     <div class="title">SVN Command Result<br/><br/></div>
  298.     <div class="text_low">The area below the SWC control panel displays various
  299.         information, also depending on certain settings as described above. It
  300.         also displays results of executed SVN commands.<br/>
  301.     </div>
  302.     <table class="description">
  303.         <tr>
  304.             <td class="description"><div class="text_low_bold">Title</div></td>
  305.             <td class="description">The first line contains the tile of the information.
  306.             </td>
  307.         </tr><tr>
  308.             <td class="description"><div class="text_low_bold">'.T(TK_DETAILS_LABEL_CMDLINE).'</div></td>
  309.             <td class="description">Displays the command line as it was executed. 
  310.             </td>
  311.         </tr><tr>
  312.             <td class="description"><div class="description" class="text_low_bold">'.
  313.                 T(TK_DETAILS_LABEL_RESULT_CODE).'</div></td>
  314.             <td class="description">Displays the numerical result code of the 
  315.                 command execution.
  316.             </td>
  317.         </tr><tr>
  318.             <td class="description"><div class="text_low_bold">'.T(TK_DETAILS_LABEL_OUTPUT).'</div></td>
  319.             <td class="description">Displays the formatted standard output as retrieved
  320.                 during command execution. 
  321.             </td>
  322.         </tr><tr>
  323.             <td class="description"><div class="text_low">'.T(TK_DETAILS_LABEL_ERROR).'</div></td>
  324.             <td class="description">Displays the formatted error output as retrieved
  325.                 during command execution.                
  326.             </td>
  327.         </tr>
  328.     </table>
  329.  
  330.     <br/><hr/>
  331.     <div class="title">Credits<br/><br/>
  332.     <table>
  333.         <tr>
  334.             <td class="title">POWERED BY</td>
  335.             <td class="text_low_bold">Developed on</td>
  336.             <td class="text_low_bold">using</td>
  337.             <td class="text_low_bold">to control within your Browser</td>
  338.         </tr><tr>
  339.             <td>
  340.                 <a href="http://www.ebc.bz" target="_blank">
  341.                     <img src="./inc/resources/logos/ebc.bz_logo.jpg" border="0" alt="eBC.bz"/>
  342.                 </a>
  343.             </td>
  344.             <td>
  345.                 <a href="http://www.eclipse.org/" target="_blank">
  346.                     <img src="./inc/resources/logos/eclipse_logo.gif" border="0" alt="Eclipse">
  347.                 </a>
  348.             </td>
  349.             <td>
  350.                 <a href="http://www.phpeclipse.de/" target="_blank">
  351.                     <img src="./inc/resources/logos/phpeclipse_logo.jpg" border="0" alt="PHPEclipse">
  352.                 </a>
  353.             </td>
  354.             <td>
  355.                 <a href="http://subversion.tigris.org/" title="Subversion" target="_blank">
  356.                     <img src="./inc/resources/logos/subversion_logo.png" border="0" alt="Subversion">
  357.                 </a>
  358.             </td>
  359.         </tr><tr>
  360.             <td class="text_low_bold">Optimised for</td>
  361.             <td class="text_low_bold">but works also well with</td>                
  362.             <td class="text_low_bold" colspan="2">Complies with</td>
  363.         </tr><tr>
  364.             <td>
  365.                 <a href="http://getfirefox.com/" title="Firefox" target="_blank">
  366.                     <img src="./inc/resources/logos/firefox_logo.png" border="0" alt="Get Firefox">
  367.                 </a>
  368.             </td>
  369.             <td>
  370.                 <a href="http://my.opera.com/USERNAME/affiliate/">
  371.                     <img src="./inc/resources/logos/opera_logo.png" border="0" alt="Opera" /></a></td>
  372.             </td>
  373.             <td colspan="2">
  374.             <a href="http://validator.w3.org/check?uri=referer" target="_blank">
  375.                     <img src="./inc/resources/logos/valid-xhtml10.png" border="0" alt="Valid XHTML 1.0 Transitional"/>
  376.                 </a>
  377.                 <img src="./inc/resources/logos/vcss.gif" border="0" alt="Valid CSS"/>
  378.             </td>
  379.         </tr><tr>                            
  380.             <td class="text_low_bold" colspan="3">Logos and trademarks belong to the according companies</td>
  381.         </tr>
  382.   </table>
  383. ';
  384.  
  385. ?>

Documentation generated on Fri, 03 Nov 2006 18:44:58 +0100 by phpDocumentor 1.3.0RC6
for sTEFANs POWERED BY eBC.bz