indico/htdocs/ihelp/html/_sources/UserGuide/Categories.txt

   1 ==========
   2 Categories
   3 ==========
   4
   5 Category
   6 ---------
   7
   8 A Category is a means of grouping your events or other Categories
   9 together. In Indico, *Home* is the top level category from where you
  10 start. Inside a category you can:
  11
  12 * add events or other sub-categories,
  13 * set access rights to say who can access or modify,
  14 * re-allocate the sub-categories,
  15 * remove the sub-categories,
  16 * and also delete the current category and everything inside it.
  17
  18 These features are accessible through the menu *Manage* (you must be logged in
  19 and with modification rights in order to see it), that you can find to the right
  20 of the title "Main categories". After clicking *Manage* (more specifically its inner
  21 option *Edit category*) you will be accessing the Management area for Category.
  22
  23
  24 Creating a Category
  25 -------------------
  26
  27 You can create a new category from the menu *Manage* and then by clicking
  28 on *Add subcategory*.
  29 You will need to have an Administrator's account or be listed
  30 in the modification list `(see Protection) <#protection>`_
  31 for the category.
  32
  33 You can also create a subcategory from the Management area, which you
  34 access from the menu *Manage*, option *Edit category*. In *General settings*,
  35 `(See General Settings) <#general-settings>`_ , click on the button
  36 *add subcateg*.
  37
  38 |image1|
  39
  40 Setting the protection for your category is important. You can set it
  41 to Inheriting, Restricted or Public, see :ref:`access_control` .
  42
  43
  44 -----------------
  45
  46 .. _category_overview:
  47
  48 Category overview
  49 -----------------
  50
  51 In the display page of the categories, the option *View* > *Today's events* allows you to see
  52 the category's event overview. Events that belong to the category and
  53 its subcategories from the specified period will be displayed.
  54
  55 It is possible to exclude some categories from the event overview, and
  56 hence control the visibility of the events belonging to the category
  57 in *General settings* `(See General Settings) <#general-settings>`_ .
  58 Categories have three event visibility levels:
  59
  60 * *Everywhere* - events are shown in the event overview webpage for this category and the parent categories.
  61 * *Category name* - events are shown only in the overview webpage for current category.
  62 * *Nowhere* - events are not shown in any overview webpage.
  63
  64 |image6|
  65
  66 As you can see in the previous image, it allows you to see all the events
  67 happening in one specific day. You can then view the other days by clicking on the
  68 arrows on top, or by choosing the day on the calendar on the left.
  69 Underneath the calendar, you can also choose the display options. You can
  70 choose to display the events over a day, a week or a month.
  71 You can also choose the detail level: *agenda* will show you all the events
  72 occuring over that period of time, *sessions* will only display the sessions
  73 and *contributions* will only display the contributions.
  74
  75 |image7|
  76
  77 **Calendar overview webpage** : Another option for *View* is the calendar view. It gives you an overview of all the
  78 events over several months. You can access it by clicking on *View* -> *Calendar*.
  79 You can see all the events happening in one specific day by pointing with
  80 your mouse on the day you wish to view (see image above). On the left menu,
  81 you can choose the number of months you wish to view (up to 12), the starting
  82 month and the number of colums displayed. You can also change to color legend.
  83
  84 Category Management Area
  85 ------------------------
  86
  87 General settings
  88 ~~~~~~~~~~~~~~~~
  89
  90 In the Category Management Area, the first option in the menu is *General settings*:
  91
  92 You can modify the details of the category:
  93
  94 * Name
  95 * Description
  96 * Timezone
  97 * Icon
  98 * Default style (layout) for meetings created within this category `(see Meetings) <Meetings.html>`_
  99 * Default style (layout) for lectures created within this category `(see Lectures) <Lectures.html>`_
 100 * Event visibility for this category `(See Category overview) <#category-overview>`_
 101
 102 and you can modify its content:
 103
 104 * Add a new sub-category
 105 * Re-allocate (move to another category) some events or categories
 106 * Remove the inner events or categories
 107
 108 |image2|
 109
 110 --------------
 111
 112 Files
 113 ~~~~~
 114
 115 In this option, you can add material to a category. To do so, click on
 116 the link *Add Material*. A window will appear:
 117
 118 |image8|
 119
 120 When uploading material, in the *Basic* tab, you can select its access
 121 protection and set it to inheriting, private or public
 122 (for more details, see :ref:`access_control` ).
 123 In the *Advanced* tab, you can add a description and a display name. The
 124 display name will be used instead of the original name of the file.
 125
 126 --------------
 127
 128 Protection
 129 ~~~~~~~~~~
 130
 131 From the Management Area you can protect your category using the
 132 three controls for access levels: Modification control, Access control
 133 and Domain control. You can add Users or  Groups to the Modification and
 134 Access control lists. Conference creation control controls the users who
 135 are able to add events to this category.
 136
 137 |image3|
 138
 139 *Modification Control*: Category Managers can be added to a
 140 category to allow access to the Management Area for modification.
 141 Category managers are either those listed in the modification
 142 control list or Indico administrators. The creator of a category
 143 will be able to modify its category without being listed.
 144
 145 *Access Control*: A category can be public, inheriting or private;
 146 Public: Anyone can view a public category and any user can add events to it.
 147 However, users will only be able to see the events inside the
 148 category to which they have access.
 149 Restricted: Only those users in the access list or administrators can
 150 access the category and add events. When a Category is made private,
 151 the option for domain control is omitted and any event or
 152 category made inside it will also be private. The category will be
 153 displayed with "(protected)" after its name to show it is private.
 154 As well, if the category access is  RESTRICTED the category manager will be able to set a
 155 'Contact in case of no access', so users with no access will know who to contact
 156 in order to request access.
 157 Inheriting: The category will have the same access protection as its
 158 parent category. This means that changing the parent's protection
 159 will change the protection of tha category.
 160
 161 *Domain Control*: The access to the Category can be restricted by domain.
 162 Therefore, just the users from the chosen domain will be able to access
 163 (e.g. If we choose the domain CERN, just users from inside CERN will
 164 be able to access the category and its content).
 165
 166 *Conference creation control*: You can restrict who is able to add
 167 events to the category. If you do so, you will need to add
 168 users or groups to the list in order to allow them to add events.
 169
 170 |image4|
 171
 172 `See Protection System <Protection.html>`_
 173 in order to know more about Protection in Indico.
 174
 175 --------------
 176
 177 Detail Modification & Sub-Category/Event Organisation
 178 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 179
 180 The details of a Category can be modified and sub-categories can
 181 be organised from the option *General settings* in the management area.
 182 Details can be modified by clicking on *modify* inside the main menu.
 183 Sub-categories and events can be organised in the particular order
 184 in which you wish to view them by using the order drop down box next
 185 to each sub-category.
 186
 187 |image5|
 188
 189 You can re-allocate a sub-category or event by selecting the one
 190 you wish to move using the tick box and clicking on re-allocate,
 191 you will then be asked to where you would like to reallocate this
 192 sub-category/event.
 193
 194 To remove a sub-category and anything it contains or an event,
 195 select it and click *remove*. If it contains anything you will be
 196 asked confirmation of the deletion.
 197
 198 --------------
 199
 200 Deleting a Category
 201 ~~~~~~~~~~~~~~~~~~~
 202
 203 To delete the current category you can go to the Tools menu in the
 204 Management Area and select 'Delete this category'. There is no undo tool
 205 so far, but you will be asked to confirm the deletion first.
 206
 207 --------------
 208
 209 .. |image0| image:: UserGuidePics/logo.png
 210 .. |image1| image:: UserGuidePics/categ1.png
 211 .. |image2| image:: UserGuidePics/categ2.png
 212              :width: 900px
 213 .. |image3| image:: UserGuidePics/categ3.png
 214 .. |image4| image:: UserGuidePics/categ4.png
 215 .. |image5| image:: UserGuidePics/categ5.png
 216 .. |image6| image:: UserGuidePics/categ6.png
 217 .. |image7| image:: UserGuidePics/categ7.png
 218 .. |image8| image:: UserGuidePics/uploadMaterial.png
 219