Docs Developer Site
Enonic XP
arrow-down
    1. Widgets
    1. ID providers
    2. System ID provider
    3. Users and groups
    4. Roles
    1. Projects
    2. Layers
        1. AttachmentUploader
        2. Checkbox
        3. Combobox
        4. ContentSelector
        5. ContentTypeFilter
        6. CustomSelector
        7. Date
        8. DateTime
        9. Double
        10. GeoPoint
        11. HtmlArea
        12. ImageSelector
        13. Long
        14. MediaSelector
        15. Radiobutton
        16. Tag
        17. TextArea
        18. TextLine
        19. Time
      2. Field set
      3. Item set
      4. Option set
      5. Mixins
      6. Localization
    4. Content Types
    5. X-data
    6. Macros
    7. Custom styles
    8. Sites
      1. Regions
      2. Part component
      3. Layout component
      4. Text component
      5. Fragments
      6. Filtering
      7. Component indexing
      8. Visual editor
    10. Page templates
  4. Applications
    1. Sandboxes
    2. Code
    3. Building
    4. Configuration
    5. TypeScript
      1. Controllers
      2. Globals
      3. HTTP
      4. Events
      5. Error handler
      6. Filters
      7. ID provider
      8. Tasks
      9. Templating
      10. Localization
      11. Websocket
      12. Mappings
      13. Components
      14. Processors
      15. Contributions
      16. Main controller
      17. Java bridge
      1. Admin API
      2. Application API
      3. Auditlog API
      4. Authentication API
      5. Cluster API
      6. Common API
      7. Content API
      8. Context API
      9. Event API
      10. Export API
      11. Grid API
      12. I18N API
      13. IO API
      14. Mail API
      15. Node API
      16. Portal API
      17. Project API
      18. Repo API
      19. Scheduler API
      20. Schema API
      21. Tasks API
      22. Value API
      23. VHost API
      24. Websocket API
      1. Webapp Engine
        1. Image service
        2. Component service
      3. Admin Engine
      4. Asset service
      5. HTTP service
      6. IDprovider service
    2. Task engine
    3. Management Endpoint
    4. Statistics Endpoint
    1. Nodes and repos
    2. Properties
    3. Indexing
    4. Branches
    5. Queries (NoQL)
    6. Queries (DSL)
    7. Filters
    8. Aggregations
    9. Highlighting
    10. Editors
    1. Strategies
    2. Distributions
    3. Docker image
    4. Vhosts
    5. Configuration
    6. Backup & restore
    7. Systemd
    8. Clustering
  9. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps
Developer Docs Xp Stable Cms Sites

Sites

Contents

Sites add support for building building pages, in addition to form-based content.

For a hands on introduction to sites and the concepts described here, visit the My first site tutorial.

Introduction

Sites unlock powerful functionality for managing websites and creating visually oriented content like pages, page templates and fragments.

Similar to content projects, you may add applications to a site. For sites however, purpose-specific applications like sitemap.xml, robots.txt, Google Analytics, SEO Metafields, and Siteimprove introduce features and management capabilities beyond that of basic content.

Site content type

Site is a built-in content type, which means a site can easily be created anywhere in your content structure.

Site content items are special in the way that you may add applications to them. Similar to projects, functionality and schemas from the app will be available in the scope of the site.

Apps added to a project will not apply to a site, unless explicitly added there as well.

The site engine

When rendering sites and pages with the Enonic framework, request handling and resolving is performed by the site engine. It offers site-specific capabilities and request handling such as:

site.xml

Applications declare support for sites by including the site.xml descriptor file.

This descriptor serves multiple purposes:

  • Declares that this app supports sites (and CMS projects)

  • Defines a form that lets you configure the application on a per site (or project) basis

  • Define X-data mappings

  • Define controller and filter mappings.

  • Define response processors.

The descriptor must be placed in your app as: src/main/resources/site/site.xml

Minimal site.xml example 
<site>
  <form/>
</site>
Site.xml with all options in use 
<site>
  <form>  (1)
    <input type="TextLine" name="company">
      <label>Company</label>
      <occurrences minimum="1" maximum="1"/>
    </input>
    <mixin name="address"/>
  </form>
  <x-data name="seo-settings"/>  (2)
  <mappings>  (3)
    <mapping controller="/site/foobar/api.js" order="10">
      <pattern>/api/v\d+/.*</pattern>
    </mapping>
    <mapping controller="/site/pages/default/default.js">
      <match>type:'portal:fragment'</match>
    </mapping>
  </mappings>
  <processors>
    <response-processor name="tracker" order="10"/> (4) (5)
  </processors>
</site>
1 Define a form for this app. The form is used to create site specific configuration for the app.
2 Specify X-data fields to use within the site scope.
3 Controller and filter mappings definitions
4 Commonly used to add page contributions to the response
5 The order is used to decide execution order if multiple applications and processors are added to a single site.

Contents

Contents