You are here: User Interface Elements - How to Use Each One > Adding Files to Source Control

 

Adding Files to Source Control

When working in a project that is connected to a source control application, there may be occasions when you have files in your local copy of the project that are not yet part of the source control copy. For example, when you add a new topic in your local copy of the project, that file will not be included in the source control copy of the project until you add it. Following are instructions for adding new files to source control (i.e., adding them as they are created in the local project copy), as well as instructions for adding existing files to source control.

How to add new files to source control

You can use these steps when creating new content files in the project (e.g., topics, style sheets).

  1. Follow the usual steps for creating a new content file, such as a topic.
  2. In the Copy to Project dialog, click Add to Source Control.
  3. Click OK.

    The file is added and automatically checked out to you.

How to add existing files to source control

  1. Do one of the following, depending on the particular file(s) that you want to work with.

    Specific content files only:

    1. Make sure the Content Explorer is open. By default, the Content Explorer is located on the left side of the interface in an accordion structure with the Project Organizer, unless you have previously moved it and saved the new layout. You may have to click the Content Explorer bar to bring it into view.
    2. Select the relevant folder or file.

      If you choose a folder, you can recursively select all files under the folder.

      If you want to choose all content files, select the root Content folder.

      Note: If you want to select several specific files at the same time, open the File List window pane instead (View>File List) and choose the appropriate files using the CTRL or SHIFT key.

    3. In the Standard toolbar, click the down arrow next to the Source Control button .

      Note: Alternatively, you can right-click on the file or folder and select Source Control from the context menu.

    Specific project files only:

    1. Make sure the Project Organizer is open. By default, the Project Organizer is located on the left side of the interface in an accordion structure with the Content Explorer, unless you have previously moved it and saved the new layout. You may have to click the Project Organizer bar to bring it into view.
    2. Select the relevant folder or file.

      If you choose a folder, you can recursively select all files under the folder.

      If you want to choose all project files, select the root Project folder.

    3. In the Standard toolbar, click the down arrow next to the Source Control button .

      Note: Alternatively, you can right-click on the file or folder and select Source Control from the context menu.

  2. Select Add.

    The Check In dialog opens. The selected files are listed with check boxes next to them.

  3. (Optional) Enter an optional comment tied to the check-in. This enables you to keep an audit trail for a file. The comment can then be viewed from the History dialog, which can be accessed from the Source Control button .

  4. (Optional) If you want to see all files with pending changes (rather than only those you selected), click .
  5. Make sure to click the check box next to each file you want to check in so that it contains a check mark.
  6. If you want to automatically check the files out of source control, select Keep Checked Out.
  7. Click Check In.

See Also

PDF Downloads:

Flare Quick Guide

Flare Getting Started Guide

Flare What's New Guide

Flare Key Features Guide

Flare Transition From FrameMaker Guide

Flare Styles Guide

Flare Printed Output Guide

Flare WebHelp Plus Guide

Flare Shortcuts