Back to Search Back to Search Results

Portal Theme Pages

The following pages are required for a basic Portal to function properly. All paths are relative to the Portal Theme root.

Most of the following pages are located in the root of the /pages directory, with the exception of the pages contained in the /errors directory. There are no requirements regarding the content of the following files; any one of them could be left blank without causing problems as long as they are not linked to. When rendered, these pages' data-models are supplemented with data structures specifically designed for the purpose connoted by the file's name.

Portal Theme Page URLs

Template File URL Pattern(s) Description
/pages/portal-home.ftl /portalPath/ Portal landing page.
/pages/searchResults.ftl /portalPath/search Search results page.
/pages/viewer.ftl /portalPath/viewer/*, /portalPath/content/* Viewer page for XML content in the context of other documents. For example, a DITA topic in the context of a DITA map, or a chunked section of a non-DITA XML document.
/pages/mapViewer.ftl (deprecated) /portalPath/viewer/*, /portalPath/content/* Viewer page for top-level embeddable content, such as XML, Markdown, and HTML fragments (no root <html> element.
Note: This page is deprecated, and should simply <#include> viwer.ftl. This template may be removed in a future release.
/pages/login.ftl /portalPath/login Login page for LDAP-based authentication.
/pages/assemblyViewer.ftl /portalPath/assembly/assemblyKey/ ToC view page of an assembly.
/pages/assemblyTopicViewer.ftl /portalPath/assembly/assemblyKey/topicId Viewer page for an entry in an assembly.
/pages/assemblyPreview.ftl N/A Template used to render the preview view of a topic in the assembly editor.
/pages/custom/*.ftl /portalPath/pages/* Custom pages.
/pages/error.ftl N/A Page used to present HTTP errors (404, 500, etc.).

In this section:

  1. Portal Landing Page
    This page is defined by the /pages/portal-home.ftl template in the portal theme. The base URL of any portal is the URL path /portalUrlPath/. When navigating to a Portal URL, this page will be rendered.
  2. Search Results Page
    This page is defined by the /pages/searchResults.ftl template in the portal theme. The search results page is meant to show the results of a query, and is bound to the URL path /portalUrlPath/search.
  3. Embeddable Content Viewer Pages
    This page is defined by the /pages/viewer.ftl and /pages/mapViewer.ftl (deprecated) templates in the portal theme. Content that can be embedded in a portal's overall look, such as XML content, Markdown, and some HTML files, are rendered through this template. Other file types are served directly, without a template.
  4. Login Page
    This page is defined by the /pages/login.ftl template in the portal theme. This page is used when a portal uses an LDAP authentication scheme, to gather the username and password for the user.
  5. Assembly Viewer Pages
    These pages is defined by the /pages/assemblyViewer.ftl and /pages/assemblyTopicViewer.ftl templates in the portal theme and are used to display assemblies and their contents.
  6. Assembly Preview Template
    This page is defined by the /pages/assemblyPreview.ftl template in the portal theme. It is used to display topics in the Assembly Editor.
  7. Error Pages
    When the Portal application serves up an HTTP error page - such as when it sends an HTTP 404 response when a piece of content does not exist - the application will dynamically determine which template to use for the error.
  8. Custom Pages
    The /pages/custom folder contains full-page templates that can be used to extend the functionality of a Portal by adding new pages.
Parent topic: Page Templates