File Menu

Option

Description

New Project

Opens the Start New Project Wizard, which you can use to create a new project. You can also use this wizard to import files from other sources. See Creating a Project.

Import Project

Opens a submenu, which lets you select an import option.

  • From Source Control Opens the Import From Source Control Wizard, which lets you create a new project by importing an existing project that is located in a source control application. See Importing a Project From Source Control.
  • RoboHelp Project Opens the Import Project Wizard, which lets you import a RoboHelp project. See Importing a RoboHelp Project.
  • Doc-To-Help Project Opens the Import Project Wizard, which lets you import a Doc-To-Help project. See Importing a Doc-To-Help Project.
  • HTML Help File (CHM) Opens the Import Project Wizard, which lets you import an HTML Help (CHM) file. See Importing CHM Files.
  • HTML Help Project (HHP) Opens the Import Project Wizard, which lets you import an HTML Help project. See Importing an HTML Help Project.
  • DITA Document Set Opens the Import DITA Wizard, which lets you import DITA file content. See Importing DITA Files.

Zip

Opens a submenu, which lets you select an option to "pack" your project into a single zip file, which makes it easier to move it and send it to other individuals who have Flare Desktop installed.

  • Zip Project Opens the Create Package dialog, which lets you zip a project and select a location for storing it. See Zipping Projects.
  • Zip and Email Project Automatically zips the project, opens your email program, and attaches the zip file to a new message. All you need to do is provide the address of the email recipient and send the email. See Zipping and Emailing Projects.

Open

Opens a dialog, which lets you search for and select a Flare project to open.

Close

Closes the active file.

Close Project

Closes the current project, but the application itself does not close.

Save

Saves changes to the active file.

Save As

Opens the Save As dialog, which lets you save the active file under a different name and/or file type and to a particular location. The new file is then displayed in the editor.

Save To

Opens the Save As dialog, which lets you save the active file under a different name and/or file type and to a particular location. The new file is not automatically displayed in the editor.

Save All

Saves changes to all of the open files.

Save As Template

Opens the Save as Template dialog, which lets you save a copy of the active file as a template. When you create a new file of the same type in the future, you can select your template file as a starting point for the new file. See Creating Templates.

Export Project

Opens the Export Project Wizard, which lets you export a project, or parts of one, to another location. See Exporting Projects.

Backups

You can choose a backup option.

  • Send Copy to the Backups Folder Creates a temporary copy of the file that is open and active in the interface (not files that you select in the Content Explorer, Project Organizer, or File List window pane). The file is placed in the Backups window pane.See Backing Up Files.
  • Clear the Backups Folder Removes all temporary backup files from the Backups window pane. See Clearing the Backups Folder.
  • Backups Opens the Backups Folder window pane, where you can view your backup files.

Example You might use this feature, for example, if you want to make some changes to a file but are not certain if you will want to keep them when you are finished. Therefore, you can make a backup of the file in question. When you are finished making your changes, you might decide that you prefer the file the way it was. If so, you can quickly roll back to the backup file, which overwrites the changes that you made.

Source Control

Opens a submenu, which lets you select various source control options for the selected file(s). The options shown are different, depending on which source control provider your project is bound to.

  • Project Opens a submenu, which lets you select a source control action to be applied to the entire project (as opposed to just the selected folder or files):
    • Check In All Opens the Check In dialog, which lets you check in all files in the project into source control.

      When you are finished editing files, you can check them in to source control. Checking in a file overwrites the old copy of the file in the database with the new one from your local machine. Even if others are not working on a file, it is a good idea to periodically check in files for a backup in source control.

      You will see this option if your project is bound to Microsoft Team Foundation Server.

      See Checking In, Committing, and Submitting Source Control Files.

    • Commit All Opens the Commit dialog, which lets you commit all files in the project into source control.

      If your project is bound to Git, committing a file adds your changes to the local database. When you are ready to add your local commits to the remote repository, you can push these files to the remote. If your project is bound to Subversion, committing a file overwrites the old copy of the file in the source control database with the new one from your local machine.

      You will see this if your project is bound to Git or Subversion.

      See Checking In, Committing, and Submitting Source Control Files.

    • Submit All Opens the Submit dialog, which lets you submit all files in the project into source control.

      When you are finished editing files, you can submit them to source control. Submitting a file overwrites the old copy of the file in the source control database with the new one from your local machine. So even if others will not be working on that file, it is a good idea to periodically submit files so that you have a backup in source control.

      You will see this option if your project is bound to Perforce Helix Core.

      See Checking In, Committing, and Submitting Source Control Files.

    • Check Out All Opens the Check Out dialog, which lets you check out all files in the project from source control.

      When you need to work on any of the Flare Desktop project files, you can check them out. Checking out files means to copy the latest source control files to your local Flare Desktop project and remove the "Read Only" designation from them so that you can edit the files. A red check mark is displayed next to each file that is checked out.

      You will see this option if your project is bound to Microsoft Team Foundation Server or Helix Core.

      See Checking Out Source Control Files.

    • Get Latest Version All Opens the Get Latest Version dialog, which lets you "get" all files in the project from source control.

      After you bind a Flare Desktop project to a source control application, you can get the latest version of any of the source control files. When you do this, you are copying the most current files stored in the source control application to your local Flare Desktop project without necessarily checking out the files. This means that the "Read Only" designation will remain associated with the files until you check them out.

      You will see this option if your project is bound to Microsoft Team Foundation Server or Helix Core.

      See Updating or Getting the Latest Version of Source Control Files.

    • Update All Opens the Get Latest Version dialog, which lets you update files from source control.

      After you bind a Flare Desktop project to Subversion, you can update any of the source control files. When you do this, you are copying the most current files stored in Subversion to your local Flare Desktop project.

      You will see this option if your project is bound to Subversion.

      See Updating or Getting the Latest Version of Source Control Files.

    • Undo Check Out All Opens the Undo Check Out dialog, which lets you reverse the check-out of all files in the project.

      If you have files checked out from source control but do not want them checked out anymore, you can use the "Undo Check Out" option instead of checking in the files.

      You will see this option if your project is bound to Microsoft Team Foundation Server.

      See Reverting or Undoing a Checkout of Source Control Files.

    • Revert All Opens the Revert dialog, which lets you return files to their last known state.

      If you have modified files from source control but do not want to keep your modifications, use the "Revert" option instead of committing the files. While committing the file would save changes to source control, reverting a file returns it to its previously committed state and does not commit any of your new changes to source control. When reverting changes made in Git, you only revert changes to the file on the branch you are currently editing. If you have a file that resides on multiple branches, copies of the file on other branches are preserved.

      You will see this option if your project is bound to Git, Helix Core, or Subversion.

      See Reverting or Undoing a Checkout of Source Control Files.

    • Pull Opens the Select Remote for Pull dialog, which lets you select the remote repository from which you will download remote files.

      After you select the repository you want to pull from, the remote files are retrieved from the repository and downloaded to your local project. If necessary, Flare Desktop will perform a commit before pulling your files.

      You will see this option if your project is bound to Git.

      See Pulling Files From a Remote Repository—Git.

    • Push Opens the Select Remote for Push dialog, which lets you select the remote repository to which you will upload your local commits.

      After you select the repository you want to push to, your files are sent to the remote repository. If necessary, Flare Desktop will perform a commit before pushing your files.

      You will see this option if your project is bound to Git.

      See Pushing Files to a Remote Repository—Git.

    • Synchronize Opens the Select Remote for Synchronize dialog to select the remote for a pull and push of files.

      After you select the repository, Flare Desktop pulls the remote files from the Git repository and merges them with your local database. Then Flare Desktop pushes your local changes back to the remote Git repository. If necessary, Flare Desktop will perform a commit before synchronizing your files.

      You will see this option if your project is bound to Git.

      See Synchronizing Source Control Files—Git.

    • Branch Opens the Branch Management to create branches, switch to (select) a different branch, and delete an existing branch.

      A Git branch is a pointer to a snapshot of your changes, or you can think of it as a variation from the original or main state of your files. Adding a branch lets you create a new development area for your work (e.g., when documenting a new feature, rewriting large sections of a topic, or making structural changes). Then later, you can merge the branch into another one.

      You will see this option if your project is bound to Git.

      See Creating Branches, Deleting Branches, Switching Branches, and Publishing Branches.

    • Disconnect/Reconnect Disconnects the source control network so you can work offline. You can reconnect at any time.

      This is available if your project is bound to TFS, Helix Core, or Subversion.

      See Disconnecting From Source Control.

    • Network Settings Opens the Network Settings dialog to view and modify source control network settings from Flare Desktop.

      This is available if your project is bound to Git or Subversion.

      See Modifying Network Settings.

  • Add Opens the Add File(s) dialog to add the selected files to the integrated source control application. When working in a project that is connected to source control, 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.

    You will see this option for all source control providers.

    See Adding Files to Source Control.

  • Check In Opens the Check In dialog to check files into source control. When you are finished editing files, you can check them in to source control. Checking in a file overwrites the old copy of the file in the database with the new one from your local machine. Even if others are not working on a file, it is a good idea to periodically check in files for a backup in source control.

    You will see this option if your project is bound to Microsoft Team Foundation Server.

    See Checking In, Committing, and Submitting Source Control Files.

  • Commit Opens the Commit dialog, which lets you commit files into source control.

    When you are finished editing files, you can commit them to source control. If you are working with Git, committing a file adds your changes to the local database. When you are ready to add your local commits to the remote repository, you can push these files to the remote.

    If you are working with Subversion, committing a file overwrites the old copy of the file in the source control database with the new one from your local machine.

    You will see this option if your project is bound to Git or Subversion.

    See Checking In, Committing, and Submitting Source Control Files.

  • Submit Opens the Submit dialog, which lets you submit files into source control.

    When you are finished editing files, you can submit them to source control. Submitting a file overwrites the old copy of the file in the source control database with the new one from your local machine. So even if others will not be working on that file, it is a good idea to periodically submit files so that you have a backup in source control.

    You will see this option if your project is bound to Helix Core.

    See Checking In, Committing, and Submitting Source Control Files.

  • Check Out Opens the Check Out dialog, which lets you check out files from source control.

    When you need to work on any of the Flare Desktop project files, you can check them out. Checking out files means to copy the latest source control files to your local Flare Desktop project and remove the "Read Only" designation from them so that you can edit the files. A red check mark is displayed next to each file that is checked out.

    You will see this option if your project is bound to Microsoft Team Foundation Server or Helix Core.

    See Checking Out Source Control Files.

  • Lock Opens the Lock dialog, where you can select files you want to lock. If your project is bound to Subversion, you can steal locks from another user's locked files using this dialog. When you are working, you may want to lock the files you have modified. Locking a file does not prevent other users from modifying the file. However, no one else can commit a file that you have locked until you unlock the file. If your project is bound to Subversion, you can steal a lock from another user if you need to commit a locked file while they are working on it. Likewise, another user can steal a lock on a file you have locked.

    You will see this option if your project is bound to Helix Core or Subversion.

    See Locking Files.

  • Unlock Opens the Unlock dialog, where you can select files you want to unlock. If you have locked a file, you should unlock it when you are done modifying it. Other users can modify the file while you have it locked, but they cannot submit a locked file until you unlock it. To help prevent file conflicts and make sure that everyone on your team has the most current version of the file, you should unlock and submit the file when you are finished working on it.

    You will see this option if your project is bound to Helix Core or Subversion.

    See Unlocking Files.

  • Get Latest Version Opens the Get Latest Version dialog, which lets you "get" files from source control.

    After you bind a Flare Desktop project to a source control application, you can get the latest version of any of the source control files. When you do this, you are copying the most current files stored in the source control application to your local Flare Desktop project without necessarily checking out the files. This means that the "Read Only" designation will remain associated with the files until you check them out.

    You will see this option if your project is bound to Microsoft Team Foundation Server or Helix Core.

    See Updating or Getting the Latest Version of Source Control Files.

  • Update Opens the Get Latest Version dialog, which lets you update files from source control.

    After you bind a Flare Desktop project to Subversion, you can update any of the source control files. When you do this, you are copying the most current files stored in Subversion to your local Flare Desktop project.

    You will see this option if your project is bound to Subversion.

    See Updating or Getting the Latest Version of Source Control Files.

  • Undo Check Out Opens the Undo Check Out dialog, which lets you reverse the check-out of the files.

    If you have files checked out from source control but do not want them checked out anymore, you can use the "Undo Check Out" option instead of checking in the files.

    You will see this option if your project is bound to Microsoft Team Foundation Server.

    See Reverting or Undoing a Checkout of Source Control Files.

  • Revert Opens the Revert dialog. You can return files to their last known state.

    If you have modified files from source control but do not want to keep your modifications, use the "Revert" option instead of committing the files. While committing the file would save changes to source control, reverting a file returns it to its previously committed state and does not commit any of your new changes to source control. When reverting changes made in Git, you only revert changes to the file on the branch you are currently editing. If you have a file that resides on multiple branches, copies of the file on other branches are preserved.

    This is available if your project is bound to Git, Helix Core, or Subversion.

    See Reverting or Undoing a Checkout of Source Control Files.

  • Show Differences Opens a window pane that lets you view the content and code differences for files. If you select a single file and choose this option, the differences between the local version of the file and the source control version of the file are shown. If you select two files and choose this option, the differences between those two files are shown.

    You will see this option for all source control providers.

    See Viewing Differences in Source Control Files.

  • View History Opens the History dialog, which lets you view the history of a particular source control file, including all of the occasions when the file has been checked in. You can then use the dialog to view the differences between older versions of the file or roll back to a particular version.

    You will see this option for all source control providers.

    See Viewing the History of Source Control Files and Rolling Back to an Earlier Version of a File.

  • Undelete Undeletes a file, allowing you to add it to source control. You will see this option if your project is bound to Microsoft Team Foundation Server or Helix Core. See Undeleting Source Control Files.
  • Refresh Refreshes the window pane so that the latest information is shown.

    You will see this option for all source control providers.

  • Pending Changes Opens the Pending Changes window pane. This displays files in the project that are pending check in (if the project is integrated with a source control application). Use this window pane to see which files you have checked out, which files have been created but not yet added to source control, which files other users have checked out, and which files are out of date. For more information see Source Control and Viewing Files With Pending Changes You will see this option for all source control providers.

Note The labels that appear in the Source Control Explorer will vary depending on the source control provider you are using. For information specific to your source control provider, see Source Control.

SharePoint

Opens a submenu, which lets you select various SharePoint options for the selected file(s). See SharePoint Integration.

Send To

Opens a submenu, which lets you open the active file in another application, attach it to an email, or open the Windows folder where it is stored.

Print

Opens the Print dialog, which lets you send a file to a printer. Make sure that the item that you want to print is selected. For example, if you want to print a topic from the Help system, first click somewhere inside the topic so that it is the active element in the interface.

Print Preview

Opens the Print Preview dialog, which lets you see how a document looks before you send it to a printer. Make sure that the item that you want to preview is selected. For example, if you want to preview a topic from the Help system, first click somewhere inside the topic so that it is the active element in the interface.

Properties

Opens the Properties dialog for the selected item.

Recent Files

Displays a list of recently opened files. You can select one from the list to open it. You can also remove files from the list of recently opened files, which lets you keep the list shorter and more manageable. When you use this feature, the file is merely removed from the list, but the actual file is not deleted.

Recent Projects

Displays a list of recently opened projects. You can select one from the list to open it. You can also remove projects from the list of recently opened projects, which lets you keep the list shorter and more manageable. When you use this feature, the project is merely removed from the list, but the actual project is not deleted.

Exit

Closes the application.