Menus

Opens a dialog, which lets you search for and select a Flare project to open so that you can analyze it.

Opens a dialog that lets you choose a particular file to open whenever you launch Analyzer in the future.

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

Opens the Project Properties dialog, which lets you do the following.

• Select a master table of contents (TOC) for the entire project. The TOC will be used for all targets in the project. However, you can also set a master TOC at the target level. If you do that, the TOC specified at on the target takes precedence over the master TOC set at the project level.
• Select a master page layout for the entire project.
• Select a master stylesheet for the entire project.
• Select a language to be used for the project.
• Bind a project to source control.

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.

Saves changes to all of the open files.

Opens a submenu, which lets you select various source control options for the selected file(s):

• 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 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 check in files so that you have a backup in source control.

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

  • 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 option if your project is bound to Git or Subversion.

  • 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.

  • 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 Analyzer project files, you can check them out. Checking out files means to copy the latest source control files to your local Analyzer 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, Microsoft Visual SourceSafe, or Perforce.

  • 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 Analyzer 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 Analyzer 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, Microsoft Visual SourceSafe, or Perforce.

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

    After you bind a Analyzer project to a 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 Analyzer project.

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

  • 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 or Microsoft Visual SourceSafe.

  • 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, you can use the "Revert" option instead of committing the files. While committing the file would save your 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, Perforce, or Subversion.

  • 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, Analyzer 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, Analyzer 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, which lets you select the remote you want to use for a pull and push of files.

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

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

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

    You will see this option if your project is bound to TFS, Perforce, or Subversion.

  • Network Settings Opens the Network Settings dialog, which lets you view and modify source control network settings from Flare.

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

• Add Opens the Add File(s) dialog, which lets you 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.

• Check In Opens the Check In dialog, which lets you 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 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 check in files so that you have a backup in source control.

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

• 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.

• 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 Perforce.

• 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 Analyzer project files, you can check them out. Checking out files means to copy the latest source control files to your local Analyzer 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, Microsoft Visual SourceSafe, or Perforce.

• 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 Perforce or Subversion.

• 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 Perforce or Subversion.

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

  After you bind a Analyzer 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 Analyzer 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, Microsoft Visual SourceSafe, or Perforce.

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

  After you bind a Analyzer project to a 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 Analyzer project.

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

• 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 or Microsoft Visual SourceSafe.

• Revert 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, you can use the "Revert" option instead of committing the files. While committing the file would save your 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, Perforce, or Subversion.

• 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.

• 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.

• Request Check In Opens the Send Request Check-In Message Dialog, which lets you ask another user to check in the selected files so that you can edit them.

  If you discover that another user already has that file checked out, you can automatically send a request to that user to check in the file. This is a completely automated process involving instant messaging or email. Not only are the messages sent to the appropriate individuals automatically, but the mechanisms for checking in and checking out the necessary files are built in to those messages. This means that you and the other authors on your team do not need to hunt down the correct files manually.

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

• Request View File Opens the View File Request dialog, which lets you ask another user to view the selected file.

  If you have finished working on a file and want another user to review it, you can use the "Request View File" option. You can send an instant message or email to the other user with a message. That individual can then quickly open the specified file and send you comments about it.

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

• Undelete Undeletes a file, allowing you to add it to source control. See Undeleting Source Control Files. You will see this option if your project is bound to Microsoft Team Foundation Server, Microsoft Visual SourceSafe, or Perforce.
• 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, which displays files in the project that are pending check in (if the project is integrated with a source control application). In other words, you can 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 the Flare online Help. You will see this option for all source control providers.

Opens the active file in MadCap Flare.

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 online Help, first click somewhere inside the topic so that it is the active element in the interface.

Lets you reverse the most recent action in a file. The undo and redo functions are enhanced in the following ways.

• Unlimited You can undo or redo an unlimited number of times, back to the last time you opened the file, even after you have saved the document.
• Multiple Buffers Each document in the interface has its own Undo/Redo buffer. This means that you can undo actions in one document and then switch to another document and undo actions specific to that file.

Cuts the selection and sends it to the clipboard.

Pastes the selection from the clipboard to the place where the cursor is inserted.

Selects all content in the file.

Opens the Find Elements window pane, where you can search for specific elements, tags, styles, and markup in the open document or the entire project. See Using the Find Elements Feature.

Opens a submenu, which lets you select a toolbar to open or close:

• Standard Opens or closes the Standard toolbar. Tools in the Standard toolbar let you perform basic functions, such as Save, Cut, Copy, Paste, Undo, and Redo. There are also shortcut buttons for performing source control functions, as well as sending documents to other applications (e.g., opening a topic's true code in Notepad in order to edit the tags). To see this toolbar you can select View > Toolbars > Standard.
• Text Format Opens or closes the Text Format Toolbar. The Text Format toolbar lets you quickly apply formatting to content in your topics and other files. To see this toolbar, select View > Toolbars > Text Format.

Opens the Reports window pane, which lets you generate custom reports based on the information contained in your project, for just about any type of information that MadCap Analyzer captures. In addition, you can design the look and feel of reports, save them for future access, and open them in a browser window (where you can print them). See About Reports.

Opens the File Issues Viewer, where you can send selected files to the in order to see any issues associated with them. You can use the File List window pane to quickly add many files to this Viewer, or you can add files one at a time from within the user interface. See Viewing Issues for Specific Files.

Opens a submenu, which lets you open window panes that display suggestions for improving your project.

• Index Keyword Suggestions Opens the Index Keyword suggestions pane, which lets you view a list of topics containing text that matches existing index keywords in your project. You can then quickly add the same index keywords to those topics. See Viewing Index Keyword Suggestions.
• Snippet Suggestions Opens the Snippet Suggestions window pane, which lets you view content that matches existing snippets in your project, and you can quickly convert these occurrences to snippets. You can also double-click a row to open the topic in question, with the potential snippet content highlighted. See Viewing Snippet Suggestions.
• Variable Suggestions Opens the Variable Suggestions window pane, which lets you view regular text that matches existing variables in your project, and then quickly convert these occurrences to variables. You can also double-click a row to open the topic in question, with the potential variable text highlighted. See Viewing Variable Suggestions.
• New Style Suggestions Opens the New Style Suggestions window pane, which lets you view the places in your project where you have used local formatting. MadCap Analyzer suggests that you convert these instances of formatting to new styles. You can use the Create New Style dialog to do just that. You can also double-click a row to open the file where the formatted content exists. See Viewing New Style Suggestions.
• Replace Local Style Suggestions Opens the Replace Local Style Suggestions window pane, which lets you view the places in your project where you have used local formatting. MadCap Analyzer suggests that you replace these instances of formatting with existing styles in your stylesheet that match the formatting that you have applied manually. This is different from a new style suggestion in the following way: With a new style suggestion, the properties in the tag do not match an existing style exactly; therefore, Analyzer suggests that you create a new style. On the other hand, if you make formatting changes that happen to result in an exact match to all of the properties in an existing style, Analyzer suggests that you replace the formatting with that style (rather than creating a new style). See Viewing Local Style Suggestions.
• Accessibility Suggestions Opens the Accessibility Suggestions window pane, where you can search for places in your project where you can make accessibility improvements for WebHelp and PDF outputs in Flare. That way, you can make sure your documentation can be accessed by people with disabilities (i.e., individuals who have visual, hearing, and mobility impairments). This includes the ability to identify tables that are missing certain elements and finding objects—such as images, equations, and QR codes—that are missing alternate text. You can click the "Search Properties" button to customize which types of issues to display in the window pane. You can double-click a row to open the topic or other file in the Analyzer interface. You can also select the row and click File > Send to Flare to open the file in the Flare project. See Viewing Accessibility Suggestions.
• Markup Suggestions Opens the Markup Suggestions window pane, where you can search for places in your project where the XHTML markup (code) can be improved (e.g., empty tags, CDATA tags, empty attributes, excessive spaces). You can click the "Apply" button to automatically apply the suggestions to the selected files. You can click the "Search Properties" button to customize which types of issues to display in the window pane. You can double-click a row to open the topic or other file in the Analyzer interface. You can also select the row and click File > Send to Flare to open the file in the Flare project. See Viewing and Applying Markup Suggestions.
• Writing Suggestions Opens the Writing Suggestions window pane, which lets you view places in your project where you can make writing improvements based on industry-wide standards. For example, Analyzer can locate files where an h1 or h2 heading has only one subheading (i.e., an h1 heading with only one h2 heading under it, or an h2 heading with only one h3 heading under it). It is recommended that you have more than one subheading under a parent heading. Therefore, occurrences such as these are raised as concerns. Analyzer can also locate files where a heading level has been skipped (e.g., an h1 heading is followed by an h3 heading, rather than h2), as well as any files where consecutive headings exist (e.g., an h1 heading is followed by an h2 heading, with no other content between them). You can use the Writing Suggestions Search Properties dialog to customize which types of suggestions to display in the window pane. See Viewing Writing Suggestions.
• Cross-Reference Suggestions Opens the Cross-Reference Suggestions window pane, where you can search for hyperlinks in your project that can be converted to cross-references. You can double-click a row to open the file and proceed to convert the hyperlink into a cross-reference. See Viewing Cross-Reference Suggestions.
• Frequent Segments Opens the Frequent Segments window pane, which lets you view a list of segments that occur frequently in your project. You can see the text, the number of occurrences of each segment, and the number of words and characters in each segment. If you notice that certain segments are repeated numerous times throughout your project, you can easily convert them to snippets or variables. For an example, see About Frequent Segments. Also see Viewing Frequent Segments.
• Similar Segments Opens the Similar Segments window pane, which lets you view a list of segments of text in your project that are similar, but not identical, to each other. You may want to modify similar segments so that they become identical to each other, or even convert them to snippets. You can also use the "Start Search" button to limit or expand the list of similar segments that are displayed. See Viewing Similar Segments.

Opens a submenu, which lets you open window panes showing information related to used elements in your project.

• Used Condition Tags Opens the Used Condition Tags window pane, which lets you view a list of all condition tags that have been applied in files throughout your project. The list shows not only the condition tags, but each file where they have been used. You can also quickly rename or remove multiple condition tag occurrences in a single batch. See Viewing Used Condition Tags.
• Used File Tags Opens the Used File Tags window pane, which lets you view a list of all file tags used in your project. The list shows the tag type and the file that it is associated with. You can quickly rename or remove multiple file tag occurrences in a single batch. See Viewing Used File Tags.
• Used Language Tags Opens the Used Language Tags window pane, which lets you view a list showing each file where a language tag is found, the content tag to which it has been applied (e.g., html, span), and the language used. See Viewing Used Language Tags.
• Used Variables Opens the Used Variables window pane, which lets you view a list of variables that have been inserted in your project. The list shows not only the variables, but each topic where they have been used. You can also quickly rename or remove multiple variable occurrences in a single batch. See Viewing Used Variables.
• Used Index Keywords Opens the Used Index Keywords window pane, which lets you view a list of all index keywords used throughout your project. You can also quickly rename multiple keyword occurrences in a single batch. See Viewing Used Index Keywords.
• Used Concepts Opens the Used Concepts window pane, which lets you view a list of all concepts used in your project. You can also quickly rename multiple concept occurrences in a single batch. See Viewing Used Concepts.
• Used Bookmarks You can view a list showing each file where a link to a bookmark is found, including the name of the bookmark, the kind of link used, and the path of the link. You can also double-click a row to open the file where the bookmark link is inserted. See Viewing Used Bookmark Links.

Opens the Topics for Selected window pane, which lets you view a list of topics associated with a segment (as selected in the Frequent Segments window pane or Similar Segments window pane). This is simply a quick way to open a file where a particular segment exists. See Viewing Topics for a Selected Item.

Opens the Start Page, which is a handy window pane that displays when you first launch Analyzer and remains open unless you close it. You can use the Start Page to open and create projects, access Getting Started resources for new users, select project templates, and more.  See Start Page.

Opens the Pending Changes window pane, which displays files in the project that are pending check in (if the project is integrated with a source control application). In other words, you can 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 the Flare online Help.

Opens the Update Cross-References dialog, which lets you update the cross-references that you have added to topics. By updating the cross-references, you can ensure that they reflect any changes in your project that might affect them.

Updating cross-references is not a mandatory step. When you generate output for a target, all of your cross-references will be updated automatically. However, you can use this feature to manually update cross-references in a single topic. This is a way of performing a "spot check" ahead of time, verifying that cross-references will be updated accurately before you generate the entire target.

Opens the Stylesheet Links dialog, which lets you apply one or more stylesheets to the active content file.

Opens a submenu, which lets you select options for creating concept keywords.

• Concept Window Opens the Concept window pane, which is used to create concepts and insert them into topics.
• Concept Entry Mode Activates the "Concept Entry Mode," which turns your cursor to a small "c" and is a quick way to insert concepts. Use this method to accomplish the same thing as the Concept window pane method. The difference is that, with this method, you do not need to move your cursor from the topic to the Concept window pane. You simply click at the spot in the text where you want to insert the marker and start typing. The words you type are added directly into the Concept window pane.

Opens the Frame Contents window pane, which lets you add content to the selected frame in a page layout.

Activates a feature that lets you check your spelling as you type in your topics. Questionable words are underlined with a jagged red line. You can take action with the word by right-clicking on it. See Spell Checking While Typing.

Opens the Ignored Words dialog, which lets you create a list of words to be ignored when using the spell checking feature in the application.

See About Spell Check and Adding Words to the Ignore Spell Check List.

Closes all files that you have opened in the workspace.

If you select the Dock option when a window pane is active, the Drag Pane area is shown or hidden in the window pane accordingly. The Drag Pane area lets you move the window pane and dock it elsewhere in the program window.

Converts the active window pane or editor to a floating window, which means it is no longer attached to the interface. This is a good option to use if you want to work on two topics side-by-side. If you do not want a window pane or editor to be floating anymore, you can right-click in the title bar and select Dock.

Opens the Help TOC window pane, which lets you locate and access topics in Analyzer's online Help.

Opens the Help Search window pane, which lets you search for information in Analyzer's online Help.

Opens the Help Glossary window pane, which lets you view glossary terms and definitions in Analyzer's online Help.

Opens a new instance of a Help topic in another window.

Lets you manually synchronize the current Help topic with the TOC. In other words, the TOC book containing that topic also opens to show you where the topic resides in the TOC hierarchy. This feature is for topics and TOCs in the output. However, you can do much the same thing in the source files. If you right-click a topic in the Content Explorer or File List window pane, you can select Locate in TOC. This opens the source TOC file and highlights all of the entries where the topic is linked.

Opens the Index Results window pane, which displays links to related topics after you perform a search in the Help index.

Opens a Help topic that lets you access one of the printed guides related to Analyzer. See PDFs.

Deactivates the currently used license for the machine running Analyzer.

Opens the New Updates Available dialog, which lets you download Analyzer updates from MadCap Software.