ClickHelp User Manual

Quick Parts

Quick Parts are small content extracts that you can insert into your content. They help you speed up routine tasks like inserting certain repeated pieces of content throughout your documentation. You can create a Quick Part from any piece of your content, including Variables, Snippets, Conditional Blocks, and many more.

To quickly jump to a certain section of this topic, use the following links:

By default, there are more than ten Quick Parts available in ClickHelp, including Info Box, Warning Box, Show More element, and API quick parts.

Unlike Snippets, Quick Parts are pieces of content that are directly inserted into the topic. After you insert a Quick Part, it becomes a part of the topic content so that you can modify it in place. It's like inserting content from the clipboard.

Quick Parts are shared on a portal scale, which means every user has the same Quick Parts list. There are no project-specific or user-specific Quick Parts. 

Create a Quick Part

To create a new Quick Part, perform a few simple steps:

  1. Select the content in your topic you want to create a Quick Part from.
    If you want to create a Quick Part from custom HTML, read the instruction below.
  2. Select the Insert tab on the ribbon and click the Create From Selection button in the Quick Parts group. Alternatively, hit Ctrl+Q (Command-Q on MacOS)
    The Create from selection button on the Insert tab of the Ribbon bar
  3. The Create Quick Part dialog will appear
    The Create Quick Part dialog
    • You will need to specify the name of the Quick Part. If you specify (or select from the list) the name of an already existing Quick Part, then the existing Quick Part will be overwritten with the new one.
    • You can click the Show Quick Part source link to see the HTML of the Quick Part. You can also edit it if you need to change something on the fly or clean up the markup.

Insert a Quick Part

The process of inserting a Quick Part is pretty straightforward:

  1. Switch to the Insert tab of the ribbon and click the Insert button of the Quick Parts group.
  2. Click on the necessary Quick Part from the list.

The Quick Part will be inserted at the location of your text cursor.

Edit a Quick Part

It's not possible to edit an already existing Quick Part, but you can replace it with a new one:

  1. Create a new topic. Delete all of the content from it.
    This step is necessary to make sure no extra HTML accidentally gets into your Quick Part source.
  2. Insert the Quick Part into the topic.
  3. Edit it to your liking.
  4. Switch to the Source mode and copy the edited source HTML of the Quick Part.
  5. Switch back to the Design mode and select everything (Ctrl+A).
  6. Click Create From Selection in the Insert tab of the ribbon.
  7. In the popup, click Show quick part source.
  8. Replace the source that is currently in the input area with the one you have copied in step 4.
  9. Enter the name of the Quick Part you were editing. It will prompt you that the existing Quick Part with that name will be overwritten.
  10. Click OK.

​Rename a Quick Part

As with editing, it's not currently possible to rename an existing Quick Part. Here's what you can do to achieve it, though:

  1. Insert the Quick Part into the topic
  2. Select it in the topic
  3. Click Create From Selection in the Insert tab of the ribbon
  4. Enter a new name for the Quick Part
  5. Delete the old Quick Part

Delete a Quick Part

Any user of the Contributor user type except Reviewers can delete a Quick Part.

If you delete a Quick Part, it will be deleted for everyone in your portal. 
  1. Hover over the specific Quick Part in the Insert Quick Part popup
  2. Click the delete button (trash can icon).
    Click the Delete button to delete a quick part

API Docs Quick Parts

ClickHelp provides several typical elements popular in API docs out of the box. Aside from being available in the Quick Parts insert menu, API-related Quick Parts are also available on a separate tab on the ribbon:

The API Docs tab of the Ribbon bar

This is a great starting point that you can use to jumpstart your API docs writing process. You can use these building blocks to quickly assemble typical API documentation topics. For example, Member Table can be used for describing both request parameters and response fields.

If you delete an API Docs Quick Part from the Insert Quick Part menu, you won't be able to insert it by clicking the corresponding button on the API Docs tab of the Ribbon bar. You will need to create a Quick Part with the corresponding name to restore the ribbon buttons' functionality.

Quick Parts Frequently Asked Questions

Can I customize API docs quick parts?

Yes. Since these elements are Quick Parts, you can customize them both in terms of layout and style. To learn how to modify Quick Parts, refer to the corresponding section above.

To change the look & feel of API Docs Quick Parts, look for the corresponding CSS rules added automatically with the portal upgrade to your projects style files under the section titled /* API Docs Elements - begin */.

Can I create new API docs quick parts?

Yes. Just like with any other Quick Parts, you can add API docs Quick Parts in the same manner. To learn how to do this, refer to the corresponding section above

When you create custom API Docs Quick Parts that are not provided out of the box, they will not appear as buttons on the ribbon in the API Docs tab.

 How are quick parts different from snippets?

While the difference between Quick Parts and Content Snippets may not be obvious at the first glance and they may seem similar, they are very different in their nature.

Quick Parts Snippets
Quick Part's markup becomes a part of the topic markup on insertion Snippet's markup becomes a part of the topic markup on publish
Stored in your portal data, outside of topics Need to exist as individual topics
Can be edited upon insertion Can not be edited in the topic they are inserted in
If one of the inserted Quick Parts is edited in a topic, the changes are made only to the edited instance When an original Snippet is edited, the changes are reflected in every inserted instance of this Snippet in all Projects

I have accidentally deleted a quick part, what do I do?

You can always create a new one following the instructions above. You can find some of the default Quick Parts HTML in our Knowledge Base.

How do I create a quick part from custom HTML?

  1. Select anything in the topic to activate the Create From Selection button.
  2. Click Create From Selection.
  3. In the popup, click Show quick part source link.
    The Show quick part source link in the Create Quick Part dialog
  4. Replace the source with your custom HTML.
  5. Do not forget to specify Quick Part's name and hit OK.