mozdev.org

CalendarHelp

resources:
developer:
project:
projects:

Calendar Folders

Calendar Folders is an extension for Sunbird and future versions of Mozilla Calendar.

It provides ways to:

* The clock is a temporary feature. Future releases of Calendar Folders will have no clock, and the clock will be available in a separate extension: Clock Tab

The current version of Calendar Folders is a prototype for Sunbird 0.3a1 only.

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

For installation instructions, see the bottom of this page.

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.

The Calendar Folders project is a subproject of Calendar Help.

Why use Calendar Folders?

Use Calendar Folders when you often work with many calendars, so that you can easily view groups of calendars at the same time.

Or use it just for its batch change and reporting features, or just to add a clock to your calendar.

Example

You work on two projects, codenamed Alum and Borax. 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.

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.

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

Here the seven calendars that you can work with:

Working with your own calendars

To work with your own three calendars, you place them in a folder named Me:

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

Working with project calendars

To work with project calendars, you place them in folders:

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.

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

Default folders

When you install Calendar Folders and restart sunbird, you two folders are created automatically, named All and Default.

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).

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

Working with calendars and folders

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.)

Creating and maintaining a folder

To create a new folder, choose New Folder from the context menu.

Give the new folder a name.

To populate the new folder, drag calendars from the All folder and drop them in the new folder:

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.

To remove a calendar from the folder, drag it back into All.

Changing calendar properties

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.

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 colour blue. But in other folders the same calendar has a different name and colour.

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

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.

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

Filters

To filter a folder's entries, so you only see the entries that you want to work with, open the folder's properties and choose the Entry filter tab. Specify filter criteria to select the required entries. In this example, category and status criteria are specified:

Changing multiple entries in one step

This feature is not implemented yet, but its user interface partly works.

To change multiple entries in one step, make a folder that contains the entries. The entries can be in different calendars, and the folder can be filtered to protect entries that you do not want to change.

From the folder's context menu, select Change Entries.... In the Change Entries wizard, specify the change that you want to make. Press the Finish button to make the change.

Summarizing entries in a report

To summarize entries in a report, make a folder that contains the entries. The entries can be in different calendars, and the folder can be filtered to protect entries that you do not want to change.

From the folder's context menu, select Report... In the Report wizard, specify the content of the report. Check the preview to see the results.

To work with the report, choose to view it in your browser, print it, save it as a file, or any combination of these. You can save your report as a file in plain text, as a web page, or as XML data.

Options

To set options for Calendar Folders, choose Tools – Options... from the menu bar. Go to the Folders page.

Choose whether to display tabs for the clock and the original Calendars list.

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.

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

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

To choose calendar colours from a larger palette, check the box Alternate palette. The alternate palette has two pages, with 80 colours on each page. One page contains bright colours and greys, the other contains dull and pastel colours. The bar at the side of the palette switches pages.

Help

Calendar Folders contains built-in help. To use the help, you must also have the Calendar Help extension.

You can access the help in all the usual ways. For example, you can press the F1 or Help key, or the Help button in a dialog, or you can go to the Calendar Folders chapter in the help contents.

Installing Calendar Folders

A prototype of Calendar Folders is available so that you can understand the design. It is not yet fully working. This prototype might have significant bugs that affect your data.

To use the Calendar Folders prototype, you must have Sunbird 0.3a1, or a later version.

To install Calendar Folders, choose Tools – Extensions... from Sunbird's menu bar. Drag the link below and drop it in the Extensions window:

calfolder-0.4-en-US.xpi

Note:   Calendar Folders version numbers have no relationship to Sunbird version numbers.

Wait for the download, and allow the installation to proceed.

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).

Uninstalling Calendar Folders

To uninstall, return to the Extensions window. Select Calendar Folders and press the Uninstall button. Close Sunbird.

Go to your profile directory and delete the file calfolder.rdf. Edit the file prefs.js and remove all the entries that contain calfolder. Restart Sunbird.

The calendarhelp project can be contacted through the mailing list or the member list.
Copyright © 2000-2017. All rights reserved. Terms of Use & Privacy Policy.