ClickHelp Documentation

Code Highlighting

ClickHelp User Manual/Authoring/Topic Editor/Insert Tab/Code Highlighting

ClickHelp supports highlighting for code examples through a special Code Sample element. You can insert code examples in dozens of languages: JavaScript, XML, HTML, CSS, ASP.NET, Bash (Unix Shell), etc.


Inserting Code Samples

To insert a code block with highlighting, do the following:

  • Go to the Insert tab of the editor's toolbar.
  • Click the Code Sample button.
    The Code sample button on the Insert tab of the Ribbon bar
  • The Insert Code Sample dialog will open to select the language, layout and enter the code.
    The Insert code sample dialog
  • If you want to insert a code example without highlight enabled, select Code in the Language dropdown.
  • Click OK when you're done.

Here is what the code sample will look like for the readers:

The code sample in the Reader UI

Tip
You can use the Code language from the dropdown to insert code samples in languages not supported by ClickHelp. The code highlighting is not enabled in this case. 

Editing Code Samples

To edit the code, you can use either of the methods:

  • Double-click your Code Sample block.
  • Click the Code Sample block and select the Edit Code Sample context menu command.
    Click the Change code sample link to edit the code sample
  • Click the Code Sample block and then click the gear icon in the Tag Inspector.
    Click the gear icon in the Tag inspector to change the code sample
  • Click a Code Sample block and then click Code Sample on the Insert tab of the ribbon bar.

Deleting Code Samples

To delete a code sample, click it and then select the Remove Code Sample context menu command.

Copy Code From Code Sample

If you or your readers want to copy the code, click the Copy Code button.

The Copy code button of the code sample

Display Code in Multiple Languages

If you want to provide the same code excerpt in multiple programming languages, you can utilize Tabs. You can read more on how to achieve this here: Code Samples in Multiple Programming Languages.

The code sample in multiple programming languages

Tip
It's recommended to use the Code only layout within tabs to hide everything except the code.