{"id":3019,"date":"2022-10-31T09:48:29","date_gmt":"2022-10-31T07:48:29","guid":{"rendered":"https:\/\/dox.fi\/?p=3019"},"modified":"2022-10-31T09:48:30","modified_gmt":"2022-10-31T07:48:30","slug":"how-to-adapt-the-webhelp-template","status":"publish","type":"post","link":"https:\/\/dox.fi\/en\/how-to-adapt-the-webhelp-template\/","title":{"rendered":"How to adapt the WebHelp template"},"content":{"rendered":"\n
\"\"
Demo content published as a WebHelp that was modified with a style sheet.<\/em><\/figcaption><\/figure>\n\n

One publishing format that DoX CMS<\/strong><\/a> supports is WebHelp<\/strong><\/a>. They are HTML<\/strong><\/a> publications which are set inside a template that shows the table of contents together with one topic at a time. The template was originally made primarily for our internal use. As such, you must change many details with style sheets when you publish other documents in this format. I will show how to do this in this piece. I will also add this information in our user manual later.<\/p>\n\n

We have also outlined a more comprehensive solution for how users can edit their WebHelp<\/strong><\/a> templates. This solution will let you select the components that your WebHelp<\/strong><\/a> publications will include. For example, you ought to be able to use custom headers and footers like you already can with PDF<\/strong><\/a> publications. In this piece, I will only focus on the currently available methods that involve style sheets, though.<\/p>\n\n

Style sheets are based on CSS<\/strong><\/a>. This piece is helpful mostly to those who have access to someone who can write style sheets. We can also write the required style sheets for our customers when they adopt the system or as a separately billed service.<\/p>\n\n

Default template<\/h2>\n\n
\"\"
The cover page of the user manual for DoX CMS as a default WebHelp publication.<\/em><\/figcaption><\/figure>\n\n

The image above shows what the default template for WebHelp<\/strong><\/a> publications looks like. This image comes from the user manual for DoX CMS<\/strong><\/a>. It shows all the components that can be changed with the methods that I discuss below. This components consist of<\/p>\n\n

  1. default identifiers,<\/li>
  2. the table of contents,<\/li>
  3. the content field,<\/li>
  4. the find field,<\/li>
  5. forward and back buttons, and<\/li>
  6. a default style.<\/li><\/ol>\n\n

    WebHelp<\/strong><\/a> publications include a default style sheet that they use in addition to the style sheets from the style that you selected. You cannot change this style sheet directly. You can, however, change which values apply through other style sheets. Sometimes, such changes must involve the ‘!important’ qualifier as the examples below show. You should make a separate style sheet for the changes related to WebHelp<\/strong><\/a>. You can then use it together with other style sheets as a new style in DoX CMS<\/strong><\/a>. Each style can include more than one style sheet.<\/p>\n\n

    Inspect feature<\/h3>\n\n
    \"\"
    The cover page of the user manual for DoX CMS and the browser’s sidebar after using the Inspect command.<\/em><\/figcaption><\/figure>\n\n

    You can review the different parts of WebHelp<\/strong><\/a> publications and the previews for other publications with the Inspect<\/strong> command on your browser. When you click on a part of the view with the righthand mouse button and select this command, the browser shows the different parts of the view in its sidebar. When you select one of these parts, the browser also shows all the rules related to it in all active style sheets.<\/p>\n\n

    This feature lets you see the identifiers for the different parts of the view and the rules that apply to them at the time. You can also make temporary changes to their style with the browser. You must still add all these changes separately to add them to new publications.<\/p>\n\n

    Default identifiers<\/h2>\n\n

    Because WebHelp<\/strong><\/a> publications were originally added for DoX CMS<\/strong><\/a>‘s user manual, the default template mentions DoX Systems. You can remove them and replace them with more appropriate pieces of text.<\/p>\n\n

    There are two positions for default identifiers: at the bottom of the table of contents and in the upper right corner. The bottom of the table of contents says ‘www.dox.fi | \u00a9 DoX systems’. The upper right corner says ‘DoX Content Management System | DOX USER MANUAL’. You cannot change these pieces of texts direcrly but you can hide them and replace them with content that you add in a nearby position.<\/p>\n\n

    How the default identifiers were replaced in the pictures across this piece is shown below:<\/p>\n\n