HelpSmith Topics
Making Help Authoring a Pleasure To Do

How do I format code in my help file?

I need to paste some code examples to my help file, which should be formatted according to the style used in a specific programming language (e.g. PHP, Python, HTML, etc.) for function names, variables, keywords, etc.

But when I copy/paste the code into a topic, it is displayed as plain text.

How do I format the code in help documentation with the appropriate styles?

23

Comments

How do I format the code in help documentation with the appropriate styles?

Use the Syntax Highlighter tool

You can use the HelpSmith's Syntax Highlighter tool to format program code in a topic:

Write tab|Syntax Highlighter

For more details, you can also visit:

https://www.helpsmith.com/webhelp/topics/using-syntax-highlighter.htm

Formatting program code

19

Edit syntax highlighting schemes: formatting, colors, etc.

Please note that the Syntax Highlighter allows you to customize the schemes for specific languages.

To edit the syntax highlighting schemes:

  • On the Write tab, in the Program Code group, click the lower half of the Syntax Highlighter button.
  • In the popup menu, click Customize.

Syntax Highlighting Settings

15

Add a Comment

Please Login or Register or leave comments.

Hello World
Lorem ipsum dolor sit amet
OK
Login
Nickname or Email:
Password:
If you do not have an account, you can register.