https://wiki.eprints.org/w/api.php?action=feedcontributions&feedformat=atom&user=Tajoli 2026-05-11T20:09:32Z User contributions MediaWiki 1.31.8 https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6229 2009-02-03T12:24:45Z

<p>Tajoli: </p> <hr /> <div>== Option avaible for the views config ==<br /> This link is an [http://wiki.eprints.org/w/Adding_new_views 'How to' about views] with examples.<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====render_menu====<br /> <br /> 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 lib/defaultcfg/cfg.d/views_render_menu_example.pl<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> <br /> The following options are available:<br /> <br /> {| border=&quot;1&quot; cellpadding=&quot;4&quot; cellspacing=&quot;0&quot;<br /> |reverse<br /> |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.<br /> |-<br /> |filename<br /> |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.<br /> <br /> filename=different_filename<br /> |-<br /> |first_value<br /> |If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> |-<br /> |first_initial<br /> |If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> |-<br /> |first_letter<br /> |The same as 'truncate=1'<br /> |-<br /> |truncate<br /> |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.<br /> <br /> truncate=4<br /> |-<br /> |tags<br /> |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.<br /> |-<br /> |cloud<br /> |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.<br /> |-<br /> |cloudmax<br /> |The % size of the largest tag in a tag cloud.<br /> |-<br /> |cloudmin<br /> |The % size of the smallest tag in a tag cloud.<br /> |-<br /> |jump<br /> |<br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> |-<br /> |no_seperator (sic)<br /> |Turns of the separator between each subheading navigation link (by default a vertical bar symbol).<br /> |-<br /> |string<br /> |Uses values 'as is'. No ordervalues, no phrases.<br /> |-<br /> |hideup (since 3.1.1) <br /> |Defaults to &quot;0&quot;. If set to &quot;1&quot; this hides the &quot;up to parent&quot; link (often you want to hide this on .include files)<br /> |-<br /> |render_fn<br /> |Name of a function to render this groupings list of items. For an example, see views_render_items_example.pl<br /> |}</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6159 2008-07-03T09:23:51Z

<p>Tajoli: </p> <hr /> <div>{{development}}<br /> <br /> Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br /> <br /> There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository. <br /> Instead with this link you can read a [http://wiki.eprints.org/w/Views.pl complete list of all options] avaible for views.<br /> <br /> __TOC__<br /> <br /> ===The basics===<br /> <br /> The views for your repository are defined in the views configuration file:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br /> <br /> Open this file and find the browse_views configuration setting:<br /> <br /> $c-&gt;{browse_views} = [<br /> {<br /> id =&gt; &quot;year&quot;,<br /> fields =&gt; &quot;-date;res=year&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;subjects&quot;,<br /> fields =&gt; &quot;subjects&quot;,<br /> ...<br /> },<br /> ];<br /> <br /> The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br /> <br /> The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br /> <br /> Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br /> <br /> It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br /> <br /> ===Worked example: browse by organisational structure===<br /> <br /> By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br /> <br /> Open the views configuration file:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br /> <br /> Add the following definition to the browse_views setting:<br /> <br /> $c-&gt;{browse_views} = [<br /> {<br /> id =&gt; &quot;year&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;subjects&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;divisions&quot;,<br /> fields =&gt; &quot;divisions&quot;,<br /> order =&gt; &quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> ];<br /> <br /> Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br /> <br /> bin/generate_views ARCHIVEID --verbose<br /> <br /> Open the view page in a Web browser:<br /> <br /> http://your.repository.url/view/<br /> <br /> The view page lists all the available views. You should see your new views on the list:<br /> <br /> [[Image:View_page2.png|frame|none|The view page lists available views]]<br /> <br /> '''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br /> <br /> [&quot;viewname_eprint_divisions&quot; not defined]<br /> <br /> Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br /> <br /> Edit the language-specific phrases file for view names:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br /> <br /> Add an appropriate phrase which describes the new view, for example:<br /> <br /> &lt;epp:phrase id=&quot;viewname_eprint_divisions&quot;&gt;Division&lt;/epp:phrase&gt;<br /> <br /> Save the phrases file and regenerate the view pages:<br /> <br /> bin/generate_views ARCHIVEID --verbose<br /> <br /> ===Example view definitions===<br /> <br /> ====Browse by type====<br /> <br /> Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br /> <br /> {<br /> id =&gt; &quot;types&quot;,<br /> fields =&gt; &quot;type&quot;,<br /> order =&gt; &quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> <br /> ====Browse by author====<br /> <br /> ===Example views (combined fields)===<br /> <br /> ====Browse by author and editor====<br /> <br /> ===Example views (multiple fields)===<br /> <br /> ====Browse by journal title, then by volume====<br /> <br /> This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br /> <br /> {<br /> id=&gt;&quot;journal_volume&quot;,<br /> fields=&gt;&quot;publication,volume&quot;,<br /> order=&gt;&quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> <br /> [[Image:Browse_by_journal.png|border]]<br /> <br /> [[Image:Browse_by_journal_volume.png|border]]<br /> <br /> <br /> <br /> ===Linking in your view===<br /> <br /> You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br /> <br /> [[Image:Browse_by_navbar.png]]<br /> <br /> ====Generating CVs etc====<br /> <br /> ===Linking items back to views===<br /> ===Views as collections===<br /> <br /> <br /> ===New options in EPrints 3.1===<br /> <br /> ====subfield no longer supported====<br /> <br /> The subfield option is no longer supported in EPrints 3.1.<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> =====reverse=====<br /> <br /> 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.<br /> <br /> =====filename=====<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> =====first_value=====<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> =====first_initial=====<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> =====first_letter=====<br /> <br /> The same as 'truncate=1'<br /> <br /> =====truncate=====<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> =====tags=====<br /> <br /> 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.<br /> <br /> =====cloud=====<br /> <br /> 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.<br /> <br /> =====cloudmax=====<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> =====cloudmin=====<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> =====jump=====<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> =====no_seperator (sic)=====<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> =====string=====<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6158 2008-07-03T09:19:50Z

<p>Tajoli: /* Option avaible for the views config */</p> <hr /> <div>== Option avaible for the views config ==<br /> This link is an [http://wiki.eprints.org/w/Adding_new_views 'How to' about views] with examples.<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> <br /> * '''reverse'''<br /> <br /> 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.<br /> <br /> <br /> * '''filename'''<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> <br /> * '''first_value'''<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> <br /> * '''first_initial'''<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> <br /> * '''first_letter'''<br /> <br /> The same as 'truncate=1'<br /> <br /> <br /> * '''truncate'''<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> <br /> * '''tags'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloud'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloudmax'''<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> <br /> * '''cloudmin'''<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> <br /> * '''jump'''<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> <br /> * '''no_seperator (sic)'''<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> <br /> * '''string'''<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6157 2008-07-03T09:18:29Z

<p>Tajoli: /* Option avaible for the views config */</p> <hr /> <div>== Option avaible for the views config ==<br /> If you want to read an [[http://wiki.eprints.org/w/Adding_new_views how to about views]] follow the link.<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> <br /> * '''reverse'''<br /> <br /> 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.<br /> <br /> <br /> * '''filename'''<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> <br /> * '''first_value'''<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> <br /> * '''first_initial'''<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> <br /> * '''first_letter'''<br /> <br /> The same as 'truncate=1'<br /> <br /> <br /> * '''truncate'''<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> <br /> * '''tags'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloud'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloudmax'''<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> <br /> * '''cloudmin'''<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> <br /> * '''jump'''<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> <br /> * '''no_seperator (sic)'''<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> <br /> * '''string'''<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6156 2008-07-03T09:16:18Z

<p>Tajoli: /* Option avaible for the views config */</p> <hr /> <div>== Option avaible for the views config ==<br /> [[http://wiki.eprints.org/w/Adding_new_views]]<br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> <br /> * '''reverse'''<br /> <br /> 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.<br /> <br /> <br /> * '''filename'''<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> <br /> * '''first_value'''<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> <br /> * '''first_initial'''<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> <br /> * '''first_letter'''<br /> <br /> The same as 'truncate=1'<br /> <br /> <br /> * '''truncate'''<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> <br /> * '''tags'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloud'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloudmax'''<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> <br /> * '''cloudmin'''<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> <br /> * '''jump'''<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> <br /> * '''no_seperator (sic)'''<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> <br /> * '''string'''<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6155 2008-07-03T09:02:00Z

<p>Tajoli: /* variations */</p> <hr /> <div>== Option avaible for the views config ==<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> <br /> * '''reverse'''<br /> <br /> 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.<br /> <br /> <br /> * '''filename'''<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> <br /> * '''first_value'''<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> <br /> * '''first_initial'''<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> <br /> * '''first_letter'''<br /> <br /> The same as 'truncate=1'<br /> <br /> <br /> * '''truncate'''<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> <br /> * '''tags'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloud'''<br /> <br /> 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.<br /> <br /> <br /> * '''cloudmax'''<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> <br /> * '''cloudmin'''<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> <br /> * '''jump'''<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> <br /> * '''no_seperator (sic)'''<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> <br /> * '''string'''<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6154 2008-07-03T08:59:05Z

<p>Tajoli: /* variations */</p> <hr /> <div>== Option avaible for the views config ==<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> * '''reverse'''<br /> <br /> 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.<br /> <br /> * '''filename'''<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> * '''first_value'''<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> * '''first_initial'''<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> ======first_letter======<br /> <br /> The same as 'truncate=1'<br /> <br /> ======truncate======<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> ======tags======<br /> <br /> 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.<br /> <br /> ======cloud======<br /> <br /> 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.<br /> <br /> ======cloudmax======<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> ======cloudmin======<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> ======jump======<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> ======no_seperator (sic)======<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> ======string======<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6153 2008-07-03T08:58:20Z

<p>Tajoli: /* variations */</p> <hr /> <div>== Option avaible for the views config ==<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> ** '''reverse'''<br /> <br /> 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.<br /> <br /> ** '''filename'''<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> ======first_value======<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> ======first_initial======<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> ======first_letter======<br /> <br /> The same as 'truncate=1'<br /> <br /> ======truncate======<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> ======tags======<br /> <br /> 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.<br /> <br /> ======cloud======<br /> <br /> 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.<br /> <br /> ======cloudmax======<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> ======cloudmin======<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> ======jump======<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> ======no_seperator (sic)======<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> ======string======<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6152 2008-07-03T08:56:31Z

<p>Tajoli: /* variations */</p> <hr /> <div>== Option avaible for the views config ==<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> '''reverse'''<br /> <br /> 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.<br /> <br /> ======filename======<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> ======first_value======<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> ======first_initial======<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> ======first_letter======<br /> <br /> The same as 'truncate=1'<br /> <br /> ======truncate======<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> ======tags======<br /> <br /> 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.<br /> <br /> ======cloud======<br /> <br /> 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.<br /> <br /> ======cloudmax======<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> ======cloudmin======<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> ======jump======<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> ======no_seperator (sic)======<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> ======string======<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6151 2008-07-03T08:55:51Z

<p>Tajoli: /* variations */</p> <hr /> <div>{{development}}<br /> <br /> Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br /> <br /> There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository.<br /> <br /> __TOC__<br /> <br /> ===The basics===<br /> <br /> The views for your repository are defined in the views configuration file:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br /> <br /> Open this file and find the browse_views configuration setting:<br /> <br /> $c-&gt;{browse_views} = [<br /> {<br /> id =&gt; &quot;year&quot;,<br /> fields =&gt; &quot;-date;res=year&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;subjects&quot;,<br /> fields =&gt; &quot;subjects&quot;,<br /> ...<br /> },<br /> ];<br /> <br /> The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br /> <br /> The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br /> <br /> Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br /> <br /> It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br /> <br /> ===Worked example: browse by organisational structure===<br /> <br /> By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br /> <br /> Open the views configuration file:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br /> <br /> Add the following definition to the browse_views setting:<br /> <br /> $c-&gt;{browse_views} = [<br /> {<br /> id =&gt; &quot;year&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;subjects&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;divisions&quot;,<br /> fields =&gt; &quot;divisions&quot;,<br /> order =&gt; &quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> ];<br /> <br /> Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br /> <br /> bin/generate_views ARCHIVEID --verbose<br /> <br /> Open the view page in a Web browser:<br /> <br /> http://your.repository.url/view/<br /> <br /> The view page lists all the available views. You should see your new views on the list:<br /> <br /> [[Image:View_page2.png|frame|none|The view page lists available views]]<br /> <br /> '''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br /> <br /> [&quot;viewname_eprint_divisions&quot; not defined]<br /> <br /> Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br /> <br /> Edit the language-specific phrases file for view names:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br /> <br /> Add an appropriate phrase which describes the new view, for example:<br /> <br /> &lt;epp:phrase id=&quot;viewname_eprint_divisions&quot;&gt;Division&lt;/epp:phrase&gt;<br /> <br /> Save the phrases file and regenerate the view pages:<br /> <br /> bin/generate_views ARCHIVEID --verbose<br /> <br /> ===Example view definitions===<br /> <br /> ====Browse by type====<br /> <br /> Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br /> <br /> {<br /> id =&gt; &quot;types&quot;,<br /> fields =&gt; &quot;type&quot;,<br /> order =&gt; &quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> <br /> ====Browse by author====<br /> <br /> ===Example views (combined fields)===<br /> <br /> ====Browse by author and editor====<br /> <br /> ===Example views (multiple fields)===<br /> <br /> ====Browse by journal title, then by volume====<br /> <br /> This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br /> <br /> {<br /> id=&gt;&quot;journal_volume&quot;,<br /> fields=&gt;&quot;publication,volume&quot;,<br /> order=&gt;&quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> <br /> [[Image:Browse_by_journal.png|border]]<br /> <br /> [[Image:Browse_by_journal_volume.png|border]]<br /> <br /> <br /> <br /> ===Linking in your view===<br /> <br /> You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br /> <br /> [[Image:Browse_by_navbar.png]]<br /> <br /> ====Generating CVs etc====<br /> <br /> ===Linking items back to views===<br /> ===Views as collections===<br /> <br /> <br /> ===New options in EPrints 3.1===<br /> <br /> ====subfield no longer supported====<br /> <br /> The subfield option is no longer supported in EPrints 3.1.<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> =====reverse=====<br /> <br /> 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.<br /> <br /> =====filename=====<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> =====first_value=====<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> =====first_initial=====<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> =====first_letter=====<br /> <br /> The same as 'truncate=1'<br /> <br /> =====truncate=====<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> =====tags=====<br /> <br /> 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.<br /> <br /> =====cloud=====<br /> <br /> 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.<br /> <br /> =====cloudmax=====<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> =====cloudmin=====<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> =====jump=====<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> =====no_seperator (sic)=====<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> =====string=====<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6150 2008-07-03T08:54:51Z

<p>Tajoli: </p> <hr /> <div>{{development}}<br /> <br /> Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br /> <br /> There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository.<br /> <br /> __TOC__<br /> <br /> ===The basics===<br /> <br /> The views for your repository are defined in the views configuration file:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br /> <br /> Open this file and find the browse_views configuration setting:<br /> <br /> $c-&gt;{browse_views} = [<br /> {<br /> id =&gt; &quot;year&quot;,<br /> fields =&gt; &quot;-date;res=year&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;subjects&quot;,<br /> fields =&gt; &quot;subjects&quot;,<br /> ...<br /> },<br /> ];<br /> <br /> The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br /> <br /> The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br /> <br /> Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br /> <br /> It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br /> <br /> ===Worked example: browse by organisational structure===<br /> <br /> By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br /> <br /> Open the views configuration file:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br /> <br /> Add the following definition to the browse_views setting:<br /> <br /> $c-&gt;{browse_views} = [<br /> {<br /> id =&gt; &quot;year&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;subjects&quot;,<br /> ...<br /> },<br /> {<br /> id =&gt; &quot;divisions&quot;,<br /> fields =&gt; &quot;divisions&quot;,<br /> order =&gt; &quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> ];<br /> <br /> Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br /> <br /> bin/generate_views ARCHIVEID --verbose<br /> <br /> Open the view page in a Web browser:<br /> <br /> http://your.repository.url/view/<br /> <br /> The view page lists all the available views. You should see your new views on the list:<br /> <br /> [[Image:View_page2.png|frame|none|The view page lists available views]]<br /> <br /> '''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br /> <br /> [&quot;viewname_eprint_divisions&quot; not defined]<br /> <br /> Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br /> <br /> Edit the language-specific phrases file for view names:<br /> <br /> /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br /> <br /> Add an appropriate phrase which describes the new view, for example:<br /> <br /> &lt;epp:phrase id=&quot;viewname_eprint_divisions&quot;&gt;Division&lt;/epp:phrase&gt;<br /> <br /> Save the phrases file and regenerate the view pages:<br /> <br /> bin/generate_views ARCHIVEID --verbose<br /> <br /> ===Example view definitions===<br /> <br /> ====Browse by type====<br /> <br /> Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br /> <br /> {<br /> id =&gt; &quot;types&quot;,<br /> fields =&gt; &quot;type&quot;,<br /> order =&gt; &quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> <br /> ====Browse by author====<br /> <br /> ===Example views (combined fields)===<br /> <br /> ====Browse by author and editor====<br /> <br /> ===Example views (multiple fields)===<br /> <br /> ====Browse by journal title, then by volume====<br /> <br /> This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br /> <br /> {<br /> id=&gt;&quot;journal_volume&quot;,<br /> fields=&gt;&quot;publication,volume&quot;,<br /> order=&gt;&quot;-date/title&quot;,<br /> hideempty =&gt; 1,<br /> },<br /> <br /> [[Image:Browse_by_journal.png|border]]<br /> <br /> [[Image:Browse_by_journal_volume.png|border]]<br /> <br /> <br /> <br /> ===Linking in your view===<br /> <br /> You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br /> <br /> [[Image:Browse_by_navbar.png]]<br /> <br /> ====Generating CVs etc====<br /> <br /> ===Linking items back to views===<br /> ===Views as collections===<br /> <br /> <br /> ===New options in EPrints 3.1===<br /> <br /> ====subfield no longer supported====<br /> <br /> The subfield option is no longer supported in EPrints 3.1.<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> '''reverse'''<br /> <br /> 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.<br /> <br /> =====filename=====<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> =====first_value=====<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> =====first_initial=====<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> =====first_letter=====<br /> <br /> The same as 'truncate=1'<br /> <br /> =====truncate=====<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> =====tags=====<br /> <br /> 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.<br /> <br /> =====cloud=====<br /> <br /> 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.<br /> <br /> =====cloudmax=====<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> =====cloudmin=====<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> =====jump=====<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> =====no_seperator (sic)=====<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> =====string=====<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6149 2008-07-03T08:53:53Z

<p>Tajoli: </p> <hr /> <div>== Option avaible for the views config ==<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> '''======reverse======'''<br /> <br /> 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.<br /> <br /> ======filename======<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> ======first_value======<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> ======first_initial======<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> ======first_letter======<br /> <br /> The same as 'truncate=1'<br /> <br /> ======truncate======<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> ======tags======<br /> <br /> 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.<br /> <br /> ======cloud======<br /> <br /> 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.<br /> <br /> ======cloudmax======<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> ======cloudmin======<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> ======jump======<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> ======no_seperator (sic)======<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> ======string======<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6148 2008-07-03T08:51:52Z

<p>Tajoli: </p> <hr /> <div>== Option avaible for the views config ==<br /> <br /> ===Basic===<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> ======reverse======<br /> <br /> 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.<br /> <br /> ======filename======<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> ======first_value======<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> ======first_initial======<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> ======first_letter======<br /> <br /> The same as 'truncate=1'<br /> <br /> ======truncate======<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> =====tags=====<br /> <br /> 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.<br /> <br /> =====cloud=====<br /> <br /> 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.<br /> <br /> =====cloudmax=====<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> =====cloudmin=====<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> =====jump=====<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> =====no_seperator (sic)=====<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> =====string=====<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6147 2008-07-03T08:50:09Z

<p>Tajoli: /* Option avaible for the views config */</p> <hr /> <div>== Option avaible for the views config ==<br /> <br /> ===Basic==<br /> <br /> ====id (mandatory)====<br /> <br /> ====fields (mandatory)====<br /> <br /> ====order====<br /> <br /> ===Standard===<br /> <br /> ====allow_null====<br /> <br /> ====hideempty:====<br /> <br /> ====heading_level====<br /> <br /> ====include====<br /> <br /> ====subheadings====<br /> <br /> ===Extra feature===<br /> <br /> ====citation====<br /> <br /> ====nocount====<br /> <br /> ====nohtml====<br /> <br /> ====noindex====<br /> <br /> ====nolink====<br /> <br /> ===New features===<br /> <br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> =====reverse=====<br /> <br /> 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.<br /> <br /> =====filename=====<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> =====first_value=====<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> =====first_initial=====<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> =====first_letter=====<br /> <br /> The same as 'truncate=1'<br /> <br /> =====truncate=====<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> =====tags=====<br /> <br /> 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.<br /> <br /> =====cloud=====<br /> <br /> 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.<br /> <br /> =====cloudmax=====<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> =====cloudmin=====<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> =====jump=====<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> =====no_seperator (sic)=====<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> =====string=====<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6146 2008-07-03T08:46:46Z

<p>Tajoli: /* Option avaible for the views config */</p> <hr /> <div>== Option avaible for the views config ==<br /> ''Basic''<br /> id (mandatory) :<br /> fields (mandatory):<br /> order:<br /> <br /> ''Standard''<br /> allow_null:<br /> hideempty:<br /> heading_level:<br /> include:<br /> subheadings:<br /> <br /> ''Extra feature''<br /> citation:<br /> nocount:<br /> nohtml:<br /> noindex:<br /> nolink:<br /> <br /> ''New features''<br /> ====new_column_at====<br /> <br /> This is an array of integers representing the number of items in a view list before another column is added. For example:<br /> <br /> [ 10 ]<br /> <br /> This would have one column of values until there were 11, then there would be 2 columns.<br /> <br /> [ 10, 10 ]<br /> <br /> 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.<br /> <br /> [ 0, 0 ]<br /> <br /> This would always have three columns.<br /> <br /> 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.<br /> <br /> ====variations====<br /> <br /> This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br /> <br /> variations =&gt; [<br /> &quot;creators_name;first_letter&quot;,<br /> &quot;type&quot;,<br /> &quot;DEFAULT&quot;<br /> ],<br /> <br /> The following options are available:<br /> <br /> =====reverse=====<br /> <br /> 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.<br /> <br /> =====filename=====<br /> <br /> 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.<br /> <br /> filename=different_filename<br /> <br /> =====first_value=====<br /> <br /> If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br /> <br /> =====first_initial=====<br /> <br /> If using a name, truncate the given name to the first initial. This will make items like &quot;Les Carr&quot; and &quot;Leslie Carr&quot; appear together. Note it will also make &quot;John Smith&quot; and &quot;Jake Smith&quot; appear together too, showing that you really never can win.<br /> <br /> =====first_letter=====<br /> <br /> The same as 'truncate=1'<br /> <br /> =====truncate=====<br /> <br /> 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.<br /> <br /> truncate=4<br /> <br /> =====tags=====<br /> <br /> 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.<br /> <br /> =====cloud=====<br /> <br /> 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.<br /> <br /> =====cloudmax=====<br /> <br /> The % size of the largest tag in a tag cloud.<br /> <br /> =====cloudmin=====<br /> <br /> The % size of the smallest tag in a tag cloud.<br /> <br /> =====jump=====<br /> <br /> jump=plain<br /> <br /> Turns of the 'jump to' text before the list of subheading navigation links.<br /> <br /> =====no_seperator (sic)=====<br /> <br /> Turns of the separator between each subheading navigation link (by default '|').<br /> <br /> =====string=====<br /> <br /> Uses values 'as is'. No ordervalues, no phrases.</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Views.pl&diff=6145 2008-07-03T08:20:59Z

<p>Tajoli: New page: == Option avaible for the views config == ''Basic'' id (mandatory) : fields (mandatory): order: ''Standard'' allow_null: hideempty: heading_level: include: subheadings: ''Extra feature''...</p> <hr /> <div>== Option avaible for the views config ==<br /> ''Basic''<br /> id (mandatory) :<br /> fields (mandatory):<br /> order:<br /> <br /> ''Standard''<br /> allow_null:<br /> hideempty:<br /> heading_level:<br /> include:<br /> subheadings:<br /> <br /> ''Extra feature''<br /> noindex<br /> nolink<br /> nohtml<br /> citation<br /> nocount</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Talk:History&diff=5140 2007-08-22T14:37:52Z

<p>Tajoli: </p> <hr /> <div></div>

Tajoli https://wiki.eprints.org/w/index.php?title=Talk:Migration&diff=5137 2007-08-22T14:35:58Z

<p>Tajoli: </p> <hr /> <div></div>

Tajoli https://wiki.eprints.org/w/index.php?title=Talk:Float_field&diff=5134 2007-08-22T14:33:37Z

<p>Tajoli: </p> <hr /> <div></div>

Tajoli https://wiki.eprints.org/w/index.php?title=Float_field&diff=5133 2007-08-22T14:32:37Z

<p>Tajoli: </p> <hr /> <div>{{fieldtypes}}<br /> __NOTOC__<br /> == Inheritance ==<br /> <br /> * [[Metadata]]<br /> ** [[Float field]]<br /> <br /> == Description ==<br /> <br /> Stores a floating point number (may be negative). In 3.0 there is no way to search these values. They might as well be just strings, but they are stored as FLOAT in the database. <br /> <br /> This field is used for the latitude and longitude built in fields in [[User Object]]s and [[EPrint Object]]s.<br /> <br /> The usefulness of this field will be expanded in later versions of EPrints.<br /> <br /> == Properties ==<br /> <br /> No extra properties.<br /> <br /> == Required Phrases ==<br /> <br /> None.<br /> <br /> == Database ==<br /> <br /> Float fields are stored in the database as<br /> <br /> fieldname FLOAT</div>

Tajoli https://wiki.eprints.org/w/index.php?title=IRRA&diff=5129 2007-08-22T14:25:07Z

<p>Tajoli: </p> <hr /> <div>{{IRRA}}<br /> IRRA is a JISC project investigating and developing IR infrastructure for EPrints and DSpace to enable Research Assessment (specifically for the UK Research Assessment Exercise 2008).<br /> The project, which is running from June 2005 to May 2006, is joint between Southampton</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Adding_a_Field_to_a_Live_Repository&diff=4458 2007-06-19T12:05:16Z

<p>Tajoli: </p> <hr /> <div>To add a field to a live eprints archive you have to modify the SQL tables.<br /> <br /> Before you start this you may wish to BackupTheDatabase.<br /> <br /> This assumes you are adding a field to the &quot;eprint&quot; fields, not the &quot;user&quot; fields. If you are changing &quot;user&quot; then anywhere we have 4 actions, one for each of buffer, deletion, archive and inbox, you instead need a single action for &quot;users&quot;.<br /> <br /> Adding fields of type &quot;name&quot; is beyond the scope of these instructions.<br /> <br /> == Recipe (for Eprints 2.x)== <br /> <br /> === Step 1 - Shut down apache === <br /> Shut down the web server. You don't want people using it while you make this change.<br /> <br /> === Step 2 - Add configuration ===<br /> Add the configuration for this field to MetadataFieldsConfig.pm - take note of which field you add this new field after. (from now on I'll refer to the previous field as ''prevfield''. <br /> <br /> === Step 3 - Add fields to database ===<br /> <br /> Find out the SQL type of the field you are adding. <br /> <br /> boolean<br /> :: '''SET('TRUE','FALSE')'''<br /> date<br /> :: '''DATE'''<br /> year, int<br /> :: '''INTEGER'''<br /> longtext<br /> :: '''TEXT'''<br /> subject,set,url,email,pagerange,text<br /> :: '''VARCHAR(255)'''<br /> <br /> Note that if the field is type multiple then this step is different.<br /> <br /> For both steps the following replacements must be applied to the MySQL code given:<br /> <br /> * Replace ''type'' with the SQL type appropriate to the field you are adding. <br /> * Replace ''newfieldname'' with the name of the field you're adding<br /> * Replace ''prevfield'' with the name of the (non-multiple) field proceeding the field you are adding. If prevfield is a multiple then use the first non-multiple field proceeding your new field. (not used for multiple fields)<br /> <br /> ''Now only do step 3a or 3b depending if this field is multiple or not''<br /> <br /> ==== Step 3a - Adding a normal field ====<br /> <br /> In the database (log into CommandLineMySQL) do the following:<br /> <br /> <br /> If this is confusing see the example at the end of the page. <br /> <br /> <br /> ALTER TABLE archive ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE buffer ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE inbox ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE deletion ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> <br /> ==== Step 3b - Adding a &quot;multiple&quot; field ====<br /> <br /> Multiple fields need their own table, so the syntax is different.<br /> <br /> Please note that these commands have been split over multiple lines for readability.<br /> <br /> CREATE TABLE archive_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE buffer_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE inbox_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE deletion_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> === Step 4 - Modify the ordervalues tables ===<br /> <br /> The ordervalues table is used to store a &quot;dumbed down&quot; version of the value in your field used for sorting, but never rendered.<br /> <br /> The same replacement values apply as for step 3 with one difference. The ''prevfield'' is the previous field in ArchiveMetadataFieldsConfig.pm even if it is a multiple field.<br /> <br /> Notes:<br /> * there are two underline characters before &quot;ordervalues&quot;.<br /> * this assumes you are not running a multilanguage or non-english archive. If you ''are'' then repeat the 4 commands below and replace 'en' with each of your archive's languages in turn.<br /> <br /> ALTER TABLE archive__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE buffer__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE inbox__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE deletion__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> <br /> === Step 5 - Checking it works... ===<br /> <br /> It should all be OK at this point, but it's worth checking. I suggest running generate_views on the archive to make sure it all works OK.<br /> <br /> === Step 6 - Finishing up ===<br /> <br /> Add the config to metadata-types.xml and phrases.xml - see AddingFields<br /> <br /> === Step 7 - Restart apache ===<br /> <br /> Everything should now be OK. restart the webserver<br /> <br /> ----<br /> <br /> == Examples (for Eprints 2.x) ==<br /> <br /> <br /> === Normal set field example ===<br /> To add a field of type 'set' to eprints. We add this to ArchveMetadataFieldsConfig.pm<br /> <br /> { name =&gt; &quot;foo&quot;, type =&gt; &quot;set&quot;, input_rows =&gt; 1,<br /> options =&gt; [ &quot;yesod&quot;, &quot;hod&quot;, &quot;chesed&quot; ] },<br /> <br /> The previous field is a (non-multiple) text field called 'bar')<br /> <br /> then run the following SQL statements:<br /> <br /> ALTER TABLE archive ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE buffer ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE inbox ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE deletion ADD foo VARCHAR(255) default NULL AFTER bar;<br /> <br /> ALTER TABLE archive__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE buffer__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE inbox__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE deletion__ordervalues_en ADD foo TEXT AFTER bar;<br /> <br /> <br /> <br /> == Recipe (for Eprints 3.x) ==<br /> <br /> == Examples (for Eprints 3.x) ==</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Adding_a_Field_to_a_Live_Repository&diff=4457 2007-06-19T12:03:40Z

<p>Tajoli: /* Recipe */</p> <hr /> <div>'''For Eprints 2.x'''<br /> <br /> To add a field to a live eprints archive you have to modify the SQL tables.<br /> <br /> Before you start this you may wish to BackupTheDatabase.<br /> <br /> This assumes you are adding a field to the &quot;eprint&quot; fields, not the &quot;user&quot; fields. If you are changing &quot;user&quot; then anywhere we have 4 actions, one for each of buffer, deletion, archive and inbox, you instead need a single action for &quot;users&quot;.<br /> <br /> Adding fields of type &quot;name&quot; is beyond the scope of these instructions.<br /> <br /> == Recipe (for Eprints 2.x)== <br /> <br /> === Step 1 - Shut down apache === <br /> Shut down the web server. You don't want people using it while you make this change.<br /> <br /> === Step 2 - Add configuration ===<br /> Add the configuration for this field to MetadataFieldsConfig.pm - take note of which field you add this new field after. (from now on I'll refer to the previous field as ''prevfield''. <br /> <br /> === Step 3 - Add fields to database ===<br /> <br /> Find out the SQL type of the field you are adding. <br /> <br /> boolean<br /> :: '''SET('TRUE','FALSE')'''<br /> date<br /> :: '''DATE'''<br /> year, int<br /> :: '''INTEGER'''<br /> longtext<br /> :: '''TEXT'''<br /> subject,set,url,email,pagerange,text<br /> :: '''VARCHAR(255)'''<br /> <br /> Note that if the field is type multiple then this step is different.<br /> <br /> For both steps the following replacements must be applied to the MySQL code given:<br /> <br /> * Replace ''type'' with the SQL type appropriate to the field you are adding. <br /> * Replace ''newfieldname'' with the name of the field you're adding<br /> * Replace ''prevfield'' with the name of the (non-multiple) field proceeding the field you are adding. If prevfield is a multiple then use the first non-multiple field proceeding your new field. (not used for multiple fields)<br /> <br /> ''Now only do step 3a or 3b depending if this field is multiple or not''<br /> <br /> ==== Step 3a - Adding a normal field ====<br /> <br /> In the database (log into CommandLineMySQL) do the following:<br /> <br /> <br /> If this is confusing see the example at the end of the page. <br /> <br /> <br /> ALTER TABLE archive ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE buffer ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE inbox ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE deletion ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> <br /> ==== Step 3b - Adding a &quot;multiple&quot; field ====<br /> <br /> Multiple fields need their own table, so the syntax is different.<br /> <br /> Please note that these commands have been split over multiple lines for readability.<br /> <br /> CREATE TABLE archive_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE buffer_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE inbox_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE deletion_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> === Step 4 - Modify the ordervalues tables ===<br /> <br /> The ordervalues table is used to store a &quot;dumbed down&quot; version of the value in your field used for sorting, but never rendered.<br /> <br /> The same replacement values apply as for step 3 with one difference. The ''prevfield'' is the previous field in ArchiveMetadataFieldsConfig.pm even if it is a multiple field.<br /> <br /> Notes:<br /> * there are two underline characters before &quot;ordervalues&quot;.<br /> * this assumes you are not running a multilanguage or non-english archive. If you ''are'' then repeat the 4 commands below and replace 'en' with each of your archive's languages in turn.<br /> <br /> ALTER TABLE archive__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE buffer__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE inbox__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE deletion__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> <br /> === Step 5 - Checking it works... ===<br /> <br /> It should all be OK at this point, but it's worth checking. I suggest running generate_views on the archive to make sure it all works OK.<br /> <br /> === Step 6 - Finishing up ===<br /> <br /> Add the config to metadata-types.xml and phrases.xml - see AddingFields<br /> <br /> === Step 7 - Restart apache ===<br /> <br /> Everything should now be OK. restart the webserver<br /> <br /> ----<br /> <br /> == Examples ==<br /> <br /> <br /> === Normal set field example ===<br /> To add a field of type 'set' to eprints. We add this to ArchveMetadataFieldsConfig.pm<br /> <br /> { name =&gt; &quot;foo&quot;, type =&gt; &quot;set&quot;, input_rows =&gt; 1,<br /> options =&gt; [ &quot;yesod&quot;, &quot;hod&quot;, &quot;chesed&quot; ] },<br /> <br /> The previous field is a (non-multiple) text field called 'bar')<br /> <br /> then run the following SQL statements:<br /> <br /> ALTER TABLE archive ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE buffer ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE inbox ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE deletion ADD foo VARCHAR(255) default NULL AFTER bar;<br /> <br /> ALTER TABLE archive__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE buffer__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE inbox__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE deletion__ordervalues_en ADD foo TEXT AFTER bar;</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Adding_a_Field_to_a_Live_Repository&diff=4456 2007-06-19T12:03:04Z

<p>Tajoli: </p> <hr /> <div>'''For Eprints 2.x'''<br /> <br /> To add a field to a live eprints archive you have to modify the SQL tables.<br /> <br /> Before you start this you may wish to BackupTheDatabase.<br /> <br /> This assumes you are adding a field to the &quot;eprint&quot; fields, not the &quot;user&quot; fields. If you are changing &quot;user&quot; then anywhere we have 4 actions, one for each of buffer, deletion, archive and inbox, you instead need a single action for &quot;users&quot;.<br /> <br /> Adding fields of type &quot;name&quot; is beyond the scope of these instructions.<br /> <br /> == Recipe == <br /> <br /> === Step 1 - Shut down apache === <br /> Shut down the web server. You don't want people using it while you make this change.<br /> <br /> === Step 2 - Add configuration ===<br /> Add the configuration for this field to MetadataFieldsConfig.pm - take note of which field you add this new field after. (from now on I'll refer to the previous field as ''prevfield''. <br /> <br /> === Step 3 - Add fields to database ===<br /> <br /> Find out the SQL type of the field you are adding. <br /> <br /> boolean<br /> :: '''SET('TRUE','FALSE')'''<br /> date<br /> :: '''DATE'''<br /> year, int<br /> :: '''INTEGER'''<br /> longtext<br /> :: '''TEXT'''<br /> subject,set,url,email,pagerange,text<br /> :: '''VARCHAR(255)'''<br /> <br /> Note that if the field is type multiple then this step is different.<br /> <br /> For both steps the following replacements must be applied to the MySQL code given:<br /> <br /> * Replace ''type'' with the SQL type appropriate to the field you are adding. <br /> * Replace ''newfieldname'' with the name of the field you're adding<br /> * Replace ''prevfield'' with the name of the (non-multiple) field proceeding the field you are adding. If prevfield is a multiple then use the first non-multiple field proceeding your new field. (not used for multiple fields)<br /> <br /> ''Now only do step 3a or 3b depending if this field is multiple or not''<br /> <br /> ==== Step 3a - Adding a normal field ====<br /> <br /> In the database (log into CommandLineMySQL) do the following:<br /> <br /> <br /> If this is confusing see the example at the end of the page. <br /> <br /> <br /> ALTER TABLE archive ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE buffer ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE inbox ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE deletion ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> <br /> ==== Step 3b - Adding a &quot;multiple&quot; field ====<br /> <br /> Multiple fields need their own table, so the syntax is different.<br /> <br /> Please note that these commands have been split over multiple lines for readability.<br /> <br /> CREATE TABLE archive_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE buffer_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE inbox_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE deletion_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> === Step 4 - Modify the ordervalues tables ===<br /> <br /> The ordervalues table is used to store a &quot;dumbed down&quot; version of the value in your field used for sorting, but never rendered.<br /> <br /> The same replacement values apply as for step 3 with one difference. The ''prevfield'' is the previous field in ArchiveMetadataFieldsConfig.pm even if it is a multiple field.<br /> <br /> Notes:<br /> * there are two underline characters before &quot;ordervalues&quot;.<br /> * this assumes you are not running a multilanguage or non-english archive. If you ''are'' then repeat the 4 commands below and replace 'en' with each of your archive's languages in turn.<br /> <br /> ALTER TABLE archive__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE buffer__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE inbox__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE deletion__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> <br /> === Step 5 - Checking it works... ===<br /> <br /> It should all be OK at this point, but it's worth checking. I suggest running generate_views on the archive to make sure it all works OK.<br /> <br /> === Step 6 - Finishing up ===<br /> <br /> Add the config to metadata-types.xml and phrases.xml - see AddingFields<br /> <br /> === Step 7 - Restart apache ===<br /> <br /> Everything should now be OK. restart the webserver<br /> <br /> ----<br /> <br /> == Examples ==<br /> <br /> <br /> === Normal set field example ===<br /> To add a field of type 'set' to eprints. We add this to ArchveMetadataFieldsConfig.pm<br /> <br /> { name =&gt; &quot;foo&quot;, type =&gt; &quot;set&quot;, input_rows =&gt; 1,<br /> options =&gt; [ &quot;yesod&quot;, &quot;hod&quot;, &quot;chesed&quot; ] },<br /> <br /> The previous field is a (non-multiple) text field called 'bar')<br /> <br /> then run the following SQL statements:<br /> <br /> ALTER TABLE archive ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE buffer ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE inbox ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE deletion ADD foo VARCHAR(255) default NULL AFTER bar;<br /> <br /> ALTER TABLE archive__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE buffer__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE inbox__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE deletion__ordervalues_en ADD foo TEXT AFTER bar;</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Adding_a_Field_to_a_Live_Repository&diff=4455 2007-06-19T12:02:40Z

<p>Tajoli: </p> <hr /> <div>'''For Eprints 2.x'''<br /> To add a field to a live eprints archive you have to modify the SQL tables.<br /> <br /> Before you start this you may wish to BackupTheDatabase.<br /> <br /> This assumes you are adding a field to the &quot;eprint&quot; fields, not the &quot;user&quot; fields. If you are changing &quot;user&quot; then anywhere we have 4 actions, one for each of buffer, deletion, archive and inbox, you instead need a single action for &quot;users&quot;.<br /> <br /> Adding fields of type &quot;name&quot; is beyond the scope of these instructions.<br /> <br /> == Recipe == <br /> <br /> === Step 1 - Shut down apache === <br /> Shut down the web server. You don't want people using it while you make this change.<br /> <br /> === Step 2 - Add configuration ===<br /> Add the configuration for this field to MetadataFieldsConfig.pm - take note of which field you add this new field after. (from now on I'll refer to the previous field as ''prevfield''. <br /> <br /> === Step 3 - Add fields to database ===<br /> <br /> Find out the SQL type of the field you are adding. <br /> <br /> boolean<br /> :: '''SET('TRUE','FALSE')'''<br /> date<br /> :: '''DATE'''<br /> year, int<br /> :: '''INTEGER'''<br /> longtext<br /> :: '''TEXT'''<br /> subject,set,url,email,pagerange,text<br /> :: '''VARCHAR(255)'''<br /> <br /> Note that if the field is type multiple then this step is different.<br /> <br /> For both steps the following replacements must be applied to the MySQL code given:<br /> <br /> * Replace ''type'' with the SQL type appropriate to the field you are adding. <br /> * Replace ''newfieldname'' with the name of the field you're adding<br /> * Replace ''prevfield'' with the name of the (non-multiple) field proceeding the field you are adding. If prevfield is a multiple then use the first non-multiple field proceeding your new field. (not used for multiple fields)<br /> <br /> ''Now only do step 3a or 3b depending if this field is multiple or not''<br /> <br /> ==== Step 3a - Adding a normal field ====<br /> <br /> In the database (log into CommandLineMySQL) do the following:<br /> <br /> <br /> If this is confusing see the example at the end of the page. <br /> <br /> <br /> ALTER TABLE archive ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE buffer ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE inbox ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> ALTER TABLE deletion ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';<br /> <br /> ==== Step 3b - Adding a &quot;multiple&quot; field ====<br /> <br /> Multiple fields need their own table, so the syntax is different.<br /> <br /> Please note that these commands have been split over multiple lines for readability.<br /> <br /> CREATE TABLE archive_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE buffer_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE inbox_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> CREATE TABLE deletion_''newfieldname'' ( eprintid INT NOT NULL, pos INT, <br /> ''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) ); <br /> <br /> === Step 4 - Modify the ordervalues tables ===<br /> <br /> The ordervalues table is used to store a &quot;dumbed down&quot; version of the value in your field used for sorting, but never rendered.<br /> <br /> The same replacement values apply as for step 3 with one difference. The ''prevfield'' is the previous field in ArchiveMetadataFieldsConfig.pm even if it is a multiple field.<br /> <br /> Notes:<br /> * there are two underline characters before &quot;ordervalues&quot;.<br /> * this assumes you are not running a multilanguage or non-english archive. If you ''are'' then repeat the 4 commands below and replace 'en' with each of your archive's languages in turn.<br /> <br /> ALTER TABLE archive__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE buffer__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE inbox__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> ALTER TABLE deletion__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';<br /> <br /> === Step 5 - Checking it works... ===<br /> <br /> It should all be OK at this point, but it's worth checking. I suggest running generate_views on the archive to make sure it all works OK.<br /> <br /> === Step 6 - Finishing up ===<br /> <br /> Add the config to metadata-types.xml and phrases.xml - see AddingFields<br /> <br /> === Step 7 - Restart apache ===<br /> <br /> Everything should now be OK. restart the webserver<br /> <br /> ----<br /> <br /> == Examples ==<br /> <br /> <br /> === Normal set field example ===<br /> To add a field of type 'set' to eprints. We add this to ArchveMetadataFieldsConfig.pm<br /> <br /> { name =&gt; &quot;foo&quot;, type =&gt; &quot;set&quot;, input_rows =&gt; 1,<br /> options =&gt; [ &quot;yesod&quot;, &quot;hod&quot;, &quot;chesed&quot; ] },<br /> <br /> The previous field is a (non-multiple) text field called 'bar')<br /> <br /> then run the following SQL statements:<br /> <br /> ALTER TABLE archive ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE buffer ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE inbox ADD foo VARCHAR(255) default NULL AFTER bar;<br /> ALTER TABLE deletion ADD foo VARCHAR(255) default NULL AFTER bar;<br /> <br /> ALTER TABLE archive__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE buffer__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE inbox__ordervalues_en ADD foo TEXT AFTER bar;<br /> ALTER TABLE deletion__ordervalues_en ADD foo TEXT AFTER bar;</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Main_Page&diff=2316 2006-09-27T08:03:22Z

<p>Tajoli: /* Scripts, patches and translations */</p> <hr /> <div>'''Welcome to the EPrints Wiki'''<br /> <br /> The content of this site is technical only. For more information on the EPrints project, visit http://eprints.org/<br /> <br /> ''We are currently in the process of moving information from the [http://wiki2.eprints.org Old Wiki].''<br /> <br /> ==Documentation==<br /> <br /> * [[EPrints Manual|EPrints 3]] The manual for the next release of EPrints is being developed here.<br /> * [http://www.eprints.org/documentation/tech/php/intro.php EPrints 2 and older Versions] The manual for older versions of EPrints are available on the main site.<br /> * [[Frequently Asked Questions]]<br /> * [[Web Services]] - sneak peek at the upcoming Web Service API<br /> <br /> ==Scripts, patches and translations==<br /> <br /> * '''EPrints on EPrints''' - the [http://files.eprints.org/ EPrints Files] repository is the place to share scripts, patches and translations. This is also the place where releases of EPrints itself will be archived.<br /> * [[Files/]] Wiki pages about scripts and patches. There isn't a page for every script or patch.<br /> * [[Translating EPrints]] into your language.<br /> * [[How to contribute]]<br /> <br /> ==Tips, tricks and howtos==<br /> <br /> * [[Installing]] EPrints on various platforms or in non-standard ways<br /> * Howto..<br /> ** [[Integrating EPrints with LDAP|integrate with LDAP]] - authenticate users with LDAP/Active Directory server<br /> ** [[CAS|integrate with CAS]] - integrate EPrints with an enterprise single sign-on service<br /> ** Secure EPrints with [[HTTPS]]<br /> ** Add a [[RequestEprint|Request eprint from author]] button (to non-OA records)<br /> ** [[Customizing_RSS_Output|customize RSS output]] - show an institution's or person's last n publications<br /> ** [[Howtos|more..]]<br /> <br /> ==Contributing==<br /> <br /> * [[Wiki Guidelines]]<br /> * [[Wiki Todo List]]<br /> * [[EPrints:Migration to files.eprints.org]]<br /> <br /> ==Getting Support==<br /> <br /> * [http://www.eprints.org/services/ EPrints Services] - premium support and training from EPrints experts<br /> * [http://www.eprints.org/software/ Mailing Lists]<br /> <br /> ==EPrints Projects==<br /> <br /> * [[IRRA]] - Supporting the UK research assessment processes through institutional repositories</div>

Tajoli https://wiki.eprints.org/w/index.php?title=Main_Page&diff=2315 2006-09-27T08:01:57Z

<p>Tajoli: </p> <hr /> <div>'''Welcome to the EPrints Wiki'''<br /> <br /> The content of this site is technical only. For more information on the EPrints project, visit http://eprints.org/<br /> <br /> ''We are currently in the process of moving information from the [http://wiki2.eprints.org Old Wiki].''<br /> <br /> ==Documentation==<br /> <br /> * [[EPrints Manual|EPrints 3]] The manual for the next release of EPrints is being developed here.<br /> * [http://www.eprints.org/documentation/tech/php/intro.php EPrints 2 and older Versions] The manual for older versions of EPrints are available on the main site.<br /> * [[Frequently Asked Questions]]<br /> * [[Web Services]] - sneak peek at the upcoming Web Service API<br /> <br /> ==Scripts, patches and translations==<br /> <br /> * '''EPrints on EPrints''' - the [http://files.eprints.org/ EPrints Files] repository is the place to share scripts, patches and translations. This is also the place where releases of EPrints itself will be archived.<br /> * [[Files]] Wiki pages about scripts and patches. There isn't a page for every script or patch.<br /> * [[Translating EPrints]] into your language.<br /> * [[How to contribute]]<br /> <br /> ==Tips, tricks and howtos==<br /> <br /> * [[Installing]] EPrints on various platforms or in non-standard ways<br /> * Howto..<br /> ** [[Integrating EPrints with LDAP|integrate with LDAP]] - authenticate users with LDAP/Active Directory server<br /> ** [[CAS|integrate with CAS]] - integrate EPrints with an enterprise single sign-on service<br /> ** Secure EPrints with [[HTTPS]]<br /> ** Add a [[RequestEprint|Request eprint from author]] button (to non-OA records)<br /> ** [[Customizing_RSS_Output|customize RSS output]] - show an institution's or person's last n publications<br /> ** [[Howtos|more..]]<br /> <br /> ==Contributing==<br /> <br /> * [[Wiki Guidelines]]<br /> * [[Wiki Todo List]]<br /> * [[EPrints:Migration to files.eprints.org]]<br /> <br /> ==Getting Support==<br /> <br /> * [http://www.eprints.org/services/ EPrints Services] - premium support and training from EPrints experts<br /> * [http://www.eprints.org/software/ Mailing Lists]<br /> <br /> ==EPrints Projects==<br /> <br /> * [[IRRA]] - Supporting the UK research assessment processes through institutional repositories</div>

Tajoli