Format User Module Help To Display In The Clarius Help Pane - Keithley 4200A-SCS Reference Manual

Hide thumbs Also See for 4200A-SCS:

Table of Contents

Section 8: Keithley User Library Tool (KULT)

Format user module help to display in the Clarius Help pane

If your user module includes a help description, but it is not set up for HTML, when you create a UTM

in Clarius, the Help pane displays the Open UTM Comments button. If you click this button, text from

the Description tab in KULT is displayed in an ASCII browser window.

You can set up this help to display as formatted HTML in the Help pane using PHP Markdown Extra

tools. On the first line of the description, add the following stylesheet and MarkdownExtra code:

href="http://clariusweb/HelpPane/stylesheet.css">

In order to see the help in Clarius, you must compile the UTM and rebuild the library after entering the

Markdown code.

To format the text, you can use some of the following options:

Create a first level heading: Place ===== under a line to center and bold the line. (You can use

any number of = characters.)

Create a second level heading: Place -------- under a line to bold the line. (You can use any

number of - characters.)

To create list: Insert a blank line before the start of the list, then use 1., 2., and so on to number

each item in the list.

Italicize text: Place * before and after the text to be italicized.

Display text in a fixed-width font: Put 6 spaces before each line of the text or use four tilde

characters (~~~~) before and after the lines of text.

You can make changes to the .c file of the user module with KULT or a text editor. After saving

changes, you can refresh the Help pane to view the changes. To refresh the help pane, select

another project tree object and then return to the UTM.

An example of the code entered in the Description tab is shown in

page 8-22). An example of the result in the Help pane in Clarius is shown in

(on page 8-26).

For information on additional formatting options, refer to the PHP Markdown Extra website of

(https://michelf.ca/projects/php-markdown/extra/).

Based on Markdown

Model 4200A-SCS Parameter Analyzer Reference Manual

Michel Fortin

(https://michelf.ca/).

Daring Fireball

(https://daringfireball.net/).

Documenting the user module

Checking the user

4200A-901-01 Rev. C / February 2017