•  
Main
About Hippo Portal
Documentation
Community
Other

Portal project structure

This is the basic file structure of a project based on Hippo Portal:

File or folder Contains
<src>
    <conf> Hippo Portal specific run-time properties and Spring Configuration
        hippo-portal.properties Contains properties used in Spring configurations, such as /src/conf/hippo-portal.xml and /src/webapp/WEB-INF/assembly/hippo-portal.xml
        hippo-portal.xml Spring configuration for core Hippo Portal components.
    <sql> Portal database initialization scripts
    <webapp> The root of the webapp
        <decorations> Jetspeed portlet and layout decorations . The hp:create-portal-project maven goal generates a default, generic layout decorator 'default' which can be used as a basis for further customization.
        <WEB-INF>
            <assembly> default Jetspeed Spring configuration
                <override> Spring configuration that overrides the default Spring configuration. We recommend you use this folder, if you want to change/extend core Jetspeed components. However, in most cases you don't have to.
            <conf> Jetspeed configuration files. Use override.properties to override Jetspeed's default configuration.
            <pages> PSML files. Go to Adding Pages to find out more about how these files are used in Hippo Portal.
            <templates> Velocity scripts that generate the structure of the layout fragment. The hp:create-portal-project maven goal created a default template 'fixed-layout', which is a generic script that delegates to Velocity scripts in the decoration. See also Adding Pages .
core-build.xml Contains dependencies required by Jetspeed. This file is required, and shouldn't be changed!
full-portal.xml Contains Jetspeed dependencies. This file is required, and shouldn't be changed!
hippo-portal-components.xml Contains dependencies required by Hippo Portal and contains dependencies to Hippo components, such as Hippo Portal and Hippo Repository adapter. This file is required, and shouldn't be changed!
jetspeed-components.xml Contains Jetspeed dependencies. This file is required, and shouldn't be changed!
project.properties Contains properties used during building and deploying the project. The properties defined in this file are all commented.
project.xml The top POM of the project. Add your custom project dependencies here. Make sure that project.xml is extended by hippo-portal-components.xml. This file is required, and shouldn't be changed!
project-info.xml Contains the project info for your project. Optionally fill in information like project description, info about developers, etc.