EPrints 2.2 Documentation - generate_static command



NAME

generate_static - Generate static pages of an EPrint archive using the template.


SYNOPSIS

generate_static archiveid [options]


DESCRIPTION

This script creates the static web site for EPrints (or, if you are running in multiple lanugages it generates the websites).

It processes every file in EPRINTS/archives/ARCHIVE/cfg/static/LANGID/. For each language processes all the files in /LANGID/ and /generic/ into EPRINTS/archives/ARCHIVE/html/LANGID. If that sounds confusing, don't worry, it's not that bad, just put your webpage outlines in static/en/ and your image files and the like in static/generic/ and run this script and see what happens.

Most files are copied into the target directory as is and directory structure is preserved.

Files with a .xpage or .xhtml suffix are processed as they are copied.

.xpage
This is an XML file with the following structure:
 <?xml version="1.0" standalone="no" ?>
 <!DOCTYPE page SYSTEM "entities-en.dtd" >
 <page>
   <title>This is the page title</title>
   <body>
     <p>Some XHTML body</p><p>Which is <b>neat</b></p>
   </body>
 </page>

The resulting file will be a .html file (foo.xpage becomes foo.html). It will take the template for this archive and insert the title and body from the appropriate places. It will also cause the the special EPrints entities to be converted as it is copied. See the main documentation.

.xhtml
This is a normal XHTML file but with the following XML header:
 <?xml version="1.0" standalone="no" ?>
 <!DOCTYPE html SYSTEM "entities-en.dtd" >

This will cause the the special EPrints entities to be converted as it is copied. See the main documentation for more about these entities. It will also be renamed to .html for example, foo.xhtml will become foo.html


NOTE FOR THE NON-ENGLISH MAJORITY

If you are running EPrints in a language other than English then place the static files in a directory of your ISO language ID instead of en, for example French is fr. The generic directory is for language neutral stuff. Which is extra handy if you want to run the site in more than one language. Also the entities file should be renamed from -en to -whatever eg. entities-fr.xml.


ARGUMENTS

archiveid
The ID of the eprint archive to use.


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.


AUTHOR

This is part of this EPrints 2 system. EPrints 2 is developed by Christopher Gutteridge.


VERSION

EPrints Version: 2.2.1


CONTACT

For more information goto http://www.eprints.org/ which give information on mailing lists and the like.

Chris Gutteridge may be contacted at support@eprints.org

Should you need a real world address for some reason, EPrints can be contacted in the real world at

 EPrints c/o Christopher Gutteridge
 Department of Electronics and Computer Science
 University of Southampton
 SO17 1BJ
 United Kingdom


COPYRIGHT

This file is part of EPrints 2.

Copyright (c) 2000,2001,2002 University of Southampton, UK. SO17 1BJ.

EPrints 2 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 2 of the License, or (at your option) any later version.

EPrints 2 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 2; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

 EPrints 2.2 Documentation - generate_static command