Edit online

Projects and Publishing

Oxygen Content Fusion offers the ability to connect to an existing Git repository that has a DITA project as its source. This is managed within the Content Fusion browser interface through a feature known as Projects. Users with a Content Fusion Author role can create review tasks inside a project and reviewers' suggestions are tracked on a dedicated branch in the Git repository. You can also use the Projects feature to build and configure deliverables for creating PDF or Oxygen WebHelp Responsive output. Projects also provide access to the personal workspace feature that allows authors to make changes across multiple files within a project and then commit them to the project.

What is a Project in Content Fusion?

A Content Fusion Project:
  • Defines a connection to a Git repository that contains DITA content.
  • Provides a graphical interface to manage the DITA project and review processes within the project.
  • Allows Authors to create review tasks inside the project and reviewer suggestions are tracked on a dedicated branch that is traced in the Git repository.
  • Helps Authors with building WebHelp or PDF outputs via Publications and Deliverables.
  • Acts as a read-only clone of the Git repository making it compatible with existing workflows and tools.

User Roles

When working with projects, there are two user roles:
  • Subject Matter Expert (SME) - By default, Content Fusion users have the Subject Matter Expert (SME) role assigned. This role allows the user to access review tasks assigned to them and to create review tasks from scratch.
  • Content Fusion Author - This role must be assigned to a user by an administrator. In addition to the features that an SME has access to, Content Fusion Authors can access all projects and are able to create review tasks inside projects, as well as other functionality that is restricted from an SME. They also have access to the AI Positron Assistant that provides various ways to use AI-generated content or suggestions while editing or reviewing content.

The license for Content Fusion covers a number of user-based licenses for authors and a number of floating licenses for SMEs. A system administrator can assign roles from the Administration page.

Main Projects Page

Projects is one of the two main components (along with Review Tasks) within the Content Fusion browser interface. The main Projects page displays a list of all the current projects that are available for your organization and your user role.

Figure 1. Main Projects Page

To open an existing project, simply click on it. This opens the project Review Tasks page by default.

Branch Management

When a project is open, the second stripe at the top includes a branch management drop-down menu. The current branch is displayed inside the box and you can click it to select a different branch (all the Git branches from your project are available).

Figure 2. Top Header Stripes Inside a Project
In addition to being able to change the branch, the branch management drop-down also contains the following actions:
  • Create new branch - Opens a dialog box where you can choose the name for a new branch and an existing branch to base it on.
  • Delete branch - Opens a confirmation dialog box where you have the option to delete the current branch.
  • Merge into current branch - Opens a dialog box where you can select an existing branch to merge into the current branch.
    Figure 3. Merge Branch Dialog Box

    In the Merge Branch dialog box, you can select which branch to merge into the current one. Click Merge to initiate the process. If the merge succeeds without conflicts, a Merge successful message is displayed.

    If there are files with conflicting changes, a special branch merging conflict resolution dialog box is initiated where you can choose a merge action for each particular conflict and you can view each version of a conflicted file in a side-by-side comparison view.

An Edit in workspace button is always displayed in an additional stripe below the top stripe. You can use this button from anywhere within the project to edit the project in a personal workspace that allows you to make changes across multiple files within the project and then commit them to the repository.

Creating a New Project

Click the New project button to create a new project. This opens a dialog box where you will configure the connection to your Git repository. It includes the following fields:
  • Name - The name of the project.
  • Description - The description of the project. It is displayed under the project's name in the main Projects page.
  • Project URL - The URL of the Git repository.
  • Branch - The default branch of the project.
  • Visibility - You can choose between Public (accessible by all members) or Private (restricts access to select members).
  • Username and Access Token - You can enter the Git credentials (username and access token) using this option.
    Note:
    The personal access token for GitHub must have the following permissions:
    • Repository permissions > Contents > Read and Write.
    • You should also specify which repositories it has access to.
  • Git Account - Use this option to select a preconfigured Git account.

Once you are done configuring the details, click the Create project button to finish the creation process. The newly created project is automatically opened with the project's Content page displayed.