Skip to main content

Next-Gen Editor 

Introducing the Next-Gen Editor, a powerful tool crafted specifically for professional tech writers seeking a seamless and intuitive writing experience. This new editor offers a user interface that closely resembles other writing platforms, providing a familiar workspace that promotes productivity and ease of use. Its clean design ensures that focus remains on content creation, while advanced features support complex workflows and collaboration.

Despite its familiar appearance, the underlying structure is still the same robust XML-based architecture. Writers can take advantage of the rich semantic capabilities of DocBook, making it possible to organize, reuse, and adapt content efficiently across different projects and platforms.

The Next-Gen Editor is designed with flexibility in mind, allowing for both simple editing tasks and complex document management. This integration of a familiar interface with a solid XML backbone aims to elevate professional writing workflows and streamline content management processes.

Learn more about the Next-Gen Editor:

Contribute in Next-Gen Editor

When opening a contribution assignment in the Next-Gen Editor, the topic or publication that has been assigned to you will open in Edit mode. You can then add or remove content, as well as leave comments and create review assignments.

Start contribution

If the topic you want to make changes to is in Read-only view, you need to open it up for editing before you can start working on it.

  1. Locate the topic you want to contribute to.

  2. Select the Edit/Close edit button 251208_Edit_Button.png.

  3. Start editing.

View the content structure

Some topics, and most publications can consist of many reused topics and other elements. To get an overview of the structure of the document you are contributing to, do the following:

  1. Select the Content structure pane button 260605_Structure_Pane_Button.png.

  2. The Content structure pane expands and shows all reused and structure reused components.

    260605_Content_Structure_Pane_Expanded.png

Switch between Edit and Suggest mode

You can either insert your contributions directly into the content, or you can insert those contributions as suggestions so that the author can decide whether or not to accept them.

  1. Select the Mode switcher 260605_Mode_Switcher.png.

  2. Select the mode you want to use from the dropdown.

    260605_Mode_Switch_Dropdown.png

Note

When inserting content in Suggest mode, the inserted content will be marked green.

260605_Suggestion_Highlighting.png

Insert new topics in a Contribution

You can add new topics to topics or publications you are contributing to.

  1. In between two topics or at the end of the topic you are contributing to, select the Create topic icon.

    260605_Create_Topic_Icon.png

  2. In the Create topic dialog, enter a title for the topic.

    260605_Create_Topic_Dialog.png

  3. Select Create.

  4. Select the Edit button 251208_Edit_Button.png for the newly inserted topic to start adding content.

Note

When adding a new topic to a topic, it will be inserted as Structure reuse.

Commenting in Contributor mode

Whether you are working in Edit or Suggestion mode, you can always insert comments into the content.

Inserting comments works in the same way it does for Reviewers. Please see Review in Next-Gen Editor for more information.

Working with assignments

While in Contributor mode, you can interact with assignments using the Assignments button in the Editor header.

Create a review assignment

If you want your contributions to be reviewed by someone other than the original assigner, you can create a review assignment.

Note

You can only create a review assignment for the document you are currently working in.

  1. Select the Assignments button 260605_Assignments_button.png.

  2. In the assignments dialog, select the Create review assignment button.

    260605_Create_Review_Assignment_Button.png

  3. In the Create a review assignment dialog, set the following parameters:

    • One or more assignees

    • Assignment date 

      Note

      By default this is set to 7 days from the current date.

    • Assignment description (optional)

  4. Select Create.

Finish an assignment

To finish an assignment:

  1. Select the Assignments button 260605_Assignments_button.png.

  2. In the assignments dialog, select the Finish assignment button.

    260605_Finish_Assignment_Button.png

    Note

    This action can be undone by selecting the Undo button.

Switch to another assignment

You can switch to any other assignment that is currently assigned to you.

  1. Select the Assignments button 260605_Assignments_button.png.

  2. In the assignments dialog, select the title of the assignment you want to switch to.

    260605_Switch_Assignments.png