Supported Standards

XML

XML, an industry standard of the World Wide Web Consortium (W3C), since its adoption in 1998, has become a truly universal format in IT.

XML is especially suitable for processing complex documents. With XML it's possible to separate the actual text from the layout, as well as the structural characteristics (e.g. chapters, safety instructions, lists, tables). In contrast to other storage formats, XML is easily processed automatically.

HyperDoc fully supports XML. Not only content, but also processing, display, and functionality of the system are controlled by XML.

HyperDoc supports all XML authoring tools, including Microsoft Word, Adobe Framemaker, XMetal and Arbortext Editor.

HyperDoc includes a predefined XML structure definition (DTD) for specific scenarios. DTD development is costly and not everyone wants to start from scratch. Of course you can also use your own DTD or schema with HyperDoc, several if you like. Concepts for DTD or schema versioning are included. We even have solutions in HyperDoc to exchange content between different DTDs or schemas.

Both data storage and processing are thus handled in accordance with industry standards. You can access all data in HyperDoc with an XSLT extension (STT). Assembling documents and calculating publications are done with XSLT scripts.

Of course, integrating SVG and MathML data is also possible.

DITA

DITA (Darwin Information Typing Architecture) is a standard from OASIS (Organization for the Advancement of Structured Information Standards), a non-commercial, international consortium for standardizations in the e-business area. Developed by, among others, IBM, Sun, and Oracle, DITA is a structure description for texts which classifies content into thematic text modules (topics) of different types. Reuse of these blocks by way of references from various contexts allows for the repeated use of text without having to create and maintain redundant copies. To provide a flexible classification of the text modules, DITA defines an inheritance schema for information modules, their properties, metadata and processing (specialization). The structure description for DITA texts is created using an XML DTD (document type definition), the so-called topic DTD.

HyperDoc is the system of choice for modular concepts. The XML editing and content management solutions from HyperDoc are based systematically on the same modular approach as that realized in DITA. Extensive documentation is divided into single text or information units and stored media-independently. These content modules form the elementary prerequisite for industrial text production, which we have made available to our customers since the 1990s.

HyperDoc's inheritance mechanisms provide support for content creation according to DITA structures. The inheritance hierarchies are created on the information type level, graphically represented and easily modeled and adjusted. Document creation according to DITA is possible with out-of-the-box HyperDoc tools.

ASD S1000D, ATA - Aerospace and Defense

The ASD (formerly AECMA) and ATA specifications define standards for documentation creation in the aerospace and defense industries. These requirements make it possible to unify the distributed creation of technical descriptions and information and keep them consistent.

Modularization of content and images plays just as central a role as the standards for data format and the creation of a Common Source Data Base (CSDB). In addition to simplified data exchange, this process makes it possible to publish documentation in different target media, allowing for the gradual replacement of paper-based documentation with electronic documentation.

The XML-based editing and content management solutions from HyperDoc offer extensive support for implementing these processes and standards. Content and images are created as information units in HyperDoc and managed in a central database. The media-independent data format XML makes not only cross-media publication of technical documentation possible, but also optimizes the data transfer between the suppliers and manufacturers participating in the production process. Tagging and structuring content as required by the standards can also be implemented with HyperDoc.

ANSI Z535.6 - Warnings and Safety Instructions

The US standard ANSI Z535.6, effective since August 2006, defines a frame for the use and design of warnings and safety instructions.

The standard supports technical editors creating user guides and operator manuals for the US market, specifying the manner in which safety instructions must be created and positioned in documentation for a variety of products.

• In HyperDoc, all images and texts in compliance with ANSI Z535.6 are already preconfigured.
• Companies exporting to the US are thus safe from liability regarding the critical issue of warnings and safety instructions.
• Users have the possibility and flexibility to create safety instructions that conform to ANSI Z535.6 or to design them according to their own needs.
• With the help of various dialog boxes, authorized editors or administrators can specify safety instructions for all product information from a central location.
• The combination of hazard level (e.g. instruction, warning, danger), type and source of danger (e.g. laser, heat, unspecified danger), can be set, as can the symbol to be used and any additional symbols, e.g. indication of preventive measures (wearing protective goggles or ear muffs, etc.).

In addition, visual elements such as color and border styles can be defined. During the editing process, the user can then insert the predefined instruction sequences via the Safety instructions menu.

PIM (EMEA), SPL/PLR (FDA) - Life Sciences

Introduced in 2005, the XML standards PIM (EMEA) and SPL/ PLR (FDA) fundamentally changed the labeling process. Since then, companies in the life sciences industry have been requested to create their product information (initial registration, changes, annual reports) according to the specifications of the respective standards.

PIM and SPL/PLR are intended to simplify data exchange and ensure a higher degree of process safety. The goal is to optimize the process for drug approval or marketing authorization. For affected companies, the conversion to an XML-based data storage initially means additional effort. What is needed are efficient solutions, such as those realized with the XML-based editing and content management system from HyperDoc.

By intelligently managing the cross-references between documents, it is possible to:

• Improve and monitor compliance with internal and statutory requirements
• Change information once and reuse in many documents
• Continue to use Microsoft Word as an editing tool
• Create and manage multilingual documents such as PIM more efficiently and cost-effectively

HyperDoc, as an XML-based modular content management system, is much more than a specialist XML editor for PIM or SPL. It is a sophisticated system for linked information in widespread use in the life sciences industry, as well as in plant and machinery manufacturing. HyperDoc incorporates functionality for cross-media publishing. Another standard function is the processing of multilingual content. HyperDoc also offers standard interfaces to translation memory systems. 

Mumasy (VDMA 66320)

Mumasy (multimedia machinery information system) is a cross-industry multimedia information model containing standard data structures in the form of an XML-DTD/schema for information exchange between suppliers, manufacturers and customers, for different phases of the product lifecycle.

A transferable model has been created for the entire sector in cooperation with machinery manufacturers from different areas, software publishers and research institutes, and in coordination with VDMA. Tools and methods have been built around this model for the creation, integration, maintenance and preparation of multimedia machinery information.

The powerful and flexible XML editing and content management solutions from HyperDoc are highly suitable for the implementation of the sophisticated mumasy information model.

HyperDoc can represent the mumasy structure and, in addition to storing the text modules in the form of XML-based media-independent data, can efficiently manage and display the complex relationships between structures for construction, function, and operation.

HyperDoc also offers extensive variants and version management, indispensable for liability reasons, but also offering other advantages, for example, when an existing documentation for an older product batch is to be translated after the fact for an export country. HyperDoc provides differentiated storage methods, letting documentation be created promptly and comprehensively.

Maintenance and organization of content, structures, and layout in a central data pool make it possible to integrate and support workflow processes and professional translation management.

Please contact us today for more information and to request a demonstration of HyperDoc.