Editing Views.pl (section)

===Menu options===

These options can only be used in the '''menu definitions'''.

{|border="1" cellpadding="4" cellspacing="0"
|- valign="top"
|fields  <sup style="font-weight:bold; font-size:10px;">(M)</sup>
|Obligatory, an array of field identifiers. Items in all fields are merged together. For example, to define a list of those those who are either authors or editors or both, use the definition

    fields => [ "creators_id", "editors_id" ],

Even if there is a single field, you must use square brackets, such as

    fields => [ "subjects" ],

<div style="color: #662211; background-color:#ddffdc; border:1px solid black; padding:3px;">'''Important!''' All fields must have the same type - i.e. you cannot mix titles and authors, say.</div>

You can also add extra rendering info to the field name, without the "render_" prefix. For example, to make a date have resolution year, you would write

    fields => [ "date;res=year" ],

or, ordering authors by their ''given'' names rather than by their family names:

    fields => [ "creators_name;order=gf" ],

You can add ";quiet" to the field name to force non-existing values to appear as empty space rather than the ugly "UNDEFINED" (see the allow_null property below). You can find the available rendering properties of different fields in the [[Metadata]] section.
|- valign="top"
|allow_null <sup style="font-weight:bold; font-size:10px;">(M)</sup> 
|The ''undefined'' value among the possible values of the fields does not show up in the generated view. To allow the undefined value to appear as well, set

  allow_null => 1,

Beware: the title of the undefined entries will be the ugly UNDEFINED. You might consider to use the ";quiet" rendering option for field names.
|- valign="top"
|hideempty <sup style="font-weight:bold; font-size:10px;">(M)</sup>
|If a category is empty, don't show it as an entry. Default value: show all entries, even if they contain no entries. Used only in menus, not at the lower level (list).
Example:

    hideempty => 1,
|- valign="top"
|reverse_order <sup style="font-weight:bold; font-size:10px;">(M)</sup>
|If set, then the ordering of items in this menu is reversed. Example:

    reverse_order => 1,
|- valign="top"
|mode <sup style="font-weight:bold; font-size:10px;">(M)</sup>
|Possible values: ''[[#Sections|sections]]'' and ''default'' (default). When defined as ''sections'' then grouping can be defined by the following data:
* ''grouping_function'' (group by first character if not defined)
* ''group_sorting_function'' (how to sort members of a group)
* ''group_range_function''
* ''open_first_section'' the front page should show the first section
See [[#Sections|below]].
|- valign="top"
|hideup <sup style="font-weight:bold; font-size:10px;">(M)</sup>
|When set to 1, don't show the "move one level up" link at the top of the page.
|- valign="top"
|render_menu <sup style="font-weight:bold; font-size:10px;">(M)</sup>
|The configuration parameter which renders this menu. This should be a string, and also you should define a routine with the same name. For example if you write
    render_menu => 'render_view_menu_3col_boxes',
then this menu will be rendered by the routine which is defined in [[views_render_menu_example.pl]] as
  $c->{render_view_menu_3col_boxes} = sub
  {
       ...
  }
See there for hints how to tweak your own routine.
|- valign="top"
|new_column_at <sup style="font-weight:bold; font-size:10px;">(M)</sup>
|Used in menus (not lists) and in default mode. This is an array of integers representing the number of items in a view list before another column is added.  For example:

 [ 11 ]

The menu is rendered as a single column data if there are less than 11 entries, then there would be 2 columns.

 [ 11, 21 ]

This would have one column if there were ten or less values, two columns if there are twenty or less, and three columns for all other cases.

 [ 0, 0 ]

This would always have three columns.

 [ 2, 3 ]

This would have one column for a single data, two columns for two, and three columns for three or more data.

Add one to the number of integers in the array and you get the maximum number of columns. The entries are evenly distributed in the columns.
|}