What's New?
Flare What's New
Following are the new features available in this release of Flare.
If you are integrating your Flare project with Git source control, you can now merge branches and revert commits you have made in branches.
In previous versions of Flare you could merge individual files bound in Git. Now you can merge Git branches as well.
When you view the Source Control Explorer for your Git-bound project, you will see a Merge Branch button at the bottom of this pane.
On the Source Control ribbon, there is also a Merge button to handle merges between your Git branches.
If you are working in Content Explorer, you can right-click on a folder or file and select Merge.
-
Do one of the following, depending on the part of the user interface you are using:
- Ribbon Select the Source Control ribbon. In the Project section, select Merge.
- Right-Click If you have the Content Explorer or Project Organizer window pane open, right-click on any file or folder and select Source Control > Project > Merge.
- Source Control Explorer Click the Merge Branch button.
The Select branch to merge dialog opens.
-
From the drop-down list, select the Git branch you wish to merge into the active branch.
-
Click OK. A dialog will display the status of the merge in progress.
- When the merge operation is completed, a dialog will display indicating the merge was a success. Click OK to close the dialog.
Example—No Conflicting Changes
Let's say you have two feature branches that are bound in Git source control.
In the first feature branch (e.g., develop-feature1), you are making changes to the "Getting Started" topic. These changes are specific to the first feature being developed.
In the second feature branch (e.g., develop-feature2), you also make changes to the "Getting Started" topic. These changes are specific to the second feature being developed, and are being made in a separate part of the topic from the develop-feature1 changes.
After you complete your changes on the second feature branch, you decide you want to merge your changes from the first feature branch to the second feature branch.
In the Source Control Explorer, you select the develop-feature2 branch. Then, you click the Merge Branch button. Finally, from the drop-down list of branches, you select the develop-feature1 branch.
You click OK to merge. Since the changes took place in different sections of the "Getting Started" topic, the merging of the first feature branch into the second feature branch is successful.
Example—Conflicting Changes
Let's say you have two feature branches that are bound in Git source control.
In the first feature branch, you are making changes to the "Getting Started" topic. These changes are specific to the first feature being developed.
In the second feature branch, you also make changes to the "Getting Started" topic. The changes are made to the same paragraph as those you made for the first feature branch.
In the Source Control Explorer, you select the develop-feature2 branch. Then, you click the Merge Branch button. Finally, from the drop-down list of branches, you select the develop-feature1 branch.
You click OK to merge. Since the changes took place in the same paragraph in the "Getting Started" topic, you get a dialog indicating conflicts exist. You then click Yes to resolve the existing conflicts.
On the Resolve Conflicts dialog, you click Auto Merge All.
However, the auto merging is not successful. You click OK, then Resolve to fix the remaining conflicts.
When the Resolve Version Conflict dialog displays, you choose to Merge changes in merge tool. This will allow you to view the specific conflict taking place rather than accepting either the local or the server changes.
The Merge Changes dialog opens. The left pane is the file version on your local machine, while the right pane is the server version. The bottom pane displays how the file will display as you make your changes.
As you review the text, you notice the conflict icon next to the "Do This" bullet point. You decide to keep the server version in the right pane by right-clicking on the conflict icon and selecting Keep Change.
Notice that when you keep the changes on the right pane, the conflicting changes in the left pane are now disabled and outlined in gray.
Note: As you resolve conflicts in the merge tool, you can also left-click on the Conflict icon on either the local or server pane to keep the change. If you left-click on the icon again, it will toggle the change to be accepted on the opposite pane of where you are clicking.
Once you have reviewed all of the conflicts and made your changes, you click OK. At this point, you need to commit the changes that resolved your conflicts. You then type in your comment used to resolve the conflict, and click Commit.
When your changes are committed, you can now merge this branch. With the develop-feature2 branch selected, you click the Merge Branch button. You then select the develop-feature1 branch from the drop-down list. You click OK to merge. A confirmation dialog displays when the merge is completed.
The merge will also be displayed in the Branch History dialog.
Note: If your Flare project is dual-bound in both Central and Git, you will not be able to create branches. But you can merge branches that were created before the project was dual-bound.
A revert is a type of commit that undoes a prior commit on your branch. Reverting becomes necessary if changes have been made that are no longer needed. For example, if you have committed changes for a feature branch that is no longer going to be included in a release, then those changes need to be reverted.
An advantage of reverting a prior commit on your branch is that it will back out any unwanted changes. If other writers are making changes on the same branch, any reverted commits will be picked up by the other writers when they pull from that branch. See Pulling Files from a Remote Repository—Git.
But one disadvantage of reverting commits in your branch is that it will remove part of your branch history. The revert removes the part of your branch history that contained the commits that were undone.
The Commit history dialog allows you to view and revert specific commits within your branch. You can also undo any branches that were merged.
The following columns are displayed in the Commit history dialog:
- Commit Type This indicates the type of changes checked in on the branch. You can view when a branch was started, when a commit was made, or when a merge occurred.
- Branches This column displays the branches that are affected by the action taken. If the changes affect more than one branch then all of the affected branches are displayed in this column.
- Commit This alphanumerical code provides the commit number used by Git.
- Commit Time This displays the date, followed by the time the commit was made in your Git branch.
- Author This displays the name of the author that committed the specific change in the branch.
- Comments This column displays the comments made for each commit.
- In the Source Control Explorer, select your branch containing changes that you want to revert.
-
In the Source Control ribbon, click Branch History. The Commit history dialog opens.
- Select the row that contains the commit you want to back out.
-
Click Revert.The Accept reverted modifications dialog is displayed.
- Click Accept.
- A confirmation message confirms the revert was successful. Click OK to close this dialog.
You can now exclude JavaScript files from your HTML5 output. This might be helpful if you are using products like Fortify and Veracode to run security scans on your output, as having these JavaScript files in your HTML5 target might cause issues when viewing your output.
How to Exclude JavaScript Files from Generated Output
- In the Project Organizer, expand Targets and double-click your HTML5 target. The Target Editor opens.
- Click the Advanced tab.
-
Remove the check mark next to the Include JavaScript for CSH field.
- Click
to save your work.
Note: If you choose not to include JavaScript files in your HTML5 output, you will not be able to perform CSH calls using the JavaScript method. However, you can still make CSH calls using URLs.
If you plan to bind a Flare project to a MadCap Central license, you can now choose between a couple of transfer protocol options when performing the binding. This includes binding new projects or importing existing projects from Central. It does not affect existing projects that are already bound.
How to Select a MadCap Central Transfer Protocol
- Select File > Options. The Options dialog opens.
- Select the Source Control tab.
- Under MadCap Central Transfer Protocol, select one of the following:
- SSH Also called “Secure Shell,” this is a network protocol that allows you to communicate remotely and securely between computers.
- HTTPS Hypertext Transfer Protocol Secure (HTTPS) is a more secure version of HTTP, which is the standard protocol for transferring data over the web.
Some companies might prefer HTTPS, but SSH could be necessary for binding especially large projects to Central.
- Click OK.
Following are features that will be removed in the next release of MadCap Flare, alongside features that we recommend as replacements.
|
Deprecated Features |
Recommended Replacements |
|---|---|
|
DotNet Help targets DotNet Help Viewer |
HTML5 targets See About HTML5 Output. |
|
FrameMaker targets |
PDF or Word targets See About PDF Output and About Word Output. |
|
Third-party source control plug-in support |
One of the other natively supported tools (e.g., Git, Perforce, Subversion) or MadCap Central (uses Git) See About Source Control and About MadCap Central and Flare. |
|
Visual SourceSafe support |
Team Foundation Server (if you want to continue with a Microsoft solution), one of the other natively supported tools (e.g., Git, Perforce, Subversion), or MadCap Central (uses Git) See About Microsoft TFS, About Source Control, and About MadCap Central and Flare. |
|
WebHelp Mobile targets |
HTML5 targets With responsive skins in HTML5, output displays appropriately depending on the size of the device—web, tablet, or mobile. See About HTML5 Output. |
|
XHTML Book targets |
Clean XHTML or HTML5 targets |
To provide feedback on these deprecated lists, please send an email to supportplanrep@madcapsoftware.com.