Annotation of calendarhelp/www/calfolder.html, revision 1.4

1.1       whiteley    1: <h2>Calendar Folders</h2>
                      2: 
                      3: <p>
1.4     ! whiteley    4: <b>Calendar Folders</b> is an extension for future versions of Mozilla Calendar and Sunbird.</p>
        !             5: <p>
        !             6: It provides:
        !             7: <ul style="margin-top:-8px;">
        !             8: <li>a way to group calendars in folders</li>
        !             9: <li>a way to filter entries, so you see only the entries that you want to work with</li>
        !            10: <li>a way to change many entries in one step</li>
        !            11: <li>an alternate palette with more colours for your calendars</li>
        !            12: <li>a clock</li>
        !            13: </ul>
1.1       whiteley   14: </p>
                     15: 
                     16: <img src="./calfo0.png" style="margin-left:2em;">
                     17: 
                     18: <p>
1.4     ! whiteley   19: <span style="border:1px solid #f00; margin-left:-4px; padding:4px;">
        !            20: The current version of Calendar Folders is a prototype for Sunbird 0.2+ test builds only.
        !            21: </span>
1.1       whiteley   22: </p>
                     23: 
                     24: <p>
1.4     ! whiteley   25: In this prototype, some features do not work at all and some others are buggy.
1.1       whiteley   26: </p>
                     27: 
                     28: <p>
1.4     ! whiteley   29: For installation instructions, see the <a href="#install">bottom</a> of this page.
1.1       whiteley   30: </p>
                     31: 
                     32: <p>
                     33: There is no version of Calendar Folders for the current release, Sunbird 0.2,
                     34: and there is no version for any Calendar extensions or Lightning.
                     35: </p>
                     36: 
                     37: 
                     38: <p>
                     39: The <b>Calendar Folders</b> project is a subproject of <b>Calendar Help</b>.
                     40: </p>
                     41: 
                     42: <h3>Why use Calendar Folders?</h3>
                     43: <p>
                     44: Use Calendar Folders when you often work with many calendars,
                     45: so that you can easily view groups of calendars at the same time.
                     46: </p>
                     47: 
                     48: <h3>Example</h3>
                     49: <div style="margin-left:-4px; padding:4px; border:1px inset #f99; width:40em;">
                     50: <p>
                     51: You work on two projects, codenamed <i>Alum</i> and <i>Borax</i>.
                     52: You have three colleagues Cedric, Daisy and Evan in your department.
                     53: Cedric also works on Alum and Borax, but Daisy only works on Alum and Evan only works on Borax.
                     54: </p>
                     55: 
                     56: <p>
                     57: Each of you has a personal calendar and a calendar for each project.
                     58: The project calendars are shared on a server.
                     59: So there are ten calendars in all:
                     60: four personal calendars, and six shared on the server.
                     61: </p>
                     62: 
                     63: <p>
                     64: In Sunbird, you can work with your personal calendar and the six shared calendars.
                     65: (You cannot work with other people's personal calendars.)
                     66: </p>
                     67: 
                     68: <p>
                     69: Here the seven calendars that you can work with:
                     70: </p>
                     71: <img src="./calfo1.png" style="margin-left:2em;">
                     72: 
                     73: <h4>Working with your own calendars</h4>
                     74: <p>
                     75: To work with your own three calendars, you place them in a folder named Me:
                     76: </p>
                     77: <img src="./calfo2.png" style="margin-left:2em;">
                     78: 
                     79: <p>
                     80: When you select this folder, you see these three calendars but no others.
                     81: The default calendar for new entries is Personal.
                     82: </p>
                     83: 
                     84: <h4>Working with project calendars</h4>
                     85: <p>
                     86: To work with project calendars, you place them in folders:
                     87: </p>
                     88: <img src="./calfo3.png" style="margin-left:2em;">
                     89: 
                     90: <p>
                     91: When you select a project folder, you see the calendars for that project but no others.
                     92: The default calendar for new entries is your calendar for the selected project.
                     93: </p>
                     94: 
                     95: <p>
                     96: Using Calendar Folders, you can also give the calendars different names and different
                     97: colours in each folder.
                     98: </p>
                     99: 
                    100: </div>
                    101: 
                    102: 
                    103: <h3>Default folders</h3>
                    104: <p>
                    105: When you install <b>Calendar Folders</b> and restart sunbird,
                    106: you two folders are created automatically, named <i>All</i> and <i>Default</i>.
                    107: </p>
                    108: 
                    109: <p>
                    110: The folder All is a special folder that contains all you calendars.
                    111: It is very like Sunbird's original Calendars list.
                    112: You cannot delete this folder (but you can rename it).
                    113: </p>
                    114: 
                    115: <p>
                    116: The folder Default contains whatever calendars are active when
                    117: <b>Calendar Folders</b> first runs.
                    118: You can work with this folder just like any other folder.
                    119: </p>
                    120: 
                    121: 
                    122: <h3>Working with calendars and folders</h3>
                    123: <p>
                    124: To work with calendars and folders, use the entries in the
                    125: Calendar Folders list, and use the context menus.
                    126: (To obtain a context menu, you can right-click, or use the Menu key
                    127: on your keyboard, or use some other method depending on your system.)
                    128: </p>
                    129: 
                    130: 
                    131: <h4>Creating and maintaining a folder</h4>
                    132: <p>
                    133: To create a new folder, choose New Folder from the context menu.
                    134: </p>
                    135: <img src="./calfo4.png" style="margin-left:2em;">
                    136: 
                    137: <p>
                    138: Give the new folder a name.
                    139: </p>
                    140: <img src="./calfo5.png" style="margin-left:2em;">
                    141: 
                    142: <p>
                    143: To populate the new folder, drag calendars from the All folder and drop
                    144: them in the new folder:
                    145: </p>
                    146: 
                    147: <p>
                    148: To specify the default calendar for new entries in the folder,
                    149: click one calendar's icon.
                    150: The icon displays a radio button to show that it is the default.
                    151: </p>
                    152: 
                    153: <p>
                    154: To remove a calendar from the folder, drag it back into All.
                    155: </p>
                    156: 
                    157: 
                    158: <h4>Changing calendar properties</h4>
                    159: <p>
                    160: The names and colours of calendars apply within a folder.
                    161: So a calendar can have a different name and a different colour
                    162: depending on the folder.
                    163: </p>
                    164: 
                    165: <p>
                    166: For example, in each project you might name the project manager's
                    167: calendar Project Manager, and colour it blue.
                    168: Suppose you are the project manager in one project.
                    169: In that project's folder, your calendar is named Project Manager and
1.4     ! whiteley  170: has the colour blue.
1.1       whiteley  171: But in other folders the same calendar has a different name and colour.
                    172: </p>
                    173: 
1.4     ! whiteley  174: <img src="./calfo8.png" style="margin-left:2em;">
        !           175: 
1.1       whiteley  176: <p>
                    177: This feature can be confusing.
                    178: Only use it if you have a specific purpose for different names and colours.
                    179: </p>
                    180: 
                    181: <p>
                    182: To rename a calendar, select it in the Folders panel, then click on its name.
                    183: To change a calendar's colour, click on its colour patch in the Folders panel.
                    184: </p>
                    185: 
                    186: <p>
                    187: To reload a remote calendar, click on its reload marker (a small blue circle at the
                    188: right of its colour patch).
                    189: </p>
                    190: 
1.4     ! whiteley  191: 
        !           192: <h4>Filters</h4>
        !           193: <p>
        !           194: <span style="border:1px solid #f00; margin-left:-4px; padding:4px;">
        !           195: This feature is not implemented in the current download.
        !           196: </span>
        !           197: </p>
        !           198: 
        !           199: <p>
        !           200: To filter a folder's entries, so you only see the entries that you want to work with,
        !           201: open the folder's properties and choose the Entry filter tab.
        !           202: Specify filter criteria to select the required entries.
        !           203: In this example, category and status criteria are specified:
        !           204: </p>
        !           205: 
        !           206: <img src="./calfo7.png" style="margin-left:2em;">
        !           207: 
        !           208: 
        !           209: <h4>Changing multiple entries in one step</h4>
        !           210: <p>
        !           211: <span style="border:1px solid #f00; margin-left:-4px; padding:4px;">
        !           212: This feature is not implemented yet.
        !           213: </span>
        !           214: </p>
        !           215: 
        !           216: <p>
        !           217: To change multiple entries in one step, make a folder that contains the entries.
        !           218: The entries can be in different calendars, and the folder can be filtered to protect
        !           219: entries that you do not want to change.
        !           220: </p>
        !           221: 
        !           222: <p>
        !           223: From the folder's context menu, select Change.
        !           224: In the Change Entries wizard, specify the change that you want to make.
        !           225: Press the Finish button to make the change.
        !           226: </p>
        !           227: 
        !           228: 
        !           229: 
1.1       whiteley  230: <h4>Options</h4>
                    231: <p>
                    232: To set options for Calendar Folders, choose Tools &ndash; Options... from the menu bar.
                    233: Go to the Folders page.
                    234: </p>
                    235: 
                    236: <p>
                    237: Choose whether to display tabs for the clock and the original Calendars list.
                    238: </p>
                    239: 
                    240: <p>
                    241: Specify how to display the date and time in the clock.
                    242: To use your operating system's settings, uncheck the Long box for the date
                    243: and choose System for the time.
                    244: </p>
                    245: 
                    246: <p>
                    247: To ensure that only one folder can be selected at a time, check the Single folder box.
                    248: </p>
                    249: 
                    250: <p>
                    251: To lock calendar names or colours so that they remain consistent between folders,
                    252: check the Name or Color boxes.
                    253: </p>
                    254: 
1.4     ! whiteley  255: <p>
        !           256: To choose calendar colours from a larger palette, check the box Alternate palette.
        !           257: The alternate palette has two pages, with 80 colours on each page.
        !           258: One page contains bright colours and greys, the other contains dull and pastel colours.
        !           259: The bar at the side of the palette switches pages.
        !           260: </p>
        !           261: 
        !           262: <img src="./calfo6.png" style="margin-left:2em;">
        !           263: 
        !           264: 
        !           265: <h4>Help</h4>
        !           266: <p>
        !           267: Calendar Folders contains built-in help.
        !           268: To use the help, you must also have the Calendar Help extension.
        !           269: </p>
        !           270: 
        !           271: <p>
        !           272: You can access the help in all the usual ways.
        !           273: For example, you can press the F1 or Help key, or the Help button in a dialog,
        !           274: or you can go to the Calendar Folders chapter in the help contents.
        !           275: 
        !           276: </p>
        !           277: 
        !           278: 
1.1       whiteley  279: 
                    280: <h3 id="install">Installing Calendar Folders</h3>
                    281: <p>
1.4     ! whiteley  282: A prototype of Calendar Folders is available so that you can understand the design.
        !           283: It is not yet fully working.
        !           284: Like Sunbird 0.2+ nightlies, the Calendar Folders prototype might have significant
        !           285: bugs that affect your data.
        !           286: </p>
        !           287: 
        !           288: <p>
        !           289: To use the Calendar Folders prototype, you must have Sunbird 0.2+ (a nightly test build),
        !           290: or Sunbird 0.3 when available.
        !           291: </p>
        !           292: 
        !           293: <p>
1.1       whiteley  294: To install Calendar Folders, choose Tools &ndash; Extensions... from Sunbird's menu bar.
1.4     ! whiteley  295: Drag the link below and drop it in the Extensions window:
1.1       whiteley  296: </p>
                    297: 
1.3       whiteley  298: <p><a href="http://downloads.mozdev.org/calendarhelp/calfolder-0.2-en-US.xpi">calfolder-0.2-en-US.xpi</a></p>
1.1       whiteley  299: 
                    300: <p>
1.4     ! whiteley  301: Wait for the download, and allow the installation to proceed.
        !           302: </p>
        !           303: 
        !           304: 
        !           305: <p>
1.1       whiteley  306: Restart Sunbird.
                    307: If the installation succeeds, you see the About Calendar Folders window.
                    308: To dismiss it, click on the background of the window (or press Escape).
                    309: </p>
                    310: 
                    311: <h4>Uninstalling Calendar Folders</h4>
                    312: <p>
                    313: To uninstall, return to the Extensions window.
                    314: Select Calendar Folders and press the Uninstall button.
                    315: Close Sunbird.
                    316: </p>
                    317: 
                    318: <p>
                    319: Go to your profile directory and delete the file <code>calfolder.rdf</code>.
                    320: Edit the file <code>prefs.js</code> and remove all the entries that contain <tt>calfolder</tt>.
                    321: Restart Sunbird.
                    322: </p>

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