|
|
Roadmap to the localisation tree layout. Localisation allows us to deploy the spp package with various hub-specific configurations. It affects files found under the configuration tree and the portlets tree. With no localisation option set a deployment will just copy (and patch where appropriate) files from these directories. With a localisation option, a deployment will overwrite these defaults with your localised configuration files. This allows you to set up your hub-specific look and feel files, mail server options, search targets, etc. and keep them in CVS alongside the defaults and those of other hubs. It also means you can re-deploy your hub-specific spp installation with one command: e.g. > ant deploy -Dlocalisation=sosig Creating an eclipse task for a localised deploy Follow the instructions for setting up an ant task found on the dev site (docs/Eclipse: getting started). Include this argument in the main tab: '-Dlocalisation=<name of your localisation>' Note that you can also set the default localisation parameter in the build.properties file. How to set up and use a localisation Under the localisation directory create a directory tree under your chosen locale, following the sosig example. The structure should follow the current default configuration and portlets tree layouts. When you deploy with the localisation switch set to this directory, files here will be used to overwrite the default files. If you want to overwrite jetspeed files you can (e.g. navigation templates, etc.). You will need to have some knowledge of where jetspeed keeps its files - see the sosig and demo localisations for some examples. The deployment order is this: - copy default files and apply default patches - copy any localised files and apply localised patches Some more details about the sort of stuff you can localise: ./<locale>/configuration/copy/ - anything here will be copied to the root webapps/spp/ directory ./<locale>/configuration/copy/WEB-INF/ - jetspeed configuration stuff ./<locale>/configuration/copy/WEB-INF/conf/portlets.xreg ./<locale>/configuration/copy/WEB-INF/conf/demo-portlets.xreg - overwrites the default jetspeed portlet lists. At present this just removes most of the supplied examples. ./<locale>/configuration/copy/WEB-INF/psml/user/anon/html/en/default.psml - portlets for guest logged in page ./<locale>/configuration/copy/WEB-INF/psml/user/turbine/html/en/default.psml - portlets for demo turbine user logged in page ./<locale>/configuration/copy/WEB-INF/psml/role/user/html/default.psml - template psml file - copied on new user registration ./<locale>/configuration/copy/WEB-INF/spp/ - spp installation specific data. e.g mailer.properties holds details of mailhosts and xsearch/modes.xml defines which targets are available ./<locale>/configuration/copy/WEB-INF/templates/vm/layouts/html/default.vm - overall screen layout - currently uses config settings to decide whether to display nav bars. The main portlet area is marked by $screen_placeholder ./<locale>/configuration/copy/WEB-INF/templates/vm/navigations/html/ - navigation templates. layouts above determines where these will appear, JetspeedResources.properties below has parameters for switching them on and off. ./<locale>/configuration/patch/WEB-INF/conf/JetspeedResources.properties.ant - patch file for editing the default JetspeedResources.properties settings. See the file that results in your tomcat/webapps/spp/WEB-INF/conf for examples. e.g. switch off left nav bar. ./<locale>/portlets/ - spp installation specific portlet configuration ./<locale>/portlets/spp/configuration/ - edit .xreg files to alter the list of available portlets and skins. ./<locale>/portlets/spp/velocity/spp/ - templates for portlets defined above (e.g. is welcome.vm, used by the SPPWelcome portlet)