A simple WordPress integration for Quip
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
css
images
.gitignore
LICENSE
Makefile
README.md
readme.txt
svn_init.sh
svn_release.sh
uninstall.php
wp-quip.php

README.md

wp-quip

WP Quip plugin Settings page

Quip integration for WordPress

Introduction

WP Quip plugin uses WordPress shortcodes to embed Quip documents into WordPress pages and blog posts.

https://codex.wordpress.org/Shortcode

https://codex.wordpress.org/Shortcode_API

Manual Installation

  1. Upload wp-quip folder to the /wp-content/plugins/ directory

  2. Activate the WP Quip plugin through the Plugins menu in WordPress

  3. On Quip Settings page (menu Settings/WP Quip), update the default value for Time-to-Live if needed (see Usage for more details)

  4. On Quip Settings page, enter and save Quip API Access Token

To generate a Quip API Access Token, visit this page: https://quip.com/dev/token . Whenever you generate a new token, all previous tokens are automatically invalidated.

WP Quip plugin Settings page

WP Quip plugin Settings page

Installation from wordpress.org plugin repository

https://wordpress.org/plugins/wp-quip/

  1. In WordPress Admin, search for WP Quip plugin and install it

  2. Activate the WP Quip plugin

  3. On Quip Settings page (menu Settings/WP Quip), update the default value for Time-to-Live if needed (see Usage for more details)

  4. On Quip Settings page, enter and save Quip API Access Token

WP Quip plugin Settings page

Usage

To embed the content of a Quip document into a WordPress page or blog post, use the quip shortcode.

quip shortcode accepts two attributes and has the following format:

[quip id="mWnnAszre3MW" ttl=7200]

where

  • id (Required) - The ID of the Quip document (e.g. https://quip.com/mWnnAszre3MW)

  • ttl (Optional) - Time-To-Live in seconds. After the first request to the Quip API, the plugin caches the content of the document (HTML and images) for the specified amount of time (seconds). All consecutive requests to the same page or blog post will not call the Quip API again but instead will retrieve the document from the internal cache, making the pages faster. After the ttl expires, the plugin will call the Quip API and cache the result again. If the ttl attribute is not provided, the default value of 7200 seconds (2 hours) is used. You can change the default value in Quip Settings (menu Settings/WP Quip). If ttl is set to 0, the plugin will not cache the Quip API responses, and every request to the WordPress page or blog post will call the Quip API.

NOTE: Setting ttl to 0 also invalidates the document cache. This could be used if you change the Quip document and want the changes to be reflected on the website immediately. In this case, update the document in Quip, set ttl to 0 in the quip shortcode, refresh the WordPress page or blog post in the browser to invalidate the cache, and then set ttl back to its original value.

WordPress post editor with a quip shortcode

WordPress post editor with a 'quip' shortcode

Quip document embedded into a WordPress blog post

Quip document embedded into a WordPress blog post

Quip document embedded into a WordPress blog post

Quip document embedded into a WordPress blog post

References

For more information on Quip API, visit https://quip.com/dev/automation/documentation

Help

Got a question?

File a GitHub issue, send us an email or reach out to us on Gitter.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing wp-quip, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

APACHE 2.0 © 2017-2018 Cloud Posse, LLC

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

About

wp-quip is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com

We love Open Source Software!

See our other projects or hire us to help build your next cloud platform.

Contributors

Erik Osterman
Erik Osterman
Andriy Knysh
Andriy Knysh