Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
af34e7e
revamp page and add missing screenshots
May 9, 2016
b068c72
replace images
May 9, 2016
065d7c6
revamp link roundup page
May 9, 2016
40e4c41
update mailchimp page
May 9, 2016
2ff02b0
add a couple of formatting changes and an image
May 9, 2016
9473966
replace image
May 9, 2016
447bbf7
revamp widgets page
May 9, 2016
d421614
delete section on the widget since it's going on the widget page
May 9, 2016
7a7399a
update readme with better image
May 9, 2016
45c50f9
add details about what Link Roundups are and what's in these docs
May 9, 2016
8e7d467
add mention of featured images
May 9, 2016
ccdfe19
add links to other pages where appropriate
May 9, 2016
371be9b
change header level
May 9, 2016
7eac671
Merge pull request #113 from INN/jack-docs-updates
aschweigert May 10, 2016
4686cb6
merge use-mailchimp-tools branch to master
rnagle Jun 3, 2016
912bda8
first pass at a new release script that will include composer and bow…
rnagle Jun 3, 2016
5997f22
bower description had to be shortened
rnagle Jun 3, 2016
4d1af64
update tests
rnagle Jun 3, 2016
a8da337
update link-roundups.pot file
rnagle Jun 3, 2016
437fed0
update version numbers
rnagle Jun 3, 2016
72702d9
can't reference trunk_path before defining it
rnagle Jun 3, 2016
f201b27
make sure the default query for roundup blocks includes the last 30 d…
rnagle Jun 7, 2016
184b30e
replace images for new plugin settings and delete references to argo
Jun 7, 2016
dd8f0e7
add section on new panels in the link roundups edit screen
Jun 7, 2016
6a31da0
minor clarification about snding campaigns from either the edit scree…
Jun 7, 2016
ecb3acf
update for new shortcode and workflow
Jun 7, 2016
184596b
add header for categories and tags section
Jun 7, 2016
51827ea
fix broken image link in repo readme.md
Jun 7, 2016
c3a74e9
fix spelling
Jun 7, 2016
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A WordPress plugin to make it easy to collect links from around the web, turn th

**Tested up to:** 4.2.3

**Stable tag:** 0.3.2
**Stable tag:** 0.4.0

**License:** GPLv2 or later

Expand Down Expand Up @@ -51,7 +51,7 @@ Installation directly from the WordPress.org plugin directory coming soon!
## Features

#### Saved Links
![New Saved Link](https://raw.githubusercontent.com/INN/link-roundups/master/docs/img/new-saved-link.png)
![New Saved Link](https://raw.githubusercontent.com/INN/link-roundups/master/docs/img/new-saved-link-npr.png)

Curate links from around the web and save them in WordPress using a handy browser bookmark. You can also add your own descriptions and organize saved links using tags.

Expand Down
12 changes: 11 additions & 1 deletion README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Donate link: http://bit.ly/1N4nSJJ
Tags: newsletters, mailchimp, links, curation, aggregation
Requires at least: 4.1
Tested up to: 4.2.3
Stable tag: 0.3.2
Stable tag: 0.4.0
License: GPLv2
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Expand Down Expand Up @@ -33,6 +33,16 @@ Collect links from around the web, turn them into roundup posts and streamline t

== Changelog ==

= 0.4.0 =

- Added "roundup block" shortcode and accompanying post editor user interface for editing blocks of saved links
- Manage front-end Javascript dependencies using Bower
- Manage PHP dependencies using Composer
- Uses the wordpress-mailchimp-tools PHP package, brought to you by INN
- Added MailChimp campaign editor meta box to the post editor
- Added MailChimp campaign settings for roundup posts
- Moved MailChimp API Key settings to Settings > MailChimp Settings menu

= 0.3.2 =

- Submitted the plugin to WordPress.org
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "link-roundups",
"description": "A WordPress plugin to make it easy to collect links from around the web, turn them into roundup posts and streamline the production of daily/weekly roundup newsletters using MailChimp.",
"description": "A WordPress plugin that makes it easy to collect links, turn them into roundup posts and produce roundup newsletters using MailChimp.",
"main": "link-roundups.php",
"authors": [
"INN Nerds <nerds@inn.org>"
Expand Down
Binary file added docs/img/added-links-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/adding-link-roundup-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/adding-link-roundup-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/adding-link-roundup-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/adding-links-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/all-saved-links.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/argo-links-menu.png
Binary file not shown.
Binary file removed docs/img/bookmarklet-popup.png
Binary file not shown.
Binary file removed docs/img/edit-saved-links.png
Binary file not shown.
Binary file added docs/img/link-roundup-campaign-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/link-roundup-campaign-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/link-roundup-mailchimp-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/link-roundup-page-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/link-roundup-send-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/link-roundups-mailchimp-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/link-roundups-widget-in-sidebar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/links-roundup-posts-on-homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/mailchimp-campaign-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/new-link-roundup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/new-saved-link-npr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/new-saved-link-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/new-saved-link.png
Binary file not shown.
Binary file added docs/img/recent-links-sidebar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/roundup_block_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/save-to-site-bookmarklet-in-browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/save-to-site-bookmarklet-page.png
Binary file added docs/img/saved-links-widget.png
Binary file added docs/img/todays-links.png
58 changes: 47 additions & 11 deletions docs/link-roundups.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,64 @@
## How to Create Link Roundups
# How to Create Link Roundups

Now that you have some Saved Links, you're ready to create your first Link Roundup.
Assuming you have some [Saved Links](/docs/saved-links.md), you're ready to create your first Link Roundup.

1) Go to Link Roundups and click Add New from your WordPress Dashboard.
1) Go to **Link Roundups** and click Add Link Roundup from your WordPress Dashboard.

![Finding "Link Roundups > Add New" in the menu](img/new-roundup.png)
![New Link Roundup link in the Dashboard](./img/new-link-roundup.png)

The new Link Roundup post will resemble a regular WordPress post in many ways... but there is one important difference: the Recent Saved Links Panel below the Editor.

Recent Saved Links lets you sort through links based on the date they were created.
Recent Saved Links lets you sort through Saved Links based on the date they were created.

![Screenshot showing how to choose links to add to a roundup post](img/recent-roundup-links.png)
![New Link Roundup link in the Dashboard](./img/adding-link-roundup-1.png)

2) Select one or more links to add to your roundup by sending them to the Editor.
2) Select one or more links to add to your roundup by clicking the **Send to Editor** button.

The Recent Saved Links section shows a maximum of 15 links at one time. Use the pagination to view more pages of Saved Links, but bear in mind you must send links to the editor before switching pages -- the box won't remember links you checked on other pages, only links currently displayed.

Once you have the links that make up your roundup in the editor window, you can edit the links, change the description and make any adjustments that you'd make to a normal post. If you'd like to add a description to the post, go to the first line of the roundup and add a new line. You'll likely notice that the roundup icon that appears to the left of new roundup links appears on the blank line. To remove this icon, select "Paragraph" from the formatting menu and the formatting will be removed.
![New Link Roundup link in the Dashboard](./img/adding-link-roundup-2.png)

![Screenshot showing the post editor](img/link-roundup-heading.png)
Once you have the links that make up your roundup in the editor window, you can edit the links, change the description and make any adjustments that you'd make to a normal post. If you'd like to add a description to the post, go to the first line of the roundup and add a new line.

When you're satisfied with the description and links that you've added to your roundup, publish your post and congratulate yourself on some excellent curatorial work.
![New Link Roundup link in the Dashboard](./img/adding-link-roundup-3.png)

# Link Roundups Options
## Add Categories and Tags

You can also add Categories and Tags to the Link Roundup, like any other post. _Adding one or more Categories allows filtering display of Link Roundups by Category_.

## Creating a Link Roundup using roundup_block Shortcode

An alternative way to create a Link Round is to use a special shortcode with this format:

`[roundup_block name="Today's Links"]`

The name will be displayed as a header so just change it as desired. When you add this shortcode you'll see the name of the header in a grey box:

![Link Roundups shortcode displayed in the visual editor](./img/roundup_block_1.png)

Hover over the box and a pencil icon appears. Click the pencil, and you'll be presented with a modal window to edit the contents:

![adding links to a roundup](./img/adding-links-modal.png)

Under each available item, click the Add button to add it to the Link Roundup:

![Links added to a roundup](./img/added-links-modal.png)

Click the Save button in the modal window and return to find your links in the Link Roundup edit screen:

![Links added to a roundup](./img/todays-links.png)

## How Link Roundups are Displayed On Your Site

Once you Publish the Link Roundup post, it displays in your homepage content stream like any other post:

![Link Roundups on the homepage](./img/links-roundup-posts-on-homepage.png)

Each Link Roundup also has its own single-post page which displays its Saved Links which link to the original source:

![Link Roundup post page](./img/link-roundup-page-example.png)

## Link Roundups Options

Link Roundups Options enable the following:
- Rename the Link Roundups Post Type (including public URL slug!)
Expand Down
40 changes: 29 additions & 11 deletions docs/mailchimp.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ In order to use the MailChimp features of Link Roundups, you'll need to sign up
2. Click on your account in the upper-right corner. In the drop-down menu, click "Account".
3. Click on "Extras", then "API keys".
4. Click "Create A Key". A new key will appear in the list.
5. Click the "Label" field of your new API key. Name it after the site you're using Argo Links on. For example: "example.com argo links"
5. Click the "Label" field of your new API key. Name it after the site you're using Link Roundups on. For example: "example.com links"
6. Copy the API key. This will be a long string of characters from 0-9 and a-f.
7. On your website, go to Dashboard > Link Roundups > Options.
8. Paste the MailChimp API Key into the appropriate field, then check "Enable MailChimp API Integration".
7. On your WordPress site, go to **Dashboard > Settings > MailChimp Settings**.
8. Paste the MailChimp API Key into the appropriate field.
9. Press "Save Changes".

Next: Creating a template in Mailchimp that your post will use.
![Link Roundups MailChimp API settings](./img/link-roundups-mailchimp-settings.png)

## Creating a template in the MailChimp dashboard

Expand All @@ -47,9 +47,9 @@ Then, edit the template to insert the following tags where you want them to appe

#### Required Tags:

If these template tags are not present in your MailChimp template, you will be unable to create a new Argo Links Roundup Email Campaign.
If these template tags are not present in your MailChimp template, you will be unable to create a new Links Roundup Email Campaign.

- `*|ROUNDUPLINKS|*` - The actual list of links from the Argo Links Roundup post
- `*|ROUNDUPLINKS|*` - The actual list of links from the Links Roundup post

#### Optional Tags:

Expand All @@ -60,14 +60,32 @@ These template tags are not required, but you may wish to use them in your templ
- `*|ROUNDUPDATE|*` - The date the Links Roundu post was published
- `*|ROUNDUPPERMALINK|*` - A link back to the original Link Roundup post

## Choosing the template to use
## Choosing the MailChimp Template and List to use

So now you have at least one template saved in MailChimp. Go back to the Link Roundups Options page in Dashboard &raquo; Link Roundups &raquo; Options, and choose your template.
So now you have at least one template saved in MailChimp, and we're assuming you also have a list of subscribers for your newsletter. In the WordPress Dashboard go to **Link Roundups > MailChimp Campaign Settings**, and choose your default campaign type, default mailing list, default template, and email address(es) for campaign tests:

![Link Roundups MailChimp Campaign settings](./img/link-roundup-campaign-settings.png)

# Creating a MailChimp Campaign

Once you have [saved some links](saving-links.md) and [created a link roundup post](link-roundups.md), you can send the link roundup post to MailChimp as a draft campaign.
Once you have [saved some links](saving-links.md) and [created a Link Roundup post](link-roundups.md), you can send the Link Roundup post to MailChimp as a draft campaign.

In the Link Roundups editor make sure the **Mailchimp Campaign Editor** is visible. If not, visit Screen Options and select it to make it visible. You can now:

- Choose a campaign type
- Choose a list to send to
- Give your campaign a title
- Add the campaign subject line for email
- Choose which MailChimp template to use for the campaign (defaults to what was set in Link Roundups > MailChimp Campaign Settings)

![Mailchimp Campaign Editor panel in the post editor](./img/link-roundup-campaign-editor.png)

Click the **Create Draft** button to create a draft MailChimp campaign. You can then view the draft campaign in your [MailChimp campaigns](https://us13.admin.mailchimp.com/campaigns/), and make any needed changes there before sending. You can also send a test email from the Link Roundup edit screen:

![Send Test button in the Link Roundups edit screen](./img/link-roundup-send-test.png)

The **Send Test** button won't appear until after creating a draft campaign. You will then also see a new **MailChimp Campaign Preview** screen on the right side of the Link Roundup edit screen, where you can preview the campaign in a new window, or preview and edit the campaign in MailChimp:

In the Link Roundups editor, above the standard WordPress "Publish" button you'll find a button to "Create a MailChimp Campaign."
![MailChimp Campaign Preview panel in the Link Roundups edit screen](./img/mailchimp-campaign-preview.png)

When you click "Create a MailChimp Campaign" you will be asked to confirm the action. The Link Roundups plugin will contact MailChimp to create the campaign and, upon success, present you with a link to finish editing the campaign in the MailChimp dashboard.
When the draft campaign is ready to go, hist the **Send Now** button to launch the MailChimp campaign. You can also choose to launch the campaign from MailChimp if preferred.
9 changes: 7 additions & 2 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Link Roundups Documentation

![link roundup](img/published-roundup.png)
Link Roundups is a WordPress plugin that makes it easy to:

This plugin makes it easy to collect links from across the web and share them right from your WordPress Dashboard.
- collect links from around the web and save them in WordPress as Saved Links
- turn them into Link Roundup posts
- display Saved Links and Link Roundups in WordPress widgets on your site
- streamline the production of daily/weekly roundup newsletters using MailChimp

![link roundup post on a website](img/link-roundup-page-example.png)

Get the brief introduction to plugin features in [the main Readme.md file](https://github.com/INN/link-roundups/blob/master/README.md).

Expand Down
31 changes: 26 additions & 5 deletions docs/saved-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,41 @@ Once you've [installed and activated the plugin](installation.md), you should se
## Save Links via Browser Bookmark Tool (Recommended)

1. Under Saved Links, navigate to Add Browser Bookmark (Save to Site)

![installing Save to Site bookmarklet in WordPress](img/save-to-site-bookmarklet-page.png)

2. Install by dragging on to the bookmark bar of your preferred web browser.

![Save to Site bookmarklet installed in a browser toolbar](img/save-to-site-bookmarklet-in-browser.png)

3. Test by finding a great internet link and clicking your bookmark.
4. A popup will appear (you may need to adjust your browser settings to allow the popup to be displayed) with a new Saved Link screen. If you're not logged in to your WordPress site, a login screen will appear before you're passed through. The Save to Site Bookmark Tool attempts to prefill **Title**, **URL** and **Source** information -- saving you time! It will even attempt to grab a **featured image** and import that to WordPress (featured images are still a beta feature and we have improvements planned for this soon)

4. A popup will appear (you may need to adjust your browser settings to allow the popup to be displayed) with a new Saved Link screen. If you're not logged in to your WordPress site, a login screen will appear before you're passed through. The Save to Site Bookmark Tool attempts to prefill **Title**, **URL** and **Source** information -- saving you time! It will even attempt to grab a **featured image** and import that to WordPress (featured images are still a beta feature and we have improvements planned for this soon).

![Saving a link to a story in the Saved Links bookmarklet popup screen](img/new-saved-link-npr.png)

5. **Publish** your Saved Link and resume normal web browsing.

## Save Links Manually from the WordPress Dashboard

1. In WordPress find Saved Links in the main menu and navigate to New Saved Link.

![Saved links area of the WordPress dashboard](img/new-saved-link-screen.png)

2. Add a Title for your Link
3. A URL is required, paste a valid URL in the URL field.
3. Optionally define a custom slug, provide a short description and the source of your Saved Link.
3. Optionally define a custom slug, add a Featured Image, and provide a short description and the source of your Saved Link.

## Editing Saved Links

Visit the dashboard screen under **Saved Links > Saved Links** to see all your Saved Links. You can edit them just like other post types.

![Saved links area of the WordPress dashboard](img/all-saved-links.png)

![Link Roundups This!](img/argo-links-menu.png)
## Using Saved Links in Link Roundups

![Screenshot showing the Link Roundups This! bookmarklet in use](img/bookmarklet-popup.png)
Now that you have some Saved Links you can:

![Screenshot showing the Link Roundups area of the WordPress dashboard](img/links-dashboard.png)
- [Use them in Link Roundups posts](/docs/link-roundups.md) which display like other posts on your site.
- If you have a MailChimp account for your email newsletter, you can also easily [publish Link Roundup posts as MailChimp campaigns](/docs/mailchimp.md) from your WordPress dashboard.
- You can also display Saved Links in the [Saved Links Widget](/docs/widgets.md).
16 changes: 11 additions & 5 deletions docs/widgets.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# Widgets

### Adding Widgets
## Adding Widgets

Widgets can be added in the WordPress Dashboard under Appearance > Widgets, or alternatively in the WordPress Customizer under the Widgets Panel. Drag the desired widget into your desired sidebar or widget area (or click Add Widget in your desired sidebar in the case of the Customizer).
Widgets can be added in the WordPress Dashboard under **Appearance > Widgets**, or alternatively in the WordPress Customizer under the **Widgets Panel**. Drag the desired widget into your desired sidebar or widget area (or click Add Widget in your desired sidebar in the case of the Customizer).

#### 1. Saved Links Widget (since 0.1)
## 1. Saved Links Widget (since 0.1)

The Saved Links Widget gathers Saved Links (optionally filtered by your Saved Link Tags) and displays them as a list similar to a list of Recent Posts. You can control the number of Saved Links to show, the length of the description excerpt, control display for different devices and a hyperlinked widget title for the feed.

#### 2. Link Roundups Widget (since 0.3)
![Saved Links Widget on a post page](./img/recent-links-sidebar.png)

The Link Roundups Widget shows the most recent Link Roundup(s), which can be limited to a category. You can control the number of Link Roundups to show, the category to limit to (at present must be a single category, so use nested categories for multiple), control display for different devices and a hyperlinked widget title above the headline (i.e. "Latest Digest")
## 2. Link Roundups Widget (since 0.3)

After creating one or more Link Roundups, you can use the Link Roundups Widget to create links to your Link Roundups. The Link Roundups Widget shows the most recent Link Roundup(s), which can be limited to a category.

![Link Roundups widget displayed in a sidebar](./img/link-roundups-widget-in-sidebar.png)

Widget options include filtering display of Link Roundups by Category, changing the default Title of "Recent Link Roundups," and adding a link and URL at the bottom of the widget.
18 changes: 16 additions & 2 deletions inc/link-roundups/class-link-roundups-editor.php
Original file line number Diff line number Diff line change
Expand Up @@ -293,14 +293,28 @@ public static function roundup_update_post() {
}

public static function roundup_block_posts_query() {
$month_ago = strtotime('-30 days');
$now = strtotime('now');

// Default arguments
$args = apply_filters('link_roundups_roundup_block_post_query', array(
'post_type' => 'rounduplink',
'orderby' => 'date',
'order' => 'desc',
'posts_per_page' => -1,
'year' => date( 'Y' ),
'monthnum' => date( 'm' )
'date_query' => array(
'after' => array(
'year' => date( 'Y', $month_ago ),
'month' => date( 'n', $month_ago ),
'day' => date( 'j', $month_ago )
),
'before' => array(
'year' => date( 'Y', $now ),
'month' => date( 'n', $now ),
'day' => date( 'j', $now )
),
'inclusive' => true
)
));
$query = new WP_Query($args);
$posts = $query->get_posts();
Expand Down
Loading