XML Editor

The XML Editor is the primary editor for authoring in Flare. It displays when you open a topic, snippet, or template page from the Content Explorer, and provides access to the underlying XML structure of documents in a comfortable visual authoring environment. This editor is used to enter, modify, and format the content that users see in the output. Although this editor lets you produce XML files, you do not need to know anything about XML to use it.

How to Open the Editor

  1. Open the Content Explorer.
  2. Navigate to a topic, snippet, or template page.
  3. Double-click the file that you want to open.

XML Editor Features and Elements

The following are common features and elements that exist in the XML Editor.

[Mini-TOC Proxy — Online — Depth1]

What You Can Do in the XML Editor

In addition to typing content, there are dozens of things you can do in the XML Editor. Following are some of the primary tasks that you can perform.

  • Bookmarks (Insert/Edit) ClosedRead more… A bookmark is a marker, or flag, that lets you create hyperlinks to specific locations within topics (rather than to another topic file in general). You can insert a bookmark at a specific location in your topic (e.g., at a subheading) and then insert a hyperlink that "connects" to that bookmark. This is a useful feature, for example, if you have a somewhat lengthy topic and want the user to be able to locate a specific place in the topic quickly. See Inserting Bookmarks.
  • Characters and Symbols (Insert) ClosedRead more… You can insert special characters or symbols into content. This can be done by using the Character dialog, by inserting a quick character that you have specified, by selecting a favorite character, or by selecting a recent character. See Inserting Characters and Symbols.
  • Code Snippets (Insert) ClosedRead more… You can create and insert code into documentation in dozens of languages. The syntax is automatically highlighted according to the language, similar to text editors such as Sublime Text and Notepad++. In HTML5 output, users can click a Copy button, then paste the code into a third-party editor. See Creating and Inserting Code Snippets.
  • Condition Tags (Apply) ClosedRead more… A condition is a single-sourcing feature that you can apply to files or to different areas of your content, so that some information displays in some outputs but not in others, or it displays only when viewed on a certain device or screen size. See Applying Conditions to Content.
  • Cross-References (Insert/Edit) ClosedRead more… A cross-reference is a dynamic navigation link that lets you connect one topic to another (or a bookmark within a topic). Cross-references are somewhat similar to text hyperlinks. However, cross-references differ from hyperlinks in a few ways. (1) They are based on format commands that help you keep the look of links consistent. (2) They are especially useful for print output because they let you automatically refer to specific areas and/or page numbers in the output. (3) Both the source and destination files must be part of the same target output within the same project.See Inserting Cross-References.
  • Drop-Down Text (Insert/Edit) ClosedRead more… Drop-down text is a feature that lets you click a hotspot to expand and collapse specified content below it. See Inserting Drop-Down Text .
  • Equations (Insert/Edit) ClosedRead more… From any location in a topic or snippet you can insert an equation. Although an equation may be composed of many different parts, in the XML Editor it renders as a single block of content. In that way, it behaves much like an image.See Inserting Equations.
  • Expanding Text (Insert/Edit) ClosedRead more… Expanding text is a feature that lets you click a hotspot to expand and collapse content that appears after it in the same paragraph or other block element. See Inserting Expanding Text.
  • Formatting—Local (Apply) ClosedRead more… When you edit the content of a topic, you are working in the XML Editor. Sometimes called “inline formatting,” local formatting is a way to change the look and feel of content directly so that the changes are applied only to that specific content (as opposed to applying the changes throughout your project via the use of styles). However, using styles is recommended instead of local formatting when possible. See Local Formatting.
  • Hyperlinks (Insert/Edit) ClosedRead more… A text hyperlink is one of the most basic forms of a navigation link. It is simply a hyperlink applied to text. When an end user clicks the hyperlink in the output, the location specified in the hyperlink opens. The location can be another topic in the project (including a bookmark within that topic), a topic in an imported HTML Help file, or a file outside of the project (such as a website on the internet). See Inserting Text Hyperlinks.
  • Images (Insert/Edit) ClosedRead more… You can insert images into content files (e.g., topics, snippets). Flare supports the following types of raster and vector image files: BMP, EMF, EPS, EXPS, GIF, HDP, JPG, JPEG, PDF, PNG, PS, SVG, SWF, TIF, TIFF, WDP, WMF, XAML, XPS. See Inserting Images.
  • Index Keywords (Insert/Edit) ClosedRead more… Unlike some features in Flare, there is no independent index file in your project that becomes the index in your output. Instead, the index is automatically generated when you build output, based on index keywords that you insert into content files in your project. See Inserting Index Keywords.
  • Keyword Links (Insert/Edit) ClosedRead more… A keyword link is a Help control that lets you open topics related to the current topic based on index keywords that they share. See Inserting Keyword Links.
  • Locate in Content Explorer ClosedRead more… If you have a content file open in the XML Editor and want to quickly find where it is stored in the Content Explorer, you can right-click in the file and select Locate in Explorer. Flare opens the Content Explorer, expanding folders to show where the file is located. See Locating Files in the Content Explorer or Project Organizer.
  • Locate in TOC ClosedRead more… If you have a topic open in the XML Editor and want to quickly find where it is linked in a table of contents, you can right-click in the file and select Locate in TOC. If the topic is located in more than one TOC, a dialog opens, listing all of those TOCs. Select the TOC you want to look in and click Open. See Locating Topics in TOCs.
  • Micro Content (Create) ClosedRead more… Micro content is short, concise information that stands alone and is easily consumable. In Flare, it begins with the creation of a collection of brief phrases and corresponding responses, such as questions and answers. After generating HTML5 output, these phrase/response combinations can be used in different ways as users interact with your output. For example, it can greatly improve the user experience when people search in your HTML5 output. It can also be used to create field-level context-sensitive Help. See Micro Content and Creating Micro Content.
  • Multimedia (Insert/Edit) ClosedRead more… Not only can you explain concepts and tasks to users in your project, but you can also show and tell them through the use of multimedia (video and audio). You can insert links to YouTube and Vimeo movies; files such as Flash, Windows Media, and Quicktime; MadCap Mimic video files; and 3D models. See Multimedia.
  • Popups (Insert/Edit) ClosedRead more… A text popup is a link that opens a popup box containing basic text that you provide. A topic popup is a text hyperlink that opens a topic or external file (such as a website) in a popup box. See Inserting Text Popups and Inserting Topic Popups.
  • Preview ClosedRead more… You can quickly see how a topic (as well as a snippet or template page) will look in the final output by previewing it. 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. See Previewing Topics.
  • Proxies (Insert) ClosedRead more… A proxy acts as a placeholder for auto-generated content or content that you have created elsewhere. When you build output, the content takes the place of that proxy. Proxies can be added to regular topics, as well as to template pages. The difference is that a proxy added to a topic will display that information in the output only once (wherever the topic occurs), but if a proxy is added to a template page, the content will show up everywhere that the template page has been applied. Proxies are quite often used for print-based outputs, especially to create navigation-like elements, such as TOCs, indexes, and glossaries. However, proxies can be used in online output as well. They can be especially useful if you are creating HTML5 Top Navigation output, where the traditional Tripane format is replaced by a more modern design that relies heavily on proxies. See Proxies.
  • QR Codes (Insert/Edit) ClosedRead more… You can insert a quick response (QR) code into a content file (e.g., topic, snippet) using the XML Editor. A QR code is a type of barcode that can be read by devices such as smart phones. The data encoded in the QR code can be text, a website URL, an email address, contact information, or SMS (Short Message Service, which is used for sending text messages). Basically, QR codes are a way to bridge the gap between a static print document and search-friendly, more detailed online information at your fingertips. See Inserting QR Codes.

  • Related Topics Links (Insert/Edit) ClosedRead more… A related topics link is a Help control that provides users with list of links to topics that you've specified as being related to the current topic. This is similar to a concept link. You might use a related topics link if you are applying it to a topic that you want to associate with specific topics but you do not plan to reuse the same link in other topics. See Inserting Related Topics Links.
  • Responsive Layouts (Create/Edit) ClosedRead more… Styles and media queries can be used to make your content responsive in HTML5 output. This lets you present information—both its substance and structure—differently depending on the size of the screen or device. Flare provides a Responsive Layout window pane that helps you create this kind of content more easily. You also have the option of using third-party solutions (e.g., Zurb Foundation grid system) by adding the appropriate styles in your stylesheets and topics. See Creating Responsive Layouts.
  • See Also (Concept) Links (Insert/Edit) ClosedRead more… A concept link is a Help control that lets users open topics that you've determined are related to the current topic. It is similar to the related topics link. However, whereas you associate a related topics link with specific individual topics (usually for a one-time use), you associate a concept link with a group of topics (to be reused in different topics). One great benefit of this type of link is that, if you later want to add or delete topics from the group, you only need to do so in one place and the changes are applied to every topic containing that concept link. See Inserting Concept Links.
  • Slideshows (Insert/Edit) ClosedRead more… You can add a slideshow as an alternative way to display content, using navigation controls to move from slide to slide to view different content. Most kinds of content can be placed into a slideshow, including snippets, text, tables, and more. See Inserting and Navigating in Slideshows.
  • Snippets (Create/Insert/Edit) ClosedRead more… A snippet is a chunk of formatted content that is heavily used in single-sourcing. Snippets can include text, tables, images, and whatever else can be included in a normal topic. You can insert snippets into one or more topics throughout your project, thus allowing you to reuse content that is maintained in one place. You can even insert them into other snippets, creating nested snippets. Snippets are not usually intended for single words or very short phrases that change frequently. In those cases, you probably want to use variables instead. See Creating Snippets From Existing Content and Inserting Snippets.
  • Styles (Apply) ClosedRead more… If you are using styles in your project, you can change the look of content simply by applying styles to it. See Applying Styles to Content.
  • Tables (Insert/Edit) ClosedRead more… A table in Flare is much like it is in any word processing program, such as Microsoft Word, or in a printed textbook. It is a group of intersecting columns and rows that you can add to a topic for various purposes, such as comparing different elements. See Inserting Tables.
  • Togglers (Insert/Edit) ClosedRead more… A toggler is a feature that lets users click a hotspot to reveal one or more named elements in a topic. A named element (also called the "toggler target") is a chunk of content that can reside anywhere in the topic. When users click the toggler hotspot, the output reveals hidden content elements. When users click the hotspot again, the content is hidden again. See Inserting Togglers.
  • Variables (Insert) ClosedRead more… A variable is a brief, non-formatted piece of content that can be edited in one place but used in many places throughout your project. They're especially good for text that might change frequently, such as version numbers and dates. Variables are stored in variable sets, which can hold multiple variables. Depending on the template you select when creating a project, Flare may provide you with an initial variable set, but you can add as many additional variable sets and variables as you like. There are different kinds of variables: (1) basic ones that you create, (2) custom date/time variables that you create, (3) system variables (e.g., date and time; titles; page count; Chapter, Section, and Volume numbers), (4) Heading variables, and (5) Running Head variables. Some of these are especially useful for page headers and footers in print-based output. See Inserting Variables.

Buttons and Sections—Top of Editor

This button lets you preview the topic, snippet, or template page. It also lets you see how the topic will look with condition tags associated with it or with specific target settings applied to it. If you click the face of the button, the preview is shown based on the format specified in the primary target. If you click the down arrow, you can select any of the targets in your project from a menu. The preview is then displayed using the output format specified in that target.

In addition, the preview updates as you save changes in your file; when you open a new content file (i.e., topic, snippet, template page); when you change the File, Target, or Conditional Expression fields; and when you click the refresh button Refresh the active window pane..This ensures you are always seeing the most current content in the Preview window pane.

For more information see Previewing Topics.

Note The topic preview feature is not available for Microsoft Word formats.

Opens the Conditional Text dialog, which lets you associate condition tags with a file while you edit it. This is similar to the feature that you can use to preview a document with certain conditions set. The difference is that this associates the conditions to the document as you edit it in the XML Editor. See Associating Conditions to a File While Editing.

Flare provides multiple layout modes when working in the XML Editor: Web Layout, Web Layout (Tablet), Web Layout (Mobile), and Print Layout. This lets you see your content in the format that you are most likely concerned about at the moment. See Layout Modes.

The default and print mediums are tied to the Web Layout and Print Layout modes, respectively. The tablet and mobile media queries are tied to the Web Layout (Tablet) and Web Layout (Mobile) modes, respectively.

The key is to select the layout first. If you select the medium or media query, the layout will not automatically change as well.

Clicking the down arrow on this button lets you select a medium or media query so that you can view the topic with a specific set of styles.

This drop-down field is simply intended to show you how particular styles make a topic look. By using this feature, you are not telling Flare to use that medium in the output for that topic. The way to do that is to associate the medium with a target.

When (multiple) displays, that is an indication that multiple styles are applied, and content in the XML Editor is rendered with all applicable styles (according to the width). However, if only one medium is selected, then that medium is shown in the drop-down.

For more information, see Mediums and Media Queries and Selecting Mediums and Media Queries.

If you are viewing content using the Print Layout in the XML Editor, you can use this drop-down in the local toolbar to choose a specific page layout. See Selecting a Page Layout to View Content in the XML Editor.

Opens the Insert Hyperlink dialog, which lets you insert a text hyperlink on the selected text in the topic. See Inserting Text Hyperlinks.

Opens the Insert Cross-Reference dialog, which lets you insert a cross-reference into the topic at the location of the cursor. See Inserting Cross-References.

Opens a dialog, if you click the face of the button. You can use this dialog to insert an image. If you click the down arrow on the button, a drop-down opens, where you can access your pinned images and recently used images. See Inserting Images.

Opens the Insert Snippet Link dialog, if you click the face of the button. You can use this dialog to insert a snippet. If you click the down arrow on the button, the Insert Snippet drop-down opens, where you can access your pinned snippets and recently used snippets. See Inserting Snippets.

Opens the Variables dialog, if you click the face of the button. You can use this dialog to insert a variable. If you click the down arrow on the button, a drop-down opens, where you can access your pinned variables and recently used variables. See Inserting Variables.

Opens the Character dialog, if you click the face of the button. You can use this dialog to choose a character to insert or perform many other tasks. If you click the down arrow on the button, you can select other options, such as inserting a quick character or choosing one of your favorite or recent characters. See Inserting Characters and Symbols.

Activates Index Entry Mode. Click in the text where you want to insert the keyword and start typing. The words you type are added directly into the Index window pane. Use this method to do a lot of indexing all at once, without performing any other tasks in the topic or snippet. See Inserting Index Keywords.

Activates Concept Entry Mode. Click in the text where you want to insert the keyword and start typing. The words you type are added directly into the Concept window pane. Use this method to create concepts in a lot of topics at once, without performing any other tasks in the topic. See Inserting Concepts.

Turns paragraph and space markers on and off. When you turn this feature on, you can see markers that show where paragraphs end and where space exists before and after content.

If you click the face of this button, all of the content changes, showing the XML tags surrounding the content. If you click the down arrow, you can select the following options.

  • Caret Tag Neighborhood ClosedRead more… Turns the caret tag neighborhood feature on and off (it is off by default). See Caret Tag Neighborhood.

  • Markers ClosedRead more… Turns markers on or off in the active topic or other content file. See Markers.

  • Inline Markers ClosedRead more… You can show or hide markers for all inline elements in the active topic. See Inline Markers.

  • Block Structure Bars ClosedRead more… Shows or hides the tag block bars. These bars are displayed to the left of the content area. They show the different tags for your chunks of content (i.e., block-level tags), as well as the overall tag structure. See Structure Bars.
  • Span Structure Bars ClosedRead more… Shows or hides the span bars representing inline tags. These bars are displayed at the top of the content. See Structure Bars.
  • Expand/Collapse ClosedRead more… Enables or disables the feature to collapse and expand tags in the XML Editor. See Collapsing and Expanding Tags.
  • Horizontal Ruler ClosedRead more… Shows or hides a measurement ruler horizontally at the top of the editor or window pane. If you click the ruler after it is opened, you can select to convert the ruler to pixels, points, centimeters, inches, or ems.
  • Vertical Ruler ClosedRead more… Shows or hides a measurement ruler vertically at the left of the editor or window pane. If you click the ruler after it is opened, you can select to convert the ruler to pixels, points, centimeters, inches, or ems.
  • Layout Resizer ClosedRead more… Shows or hides the layout resizer at the top of the editor. When enabled, you can click the controls on the resizing slider or enter a breakpoint value in pixels, points, centimeters, inches, or ems to alter the width setting.
  • Invisible Tags ClosedRead more… Turns invisible tags (e.g., <title>) on or off in the active topic. This option is enabled only if you have selected "Show tags."
  • Comments ClosedRead more… Turns comment tags on or off in the active topic. Comment tags are those that you have added to a topic in order include notes behind the scenes (without the comments being seen in the output).
  • Thumbnail Images ClosedRead more… Toggles between showing images in the XML Editor as thumbnails or at full size. This is a feature for you as the author, allowing you to scale all images down to 48 pixels high (if the original size is larger than that). This lets you see more content and less of your images as you edit topics. The images are only scaled for your editing purposes; they are not necessarily shown as thumbnails in the output. See Showing Images as Thumbnails While Editing.
  • Tags in Mono-Color ClosedRead more… Lets you choose whether to display tags in a color or in black. This option is enabled only if you have selected "Show tags."
  • Tags in Mono-Font ClosedRead more… Lets you choose whether to display all tags in the same font or in the font actually applied to each area. This option is enabled only if you have selected "Show tags."
  • Object Positioning ClosedRead more… Turns object positioning on and off. Object positioning can be used with text boxes, images, and other objects that you have inserted into topics. If this option is on, you can easily position the object in different places in the topic (e.g., to the right or left of the frame on a page). See Object Positioning.
  • Orphan/Widow Control ClosedRead more… Turns widow and orphan control on or off. If this is turned on, you can see the effects in the Print Layout mode in the XML Editor. Widow control determines the minimum number of lines in a paragraph to be left at the top of a page or column. Orphan control determines the minimum number of lines in a paragraph to be left at the bottom of a page or column. The default number of lines for both is 2, but you can adjust this setting. See Widows and Orphans and Setting Widow and Orphan Control.
  • Hidden Elements ClosedRead more… Shows content that has been designated as "hidden." In other words, you can have a style where the "display" property value is set to "none." Normally, content to which this style is applied will not be seen. But you can display that content by selecting this option.
  • Conditions ClosedRead more… If you have created and applied condition tags, clicking this button toggles between showing and hiding them.
  • Snippet Conditions ClosedRead more… If you have created and applied snippet condition tags, this command enables or disables a marker that overlays snippets that have snippet conditions applied to them. See Using Snippet Conditions.

  • Variable Names ClosedRead more… Lets you choose whether to see the names of variables in your markers (if you have inserted variables) in the active topic. See Visual Cues for Variables.

  • Variable Highlighting ClosedRead more… Lets you choose whether to see a gray background behind variable definitions in a topic. See Visual Cues for Variables.

  • Bookmark Names ClosedRead more… Lets you choose whether to see the names of bookmarks in your markers (if you have inserted bookmarks) in the active topic.
  • Named Elements ClosedRead more… Lets you choose whether to see the yellow flag icon next to named elements in your markers (if you have inserted named elements) in the active topic. Named elements are used for inserting togglers into topics.
  • Locks ClosedRead more… Locks or unlocks the content designated with the gray background. After content has been locked, it cannot be edited, and annotations cannot be added to it. See Locking Elements.
  • Locked Elements ClosedRead more… Lets you show or hide the gray background associated with elements that have been locked or selected to be locked. See Locking Elements.
  • Changes ClosedRead more… Displays any tracked changes or annotations (notes) that have been attached to any content in the topic. See Reviews and Collaboration.
  • Marker Width ClosedRead more… Lets you adjust the width of markers in the active topic to see more or less of the markers when they are visible.

Expands all

Expands all tags in the editor (i.e., blocks of content), so that you can see any content that was previously collapsed.

Collapses all

Collapses all heading tags in the editor (and the content under them). An ellipsis icon displays under the main heading. As an alternative to collapsing all tags, you can hover to the left of each block of content and click the angled arrow to collapse just that part.

Opens the file in the Internal Text Editor (for review packages only).

Buttons and Sections—Bottom of Editor in Web Layout Mode

Words

Displays the number of words in the open file. If you highlight words in the file, this area shows you how many words are selected out of the total count. If a file contains snippets, the words from those snippets are not included in this word count, because those are separate files.

Reduces the scale of the font by 10% each time you click the button.

Resets the scale of the font to 100%.

Increases the scale of the font by 10% each time you click the button.

Lets you select a specific percentage to scale the font.

Shows or hides the colored shading of content to which condition tags have been applied.

Example Your condition tag has blue associated with it and you have applied this tag to a block of content. When you click this button to show the indicator, the block of content becomes shaded with a lighter version of blue. If more than one condition is applied to the block of content, the shading appears in a pattern that shows all of the applied condition colors.

Shows or hides the tag block bars. These bars are displayed to the left of the content area. They show the different tags for your chunks of content (i.e., block-level tags), as well as the overall tag structure. See Structure Bars.

Shows or hides the span bars representing inline tags. These bars are displayed at the top of the content area.

Example If you have a block of text that is bold and you click it, you will see a "b" in a bar above.

See Structure Bars.

Enables or disables the feature to collapse and expand tags in the XML Editor.

Shows or hides a measurement ruler horizontally at the top of the editor or window pane. If you click the ruler after it is opened, you can select to convert the ruler to pixels, points, centimeters, inches, or ems.

Shows or hides a measurement ruler vertically at the left of the editor or window pane. If you click the ruler after it is opened, you can select to convert the ruler to pixels, points, centimeters, inches, or ems.

Shows or hides the layout resizer at the top of the editor. When enabled, you can click the controls on the resizing slider or enter a breakpoint value in pixels, points, centimeters, inches, or ems to alter the width setting.

Buttons and Sections—Bottom of Editor in Print Layout Mode

Words

Displays the number of words in the open file. If you highlight words in the file, this area shows you how many words are selected out of the total count. If a file contains snippets, the words from those snippets are not included in this word count, because those are separate files.

Displays the first page of the topic in Print Layout mode.

Displays the previous page of the topic in Print Layout mode.

Displays the next page of the topic in Print Layout mode.

Displays the last page of the topic in Print Layout mode.

Displays the current page of the topic, as well as the total number of pages in the topic. You can enter another number in the field or use the arrow buttons to navigate to a different page.

The Zoom/Scale button (which looks different depending on the current selection) opens a drop-down menu so that you can select from the following options:

  • 100% Displays the page at 100% of its actual size.
  • 100% (2 pages) Shows two pages of a topic at a time, displaying each one at 100%.
  • Fit Width Resizes the page so that it displays in proportion to the width of the window pane.
  • One Page Displays only one page at a time.
  • Two Pages Displays two pages at a time.
  • Four Pages Displays three pages at a time.
  • Eight Pages Displays four pages at a time.

Note This option is available only if you are working in Print Layout mode. In this mode, additional pages are automatically created when you add content beyond that which can be held on a single page.

Reduces the scale of the font by 10% each time you click the button.

Increases the scale of the font by 10% each time you click the button.

Lets you select a specific percentage to scale the font.

Shows or hides the colored shading of content to which condition tags have been applied.

Example Your condition tag has blue associated with it and you have applied this tag to a block of content. When you click this button to show the indicator, the block of content becomes shaded with a lighter version of blue. If more than one condition is applied to the block of content, the shading appears in a pattern that shows all of the applied condition colors.

Shows or hides the tag block bars. These bars are displayed to the left of the content area. They show the different tags for your chunks of content (i.e., block-level tags), as well as the overall tag structure.

Shows or hides the span bars representing inline tags. These bars are displayed at the top of the content area.

Example If you have a block of text that is bold and you click it, you will see a "b" in a bar above.

Enables or disables the feature to collapse and expand tags in the XML Editor.

Shows or hides a measurement ruler horizontally at the top of the editor or window pane. If you click the ruler after it is opened, you can select to convert the ruler to pixels, points, centimeters, inches, or ems.

Shows or hides a measurement ruler vertically at the left of the editor or window pane. If you click the ruler after it is opened, you can select to convert the ruler to pixels, points, centimeters, inches, or ems.