Toggle

<< Click to Display Table of Contents >>

Navigation:  Reference > Workspace, Toolbars and Dialogs > The Write Tab > Insert / Insert Object >

Toggle

This dialog is used to insert expanding sections, text and images, known as Toggles, in your topics. There are two versions of the dialog, depending on whether you choose the Expanding Text or Screenshot Toggle option a the top of the dialog.

The Insert Toggle dialog – Expanding Text mode:

DLG_InsertToggle

Insert Toggle dialog options for expanding text:

Export Options:

These options control whether the toggle is expanded or collapsed in your output. Normally, toggles are expanded in print formats (PDF, printed manuals and Word DOCX) and collapsed by default in supported electronic formats.

Note that toggle switching is not supported in Windows Exe or ePUB eBooks and so toggles are always displayed expanded in these formats.

Optional ID:

This is optional and we recommend that you leave it blank. You only need to enter an ID here if you plan to access the toggle IDs in the HTML code of your output for any reason.

If you leave this field blank Help+Manual will give each toggle a unique internal ID. If you enter your own ID you must make sure that each ID in the current topic is unique and you must also edit your IDs manually if you copy your toggles, otherwise you will have ID conflicts.

Caption:

This is the "header" of your expanding section. It is also the active link that the user clicks on to expand or collapse the section. (If you select text before inserting the toggle the text will automatically be displayed here).

Link style:

Selecting this displays the toggle header formatted as a normal hyperlink, deselecting it displays the header as plain text (it is still an active link).

For more details on formatting toggle links see below and in the Formatting toggle links topic.

Tooltip:

Text you enter here is displayed as a mouseover tooltip when the user positions the mouse pointer over the toggle header.

Icon:

This option allows you to choose the image to be displayed to the left of the toggle header. You can choose no icon, one of the three standard icons or use your own icons.

If you choose a standard icon the icon files (one for each state) will be copied to your project or graphics directory the first time you select the function.

If you choose to use your own icons you can then select the graphics for the two icon states in the Collapsed: and Expanded: fields. We recommend storing the icons in your standard graphics folder or your project folder. See below for more details on using your own icons for expanding sections.

Print icons:

The icons used for expanding toggle links are often not appropriate for printed manuals and other print-style documents (PDF, DOCX, iBooks®/ePUB). When you select custom icons you can set a different icon to be used in these formats. Or select Remove icon when printing to publish without an icon.

Toggle a Table:

This option creates an expanding section toggle.

Create a new table:
This is the standard option. It automatically creates a new, single-cell table for the text that you want to expand. This table is inserted directly after the toggle header (caption). The table and the header are both automatically indented by the same amount from the icon.

Toggle the table below this link:
This option is displayed if there is a table directly below the current position and it allows you to toggle an existing table. There can be a maximum of one paragraph of empty space between the toggle header and the table.

Toggle Inline Text:

This option creates an expanding inline text toggle.

Enter your text in the editing box. You cannot enter any formatting in this box. You can enter hard returns with enter for easier editing but they will be ignored in the generated toggle.

Format text with Style:

Applies a style to the expanding inline text, for example to make it stand out against the rest of the text in the paragraph.

The Insert Toggle dialog – Screenshot Toggle mode:

DLG_InsertToggleIMG

Insert Toggle dialog options for expanding images

Export Options:

These options control whether the toggle is expanded or collapsed in your output. Normally, toggles are expanded in print formats (PDF, printed manuals and Word DOCX) and collapsed by default in supported electronic formats.

Note that toggle switching is not supported Windows Exe or ePUB eBooks and so toggles are always displayed expanded in these formats.

Optional ID:

This is optional and we recommend that you leave this field blank. You only need to enter an ID here if you plan to access the toggle IDs in the HTML code of your output for any reason.

If you leave this field blank Help+Manual will give each toggle a unique internal ID. If you enter your own ID you must make sure that each ID in the current topic is unique and you must also edit your IDs manually if you copy your toggles, otherwise you will have ID conflicts.

Picture file name:

This is the full-size image to be used in your toggle. Click on the BTN_Browse Browse button to select an image file directly.

Thumbnail:

Size of the preview image relative to the full size of the image.

Zoom is proportional to document width:

Makes the image responsive in HTML-based output formats. The defined zoom size of the image will then be relative to the current page width. For example, 50% zoom will make the image 50% of the page width, with the height proportional to the width.

Alignment:

Selecting Left or Right positions the preview image to the left or right of the text and flows the text around it. Works the same as the alignment option for normal images.

Padding:

Inserts padding around the image. The values are in pixels.

Tooltip:
Caption:

The tooltip and caption you enter here are normally displayed in both the expanded and the collapsed states. The texts are automatically copied to the When Collapsed: fields, which are grayed out unless you select them to enter different texts there.

The tooltip is displayed when the user positions the mouse pointer over the image. The caption is displayed beneath the image using the standard image caption style.

When collapsed use different settings:

Normally, the toggle will use the same image, tooltip and caption for both the expanded and the collapsed states. You can select the options here to use a different image and enter a different tooltip or caption.

Picture:

Select this option to use a different image in the collapsed state.

Alternatively you can use your own image for the thumbnail version. If you do this you must create this version yourself with Impict or your favorite graphics program. You must create the image with the correct size you want to display – Help+Manual will not zoom the image for you.

Tooltip:
Caption:

Select these options to enter a different tooltip and/or caption for the collapsed state.

See also:

Toggles: Expanding Text and Images