File:  [mozdev] / calendarhelp / www / calfolder.html
Revision 1.3: download - view: text, annotated - select for diffs - revision graph
Thu Sep 15 10:55:14 2005 UTC (13 years, 8 months ago) by whiteley
Branches: MAIN
CVS tags: HEAD
0.2 link

<h2>Calendar Folders</h2>

<p>
<b>Calendar Folders</b> is an extension for future versions of Mozilla Calendar and Sunbird.
It provides a way to group calendars in folders.
It also provides a clock.
</p>

<img src="./calfo0.png" style="margin-left:2em;">

<p>
For installation instructions, see the <a href="#install">bottom</a> of this page.
</p>

<p>
The current version of Calendar Folders is a prototype for Sunbird 0.2+ test builds only.
</p>

<p>
In this prototype, some features do not work at all and some others are buggy.
</p>

<p>
There is no version of Calendar Folders for the current release, Sunbird 0.2,
and there is no version for any Calendar extensions or Lightning.
</p>


<p>
The <b>Calendar Folders</b> project is a subproject of <b>Calendar Help</b>.
</p>

<h3>Why use Calendar Folders?</h3>
<p>
Use Calendar Folders when you often work with many calendars,
so that you can easily view groups of calendars at the same time.
</p>

<h3>Example</h3>
<div style="margin-left:-4px; padding:4px; border:1px inset #f99; width:40em;">
<p>
You work on two projects, codenamed <i>Alum</i> and <i>Borax</i>.
You have three colleagues Cedric, Daisy and Evan in your department.
Cedric also works on Alum and Borax, but Daisy only works on Alum and Evan only works on Borax.
</p>

<p>
Each of you has a personal calendar and a calendar for each project.
The project calendars are shared on a server.
So there are ten calendars in all:
four personal calendars, and six shared on the server.
</p>

<p>
In Sunbird, you can work with your personal calendar and the six shared calendars.
(You cannot work with other people's personal calendars.)
</p>

<p>
Here the seven calendars that you can work with:
</p>
<img src="./calfo1.png" style="margin-left:2em;">

<h4>Working with your own calendars</h4>
<p>
To work with your own three calendars, you place them in a folder named Me:
</p>
<img src="./calfo2.png" style="margin-left:2em;">

<p>
When you select this folder, you see these three calendars but no others.
The default calendar for new entries is Personal.
</p>

<h4>Working with project calendars</h4>
<p>
To work with project calendars, you place them in folders:
</p>
<img src="./calfo3.png" style="margin-left:2em;">

<p>
When you select a project folder, you see the calendars for that project but no others.
The default calendar for new entries is your calendar for the selected project.
</p>

<p>
Using Calendar Folders, you can also give the calendars different names and different
colours in each folder.
</p>

</div>


<h3>Default folders</h3>
<p>
When you install <b>Calendar Folders</b> and restart sunbird,
you two folders are created automatically, named <i>All</i> and <i>Default</i>.
</p>

<p>
The folder All is a special folder that contains all you calendars.
It is very like Sunbird's original Calendars list.
You cannot delete this folder (but you can rename it).
</p>

<p>
The folder Default contains whatever calendars are active when
<b>Calendar Folders</b> first runs.
You can work with this folder just like any other folder.
</p>


<h3>Working with calendars and folders</h3>
<p>
To work with calendars and folders, use the entries in the
Calendar Folders list, and use the context menus.
(To obtain a context menu, you can right-click, or use the Menu key
on your keyboard, or use some other method depending on your system.)
</p>


<h4>Creating and maintaining a folder</h4>
<p>
To create a new folder, choose New Folder from the context menu.
</p>
<img src="./calfo4.png" style="margin-left:2em;">

<p>
Give the new folder a name.
</p>
<img src="./calfo5.png" style="margin-left:2em;">

<p>
To populate the new folder, drag calendars from the All folder and drop
them in the new folder:
</p>

<p>
To specify the default calendar for new entries in the folder,
click one calendar's icon.
The icon displays a radio button to show that it is the default.
</p>

<p>
To remove a calendar from the folder, drag it back into All.
</p>


<h4>Changing calendar properties</h4>
<p>
The names and colours of calendars apply within a folder.
So a calendar can have a different name and a different colour
depending on the folder.
</p>

<p>
For example, in each project you might name the project manager's
calendar Project Manager, and colour it blue.
Suppose you are the project manager in one project.
In that project's folder, your calendar is named Project Manager and
has the coloour blue.
But in other folders the same calendar has a different name and colour.
</p>

<p>
This feature can be confusing.
Only use it if you have a specific purpose for different names and colours.
</p>

<p>
To rename a calendar, select it in the Folders panel, then click on its name.
To change a calendar's colour, click on its colour patch in the Folders panel.
</p>

<p>
To reload a remote calendar, click on its reload marker (a small blue circle at the
right of its colour patch).
</p>

<h4>Options</h4>
<p>
To set options for Calendar Folders, choose Tools &ndash; Options... from the menu bar.
Go to the Folders page.
</p>

<p>
Choose whether to display tabs for the clock and the original Calendars list.
</p>

<p>
Specify how to display the date and time in the clock.
To use your operating system's settings, uncheck the Long box for the date
and choose System for the time.
</p>

<p>
To ensure that only one folder can be selected at a time, check the Single folder box.
</p>

<p>
To lock calendar names or colours so that they remain consistent between folders,
check the Name or Color boxes.
</p>


<h3 id="install">Installing Calendar Folders</h3>
<p>
To install Calendar Folders, choose Tools &ndash; Extensions... from Sunbird's menu bar.
Drag this link and drop it in the Extensions window:
</p>

<p><a href="http://downloads.mozdev.org/calendarhelp/calfolder-0.2-en-US.xpi">calfolder-0.2-en-US.xpi</a></p>

<p>
Restart Sunbird.
If the installation succeeds, you see the About Calendar Folders window.
To dismiss it, click on the background of the window (or press Escape).
</p>

<h4>Uninstalling Calendar Folders</h4>
<p>
To uninstall, return to the Extensions window.
Select Calendar Folders and press the Uninstall button.
Close Sunbird.
</p>

<p>
Go to your profile directory and delete the file <code>calfolder.rdf</code>.
Edit the file <code>prefs.js</code> and remove all the entries that contain <tt>calfolder</tt>.
Restart Sunbird.
</p>

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