| 1 |
# Parse.ly # |
| 2 |
The Parse.ly plugin real-time and historical analytics to your content through a platform designed and built for digital publishing. |
| 3 |
|
| 4 |
## Description ## |
| 5 |
|
| 6 |
Designed and built for digital publishers, Parse.ly helps you understand how your audience is connecting to your content. |
| 7 |
|
| 8 |
Thousands of writers, editors, site managers, and technologists already use Parse.ly to understand what content draws in website visitors, and why. Using our powerful dashboards and APIs, customers build successful digital strategies that allow them to grow and engage a loyal audience. |
| 9 |
|
| 10 |
Join industry leaders -- like Mashable, Slate, News Corp, and Conde Nast -- who already use Parse.ly to bring clarity to content, audience, and analytics. |
| 11 |
|
| 12 |
**Features** |
| 13 |
|
| 14 |
* Get started with Parse.ly right away: the plugin automatically inserts the required parsely-page tag and JavaScript on all your published pages and posts. |
| 15 |
* Allows you to specify the JavaScript implementation to use: standard, DOM free or asynchronous. |
| 16 |
* If you've purchased access to the Parse.ly API, add a widget to your site with story recommendations personalized to individual users. |
| 17 |
|
| 18 |
Feedback, suggestions, questions or concerns? E-mail us at [](mailto:support@parsely.comsupport@parsely.com](mailto:support@parsely.com](mailto:support@parsely.com) we always want to hear from you. |
| 19 |
|
| 20 |
## Installation ## |
| 21 |
|
| 22 |
1. This plug-in requires an active version of Parse.ly. We offer a free trial, [](http://www.parsely.com/trial/?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parselysign up here](http://www.parsely.com/trial/?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely](http://www.parsely.com/trial/?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely) |
| 23 |
1. If you haven't already done so, [](http://www.parsely.com/trial/?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parselysign up for a trial of Parse.ly](http://www.parsely.com/trial/?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely](http://www.parsely.com/trial/?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely) |
| 24 |
1. Download the plugin |
| 25 |
1. Upload the entire `wp-parsely` folder to your `/wp-content/plugins` directory |
| 26 |
1. Activate the plugin through the 'Plugins' menu in WordPress (look for "Parse.ly") |
| 27 |
1. Head to the settings page for the plugin (should be /wp-admin/options-general.php?page=parsely) |
| 28 |
1. Set your Site ID, which is your own site domain name (e.g., `mysite.com`) |
| 29 |
1. Save your changes and enjoy your data! |
| 30 |
|
| 31 |
**NOTE:** This plugin does not currently support dynamic tracking (the tracking of multiple pageviews on a single page). Some common use-cases for dynamic tracking are slideshows or articles loaded via AJAX calls in single-page applications -- situations in which new content is loaded without a full page refresh. Tracking these events requires manually implementing additional JavaScript above [](http://www.parsely.com/help/integration/basic/the standard Parse.ly include](http://www.parsely.com/help/integration/basic/](http://www.parsely.com/help/integration/basic/) that the plugin injects into your page source. Please consult [](https://www.parsely.com/help/integration/dynamic/the Parse.ly documentation on dynamic tracking](https://www.parsely.com/help/integration/dynamic/](https://www.parsely.com/help/integration/dynamic/) for instructions on implementing dynamic tracking, or contact Parse.ly support for additional assistance. |
| 32 |
|
| 33 |
Feedback, suggestions, questions or concerns? E-mail us at [](mailto:support@parsely.comsupport@parsely.com](mailto:support@parsely.com](mailto:support@parsely.com) -- we always want to hear from you. |
| 34 |
|
| 35 |
## Tests ## |
| 36 |
|
| 37 |
1. Follow the steps to install VirtualBox, Vagrant and `vagrant-hostsupdater` at [](http://vccw.cc/http://vccw.cc/](http://vccw.cc/](http://vccw.cc/). |
| 38 |
1. Navigate to the directory on your host machine to which you downloaded vccw. |
| 39 |
1. Within that directory, navigate to `www/wordpress/wp-content/plugins` and clone this repo -- `git clone https://github.com/Parsely/wp-parsely.git` |
| 40 |
1. Checkout the branch on which you've been working |
| 41 |
1. Navigate back up to the root of the `vccw` directory and run `vagrant up` |
| 42 |
1. Ssh into the Vagrant machine with `vagrant ssh` |
| 43 |
1. Navigate to `/var/www/wordpress/wp-content/plugins/wp-parsely` and run the test suite with the command `phpunit` |
| 44 |
|
| 45 |
## Frequently Asked Questions ## |
| 46 |
|
| 47 |
### Where do I find my Site ID? ### |
| 48 |
|
| 49 |
Your Site ID is your own site domain name (e.g., `mysite.com`). |
| 50 |
|
| 51 |
### Why can't I see Dash code on my post when I preview? ### |
| 52 |
|
| 53 |
Dash code will only be placed on pages and posts which have been published in WordPress to ensure we don't track traffic generated while you're still writing a post/page. |
| 54 |
|
| 55 |
### How can I edit the values passed to the JSON-LD metadata? ### |
| 56 |
|
| 57 |
You can use the `after_set_parsely_page` filter, which sends three arguments: the array of metadata, the post object, and the `parselyOptions` array: |
| 58 |
|
| 59 |
``` |
| 60 |
function filter_parsely_page($parselyPage, $post, $parselyOptions ) { |
| 61 |
$parselyPage['articleSection'] = ; // whatever values you want Parse.ly's Section to be |
| 62 |
return $parselyPage; |
| 63 |
} |
| 64 |
|
| 65 |
add_filter( 'after_set_parsely_page', 'filter_parsely_page', 10, 3); |
| 66 |
``` |
| 67 |
|
| 68 |
This filter can go anywhere in your codebase, provided it always gets loaded. We recommend putting it in your header file, so that it gets loaded with wp_head. |
| 69 |
|
| 70 |
### Is the plugin Google AMP/Facebook Instant ready? |
| 71 |
|
| 72 |
It is! We are hooked into Automattic's official plugins for AMP and Facebook Instant. AMP support is enabled automatically if the Automattic AMP plugin is installed, and for Facebook Instant you just have to enable "Parsely Analytics" in the "Advanced Settings" menu of the Facebook Instant Articles plugin. |
| 73 |
|
| 74 |
Official AMP plugin: https://wordpress.org/plugins/amp/ |
| 75 |
Official FB Instant plugin: https://wordpress.org/plugins/fb-instant-articles/ |
| 76 |
|
| 77 |
### How do I create a local dev environment to make changes to the `wp-parsely` code? ### |
| 78 |
|
| 79 |
See [](https://github.com/Parsely/wp-parsely/wiki/Setting-up-a-WP-plugin-development-environmentthe wiki](https://github.com/Parsely/wp-parsely/wiki/Setting-up-a-WP-plugin-development-environment](https://github.com/Parsely/wp-parsely/wiki/Setting-up-a-WP-plugin-development-environment). |
| 80 |
|
| 81 |
## Screenshots ## |
| 82 |
|
| 83 |
#### 1. The main settings screen of the wp-parsely plugin #### |
| 84 |
 |
| 85 |
|
| 86 |
#### 2. The standard JavaScript include being inserted before `</body>` #### |
| 87 |
 |
| 88 |
|
| 89 |
#### 3. A sample `JSON-LD` meta tag for a home page or section page #### |
| 90 |
 |
| 91 |
|
| 92 |
#### 4. A sample `JSON-LD` meta tag for an article or post #### |
| 93 |
 |
| 94 |
|
| 95 |
## Changelog ## |
| 96 |
|
| 97 |
### 2.0 ### |
| 98 |
* Changes JavaScript integration to directly load tracker bundles that are customized for your specific site ID: https://www.parse.ly/help/integration/basic/. NOTE: Sites that have custom Parse.ly video tracking configured (outside of the Parse.ly WordPress plugin) for a player listed at https://www.parse.ly/help/integration/video_v2/#supported-players should contact support@parsely.com before upgrading. |
| 99 |
|
| 100 |
### 1.14 ### |
| 101 |
* Updates AMP analytics implementation |
| 102 |
* Adds ability to use a horizontal layout of the widget (for page footers) |
| 103 |
* Adds itm campaign parameters to widget links for tracking performance |
| 104 |
* Adds option to use original or resized thumbnail in widget |
| 105 |
* Improves handling of missing taxonomy terms and other data |
| 106 |
* Improves post status check |
| 107 |
* Code cleanup to conform to WordPress VIP standards |
| 108 |
|
| 109 |
### 1.13 ### |
| 110 |
* Makes AMP integration optional |
| 111 |
* Adds support for publisher logo information |
| 112 |
* Minor bugfixes |
| 113 |
|
| 114 |
### 1.12 ### |
| 115 |
* Adds ability to use repeated meta tags instead of ld+json tags for metadata |
| 116 |
* Code cleanup to conform to WordPress VIP standards |
| 117 |
* Minor bugfixes |
| 118 |
|
| 119 |
### 1.11 ### |
| 120 |
* Adds ability to use Parsely API with widget |
| 121 |
* Adds ability to track or not track custom page and post types |
| 122 |
* Adds ability to disable Javascript tracking |
| 123 |
* Minor bugfixes |
| 124 |
|
| 125 |
### 1.10 ### |
| 126 |
* Adds ability to filter final JSON-LD output |
| 127 |
* Adds the ability to use a custom taxonomy as tags |
| 128 |
* Adds AMP / Facebook Instant integration with official AMP / FBIA plugins from Automattic |
| 129 |
* Fixes bug related to HTTPS canonicals |
| 130 |
|
| 131 |
### 1.9 ### |
| 132 |
* Ability to assign custom taxonomies as section |
| 133 |
* Bug fix related to adding section to tag field |
| 134 |
|
| 135 |
### 1.8 ### |
| 136 |
* Updated documentation for installation and local development |
| 137 |
* Allow developers to adjust the tag list and the category reported for a post |
| 138 |
* Added support for themes to extend the reported authors |
| 139 |
|
| 140 |
### 1.7 ### |
| 141 |
* Use JSON-LD / schema.org for parsely-page data instead of proprietary format |
| 142 |
* Added support for multiple authors if using the Co-Authors Plus plugin https://wordpress.org/plugins/co-authors-plus/ |
| 143 |
|
| 144 |
### 1.6 ### |
| 145 |
* Maintenance release with multiple changes needed for WordPress VIP inclusion |
| 146 |
* Migrated to WP Settings API |
| 147 |
* Various syntax changes in line with Automattic's guidelines |
| 148 |
* Removed the tracker_implementation option, plugin now uses Standard implementation for all installs |
| 149 |
* Updated much of the copy in settings page |
| 150 |
* Updated screenshots |
| 151 |
|
| 152 |
### 1.5 ### |
| 153 |
* Added support for new option - "Use Categories as Tags" |
| 154 |
* Fixed bug that caused wp-admin bar to be hidden when "Do not track authenticated in users" was selected |
| 155 |
* Fixed WP category logic bug that failed on users with custom post types |
| 156 |
|
| 157 |
### 1.4 ### |
| 158 |
* Added early support for post tags |
| 159 |
* Fixed permalink errors on category/author/tag pages |
| 160 |
* Added version output to both templates and settings pages |
| 161 |
* Renamed API key to Site ID to avoid confusion |
| 162 |
|
| 163 |
### 1.3 ### |
| 164 |
* Added option to not track or not track authenticated users (default is to not track authenticated users) |
| 165 |
* Removed async implementation option |
| 166 |
* Updated API key retrieval instructions |
| 167 |
* Added activation/deactivation hooks |
| 168 |
* null categories are now set to "Uncategorized" |
| 169 |
|
| 170 |
### 1.2 ### |
| 171 |
* Support for using top-level categories for posts instead of the first active post the plugin finds |
| 172 |
* parsely-page meta tag now outputs it's value using 'content' attribute instead of 'value' |
| 173 |
* Minor fixes to outputting to use proper WordPress functions |
| 174 |
|
| 175 |
### 1.1 ### |
| 176 |
* Added ability to add prefix to content IDs |
| 177 |
* Ensured plugin only uses long tags `<?php` instead of `<?` |
| 178 |
* Security updates to prevent HTML/JavaScript injection attacks (values are now sanitized) |
| 179 |
* Better error checking of values for API key / implementation method |
| 180 |
* Bug fixes |
| 181 |
|
| 182 |
### 1.0 ### |
| 183 |
* Initial version |
| 184 |
* Support for parsely-page and JavaScript on home page and published pages and posts as well as archive pages (date/author/category/tag) |
| 185 |
|
| 186 |
|
