Difference between revisions of "API:bin/generate abstracts"
| Line 8: | Line 8: | ||
'''generate_abstracts''' - Regenerate all the static abstract pages for an EPrint repository | '''generate_abstracts''' - Regenerate all the static abstract pages for an EPrint repository | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_synopsis --> | <!-- Pod2Wiki=head_synopsis --> | ||
==SYNOPSIS== | ==SYNOPSIS== | ||
'''generate_abstracts''' <em>repository_id</em> ['''options'''] [<em>eprintid</em>] | '''generate_abstracts''' <em>repository_id</em> ['''options'''] [<em>eprintid</em>] | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_description --> | <!-- Pod2Wiki=head_description --> | ||
==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. | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_arguments --> | <!-- Pod2Wiki=head_arguments --> | ||
==ARGUMENTS== | ==ARGUMENTS== | ||
| − | + | * '''repository_id''' | |
| − | + | : The ID of the eprint repository to use. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The ID of the eprint repository to use. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | An optional integer indicating that only the abstract page for record <em>eprintid</em> should be updated. Handy for testing new configurations. | + | * '''eprintid''' |
| + | : An optional integer indicating that only the abstract page for record <em>eprintid</em> should be updated. Handy for testing new configurations. | ||
| + | <pre></pre> | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_options --> | <!-- Pod2Wiki=head_options --> | ||
==OPTIONS== | ==OPTIONS== | ||
| − | + | * '''--help''' | |
| − | + | : Print a brief help message and exit. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Print a brief help message and exit. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Print the full manual page and then exit. | + | * '''--man''' |
| + | : Print the full manual page and then exit. | ||
| − | + | * '''--quiet''' | |
| − | + | : Be vewwy vewwy quiet. This option will supress 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. | |
| − | |||
| − | |||
| − | + | <pre></pre> | |
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | + | <!-- Pod2Wiki=head_copyright --> | |
| − | <!-- Pod2Wiki= | + | ==COPYRIGHT== |
| − | == | + | Copyright 2000-2011 University of Southampton. |
| − | |||
| − | |||
| − | + | This file is part of EPrints http://www.eprints.org/. | |
| − | |||
| − | |||
| + | EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. | ||
| − | + | EPrints 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 General Public License for more details. | |
| − | |||
| − | |||
| − | |||
| − | + | You should have received a copy of the GNU General Public License along with EPrints. If not, see http://www.gnu.org/licenses/. | |
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | + | <!-- Pod2Wiki=_postamble_ --> | |
| − | <!-- Pod2Wiki= | ||
| − | |||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 09:57, 22 January 2013
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
NAME
generate_abstracts - Regenerate all the static abstract pages for an EPrint repository
SYNOPSIS
generate_abstracts repository_id [options] [eprintid]
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.
ARGUMENTS
- repository_id
- The ID of the eprint repository to use.
- eprintid
- An optional integer indicating that only the abstract page for record eprintid should be updated. Handy for testing new configurations.
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 supress 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-2011 University of Southampton.
This file is part of EPrints http://www.eprints.org/.
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
EPrints 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 General Public License for more details.
You should have received a copy of the GNU General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.
