Projects and Publishing
An introduction to projects in Oxygen Content Fusion and how they support content management, review workflows, and publishing deliverables.
A Oxygen Content Fusion project connects documentation work to a Git repository. Users get added to each project with an assigned project role.
When Authors create a new project, they are automatically assigned to the particular project with the Owner project role. Owners can assign other users to the particular project with a specific role (Collaborator, Maintainer, or Owner).
Authors who are assigned to a particular project with a Maintainer project role or Owner project role can commit changes to the project, integrate proposed changes, manage project branches, publications, and deliverables, publish content to PDF or Oxygen WebHelp Responsive output, and more. A project Owner can also manage settings, members, and project roles.
User who are assigned to a particular project with the Collaborator project role can read project content, edit project files in their own personal workspace, suggest changes, and participate in the project's review tasks. Collaborators cannot commit directly to the project, integrate review tasks, or publish deliverables.
What is a Project in Content Fusion?
- Provides Git-based storage for DITA content.
- Allows authors to create content with AI assistance.
- Provides a graphical interface to manage review tasks within the project.
- Helps Authors build WebHelp or PDF outputs via Publications and Deliverables.
Main Projects Page
Projects is one of the two main components in the Content Fusion browser interface, along with Review Tasks. The main Projects page shows all the projects that you can access.
To open an existing project, click it. By default, this opens the project's Publications page.
To mark a project as a favorite, click the star button (
) on the far-right side of the project card. You can filter
the list to show only starred projects by selecting the Show only
starred button at the top of the page.
You can also use the text filter field at the top of the page to filter the list of projects by name or description.
Creating a New Project
Click the New project button to create a new project. This opens a dialog box where you can choose one of the following options:
- Import from Git - Configure the connection to your Git repository. It includes
the following fields:
- Name - The name of the project.
- Description - The project description. It is displayed under the project's name on the main Projects page.
- Project URL - The URL of the Git repository.
- Branch - The default branch for the project.
- Type - The project type. You can choose between:
- DITA - For DITA-related content. It allows you to organize publications, publish to PDF and WebHelp, review DITA quality in the Problems page, reuse content with keys and components, run translation jobs, search within the current map, and insert images or other media.
- Generic - For non-DITA content. It allows you to store any mix of files (including XML formats such as DocBook or S1000D, Markdown, and non-XML documents). You can edit files, create review tasks, and search within the project. DITA-specific features are not available.
- Visibility - You can choose between Public (accessible by all members) or Private (restricts access to selected members).
- Username and Access Token - Use this option to enter your Git
credentials (username and access token).Notice:For details about how access tokens should be created and configured, see Creating Git Access Tokens for Projects.
- Git Account - Use this option to select a preconfigured Git account.
- After you finish configuring the details, click Create project to complete the process.
- Create from template - Choose from the following
configuration options:
- Choose template - Select one of the predefined templates
to create a project. Available templates include:
- Empty project - A blank project with no content, for starting from scratch.
- Software Docs Starter - A starter project template with standard DITA XML content.
- Software Docs Starter (Multilingual) - A starter project template with pre-translated DITA XML content.
Note:A project created from a template is stored internally in Content Fusion. Later, you can link an external Git repository, and all content will be moved to that repository. - Name - The name of the project.
- Description - The project description. It is displayed under the project's name in the main Projects page.
- Type - The project type. You can choose between:
- DITA - For DITA-related content. It allows you to organize publications, publish to PDF and WebHelp, review DITA quality in the Problems page, reuse content with keys and components, run translation jobs, search within the current map, and insert images or other media.
- Generic - For non-DITA content. It allows you to store any mix of files (including XML formats such as DocBook or S1000D, Markdown, and non-XML documents). You can edit files, create review tasks, and search within the project. DITA-specific features are not available.
- Visibility - You can choose between Public (accessible by all members) or Private (restricts access to selected members).
- Choose template - Select one of the predefined templates
to create a project. Available templates include:
- Create sample project - You can choose from predefined templates to create a
project:
- Circle Chat - A sample software documentation project that showcases reuse and profiling.
- Syncro Smartphone - A sample hardware documentation project that showcases the use of keyscopes and branch filtering.
- Hydraulic Gear Pump - A sample hardware documentation project that showcases the use of an image map.
- Sunny Sky - A sample API documentation project that showcases the inclusion of an OpenAPI JSON file in a DITA XML project.
The name and description fields for the sample projects are pre-populated, but you can specify the Visibility (you can choose between Public or Private).
The newly created project opens automatically in its personal workspace, with the Publication Map view displayed.
You can use a URL query parameter (in the form of /projects/new-from-url?url=) to create a project from a Git repository. This is useful for advanced scenarios where you want to provide a project creation URL in documentation, tutorials, or as a button in a CMS.
The URL parameter accepts either a Git repository URL or a download archive URL generated by a Git server. For the archive URL option, the generated archive must contain a root folder where the content is located. You can also use the optional folder parameter to specify the folder that contains the content to use when creating the project.
Git repository URL example: https://example.com/projects/new-from-url?url=https://github.com/user/repo&folder=template_1
Archive URL example: https://example.com/projects/new-from-url?url=https://github.com/user/repo/archive/refs/heads/main.zip&folder=template_1
Assigning Members to New Projects
Once a project is created, a project Owner can assign members to the project and assign a particular project role.
Branch Management
When a project is open, the top stripe contains 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).
- 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.