JAL-3676 adding Axis and Castor loggging properties to the help text
authorBen Soares <b.soares@dundee.ac.uk>
Fri, 28 Aug 2020 10:10:33 +0000 (11:10 +0100)
committerBen Soares <b.soares@dundee.ac.uk>
Fri, 28 Aug 2020 10:10:33 +0000 (11:10 +0100)
help/help/html/logging.html

index 2393c61..fcb491d 100644 (file)
   <strong>Note! If you change the log level in the Java Console, this change will only persist for as long as the console is open.  Once you close the console the log level will revert back to what it had been when you opened the console (usually INFO).</strong>
   </p>
   <p>
-  You can change the default log level by editing the Jalview preferenecs file, <em>.jalview_properties</em>, found in your home directory, and setting the property <em>logs.Jalview.level</em> to the log level you prefer, e.g.
+  You can change the default log level by editing the Jalview preferenecs file, <em>.jalview_properties</em>, found in your home directory (on Windows: %HOMEPATH%, or the folder above 'My Documents'; on macOS: ~ or /Users/<em>username</em>; on linux/unix: ~ or /home/<em>username</em>), and setting the property <em>logs.Jalview.level</em> to the log level you prefer, e.g.
   <pre>
   logs.Jalview.level=DEBUG
   </pre>
+  You can also set the property
+  <pre>
+  logs.Axis.level=DEBUG
+  </pre>
+  to get debug information for the SOAP services, and
+  <pre>
+  logs.Castor.level=DEBUG
+  </pre>
+  to get excessive information on XML serialisation and deserialisation!  These last two properties cannot be set from within the Java Console.
   </p>
   <p>
-  You can also set this property to a log level not usually presented in the Java Console (though restricted to log levels used by Apache Log4j -- see <a href="https://logging.apache.org/log4j/2.x/manual/customloglevels.html">Log4j Custom Log Levels</a> for details of the standard log levels available).  Jalview does not currently define any custom log levels.<br/>
-  If you do set the property with a log level that is normally not visible in the Java Console this should be respected and visibly selected when you open the console.
+  You can set the <em>logs.jalview.level</em> property to a log level not usually presented in the Java Console (though restricted to log levels used by Apache Log4j -- see <a href="https://logging.apache.org/log4j/2.x/manual/customloglevels.html">Log4j Custom Log Levels</a> for details of the standard log levels available).  Jalview does not currently define any custom log levels.  If you do set the property with a log level that is normally not visible in the Java Console this should be respected and visibly selected when you open the console.
   </p>
   <p>
-  The <em>Clear</em> button at the bottom of the console will clear all logging messages except for the initial system information which remains.
+  The <em>Clear</em> button at the bottom of the console will clear all logging messages except for the initial system information which is rewritten to the console.
   </p>
   <p>
-  The <em>Copy to clipboard</em> button at the bottom right of the console will copy all of the text in the console to your system clipboard, ready to paste into another application (e.g. email composer).
+  The <em>Copy to clipboard</em> button at the bottom right of the console will copy all of the text in the console to your system clipboard, ready to paste into another application (e.g. email composer or issue tracker).
   </p>
 
   <h3>Reporting Bugs</h3>