Difference between revisions of "API:bin/generate abstracts"
(remove self category) |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- Pod2Wiki=_preamble_ | <!-- Pod2Wiki=_preamble_ | ||
| − | This page has been automatically generated from the EPrints 3. | + | This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. |
| − | -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_abstracts.pm|package_name=bin/generate_abstracts}}[[Category:API | + | -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_abstracts.pm|package_name=bin/generate_abstracts}}[[Category:API|BIN/GENERATE_ABSTRACTS]]<div><!-- Edit below this comment --> |
| Line 17: | Line 17: | ||
<!-- Pod2Wiki=head_synopsis --> | <!-- Pod2Wiki=head_synopsis --> | ||
==SYNOPSIS== | ==SYNOPSIS== | ||
| − | '''generate_abstracts''' <em>repository_id</em> ['''options'''] [<em> | + | '''generate_abstracts''' <em>repository_id</em> ['''options'''] [<em>eprint_id</em>, <em>eprint_id</em>, <em>eprint_id</em>-<em>eprint_id</em> ...] |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 29: | Line 29: | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
This script recreates every static abstract page for an eprints repository. To save load on the database, as archived data should not change, EPrints creates static webpages containing the summary of each eprint. If you change the way the abstracts are rendered or change the site template then you will want to run this script. | This script recreates every static abstract page for an eprints repository. To save load on the database, as archived data should not change, EPrints creates static webpages containing the summary of each eprint. If you change the way the abstracts are rendered or change the site template then you will want to run this script. | ||
| + | |||
| + | To only recreate static abstract pages for certain eprint IDs provide a space separated list of eprint ID integer values. To recreate a tranche of consecutive eprint static abstract pages, use a hyphen between integer values, (e.g. 10-20). | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 58: | Line 60: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_b_eprint_id --> |
| − | ===''' | + | ==='''eprint_id''' === |
| − | |||
| − | |||
| + | An optional integer indicating that the static abstract page for eprint record <em>eprint_id</em> should be updated. Multiple <em>eprint_id</em> integer values may be provided to regenerate a set of static abstract pages for the specified eprints. To recreate a tranche of consecutive eprint static abstracts pages use a hyphen between integer values, (e.g. 10-20). | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 107: | Line 108: | ||
==='''--quiet'''=== | ==='''--quiet'''=== | ||
| − | Be vewwy vewwy quiet. This option will | + | Be vewwy vewwy quiet. This option will suppress all output unless an error occurs. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 133: | Line 134: | ||
Output version information and exit. | Output version information and exit. | ||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=head_copyright --> | ||
| + | ==COPYRIGHT== | ||
| + | {{API:Copyright}} | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
<span style='display:none'>User Comments</span> | <span style='display:none'>User Comments</span> | ||
Latest revision as of 10:41, 6 July 2022
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
generate_abstracts - Regenerate all the static abstract pages for an EPrint repository
SYNOPSIS
generate_abstracts repository_id [options] [eprint_id, eprint_id, eprint_id-eprint_id ...]
DESCRIPTION
This script recreates every static abstract page for an eprints repository. To save load on the database, as archived data should not change, EPrints creates static webpages containing the summary of each eprint. If you change the way the abstracts are rendered or change the site template then you will want to run this script.
To only recreate static abstract pages for certain eprint IDs provide a space separated list of eprint ID integer values. To recreate a tranche of consecutive eprint static abstract pages, use a hyphen between integer values, (e.g. 10-20).
ARGUMENTS
repository_id
The ID of the eprint repository to use.
eprint_id
An optional integer indicating that the static abstract page for eprint record eprint_id should be updated. Multiple eprint_id integer values may be provided to regenerate a set of static abstract pages for the specified eprints. To recreate a tranche of consecutive eprint static abstracts pages use a hyphen between integer values, (e.g. 10-20).
OPTIONS
--help
Print a brief help message and exit.
--man
Print the full manual page and then exit.
--quiet
Be vewwy vewwy quiet. This option will suppress all output unless an error occurs.
--verbose
Explain in detail what is going on. May be repeated for greater effect.
--version
Output version information and exit.
COPYRIGHT
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.
