net.sourceforge.phpeclipse.help/docbook-src/guide/src/en/user-manual/install_phpeclipse.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!-- jEdit buffer-local properties: -->
   3 <!-- :indentSize=2:noTabs=true: -->
   4 <!-- :xml.root=docmaster.xml: -->
   5
   6 <sect1 id="sec.install_phpeclipse">
   7   <title>Installing <application>PHPeclipse</application></title>
   8   <para>
   9     There are two ways to install this plugin, automated or manual.
  10   </para>
  11
  12   <sect2 id="sec.install_phpeclipse.automated">
  13     <title>Automated</title>
  14     <para>
  15       An automated installation of PHPEclipse is available via the Eclipse Update Manager.
  16       <itemizedlist>
  17         <listitem>
  18           <para>
  19             Click on
  20               <menuchoice>
  21                 <guimenu>Help</guimenu>
  22                 <guisubmenu>Software Updates</guisubmenu>
  23                 <guimenuitem>Find and Install...</guimenuitem>
  24               </menuchoice>
  25              from the Eclipse menu bar. See <xref linkend="fig.inst_pe_auto_1"/>
  26           </para>
  27         </listitem>
  28         <listitem>
  29           <para>
  30             Select the radio button labeled, "search for new features to install". See <xref linkend="fig.inst_pe_auto_2"/>
  31           </para>
  32         </listitem>
  33         <listitem>
  34           <para>
  35             Click on the <guibutton>New Remote Site</guibutton> button (see <xref linkend="fig.inst_pe_auto_3"/>), and input the following:
  36             <itemizedlist>
  37               <listitem>
  38                 <para>
  39                   Name: PHPeclipse official releases
  40                 </para>
  41               </listitem>
  42               <listitem>
  43                 <para>
  44                   URL: <ulink url="http://phpeclipse.sourceforge.net/update/releases"></ulink>
  45                 </para>
  46               </listitem>
  47             </itemizedlist>
  48             If you are interested in unofficial releases you can also add a second <quote>Remote Site</quote>:
  49             <itemizedlist>
  50               <listitem>
  51                 <para>
  52                   Name: PHPeclipse cvs releases
  53                 </para>
  54               </listitem>
  55               <listitem>
  56                 <para>
  57                   URL: <ulink url="http://phpeclipse.sourceforge.net/update/cvs"></ulink>
  58                 </para>
  59               </listitem>
  60             </itemizedlist>
  61           </para>
  62         </listitem>
  63         <listitem>
  64           <para>
  65             Click on <guibutton>Finish</guibutton>. &eclipse; will now look for new versions of &phpeclipse;. If the &eclipse; update manager finds something new, you can select the new version within a dialog. See <xref linkend="fig.inst_pe_auto_update_1"/>.
  66           </para>
  67         </listitem>
  68         <listitem>
  69           <para> <!-- @todo Or was it 'Finish'? -->
  70             Click on <guibutton>Next</guibutton>, and the download of the selected versions begins. See <xref linkend="fig.inst_pe_auto_update_2"/>.
  71           </para>
  72         </listitem>
  73       </itemizedlist>
  74     </para>
  75
  76     <note>
  77       <para>
  78         There may be a problem during automatic installation, if you use the <guibutton>Install All</guibutton> button during the Eclipse <quote>Find/Install</quote> feature. If the installation stops with an <quote>connection timed out</quote> message (when downloading additional files), close and restart Eclipse and use the <guibutton>Install</guibutton> button instead of the <guibutton>Install All</guibutton> button - this will require you to start the installation of the (currently) four packages manually but resolves the problem.
  79       </para>
  80     </note>
  81
  82     <figure id="fig.inst_pe_auto_1">
  83       <title>Find and Install...</title>
  84       <mediaobject>
  85         <imageobject role="html">
  86           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_1.png" format="PNG"/>
  87         </imageobject>
  88         <imageobject role="fo">
  89           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_1.png" format="PNG" width="8cm"/>
  90         </imageobject>
  91       </mediaobject>
  92     </figure>
  93
  94     <figure id="fig.inst_pe_auto_2">
  95       <title>Feature Update</title>
  96       <mediaobject>
  97         <imageobject role="html">
  98           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_2.png" format="PNG"/>
  99         </imageobject>
 100         <imageobject role="fo">
 101           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_2.png" format="PNG" width="10cm"/>
 102         </imageobject>
 103       </mediaobject>
 104     </figure>
 105
 106     <figure id="fig.inst_pe_auto_3">
 107       <title>Update sites to visit</title>
 108       <mediaobject>
 109         <imageobject role="html">
 110           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_3.png" format="PNG"/>
 111         </imageobject>
 112         <imageobject role="fo">
 113           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_3.png" format="PNG" width="10cm"/>
 114         </imageobject>
 115       </mediaobject>
 116     </figure>
 117
 118     <figure id="fig.inst_pe_auto_update_1">
 119       <title>Updates Search Results</title>
 120       <mediaobject>
 121         <imageobject role="html">
 122           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_update_1.png" format="PNG"/>
 123         </imageobject>
 124         <imageobject role="fo">
 125           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_update_1.png" format="PNG" width="10cm"/>
 126         </imageobject>
 127       </mediaobject>
 128     </figure>
 129
 130     <figure id="fig.inst_pe_auto_update_2">
 131       <title>Update Manager Progress</title>
 132       <mediaobject>
 133         <imageobject role="html">
 134           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_update_2.png" format="PNG"/>
 135         </imageobject>
 136         <imageobject role="fo">
 137           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_auto_update_2.png" format="PNG" width="8cm" />
 138         </imageobject>
 139       </mediaobject>
 140     </figure>
 141
 142     <para>
 143       Fedora Core 4 (and above) Users:
 144     </para>
 145     <para>
 146       If clicking on Help->Software Updates->Find/Install commands produces an error message like "Error creating feature "file:/usr/share/eclipse/features/org.eclipse.rcp.source_3.1.1/". [/usr/share/eclipse/features/org.eclipse.rcp.source_3.1.1/feature.xml (No such file or directory)]", start Eclipse as root and try again. (Once you're over this hurdle everything goes smoothly -- even as a non-root user!)
 147     </para>
 148   </sect2>
 149
 150
 151
 152   <sect2 id="sec.install_phpeclipse.manual">
 153     <title>Manual</title>
 154     <para>
 155       To install &phpeclipse; manually, first download the latest version from <ulink url="http://sourceforge.net/project/showfiles.php?group_id=57621">SourceForge</ulink>
 156     </para>
 157     <para>
 158       The &phpeclipse; zip file must be extracted in the same directory in which you installed &eclipse;. It contains two directories, <filename class="directory">plugins</filename> and <filename class="directory">features</filename>, and these must match to the plugins and features directory in your existing eclipse directory. See <xref linkend="fig.inst_pe_man_2"/>
 159     </para>
 160
 161     <note>
 162       <para>
 163         &eclipse; 3.x caches all plugin.xml files into a single repository for quicker loading. If you used &eclipse; before installing &phpeclipse;, you should start &eclipse; once with the -clean option. This -clean forces &eclipse; to rebuild that repository. This applies to anything that is installed into &eclipse; by unzipping it into its plugins folder.
 164       </para>
 165     </note>
 166
 167     <para>
 168       After extracting &phpeclipse;, (re)start &eclipse;. &phpeclipse; will be loaded automatically. If NOT, you should enable it manually. Open the
 169       <menuchoice>
 170         <guimenu>Help</guimenu>
 171         <guimenuitem>Software Updates</guimenuitem>
 172         <guimenuitem>Manage Configuration</guimenuitem>
 173       </menuchoice>
 174       menu and click the <guibutton>Show Disabled Features</guibutton> button from the toolbar if not enabled yet. See <xref linkend="fig.inst_pe_man_4"/>
 175     </para>
 176
 177
 178     <figure id="fig.inst_pe_man_2">
 179       <title>Search for new features to install</title>
 180       <mediaobject>
 181         <imageobject>
 182           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_man_2.png" format="PNG"/>
 183         </imageobject>
 184       </mediaobject>
 185     </figure>
 186
 187
 188     <figure id="fig.inst_pe_man_4">
 189       <title>Enable &phpeclipse; in case it is disabled</title>
 190       <mediaobject>
 191         <imageobject>
 192           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_install_man_4.png" format="PNG"/>
 193         </imageobject>
 194       </mediaobject>
 195     </figure>
 196
 197   </sect2>
 198
 199
 200   <sect2 id="sec.sec.install_phpeclipse">
 201     <title>Switch between different &phpeclipse; versions</title>
 202     <para>
 203       <indexterm><primary>version</primary><secondary>switching</secondary></indexterm>
 204       If you install a new version (with a higher version number), this version will be activated by default. But sometimes it could be necessary to switch back to an older version (maybe of buggy <quote>unofficial release</quote>).
 205     </para>
 206
 207     <para>
 208       Switching back to any other version could be done in the following way:
 209
 210       <itemizedlist>
 211         <listitem>
 212           <para>
 213             Click on
 214               <menuchoice>
 215                 <guimenu>Help</guimenu>
 216                 <guisubmenu>Software Updates</guisubmenu>
 217                 <guimenuitem>Manage Configuration</guimenuitem>
 218               </menuchoice>
 219              from the Eclipse menu bar. See <xref linkend="fig.switch_versions_1"/>
 220           </para>
 221         </listitem>
 222       </itemizedlist>
 223
 224       <!-- todo: add the missing figures and text -->
 225     </para>
 226
 227
 228     <figure id="fig.switch_versions_1">
 229       <title>Manage Configuration</title>
 230       <mediaobject>
 231         <imageobject role="html">
 232           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_switch_versions_1.png" format="PNG"/>
 233         </imageobject>
 234         <imageobject role="fo">
 235           <imagedata align="center" fileref="img/en/xo-002/phpeclipse_switch_versions_1.png" format="PNG" width="8cm"/>
 236         </imageobject>
 237       </mediaobject>
 238     </figure>
 239
 240   </sect2>
 241 </sect1>