Project

Key point: A container for groups that share the same configuration.

Configured by administrators, a project is primarily an organizing mechanism for groups. Projects can have one or more subprojects used to create deeper hierarchies.

Project configuration

A project stores the custom settings for the groups it contains and all groups in the project have the same customizations. These include such artifacts as:

document template
document config
publication config
word import config file
word/pdf export config file
labels – document, fragment, block, inline

In this capacity, the project acts as a template for each group.

Project settings can be exported as a single package for use on a different server or a new project on the same server.

In the user interface, projects are generally shown next to the icon.

Project title

The title is a user-friendly name to display in the user interface. This is useful if the project name contains abbreviations, acronyms or underscores. The title can include punctuation and spaces to describe the project. It’s not recommended to use hyphens in project titles.

Restrict the length to 100 characters

The title is optional, and if left empty, the project name is then displayed.

Project name

The Name field auto-fills with the project title, but it can be changed.

The name of the project is required, must be a unique filename system-wide and is used as a prefix for all subprojects and groups under that project. It is also used as the project template name.

The “URL” is the fundamental building block of PageSeeder. Because the project and group names express context for the URLs that represent content and functionality, it is important the names do not conflict with existing system URLs or the URL syntax itself

Project name restrictions

To avoid inconsistent, ambiguous or non-compliant URLs, projects must be named according to the following conventions:

A project name can only contain lowercase letters, numbers, underscore _ or tilde ~.
Restrict the length to 20 characters.
Top level projects cannot start with a non-alpha character or be named the following: admin, default, member, public.

Because the full name of a project includes the name of its parent project, [project]-[subproject], and is used in URLs and email addresses, it’s a good idea to keep project names short. We recommend that the full name of a project not exceed 40 characters.

Project description

A short description is required and is often displayed as a subtitle of the project in the user interface and in emails.