aboutsummaryrefslogtreecommitdiffstats
path: root/doc/C/apx-menuref.sgml
blob: fd3ad4f65d8884616328aa4b1903e3ccd4fecd40 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
<!--
<!DOCTYPE Appendix PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN">
-->

<appendix id="menuref">
  <title>Menu Reference</title>
  <para>
    This section will serve as a reference for every capability that
    <application>Evolution</application> has.  When menu items are
    repeated in <application>Evolution</application>, they're repeated
    here too.
  </para>
  <para>
    From left to right, the menus available to you when you are
    reading mail are: <guimenu>File</guimenu>,
    <guimenu>Edit</guimenu>, <guimenu>View</guimenu>,
    <guimenu>Tools</guimenu>, <guimenu>Actions</guimenu>, and
    <guimenu>Help</guimenu>.  The last of these doesn't change, but
    the rest of them have contents that will change depending on
    whether you're looking at mail, contacts, or calendar information.
    In addition, the editor tools for messages, appointments, and
    contacts all have menu bars.

  </para>
  <sect1 id="menuref-universal">
    <title>Menus that are the same everywhere</title>
    <para>
      The <guimenu>File</guimenu> and <guimenu>Help</guimenu> menus in
      the main <application>Evolution</application> window do not
      change, because they refer to universal items.  Other menus have
      contents that change depending on context.
    </para>
   
 <sect2 id="menuref-universal-file">
      <title>File Menu</title>
      <para>
    <variablelist>

      <varlistentry>
        <term><guisubmenu>New...</guisubmenu> Submenu</term>
        <listitem><para>
        <itemizedlist>
          <listitem><para>
              <guimenuitem>Folder</guimenuitem> &mdash;
               Create a new folder. See <xref 
               linkend="usage-mainwindow-folderbar">
               for more information about folders.
            </para></listitem>
          <listitem><para>
              <guimenuitem>Shortcut</guimenuitem> &mdash;
               Create a new Shortcut in the Shortcut Bar.
            </para></listitem>
          <listitem><para>
              <guimenuitem>Mail Message</guimenuitem> &mdash;
               Compose a new mail message. Covered in
               <xref linkend="usage-mail-getnsend-send">.
            </para></listitem>
          <listitem><para>
              <guimenuitem>Appointment</guimenuitem> &mdash;
               Enter a new appointment in your calendar. See <xref
            linkend="usage-calendar-apts-basic"> for more information.
            </para></listitem>
          <listitem><para>
              <guimenuitem>Task</guimenuitem> &mdash;
               Enter a new to-do item in your taskpad. Covered in 
               <xref linkend="usage-calendar-todo">.
            </para></listitem>
        </itemizedlist>
          </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Go to Folder</guimenuitem></term>
        <listitem><para>
               View the items in a particular folder.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Create New Folder</guimenuitem></term>
        <listitem><para>
         This item doesn't belong here any more.
          </para></listitem>
      </varlistentry>
      
      <varlistentry>
        <term><guimenuitem>Print Message</guimenuitem></term>
        <listitem><para>
         Print the current message.
          </para></listitem>
      </varlistentry>
      
      <varlistentry>
        <term><guimenuitem>Exit</guimenuitem></term>
        <listitem><para>
         Quit using <application>Evolution</application>.
          </para></listitem>
      </varlistentry>
    </variablelist>
       </para>
    </sect2>

    <sect2 id="menuref-universal-help">
      <title>The Help Menu</title>
      <para>
      <variablelist>
    <varlistentry>
      <term><guimenuitem>Help Index</guimenuitem></term>
      <listitem><para>
             Displays the table of contents for this document.
           </para></listitem>
    </varlistentry>
    <varlistentry>
      <term><guimenuitem>Getting Started</guimenuitem></term>
      <listitem><para>
              A quick look around, and a summary of the things
              <application>Evolution</application> can do for you.
           </para></listitem>
    </varlistentry>
    <varlistentry>
      <term><guimenuitem>Using the Mailer</guimenuitem></term>
      <listitem><para>
              An in-depth tour of <application>Evolution</application> Mail.
           </para></listitem>
    </varlistentry>
    <varlistentry>
      <term><guimenuitem>Using the Calendar</guimenuitem></term>
      <listitem><para>
             A step-by-step guide to using the Calendar.
           </para></listitem>
    </varlistentry>
    <varlistentry>
      <term><guimenuitem>Using the Contact Manager</guimenuitem></term>
      <listitem><para>
            Find your way around the Contact Manager.
           </para></listitem>
    </varlistentry>
    <varlistentry>
      <term><guimenuitem>Submit Bug Report</guimenuitem></term>
      <listitem><para>
             If you don't report them, they can't fix them.  Select this item to let the 
             developers know what's wrong.
           </para></listitem>
    </varlistentry>
    <varlistentry>
      <term><guimenuitem>About Evolution</guimenuitem></term>
      <listitem><para>
              Displays a window with information about the application and its authors.
              This has the same information as <xref linkend="authors">.
           </para></listitem>
      </varlistentry>
    </variablelist>
       </para>
    </sect2>
  </sect1>


  <sect1 id="menuref-mail">
    <title>Mail Menus</title>
    <para>
       All the menus for mail. FIXME: this paragraph needs content.
    </para>
   
    <sect2 id="menuref-mail-edit">
      <title>The Edit Menu</title>
      <para>
        This menu is currently empty.
      </para>
    </sect2>

    <sect2 id="menuref-mail-view">
      <title>The View Menu</title>
      <para>
        This menu lets you control the way
        <application>Evolution</application> displays your information
        for you.
        <variablelist>
      <varlistentry>
        <term><guimenuitem>Show Shortcut Bar</guimenuitem></term>
        <listitem><para>
              Toggle the shortcut bar on and off with this item.             
            </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Show Folder Bar</guimenuitem></term>
        <listitem><para>
             Toggle the folder bar on and off with this item. 
             See <xref linkend="usage-mainwindow-folderbar"> for 
             more information about the folder bar.             
            </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Threaded Message List</guimenuitem></term>
        <listitem><para>
               This item controls whether your message list is displayed by thread 
               or by other criteria.  The default order is by date; see
               <xref linkend="usage-mail-listorder"> for information about the
               order of the message list.
            </para></listitem>
      </varlistentry>
    </variablelist>
      </para>
    </sect2>

    <sect2 id="menuref-mail-tools">
      <title>The Tools Menu</title>
      <para>
      <variablelist>
      <varlistentry>
        <term><guimenuitem>Mail Filters</guimenuitem></term>
        <listitem><para>
             Edit your mail filters here.  
             See <xref linkend="usage-mail-organize-filters">
             for more information about mail filtering.
           </para></listitem>
      </varlistentry>
      
      <varlistentry>
        <term><guimenuitem>vFolder Editor</guimenuitem></term>
        <listitem><para>
              Create, edit, and delete vFolders with this tool. 
              To learn about using vFolders with mail, see 
              <xref linkend="usage-mail-organize-vfolders">.
           </para></listitem>
      </varlistentry>
      
      <varlistentry>
        <term><guimenuitem>Mail Configuration</guimenuitem></term>
        <listitem><para>
             This is a poorly named tool.  You can set your identity, 
             and everything else related to your mail account, here.
           </para></listitem>
      </varlistentry>
      
      <varlistentry>
        <term><guimenuitem>Forget Passwords</guimenuitem></term>
        <listitem><para>
             Although it's really an Action (FIXME), this item will cause 
             <application>Evolution</application> to forget what your
             password is.
           </para></listitem>
      </varlistentry>
      
      <varlistentry>
        <term><guimenuitem>Configure Folder</guimenuitem></term>
        <listitem><para>
              Another FIXME item, this allows you to set the file format
              in which <application>Evolution</application> stores mail.
           </para></listitem>
      </varlistentry>
    </variablelist>
       </para>
    </sect2>

    <sect2 id="menuref-mail-actions">
      <title>The Actions Menu</title>
      <para>
          When you select one of the actions from this menu,
          <application>Evolution</application> will do your bidding,
          usually to the item you have selected.
      </para>
      <para>
          The actions you can perform are:
          <variablelist>
      <varlistentry>
        <term><guimenuitem>Edit Message</guimenuitem></term>
        <listitem><para>
          Select a message in the drafts folder before you select this 
          item.  You can only edit a message you have written. FIXME: POOR
          description of BROKEN behavior. 
       </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>View Message</guimenuitem></term>
        <listitem><para>
           Displays the selected message in a new window.
       </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Mark all Messages Read</guimenuitem></term>
        <listitem><para>
          <application>Evolution</application> keeps track of which messages 
          you've seen;  When you don't need to read all those messages, select this item.
          You can mark a single message as read by right-clicking it in the message bar.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Expunge</guimenuitem></term>
        <listitem><para>
                   Emtpies the trash folder, erasing messages permanently. 
                   Once you've done this, don't come crying to me if you
                   want a message back.
           </para></listitem>
      </varlistentry>
    </variablelist>
       </para>
    </sect2>
  </sect1>

  <sect1 id="menuref-mail-editor">
    <title>The Message Composer Menus</title>
    <para>
      The message composition window has its own set of menus:
      <guimenu>File</guimenu>, which controls operations on files and
      data, <guimenu>Edit</guimenu>, for text editing,
      <guimenu>Format</guimenu>, which controls the file format of
      messages you send, <guimenu>View</guimenu>, to set how you view
      the message, and <guimenu>Insert</guimenu>, which holds tools
      for embedding files and other items in messages.  Here's what's in them:
    </para>
    <sect2 id="menuref-mail-editor-file">
      <title>The Message Composer File Menu</title>
      <para>
        <variablelist>
      <varlistentry>
          <term><guimenu>Open</guimenu></term>
          <listitem><para>
         Open a text file or a draft mail message.
          </para></listitem>
        </varlistentry>

        <varlistentry>
          <term><guimenu>Save</guimenu></term>
          <listitem><para>
         Save a mail message as a text file.
          </para></listitem>
        </varlistentry>

        <varlistentry>
          <term><guimenu>Save As</guimenu></term>
          <listitem><para> 
        Choose a file name and location for
        a message you want to save as a text file.
          </para></listitem>
        </varlistentry>

        <varlistentry>
          <term><guimenu>Save in Folder</guimenu></term>
          <listitem><para>
         Save a message as a draft, rather than 
         as a seperate text file. (FIXME: should be removed, and 
         functionality subsumed under "Save As").
          </para></listitem>
        </varlistentry>

        <varlistentry>
          <term><guimenu>Insert Text File</guimenu></term>
          <listitem><para>
           Open a text file and insert it into 
           the current message. (FIXME: belongs under "Insert").
          </para></listitem>
        </varlistentry>
      
        <varlistentry>
          <term><guimenu>Send</guimenu></term>
          <listitem><para>
          Sends the message immediately.
          </para></listitem>
        </varlistentry>

      <varlistentry>
        <term><guimenu>Close</guimenu></term>
        <listitem><para>
         Closes the message composer.  If you have not done so, 
         <application>Evolution</application>
         will ask you if you want to save your message.
          </para></listitem>
      </varlistentry>
    </variablelist>
      </para>
    </sect2>
    <sect2 id="menuref-mail-editor-edit">
      <title>The Message Composer Edit Menu</title>
      <para>
          The <guimenu>Edit</guimenu> menu in the message composer
          contains the following items.  Keyboard shortcuts are listed
          next to the items in the menus themselves.

        <variablelist>

      <varlistentry>
        <term><guimenuitem>Undo</guimenuitem></term>
        <listitem><para>
                Undoes the last action you performed.
        </para></listitem>
      </varlistentry>

          <varlistentry>
        <term><guimenuitem>Redo</guimenuitem></term>
        <listitem><para>
               If you change your mind about Undoing something, 
               you can always use this item.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Cut</guimenuitem></term>
        <listitem><para>
                Removes the selected text from the text entry window and 
                retains it in the system "clipboard" memory, ready for pasting.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Copy</guimenuitem></term>
        <listitem><para>
              Copies selected text to the system clipboard without deleting it.
              The text can then be inserted elsewhere with the 
              <guimenuitem>Paste</guimenuitem> command.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Paste</guimenuitem></term>
        <listitem><para>
                Inserts the contents of the system clipboard at the 
                location of the cursor.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Find</guimenuitem></term>
        <listitem><para>
               Enter a phrase and find your match in your message body.
               As with <guimenuitem>Find Regex</guimenuitem>, 
               <guimenuitem>Find Again</guimenuitem>, and
               <guimenuitem>Replace</guimenuitem>, <application>Evolution</application>
                will offer you the option to search forwards or backwards, and.

        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Find Regex</guimenuitem></term>
        <listitem><para>
               If you are familiar with regular expressions, often called 
               "regexes," you can search for something more complicated, 
               using wildcards and boolean logic. If you're not familiar with 
               them, there are numerous resources for you on the web.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Find Again</guimenuitem></term>
        <listitem><para>
              Repeats your last search.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Replace</guimenuitem></term>
        <listitem><para>
               Enter a word or phrase and the word or phrase with which you'd like
               to replace it.  
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Properties</guimenuitem></term>
        <listitem><para>
               This item brings up the Message Composer Properties Capplet, 
               a portion of the GNOME Control Center that determines the 
               key bindings for the message composer.  Help for this capplet is 
               available directly from the Control Center. (FIXME: Write that help doc too).
        </para></listitem>
      </varlistentry>

    </variablelist>
      </para>
    </sect2>
<!--    
        <varlistentry>
          <term><guimenu>View</guimenu></term>
          <listitem><para>
           </para></listitem>
        </varlistentry>

        <varlistentry>
          <term><guimenu>Insert</guimenu></term>
          <listitem><para>
           </para></listitem>
        </varlistentry>
    </variablelist>
      </para>

-->




  </sect1>
  
<sect1 id="menuref-cal">
    <title>The Calendar Menus</title>
    <para>
      The Main window of the calendar has the same menus as the main
      window of the mail client.  However, their contents vary in a
      number of ways.
    </para>
    <sect2 id="menuref-cal-edit">
      <title>The Calendar Edit Menu</title>
      <para>
         The contents of the Edit menu are currently so borked that I
         refuse to document them right now. (That means FIXME). They
         should be:

         <variablelist>
      <varlistentry>
        <term><guimenuitem>Item</guimenuitem></term>
        <listitem><para>
              Description
           </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><guimenuitem>Item</guimenuitem></term>
        <listitem><para>
              Description
           </para></listitem>
      </varlistentry>
      
      <varlistentry>
      <term><guimenuitem>Item</guimenuitem></term>
      <listitem><para>
              Description
           </para></listitem>
      </varlistentry>
    </variablelist>
      </para>
    </sect2>
    <sect2 id="menuref-cal-view">
      <title>The Calendar View Menu</title>
      <para>
        The Calendar's <guimenu>View</guimenu> menu contains the following items:

         <variablelist>
      <varlistentry>
        <term><guimenuitem>Show Shortcut Bar</guimenuitem></term>
        <listitem><para>
              Toggle the Shortcut Bar on and off with this item.              
           </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Show Folder Bar</guimenuitem></term>
        <listitem><para>
             Toggle the folder bar on and off with this item. 
             See <xref linkend="usage-mainwindow-folderbar"> for 
             more information about the folder bar.     
           </para></listitem>
      </varlistentry>
          
      <varlistentry>
      <term><guimenuitem>View By Day</guimenuitem></term>
      <listitem><para>
             Switch to the day view for your calendar.
           </para></listitem>
      </varlistentry>     

      <varlistentry>
      <term><guimenuitem>View Five Days</guimenuitem></term>
      <listitem><para>
             View five calendar days at once. 
           </para></listitem>
      </varlistentry>     

      <varlistentry>
      <term><guimenuitem>View by Week</guimenuitem></term>
      <listitem><para>
             Switch the calendar view to full week mode.
           </para></listitem>
      </varlistentry>
  
      <varlistentry>
      <term><guimenuitem>View By Month</guimenuitem></term>
      <listitem><para>
             Look at a month at a time.
           </para></listitem>
      </varlistentry>
    </variablelist>
      </para>
    </sect2>
    <sect2 id="menuref-cal-tools">
      <title>The Calendar Tools Menu</title>
      <para>
         This menu is empty.
      </para>
    </sect2>

    <sect2 id="menuref-cal-actions">
      <title>The Calendar Actions Menu</title>
      <para>
         This menu is empty.
      </para>
    </sect2>
  </sect1>

  <sect1 id="menuref-cal-editor">
    <title>The Appointment Editor Menus</title>
    <para>
      Kevin might do this section.
    </para>
  </sect1>
  

  <sect1>
    <title>Contact Manager Menus</title>
    <para>
      Insert Content Here (FIXME).
    </para>

    <sect2 id="menuref-contact-edit">
      <title>Contact Manager Edit Menu</title>
      <para>
         This menu is empty.
      </para>
    </sect2>


    <sect2 id="menuref-contact-view">
      <title>Contact Manager Edit Menu</title>
      <para>
        This menu contains the following items:

         <variablelist>
      <varlistentry>
        <term><guimenuitem>Show Shortcut Bar</guimenuitem></term>
        <listitem><para>
              Toggle the Shortcut Bar on and off with this item.              
           </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><guimenuitem>Show Folder Bar</guimenuitem></term>
        <listitem><para>
             Toggle the folder bar on and off with this item. 
             See <xref linkend="usage-mainwindow-folderbar"> for 
             more information about the folder bar.     
           </para></listitem>
      </varlistentry>
          
      <varlistentry>
      <term><guimenuitem>As Table</guimenuitem></term>
      <listitem><para>
             View your contacts as a table.  
             When in table-view mode, this menu item reads 
             <guimenuitem>As Minicards</guimenuitem>, and changes the view
             back to the minicard format.
           </para></listitem>
      </varlistentry>     
    </variablelist>      
      </para>
    </sect2>

   <sect2 id="menuref-contact-tools">
      <title>Contact Manager Tools Menu</title>
      <para>
         This menu is empty.
      </para>
    </sect2>



   <sect2 id="menuref-contact-actions">
      <title>Contact Manager Tools Menu</title>
      <para>
         This menu is broken. (FIXME).
      </para>
    </sect2>
  </sect1>

  <sect1 id="menuref-contact-editor">
    <title>The Contact Editor Menus</title>
    <para>
      Kevin might do this section.
    </para>
  </sect1>
  

</appendix>