File:  [mozdev] / calendarhelp / www / calfolder.html
Revision 1.11: download - view: text, annotated - select for diffs - revision graph
Sat Dec 3 16:17:47 2005 UTC (13 years, 10 months ago) by whiteley
Branches: MAIN
CVS tags: HEAD
Clock Tab extension (pre-release)

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

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