Structuring Documents with FrameBuilder

Process

• Preparing to structure
  • Do I need to use mifmucker?
  • Getting started

Preparing to structure

Do I need to use mifmucker?

• Figures are anchored in paras that contain only the figure anchors and are tagged as Graphic paras
• Figure captions are below the figures
• Side-heads are in the main text flow, not anchored frames
• Tables are anchored in paras that contain only the table anchors and are tagged as Table paras
• Table captions are in Table Titles which are part of the FrameBuilder tables--not in separate paras above the tables

Getting started

Take one file through the entire conversion process to get a feel for how all the parts work together in producing the online document.

1. Open the documents listed below in Builder (on bipod or icarus).
   • The document to be structured
   • The chapt.struct template The template can be opened by clicking on the following items starting at the main menu bar:

     File -> New -> Convex/ -> small/ -> chapt.struct

     You must save the template before Builder allows you to use it as a source for any import.

2. (Optional) Remove the current character and paragraph formats of the document to be converted. Skip this step if you are already using the newest chapt.struct template.
   1. Select Format -> Characters -> Catalog.
   2. Select Format -> Paragraphs -> Catalog.
   3. Select the Delete button from one of these windows.
   4. In the resulting window, repeatedly select Delete until all formats are removed.
   5. Select Done in the window from Step 4.
   6. Repeat steps 3, 4, and 5 for the second formats catalog.

3. (Optional) Import the formats from the chapt.struct template. Skip this step if you are already using the newest chapt.struct template.
   1. Select File -> Import -> Formats from the menu bar.
   2. Make sure that all 12 options in the resulting
      Import Formats window are selected so that everything is updated properly.
   3. Select chapt.struct (or the name of your copy of the chapt.struct template) in the box labeled "Import from Document:".
   4. Select the Import button.

4. (Optional) Import the element definitions. Skip this step if you are already using the newest chapt.struct template.
   1. Select File -> Import -> Element Definitions.
   2. Make sure that the option in the Import Element Definitions window is selected.
   3. Select chapt.struct (or the name of your copy of the template) in the box labeled "Import from Document:".
   4. Select Import.

5. (Optional) If you are going to use mifmucker on the file, save and close the file.

6. (Optional) Run mifmucker on the Builder file to be structured, file.bld, by entering the following command line:

   % mifmucker -l -v 4.0 fixhead writemif file.bld
   	

   Running mifmucker on Frame 3.1 files eases the transition to Frame 4.0 templates. mifmucker is covered in more detail in the "mifmucker" section.

   See the "Do I need to use mifmucker?" section to determine if your documents require using mifmucker.

7. Go through the document checking for modified paragraphs. The box below the menu bar displays the paragraph type for the current paragraph. If there is an asterisk next to the paragraph type, the paragraph format differs from the standard. Re-apply the appropriate paragraph tag to the modified paragraph.

8. Change the document manually so that the structure rule table (SRT) wraps as much as it can.
   • Nonbold monospace characters should be tagged with the Cmd character font.
   • Bold monospace characters should be tagged with the Input character font.
   • Italic characters should be tagged with the Emphasis or the Var character font.
   • User input paragraphs should be tagged as InputN, InputN8, InputW, or InputW8 paragraphs.
   • Tables must be anchored in otherwise-empty paragraphs that are tagged Table.
   • Graphics must be anchored in otherwise-empty paragraphs that are tagged Graphic.

   Examine the SRT to better understand the relationship of the character and paragraph tags to the elements. See "The structure rule table (SRT)" section for more information.

Please submit comments and questions about these pages to scox@convex.com