File:  [mozdev] / calendarhelp / www / calfolder.html
Revision 1.8: download - view: text, annotated - select for diffs - revision graph
Wed Oct 26 10:29:07 2005 UTC (13 years, 6 months ago) by whiteley
Branches: MAIN
CVS tags: HEAD
fix for 0.3

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

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