Learn the simple form-like easy-to-fill authoring environment of Simplified XML view in FrameMaker.
The Simplified XML view allows you to easily author DITA (1.3 and 1.2) topics without requiring the knowledge of how your document structure is set up. This view allows for faster authoring as you are given a simple form-like easy-to-fill authoring environment. Also, the structure of your application is maintained by placing elements at the right location and within valid XML tags.
To author content in the Simplified XML view:
Note: The following procedure uses the example of authoring in a DITA topic. However, the steps are applicable for other types of DITA topics (task, concept, reference, or troubleshooting).
-
Select the Enable Simplified XML View option in the Preferences dialog.
-
Click the Author View button in the Application bar.
The view changes to the Simplified XML view.
-
Create a new DITA topic.
Note: By default, the insertion point is placed in the Title field.
-
Enter the topic title.
Note: If you invoke the Insert Object pop-up by pressing Crtl+1, you are shown a list of all elements that are available in the current document. However, if you try to insert an invalid element, FrameMaker blocks the insertion.
-
Use the down arrow key to move the cursor to the Short description field and enter a short description for the topic. In the case of a short description, however, you can apply character formatting such as bold, italic, underline, and teletype. To do so, select the text in the Short description field and change the formatting.
For example, to mark a part of the text as bold, select the text and do one of the following:
To remove the bold formatting from the text, select the text and use any of the above mentioned ways.
Perform the same steps to enter the author name in the Enter your name field.
Note: You can move in between the various form fields by using the arrow keys.
-
Move the cursor to the Content of your topic field.
By default, the first element available in the Content field is the paragraph. This implies that if you start typing, the text is wrapped inside the paragraph tag in the background.
Note: If the cursor is visible but you are unable to type text, this implies that typing text is not valid at the current location. You are shown a pop-up prompting you to either press Enter and select an object or select an object from the Quick Element toolbar.
-
Use the QET or the Insert Object pop-up to insert elements.
Note: If you try to insert an item that is not valid at the current location, then the authoring environment automatically identifies such operation and allows you to add the selected element at the next valid location.
The following section provides more details on inserting and using the available objects.
Working with objects in Simplified XML view
This section explains the various ways to work with the most commonly used objects.
Work with ordered and unordered list
-
To create an ordered or unordered list in the document, choose the corresponding button in the QET.
-
To create a new list item, place the insertion point at the end of the current item and press Enter.
-
Within a list item, to insert an object (such as an image or a table), use the QET or the Insert Object pop-up.
-
To convert between ordered list and unordered lists, place the insertion point anywhere inside the list and choose the alternate list type from the QET.
-
To exit a list, place the insertion point at the end of the last list item and press the Enter key twice or click the Navigate To End Of Form Element button in the QET.
-
To insert a list item between two lists, either place the insertion point at the end of the first list item or at the start of the second list item and press Enter.
-
To split a list item into two items, place the insertion point where you want to split an item and press Enter.
-
To split a list into two, place the insertion point at the end of the first list item and press Enter twice. A new paragraph is created between the lists.
You can use the Tab, Shift tab keys or List Indent, List Outdent button in the QET to indent (nest) or outdent list items:
-
To indent a list item, place the insertion point at the start of the list item and press Tab. Or, place the insertion point anywhere in the list item and click List Indent.
Note: The operations performed by List Indent and List Outdent buttons also work with partially selected text.
-
To reduce the indent of the list item, place the insertion point at the start of the list item and press Shift + Tab. Or, place the insertion point anywhere in the list item and click List Outdent.
-
If a list has multiple items, to nest some of the items in the list, select the items and press Tab or click List Indent.
-
To reduce the indent of any item in a nested list, place the insertion point at the start of the list item and press Shift + Tab. Or, place the insertion point anywhere in the list item and click List Outdent.
Note: If you reduce the indent of any item in a nested list, the other items remain nested.
Work with tables
-
If you insert a table in your topic, the Simplified XML view displays a Table anchor that allows you to easily select, expand, or collapse the table.
-
To insert elements after the table, click the Navigate To End Of Form Element button in the QET.
- To add rows or columns to the table, click in a table cell next to where you want to add the row or column, choose , and specify the number of rows or columns you want to add. You can also move rows or columns within the same or different tables, and sort the rows or columns in a table. For more information, see Table rows and columns in the Tables chapter.
-
To add a new row to the table, click Tab at the last column of the last row.
-
To move across cells in the table, you can use Tab, Shift+Tab, or arrow keys.
-
To move the table, you need to click on the Table anchor and then drag-and-drop the table. You can also select and move (drag-and-drop or copy/cut/paste) table rows and columns, within or across tables.
Work with images
-
When you are working in a DITA topic, concept, or reference document, click the Figure button in the QET or select the Figure object from the Insert Object pop-up to insert an image.
-
When you are working in a DITA task or troubleshooting document, then click the Image button in the QET or select the Image Data object from the Insert Object to insert an image.
-
In the Insert Graphic dialog, enter the following details:
File Path: click Browse and select the image file that you want to insert.
DPI: select the DPIs (or resolution) from the drop-down menu or enter the resolution at which you want to insert the image.
Title: (optional) For a DITA topic, concept, or reference document, enter the title or caption for the image. The Title field is not available when you are working on a DITA task or troubleshooting type document.
Note: If you do not specify the Title, then the graphic is wrapped inside the Image element in the background and you will not be able to add a Title later on. However, if you add a Title, then the graphic is wrapped inside the Figure element allowing you to change the Title anytime later.
Alternate text: (optional) enter the text that is displayed in case the image is not published.
-
If you create a DITA task topic, then you are allowed to insert a graphic in the Procedure title, Short description, and Procedure steps fields. This is because in the task topics, the graphic is wrapped inside the image element.
-
If you insert an image, the Simplified XML view displays an anchor that allows you to easily select, expand, or collapse the image.
-
To move the image, you need to click on the Image anchor and then drag-and-drop the image.
-
To resize an image, click to select the image object (not the Image anchor) and drag a side handle to change either the width or height.
-
To view the object properties of the imported graphic, right click the graphic and choose . To view object properties of the anchored frame, click on the anchor and choose .
Work with MathML
-
You can insert MathML equations in DITA 1.3 document types (topic, task, concept, reference, and troubleshooting.)
-
To insert a MathML equation, click the MathML Container button in the QET.
-
If you insert a MathML equation in your topic, the Simplified XML view displays an Equation anchor that allows you to easily select the MathML equation.
-
To move the MathML equation, you need to click on the Equation anchor and then drag-and-drop the equation.
Work with Definition List
-
You can insert a definition list element by clicking the Definition List button in the QET.
-
To insert a definition list entry, click the Definition List Entry button in the QET.
-
To insert elements after a definition list, click the Navigate To End Of Form Element button in the QET.
Work with code block
-
You can insert a Code Block element by clicking the Code Block button in the QET.
-
To insert elements after a code block, click the Navigate To End Of Form Element button in the QET.
-
If you want to apply teletype (monospace) formatting to you content, select the desired text and click Teletype, monospaced button in the QET.
Use Paste and Smart Paste
FrameMaker automatically creates valid structure if you copy and paste content from external applications such as MS Word, Excel, or a browser. However, if pasting an external content results in an invalid DITA file, a prompt appears asking you to either copy the content without formatting or copy one block at a time.
You can also drag-and-drop content within a document. However, if you try to place the dragged content at an invalid location, FrameMaker will show a red icon and block the operation.
Open and save XML files in the Simplified XML view
You can open any DITA topic in the Simplified XML view. If the topic includes elements that are not defined in the form, then these elements will be shown but they will be uneditable. You can make changes to the editable content and then save the topic.
FrameMaker provides out-of-the-box support for DITA topic, task, reference and concept. However, any XML file for which the corresponding structured application is configured with the Simplified XML view configuration file can be opened in this view. If the configuration file is defined but template is not specified, the default template defined in the structured application is used and a message is shown in the console when you switch to the Simplified XML view. For more details, see Customize the Simplified XML authoring environment.
Note: You cannot open DITA maps, FrameMaker books, or .fm files in the Simplified XML view.
