Glossary

A-Z glossary of PageSeeder concepts

Glossary

The list of terms below links to further information. Click through for additional detail and links. 

Created on , last edited on

A

Action icons
Action icons are essentially shortcut keys that change depending on the context and perspective you are viewing the user interface with. Hover the cursor over an action icon to display its function.
Action tab
When browsing PageSeeder using the group context, there is a small action icon that corresponds to the PageSeeder folder or documents on the right hand side.
Activity – group
Provides a list of the activities of a group sortable by the activity (uploads, attachments, creations, edits, XRefs, versions, notes and comments) of members, which can be organized by the activity type, the document, the date, author and labels. It can be viewed by clicking 'Activity' on the group navigation bar.
Admin tab
The admin tab is available to group managers at the top right of the screen. Administrators of a group will have even more options available.
Administrator
A particular PageSeeder role with elevated permission to configure a PageSeeder server.
Announcement
Specific emails that are forwarded as is to all the members of a group.
Archive
Is a default folder in every group and it is also a verb that describes a feature of the system. The Archive folder is created by the system as soon as the first document is archived. How the feature works is easier to understand with some background.
Autosave
When editing a fragment of a document, there is an auto save feature that stores the current draft version of the fragment every five minutes. A message appears below the editor whenever a draft is saved.

B

Batch processing
The search page allows users to process multiple files at once using one of the six functions below:
Block label
Block labels are used to associate custom style or semantics to a block of text.
Block – Comments
The comments block lists all comments that have been posted to the particular document being viewed.
Block – Contexts
Provides a breakdown of the chapters included in the document, and the content covered within the chapters. is this description for Table of contents block??
Block – Document Browse
The document browse block can be found on the left hand side of the page when viewing a document and allows for quick navigation to other documents contained in the same folder.
Block – Members
The members block displays a list of all members who are joined to the group plus their roles and notification settings.
Block – Quick Links
A list of links which can be set up to allow users to navigate to documents quickly. The links are displayed within this block.
Block – Recently Viewed
Displays a list of documents that you have recently viewed. If you hover over each of the documents, it provides the date and time that the document was last opened.
Block – Table of Contents
The table of contents block lists all the headers contained within the document that is being viewed. The headers can be clicked on and the member will be taken to that particular fragment of the document, rather than scrolling through the entire document.
Block – Tasks
The tasks block displays any open or resolved tasks that apply to the document currently being viewed.
Blocks
A class of object in the user interface used to display information related to the page. They are handled by the Layout manager.   
Blockset

C

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 ID
PageSeeder generates a unique ID for every comment. This ID is a useful reference when tasks are significant to external systems such as software code. This allows PageSeeder to function as an issue tracker such as JIRA or Bugzilla.
Component document
Are the building blocks that are linked together in a reference document.
Content labels
A class of label used to describe information inside PageSeeder documents. The two types of content labels: para 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.
Context
There are four contexts in the interface. They are: server, project, group and document. Each time that the context changes, so the will the fundamental components of the interface such as the navigation sub menus, the blockset and the action icons.
Cross reference
Occasionally referred to as XRefs in the PageSeeder user interface, cross references have two primary functions. They are:
Cross reference label
A label attached to a cross reference.

D

Daily digest
A method of notification, allowing the member to keep up to date with the latest comments and discussion related to a group.
Default group setup
Delete
'Deleting' in general, is something that is not encouraged in PageSeeder. This is because PageSeeder's architecture relies heavily on links and most things are connected. Deleting a document may have the unintended consequence of making a comment impossible to access. Because of this the archive function is always encouraged over deleting.
Developer tab
When in the Developer Perspective, the Dev menu accessed via the Developer tab on the right hand side, provides a few tools useful for analyzing the current state of the PageSeeder server and for customizing it. 
Developer tools
There is both a developer perspective, and a developer tab in PageSeeder. As the names suggest, both these options expose tools that help develop or support PageSeeder applications.
Document
PageSeeder terminology defines a document as anything that has a URI ID. This includes the following:
Document format
PageSeeder can support multiple document formats and in earlier releases, it was much more common that more than the standard format was used. However as the standard format has matured and use of it has become more sophisticated, it is rare to see any other document format deployed. Although it is not strictly correct, one way to think of this term is to compare it to the file format for applications like Microsoft Word. In the past document formats were used to meet specific requirements, however now days, special needs can be met by simply customizing the standard format. 
Document history
Refers to the previously saved versions of a document that are able to be viewed by a member.
Document ID (DocID)
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 document by the following:
Document properties
Document template
Templates are used to guide and control the information that members include in a document type. Document types are stored at the project level. This means that the same document templates are visible to all groups in a project. 
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
A document type is a 'class' of PSML document. It can be used to customize the structure, creation, editing, labeling, importing, exporting, publishing, CSS style and validation of document content.
Document type - References
A PSML document configured as the "references" document type in PageSeeder.
docx
See Microsoft Word (docx format).
Download
In the document context, the download option allows any document to be saved locally in its native format.

E

Edit note
An edit note is a particular type of XLink (a note) attached to a specific changes in a document fragment (an edit).
Edit note label
Edit note labels are attached to a note made on a document edit.
Editing – batch
Batch, or bulk, editing is supported using the following techniques:
Export
Like preview, download and publish, export is simply a meaningful name for publish scripts that use PageSeeder's batch API. PageSeeder comes with default publish scripts that export to the following formats:

F

Filename
Whether it is a normal binary file such as a .ZIP or a Microsoft 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, it is possible to view them directly through the operating system. In this circumstance, only the filename is visible.
Folder
The term 'folder' can be used in multiple contexts including the following:
Fragment
PageSeeder documents are composed of fragments.
Fragment identifier (ID)
There are unique fragment IDs that correspond to every fragment inside a document. By default,  these values are generated by the system, however they can also be assigned to a section using PS XML.
Fragment label
A label which applies to a fragment.

G

Group
A key PageSeeder concept, the group restricts access to content such as documents and comments to a member.
Group console
Displays a list of all publishing, processing and indexing jobs within the group. The group console can be viewed by managers and selected via the admin tab.
Group folder
Group folders are the main containers for URIs (essentially documents) in a group and can belong to different schemes, hosts and/or ports.
Group owner
Is the person or organization responsible for managing a group. The group owner is visible via the 'List groups' option on the admin tab. It is also visible in the advanced options when editing group properties.
Group properties
Can be accessed via the groups option on the admin tab. These are often inherited from the project but can also be set at the group level.
Group properties – Advanced options
Group settings
Group settings are the core attributes that define how a group functions. They are available when the group is first created or can be accessed at any time by advanced users with a role of  manager or administrator of the group.
Group – naming
Because access to a group is via a URL, to avoid clashes with the other aspects of the system it is important to understand the naming constraints on a group. The full group name is prefixed by the project name dash '-' (e.g. acme-docs) and the following rules apply to the name:

I

Image shell
An implementation technique that uses a standard 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.
Inline label
Inline labels associate custom style or semantics to running pieces of content in a block of text.

L

Lab tab
The lab tab can be seen when viewing PageSeeder using lab perspective.
Labels
A convenient mechanism for adding semantics to PageSeeder artifacts.
Layout analyzer
The Layout Analyzer is a developer tool provided in the developer perspective to analyze the current PageSeeder layout configuration and report on how the different user interface components are built.
Layout Manager
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 developers several types of logs for developers and administrators to assess the health of their system and diagnose problems.
Login
The process of a member logging in to a PageSeeder server.
Logout
The process of a member logging out of a PageSeeder server.

M

Manager
A particular role with permission to configure a PageSeeder group.
Member
In PageSeeder, a user is referred to as a member. This is partly because what users can do and see is contextual on their role in a project or group. In other words, although a user has only one account per PageSeeder server, which is where their password and email address are controlled, other privileges are determined by their group membership.
Member – deregistration
The process of a member removing themselves from a group they are subscribed to.
Member – previous / pending
Previous or pending members of a group are visible when a member with a role of manager or higher views the member list.
Member – registration
The process of joining a member to a group.
Microsoft Word (docx format)
Support for converting PSML documents to docx and docx to PSML is a standard feature of PageSeeder. Available under the export icon and action icon on the Document -> Browse page, there is a standard conversion that will process any PSML document without modification.
Moderator
Is a particular role that moderates comments.

N

Navigation bar
Allows members to navigate quickly through different PageSeeder pages. The navigation bar changes depending on context and role.
Navigation – document
Refers to the navigation bar that is displayed when viewing a document.
Navigation – group
Refers to the navigation bar that is displayed when viewing a group.
Notification
Is a generated by the PageSeeder server and never stored. This is in contrast to comments or tasks which are stored within the groups to which they are posted.
Numbered headings
A numbered heading is a <heading> element in PSML or PageSeeder Standard XML which will be 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 and superior results than using Microsoft Word or similar applications. However, the issue of numbering can span the entire document lifecycle, which makes it hard to cover in a single article.

O

Object labels
A label can be used for a variety of purposes but, fundamentally, it is a qualifier for a PageSeeder document, fragment, comment, task,  version, cross reference, or edit note Labels can be used for typing or filtering or other purposes where a defined value is required.
Omnibox
The omnibox is the search box that appears to the right of the group name in the navigation and can be used to search any PageSeeder item within that group.
Overwrite
Is an option on the upload service that will record the new data as an edit instead of simply replacing the existing document.

P

Pages
A key concept of PageSeeder's Layout Manager, pages are a configuration of content and blocks.
PageSeeder contexts
See context.
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).
Para label
See block label.
Password
Passwords are required for all users to authenticate or access private groups.
PDF documents
Off the shelf, PageSeeder will store, generate, link and display PDF documents. With customization, PageSeeder can do much more, including publish to ebooks and annotating.
Performance block
Performance details of every processing step in PageSeeder can only be viewed via the performance block. This is visible in the developer perspective, where it is added to every page.
Perspective – developer
Developer perspective includes a number of tools and documentation to help PageSeeder developers. It can be selected via the cube icon on the navigation bar.  For security reasons, most of the content in this view is restricted to member's with the role of administrator.
Perspective – lab
Lab perspective allows members to use features that are experimental or still under consideration for inclusion in future versions of PageSeeder.
Perspective – standard
Standard perspective is the default perspective for end user, day-to-day use of PageSeeder. It can be selected by way of the perspective icon.
Perspectives
In earlier versions of PageSeeder, perspectives were known as style views. The change was due to the ambiguity of the word 'style' in publishing, however 'style views' persist in parts of the source code. The purpose of perspectives is to show or hide information in the user interface. This allows users to focus on specific aspects of the system and can improve productivity.
Preview
Allows developers to add a lightweight preview to the editing environment. See Preview a document.
Project
Not only is the term 'project' used in many other contexts of software development, in PageSeeder it is also somewhat ambiguous. Apologies for this but we really couldn't come up with anything better. Following are the two roles of each PageSeeder project:
PSML
PSML (PageSeeder Markup Language) refers to the new PageSeeder document format as a replacement for the xformat and PS XML format. It is part of the Universal format.
Public
In the PageSeeder context, 'public' doesn't have the same meaning as it does when used in a phrase like 'public transport'.
Publish
Publish in PageSeeder generally means to copy one or more PageSeeder documents and associated files to a website.
Publish Engine
Is a key component of the PageSeeder solution. Designed to be physically separated from the PageSeeder server, the Publish Engine allows CPU-intensive tasks such as document composition or transformation to be distributed. This protects the user interface code from having to share the host server with demanding, but less time sensitive, processes.
Publish script
Is an Apache ANT build file (build.xml) which uses one or more Ant Task and is run by the Publish Engine.  Scripts can be used for both publishing to external servers or formats, or 'publishing' to a PageSeeder group (importing data). Because ANT is free, open source and widely supported,  Publish scripts give developers a broad range of possibilities for connecting to other systems.

R

Reverse cross reference
Cross references can be bidirectional so that it is possible for target documents to know what 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 a standard that provides PageSeeder with powerful document validation capabilities. Further information is available via the Schematron Wikipedia page.
Search
Users can search for words, phrases, page numbers, videos, and links. To perform a search, do the following:
Search and replace
A common request from members is how to search and replace across a collection of documents or even a single document. Unfortunately this functionality is not supported in the current PageSeeder.
Search facets
Search – troubleshooting
Unfortunately, search isn't as easy as Google make it look. How a search query is interpreted and then resolved against the index of terms or indeed how the index is created depends on a number of decisions. Because these decisions are contextual a long chain of dependencies is created, the consequence of which can be confusing or 'bad' search results.
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 using that particular PageSeeder server of a server wide event  such an imminent upgrade or restart.
Shared document
A document viewable by more than one group.
Significant date
A date that a member can specify as part of their personal details to protect their password from being reset.
Site prefix
The PageSeeder site prefix is the URL prefix assigned to PageSeeder on the application server and is set to /ps by default.
Splitting documents
Standard format
Also known as PS Standard or PS XML , the Standard format is defined by the Standard schema.
Status
Is a value that can be assigned to a document using a version,  task or workflow. The status values are configurable in the group properties.
Style view
Also known as perspectives, allow members to choose from a number of customized user interfaces. Style views can be changed using the Layout Manager or by hovering over the perspective icon and choosing the desired option.
Subgroups

T

Table of contents
Task
Is a comment with configurable metadata such as:
Theme
PageSeeder allows for users to change the colour theme and display. By hovering over your member name at the top left of the screen you can change the PageSeeder theme.
Transclusion
A transclusion is type of cross reference which is resolved directly so that the referenced content (a document or fragment) is included into the source document.
Trees
Tree are a class of object in the user interface to represent hierarchical information.

U

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
Is PageSeeder's internal identifier as opposed to the Doc ID, which is designed to be an external identifier.
URL
In PageSeeder terminology a URL is URI that is stored outside PageSeeder. In other words it's content is not managed on the PageSeeder server. For example http://google.com would be a URL. It is also called an external URI.
Username
Usernames and email addresses can be modified on the personal details page.

V

Validation Schematron
See Schematron.
Version
A version is a snapshot of a single document. It must have a name which can be a number, date or free text (e.g. 1.1, 2014-08-19, Final Draft) and may have a text note and/or labels. Only local content is included in the snapshot not transclusions. Multiple documents may be versioned at the same time with the same name but the version on each document only applies to that document. Versions can only be created or archived by approvers.

W

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 but they are independent from each other.

X

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