Including Content from Quip Documents

In This Topic

You can create Topics in your project that include content from Quip Documents. Including a Quip Document rather than importing it allows you to continue updating the original Quip Document; the up-to-date content is downloaded and included whenever you Preview a Topic or build the documentation.

Using Quip Documents as the source for Topics in your help system allows you to have stakeholders directly contribute content without having to install and use Document! X and HelpStudio Bundle. Multiple users can collaborate, discuss and revise documents in Quip and the latest content is always used whenever you Preview or Build the generated output.

You may wish to import a static copy of the current content of a Quip Document in your project rather than using the Include method; so that you can manage the content in Document! X and HelpStudio Bundle going forward. In order to import from Quip, first export the Quip Document to HTML using the Quip editor, and then import that HTML document using the HTML from file command on the Content Authoring tab in the Topic or Content File editor.

Importing creates a copy of the current content which can be edited in Document! X and HelpStudio Bundle. Subsequent edits to the Quip Document are not reflected in your project as they would if you choose to include rather than import.

Quip Authentication

In order to access a Quip Document, you must specify a Quip Access Token which provides access to all documents in a given Quip account.

If you don't already have a Quip Access Token for other purposes, you can obtain one here: https://quip.com/api/personal-token

Once you have an Access Token you can use it as the default for any new Topics that include content from Quip by entering it on the Content Sources page in the Project Settings editor.

Each time you generate an Access Token any previously issued Access Token is invalidated. Only do this once and keep a careful note of the Access Token, or enter it in the Project Settings page of your Project.

If practical, it is recommended that you create a Quip account specifically for the purpose of including content so that only included documents are shared using the Quip Access Token. Using Quip, you can share documents from other Quip accounts with the "Inclusion" account for convenience but the Inclusion account is the one providing the Access Token so that the documents can be accessed programmatically by Document! X and HelpStudio Bundle.

Fundamentals

To create a new Topic containing only content from a Quip Document:

Create a new topic.
In the banner displayed at the top of the Topic Editor, select Advanced option.
In the Topic Content Source dropdown, select Quip.
In the Quip Thread ID field, enter the thread ID of the Quip Document you wish to use the content from.

You can find this value in the last part of the page address when you are editing a document in Quip. For example, if the address bar when editing a Quip document shows https://quip.com/NodjfUJJ then the Thread ID would be NodjfUJJ.

In the Quip Access Token field, you can enter the Quip Access Token. The Quip Access Token is required to access the Quip document. See the Authentication section of Including Content from Quip Documents for details on obtaining a Quip Access Token.

It is recommended that you specify the default Access Token on the Content Sources page in the Project Settings editor; you can then leave the Access Token blank in individual Topics or Widgets that reference Quip Documents.