Changeset 5678

Timestamp:

Jun 29, 2011, 1:47:10 PM (12 years ago)

Author:

Nicklas Nordborg

Message:

References #1590: Documentation cleanup

• Checked jobagent, raw data types, extended properties and web.xml reference in the appendix.

Location:

trunk

Files:

• doc/src/docbook/appendix/extended_properties.xml (modified) (5 diffs)
• doc/src/docbook/appendix/jobagent.sh.xml (modified) (1 diff)
• doc/src/docbook/appendix/other_config.xml (modified) (1 diff)
• doc/src/docbook/appendix/raw_data_types.xml (modified) (3 diffs)
• doc/src/docbook/appendix/web.xml.xml (modified) (3 diffs)
• lib/docbook/custom-styles/docbook/plain/css/docbook.css (modified) (1 diff)

trunk/doc/src/docbook/appendix/extended_properties.xml

@@ -39 +39 @@
   </para>
 
+  <tip>
+    <para>
+      It is also possible to put additional extended property definitions in the
+      <filename>&lt;basedir&gt;/www/WEB-INF/classes/extended-properties</filename>
+      subdirectory. BASE will merge all <filename>*.xml</filename> it finds with 
+      the main <filename>extended-properties.xml</filename> file. The extra 
+      configuration files should have the same format as the main 
+      <filename>extended-properties.xml</filename> file. The extra files
+      may contain extra columns for classes that are already
+      defined in the main file, but existing columns can't be removed or
+      re-defined. 
+      We recommend that you don't modify the default <filename>extended-properties.xml</filename>
+      file at all (unless you want to remove some of the columns). This will make it
+      easier when upgrading BASE since you don't have to worry about losing
+      your own changes.
+      
+    </para>
+  </tip>
+
+
   <para>
     The default <filename>extended-properties.xml</filename> that ships
@@ -58 +78 @@
   <listitem>
     <para>
-    Modify the <filename>extended-properties.xml</filename> file. If you have installed
+    Modify the <filename>extended-properties.xml</filename> file or create a new file
+    in the <filename>extended-properties</filename> subdirectory. If you have installed
     job agents, make sure they all have the same version as the web server.
     </para>
@@ -121 +142 @@
   </listitem>
   </itemizedlist>
-
-  <bridgehead>Multiple configuration files</bridgehead>
-  <para>
-    Starting with BASE 2.6 it is possible to use multiple configuration
-    files for extended properties. This is useful only if you want to add
-    new columns. To remove or change existing columns you still have
-    to modify the original extended properties file. It is rather simple
-    to use this feature. Create a new directory with the name 
-    <filename>extended-properties</filename> in the same directory as 
-    the <filename>extended-properties.xml</filename>. In this directory
-    you can put additional extended property files. They should have the
-    same format as the default file.
-  </para>
-  
-  <tip>
-    We recommend that you don't modify the default <filename>extended-properties.xml</filename>
-    file at all (unless you want to remove some of the columns). This will make it
-    easier when upgrading BASE since you don't have to worry about losing
-    your own changes.
-  </tip>
 
   <bridgehead>Format of the extended-properties.xml file</bridgehead>
@@ -313 +314 @@
         </row>
         <row>
-          <entry>averagable</entry>
-          <entry>no</entry>
-          <entry>
-            <emphasis>This attribute has been deprecated and replaced by the
-            <sgmltag>averagemethod</sgmltag> attribute!</emphasis>
-            
-            <para>
-              If it makes sense to calculate the average of a set of values
-              for this property or not. By default, all numerical columns are
-              averagable. For non-numerical columns this attribute is ignored. 
-            </para>
-          </entry>
-        </row>
-        <row>
           <entry>averagemethod</entry>
           <entry>no</entry>
@@ -350 +337 @@
               <simpara>
               <constant>geometric_mean</constant>: calculate the geometric mean 
+              (not supported for non-numerical columns)
+              </simpara>
+            </listitem> 
+            <listitem>
+              <simpara>
+              <constant>quadratic_mean</constant>: calculate the quadtratic mean 
               (not supported for non-numerical columns)
               </simpara>

trunk/doc/src/docbook/appendix/jobagent.sh.xml

@@ -138 +138 @@
           <literallayout>
 Status:Running
-Job:1
-Job:5
+Cpu:15
+Total memory:8254955520
+Used memory:8002252800
+Job:42
+Job.42.slot:SHORT
 </literallayout>
 </computeroutput>
           <emphasis>Status</emphasis> can be either <constant>Running</constant>
-          or <constant>Paused</constant>. For each job that is currently 
-          running, the ID is given. In the future, the <command>info</command>
-          command may output more information. For example, there is already
-          infrastructure code for CPU and memory usage. The only problem is
-          that the information is not easy to get for a Java program.
+          or <constant>Paused</constant>. There is some information about the
+          current CPU and memory usage, but this information may not be available on
+          all platforms. For each job that is currently running, the ID is given. A
+          second entry gives information about the slot the job uses for execution.
+          In the future, the <command>info</command> command may output more information.
         </para>
       </listitem>

trunk/doc/src/docbook/appendix/other_config.xml

@@ -34 +34 @@
 
   <sect1 id="appendix.otherconfig.log4j">
-    <title>log4.properties</title>
+    <title>log4j.properties</title>
     <para>TODO</para>
   </sect1>

trunk/doc/src/docbook/appendix/raw_data_types.xml

@@ -36 +36 @@
   
   <sect1 id="appendix.rawdatatypes.platforms">
-    <title>Default platforms/variants installed with BASE</title>
+    <title>Default platforms and variants installed with BASE</title>
     
     <informaltable>
@@ -123 +123 @@
     </para>
     
+    <tip>
+      <para>
+        It is also possible to put additional raw data type definitions in the
+        <filename>&lt;basedir&gt;/www/WEB-INF/classes/raw-data-types</filename>
+        subdirectory. BASE will merge all <filename>*.xml</filename> it finds with 
+        the main <filename>raw-data-types.xml</filename> file. The extra 
+        configuration files should have the same format as the main 
+        <filename>raw-data-types.xml</filename> file. Duplicate raw data types 
+        are not supported and it is not possible to add extra columns to
+        existing types using this approach.
+      </para>
+    </tip>
+    
     <para>
       If you want your BASE installation to be configured differently we recommend that 
@@ -140 +153 @@
   <listitem>
     <para>
-    Modify the <filename>raw-data-types.xml</filename> file. If you have installed
+    Modify the <filename>raw-data-types.xml</filename> file or create a new file
+    in the <filename>raw-data-types</filename> subdirectory. If you have installed 
     job agents, make sure they all have the same version as the web server.
     </para>

trunk/doc/src/docbook/appendix/web.xml.xml

@@ -89 +89 @@
     
     <varlistentry>
+      <term><sgmltag class="starttag">servlet</sgmltag>: upload</term>
+      <listitem>
+        <para>
+        Servlet for handling file uploads. Do not modify.
+        </para>
+      </listitem>
+    </varlistentry>
+    
+    <varlistentry>
       <term><sgmltag class="starttag">servlet</sgmltag>: spotimage</term>
       <listitem>
@@ -109 +118 @@
     
     <varlistentry>
+      <term><sgmltag class="starttag">servlet</sgmltag>: eeplotter</term>
+      <listitem>
+        <para>
+        Servlet for the plot tool in the experiment explorer section. It 
+        can use the same configuration properties for size and image format
+        as the plotter servlet.
+        </para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><sgmltag class="starttag">servlet</sgmltag>: news-feed</term>
+      <listitem>
+        <para>
+        Servlet for generating a RSS feed for the news on the front page.
+        Comment out this servlet if you do not want to use the RSS feed.
+        </para>
+      </listitem>
+    </varlistentry>
+
+  
+    <varlistentry>
       <term><sgmltag class="starttag">servlet</sgmltag>: AxisServlet/AxisRESTServlet</term>
       <listitem>
@@ -136 +167 @@
         extensions. The servlet redirects the compilation of *.xjsp
         files to a compiler that includes the extension supplied JAR file(s)
-        in the class path.
+        in the class path. Can be disabled if no extensions use this feature.
+        See also <xref linkend="admin.extensions.xjspcompiler" /> for more information
+        about how to enable this feature.
         </para>
       </listitem>

trunk/lib/docbook/custom-styles/docbook/plain/css/docbook.css

@@ -199 +199 @@
 }
 
+br.table-break {
+  clear: both;
+}
+
 p.releaseinfo, .copyright {
     font-size:      0.7em;