Editing API:bin/generate static

<!-- Pod2Wiki=_preamble_ 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_static|package_name=bin/generate_static}}[[Category:API|BIN/GENERATE_STATIC]][[Category:API:bin/generate_static|BIN/GENERATE_STATIC]][[Category:API:bin/generate_static|BIN/GENERATE_STATIC]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''generate_static''' - Generate static pages of an EPrint repository using the template.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_synopsis -->
==SYNOPSIS==
'''generate_static''' <em>repository_id</em> ['''options'''] 

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_description -->
==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.

<pre></pre>

* '''.xpage''' 
: This is an XML file with the following structure:

<pre> &lt;?xml version="1.0" standalone="no" ?&gt;
 &lt;!DOCTYPE page SYSTEM "entities.dtd" &gt;
 &lt;page&gt;
   &lt;title&gt;This is the page title&lt;/title&gt;
   &lt;body&gt;
     &lt;p&gt;Some XHTML body&lt;/p&gt;&lt;p&gt;Which is &lt;b&gt;neat&lt;/b&gt;&lt;/p&gt;
   &lt;/body&gt;
 &lt;/page&gt;</pre>

: The resulting file will be a .html file (foo.xpage becomes foo.html). It will take the template for this repository 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:

<pre> &lt;?xml version="1.0" standalone="no" ?&gt;
 &lt;!DOCTYPE html SYSTEM "entities.dtd" &gt;</pre>

: This will cause the the HTML entities to be properly decoded. It will also be renamed to .html for example, foo.xhtml will become foo.html

<pre></pre>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_note_for_the_non_english_majority -->
==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'''.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_arguments -->
==ARGUMENTS==
* '''repository_id''' 
: The ID of the eprint repository to use.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_options -->
==OPTIONS==
* '''--prune'''
: Remove stray files from the website (eg. if something was removed from the static pages).

* '''--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.

<pre></pre>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->
==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 -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
<!-- Edit below this comment -->