An implementation guide can (and should) contain narrative pages that explain the use-case for the implementation guide as well as special requirements. You can add these narrative pages in the "Edit Implementation Guide" screen under the "Narrative/Pages" tab.

The content of the pages is markdown. The ToF user interface provides a WYSIWYG editor based on markdown syntax. The WYSIWYG editor supports basic markdown syntax, such as bold, italics, underline, and headings. More advanced markdown functionality (e.g., tables) may not display correctly in the editor, but will be supported during the publish process. The WYSIWYG editor doesn't show the tables; however, they may appear as tables after you publish your implementation guide.

Navigation Menus

You can associate each page in the implementation guide with a top-level navigation menu. Edit the page and specify a name for the top-level navigation menu. When you edit additional pages and begin typing the same menu name, the existing menu name will appear as a suggestion. After publishing the implementation guide, each unique page name will appear as a top-level navigation menu with all pages associated with that menu appearing as options within that menu.

The top navigation menu does not reflect the hierarchy of the pages. The table of contents does reflect the hierarchy of the pages. The table of contents is automatically generated during the publish process. 

Images

To add one or more images to pages in your implementation guide:

  1. Import your images via the "Import" screen. You may drag-and-drop the images into the "File" tab.
    ToF will import these images as "Media" resources. The "id" of the Media resource will be based on the filename of the image. The exact file name will be stored as an "identifier" in the Media.
  2. Ensure your newly imported Media resources are added to the IG's "resources".
    Make sure they are not marked as an example. Leave the "Example" field either "Undefined" or "No". Otherwise, your Media resources will be an example preserved during the export process, which may produce errors during final publication.
  3. Open the page(s) where you want the image to appear and place your cursor where you want the image. Select the "Insert image from predefined list" option in the Markdown editor.
  4. Select the image.
  5. Text will appear at your cursor for the image you selected.

Note: ToF supports the following image types:

  • .JPG
  • .GIF
  • .PNG
  • .BMP

Technical Notes

During the IG export and publish processes, the pages in the IG have to be in a specific order. The first/root page of the IG has to be an index.html file. If the first page in an IG is not an index.html file, then ToF automatically adds one and makes the root page of the IG a child page of the new index.html page.

If the ImplementationGuide resource does not have properties for storing the content of each page, ToF creates contained Binary resources within the ImplementationGuide resource.