NetHelp Theme Designer Settings (Tabs and Accordion)

The Theme Designer settings can all be edited in the Settings area on the right side. To find the field you’d like to edit, select it in the area on the left. The Settings area will display the field you need to edit.

For global settings (General, Context-Sensitive, Toolbar, and Accessibility), use the drop-down to display those fields.

The General settings are global settings for this theme.

  • Right-to-Left If selected, the theme text direction will be set for right-to-left languages. If you choose the Hebrew configuration file (settings.he-il.xml) for this theme, this check box will be selected automatically.
  • Update title Switches the header title displayed on the browser tab from the topic title to the title of the project. If you would like the browser tab to remain static, rather than changing as the user navigates the output, select this check box.
  • Favicon Specifies which icon will appear in the browser when your users mark your NetHelp as a favorite.

The context-sensitive settings are global settings for this theme.

  • Title The title used in the browser window title when a list of keywords, groups, or search results is shown on the page. This string can contain macros #{key} and #{value} that are replaced with the context-key ("keyword," "group," "id," or "search") and context-value. Default: "Topics for #{key}: #{value}"
  • Not found message This message is shown when the result is empty (when the context-key is "keyword," "group," or "id"). Default: "No topics found"
  • Not supported message This message is shown when the specified context-key is not supported. Default: "The key "#{key}" is not supported"

The accessibility settings are global settings for this theme. See Accessibility.

  • Link menu header This text is read by the accessibility device if a keyword or group link has more than one topic to display. Default: "#{count} topics found"
  • Closed book This text is read by the accessibility device when you mouse over a closed book that has no associated topic and, therefore, does not display a topic when clicked. Default: "Closed book without topic"
  • Open book This text is read by the accessibility device when you mouse over an open book that has no associated topic and, therefore, does not display a topic when clicked. Default: "Open book without topic"
  • Closed book with topic This text is read by the accessibility device when you mouse over a closed book that has an associated topic, which is displayed when the book is clicked. Default: "Closed book with topic"
  • Open book with topic This text is read by the accessibility device when you mouse over an open book that has an associated topic, which is displayed when the book is clicked. Default: "Open book with topic"
  • Topic This text is read by the accessibility device when you mouse over a topic. Default: "Topic"
  • Collapsed section This text is read by the accessibility device for the collapsible section icons. Default: "Click to expand"
  • Expanded section This text is read by the accessibility device for the expanded section icons. Default: "Click to collapse
  • Skip to main content This text becomes available to users when they open a topic and press TAB. After users encounter this option, they can press ENTER to bypass the navigation.

The button settings control the label, icon, behavior, and text displayed on the buttons of the NetHelp toolbar. The default buttons included in the NetHelp toolbar are: Previous, Next, Home, Print, Email, and Powered By.

If you would like to remove, rearrange, change the alignment, or add a custom button to the NetHelp toolbar, use the Toolbar (toolbar.topicTop) fields.

  • Label The name that will be used for the label and tooltip text of the button.

    • prev Default: "Previous"

    • next Default: "Next"

    • home Default: "Home"

    • print Default: "Print"

    • email Default: "Email"

      The email address used for this button is support@mycompany.com by default. This should be changed in the Help Targets dialog.

    • twitter Default: "Twitter"

    • facebook Default: "Facebook"

    • poweredBy Default: "Created with Doc-To-Help"

      The button also includes a default click action that opens the a website. This click action can be edited.

  • Icon The icon displayed on the button. You can choose an alternate icon, upload your own (see Adding Custom Icons to a NetHelp Theme), or have no icon display.
  • Show Label If selected, the label text will be displayed on the button.
  • Click (for poweredBy and Custom buttons only) JavaScript code of the onclick event handler.

The toolbar settings control which buttons are included in your NetHelp toolbar and how they are displayed. You can remove and rearrange the buttons, as well as add custom buttons. The alignment of the buttons can also be changed.

If you would like to change the NetHelp toolbar button labels, icons, and other options, edit the Buttons fields.

  • Align Controls the alignment of the NetHelp toolbar buttons. By default, they are aligned right, but can be changed to left or center.

  • Content This field is used to add, remove, and rearrange the buttons in the NetHelp toolbar. Click the Wrench button in this field to open the Edit Toolbar Buttons dialog.

    • To Edit a Button Select it, then click on the Wrench button to open that button’s properties for editing.
    • To Delete a Button Select it, then click the – button. If you remove a default button (Previous, Next, Home, Print, Email, Powered By, etc.), you can easily add it back by clicking the + button You cannot remove buttons that were defined in other Settings files. See Using the Settings List Editor for Localization and More.
    • To Add a Custom Button Click the + button.
    • To Rearrange the Buttons Use the up and down arrows.
    • To Start a New Button Group Click the Start Group of Buttons button.
  • Visible If selected, the header area will be visible.
  • Height Adjusts the height of the header, in pixels.
  • Logo Image Inserts an image in the upper left of the header. The image will be copied to the Theme folder on your computer: C:\Users\[username]\Documents\My Doc-To-Help Projects\Doc-To-Help\Themes\NetHelp 2.0\[Name of Theme]\images.
  • Show Text If selected, the project title will displayed in the header.
  • Apply stylesheet The jQuery or Wijmo stylesheet rules are applied in the Topic area.
  • Text width Used to manually set the width of the text (in pixels) in the topic window. By default, it is set to 0, which means the text will adjust to fill the window.
  • Not found text The message when a topic cannot be loaded. Default: "Topic not found"
  • Not found title Window title displayed when topic can't be loaded. Default: "Topic not found"
  • Icon Choose the icon that will appear before each subtopic link.

Breadcrumbs are the trail of topics at the top of the Topic area.

  • Visible If selected, breadcrumbs will be displayed.
  • Include current topic If selected, the current topic will be displayed in the breadcrumbs.
  • Label The text label that will be shown before the breadcrumbs. Default: no label
  • Separator The character or text displayed between breadcrumb items. Default: "/"

The button labels and icons for the Expand All, Collapse All, Expanded Section, and Collapsed Section buttons in the topic. See Creating Expanding/Collapsing Sections.

  • Default Label for the Expand All Button "Expand All"

  • Default Label for the Collapse All Button "Collapse All"

For all four buttons, you can choose alternate icons, upload your own (see Adding Custom Icons to a NetHelp Theme), or have no icon display.

  • Message text The text that displays in the spinner animation while the topic is loading. Default: "Loading …"
  • Label The text displayed on the TOC tab or accordion button. Default: "Contents"
  • Icons The icons displayed in the table of contents for a topic, closed book, or open book. You can choose alternate icons, upload your own (see Adding Custom Icons to a NetHelp Theme), or have no icon display.
  • Label The text displayed on the Index tab or accordion button. Default: "Index"
  • Visible If selected, the index is displayed.
  • Hide empty If selected, the index will automatically be hidden if there are no index keywords in your project.
  • Filter tooltip The tooltip displayed for the Index text box. Default: "Filter keywords"
  • Not found message The message shown when no keywords are found. Default: "No keywords found"
  • Found message The message shown when one or more keywords are found. It can contain a {count} macro that is replaced with the number of keywords found. Default: "#{count} keywords found"
  • More text The text for the link that displays if the keywords don’t fit on the screen and aren’t scrolled. Default: "More…"
  • Label The text displayed on the Search tab or accordion button. Default: "Search"
  • Visible If selected, the Search tab or accordion button is displayed.
  • Filter tooltip The tooltip for the Search text box. Default: "Search topics"
  • Help message This text will be shown in a popup when the user clicks the Help button on the Search tab. The logical operators will be replaced with the ones defined in the Operators fields of the Search properties. Default: "You can use logical operators #{and}, #{or}, #{not} Example: football #{or} hockey, sports #{and} #{not} baseball"
  • Loading message This message is shown when the data is loading. Default: "Loading Search Engine…"
  • Error message This message is shown if the data fails to load. Default: "Error: Search engine failed to load"
  • Disabled message This message is shown when search is disabled. Default: "Search is disabled"
  • Not found message This message is shown when no keywords are found. Default: "No topics found"
  • Found message This message is shown when one or more topics are found. It can contain a {count} macro that is replaced with the number of topics found. Default: "# {count} topic(s) found."
  • Correcting message This message is shown when the search engine suggests a search string correction to the user. It can contain a #{query} macro that is replaced with a link to the corrected search string. Default: "Did you mean #{query}?"
  • Query modified message This message displays when the original search criteria had to be changed since no results were returned. Default: "Original search #(query) has been changed because it did not produce results."

The tooltip labels and icons for the Search(go), Help, and Highlight buttons in the Search box.

  • Default Tooltip for the Go Button "Search"

  • Default Tooltip for the Help Button "Help"

  • Default Tooltip for the Highlight Button "Highlight Search Hits"

You can choose alternate icons, upload your own (see Adding Custom Icons to a NetHelp Theme), or have no icon display.

  • Operators The text name of the search operators AND , NOT, and OR.
  • Position The initial position of the splitter, in pixels. Default: 300
  • Collapsed If selected, the side panel (TOC/Index/Search) is hidden by default. The user can reopen the side panel by clicking the "Show side panel" icon.
  • Disabled If selected, the splitter position cannot be changed by the end user.
  • Tooltip: show side panel The tooltip displayed for the show side panel icon. Default: "Show side panel"
  • Tooltip: hide side panel The tooltip displayed for the hide side panel icon. Default: "Hide side panel"

The icons displayed for the splitter, Show side panel, and Hide side panel. You can choose alternate icons, upload your own (see Adding Custom Icons to a NetHelp Theme), or have no icon display.