Skip to content

Improvements to WP Plugins section of docs #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions projects/wordpress-plugins/_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Plugin name

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/inn/
- Wordpress.org plugin repo: https://wordpress.org/plugins/

## What is it?

Historical information should go in this area of the file.

## Who made it?
21 changes: 21 additions & 0 deletions projects/wordpress-plugins/client-hosting-manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Client Hosting Manager

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/inn/client-hosting-manager
- Wordpress.org plugin repo: https://wordpress.org/plugins/client-hosting-manager/
- Instructions on removal: https://github.com/INN/umbrella-currentorg/issues/17

## What is it?

Once upon a time, many INN member sites were all hosted as part of a single multisite WordPress install. And many users on those sites had admin access. WordPress single-site admins could still update plugins, but we didn't want them to be able to do that, because it would affect sites other than their own. Thus, we needed to selectively remove certain permissions from users who were not INN staff, which are documented [in the plugin's readme](https://github.com/INN/client-hosting-manager/blob/master/README.md)

Users of this plugin would need to define several constants which would determine which users were allowed to have which permissions by matching those users' email address domains.

If the plugin were removed from a site without first deactivating it while the constants were set, the plugin's permissions changes would remain permanently. The problems can be fixed with [`wp cap`](https://developer.wordpress.org/cli/commands/cap/).

## Who made it?

RC Lations, Ben Keith
19 changes: 19 additions & 0 deletions projects/wordpress-plugins/credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Credentials

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/credentials
- Wordpress.org plugin repo: none

## What is it?

Collects information about post authors and displays that information in widgets.

For a more up-to-date version, check out [Trust Indicators](trust-indicators.md).


## Who made it?

This plugin was created as a part of the Trust Project Challenge hosted by the BBC Connected Studio in Fall 2016 as a collaboration between INN and BBC team members. RC Lations led the effort.
12 changes: 12 additions & 0 deletions projects/wordpress-plugins/developer-driven-custom-post-classes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Developer-Driven Custom Post Classes

GitHub repo: https://github.com/INN/developer-driven-custom-post-classes
wordpress.org plugin repo: not published
Status: ?

## Description:

Uses CMB2 to add a meta box allowing drop-down selection of theme-developer-defined custom classes on a post.

Developer-Driven Custom Post Classes was originally [written for Chicago Reporter](https://github.com/INN/umbrella-chicagoreporter/blob/master/wp-content/themes/chicago-reporter/inc/DDCPC.php), and was subsequently used on other sites, including [Mississippi Today](https://github.com/INN/umbrella-mstoday/blob/master/wp-content/themes/mstoday/inc/DDCPC.php).

16 changes: 16 additions & 0 deletions projects/wordpress-plugins/inn-members.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# INN Members

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/inn-members
- Wordpress.org plugin repo: none

## What is it?

Largo-independent implementation of the INN Member Stories widget, the INN Members dashboard widget, and an analytics package. This dates to the 2017 work on Largo 1.0, which among other work involved splitting Largo into separately-installable pieces that could be used by INN members who weren't running Largo.

## Who made it?

RC Lations.
21 changes: 21 additions & 0 deletions projects/wordpress-plugins/knight-lab-storytelling-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Knight Lab Storytelling Tools

Status:

## Relevant links:

- GitHub repo: https://github.com/INN/storytelling-tools
- Wordpress.org plugin repo: https://wordpress.org/plugins/storytelling-tools/
- Knight's pages: https://knightlab.northwestern.edu/projects/

## What is it?

This plugin adds support for embedding various of Knight Lab's projects in WordPress in a way that won't get stripped by wp_kses:
- [Timeline](http://timeline.knightlab.com/)
- [StoryMap](https://storymap.knightlab.com/)
- [Juxtapose](https://juxtapose.knightlab.com/)
- [Soundcite](http://soundcite.knightlab.com/)

## Who made it?

RC Lations, Ben Keith, Kay Lima, Adam Schweigert.
18 changes: 18 additions & 0 deletions projects/wordpress-plugins/largo-clean-contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Largo Clean Contact

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/largo-clean-contact
- Wordpress.org plugin repo: none

## What is it?

Modifications to the [Clean Contact](https://wordpress.org/plugins/clean-contact/) plugin, used for contact forms on Largo sites.

It was later included directly in Largo at https://github.com/INN/largo/tree/v0.6.4/lib/clean-contact

## Who made it?

Adam Schweigert
3 changes: 2 additions & 1 deletion projects/wordpress-plugins/link-roundups.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ This is one of the plugins we adopted from NPR's Project Argo but it has since b

- [Plugin repository on GitHub](https://github.com/INN/link-roundups)
- [Plugin listing on wordpress.org](https://wordpress.org/plugins/link-roundups/)
- [WordPress MailChimp tools](https://github.com/INN/wordpress-mailchimp-tools/tree/12225e55f2bbe7fff3baf2d93d4c1b5b83c0f316) (used for MailChimp integration)
- [WordPress MailChimp tools](https://github.com/INN/wordpress-mailchimp-tools/tree/12225e55f2bbe7fff3baf2d93d4c1b5b83c0f316) (used for MailChimp integration)
- [NPR Argo Project original documentation](http://argoproject.org/argo-links.php.html)
19 changes: 19 additions & 0 deletions projects/wordpress-plugins/navis-documentcloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Navis DocumentCloud

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/navis-documentcloud
- NPR Project Argo docs: http://argoproject.org/documentcloud.php.html

## What is it?

A shortcode for [DocumentCloud](https://www.documentcloud.org/) embeds.

Rather than using this, you should use [the official DocumentCloud plugin](https://wordpress.org/plugins/documentcloud/), whose github repo is https://github.com/documentcloud/wordpress-documentcloud


## Who made it?

Originally, NPR, as part of their [StateImpact project](https://stateimpact.npr.org/).
16 changes: 16 additions & 0 deletions projects/wordpress-plugins/navis-jiffy-posts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Navis Jiffy Posts

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/navis-jiffy-posts
- NPR Argo Project docs: http://argoproject.org/jiffy-post.php.html

## What is it?

Originally by NPR, this plugin aimed to make it easier to embed new content on your site.

## Who made it?

NPR and Daniel Bachhuber.
21 changes: 21 additions & 0 deletions projects/wordpress-plugins/navis-media-credit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Navis Media Credit

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/navis-media-credit
- Wordpress.org plugin repo: none
- NPR Project Argo docs: http://argoproject.org/media-credit.php.html

## What is it?

Part of NPR's original Argo Project, Navis Media Credit adds fields to the image uploader to set an individual image credit, organization credit, and organization credit URL.

Now included in Largo at https://github.com/INN/largo/tree/v0.6.4/lib/navis-media-credit

A separate implementation exists at https://github.com/Automattic/newspack-image-credits

## Who made it?

NPR, and Adam Schweigert, and some other contributors. Primary development continues in Largo.
18 changes: 18 additions & 0 deletions projects/wordpress-plugins/navis-slideshows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Navis Slideshows

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/navis-slideshows
- NPR Argo Project docs: http://argoproject.org/slideshow.php.html

## What is it?

Originally developed by NPR for the Argo Project, this plugin hooks the [post_gallery](https://developer.wordpress.org/reference/hooks/post_gallery/) filter to augment the output of the `[gallery]` shortcode and turn it into a slideshow.

Later incorporated into Largo at https://github.com/INN/largo/tree/trunk/lib/navis-slideshows and substantially rewritten.

## Who made it?

NPR, Adam Schweigert, and other contributors.
20 changes: 20 additions & 0 deletions projects/wordpress-plugins/news-match-donation-shortcode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# News Match Donation Shortcode

status: 💀 retired

## Relevant links:

GitHub repo: https://github.com/INN/news-match-donation-shortcode
wordpress.org plugin repo: https://wordpress.org/plugins/news-match-donation-shortcode/

## What is it?

Created for News Match 2017 to make it easy for sites to place a News Revenue Hub donation form without fighting wp_kses.

This plugin inherited some code from [okwatch-donation](https://github.com/INN/okwatch-donation) and [rivard-donation-plugin](https://github.com/INN/rivard-donation-plugin/), and superseded them.

https://inn.org/event/inn-labs-presents-wordpress-tools-for-your-news-match-campaign/

## Who made it?

Voice of San Diego, Ben Keith, Julia Smith, RC Lations
18 changes: 18 additions & 0 deletions projects/wordpress-plugins/news-match-popup-basics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# News Match Popup Basics

status: 💀 retired

## Relevant Links

GitHub repo: https://github.com/INN/news-match-popup-plugin
wordpress.org plugin repo: https://wordpress.org/plugins/news-match-popup-basics/

## What is it?

Created for News Match 2017 to give sites an easy way to create a [Popup Maker](https://wordpress.org/plugins/popup-maker/) popup with the recommended default settings for News Match.

https://inn.org/event/inn-labs-presents-wordpress-tools-for-your-news-match-campaign/

## Who made it?

Ben Keith
18 changes: 18 additions & 0 deletions projects/wordpress-plugins/no-nonsense-google-analytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# No Nonsense Google Analytics

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/no-nonsense-google-analytics/
- Wordpress.org plugin repo: https://wordpress.org/plugins/no-nonsense-google-analytics/

## What is it?

A simple Universal Analytics implementation of Google Analytics. No dashboard, no reports.

Intended to replace Largo's built-in Analytics.

## Who made it?

RC Lations.
16 changes: 16 additions & 0 deletions projects/wordpress-plugins/npr-audio-player.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# NPR Audio Player

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/npr-audio-player
- Wordpress.org plugin repo: none

## What is it?

Adds an audio player widget, supporting 3 streams.

## Who made it?

Julia Smith
17 changes: 17 additions & 0 deletions projects/wordpress-plugins/pmp-distribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Public Media Platform Distribution Extension

Status: 💀 retired

## Relevant links:

- GitHub repo: https://github.com/INN/pmp-distribution
- Wordpress.org plugin repo: none
- Related plugin: [Public Media Platform](./public-media-platform.md)

## What is it?

This plugin extends the PMP plugin to provide additional metaboxes and user roles for a PMP concept called a "distributor" who can determine what collections a PMP document (a WordPress Post) is in.

## Who made it?

Ryan Nagle
18 changes: 11 additions & 7 deletions projects/wordpress-plugins/public-media-platform.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Public Media Platform

### What is it?
Status: 💀 retired

## Relevant links:

- [Plugin repository on GitHub](https://github.com/publicmediaplatform/pmp-wordpress)
- [Plugin listing on WordPress.org](https://wordpress.org/plugins/public-media-platform/)
- [Public Media Platform website](http://publicmediaplatform.org/)


## What is it?

The [Public Media Platform](http://publicmediaplatform.org/) is a cross-media distribution system for digital content (audio, video, stories, and images). You can use it both to bring additional public media produced content to your site, and to expand the reach of your content to external web and mobile destinations.

Expand All @@ -10,12 +19,7 @@ The Public Media Platform is now [a project of NPR Digital Services](http://publ

INN was hired to build the official WordPress plugin for the platform.

### Who made it?
## Who made it?

Ryan Nagle (for the Public Media Platform)

### Relevant links:

- [Plugin repository on GitHub](https://github.com/publicmediaplatform/pmp-wordpress)
- [Plugin listing on WordPress.org](https://wordpress.org/plugins/public-media-platform/)
- [Public Media Platform website](http://publicmediaplatform.org/)
45 changes: 40 additions & 5 deletions projects/wordpress-plugins/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,50 @@ In addition to our work on [Largo](/projects/largo/), our team has created a num

### Plugins

- [DoubleClick for WordPress](doubleclick-for-wp.md)
- [Google Analytics Popular Posts](google-analytics-popular-posts.md)
You can find [the current list of maintained plugins at support.inn.org](https://support.inn.org/category/202-plugins-by-inn-labs).

Some plugins in this list may have private, archived, or deleted repositories, and consequently may not be visible.

Some plugins we have built and maintain include:

- [Pym.js Embeds](pym-shortcode.md)
- [Super Cool Ad Manager Plugin](doubleclick-for-wp.md)
- [Super Cool Ad Inserter](super-cool-ad-inserter.md)
- [Link Roundups](link-roundups.md)
- [Trust Indicators](trust-indicators.md)
- [Republication Tracker Tool](republication-tracker-tool.md)

Plugins which are neither maintained nor not-maintained:

- [Developer-Driven Custom Post Classes](developer-driven-custom-post-classes)

We no longer maintain these plugins, but their docs are being kept here as a historical reference:

- [Client Hosting Manager](client-hosting-manager.md)
- [Credentials](credentials.md)
- [Google Analytics Popular Posts](google-analytics-popular-posts.md)
- [INN Members](inn-members.md)
- [Knight Lab Storytelling Tools](knight-lab-storytelling-tools.md)
- [Largo Clean Contact](largo-clean-contact.md)
- [Largo Related Posts](largo-related-posts.md)
- [NPR Audio Player](npr-audio-player.md)
- [Navis DocumentCloud](navis-documentcloud.md)
- [Navis Jiffy Posts](navis-jiffy-posts.md)
- [Navis Media Credits](navis-media-credit.md)
- [Navis Slideshows](navis-slideshows.md)
- [News Match Donation Shortcode](news-match-donation-shortcode.md) (rivard, okwatch donation shortcodes)
- [News Match Popup Basics](news-match-popup-basics.md)
- [News Quiz](news-quiz.md)
- [No Nonsense Google Analytics](no-nonsense-google-analytics.md)
- [Public Media Platform Distribution Extension](pmp-distribution.md)
- [Public Media Platform](public-media-platform.md)
- [Pym Shortcode](pym-shortcode.md)
- [Super Cool Ad Inserter](super-cool-ad-inserter.md)
- [RNS Transmissions](rns-transmissions.md)
- [Term Debt Consolidator](term-debt-consolidator.md)
- [Term Enhancements](term-enhancements.md)

To add a plugin to this list, copy [`_template.md`](_template.md) into a new file.

### Utilities

- [Plugin release script](release.sh.md) (for wordpress.org)
- [Plugin release script](release.sh.md) (for wordpress.org plugins)
- [WordPress MailChimp Tools](wordpress-mailchimp-tools.md) (library)
Loading