Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudposse-archives/wp-quip

A simple WordPress integration for Quip
https://github.com/cloudposse-archives/wp-quip

quip shortcode wordpress wordpress-plugin

Last synced: 13 days ago
JSON representation

A simple WordPress integration for Quip

Host: GitHub
URL: https://github.com/cloudposse-archives/wp-quip
Owner: cloudposse-archives
License: apache-2.0
Created: 2017-08-21T18:46:28.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2018-02-01T21:57:30.000Z (almost 7 years ago)
Last Synced: 2023-12-18T08:02:03.777Z (11 months ago)
Topics: quip, shortcode, wordpress, wordpress-plugin
Language: PHP
Homepage: https://cloudposse.com/accelerate
Size: 3.77 MB
Stars: 3
Watchers: 4
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # wp-quip

![WP Quip plugin Settings page](assets/icon-128x128.png)

[Quip](https://quip.com/) integration for WordPress

## Introduction

`WP Quip` plugin uses WordPress shortcodes to embed [Quip](https://quip.com/) 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](#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](assets/screenshot-1.png)

#

## 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](#usage) for more details)

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

#

![WP Quip plugin Settings page](images/WordPress_WP_Quip.png)

#

## Usage

To embed the content of a [Quip](https://quip.com/) 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](assets/screenshot-2.png)

#

#### Quip document embedded into a WordPress blog post

![Quip document embedded into a WordPress blog post](assets/screenshot-3.png)

#

#### Quip document embedded into a WordPress blog post

![Quip document embedded into a WordPress blog post](assets/screenshot-4.png)

#

## References

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

## Help

**Got a question?**

File a GitHub [issue](https://github.com/cloudposse/wp-quip/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/).

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/cloudposse/wp-quip/issues) 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](mailto:[email protected]).

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](LICENSE) © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)

See [LICENSE](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][website]. Like it? Please let us know at 

We love [Open Source Software](https://github.com/cloudposse/)!

See [our other projects][community]

or [hire us][hire] to help build your next cloud platform.

  [website]: http://cloudposse.com/

  [community]: https://github.com/cloudposse/

  [hire]: http://cloudposse.com/contact/

### Contributors

| [![Erik Osterman][erik_img]][erik_web]
[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]
[Andriy Knysh][andriy_web] |

|-------------------------------------------------------|------------------------------------------------------------------|

  [erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144

  [erik_web]: https://github.com/osterman/

  [andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144

  [andriy_web]: https://github.com/aknysh/