SiberSafe XML Features

Granularity

Users can define the granularity at which they want to manage their content. For teams using DocBook or sdocbook DTDs, SiberSafe offers the choice of three predefined granularity descriptions. 

Other Authoring Tool Support

SiberSafe supports all leading XML authoring tools, including Justsystems XMetaL, Arbortext, FrameMaker and XmlMind. 

Author Dashboard

The SiberSafe Author Dashboard is a configurable toolbar on the user's desktop that presents the subset of their most commonly-performed SiberSafe tasks. Selectable tasks include:

  • Create a new document
  • Add a legacy/external document to the repository
  • Modify an existing repository object (document, XML fragment, entity, image, etc.) either online or offline
  • Browse the repository
  • Edit content offline / return content to the repository
  • Reuse repository content in offline mode. This provides the users of desktop editors (SiberSafe XML Communicator, XMetaL, Epic, FrameMaker) with a way to include reusable topics in their documents (either by reference or by including the content).
  • Publish a document or group of documents
  • Manage workflow tasks and assignments

The Dashboard enables most common tasks to be performed via the context menu, whose appearance varies depending on the object to which it is applied. Each task-related tool walks the author through the steps required to complete the task, making it easy for novice XML authors to collaborate inside a larger XML document production team. Because the Dashboard is a browser-based application, no special software needs to be installed on the user's computer.

SiberSafe administrators can configure online Dashboard buttons, by specifying different URLs with different sets of commands.

Document Builder

The SiberSafe Document Builder is a browser-based application that enables non-technical staff to dynamically create custom collateral, leveraging the material produced by technical writing teams. The user searches and selects topics from a product knowledge base, populates standard templates with customer specific content, specifies the output format, and receives the custom document by email within minutes.

Templates contain pre-defined queries that make finding information easy and intuitive by searching only the relevant categories of material, such as feature descriptions, command references, white papers, operating system-specific articles, or even user level-specific articles, if the source content is appropriately tagged.

A sales team may therefore define a template that includes a generic cover letter, a dynamically-created technical document with a standard cover page, a table of contents, a standard product overview chapter, dynamically created chapters that address the specific topics requested by the potential client, and a standard conclusion. 

Document Template Management

With SiberSafe, document managers can produce easy-to-use, centrally-managed, clearly-identified standard templates that enable content authors to start writing without having to worry about the details of XML. Each user is presented with relevant templates only, according to access permissions, and merely has to select the template for the type of document he is producing. 

Chunking

XML files are chunked into fragments based on the granularity definition that is applied. Individual fragments can be managed, tracked and versioned. XML documents thus appear as a hierarchy of fragments and reusable entities. 

Index & Search

SiberSafe provides powerful index and search capabilities that enable users without intimate knowledge of the repository to locate content quickly and intuitively.

By specifying which document types will be indexed, and which elements in XML documents, the administrator can tailor the indexing process to meet the operational needs and experience level of their users.

Based on criteria such as keyword, phrase, author, creation date range, attribute/value pairs, etc., the search function will locate content in the latest version of all files in the repository, or all historical revisions that provide a match.

Search results include information about each XML fragment that matched the criteria and its place in the content hierarchy of the parent document, enabling the user to locate the precise content required. 

Conditional Inclusion

Conditional inclusion produces structurally identical variants of the same content, useful when different audiences need content that differs only in some parts. This functionality is implemented via conditional fragments, which are fragments of XML content labeled with one or more audience interest tags. The combination of a fragment's audience interest tags and their respective values determines the audience for which the fragment is intended. Thus, SiberSafe offers not only single source publishing to different formats (such as PDF, HTML, CHM Help, and many others), but also single source content for different target audiences (such as user types, hardware platforms, etc.). 

Link Management

XML documents are not always independent and self-contained. They can reference graphics files, EPS files, even other XML files, which become a virtual part of the document that references them. SiberSafe displays all re-use dependencies so the user can see which assets are referenced from within a particular XML document, and which XML documents reference a particular asset. SiberSafe's recursive versioning helps the user detect changes in their documents even when they are applied to a file referenced by the document rather than to the document itself.

SiberSafe also tracks references to external content and remote content, including links to other web sites and other documents. This allows document managers to track all document dependencies.

Context-aware Linking

SiberSafe's context-aware link management GUI ensures that all created links are valid. The user selects the link target for inclusion in the document they are editing. SiberSafe generates the link using the appropriate link element according to the DTD or schema being used. That link can then be inserted in the document itself. SiberSafe also requires that all links in a document, fragment, or entity be valid prior to insertion into the repository. This ensures that any user creates only valid links. 

Prolog Management

Prolog management gives SiberSafe administrators full control over how the code preceding the root element of any XML document will be generated. DTDs or schemas, stylesheets and external entities can be specified in the centrally-defined prolog template and, once configured, these references will appear in the prolog of every document retrieved from the SiberSafe repository. Some editing tools make automatic prolog modifications that can invalidate referential integrity, so SiberSafe strips these when XML documents get checked into the repository. The correct generation of XML document prologs is therefore guaranteed, because it is driven by the central configuration rather than by the content submitted to the repository. Different prolog management configurations can be assigned to different granularities, making it possible to assign different prolog templates to different XML documents. Prolog Management ensures that teams using different tools in different editing environments can interoperate without having to worry about documents being valid in each different context. 

Virtual Document Management

SiberSafe enables users to edit XML content such as fragments and entities which are not valid XML documents. SiberSafe creates valid documents from fragments and entities by wrapping the fragment or entity with the required XML document framework. The user can then edit the fragment or entity using a validating XML editor and, when the edit is complete, SiberSafe strips away the wrapping when the content is checked back in. This allows users not necessarily familiar with the requirements of XML to collaborate on large XML documents. 

Audience Modeling and Variant Generation

To support applications that derive content from a database, or that serve content according to audience interests dependent on a condition (age, net worth, currency, etc), different variants can be declared based on relationship to a value (<, <=, =, >=, >). All required variants of documents such as insurance policies, targeted marketing material, custom reports, etc. can be automatically generated via SiberSafe's publishing framework. 

Index Term Management

Document sets often require a common index term catalog so readers can find specific content more easily across the entire set. SiberSafe enables authoring teams to define and use terms in a central index term catalog. The user marks content for inclusion in the index via an easy-to-use GUI, navigating the index term catalog and automatically inserting the selected index term hierarchy (e.g. baking, pastry, jelly filled) in the document, using the elements and attributes for index term specified in the DTD or Schema associated with the document being edited. 

Release Management

Release management enables parallel development on projects that share common content. SiberSafe allows the documentation manager to branch a project, so that a new project team can start a parallel development effort while the original team continues towards their original delivery schedule. This situation often arises when a product is released. It may be necessary for one team to deal with documentation issues on the released product, and another team to start work on the documentation and training material for the next version of the product. Release management tracks the divergences and integrations of changes between different projects and project branches.

Supported Variants Assignment

The document administrator can specify what document variants are valid selections for authors requesting publishing of that document. This reduces the confusion that might arise if too many variants are offered to the author when the publishing request is made.

XML Entity-based Content Sharing

XML defines "external entities" as the only widely supported content reuse mechanism. Entities are XML fragments stored in a different file to the XML document. Entities are included in documents by reference. SiberSafe tracks the relationship between the external entities and the documents that use them, and the relationship between documents and the entities they use. SiberSafe provides many features that make it easy to create, find, use, and opt out of using external entities.

Tracking Reuse

SiberSafe's link management features enable users to track what content is being reused in what document. By including reusable components directly in their documents, users can ensure that all updates are included in the document at publishing time. The user can see all changes made to all included entities by verifying the document history. 

Creating Entities

With SiberSafe, users can create entities from fragments at the click of a button. SiberSafe moves the fragment that was converted into a file, and replaces the content with a reference to that file. The created entity is stored in the repository and is immediately available to any member of the team for inclusion in other documents. Entities can be organized in any grouping in the repository using a folder hierarchy model. Teams can define and implement the organization that best suits them.

Entities are directly accessible from most popular XML authoring tools via the SiberLogic entity catalog. Entities can be edited in the context of the full document or as an entity. If only the entity needs to be edited, SiberSafe generates the required XML wrapping so the entity is a valid XML document. This wrapping is stripped when the changed entity is returned to the repository. 

Finding Entities

SiberSafe allows users to easily locate all relevant reusable entities for processing in an XML editor. Relevant entities can be located as follows:

  • Select from a central alphabetically-sorted catalog of all entities defined in the repository
  • Search via keywords that were specified by the user when the entity was placed in the entity catalog
  • Search via keywords or phrases that are contained in the entity content itself
  • Search via keywords that are contained in attributes to elements in the entity

SiberSafe automatically copies selected entity names into the clipboard for easy pasting into the XML editor.

Reusing Entities

Once an author has located a relevant entity, it can be included in a document under construction using one of the following mechanisms:

  • An XML editor that allows inclusion of external entities, usually via the "insert" command. Entities included this way are discovered by SiberSafe when the author invokes the "Restore Entity References" command.
  • SiberSafe's Document Composer provides a straightforward interface for XML content authors to find and include external entities into existing documents.
  • SiberSafe's Document Builder enables non technical staff to enter criteria in queries included in document templates constructed by the document administrator. The result of the queries is a set of entities from which the user can preview and select those he wants to include in the custom document. The purpose of the Document Builder is to leverage product description content so members of the sales organization (for example) can create custom documents to meet the specific queries of different customers and prospects.

Single Sourcing

SiberSafe enables publication of the same content to different media. For example, the user can opt to simultaneously publish a document to HTML, PDF, RTF, HTML Help and CHM Help. Because SiberSafe tracks all the elements required to publish a document, the user need only specify the document to be published. SiberSafe will assemble all the required components from the repository and transform them using the required publication driver. 


Transformations

SiberSafe incorporates both open source and custom transformations to enable teams authoring XML documents using the DocBook DTD to publish to PDF, RTF, HTML, HTML Help, and CHM Help. Published documents can be either stored in the repository or emailed to the requesting user, with multi-file publication results being zipped up prior to emailing.

Via SiberSafe's DITA Open Toolkit integration, users can now easily publish specialized or regular DITA content into formats such as PDF, Word, RTF, HTML, HTML DocSet, JavaHelp, HTML Help, Powerpoint slides, and more. A single server-side DITA Open Toolkit installation delivers the benefits of single-source publishing to all SiberSafe users with no new software required on their own local machines.

SiberSafe lets you specify your own XSLT script to apply to an XML document. The resulting file can be published to a different stream where it could be made available to a different group, or deployed to an external server. 
 

Automated Document Assembly

SiberSafe publication drivers automate document assembly based on query templates and parameter files that specify the criteria to be used when executing the queries. Users can assemble documents by executing queries, sorting the result based on the specified sort criteria, and applying the formatting transformations required. For example, if the Document Assembly Driver is used to produce an alphabetically-sorted list of product features, new features will be included in the right location every time a new list is published. The Document Assembly Driver uses the same document templates as the Document Builder, with the parameter file specifying the selection criteria rather than the user. 

Document Publishing On the Fly

Users can publish their documents "on the fly" without creating a new publication group, via one of the partially-defined publication groups that exist in the stream. These groups specify a publication target format, and their publication source is dynamically selected. 

Knowledge Base Publisher & Viewer

The SiberSafe Knowledge Base Publisher enables training teams to use and reference content created for technical manuals and help files. Teams can generate self paced training courses, learning objects optionally published as SCORM learning objects, and hyperlinked training books published as an interactive training course or a PDF.

Once published, the knowledge base can be distributed for use online or via CD-ROM with its convenient, royalty-free Viewer.

The Knowledge Base Indexer address specification uses XPath expressions to selectively include/exclude elements to/from a particular address in the full-text knowledge base index.

To view a knowledge base on CD-ROM, a servlet-based knowledge base viewer is automatically launch before the system browser.

Either random or user-specified file name prefixes can be generated for publication results. This enables teams to integrate SiberSafe knowledge bases with in-house content management systems that require files to have unique names regardless of the folder in which they are located.
 

What our customers say:

William Gill, Solutions Architect, Innovatia:

"Our experience with SiberLogic during our implementation has been very good. The quality of responses we receive go beyond simply correcting any issue but also provide alternatives and best practice suggestions."

Philip Vallone, Manager, Technical Documentation, SDI Government Solutions

SDI has been using SiberSafe CMS/CSDB for over 5 years to manage and automate its technical documentation development, maintenance and conversion processes. SDI's business is project-driven and every project comes with its own set of standard compliance requirements. SiberSafe has helped SDI to successfully comply with multiple technical publication standards, including S1000D, MIL-STD-2361 and DITA for our commercial and US DoD clients' projects. SiberSafe has tremendously evolved over the years, helping us meet our diverse project requirements. SiberLogic’s technical support and consulting services have helped us meet the project deadlines in our documentation development and conversion projects.

Open Ratings, Dun & Bradstreet

Open Ratings (Dun & Bradstreet) has independently surveyed multiple SiberLogic's customer accounts and gave SiberLogic high marks for its past performance in a number of business related categories, based on the quality of its products and services. Download a copy of the Open Ratings evaluation report from our website

 

Product Information Line

If you have a specific question about our technology, please call our product information line at 905-761-7334 ext 233 from 9am to 5pm EST.

Standards