...
It is possible to add simple static pages to DSpace using Manakin. This is useful for adding "one-shot" pages like About and FAQs where creating a new aspect would be overkill. There are three ways to add a static page:
1. (Pre broken in 1.8.0) XSL-based method. You can override the main body template and then add a check for the url of the page you want to add. The current page's url is always present in the DRI pageMeta section as request.URI. If the current page url is one you designated for your static page, then instead of rendering the body of the DRI page normally, you can have XSL insert different content. This content can either be placed in the code of the XSL template or imported from an external source using the document() function. This method is useful if the number of extra pages you want to include is relatively small and they are not edited frequently. You can access the page via www.example.com/xmlui/page/about
...
Create the java file which will add the DRI
[dspace-src]/dspace-xmlui/dspace-xmlui-api/src/main/java/org/dspace/app/xmlui/aspect/artifactbrowser/AboutPage.java
| Code Block |
|---|
/**
* AboutPage.java
*
* Basead on the code by Peter Dietz:
* https://gist.github.com/842301#file_dspace_add_about.diff (acessed 11-05-23)
*
* Modified to work with internationalization (i18n locales) and breadcrumbs
* by Andre Nito Assada e Josi Perez Alvarez on 11-05-23
*/
package org.dspace.app.xmlui.aspect.artifactbrowser;
import org.apache.log4j.Logger;
import org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer;
import org.dspace.app.xmlui.wing.WingException;
import org.dspace.app.xmlui.wing.element.Body;
import org.dspace.app.xmlui.wing.element.Division;
import org.dspace.app.xmlui.wing.element.PageMeta;
import org.xml.sax.SAXException;
import java.io.IOException;
import java.io.Serializable;
import java.sql.SQLException;
import org.apache.cocoon.caching.CacheableProcessingComponent;
import org.apache.excalibur.source.SourceValidity;
import org.apache.excalibur.source.impl.validity.NOPValidity;
import org.dspace.app.xmlui.utils.UIException;
import org.dspace.app.xmlui.wing.Message;
import org.dspace.authorize.AuthorizeException;
/**
* Display about us page.
*
* @author Peter Dietz
*/
public class AboutPage extends AbstractDSpaceTransformer
{
/**
* Internationalization
* 110523
*/
public static final Message T_dspace_home =
message("xmlui.general.dspace_home");
public static final Message T_title =
message("xmlui.ArtifactBrowser.AboutPage.title");
public static final Message T_trail =
message("xmlui.ArtifactBrowser.AboutPage.trail");
public static final Message T_head =
message("xmlui.ArtifactBrowser.AboutPage.head");
public static final Message T_para =
message("xmlui.ArtifactBrowser.AboutPage.para");
private static Logger log = Logger.getLogger(AboutPage.class);
/**
* Add a page title and trail links.
*/
public void addPageMeta(PageMeta pageMeta) throws SAXException, WingException {
// Set the page title
// pageMeta.addMetadata("title").addContent("About Us");
// 110523 modified page title with internationalization and added breadcrumbs
pageMeta.addMetadata("title").addContent(T_title);
// add trail
pageMeta.addTrailLink(contextPath + "/",T_dspace_home);
pageMeta.addTrail().addContent(T_trail);
}
/**
* Add some basic contents
*/
public void addBody(Body body) throws SAXException, WingException {
//Division division = body.addDivision("about-page", "primary");
//Division.setHead("About Us - Institutional Repository");
//Division.addPara("We are an institutional repository that specializes in storing your digital artifacts.");
//110523 modified with internationalization
Division division = body.addDivision("about-page", "primary");
division.setHead(T_head);
division.addPara(T_para);
}
}
|
Then map it on
[dspace-src]/dspace-xmlui/dspace-xmlui-api/src/main/resources/aspects/BrowseArtifacts/sitemap.xmap
under the tags:
| Code Block |
|---|
<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0">
<map:components>
<map:transformers>
|
we add:
| Code Block |
|---|
<map:transformer name="AboutPage" src="org.dspace.app.xmlui.aspect.artifactbrowser.AboutPage" />
|
and under the tags:
| Code Block |
|---|
<map:pipelines>
<map:pipeline>
|
We add:
| Code Block |
|---|
<map:match pattern="about">
<map:transform type="AboutPage"/>
<map:serialize type="xml" />
</map:match>
|
...
Now we override the <dri:body> of our theme to fit the calls for this aspect. On the Mirage theme one should edit [dspace-src]/dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/themes/Mirage/Mirage.xsl
and on the standard theme, one should edit the dri2xhtml.xsl
| Code Block |
|---|
<xsl:template match="dri:body">
<xsl:variable name="meta" select="/dri:document/dri:meta/dri:pageMeta/dri:metadata"/>
<xsl:variable name="pageName" select="$meta[@element='request'][@qualifier='URI']"/>
<xsl:variable name="doc" select="document(concat('pages/', $pageName, '.xhtml'))"/>
<div id="ds-body">
<!-- when conditional to handle the call for {dspace-webhost}/about -->
<xsl:choose>
<xsl:when test="/dri:document/dri:meta/dri:pageMeta/dri:metadata[@element='request'][@qualifier='URI']='about'">
<div>
<h1>This is a simple ABOUT page</h1>
<xsl:apply-templates />
</div>
</xsl:when>
[ e t c . . . ]
|
Now one must create a link calling for this page, eg. on the side menus under <xsl:template match="dri:options">
| Code Block |
|---|
<div id="ds-search-option" class="ds-option-set">
<a>
<xsl:attribute name="href">
<!-- isso pegara o context, neste caso http://143.107.73.153:8080/xmlui/ -->
<xsl:value-of select="/dri:document/dri:meta/dri:pageMeta/dri:metadata[@element='contextPath'][not(@qualifier)]"/>
<!-- e entao concatenando teremos context/contact -->
<xsl:text>/about</xsl:text>
</xsl:attribute>
<!-- e aqui o label descritivo -->
<i18n:text>xmlui.dri2xhtml.structural.static.about</i18n:text>
</a><br/>
|
...
To customize the Page Title:
| Code Block |
|---|
<title>
<xsl:choose>
<xsl:when test="starts-with($request-uri, 'page/about')">
<xsl:text>About This Repository</xsl:text>
</xsl:when>
...
</title>
|
To customize the breadcrumb / trail:
| Code Block |
|---|
<ul id="ds-trail">
<xsl:choose>
<xsl:when test="starts-with($request-uri, 'page/about')">
<xsl:text>About This Repository</xsl:text>
</xsl:when>
...
</xsl:choose>
</ul>
|
To customize the body:
| Code Block |
|---|
<xsl:template match="dri:body">
<div id="ds-body">
...
<xsl:choose>
<xsl:when test="starts-with($request-uri, 'page/about')">
<div>
<h1>About This Repository</h1>
<p>To add your own content to this page, edit webapps/xmlui/themes/dri2xhtml/structural.xsl and add your own content to the title, trail, and body.
....
</p>
</div>
</xsl:when>
<xsl:otherwise>
<xsl:apply-templates />
</xsl:otherwise>
</xsl:choose>
...
</div>
</xsl:template>
|
...