Changeset 5678


Ignore:
Timestamp:
Jun 29, 2011, 1:47:10 PM (10 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:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/appendix/extended_properties.xml

    r5436 r5678  
    3939  </para>
    4040
     41  <tip>
     42    <para>
     43      It is also possible to put additional extended property definitions in the
     44      <filename>&lt;basedir&gt;/www/WEB-INF/classes/extended-properties</filename>
     45      subdirectory. BASE will merge all <filename>*.xml</filename> it finds with
     46      the main <filename>extended-properties.xml</filename> file. The extra
     47      configuration files should have the same format as the main
     48      <filename>extended-properties.xml</filename> file. The extra files
     49      may contain extra columns for classes that are already
     50      defined in the main file, but existing columns can't be removed or
     51      re-defined.
     52      We recommend that you don't modify the default <filename>extended-properties.xml</filename>
     53      file at all (unless you want to remove some of the columns). This will make it
     54      easier when upgrading BASE since you don't have to worry about losing
     55      your own changes.
     56     
     57    </para>
     58  </tip>
     59
     60
    4161  <para>
    4262    The default <filename>extended-properties.xml</filename> that ships
     
    5878  <listitem>
    5979    <para>
    60     Modify the <filename>extended-properties.xml</filename> file. If you have installed
     80    Modify the <filename>extended-properties.xml</filename> file or create a new file
     81    in the <filename>extended-properties</filename> subdirectory. If you have installed
    6182    job agents, make sure they all have the same version as the web server.
    6283    </para>
     
    121142  </listitem>
    122143  </itemizedlist>
    123 
    124   <bridgehead>Multiple configuration files</bridgehead>
    125   <para>
    126     Starting with BASE 2.6 it is possible to use multiple configuration
    127     files for extended properties. This is useful only if you want to add
    128     new columns. To remove or change existing columns you still have
    129     to modify the original extended properties file. It is rather simple
    130     to use this feature. Create a new directory with the name
    131     <filename>extended-properties</filename> in the same directory as
    132     the <filename>extended-properties.xml</filename>. In this directory
    133     you can put additional extended property files. They should have the
    134     same format as the default file.
    135   </para>
    136  
    137   <tip>
    138     We recommend that you don't modify the default <filename>extended-properties.xml</filename>
    139     file at all (unless you want to remove some of the columns). This will make it
    140     easier when upgrading BASE since you don't have to worry about losing
    141     your own changes.
    142   </tip>
    143144
    144145  <bridgehead>Format of the extended-properties.xml file</bridgehead>
     
    313314        </row>
    314315        <row>
    315           <entry>averagable</entry>
    316           <entry>no</entry>
    317           <entry>
    318             <emphasis>This attribute has been deprecated and replaced by the
    319             <sgmltag>averagemethod</sgmltag> attribute!</emphasis>
    320            
    321             <para>
    322               If it makes sense to calculate the average of a set of values
    323               for this property or not. By default, all numerical columns are
    324               averagable. For non-numerical columns this attribute is ignored.
    325             </para>
    326           </entry>
    327         </row>
    328         <row>
    329316          <entry>averagemethod</entry>
    330317          <entry>no</entry>
     
    350337              <simpara>
    351338              <constant>geometric_mean</constant>: calculate the geometric mean
     339              (not supported for non-numerical columns)
     340              </simpara>
     341            </listitem>
     342            <listitem>
     343              <simpara>
     344              <constant>quadratic_mean</constant>: calculate the quadtratic mean
    352345              (not supported for non-numerical columns)
    353346              </simpara>
  • trunk/doc/src/docbook/appendix/jobagent.sh.xml

    r4889 r5678  
    138138          <literallayout>
    139139Status:Running
    140 Job:1
    141 Job:5
     140Cpu:15
     141Total memory:8254955520
     142Used memory:8002252800
     143Job:42
     144Job.42.slot:SHORT
    142145</literallayout>
    143146</computeroutput>
    144147          <emphasis>Status</emphasis> can be either <constant>Running</constant>
    145           or <constant>Paused</constant>. For each job that is currently
    146           running, the ID is given. In the future, the <command>info</command>
    147           command may output more information. For example, there is already
    148           infrastructure code for CPU and memory usage. The only problem is
    149           that the information is not easy to get for a Java program.
     148          or <constant>Paused</constant>. There is some information about the
     149          current CPU and memory usage, but this information may not be available on
     150          all platforms. For each job that is currently running, the ID is given. A
     151          second entry gives information about the slot the job uses for execution.
     152          In the future, the <command>info</command> command may output more information.
    150153        </para>
    151154      </listitem>
  • trunk/doc/src/docbook/appendix/other_config.xml

    r5677 r5678  
    3434
    3535  <sect1 id="appendix.otherconfig.log4j">
    36     <title>log4.properties</title>
     36    <title>log4j.properties</title>
    3737    <para>TODO</para>
    3838  </sect1>
  • trunk/doc/src/docbook/appendix/raw_data_types.xml

    r4509 r5678  
    3636 
    3737  <sect1 id="appendix.rawdatatypes.platforms">
    38     <title>Default platforms/variants installed with BASE</title>
     38    <title>Default platforms and variants installed with BASE</title>
    3939   
    4040    <informaltable>
     
    123123    </para>
    124124   
     125    <tip>
     126      <para>
     127        It is also possible to put additional raw data type definitions in the
     128        <filename>&lt;basedir&gt;/www/WEB-INF/classes/raw-data-types</filename>
     129        subdirectory. BASE will merge all <filename>*.xml</filename> it finds with
     130        the main <filename>raw-data-types.xml</filename> file. The extra
     131        configuration files should have the same format as the main
     132        <filename>raw-data-types.xml</filename> file. Duplicate raw data types
     133        are not supported and it is not possible to add extra columns to
     134        existing types using this approach.
     135      </para>
     136    </tip>
     137   
    125138    <para>
    126139      If you want your BASE installation to be configured differently we recommend that
     
    140153  <listitem>
    141154    <para>
    142     Modify the <filename>raw-data-types.xml</filename> file. If you have installed
     155    Modify the <filename>raw-data-types.xml</filename> file or create a new file
     156    in the <filename>raw-data-types</filename> subdirectory. If you have installed
    143157    job agents, make sure they all have the same version as the web server.
    144158    </para>
  • trunk/doc/src/docbook/appendix/web.xml.xml

    r4889 r5678  
    8989   
    9090    <varlistentry>
     91      <term><sgmltag class="starttag">servlet</sgmltag>: upload</term>
     92      <listitem>
     93        <para>
     94        Servlet for handling file uploads. Do not modify.
     95        </para>
     96      </listitem>
     97    </varlistentry>
     98   
     99    <varlistentry>
    91100      <term><sgmltag class="starttag">servlet</sgmltag>: spotimage</term>
    92101      <listitem>
     
    109118   
    110119    <varlistentry>
     120      <term><sgmltag class="starttag">servlet</sgmltag>: eeplotter</term>
     121      <listitem>
     122        <para>
     123        Servlet for the plot tool in the experiment explorer section. It
     124        can use the same configuration properties for size and image format
     125        as the plotter servlet.
     126        </para>
     127      </listitem>
     128    </varlistentry>
     129
     130    <varlistentry>
     131      <term><sgmltag class="starttag">servlet</sgmltag>: news-feed</term>
     132      <listitem>
     133        <para>
     134        Servlet for generating a RSS feed for the news on the front page.
     135        Comment out this servlet if you do not want to use the RSS feed.
     136        </para>
     137      </listitem>
     138    </varlistentry>
     139
     140 
     141    <varlistentry>
    111142      <term><sgmltag class="starttag">servlet</sgmltag>: AxisServlet/AxisRESTServlet</term>
    112143      <listitem>
     
    136167        extensions. The servlet redirects the compilation of *.xjsp
    137168        files to a compiler that includes the extension supplied JAR file(s)
    138         in the class path.
     169        in the class path. Can be disabled if no extensions use this feature.
     170        See also <xref linkend="admin.extensions.xjspcompiler" /> for more information
     171        about how to enable this feature.
    139172        </para>
    140173      </listitem>
  • trunk/lib/docbook/custom-styles/docbook/plain/css/docbook.css

    r5676 r5678  
    199199}
    200200
     201br.table-break {
     202  clear: both;
     203}
     204
    201205p.releaseinfo, .copyright {
    202206    font-size:      0.7em;
Note: See TracChangeset for help on using the changeset viewer.