Glossary

The glossary contains a useful list of concepts and definitions used by PageSeeder.

Created on 25 June 2010, last edited on 11 August 2021 at 16:20

A

action icons: These action icons are no longer used in the PageSeeder v6 user interface.

activity – group: Provides a list of the activities, sortable by the activity of members, including the following:

Administrator: A particular role with elevated permission to configure a PageSeeder server.

ambiguous xref: See references check.

Ant task: Apache Ant tasks perform actions in a publish script.

archive: Is a default folder in every group and it is also a verb that describes a feature of the system. It is created by the system when the group is created. How the feature works is easier to understand with some background.

AsciiMath: A free, open-source project that supports the creation of MathML equations using a simple, plain text syntax and a standard web browser.

authorname: is a human-readable name provided when a comment is posted by someone that doesn’t have an account on a PageSeeder server. This happens when a group is open to the general public, as opposed to the PageSeeder public. When someone who is not a member, posts a comment using an API call such as Service: /comments/forurl [POST], they can be prompted for a name. This would be the @name attribute on the <author> element.

autosave: When editing a document, there is an autosave feature that stores the current draft version of the fragment every few seconds after you stop typing.

B

backup: Requires backing up both the file system and the database. The following folder can be excluded as it contains only temporary files:

Bastille: Bastille is a Java library which extends Berlioz to better integrate with PageSeeder and provide common functionalities for websites.

batch (or “bulk”) processing: There are two ways to batch process PageSeeder documents through the user interface. One is using the search results and the other is to configure a publish task to run at the folder level using the Task config.

Berlioz: Berlioz is an open source Java library, written by the PageSeeder team to provide a simple developer framework that uses URI template notation to allocate services and XSLT for serving XML to the web as HTML. Although Berlioz can be used to serve any type of XML, it comes with native support for processing PageSeeder Markup Language (PSML) and includes the following infrastructure:

block label: In PSML, a block label associates semantics to a block of text.

block xref: A type of cross-reference that references content that is to appear as a standalone element. The different ways a block xref can be processed are the following:

blocks: Blocks are no longer available in the PageSeeder v6 user interface.

Bridge: Open source library that simplifies the task of accessing the PageSeeder service API from Java or Kotlin applications. Bridge allows applications to support the following:

build.xml: the standard file object for the Ant API. For further information, see Using Ant.

C

Cache-Control: There are multiple levels at which PageSeeder utilizes caching to improve performance. This entry is specifically oriented to HTTP caching.

Cascading Style Sheets (CSS): The layout manager (deprecated) CSS is organized into common CSS files plus page-specific and block-specific files as described in the following table.

CK Editor: The native editing library in PageSeeder is CK Editor. For further information, see editor config.

comment: A fundamental capability of PageSeeder, comments are a class of XLink that can be attached to different locations in the data or system. Because commenting is so integral to PageSeeder’s architecture, understanding how they work can help to explain the broader concepts.

comment formatting: Comments posted by email or through the user interface are stored in plain text. However, to leverage the formatting capabilities of modern browsers, comments can include basic formatting through the use of the popular language, Markdown.

Comment ID: There is a unique system-wide generated identifier for every PageSeeder comment.

Common group: This feature is deprecated as of PageSeeder 5.99 and the following restrictions will NOT be enforced for existing common groups.

component document: Do not have to be a specific document type, "component" reflects the role of the documents that are bound together by a references document to create a publication.

Content labels: Content labels are a class of label used to describe information inside PageSeeder documents. The two types of content labels: block label and inline label are analogous to the idea of paragraph and character styles in publishing or word processing systems, or to the HTML elements of <div> and <span>.

Content Security Policy: The Content Security Policy (CSP) is a W3C recommendation that provides a framework which assists with the following:

context: There are four contexts in the interface: server, project, group and document. They are exposed in the horizontal navigation menu and are used for configuring user interface components such as pages.

copy: see duplicate.

cross-reference: Also known as an xref.

cross-reference label: A label attached to a cross-reference.

D

Daily digest: Daily digest is a method of notification, allowing the member to keep up to date with the latest comments and discussion related to a group.

date and time: Correctly understanding where the date and time are sourced and applied is important for getting the most out of PageSeeder. The orderly processing of edits or comments is critical to efficient collaboration, but it isn’t always straightforward with globally distributed group members.

date picker: Common interface components such as a date picker can be added to PSML documents using a <properties-fragment>.

default document types: PageSeeder comes preconfigured with two document types:

default group setup: These are the settings used to initialize a group. They include the folder structure (documents, image, attachments and more) and files like the homepage and quick links.

delete: In general, PageSeeder does not encourage ‘deleting’. Even when it isn’t obvious by appearance, the PageSeeder XLink architecture means that most information objects are created by processing links to users, content and context.

developer license: The developer license for PageSeeder allows developers to create unlimited projects, groups and members as long as they access PageSeeder through localhost or *.localhost only. This license is configured by setting the product key to ‘dev’ and website address to ‘localhost’ or ‘[x].localhost’.

developer mode: To keep the user interface straightforward for end-users, PageSeeder provides a developer mode, which when enabled, turns on additional features, tools and information specifically aimed at developers.

developer perspective: The developer perspective was used in previous versions of PageSeeder. From PageSeeder 5.9, use the developer mode to enable tools dedicated to developers in the user interface.

developer tools: Is this term still relevant or should it be deprecated? See term developer mode.

DITA: DITA is an XML standard for documentation and processing from OASIS. It shares some of the same architectural concepts as PageSeeder.

document: PageSeeder terminology defines a document as anything that has a uri id / uriid and is not a URL. This includes the following:

document history: Document history refers to the previously saved versions of a PageSeeder document that are able to be viewed by a member.

document id (DocID or doc id): The PageSeeder server allows any document—XML or binary—to be assigned a server-wide, unique, permanent identifier. This value is commonly referred to as the DocID and it has the same use case for both developers and end-users. That is, the DocID is an alternative method to folder path and filename for locating a document, like a primary key.

document label: Labels can be added to a PageSeeder document by the following:

document metadata: A set of properties that can be attached to a document based on its document type or media type.

document processor: Bound to specific data formats by MIME type, the document processors help to resolve XLinks to source documents.

document status: is a way of associating a group member with a document, a task and a date. The primary objective of the document status is to formalize lifecycle stages such as creation, review and release. Using the collaboration and reporting tools of PageSeeder, the document status can eliminate much of the overheads and inaccuracies associated with managing document lifecycles using spreadsheets and email.

document template: A pre-configured structure and semantics defined as part of a document type.

Document title: Refers to a property of a document. All PageSeeder documents, regardless of their media type or content, have a Document title.

document type: In PageSeeder, a document type can be compared to a ‘template’ in Word or FrameMaker. Document types are used to customize aspects of the content such as:

document view: Refers to the display of a PSML (PageSeeder Markup Language) document.

documentinfo: One of the metadata containers for a PSML document (the other is fragmentinfo). See the metadata element reference for further detail.

documents explorer: Also known as Documents Browse.

docx: See Microsoft Word DOCX format and Open XML.

download: In the document context, the download option allows any document to be saved locally in its native format.

duplicate: Computer science has long discussed the issue of redundancy vs dependency and from time-to-time, it is a topic that arises in PageSeeder modeling.

E

edit note: An edit note is a particular type of XLink (a note) attached to a specific change in a fragment (an edit).

edit note label: Edit note labels are attached to a note made on a document edit.

Edit sheet: As the name implies, this is a hybrid of a spreadsheet and a conventional editor. The Edit sheet makes it straightforward for users to open an entire folder of documents or binary objects and edit their metadata, properties, folder or filename. In the case of PSML documents, the Edit Sheet also exposes fragment properties or inline labels for editing.

editing – batch: PageSeeder provides the infrastructure necessary to support batch or bulk editing. Effectively, this process can be thought of as re-uploading PSML – PageSeeder Markup Language files. Therefore, batch editing can support use cases such as:

export: Like download and publish, export is simply a meaningful name for publish scripts that use PageSeeder’s batch API . By default, PageSeeder comes with publish scripts that export to the following formats:

external url: Also known as simply a URL or external URI.

F

faceted navigation: Faceted navigation is a methodology for organizing information to optimize navigation by values in the data.

file size: Size in bytes of PageSeeder documents.

file system: PageSeeder relies on the file system to store documents and binary files.

filename: Whether it is a normal binary file, such as .ZIP, or an Office document or a PageSeeder document, any file viewed in PageSeeder has both a filename and document title. However, because these files are physically stored on the file system of the host server, they mustn’t have names that violate the naming rules of the host operating system.

FOConfig: also known as FO Config

folder: As a term, ‘folder’ can be used in multiple contexts including the following:

folders and files: Files and folders in PageSeeder can be used in multiple contexts. For general explanations, see the glossary entries for document or folder.

forms: For further information about the creation and editing of electronic forms or fielded data in PageSeeder, see PSML document template, PSML properties editor or the tutorial on How to configure a custom properties editor.

fragment: Documents in PageSeeder are composed of fragments.

fragment identifier: A unique identifier for a fragment within a document. The fragment ID provides developers with a more precise mechanism for updating documents that have been created outside PageSeeder.

fragment label: A label which applies to a fragment.

fragment template: part of the document template.

G

generator: A generator is a server-side component written in Java which produces an XML response from a content request. Berlioz libraries provide a number of built-in generators for common use cases.

global template: The Global template (previously known as custom folder) is a custom Project template that applies to all projects on the server.

group: A key PageSeeder concept, the group restricts access to content, such as documents and comments to a member.

group config: Group config includes the group name, description, welcome message, advanced options and group properties. They are available when the group is first created or can be accessed at any time by a manager of the group.

group config – advanced options: These settings can be found in Advanced Options on the Group configuration page located under Group administration. For more information about the API, see Service: edit-group.

group folder: Is an object that acts as a container for uris in a group. All documents and folders belong to at least one group folder. Each group folder contains its own tree of documents and folders.

group owner: Is a value used to cluster, or differentiate, groups. Typically the name of an individual or organization, the “owner” is visible through the List groups page under the Admin menu. The owner value is set through the Advanced options tab of the Group config option under the Admin menu. See the following screens.

group properties: Accessed by selecting ‘Group configuration’, under the Administration tab on the group dashboard, these are values that control various aspects of group behavior such as whether returned email messages are forwarded to a nominated address. While these same values can be set at the project level, the rules of inheritance and overrides can prove confusing for new users.

H

host: In PageSeeder, a host is one of the attributes of group folder and URI. It must be a valid hostname as defined by RFC 3986.

HTML: A key component in PageSeeder, HTML is used to provide an editing interface for PSML – PageSeeder Markup Language XML documents.

HTTP servlet: An HTTP servlet is a server-side component that receives and responds to requests from clients to perform a particular task or retrieve data over HTTP.

I

image

image shell: An implementation technique that uses a document as a wrapper for one or more images, plus any associated metadata such as credits and captions. During editing, the image shell is referenced using a normal cross-reference. However, when the document is published, the contents can be processed differently depending on the output format.

index XML: The index XML is the XML format used by the PageSeeder Index Engine as a source.

inline label: Designed to associate custom styles or semantics to running pieces of content inside a text block (paragraph). Inline labels play the equivalent role for PageSeeder as “character” or “inline” styles play in traditional publishing or word processing systems.

J

Java: Java is the language used to write much of the core of the PageSeeder application and the generators for any Berlioz application.

Java API: see Bridge.

Jetty: A servlet engine and HTTP server where most Berlioz apps are deployed.

L

labels: Labels are a convenient mechanism for adding semantics to PageSeeder artifacts. They are divided in two broad categories:

layout manager: The layout manager is a framework that generates the PageSeeder v5 user interface. It is scheduled to be removed in the next major version of PageSeeder.

layout manager config.xml: Customizing the user interface using the layout manager is deprecated. This feature is scheduled for removal in the next major release of PageSeeder.

license: PageSeeder is available under more than one license. What follows is the non-legal explanation of the different options.

list: In PageSeeder terminology, ‘list’ should be interpreted as the generic description for ordered (<nlist>) or unordered (<list>) items (<item>) in a document, not as the programming term for a type of data structure.

loading zone: The loading zone is a temporary location in the file system where files are stored before being uploaded into PageSeeder.

logging: PageSeeder provides several types of logs for developers and administrators to assess the health of their system and diagnose problems.

M

Manager: A particular role with permission to configure a PageSeeder group.

Markdown: A simple, lightweight text-based language for formatting documents.

MathML: MathML is intended to facilitate the use and re-use of mathematical and scientific content on the Web. It is supported for display and storage in PageSeeder (see following).

Media icon: To identify the media type of a document quickly, PageSeeder uses a consistent set of icons.

member: The groups that a user is a member of, determine the content they can see. The role attached to each specific group membership, determines the functionality the user has. Membership and role for any group is unrelated to what it might be on any other group.

member – add/remove: Previous or pending members of a group are visible when a user with a role of manager or higher views the member list.

member – registration: The process of joining a member to a group.

metadata: The breadth of objects and processes incorporated into PageSeeder mean some terms require qualification. ‘document’, ‘properties’ and metadata are all such terms.

Microsoft Excel: Is supported by PageSeeder in several different ways. The most common being the following:

Microsoft Word DOCX format: Support for converting PSML documents to DOCX and DOCX to PSML is a standard feature of PageSeeder. Available when viewing a document, there is a standard conversion that processes any PSML document without modification.

MIME type: PageSeeder uses the MIME type of a document as a trigger to invoke document processors that have specific capabilities to process data formats such as XML or PDF.

moderated group: A group with property that assigns the role of moderator to a member. PageSeeder then directs different transactions to the nominated individual for approval. Transactions that can be moderated are: anyone applying to join the group, comments being posted to members, and whether a document is allowed to advance a value of status or workflow.

Moderator: Is a particular role that moderates comments.

N

name-value pair: A common data structure in computing, they are natively supported in PageSeeder. For further information, see property and PSML properties editor.

notification: When certain events occur on the PageSeeder server, email notifications are sent to members. Who is notified and when depends on the options of the event and the notification settings for the member in a particular group.

numbered headings: A numbered heading is a <heading> element in PSML which is preceded by an automatically generated number when published.

numbered paragraphs: A significant amount of development effort has been invested to ensure that even the most complex numbering schemes can be supported in PageSeeder. In many cases, this is achievable with less effort than using Microsoft Word or similar applications and produces superior results. However, the issue of numbering can span the entire document lifecycle, which makes it hard to cover in a single article.

O

object labels: With no predetermined semantics, a label can be used for any purpose. The most fundamental difference for PageSeeder is whether the label is attached to an object, or part of the content. Native objects that support labels include document, fragment, comment, task, version or xref.

object model: One of PageSeeder’s main design strengths is how quick and straightforward it can be to import, edit and publish complex XML documents. The reason for this is PageSeeder’s object model (see document) and how it is used to represent XML data in an easily editable, generic form.

Open XML: See Microsoft Word DOCX format.

organization: An aspect of the service provider license that supports branding of the PageSeeder interface and messages, such as lost password and group invitations.

overwrite: Is an option on the upload service that records the new data as an edit instead of replacing the existing document.

P

pages: A key concept of PageSeeder’s layout manager (deprecated), pages are a configuration of content and blocks.

PageSeeder Ant API: A common requirement for PageSeeder is to process numerous files through multiple stages. To support this, a version of the PageSeeder API can be called from a batch processing environment, Apache ANT. This is the basis of PageSeeder publish.

PageSeeder design objectives: The PageSeeder approach to XML publishing workflows is different from that of conventional applications. PageSeeder was conceived and implemented as a web-based platform, not adapted from a desktop app. The orientation of the product has always been around collaboration and the constraints that are necessary to effectively and productively coordinate groups of users.

PageSeeder file system: Directly interacting with the host file system is not advised! Use the API or user interface to move files in or out of PageSeeder.

PageSeeder server: Is a somewhat ambiguous term. It can be the conceptual term for the overall PageSeeder solution or it can refer to the main software component of the system (and counterpart to the publish engine).

paragraph style: A widely-understood concept that is part of most unstructured document editing and publishing apps. A style groups a collection of format settings under an arbitrary name so a user can apply the identical settings elsewhere.

password: Passwords are required for all users to authenticate or access private groups.

PDF documents: PageSeeder stores, indexes, searches and displays PDF documents. It can also create PDF format from PSML documents using PDF export config usage.

Performance block: The performance block is no longer available in the PageSeeder v6 user interface.

personal group: A personal group is a reserved PageSeeder group used as a private space for PageSeeder members to receive messages and store personal documents.

perspectives: In PageSeeder version 6, the concept of “perspectives” is removed from the user interface.

placeholder: An inline Publication property that can be dynamically created, populated and resolved by writers with no need to modify the document template.

preferences

project: Fundamentally, a PageSeeder project provides the following two functions:

project and group names: Only use lowercase alpha characters plus hyphen (-), tilde (~) or underscore (_) in your project or group names.

Project template: The project template is a set of files that configure the behavior of groups within a project.

properties: Another PageSeeder term with multiple contexts, like ‘document’ and ‘metadata’.

PSML – PageSeeder Markup Language: PSML (PageSeeder Markup Language) is an XML markup language designed to represent a broad range of documents. It is natively supported by the components of the PageSeeder platform with no need for additional configuration. This includes the editor, publishing processes, validator, index/search engine and more.

psxreflist: is a specialized PSML fragment editor to add to, delete or reorganize a list of xrefs (cross-references). The second fragment of a references document is configured to invoke the psxreflist editor. Adding it must be done through the PSML document template, there is no way to call it through the standard end-user interface.

public: The conventional meaning for ‘public’ refers to an external, often anonymous, community. In PageSeeder, ‘public’ means anyone NOT in the same group.

public API support: Indicates the level of support of an HTTP servlet that is part of the public API for a particular usage.

publication: A PageSeeder concept that was redefined with the release of version 5.96xx.

publication config: Among other properties, this controls the way a “Publication” is numbered. Available through the Document config screen.

publication id: A server-wide, unique value represented by a document property. Any document with a value in this field is displayed in the list of Group Publications.

publish: A concept of batch processing in PageSeeder. Publish can mean exporting PageSeeder XML into non-PageSeeder formats such as PDF, DOCX or arbitrary XML formats. It can also mean importing Microsoft Word or Excel into PageSeeder XML.

publish action: <action> elements are specified in the publish config. They include:

publish engine: A key component of the PageSeeder solution, the Publish Engine handles all import, export, publish and some process operations by executing customizable ANT scripts. It is included as part of each PageSeeder server, but one PageSeeder server can use the Publish Engine on a different PageSeeder server so CPU-intensive tasks, such as document composition or transformation, can be distributed.

Publish Engine API: see PageSeeder Ant API.

publish script: An Apache Ant build file (build.xml) that calls the Ant API through Ant tasks so they can be processed by the publish engine.

publish task: An alternate, ambiguous and non-preferred term that refers to an Ant task.

publisher: See publish engine.

Q

question (search): The conceptual foundation of the search service is the idea of “question field” and “question”. Examples of question fields are “document title” and “author”. A questions would be one or more word that appear in either or both question fields. After processing the question, the search service will return a list of results in the specified format (documents, comments, URLs) where the content of a question field fully or partially matched the content of the question.

R

read only – section or document: Prevents a document or section from being edited through the standard PageSeeder user interface. This is especially useful for content that is being maintained externally but integrated with PageSeeder content for publishing. An example of this class of content are comments that are maintained in source code.

references check: Is a feature available under the Dev menu option on the horizontal menu bar. This service will process all xref originating from the document open when it is invoked.

references document type: PageSeeder comes pre-configured with two document types. default is a simple, general-purpose document structure for use in many different circumstances. The other type, references, is more specialized. It has been designed to represent a book structure, with front matter, a table of contents and then a collection of documents.

reverse cross-reference: For a bi-directional link, the reverse cross-reference (or reverse xref) is the component that exists on the link target and refers to the link source. By default, PageSeeder cross-references are bidirectional. This means that, by processing a document, it is possible to know what other documents link to them.

role: The role determines the permissions of a member in a PageSeeder group.

S

scheduled jobs: A Publish script can be scheduled to run at set times using the scheduler.

Schematron: Is an ISO standard with powerful validation capabilities and configurable error messages. Further information about the standard is available via the Schematron Wikipedia page. See XSD files.

search: Built on the Apache Lucene technology, PageSeeder offers end users and developers several interfaces to find and retrieve content using the search capability.

search facets: Typically a property value or a label, facets work best when they are consistently applied to most of the documents in a collection. For example, if most documents include a property of "city", the value of that property can be used to navigate or categorize documents in the collection.

section: Defined in each PSML document type, a section is a container for the content created in fragments and properties.

section id: An ID for a section. The section ID must be unique within the document and is constrained by a pattern or by enumerated values.

section title: A section title is stored outside the editable area of a section. It is displayed but cannot be removed or altered using the standard editing interface. This can be a useful way of building documents that are composed of specifically defined, or ordered, sections.

server message: A server message is a global message that an administrator can enter in the administrator console for display on all pages on the server. It is generally used to notify ALL users currently logged into that particular PageSeeder server of a server wide event, such as an imminent upgrade or restart.

shared document: A document viewable by more than one group.

site prefix: Is the prefix assigned to PageSeeder URLs. The value of the site prefix is stored in the global properties.

Standard format: The standard format was deprecated in v5.8, is now obsolete and a warning is displayed when viewing any PageSeeder Standard XML document. If these documents are not converted to PSML they will only have basic display functionality.

status: Is a value that can be assigned to a document using a workflow. The status values are configurable in the group properties.

style owner: A legacy developer term that continues to be used in several locations in PageSeeder code and configuration files. See project template.

subgroup: Subgroups allow all the members of one group to be added to another group (the supergroup) with one action.

subproject: Is a project below another project or subproject.

supergroup: Is any group with a subgroup as a member. There are no special characteristics of a supergroup, except that knowing which individuals can access the group requires processing the membership of the subgroup.

T

table of contents (ToC): <toc> is a placeholder element for the generation of a Table of contents.

task: Is a comment with configurable metadata such as:

task status: is the status of the last comment in a task.

template folder: The template folder is a container for most of PageSeeder's customizable code.

transclusion: A transclusion is type of cross reference that is resolved directly, so that the referenced content (a document or part of a document) is included into the source document.

U

Universal format: The universal format refers to a collection of PageSeeder files when outside PageSeeder. It consists of a file organization and uses PSML as a representation for PageSeeder documents and their metadata.

URI: Although URIs are a key building block of PageSeeder's XLink architecture, no particular knowledge is required by end users or developers.

uri id / uriid: Is PageSeeder's internal identifier as opposed to the document ID, which is designed to be an external identifier.

URI pattern: A URI pattern (or URL pattern) is simple URL-like notation to match URLs. They are used by the layout manager, the PageSeeder services and Berlioz to identify the user interface to render or service to invoke from a URL.

uriid: See uri id / uriid.

V

Validation: See Schematron or validating documents.

version: A version is a “named” snapshot of a single document. A name can be any of the following:

W

webapp: Refers to the folder structure below the Web application server.

Weborganic folder: The weborganic folder is where PageSeeder stores the application-level styles, scripts and images to be served over the web. Where a project has been customized, the equivalent material is stored in style folders under the template folder.

workflow: A workflow is a special type of task that uses document status values (e.g. Initiated, In Progress, Complete, Approved, Terminated). There can only be one workflow per document and the status of the document is the workflow status. It can have a current priority, due date and assigned to like other tasks and can use comment labels. Workflows can be created on multiple documents at the same time (using batch processing) but they are independent from each other.

X

XHTML sanitization: When comment content is submitted with contenttype=application/xhtml+xml the content is sanitized for security and consistency so that it only contains the following elements or attributes. Named entities such as   are also converted to numerical entities or Unicode characters so the content can be processed easily as XML.

XLink: XLinks are a key component in the PageSeeder architecture. Sometimes their role is obvious (cross references), and sometimes it is less obvious (a new document).

xref: See:

XSD files: There are a number of schema files that are useful for validating different aspects of PageSeeder. Both the files and documentation are available through Schemas.