Introduction
Technical Authors, Chemistry Manufacturing and Control (CMC) Authors, and Lab Summary Report Authors need a collaborative and seamless authoring tool to create and manage their structured documents. The ENOVIA Structured Document Manager (XDO-OC) role offers an intuitive and rich web-based document authoring experience for the same. The Structured Document Editor app in this role helps authors in reducing content authoring time by providing collaborative and concurrent authoring experience, maximizing data reuse, and providing seamless review experience.
Concept
In the structured documents you can write content in small chunks known as "Topics" and then organize them as required. Topics con have text, table, figures, and other objects with the specific formatting rules. Furthermore, you can reuse topics as required to speed-up authoring and avoid errors. Refer to the following image that explains generic architecture of the structured document.
Image1:Topic and its Elements
Image 2: Document Map
Authoring Document Using the Structured Document Editor
Image 3: Generic Process to Author Structured Document
Create Project Specific Repositories:
The Structured Document Editor app uses Repositories to store content (Document maps and topics, see next step). You can create repository for managing content of a specific project or for managing content of a particular product. You can add required users in the repositories and assign them any of the following roles as required:
- Viewer: Can read any document in the repository.
- Author: Can create and edit new topics and document maps.
- Leader: Can perform activities of Author and add other members to the repository.
Create Document Map (TOC):
Document map lets you define the overall structure of your document. You can define the hierarchy and order in which topics appear in a map. Once defined, this map is available in form of an outline view (Table of Content). You can create topics on-the-fly or add existing topics at any required location within the map.
Authoring Document Topics:
You can create a document topic to add required information related to any topic in your structured document. In the document topic, you can add information in form of text, tables, footnotes, images, figures. You can use the powerful set of options for formatting text in your topics. Once all the details are finalized, you can save all the outstanding changes in the topic and document map.
- Cross-Reference: Create cross-references using hyperlinks that redirects users from one topic to another or one location in the topic to other location in the same topic.
- External Link: You can add link to the external web-page in the document. These links are shown with a specific icon that indicates that it will redirect you to the reference outside this document.
Collaborative Review:
The “Comments” feature allows you to seamlessly collaborate while reviewing or authoring structured documents. You can add your comment on any text within the document to:
- Share your review feedback.
- Collaborate while authoring document.
You can also tag other stakeholders to notify them about your comment. Stakeholders are notified through 3DNotification and can add their reply to the comment.
The comments panel lists all the comments and replies in the given document. You can use the filter based on the resolution status, stakeholder name, and text to find the required comment.
Publish PDF:
Use the “Publish as PDF” option to begin the publication of opened structured document. The Publish Requests tab shows you the status of the document publication. Once the publication is complete, relevant user is notified. These users can then preview the published PDF document in the 3DPlay application and share it with others as required.
Refer to this video for more information about this role:
