Difference between revisions of "How to modify static pages"

From EPrints Documentation
Jump to: navigation, search
(Fix location of templates and non-language specific files)
(Clarify location of template)
 
Line 1: Line 1:
 
[[Category:Static Pages]]
 
[[Category:Static Pages]]
The static web pages are created by combining the .xpage files from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]] with the site template. The template can be found at [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/templates|opt/eprints3/archives/ARCHIVEID/cfg/templates/]]. This is what generate_static does.
+
The static web pages are created by combining the .xpage files from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]] with the site template; this is what generate_static does. A custom site template can be installed at [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|opt/eprints3/archives/ARCHIVEID/cfg/lang/en/templates/]] (if language-specific) or [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/templates|opt/eprints3/archives/ARCHIVEID/cfg/templates/]] (if not); otherwise the default one at [[EPrints_Directory_Structure/eprints3/lib/templates|opt/eprints3/lib/templates/]] will be used.
  
Generate static also copies all files which do not have the suffix .xpage from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]]
+
The generate_static script also copies all files which do not have the suffix .xpage from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]]
  
Non-language specific files go in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|/opt/eprints3/archives/ARCHIVEID/cfg/static/]] directory and appear on the website no matter what language the site is in. eg. images and the style sheet.
+
Non-language specific files go in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|/opt/eprints3/archives/ARCHIVEID/cfg/static/]] directory and appear on the website no matter what language the site is in, e.g. images and the style sheet.
  
Obviously french source files go in cfg/lang/fr/ etc.
+
Obviously cfg/lang/en/ is intended for English language source files; French source files would go in cfg/lang/fr/ and so on.
  
Edit the .xpage file (or other file in /static/)
+
# Edit the .xpage file (or other file in /static/)
 
+
# Run [[Bin/|generate_static]] ARCHIVEID
Run [[Bin/|generate_static]] ARCHIVEID
+
  
 
===Issues===
 
===Issues===

Latest revision as of 10:29, 10 July 2020

The static web pages are created by combining the .xpage files from /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/ with the site template; this is what generate_static does. A custom site template can be installed at opt/eprints3/archives/ARCHIVEID/cfg/lang/en/templates/ (if language-specific) or opt/eprints3/archives/ARCHIVEID/cfg/templates/ (if not); otherwise the default one at opt/eprints3/lib/templates/ will be used.

The generate_static script also copies all files which do not have the suffix .xpage from /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/

Non-language specific files go in the /opt/eprints3/archives/ARCHIVEID/cfg/static/ directory and appear on the website no matter what language the site is in, e.g. images and the style sheet.

Obviously cfg/lang/en/ is intended for English language source files; French source files would go in cfg/lang/fr/ and so on.

  1. Edit the .xpage file (or other file in /static/)
  2. Run generate_static ARCHIVEID

Issues

The XML Editor encodes all extended characters, with the exception of core HTML ones (e.g. <) -- this causes issues with pages that need to include one of these symbols. See https://github.com/eprints/eprints/blob/3.3/perl_lib/EPrints/Plugin/Screen/Admin/Config/Edit/XML.pm#L29

A set of phrases have been created for html entites to be used in static pages and phrases that can be edited through the front-end tools. E.g:

  <p>Nuts <epc:phrase ref='entity_amp'/> bolts</p>

A bazaar package has been created for the following phrases:

  • entity_amp
  • entity_gt
  • entity_lt
  • entity_quot
  • entity_apos

See http://bazaar.eprints.org/471/