• To access an HTML view of the Steps to Reproduce and Workaround fields, click in the text and then click the HTML coding ( <> ) icon in the toolbar.

Link Construction

When creating links, construct useful clickable links.

• When providing a sample URL:
  
  • use as replaceable variable text in the URL where an instance name is needed: eg: https:///nav_to.do?uri=...
    
  • or use only the part of the URL without the domain name, eg: /nav_to.do?uri=...
    
  • Be sure not to include internal instance names in articles with the Audience set to Public.
• Do not style sample URLs as if they were clickable links. Remove any automatic insertion of the tags surrounding the URL. They should appear as regular article text.
• Do not use the link text "here." For example, instead of saying "For more information about creating a table, click _here_," say "For more information, see the product documentation topic _Create a table_."
• For links to product documentation, use the documentation topic title as the link text rather than the URL.
• Set the link to open in a new window/tab so it does not replace the open article in the current window/tab. Within the tags, include target="_blank" as well as the href= URL.

• Headings: if you need to separate your content in different sections, use the Heading levels (HTML

  to

  tags) available in the drop-down labeled "Paragraph". You should only use the levels from 3 downwards because the names of the article template sections are already level 3 (

  ), for example, Description and Additional information. For consistency, we should only use Heading 3, 4, 5, and 6 if needed. For clarification, this content pre-dates the Table of Contents feature, and is primarily intended to reference templates which are not using a Table of Contents.

• Apply typographic styling by using the icons in the toolbar:
  
• Do NOT change the default font by using any of the fonts available in the font type drop-down. Doing this will affect the consistency of the look and feel of the knowledge base. The only exception is the use of the monospace font Andale Mono when needed (code samples, log output, property names, etc.), as described in the typesetting conventions (see KB0623104 in the Additional Information section).
  
• Many items in the interface are usually bolded (for example, field names, menu option names, button names, and the like).
• For commands or small code examples, consider using a monospace font. (Select the text and choose the preferred "Andale Mono" from the Font Family drop-down menu in the toolbar.)
  For larger code examples or script snippets, consider using the "Preformatted" paragraph style available in the toolbar, a boxed format with a monospaced font. (Use the

   HTML element rather than constructing a table.)

• Don't use colored text or a larger font for emphasis. Instead, use a bold font, italic text, or a combination of both, always keeping in mind the HI KB Article Typesetting Conventions - KB0623104
• To access an HTML view of the article fields, click in the text area and then click the HTML coding ( <> ) icon in the toolbar.