Skip to content
Open
Show file tree
Hide file tree
Changes from 7 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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
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
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-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/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-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 removed docs/img/link-roundups-mailchimp-integration.png
Binary file not shown.
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 removed docs/img/link-roundups-options-mailchimp-2.png
Binary file not shown.
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/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/todays-links.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/link-roundups.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,32 @@ Once you have the links that make up your roundup in the editor window, you can

![New Link Roundup link in the Dashboard](./img/adding-link-roundup-3.png)

## 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:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section doesn't work as described; "lr" isn't defined in the editor under PHP 7. (#132, hooray!) so I'd like to fix that after merging this docs request, or generate an issue to remove this docs block.


![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:
Expand Down
38 changes: 26 additions & 12 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".

![Link Roundups MailChimp API settings](./img/link-roundups-mailchimp-integration.png)
![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 @@ -62,16 +62,30 @@ These template tags are not required, but you may wish to use them in your templ

## Choosing the MailChimp Template and List to use

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. Go back to the Link Roundups Options page in **Link Roundups > Options**, and choose your template, and which MailChiimp List you want to use:
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 API settings](./img/link-roundups-options-mailchimp-2.png)
![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, above the standard WordPress "Publish" button you'll find a button to "Create a MailChimp 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:

![Create MailChimp Campaign button in the post editor](./img/link-roundup-mailchimp-button.png)
- 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)

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.
![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:

![MailChimp Campaign Preview panel in the Link Roundups edit screen](./img/mailchimp-campaign-preview.png)

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.