[izpack-changes] r1506 - izpack-src/trunk/src/doc-ng/XHTML
noreply at berlios.de
noreply at berlios.de
Tue Jul 25 13:36:55 CEST 2006
Author: bartzkau
Date: 2006-07-25 13:36:42 +0200 (Tue, 25 Jul 2006)
New Revision: 1506
Modified:
izpack-src/trunk/src/doc-ng/XHTML/index.html
izpack-src/trunk/src/doc-ng/XHTML/node4.html
izpack-src/trunk/src/doc-ng/XHTML/node5.html
izpack-src/trunk/src/doc-ng/XHTML/node9.html
Log:
Section "Logging the Installation" added; table of contents
synched; little corrections.
Modified: izpack-src/trunk/src/doc-ng/XHTML/index.html
===================================================================
--- izpack-src/trunk/src/doc-ng/XHTML/index.html 2006-07-25 10:14:49 UTC (rev 1505)
+++ izpack-src/trunk/src/doc-ng/XHTML/index.html 2006-07-25 11:36:42 UTC (rev 1506)
@@ -288,6 +288,18 @@
<li>
<a name="tex2html98" href="node4.html#SECTION004415000000000000000">JDKPathPanel</a>
</li>
+
+ <li>
+ <a name="tex2html415" href="node4.html#SECTION004416000000000000000">SelectPrinterPanel</a>
+ </li>
+
+ <li>
+ <a name="tex2html416" href="node4.html#SECTION004417000000000000000">DataCheckPanel</a>
+ </li>
+
+ <li>
+ <a name="tex2html417" href="node4.html#SECTION004418000000000000000">SummaryPanel</a>
+ </li>
</ul>
</li>
</ul>
@@ -332,6 +344,9 @@
</li>
</ul>
<li>
+ <a href="node5.html#Logging">Logging the Installation</a>
+ </li>
+ <li>
<a name="tex2html106" href="node5.html#SECTION00570000000000000000">Web Installers</a>
</li>
<li>
@@ -641,6 +656,9 @@
</li>
</ul>
</li>
+ <li>
+ <a href="node9.html#SECTION00970000000000000000">Summary Logger (InstallerListener)</a>
+ </li>
</ul>
<br />
</li>
Modified: izpack-src/trunk/src/doc-ng/XHTML/node4.html
===================================================================
--- izpack-src/trunk/src/doc-ng/XHTML/node4.html 2006-07-25 10:14:49 UTC (rev 1505)
+++ izpack-src/trunk/src/doc-ng/XHTML/node4.html 2006-07-25 11:36:42 UTC (rev 1506)
@@ -160,6 +160,8 @@
<li><a name="tex2html415" href="node4.html#SECTION004416000000000000000">SelectPrinterPanel</a></li>
<li><a name="tex2html416" href="node4.html#SECTION004417000000000000000">DataCheckPanel</a></li>
+
+<li><a name="tex2html417" href="node4.html#SECTION004418000000000000000">SummaryPanel</a></li>
</ul>
</li>
</ul>
@@ -280,7 +282,7 @@
<li><tt>$desktopshortcutcheckboxenabled</tt> : When set to true, it automatically checks the "Create Desktop Shortcuts" button. To see how to use it, go to <a name="tex2html378" href="node4.html#SECTION00433000000000000000">The Variables Element <tt><variables></tt></a></li>
-<li><tt>$InstallerFrame.logfilePath</tt> : The path to the install log. If set to defauly then the "$INSTALL_PATH/uninstall/install.log" path will be used. To see how to use it, go to <a name="tex2html378" href="node4.html#SECTION00433000000000000000">The Variables Element <tt><variables></tt></a></li>
+<li><a name="InstLogFile"></a><tt>$InstallerFrame.logfilePath</tt> : The path to the install log. This file contains the paths of all installed files. If set to "default" then the "$INSTALL_PATH/Uninstaller/install.log" path will be used. To see how to use it, go to <a name="tex2html378" href="node4.html#SECTION00433000000000000000">The Variables Element <tt><variables></tt></a>. If this variable is not set, no install.log will be created.</li>
</ul>
@@ -352,8 +354,8 @@
<li><tt><webdir></tt> : Causes a ``web installer'' to be created, and specifies the URL packages are retrieved from at install time. The content of the tag must be a properly formed URL. See
section <a href="node5.html#webinstaller">3.7</a> for more details.</li>
+<li><tt><summarylogfilepath></tt> : specifies the path for the logfile of the <a href="node9.html#SECTION00970000000000000000">SummaryLoggerInstallerListener</a>.</li>
</ul>
-
<p>Here is an example of a typical <tt><info></tt> section :<br />
</p>
@@ -1190,7 +1192,7 @@
<blockquote><p>It can do everything i need and more. In particular, it allows me to write a process extension and still be able to provide feedback to the user through the feedback panel, and to add new
functionality to the installer, after its been built.</p></blockquote>
-<p>New with version 3.7 is the possibility to tee output that is written to the ProcessPanel's textarea into an optional logfile. Using this feature is pretty much straightforward, you only have to
+<p><a name="ProcessPanelLogFile"></a>New with version 3.7 is the possibility to tee output that is written to the ProcessPanel's textarea into an optional logfile. Using this feature is pretty much straightforward, you only have to
add a line in <tt>ProcessPanel.Spec.xml</tt> that will tell IzPack the location, where the logfile should be stored.</p>
<p>Variable substitution is performed, so you can use <tt>$INSTALL_PATH</tt> as example.</p>
@@ -1273,6 +1275,16 @@
<p>
It will automatically give you a full list of all the variables and packs whenever the panel is made active.</p>
</p>
+<h2><a name="SECTION004418000000000000000">SummaryPanel</a></h2>
+
+<p>This panel gives a summary of all shown panels. The best place for it is just infront of the InstallPanel. Normaly it contains a warning that this is the last
+panel before installation. The panel contains a scrollable HTML text area to display the summary. The informations are collected from each panel by calling the methods
+<tt>getSummaryCaption</tt> and <tt>getSummaryBody</tt>. <tt>getSummaryCaption</tt> is implemented in <tt>IzPanel</tt> with a panel name default text.
+<tt>getSummaryBody</tt> has to be implemented in all panels which should be presented in the summary. If the secound method is not implemented, no summary of this
+panel will be shown.
+</p>
+<p>Additional it is possibel to <a href="node9.html#SECTION00970000000000000000">log the contents</a> of the summary panel into a HTML file.</p>
+
<hr />
<!--Navigation Panel-->
<table width="100%">
Modified: izpack-src/trunk/src/doc-ng/XHTML/node5.html
===================================================================
--- izpack-src/trunk/src/doc-ng/XHTML/node5.html 2006-07-25 10:14:49 UTC (rev 1505)
+++ izpack-src/trunk/src/doc-ng/XHTML/node5.html 2006-07-25 11:36:42 UTC (rev 1506)
@@ -64,6 +64,8 @@
</ul>
+<li><a href="node5.html#Logging">Logging the Installation</a></li>
+
<li><a name="tex2html433" href="node5.html#SECTION00570000000000000000">Web Installers</a></li>
<li><a name="tex2html434" href="node5.html#SECTION00580000000000000000">More Internationalization</a>
@@ -619,6 +621,28 @@
</table>
</div>
+<h1><a name="Logging">Logging the Installation</a></h1>
+<p>Logging was made as copruduct at implementing other features. There was no common design for it.
+Therefor there is no one way to made logging of any kind else for each group a different logging stuff exist.
+Not nice, but reality.</p>
+<dl>
+<dt><tt>Debug Informations</tt></dt>
+<dd>There is a rudimental <a href="node3.html#section00356000000000000000">debug stuff</a> in IzPack. The class <tt>com.izforge.izpack.util.Debug</tt> is used by
+some other classes to write debug informations on stdout. The class can be used by custom panels or actions or
+other custom classes. To activate it, add <tt>-DTRACE=TRUE</tt> infront of -jar of the installer call.</dd>
+<dt><tt>Summary of Panels</tt></dt>
+<dd>There is a <a href="node4.html#SECTION004418000000000000000">summary panel</a> which shows some informations of previos shown panels.
+The same contents can be written to a <a href="node9.html#SECTION00970000000000000000">summary log file</a>.</dd>
+<dt><tt>Logging of Installed File Set</tt></dt>
+<dd>The files which are installed are logged into the uninstaller jar file to be used at uninstallation. The contents can be
+also duplicated into a <a href="node4.html#InstLogFile">logfile</a>.</dd>
+<dt><tt>Logging of the Process Panel</tt></dt>
+<dd>The <a href="node4.html#SECTION004414000000000000000">process panel</a> logs informations of each performed process in a scrollable text area. The contents
+can be duplicated into a <a href="node4.html#ProcessPanelLogFile">logfile</a> where the used directory can be selected (but not the logfile name).</dd>
+<dt><tt>Logging of Ant Actions</tt></dt>
+<dd>It is possible to perform ant actions with the <a href="node9.html#SECTION00950000000000000000">AntActionInstallerListener</a>.
+The grade of <a href="node9.html#AntActionVerbose">logging</a> and the path of a <a href="node9.html#AntActionLogFile">logfile</a> can by determinded.</dd>
+</dl>
<h1><a name="SECTION00570000000000000000"></a> <a name="webinstaller"></a><br />
Web Installers</h1>
Modified: izpack-src/trunk/src/doc-ng/XHTML/node9.html
===================================================================
--- izpack-src/trunk/src/doc-ng/XHTML/node9.html 2006-07-25 10:14:49 UTC (rev 1505)
+++ izpack-src/trunk/src/doc-ng/XHTML/node9.html 2006-07-25 11:36:42 UTC (rev 1506)
@@ -152,7 +152,10 @@
<li><a href="#RegListExamples">Examples</a></li>
</ul>
</li>
- </ul>
+ <li>
+ <a href="node9.html#SECTION00970000000000000000">Summary Logger (InstallerListener)</a>
+ </li>
+ </ul>
<!--End of Table of Child-Links-->
<hr />
<h1>
@@ -614,12 +617,12 @@
</li>
<li>
- <tt>verbose</tt>: optional. To output verbose information or not. Possible are yes or no. Default is
+ <a name="AntActionVerbose"></a><tt>verbose</tt>: optional. To output verbose information or not. Possible are yes or no. Default is
no.
</li>
<li>
- <tt>logfile</tt>: optional. Path of the file for logging should be performed. The logfile should be not
+ <a name="AntActionLogFile"></a><tt>logfile</tt>: optional. Path of the file for logging should be performed. The logfile should be not
marked for uninstallation otherwise it will be deleted too.
</li>
@@ -935,6 +938,31 @@
<p><tt>RegistrySpec.xml</tt> will be referred by <tt>IzPack-install-reg.xml</tt> as resource.
It contains the special pack named <tt>UninstallStuff</tt> for Izpack and defines some additional
keys and values.</p>
+<h1>
+ <a name="SECTION00970000000000000000">Summary Logger (InstallerListener)</a>
+</h1>
+<p>The listener <tt>SummaryLoggerInstallerListener</tt> can be used to log the <a href="node4.html#SECTION004418000000000000000">summary of panels</a> into a file.
+To use it, add following element to the listener section of your installation config file.</p>
+ <pre>
+<listeners>
+ <listener installer="SummaryLoggerInstallerListener"
+ uninstaller="SummaryLoggerInstallerListener" >
+ <os family="windows"/>
+ </listener>
+</listeners>
+</pre>
+<p>The default path is</p>
+<pre>$INSTALL_PATH/Uninstaller/InstallSummary.htm</pre>
+<p>It can be changed with the subelement <tt>summarylogfilepath</tt> of the element <tt>info</tt>
+of the installation description file. As example:</p>
+<pre>
+<info>
+ ...
+ <summarylogfilepath>
+ $INSTALL_PATH/Uninstaller/MySummary.htm
+ </summarylogfilepath>
+</info>
+</pre>
<hr />
<!--Navigation Panel-->
<table width="100%">
More information about the izpack-changes
mailing list