Configuration

Configuration manual for PageSeeder

Developer tools

From the  developer perspective, there is a Dev menu option on the right hand side of the horizontal menu. Selecting this option provides developers with access to the following essential tools:

Note

Access to the Developer Tools requires Administrator rights on the PageSeeder Server.

  • Project Files – this page lists all the files used in a specific customization.
  • Document config – all the document types specific available to the current project are listed. The default ones (inherited) can be viewed and the custom ones can be edited. A new document type can also be created.
  • User Interface tools – the current layout customization is detailed in two different pages (the Layout Analyzer and the Layout Tree).
  • Utilities – Headers is a simple page that lists all the header properties available and Styles simply shows all the different styles available in the default CSS.

All these tools are summarized in the Toolbox page.

Project files

All the files that define a customization are listed on this page, using the original hierarchy.

Note

The default Project Files page available from the Dev menu lists the standard perspective files but other perspectives are available through the top filter menu or via the toolbox page.

Each file has various actions available through the icons on the right hand side:

  • For folders, the main actions are create a new folder/document, upload a document and delete.
  • For documents, they are download, show history, rename and delete. Each document can also be moved by simple drag-and-drop movements. Clicking on the document name will also show the document in a new page where it can be edited (if possible). When editing a document, a previous version is stored and can be accessed using the history icon.

dropzone is also available to upload any new document in the customization, the newly uploaded file can then be dragged into the desired directory.

The entire customization can also be exported using the Export button. It will download a ZIP archive containing all the document files. This archive can then be imported back by dropping it on the dropzone and un-archiving it.

Document types

The various document types available in the project are listed in a simple table showing all the possible customizations. A simple version of the table is visible on the toolbox page.

Each custom configuration file can be created or accessed directly from this table. Clicking on the file name will open it in the View Bundle page (see below).

Layout tools

There are two ways to see the layout customizations: the Layout Analyzer and the Layout Tree.

Layout analyzer

This page is useful to ensure that a customization is behaving the expected way. It lists the components (new or overwritten) with their details just the way they are registered in the Layout Manager. If a component is not behaving correctly, a quick check in the Layout Analyzer can show if the customization is correct.

Each available layout can be analyzed using the top menu filter Analyze, including perspectives (i.e.: default.developer). The layout chain is also displayed, this is useful to see the order of inheritance of the components.

The components are listed in three tables below. By using the top menu filter Show, they can be restricted to the ones defined in the layout selected only or to all the components (including the inherited ones).

The components listed in red are the ones that overwrite a default component. For each component, the following options are displayed:

  • Layout – the layout that the component is defined in.
  • URL Pattern – the URLs matching the component.
  • Scope – the scope that the component can be accessed in (Server, Project or Group).
  • Style – If a specific style is defined for the component (either CSS or XSLT).

Layout tree

The layout tree also lists the components of the different layout available but as a tree.

For each component, details are available in the tree. The details include the sub components used (for example the blocks and trees used in a specific page), the permission required, the servlets and generators used (with the parameters) and the scripts.

A search field is also provided to locate a specific component. The matching components will be displayed in the tree in bold.

Bundle view

From the Document Types page and from the Layout Tools, documents can be clicked and they will be viewed in the Bundle View page. This page lists the different files used by the component (XSLT, CSS, Javascript...).

These files can be created, viewed and modified directly on the Bundle View page.

Note

After modifying an XSLT script, the layout needs to be reloaded by clicking the button Reload PageSeeder Cache in the Developer Tools block visible in the Developer perspective or by adding the following parameter to any PageSeeder URL: ?ps-reload=true

Created on , last edited on