Flare What's New
Following are new features included in this release of Flare.
The Preview window pane is dynamic, allowing you to keep the preview open while you work and see changes as you make them in the XML Editor.
You can use the following methods to open the Preview window pane:
Local Toolbar Open a topic, snippet, or master page. Then in the local toolbar of the XML Editor, click . If you click the down arrow, you can choose a target; otherwise, the preview opens according to the settings in the primary target (e.g., with the appropriate conditions already applied).
- Ribbon Open a topic, snippet, or master page. Then open the View ribbon and select Preview Window. Like the button in the local toolbar, this option also has a down arrow from which you can choose a specific target.
- Right-Click To preview a topic, snippet, or master page that is not open, you can right-click the file in the Content Explorer and choose Preview.
Initially, the window pane opens as a floating window. This can be quite useful if you are working with dual monitors, because you can drag the Preview window pane to one monitor while editing the topic in the other monitor. However, you always have the option of docking the Preview window pane to the interface.
The Preview window pane updates when any of the following take place:
- A content file (i.e., topic, snippet, master page) is opened.
- A change is saved in the XML Editor.
- The refresh button in the window pane is clicked.
- The File, Target, or Conditional Expression fields in the window pane are updated.
The Conditional Expression field has been available previously, but the File and Target fields are new in this version.
The File field lets you select any other topic, snippet, or master page in your project. When you select a file in this field, the Preview pane shows a preview of it. You do not need to open the file in the XML Editor.
The Target field lets you select any target in the project. When you select a target, the current preview changes accordingly, showing the content using the settings (e.g., conditions) in that target.
The Conditional Expression field lets you include or exclude any conditions manually by clicking . For example, you might find this useful if you’ve added a new condition to the project and want to see how some topics will look once that condition is included or excluded. Rather than changing the target file, you can test the condition in the Preview window pane first. Flare will remember the manual condition as you open one content file after another so that you do not need to select the condition each time you move to a different file. You can click to reset the conditional expression to the target settings.
A lock button is also new to the Preview window pane. By enabling the lock button, you can continue to show the preview for one file while opening others in the XML Editor. After you click the button again to remove the lock, the window pane updates to show a preview for the current file.
Let's say you are working on a topic. You want to use the Preview window pane to see how the topic will appear using different settings in your project.
When you first open the Preview window pane, the preview looks as follows, with the primary target settings applied:
Now you want to see how the topic will look when you build the Print target. You select the Print target from the Target drop-down. The preview changes to reflect the new settings.
Next, you want to see what would happen if you excluded the Audience A condition in the Print target. You click the Conditions button and make your changes in the Conditional Text dialog.
After you click OK, the preview settings change, and Audience A is excluded.
Finally, you want to preview a different topic than the one currently open in the XML Editor, so you select that topic in the File field. The new topic opens in the Preview window pane.
Clean XHTML produces basic HTML files that are free of MadCap-specific tags and not dependent upon other MadCap-generated files. The output does not include any skins, search, navigation, or other extra features; it is simply your single-sourced content. This allows you to re-purpose your output in many flexible ways (e.g., you can embed the output files into other applications, such as project management tools, wikis, or eLearning systems). You might also perform other types of post-processing tasks with the output.
Following are some important points to keep in mind with this output type:
- Single-Sourcing Flare’s unique features are applied during compilation so that you still end up with single-sourced output.
- MC Tags All mc tags and data-mc tags are removed, including keywords, concepts, conditions, etc.
- Namespace The MadCap namespace is removed.
(see About Scripts)will not automatically be removed when you generate Clean XHTML; if you want to exclude these custom scripts, you must do so manually (i.e., by deleting them or using conditions).
- Images/Multimedia Images and other multimedia remain as separate files in the output and are included in the topics by reference.
- MadCap Styles All MadCap-specific styles are removed from the user stylesheet.
Convert to Inline Styles In the Target Editor (General tab), there is an option to convert stylesheet styles to inline styles.
If you choose this option, the output folder will not include stylesheet files. That’s because the styles have been integrated into the topic files.
If Option Is Not Selected
If Option Is Selected
Output Content/Resources Folder:
Output Content/Resources Folder:
You can now pin your favorite variables, making them easily and quickly accessible for future use.
After you insert a variable, it is added to a group of your 20 most Recently Used Variables. You can pin any variable found in this group.
Three variables have been added to the Pinned Variables group. Other recently used variables can still be seen in the Recently Used Variables group; you can add any of these variables to the Pinned Variables group at any time.
To pin a variable, open the Variables dialog (Insert>Variable), or in the local toolbar of the XML Editor you can click the down arrow next to the Insert Variable button . Hover over the variable you want to pin and click the little pin. Pinned variables are added to the Pinned Variables group in alphabetical order.
To unpin a variable, just click the pin again and it will be moved back to the bottom of the Recently Used Variables group.
Note: Variables must appear in the Recently Used Variables group before they can be pinned. If the variable you want to pin does not appear in the Recently Used Variables group, you can add it to a content file by dragging it from the Project Organizer or using the Variables dialog.
Note: You can expand or collapse the Recently Used Variables and Pinned Variables groups by clicking the arrows next to each group name.
In previous versions of Flare, you would need to manually change the labels for a table of contents (TOC) entry when you edited the title of its linked topic. If you forgot to make changes to the TOC entry, you would end up with topic titles that were inconsistent with the entry in the TOC. Starting in this version of Flare, you can use new system variables to ensure that your TOC entries are always in sync with your topic titles.
When you drag a topic into a
This doesn’t mean that the text will show up as blue in the output. Instead, what it means is that the
It means that the
It can also be changed in the markup.
If the title for the topic changes, the
If your topic doesn’t have a title (and it doesn’t have to), Flare will then use the first heading it finds in the topic instead.
And if it doesn’t find a heading, it will use the file name for the topic.
You can keep the
In the Properties dialog for the entry, you can click next to the Label field to open the Variables dialog. You can choose the LinkedHeader variable if you want the
You also have the option of choosing the LinkedFile variable if you want to force it to use the file name.
And finally, you might decide not to use a variable at all and simply type text manually for the label, in which case the text will be black in the
Note: These variables can also be used when creating browse sequences.
Note: The LinkedFile and LinkedTitle system variables are different from the Title and SourceFile system variables. While the LinkedFile and LinkedTitle variables show information for the linked source file, the Title and SourceFile variables show information for the file where the variable is inserted. If you use Title or SourceFile in your TOC, you will see the TOC's title or file path in the TOC entry.
Note: If you click the label in the TOC or open the Properties dialog, you will see the variable syntax.
When adding a new file to a project, you can
In the Add File dialog, expand the Attributes area at the bottom. Then next to the Condition Tags or File Tags field, click and select the relevant conditions or file tags.
When importing Microsoft Word files that contain equations, you can convert them from Office Math Markup Language (the format used in Word) to MathML (the web standard and Flare format). If you disable this option, equations from Word are converted to images.
Note: To use this feature, the equation must have been created in Microsoft Word 2007 or newer. Also, open the Options dialog (File>Options), select the General tab, and make sure that Import/Export Word Files without MS Office is disabled.