API:bin/generate sitemap

From EPrints Documentation
Revision as of 13:37, 5 March 2022 by Drn@ecs.soton.ac.uk (talk | contribs) (Added API:bin page for generate_sitemap)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

generate_sitemap - Generates sitemap.xml in standard location for use in Google Search Console and similar tools


SYNOPSIS

generate_sitemap repository_id



DESCRIPTION

This script lists the abstract/summary page URLs for every live publication in the repository as part of a sitemap. The main sitemap links to individual sitemaps containing a maxiumum of 1000 URLs (live publication items). This is preferred for tools like Google Search Console to save individual files getting too large. The main sitemap's filename is sitemap.xml and can be found on the root path of the repository (e.g. http://eprints.example.org/sitemap.xml). sitemap.xml and its child sitemaps (e.g. http://eprints.example.org/sitemaps/1.xml) are presented in XML format using the sitemap schema http://www.sitemaps.org/schemas/sitemap/0.9, setting a weekly change frequency.


ARGUMENTS

repository_id
The ID of the EPrints repository to use.



COPYRIGHT

Copyright 2021 University of Southampton. EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

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/.