Guide

The end-user manual for PageSeeder

Document Navigation

There are a number of functions that appear at the top of the page when you have a document open. The options are view, properties, comments, history, preview, version and validate.

View

Allows the user to view a document in its entirety.

When viewing the document you can choose to display the following:

·         Special characters:

Display white spaces and non-ASCII characters

·         Transclusions:

A transclusion is a type of cross reference, which is resolved directly so that the referenced content (a document or part of a document) is included into the source document. It is important to see that this content does not solely exist in the document it is being viewed in.

·         Labels:

Display labels applied to fragments. Labels are a convenient mechanism for adding semantics to PageSeeder artifacts. Label names may contain the following characters:  [a-z][A-Z][0-9][-_].  They are divided into two broad categories; object and content labels. Object labels  apply to PageSeeder objects such as  documents or  fragments, Content labels  apply to text content inside PageSeeder documents.

Properties

Allows the member to edit the document’s properties. This includes editing the title, filename, document ID and description.

Comments

You can choose to add a workflow step to this document or just insert a comment to this document.

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

Where a comment has been inserted to a particular fragment of a document, the ‘Go to thread’ will automatically take you to the relevant part of the document.

History

Shows the timeline of any changes that have been made to the document via the calendar.

Preview

Allows users to preview the document. They can choose the link depth and whether to generate the table of contents.

Version

A version is a snapshot of a single document at a point in time. 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. Groups can be set up to allow only certain PageSeeder roles to create or archive versions.

You can view the original and current version, as well as any that may exist in between. You can also compare the versions if required.

Validate

Using best practice schema, PageSeeder can identify things that appear missing or incorrect, allowing the user to rectify them.

Created on , last edited on