Difference between revisions of "Views.pl"
(→New features) |
(→variations) |
||
Line 60: | Line 60: | ||
====variations==== | ====variations==== | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
The following options are available: | The following options are available: | ||
− | + | {| border="1" cellpadding="4" cellspacing="0" | |
− | + | |reverse | |
− | + | |Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first. | |
− | Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first. | + | |- |
− | + | |filename | |
− | + | |Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed. | |
− | |||
− | |||
− | Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed. | ||
filename=different_filename | filename=different_filename | ||
− | + | |- | |
− | + | |first_value | |
− | + | |If a field is multiple, only use the first value. Otherwise each item will appear once for each value. | |
− | + | |- | |
− | If a field is multiple, only use the first value. Otherwise each item will appear once for each value. | + | |first_initial |
− | + | |If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win. | |
− | + | |- | |
− | + | |first_letter | |
− | + | |The same as 'truncate=1' | |
− | If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win. | + | |- |
− | + | |truncate | |
− | + | |Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only. | |
− | |||
− | |||
− | The same as 'truncate=1' | ||
− | |||
− | |||
− | |||
− | |||
− | Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only. | ||
truncate=4 | truncate=4 | ||
− | + | |- | |
− | + | |tags | |
− | + | |Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each. | |
− | + | |- | |
− | Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each. | + | |cloud |
− | + | |Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use. | |
− | + | |- | |
− | + | |cloudmax | |
− | + | |The % size of the largest tag in a tag cloud. | |
− | Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use. | + | |- |
− | + | |cloudmin | |
− | + | |The % size of the smallest tag in a tag cloud. | |
− | + | |- | |
− | + | |jump | |
− | The % size of the largest tag in a tag cloud. | + | | |
− | |||
− | |||
− | |||
− | |||
− | The % size of the smallest tag in a tag cloud. | ||
− | |||
− | |||
− | |||
− | |||
jump=plain | jump=plain | ||
Turns of the 'jump to' text before the list of subheading navigation links. | Turns of the 'jump to' text before the list of subheading navigation links. | ||
− | + | |- | |
− | + | |no_seperator (sic) | |
− | + | |Turns of the separator between each subheading navigation link (by default a vertical bar symbol). | |
− | + | |- | |
− | Turns of the separator between each subheading navigation link (by default | + | |string |
− | + | |Uses values 'as is'. No ordervalues, no phrases. | |
− | + | |- | |
− | + | |hideup (since 3.1.1) | |
− | + | |Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files) | |
− | Uses values 'as is'. No ordervalues, no phrases. | + | |- |
− | + | |render_fn | |
− | + | |Name of a function to render this groupings list of items. For an example, see views_render_items_example.pl | |
− | + | |} | |
− | Name of a function to render this groupings list of items. For an example, see views_render_items_example.pl |
Revision as of 14:16, 19 November 2008
Contents
Option avaible for the views config
This link is an 'How to' about views with examples.
Basic
id (mandatory)
fields (mandatory)
order
Standard
allow_null
hideempty:
heading_level
include
subheadings
Extra feature
citation
nocount
nohtml
noindex
nolink
New features
The name of a config element which defines a function with an alternate way to render the menu page for a view. For an example, try looking in cfg.d/views_render_menu_example.pl
new_column_at
This is an array of integers representing the number of items in a view list before another column is added. For example:
[ 10 ]
This would have one column of values until there were 11, then there would be 2 columns.
[ 10, 10 ]
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.
[ 0, 0 ]
This would always have three columns.
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.
variations
The following options are available:
reverse | Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first. |
filename | Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.
filename=different_filename |
first_value | If a field is multiple, only use the first value. Otherwise each item will appear once for each value. |
first_initial | If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win. |
first_letter | The same as 'truncate=1' |
truncate | Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.
truncate=4 |
tags | Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each. |
cloud | Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use. |
cloudmax | The % size of the largest tag in a tag cloud. |
cloudmin | The % size of the smallest tag in a tag cloud. |
jump |
jump=plain Turns of the 'jump to' text before the list of subheading navigation links. |
no_seperator (sic) | Turns of the separator between each subheading navigation link (by default a vertical bar symbol). |
string | Uses values 'as is'. No ordervalues, no phrases. |
hideup (since 3.1.1) | Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files) |
render_fn | Name of a function to render this groupings list of items. For an example, see views_render_items_example.pl |