minor
[taxeditor.git] / src / site / fml / troubleshooting.fml
index d27c88e4e1a568d9f247199c5d48350ebc0264df..a27c259c6473204b6d40dbff139dbb3678e40df7 100644 (file)
@@ -1,49 +1,82 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?xml version="1.0" encoding="UTF-8"?>
-<faqs xmlns="http://maven.apache.org/FML/1.0.1"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
-  title="Frequently Asked Questions"
-  toplink="false">
-
-  <part id="general">
-    <title>General</title>
-
-    <faq id="whats-foo">
-      <question>
-        What is Foo?
-      </question>
-      <answer>
-        <p>some markup goes here</p>
-
-        <source>some source code</source>
-
-        <p>some markup goes here</p>
-      </answer>
-    </faq>
-
-    <faq id="whats-bar">
-      <question>
-        What is Bar?
-      </question>
-      <answer>
-        <p>some markup goes here</p>
-      </answer>
-    </faq>
-  </part>
-
-  <part id="install">
-
-    <title>Installation</title>
-
-    <faq id="how-install">
-      <question>
-        How do I install Foo?
-      </question>
-      <answer>
-        <p>some markup goes here</p>
-      </answer>
-    </faq>
-
-  </part>
-
-</faqs>
\ No newline at end of file
+<faqs xmlns="http://maven.apache.org/FML/1.0.1" 
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+       xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd" 
+       title="Troubleshooting" 
+       toplink="true">
+       <part id="general">
+               <title>General</title>
+               <faq id="How_can_I_configure_logging_in_the_editor">
+                       <question>How can I configure logging in the editor?</question>
+                       <answer>
+                               <p>To get log4j to read your own configuration when developing the editor or 
+                                       anything that has to do with cdmLibrary eclipse plugin you have to tell 
+                                       log4j explicitly what configuration it should use. Otherwise it will scan 
+                                       the classpath and use the first log4j.xml/log4j.properties file it finds 
+                                       (which is mostly the log4j.properties in cdmlib-commons as it will be the 
+                                       first one it encounters).</p>
+                               <p>Passing the following argument to the Virtual Machine however does the trick:</p>
+                               <source>-Dlog4j.configuration=file:///&lt;path to your personal&gt;/log4j.properties</source>
+                               <p>If you run into trouble , you can debug log4j's startup sequence by passing 
+                                       another argument to the VM.</p>
+                               <source>-Dlog4j.debug</source>
+                       </answer>
+               </faq>
+               <faq id="taxeditor_projects_have_errors">
+                       <question>Some of the taxeditor projects have errors</question>
+                       <answer>
+                               <p>And the errors do look like the cdmlib dependecies can not be resolved, there are two possible solutions for this problem.</p>
+                               <ol>
+                                       <li><em>cdmlib-plugin</em> does not contain the cdmlib dependencies
+                                               <p>Please follow the instructions on <a href="./getting-started.html#Dependencies">how to initialize the cdmlib-plugin</a></p>
+                                       </li>
+                                       <li>Your classpath is outdated
+                                               <p>Update your classpath by right-clicking any of the <em>taxeditor-*</em> projects and choose <em>PDE Tools -&gt; Update Classpath...</em>. Click &lt;Select All&gt; in the dialog and confirm.</p>
+                                       </li>
+                               </ol>
+                       </answer>
+               </faq>
+               <faq id="Launching_the_editor_from_eclipse_is_simply_not_working">
+                       <question>Launching the editor from eclipse is simply not working for me.</question>
+                       <answer>
+                               <p>This could be due to many reasons. Please have a look at the <a href="http://dev.e-taxonomy.eu/trac/wiki/TroubleshootingEditorLaunches">Troubleshooting Editor Launches</a> document on the developers wiki.</p>
+                       </answer>
+               </faq>
+               <faq id="No_application_id_has_been_found">
+                       <question>I get a "RuntimeException: No application id has been found." preceded by lots of "Missing required bundle" errors when launching my run/debug configuration</question>
+                       <answer>
+                               <p>Whenever you change something in the plguin dependency hirarchy, i.e. adding, (re)moving, or renaming a dependant plugin your run configuration does not know about that automatically. To solve this:</p>
+                               <ul>
+                                       <li>In eclipse, open the <em>Run Configurations</em> wizard</li>
+                                       <li>Choose the run configuration in question</li>
+                                       <li>Select the <em>Plug-ins</em> tab</li>
+                                       <li>Click <em>Deselect All</em> from the buttons on the right</li>
+                                       <li>Click <em>Add Required Plug-ins</em></li>
+                                       <li>Apply your changes</li>
+                               </ul>
+                               <p>The editor should launch again.</p>
+                       </answer>
+               </faq>
+               <faq id="ubuntu_gtk2_eclipse_rcp_crash">
+                       <question>The Taxonomic Editor crashes or freezes in recent Ubuntu versions</question>
+                       <answer>
+                               <p>In recent Ubuntu versions (13.04, 13.10) the Taxomomic Editor crashes frequently (KDE) or freezes for some time (GNOME). The crashes in KDE are due to a bug which affects all Eclipse indigo (3.7) RCP based applications. Even this bug is currently discussed in the affected developer communities: <a href="https://bugs.launchpad.net/ubuntu/+source/unity/+bug/1241101">launchpad bug 1241101</a>, <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=419729">eclipse bug 419729</a> the cause of this bug is still unclear.
+                           </p>
+                               <p>In KDE the crash occurs when the oxygene_gtk is being used. Therefore switching to another GTK2 theme is known as a  temporary solution. The GTK2 theme Raleigh has been sucessfully used as a replacement to the oxygen_gtk2. You can either configure it globally or set the environmanet variable GTK2_RC_FILES for the application to run.</p>
+                               <p>
+                               <code>GTK2_RC_FILES=/usr/share/themes/Raleigh/gtk-2.0/gtkrc "/path/to/EDIT Taxonomic Editor/TaxonomicEditor"</code>
+                       </p>
+                               <p>The font size is usually too big in the default configration of this theme. In order to have a nicer font, you can create a file named .gtkrc-eclipse in your user home folder with the following content:</p>
+<pre>style "eclipse" {
+        font_name = "Ubuntu 9"
+}
+class "GtkWidget" style "eclipse"
+</pre>
+                               <p>Finally, to launch the Editor, use following command line:</p>
+<p>
+                               <code>GTK2_RC_FILES=/usr/share/themes/Raleigh/gtk-2.0/gtkrc:~/.gtkrc-eclipse "/path/to/EDIT Taxonomic Editor/TaxonomicEditor"</code>
+                               </p>
+                       </answer>
+               </faq>
+       </part>
+</faqs>