Adding comment for future developer(s)
[squirrelmail.git] / templates / default / read_menubar_nav.tpl
1 <?php
2 /**
3  * read_menubar_nav.tpl
4  *
5  * Template to generate the nav buttons while reading a message, e.g. "Previous",
6  * "Next", "Delete & Previous", etc.  When used in conjunction with the
7  * read_menubar_nav tempalte, the entire menubar is generated.
8  * 
9  * The following variables are available in this template:
10  *    $nav_on_top       - boolean TRUE if the navigation buttons are on top of the
11  *                        action buttons generated here.
12  *    $prev_href        - URL to move to the previous message.  Empty if not avilable.
13  *    $up_href          - URL to move up in the message.  Empty if not available.
14  *    $next_href    - URL to move to the next nessage.  Empty when N/A.
15  *    $del_prev_href - URL to delete this message and move to the next one.  Empty if N/A.
16  *    $del_next_href - URL to delete this message and move to the next one.  Empty if N/A.
17  *    $view_msg_href - URL to go back to the main message.  Empty if N/A.
18  *    $msg_list_href - URL to go to the message list.
19  *    $search_href   - URL to go back to the serach results.  Empty if N/A.
20  *    $form_extra    - Extra elements required by the forms to delete, move or copy
21  *    $compose_href  - Base URL to forward, reply, etc.  Note that a specific action
22  *                     must also be given by the form or in this URL.
23  *    $on_click      - Onclick event string for all buttons
24  *    $forward_as_attachment_enabled - boolean TRUE if forwarding as attachments
25  *                     has been enabled.
26  *    $can_resume_draft - boolean TRUE if the "resume draft" is legitimate for
27  *                     this message.
28  *    $can_edit_as_new - boolean TRUE if the "reasume as new" action is legitimate
29  *                     for this message
30  *    $mailboxes     - array containing list of mailboxes available for move/copy action.
31  *    $can_be_deleted - boolean TRUE if this message can be deleted.
32  *    $can_be_moved  - boolean TRUE if this message can be moved.
33  *    $cab_be_copied - boolean TRUE if this message can be copied to another folder.
34  *    $move_delete_form_action - the value for the ACTION attribute of forms to
35  *                     move, copy or delete a message
36  *    $delete_form_extra - additional input elements needed by the DELETE form
37  *    $move_form_extra - additional input elements needed by the MOVE form.
38  *    $last_move_target - the last folder that a message was moved/copied to. 
39  *     *
40  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
41  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
42  * @version $Id$
43  * @package squirrelmail
44  * @subpackage templates
45  */
46
47 /** add required includes **/
48
49 /** extract template variables **/
50 extract($t);
51
52 /*FIXME: This is a place where Marc's idea for putting all the buttons and
53          links and other widgets into an array is sorely needed instead of
54          hard-coding everything.  Whomever implements that, PLEASE, PLEASE
55          look at how the preview pane plugin code is used in this same template 
56          file for the *default_advanced* set to change some links and buttons 
57          and make sure your implementation can support it (tip: it may or may 
58          not be OK to let a plugin do the modification of the widgets, since 
59          a template set can turn on the needed plugin, but that might not be 
60          the most clear way to solve said issue).*/
61
62
63 /** Begin template **/
64
65 if ($nav_on_top) {
66     $table_class = 'top';
67     $plugin_hook = 'read_body_menu_nav_top';
68 } else {
69     $table_class = 'bottom';
70     $plugin_hook = 'read_body_menu_nav_bottom';
71 }
72 ?>
73 <div class="readMenuBar">
74 <table cellspacing="0" class="<?php echo $table_class; ?>">
75  <tr class="nav">
76   <td class="nav">
77    <small>
78    [
79    <?php
80     if (empty($prev_href)) {
81         echo _("Previous");
82     } else {
83         ?>
84    <a href="<?php echo $prev_href; ?>"><?php echo _("Previous"); ?></a>
85         <?php
86     }
87    ?> | 
88    <?php
89     if (empty($up_href)) {
90         # Do nothing
91     } else {
92         ?>
93    <a href="<?php echo $up_href; ?>"><?php echo _("Up"); ?></a> |
94         <?php
95     }
96
97     if (empty($next_href)) {
98         echo _("Next");
99     } else {
100         ?>
101    <a href="<?php echo $next_href; ?>"><?php echo _("Next"); ?></a>
102         <?php
103     }
104    ?>
105    ]
106    &nbsp;&nbsp;&nbsp;&nbsp;
107    <?php
108     if (!empty($del_prev_href) || !empty($del_next_href)) {
109         ?>
110         [
111         <?php        
112         if (empty($del_prev_href)) {
113             echo _("Delete &amp; Previous");
114         } else {
115             ?>
116    <a href="<?php echo $del_prev_href; ?>"><?php echo _("Delete &amp; Previous"); ?></a>
117             <?php
118         }
119         ?>
120         | 
121         <?php
122         if (empty($del_next_href)) {
123             echo _("Delete &amp; Next");
124         } else {
125             ?>
126    <a href="<?php echo $del_next_href; ?>"><?php echo _("Delete &amp; Next"); ?></a>
127             <?php
128         }
129         ?>
130         ]
131    &nbsp;&nbsp;&nbsp;&nbsp;
132         <?php
133     }
134    
135     if (!empty($view_msg_href)) {
136         ?>
137    [ <a href="<?php echo $view_msg_href; ?>"><?php echo _("View Message"); ?></a> ]
138    &nbsp;&nbsp;&nbsp;&nbsp;
139         <?php
140     }
141    ?>
142    [ <a href="<?php echo $message_list_href; ?>"><?php echo _("Message List"); ?></a>
143    <?php
144     if (!empty($search_href)) {
145         ?>
146    | <a href="<?php echo $search_href; ?>"><?php echo _("Search Results"); ?></a>
147         <?php
148     }
149    ?>
150    ]
151    </small>
152    <?php if(!empty($plugin_output[$plugin_hook])) echo $plugin_output[$plugin_hook]; ?>
153   </td>
154  </tr>
155 </table>
156 </div>