File:  [mozdev] / calendarhelp / www / installation.html
Revision 1.34: download - view: text, annotated - select for diffs - revision graph
Wed May 31 10:26:01 2006 UTC (11 years, 6 months ago) by whiteley
Branches: MAIN
CVS tags: HEAD
Warn about current releases

<!-- MAIN CONTENT -->
<h5 class="page-header"><a id="content" name="content">Installation</a></h5>

<p>
This page contains download links and installation instructions for Calendar Help.
</p>

<p style="border:1px solid #900; margin-left:-4px; padding:4px;">
Calendar Help does not currently support Sunbird 0.3 alpha releases or Lightning.
This support is planned for future versions.
</p>

<p><strong>Note:</strong>
If you are performing a shared installation on a multi-user system,
first read the section <a href="#shared">Shared installation</a>.
</p>

<p>
There are separate installation instructions for each parent application:
<blockquote>
<a href="#mozilla">Mozilla Application Suite</a><br>
<a href="#thunderbird">Thunderbird</a><br>
<a href="#firefox">Firefox</a><br>
<a href="#sunbird">Sunbird 0.2</a><br>
<a href="#sunbird3">Sunbird 0.2+ and 0.3</a><br>
</blockquote>
</p>



<h4 id="download">Downloads</h4>
<p>
Here are links to the current downloads, dated May 19, 2005.
<br>
Do not use these links for Sunbird 0.2+ or Sunbird 0.3.
</p>

<p><trong>Note: </strong>
0.5.1 is a quick fix for an install bug in Mozilla suite, and one other bug.
It is otherwise identical to 0.5.
</p>

<table class="BZ-table" cellspacing="2" cellpadding="2" border="0">
<thead><tr>
<th class="BZ-th-bug">Calendar Help</th>
<th class="BZ-th-desc">January/February 2005 official releases</th>
</tr></thead>
<tbody>
<tr>
<td><a href="http://downloads.mozdev.org/calendarhelp/calendarhelp-0.5.1-en-US.xpi">calendarhelp-0.5.1-en-US.xpi&nbsp;</a></td>
<td>Installer for US English</td>
</tr>
</tbody>

<thead><tr>
<th class="BZ-th-bug">Help Viewer</th>
<th class="BZ-th-desc">&nbsp;</th>
</tr></thead>
<tbody>
<tr>
<td><a href="http://downloads.mozdev.org/calendarhelp/help.jar">help.jar</a></td>
<td>download in <code>chrome</code> (see instructions below)</td>
</tr>
</tbody>

<thead><tr>
<th class="BZ-th-bug">Sunbird Fix</th>
<th class="BZ-th-desc">&nbsp;</th>
</tr></thead>
<tbody>
<tr>
<td><a href="http://downloads.mozdev.org/calendarhelp/nsExtensionManager.js">nsExtensionManager.js</a></td>
<td>download in <code>components</code> (see instructions below)</td>
</tr>
</tbody>
</table>


<p>
Here is a link to the download for Sunbird 0.2+ and Sunbird 0.3, dated November 3, 2005:
<br>
Do not use this link for the official Sunbird 0.2 release, or for Calendar extensions.
</p>

<table class="BZ-table" cellspacing="2" cellpadding="2" border="0">
<thead><tr>
<th class="BZ-th-bug">Calendar Help</th>
<th class="BZ-th-desc">Sunbird 0.2+/0.3, August 2005 onwards&nbsp;</th>
</tr></thead>
<tbody>
<tr>
<td><a href="http://downloads.mozdev.org/calendarhelp/calendarhelp-0.6.2-en-US.xpi">calendarhelp-0.6.2-en-US.xpi&nbsp;</a></td>
<td>Installer for US English</td>
</tr>
</tbody>
</table>


<p>
For old downloads, look in the
<a href="http://downloads.mozdev.org/calendarhelp">calendarhelp directory</a>
on your downloads mirror.
</p>


<h4 id="mozilla">Mozilla Application Suite</h4>
<p>
Install Calendar Help as an extension in the normal way.
For example, if you are reading this page in Mozilla,
click the link to the XPI file in the table of downloads above.
</p>

<p>
Do not download the help viewer.
A working help viewer is built in to Mozilla.
</p>

<p>
Restart Mozilla and open Calendar.
In Calendar's Help menu, click the Context Help item
to open the help in a new window.
</p>


<h4 id="thunderbird">Thunderbird</h4>
<p>
Thunderbird has no help viewer.
To use Calendar Help, you must prepare Thunderbird by installing a help viewer.
</p>

<p><strong>Note: </strong>
A help viewer for Thunderbird is also available from the
<a href="http://www.mozilla.org/projects/help-viewer">Help Viewer project</a>.
Theoretically, Calendar Help should work with either help viewer.
It is not possible to install both help viewers in the same product.
</p>

<h5>Preparing Thunderbird</h5>
<p>
To prepare Thunderbird, there are six steps:
</p>

<ol>
<li>Ensure that Thunderbird is not running.</li>

<li>
Go to Thunderbird's <code>chrome</code> directory.
(It is where the Thunderbird program is, <i>not</i> in your profile.)
</li>

<li>Edit the file <code>installed-chrome.txt</code> and:
	<p><ol class="alpha-list">
	<li>Search for any lines that end with <code>/help/</code> and remove them.</li>
	<li>Add these lines at the end (by copying and pasting from here):
<pre>
skin,install,url,jar:resource:/chrome/help.jar!/content/help/
locale,install,url,jar:resource:/chrome/help.jar!/content/help/
content,install,url,jar:resource:/chrome/help.jar!/content/help/
skin,install,url,jar:resource:/chrome/help.jar!/skin/classic/help/
locale,install,url,jar:resource:/chrome/help.jar!/locale/en-US/help/
</pre></li>
	<li>Save and close <code>installed-chrome.txt</code>.</li>
	</ol></p>
</li>

<li>Delete the following:
	<blockquote>
	<code>chrome.rdf</code> (file&mdash;see step 6)<br>
	<code>overlayinfo</code> (directory and all its contents&mdash;see step 6)<br>
	</blockquote>
	</li>
	
<li>Download the file <code>help.jar</code> from the table of downloads above.
If a file of that name is already there, let the download overwrite it.
</li>

<li>Restart Thunderbird.
It automatically rebuilds <code>chrome.rdf</code> and <code>overlayinfo</code>.
</li>
</ol>


<h5>Installing Calendar Help in Thunderbird</h5>
<p>
Install Calendar Help as an extension in the normal way.
For example, from Thunderbird's menu bar choose Tools - Extensions to open the Extensions window.
Then drag the link from the table of downloads above, and drop it in the Extensions window.
</p>

<p>
Restart Thunderbird and open Calendar.
In Calendar's Help menu, click the Context Help item
to open the help in a new window.
</p>


<h4 id="firefox">Firefox</h4>
<p>
Install Calendar Help as an extension in the normal way.
For example, if you are reading this page in Firefox,
click the link to the XPI file in the table of downloads above.
</p>

<p>
Restart Firefox and open Calendar.
In Calendar's Help menu, click the Context Help item
to open the help in a new window.
</p>

<p><strong>Note:</strong>
Do not download the help viewer.
A working help viewer is built in to Firefox.
</p>



<h4 id="sunbird">Sunbird 0.2</h4>
<p>
These instructions are for the official Sunbird 0.2 release.
You might be able to adapt them for older releases of Sunbird by
including extra steps from the Thunderbird section above.
</p>

<p><strong>Note: </strong>
The Sunbird 0.2 Windows EXE download (<code>SunbirdSetup-0.2.exe</code>) is incomplete.
To use Calendar Help in Sunbird 0.2 on Windows, install Sunbird from the ZIP download
(<code>Sunbird-0.2-win32.zip</code>).
</p>

<p>
Sunbird's extension manager is broken and its help viewer is broken.
To use Calendar Help, you must prepare Sunbird
by installing a working extension manager and help viewer.
</p>

<p><strong>Note: </strong>
In test builds of Sunbird 0.2+, the Extension Manager should work normally.
You might be able to install Calendar Help by dragging the XPI link from the table
of downloads above, and dropping it in the Extensions window.
There might be other problems that stop Calendar Help working in these test builds,
so Calendar Help is not currently supported in Sunbird 0.2+.
</p>


<h5>Preparing Sunbird 0.2</h5>
<p>
To prepare Sunbird, there are six steps:
</p>

<ol>
<li>Ensure Sunbird is not running.</li>

<li>
Go to Sunbird's <code>chrome</code> directory.
(It is where the Sunbird program is, <i>not</i> in your profile.)
</li>

<li>Download the file <code>help.jar</code> from the table of downloads above,
overwriting the one supplied with Sunbird.
</li>

<li>Go to Sunbird's <code>components</code> directory.</li>

<li>Download the file <code>nsExtensionManager.js</code> from the table of downloads above,
overwriting the one supplied with Sunbird.
</li>

<li>Restart Sunbird.
You should not notice anything different.
</li>
</ol>

<p><strong>Note:</strong>
The extension manager fix does not provide a user interface.
</p>

<h5 id="sbinstall">Installing Calendar Help in Sunbird 0.2</h5>
<p>
To install Calendar Help, download the XPI file from the table of downloads above
and store it on your local machine, remembering where you put it.
For example, right-click the link, then from the context menu choose Save Link As...
and choose a location.
</p>

<p>
Start Sunbird using the command line option
<code>-install-global-extension</code> followed by the full path and name
where you put the XPI file.
For example, you might use a command like:
<pre>
sunbird.exe -install-global-extension C:\WINDOWS\TEMP\calendarhelp-0.1-en-US.xpi
</pre>
Sunbird installs the extension and exits, without opening its user interface.
</p>

<p>
Restart Sunbird normally.
In the Help menu, click the Context Help item
to open the help in a new window.
</p>

<h5>Manual installation in Sunbird 0.2</h5>
<p>
If the installation fails when you use the instructions above,
then the extension manager fix might not have worked in your version of Sunbird.
You might be able to install Calendar Help manually using the
instructions in this section.
</p>

<ol>
<li>
Delete and reinstall Sunbird to remove any damaged or unwanted files
left after the failed installation.
</li>

<li>
Follow the instructions <strong>Preparing Sunbird</strong>, above.
You can stop after step 3.
</li>

<li>
Download the XPI file from the table of downloads above
and store it on your local machine, remembering where you put it.
</li>

<li>
Use a zip tool to unzip the XPI file.
(You might have to rename it <code>.zip</code> first, depending on the tool.)
</li>

<li>
Ensure that Sunbird has run at least once, but is not running now.
</li>

<li>
Copy the file <code>calendarhelp-en-US.jar</code> from the
XPI's <code>chrome</code> directory to Sunbird's <code>chrome</code> directory.
</li>

<li>
In Sunbird's <code>chrome</code> directory, delete the file
<code>chrome.rdf</code> and the directory <code>overlayinfo</code>.
(The final step rebuilds them.)
</li>

<li>
Edit the file <code>installed-chrome.txt</code>.
Add these lines by copying and pasting them from here:
<blockquote><pre>
content,install,url,jar:resource:/chrome/calendarhelp-en-US.jar!/content/calendarhelp/
locale,install,url,jar:resource:/chrome/calendarhelp-en-US.jar!/locale/en-US/calendarhelp/
skin,install,url,jar:resource:/chrome/calendarhelp-en-US.jar!/skin/classic/calendarhelp/
</pre></blockquote>
Check that these lines are present in the file, adding or correcting them if necessary:
<blockquote><pre>
content,install,url,jar:resource:/chrome/help.jar!/content/help/
locale,install,url,jar:resource:/chrome/help.jar!/locale/en-US/help/
skin,install,url,jar:resource:/chrome/help.jar!/skin/classic/help/
</pre></blockquote>
then save and close the file.
</li>

<li>
Restart Sunbird.
Sunbird automatically rebuilds the file
<code>chrome.rdf</code> and the directory <code>overlayinfo</code>.
</li>

<li>
In the Help menu, click the Context Help item
to open the help in a new window.
</li>

</ol>


<h4 id="sunbird3">Sunbird 0.2+ and Sunbird 0.3</h4>
<p>
These instructions are for Sunbird 0.2+ nightly builds and Sunbird 0.3.
</p>

<ol>
<li>In Sunbird, choose Tools &ndash; Extensions... from the menu bar.</li>
<li>Find the correct link in the table of downloads above, making sure that the version number is at least 0.6.
Drag the link from your browser and drop it in Sunbird's Extensions window.</li>
<li>Confirm that you want to install Calendar Help, then wait for the download to complete.</li>
<li>Close and restart Sunbird.</li>
<li>In the Help menu, click the Context Help item to open the help in a new window.</li>
</ol>



<h4 id="shared">Shared installation</h4>
<p>
If you are installing Calendar Help on a multi-user system where more than one
user will access the same installed package, perform a global installation
(not a profile installation).
</p>

<p>
For Thunderbird or Firefox, perform a global installation by adapting the
installation instructions for <a href="#sbinstall">Sunbird</a>, above.
For Mozilla Suite or Sunbird, follow the normal installation instructions above.
</p>

<p>
Ensure that you open Calendar Help as the final step in the installation.
The first time you open Calendar Help it creates a file,
and this completes the installation.
</p>

<p>
Also check that all the intended users have access to the installed files:
<blockquote><pre>
chrome/calendarhelp.jar
chrome/calendarhelpdtd/content/calendarhelpdtd/parent.dtd
</pre></blockquote>
</p>








FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>