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

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

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