Limiting names shown - Revision history

Drn@ecs.soton.ac.uk at 00:34, 6 March 2022

2022-03-06T00:34:18Z

Drn@ecs.soton.ac.uk at 16:30, 4 February 2022

2022-02-04T16:30:06Z

Drn@ecs.soton.ac.uk: Updated instructions to be more detailed and relevant to latest 3.4 and include help about rendering so et al is a link.

2021-08-27T13:17:19Z

Updated instructions to be more detailed and relevant to latest 3.4 and include help about rendering so et al is a link.

Drn@ecs.soton.ac.uk at 19:38, 25 August 2021

2021-08-25T19:38:35Z

Drn@ecs.soton.ac.uk at 19:37, 25 August 2021

2021-08-25T19:37:32Z

Drn@ecs.soton.ac.uk: Added limiting names page from serviceswiki

2021-08-25T19:28:37Z

Added limiting names page from serviceswiki

Th.lauke@arcor.de: link to github's commit added

2020-12-21T16:06:21Z

link to github's commit added

Drn@ecs.soton.ac.uk: Added placeholder page

2018-09-19T10:04:31Z

Added placeholder page

New page

=== To Be Written ===
This page will contain information on how citations can be made to limit the number of authors shown but be expandable with a single click.

@@ Line 22: / Line 22: @@
-. Refresh abstract pages.  Either by clicking the '''Refresh Abstracts''' button in the '''Config. Tools'' tab of the '''Admin''' page or by running the following command as the '''eprints''' user (substituting ''''EPRINTS_PATH''' and '''ARCHIVE_NAME''' appropriately):
+. Refresh abstract pages.  Either by clicking the '''Refresh Abstracts''' button in the '''Config. Tools'' tab of the '''Admin''' page or by running the following command as the '''eprints''' user (substituting ''''EPRINTS_PATH''' and '''ARCHIVEID''' appropriately):
-  EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVE_NAME
+  EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVEID
@@ Line 31: / Line 31: @@
-If you want to use limited names citations for search results and browse views, then you will need to make similar changes to ''cfg/citations/eprint/default.xml'' and ''cfg/citations/eprint/result.xml'''.  Like for updating abstract pages, you will need to click '''Refresh Views''' button in the '''Config. Tools'' tab of the '''Admin''' page or by running the following command as the '''eprints''' user (substituting ''''EPRINTS_PATH''' and '''ARCHIVE_NAME''' appropriately):
+If you want to use limited names citations for search results and browse views, then you will need to make similar changes to ''cfg/citations/eprint/default.xml'' and ''cfg/citations/eprint/result.xml'''.  Like for updating abstract pages, you will need to click '''Refresh Views''' button in the '''Config. Tools'' tab of the '''Admin''' page or by running the following command as the '''eprints''' user (substituting ''''EPRINTS_PATH''' and '''ARCHIVEID''' appropriately):
-  EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVE_NAME
+  EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVEID
 If you have updated either browse view or search result citations, you will also need to reload the webserver (see step 6 above).
 If you want to update all citations, then technically you need only modify (like described in step 3) the ''cfg/citations/eprint/result.xml''' and ''cfg/citations/eprint/default.xml''' (and ''cfg/citations/eprint/default_for_summary_page.xml''') citation files and need not create a '''cfg/citations/eprint/display.xml''' nor modify '''cfg/citations/eprint/summary_page.xml''' (steps 2 and 4).  However, you will still need to run refresh abstracts, refresh views and reload the webserver.

← Older revision		Revision as of 16:30, 4 February 2022
Line 1:		Line 1:
−	Although all names should be shown for exports, sometimes an EPrint has so many creators or editors it is really not useful to display then all without user prompting. Therefore, a render function (in '''lib/cfg.d/limit_names_shown.pl''') has been written for '''EPrints 3.4.2+''' to allow some names to be hidden and then displayed when a link on "et al" is clicked. Below describes how you can make good use of the render function:	+	Although all names should be shown for exports, sometimes an EPrint has so many creators or editors it is really not useful to display then all without user prompting. Therefore, a render function (in '''lib/cfg.d/[[limit_names_shown.pl]]''') has been written for '''EPrints 3.4.2+''' to allow some names to be hidden and then displayed when a link on "et al" is clicked. Below describes how you can make good use of the render function:

@@ Line 9: / Line 9: @@
           render_value => 'limit_names_shown',
           render_limit => 10,
   },
-. Reload the webserver, using the appropriate command for your particular Linux operating system.  E.g.
   root@redhat> apachectl graceful
   root@ubuntu> apache2ctl graceful

← Older revision		Revision as of 19:38, 25 August 2021
Line 18:		Line 18:


−	4. Edit your archive's '''cfg/citations/eprint/summary_page.xml''' and '''cfg/citations/eprint/result.xml''' replace '''item.citation('default')''' with '''item.citation('display')'''. (N.B. you may need to modify other citation styles if they have been created for your archive). If the '''summary_page.xml''' and '''result.xml''' do not already exists in you archive, you need to copy these from '''flavours/pub_lib/citations/eprint/''' to you archive and then edit these files ~~there~~.	+	4. Edit your archive's '''cfg/citations/eprint/summary_page.xml''' and '''cfg/citations/eprint/result.xml''' replace '''item.citation('default')''' with '''item.citation('display')'''. (N.B. you may need to modify other citation styles if they have been created for your archive). If the '''summary_page.xml''' and '''result.xml''' do not already exists in you archive, you need to copy these from '''flavours/pub_lib/citations/eprint/''' to you archive and then edit these files within the archive's '''cfg/citations/eprint/''' directory.

@@ Line 1: / Line 1: @@
-Although all names should be shown for exports, sometimes an EPrint has so many creators or editors it is really not useful to display then all without user prompting.  Therefore, I have written a render function (in '''site_lib/cfg.d/limit_names_shown.pl''') to allow some names to be hidden and then displayed when a link on "et al" is clicked.  Below describes how you can make good use of the render function:
+Although all names should be shown for exports, sometimes an EPrint has so many creators or editors it is really not useful to display then all without user prompting.  Therefore, a render function (in '''lib/cfg.d/limit_names_shown.pl''') has been written for '''EPrints 3.4.2+''' to allow some names to be hidden and then displayed when a link on "et al" is clicked.  Below describes how you can make good use of the render function:
+. Edit your archive's '''cfg/cfg.d/eprint_fields.pl''' and create a virtual field replica of the name field on which you want to be able to limit authors.  The example bellow will limit the number of creators display to 10 before showing an "et al" so you can display the rest.
+  {
           name => 'creators_name_limited',
@@ Line 14: / Line 12: @@
+. Copy your archive's '''cfg/citations/eprint/default.xml''' to '''cfg/citations/eprint/display.xml'''.
-. Edit display.xml adding '''_limited''' to all the name fields you want to limit the number of names initially displayed.
+. Edit '''cfg/citations/eprint/display.xml''' adding '''_limited''' to all the name fields you want to limit the number of names initially displayed.
-. Edit '''cfg/citations/eprint/summary_page.xml''' and '''cfg/citations/eprint/result.xml''' replace '''item.citation('default')''' with '''item.citation('display')'''.  (N.B. you may need to modify other citation styles if they have been created for your archive).
+. Edit your archive's '''cfg/citations/eprint/summary_page.xml''' and '''cfg/citations/eprint/result.xml''' replace '''item.citation('default')''' with '''item.citation('display')'''.  (N.B. you may need to modify other citation styles if they have been created for your archive).  If the '''summary_page.xml''' and '''result.xml''' do not already exists in you archive, you need to copy these from '''flavours/pub_lib/citations/eprint/''' to you archive and then edit these files there.
-. Reload webserver or reload configuration through the '''Admin''' page's '''Config. Tools''' tab.
+. Reload the webserver, using the appropriate command for your particular Linux operating system.  E.g.

← Older revision		Revision as of 19:28, 25 August 2021
Line 1:		Line 1:
−	~~=== To Be Written ===~~	+	Although all names should be shown for exports, sometimes an EPrint has so many creators or editors it is really not useful to display then all without user prompting. Therefore, I have written a render function (in '''site_lib/cfg.d/limit_names_shown.pl''') to allow some names to be hidden and then displayed when a link on "et al" is clicked. Below describes how you can make good use of the render function:
−	~~This page will contain information on how citations can~~ be ~~made~~ to ~~limit the number of authors shown but~~ be ~~expandable with~~ a ~~single click~~.

−	In the ~~meantime look at [https:~~//~~github~~.~~com~~/~~eprints~~/~~eprints3~~.4/~~commit~~/~~10b90d2a1cb3ede4ae6dc1dc62d9f6524c1b626a commit@github]~~	+	1. Make sure that '''site_lib''' is update to date with SVN.
		+
		+
		+	2. Edit your archive's '''cfg/cfg.d/eprint_fields.pl''' and create a virtual field replica of the name field on which you want to be able to limit authors. The example bellow will limit the number of creators display to 10 before showing an "et al" so you can display the rest.
		+	{
		+	name => 'creators_name_limited',
		+	type => 'name',
		+	virtual => 1,
		+	render_value => 'limit_names_shown',
		+	render_limit => 10,
		+	},
		+
		+
		+
		+	3. Copy your archives '''cfg/citations/eprint/default.xml''' to '''cfg/citations/eprint/display.xml'''.
		+
		+
		+	4. Edit display.xml adding '''_limited''' to all the name fields you want to limit the number of names initially displayed.
		+
		+
		+	5. Edit '''cfg/citations/eprint/summary_page.xml''' and '''cfg/citations/eprint/result.xml''' replace '''item.citation('default')''' with '''item.citation('display')'''. (N.B. you may need to modify other citation styles if they have been created for your archive).
		+
		+
		+	6. Reload webserver or reload configuration through the '''Admin''' page's '''Config. Tools''' tab.

← Older revision		Revision as of 16:06, 21 December 2020
Line 1:		Line 1:
	=== To Be Written ===		=== To Be Written ===
	This page will contain information on how citations can be made to limit the number of authors shown but be expandable with a single click.		This page will contain information on how citations can be made to limit the number of authors shown but be expandable with a single click.
		+
		+	In the meantime look at [https://github.com/eprints/eprints3.4/commit/10b90d2a1cb3ede4ae6dc1dc62d9f6524c1b626a commit@github]