Developers: | PTC Inc (Parametric Technology Corporation ) |
Technology: | SCADA, CAD |
Arbortext is the product family of the American giant company PTC (Parametric Technology Corp.) intended for creation of technical documentation. In the basis Arbortext uses the principle of a uniform source which cornerstone the XML format is. Article will be devoted in the main Arbortext Editor with Styler which is the main tool of the technical writer. Let's consider the brief summary of a part of products of the line Arbortext and their appointment as further these products can be mentioned.
Arbortext Editor — powerful XML the editor integrated with other products of PTC company (among which the CSDB for S1000D database, the PLM Windchill system, etc.). Supports numerous formats of output publications, such as Web, PDF, HTML Help, Digital Media Publisher.
Arbortext Styler is the superstructure integrated into Arbortext Editor, allowing using the visual interface it is easy to create and edit the styles applied at the publication XML of a source in different formats. Very often Arbortext Editor is selected from a complete set of Arbortext Editor with Styler.
Arbortext ISO Draw is a system for creation of technical illustrations. Arbortext IsoDraw automates process of creation of high-quality 2D and 3D technical illustrations and animation directly from three-dimensional models. Illustrations are automatically updated at change of the CAD initial models.
Arbortext Publishing Engine is the network server for the publication. Allows to select and publish material according to the selected requirements of contents and a format. Contains the machine for the publication in the IETP format.
Arbortext CSDB for S1000D (Arbortext ASD 1000D) is completely set up "turnkey" solution implementing technical documentation according to the ASD 1000D and ASD 2000M specifications. Why Arbortext?
High degree of integration of the products Arbortext with other products PTC allows to perform development of documentation not just in XML the editor, but in a special development environment. This Wednesday gives the chance not only to create XML, but also to store documentation, to create interactive illustrations, to organize parallel operation on creation of documentation to several participants of process while most of editors — the closed solutions for the local user aimed more at some delicacy, but not at the finished solution.
The functionality of the editor which will be in detail considered further meets all modern requirements for the organization of professional work on development of documentation — on the one hand. On the other hand, Arbortext Editor is created it is to begin rather work and to receive result, without needing specific knowledge of XML, XSL-FO, subtleties of installation of standards, document types, etc.
Practically always documentation is developed not from scratch. Many understand that upon transition to use of uniform data source in the XML format it will be required not only to organize development of documentation, but at the same time to use the available practices. Arbortext contains the configured module for import of data from Microsoft Word and Adobe FrameMaker to the XML format.
Functionality of Arbortext Editor
Pleasant moments of workflow
Having begun work and having decided to create the new document, we at once see the preset VEV: DITA, DocBook/XML, SMA (service manual application is specialization on the basis of DITA) and others. There is no need to set or configure DITA or DocBook. Adding of new document type happens the instruction of new DTD (in the drawing own document types which were created and added — elantra, glava, trg_ditabase are also visible).
The preset document types
The choice of the point Sample allows us to open the preset example of the document of this or that type for acquaintance. In the drawing we are lower we see the Arbortext Editor interface with an open sample of the document in the DITA Topic format. The captious user can configure colors, panels, display of elements to the taste.
Having looked at the drawing and having paid attention to display of icons of a marking, it is possible to notice that the filled attributes of tags by default are displayed with their values in icons of tags of a marking that is quite evident as it is not necessary to browse a window of attributes of each tag.
Interface. The preset sample of the selected document type
The window of attributes can be quickly opened by the hot key depending on a cursor position in an edit window or a tree of the document
The screen is by default broken into 2 frames: at the left a document tree, on the right — the field of editing. Splitting the screen into 2 frames it is possible to remove, locate in a different way, and it is possible to replace, having selected, for example, a resource manager as you see in the drawing lower. The resource manager can display the available graphics, structure of links and communications with other XML documents, the borrowed parts of content.
Resource manager (images, the content links, structure members into which documents break)
Documents can be submitted as assembly from file entities, assembly from sets of links. It allows to organize simultaneous operation over the document of several users. On an example the instruction on a car running in which in parallel formed from two parts — file entities is lower.
The Compare function allows to monitor changes, performing comparison of the current document with the last saved version, with the document from other file or from other open Arbortext Editor window. We can trace whether in the new version editing, removal or adding of a part of the text was made. Apparently in the drawing, one point was deleted from the list, but we see in what place it was.
Function of comparison monitors changes in the document
Arbortext Editor can include function of import of documents of different formats to the XML format.
Import of documents to a format
For import the special STD template is used. It is possible to use ready templates, and it is possible to use the built-in editor. On an example we are lower we see some project of import in which work on creation of the template for converting of the Microsoft Word files in XML is begun.
Development environment
For formation of a unified environment of development of documentation and ensuring support of lifecycle of documentation are provided:
Arbortext CSDB for S1000D. ASD 1000D (S 1000D) is the "turnkey" environment of development, creation, management and operation of technical publications in relation to civil and war Aviation and Defense industry. The format of article does not allow to reveal widely features of a product, more detailed information can be found according to the link.
System of providing product lifecycle Windchill. Being the web focused PLM system where a client is normal Internet Explorer, Windchill creates the environment for data storage and product development, provides full-fledged workflow. Windchill is especially irreplaceable when project participants are strongly deleted from each other, but have access to a local or global network. The user can create rules by which the loaded XML documents will break into several files, turning into assembly for formation of parallel operation of remote users and formation of books on the basis of reuse of parts of documentation.