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.
[Menu Proxy — Headings — Online — Depth3 ]
How to Open the Editor
- Open the Content Explorer.
- Navigate to a topic, snippet, or template page.
- 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)
- Characters and Symbols (Insert)
- Code Snippets (Insert)
- Condition Tags (Apply)
- Cross-References (Insert/Edit)
- Drop-Down Text (Insert/Edit)
- Equations (Insert/Edit)
- Expanding Text (Insert/Edit)
- Formatting—Local (Apply)
- Hyperlinks (Insert/Edit)
- Images (Insert/Edit)
- Index Keywords (Insert/Edit)
- Keyword Links (Insert/Edit)
- Locate in Content Explorer
- Locate in TOC
- Micro Content (Create)
- Multimedia (Insert/Edit)
- Popups (Insert/Edit)
- Preview
- Proxies (Insert)
- Related Topics Links (Insert/Edit)
- Responsive Layouts (Create/Edit)
- See Also (Concept) Links (Insert/Edit)
- Slideshows (Insert/Edit)
- Snippets (Create/Insert/Edit)
- Styles (Apply)
- Tables (Insert/Edit)
- Togglers (Insert/Edit)
- Variables (Insert)
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
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. |
|
|
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. 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. |
|
|
Opens the Insert Hyperlink dialog, which lets you insert a text hyperlink on the selected text in the topic. |
|
|
Opens the Insert Cross-Reference dialog, which lets you insert a cross-reference into the topic at the location of the cursor. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
|
|
|
Expands all tags in the editor (i.e., blocks of content), so that you can see any content that was previously collapsed. |
|
|
Collapses all heading tags in the editor (and the content under them). An ellipsis icon |
|
|
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. |
|
|
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:
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. |
.This ensures you are always seeing the most current content in the Preview window pane.

