diff --git a/README.md b/README.md index 2fa5fdf..f759f42 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/README.txt b/README.txt index 034589e..6b20ba3 100644 --- a/README.txt +++ b/README.txt @@ -27,7 +27,8 @@ Collect links from around the web, turn them into roundup posts and streamline t 1. Install the Link Roundups plugin via the Wordpress.org plugin directory 2. Activate the plugin 3. Navigate to the Admin -> Link Roundups -> Options page to configure the plugin -4. Done! +4. Navigate to the Admin -> Settings -> Mailchimp Settings page to configure the plugin's MailChimp integration, if desired +5. Done! [Read more about installing plugins here](https://codex.wordpress.org/Managing_Plugins#Installing_Plugins). @@ -38,7 +39,7 @@ Collect links from around the web, turn them into roundup posts and streamline t - 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 +- Uses the [wordpress-mailchimp-tools](https://github.com/INN/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 diff --git a/docs/img/added-links-modal.png b/docs/img/added-links-modal.png new file mode 100644 index 0000000..8fd77cf Binary files /dev/null and b/docs/img/added-links-modal.png differ diff --git a/docs/img/adding-links-modal.png b/docs/img/adding-links-modal.png new file mode 100644 index 0000000..618edb3 Binary files /dev/null and b/docs/img/adding-links-modal.png differ diff --git a/docs/img/link-roundup-campaign-editor.png b/docs/img/link-roundup-campaign-editor.png new file mode 100644 index 0000000..007f3a3 Binary files /dev/null and b/docs/img/link-roundup-campaign-editor.png differ diff --git a/docs/img/link-roundup-campaign-settings.png b/docs/img/link-roundup-campaign-settings.png new file mode 100644 index 0000000..4751257 Binary files /dev/null and b/docs/img/link-roundup-campaign-settings.png differ diff --git a/docs/img/link-roundup-send-test.png b/docs/img/link-roundup-send-test.png new file mode 100644 index 0000000..009042c Binary files /dev/null and b/docs/img/link-roundup-send-test.png differ diff --git a/docs/img/link-roundups-mailchimp-integration.png b/docs/img/link-roundups-mailchimp-integration.png deleted file mode 100644 index 72d157d..0000000 Binary files a/docs/img/link-roundups-mailchimp-integration.png and /dev/null differ diff --git a/docs/img/link-roundups-mailchimp-settings.png b/docs/img/link-roundups-mailchimp-settings.png new file mode 100644 index 0000000..68cf3c2 Binary files /dev/null and b/docs/img/link-roundups-mailchimp-settings.png differ diff --git a/docs/img/link-roundups-options-mailchimp-2.png b/docs/img/link-roundups-options-mailchimp-2.png deleted file mode 100644 index 03c5e29..0000000 Binary files a/docs/img/link-roundups-options-mailchimp-2.png and /dev/null differ diff --git a/docs/img/mailchimp-campaign-preview.png b/docs/img/mailchimp-campaign-preview.png new file mode 100644 index 0000000..b8aa328 Binary files /dev/null and b/docs/img/mailchimp-campaign-preview.png differ diff --git a/docs/img/roundup_block_1.png b/docs/img/roundup_block_1.png new file mode 100644 index 0000000..3717ce8 Binary files /dev/null and b/docs/img/roundup_block_1.png differ diff --git a/docs/img/todays-links.png b/docs/img/todays-links.png new file mode 100644 index 0000000..ec944eb Binary files /dev/null and b/docs/img/todays-links.png differ diff --git a/docs/installation.md b/docs/installation.md index f3ea7f2..08cc228 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,15 +1,23 @@ # Installation -If you're an INN member making use of INN's [Largo Project](https://largoproject.org) hosting, the Link Roundups plugin is already installed. Just [contact us](http://jira.inn.org/servicedesk/customer/portal/4) through the Largo help desk to have it activated on your site. - ## Manual Install 1. Download the [.zip archive](https://github.com/INN/link-roundups/archive/master.zip) from GitHub. -2. Extract the .zip archive. +2. Extract the .zip archive. 3. Rename the plugin directory to `link-roundups`. If the directory the plugin files reside in is named anything else, the plugin will not work. 4. Upload the plugin directory to you server's `wp-content/plugins` directory. 5. Activate the plugin through the [`Plugins` menu](https://codex.wordpress.org/Plugins_Screen) in WordPress. ## WordPress Plugin Directory or Your WordPress Dashboard -Coming Soon. Yes, exciting. +Download from [the Wordpress.org Plugin Directory](https://wordpress.org/plugins/link-roundups/), or search in your WordPress site's plugin dashboard for "Link Roundups". + +## Developer Installation + +1. Clone this plugin from GitHub into your plugins directory, and navigate there in your terminal. +2. `bower install` +3. `npm install` +4. `git submodule update --init --recursive` +5. `cd wordpress-mailchimp-tools` +6. `composer install` +7. If something's missing, tell us by [filing an issue](https://github.com/INN/link-roundups/issues/new) or by sending an email to support@inn.org diff --git a/docs/link-roundups.md b/docs/link-roundups.md index c2a755e..3cf0d7a 100644 --- a/docs/link-roundups.md +++ b/docs/link-roundups.md @@ -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: + +![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: diff --git a/docs/mailchimp.md b/docs/mailchimp.md index c445ec2..6cef47d 100644 --- a/docs/mailchimp.md +++ b/docs/mailchimp.md @@ -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 @@ -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: @@ -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. \ No newline at end of file +![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. \ No newline at end of file