API:bin/generate static

From EPrints Documentation
Revision as of 15:27, 16 December 2011 by Tdb01r (Talk | contribs)

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.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

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

User Comments


SYNOPSIS

generate_static repository_id [options]

User Comments


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.


User Comments


.xpage

This is an XML file with the following structure:

<?xml version="1.0" standalone="no" ?>
<!DOCTYPE page SYSTEM "entities.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 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.

User Comments


.xhtml

This is a normal XHTML file but with the following XML header:

<?xml version="1.0" standalone="no" ?>
<!DOCTYPE html SYSTEM "entities.dtd" >
 

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

User Comments


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.

User Comments


ARGUMENTS

User Comments


repository_id

The ID of the eprint repository to use.

User Comments


OPTIONS

User Comments


--prune

Remove stray files from the website (eg. if something was removed from the static pages).

User Comments


--help

Print a brief help message and exit.

User Comments


--man

Print the full manual page and then exit.

User Comments


--quiet

Be vewwy vewwy quiet. This option will supress all output unless an error occurs.

User Comments


--verbose

Explain in detail what is going on. May be repeated for greater effect.

User Comments


--version

Output version information and exit.

User Comments


COPYRIGHT

User Comments