← All changes | README.md +123 -95 3.23.7 → 1.12.2 View file →

		@@ -1,135 +1,163 @@
1		-# Parse.ly
	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.
2	3
3		-Stable tag: 3.23.7
4		-Requires at least: 6.0
5		-Tested up to: 6.9
6		-Requires PHP: 7.4
7		-License: GPLv2 or later
8		-License URI: https://www.gnu.org/licenses/gpl-2.0.html
9		-Tags: analytics, statistics, stats, content marketing, parsely, parsley, parse.ly
10		-Contributors: parsely, hbbtstar, jblz, mikeyarce, GaryJ, parsely_mike, acicovic, mehmoodak, vaurdan
	4	+## Description ##
11	5
12		-The Parse.ly plugin facilitates real-time and historical analytics to your content through a platform designed and built for digital publishing.
	6	+Designed and built for digital publishers, Parse.ly helps you understand how your audience is connecting to your content.
13	7
14		-## Description
	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.
15	9
16		-Designed and built for digital publishers, Parse.ly helps you understand how your audience is connecting to your content.
	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.
17	11
18		-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.
	12	+**Features**
19	13
20		-Join industry leaders -- like NBA, Slate, News Corp, and Condé Nast -- who already use Parse.ly to bring clarity to content, audience, and analytics.
	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.
21	17
22		-Feedback, suggestions, questions or concerns? Open a new [GitHub issue](https://github.com/Parsely/wp-parsely/issues) or email us at [support@parsely.com](mailto:support@parsely.com). We always want to hear from you!
	18	+Feedback, suggestions, questions or concerns? E-mail us at [support@parsely.com](mailto:support@parsely.com) we always want to hear from you.
23	19
24		-**NOTE:** The plugin requires an active Parse.ly account. [Sign up for a free Parse.ly demo](https://www.parsely.com/getdemo?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely).
	20	+## Installation ##
25	21
26		-### Features
	22	+1. This plug-in requires an active version of Parse.ly. We offer a free trial, [sign up here](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, [sign up for a trial of Parse.ly](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!
27	30
28		-The wp-parsely plugin is packed with features that allow for a seamless integration process, and brings the power of the Parse.ly dashboard into WordPress.
	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 [the standard Parse.ly include](http://www.parsely.com/help/integration/basic/) that the plugin injects into your page source. Please consult [the Parse.ly documentation on dynamic tracking](https://www.parsely.com/help/integration/dynamic/) for instructions on implementing dynamic tracking, or contact Parse.ly support for additional assistance.
29	32
30		-#### Automated integration
	33	+Feedback, suggestions, questions or concerns? E-mail us at [support@parsely.com](mailto:support@parsely.com) -- we always want to hear from you.
31	34
32		-The plugin automatically inserts the Parse.ly metadata and JavaScript in all published pages and posts (Custom Post Types are supported). It also provides a settings page to customize your integration, with options including:
33		-- Output Parse.ly metadata as [JSON-LD](https://docs.parse.ly/metadata-jsonld/) or [repeated meta tags](https://docs.parse.ly/metatags/).
34		-- Choose whether logged-in users should be tracked.
35		-- Define how to track every Post Type (as Post, Non-Post or no tracking).
	35	+## Tests ##
36	36
37		-#### Parse.ly Content Intelligence
	37	+1. Follow the steps to install VirtualBox, Vagrant and `vagrant-hostsupdater` at [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`
38	44
39		-[Content Intelligence](https://docs.parse.ly/plugin-content-intelligence/) is a set of content insight tools including:
40		-- The [Parse.ly Dashboard Widget](https://docs.parse.ly/plugin-content-intelligence/#h-dashboard) - Displays the site's top posts in the WordPress Dashboard.
41		-- The [Parse.ly Stats Column](https://docs.parse.ly/plugin-content-intelligence/#h-posts) - Displays published post performance for the last 7 days in Post Lists.
42		-- The [Engagement Boost](https://docs.wpvip.com/parse-ly/parsely-features/engagement-boost/) feature - Helps you increase page views and engagement by strategically placing links to key content within high-performing articles on your site.
43		-- The [Parse.ly Editor Sidebar](https://docs.parse.ly/plugin-content-intelligence/#h-editor) - This sidebar is integrated into the WordPress Editor and offers insights about the content currently being edited such as:
44		- - [Title Suggestions](https://docs.wpvip.com/parse-ly/parsely-features/title-suggestions/) - Generates title suggestions for the post/page currently being edited.
45		- - [Excerpt Suggestions](https://docs.wpvip.com/parse-ly/parsely-features/excerpt-suggestions/) - Generates an excerpt suggestion for the post/page currently being edited.
46		- - [Smart Linking](https://docs.wpvip.com/parse-ly/parsely-features/smart-linking/) - Automatically adds links to the current content that point to the most relevant and top-performing posts.
47		- - [Related Posts](https://docs.parse.ly/plugin-content-intelligence/#h-related-posts) - Displays a list of the website’s most successful posts, similar to the post/page currently being edited.
48		- - [Performance Stats](https://docs.parse.ly/plugin-content-intelligence/#h-see-performance-details) - Displays performance metrics about the content currently being edited.
	45	+## Frequently Asked Questions ##
49	46
50		-#### The Parse.ly Recommendations Block
	47	+### Where do I find my Site ID? ###
51	48
52		-The plugin includes a [Recommendations Block](https://docs.parse.ly/recommendations-block/) that displays a list of posts related to the currently viewed post/page. The Block is useful for showcasing related content to visitors, and it can also be used in Site Editing mode or as a [Block-based Widget](https://wordpress.org/documentation/article/block-based-widgets-editor/).
	49	+Your Site ID is your own site domain name (e.g., `mysite.com`).
53	50
54		-#### Advanced integrations support
	51	+### Why can't I see Dash code on my post when I preview? ###
55	52
56		-While the plugin works out of the box for basic integrations, it offers a host of features that easily allow for advanced integration scenarios:
57		-- Support for [Google Tag Manager, AMP, Google Web Stories and Cloudflare](https://docs.parse.ly/plugin-common-questions/#h-is-wp-parsely-compatible-with-amp-or-google-web-stories) is included.
58		-- The plugin exposes the `wpParselyOnLoad` and `wpParselyOnReady` JavaScript hooks that allow for advanced integrations requiring JavaScript, such as [Dynamic Tracking](https://docs.parse.ly/plugin-dynamic-tracking/).
59		-- Support for WordPress [network/multisite](https://docs.parse.ly/plugin-common-questions/#h-is-wp-parsely-compatible-with-wordpress-network-multisite) and [decoupled/headless](https://docs.parse.ly/decoupled-set-up/) (GraphQL and WP Rest API) setups is included.
60		-- Last but not least, a wide range of hooks is available in order to customize the plugin's functionality even further.
	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.
61	54
62		-### Documentation and resources
	55	+### How can I edit the values passed to the JSON-LD metadata? ###
63	56
64		-- [Plugin Documentation](https://docs.parse.ly/wordpress-plugin-setup/).
65		-- [Commonly Asked Questions](https://docs.parse.ly/plugin-common-questions/).
66		-- [Changelog](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).
	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:
67	58
68		-**IMPORTANT:** If you are a [WordPress VIP](https://wpvip.com/) customer, please consult the [WordPress VIP documentation](https://docs.wpvip.com/parse-ly/) for more details.
	59	+```
	60	+$parselyPage = apply_filters('after_set_parsely_page', $parselyPage, $post, $parselyOptions);
	61	+```
69	62
70		-### Sample Parse.ly metadata
	63	+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.
71	64
72		-The standard Parse.ly JavaScript tracker inserted before the closing `body` tag:
	65	+### Is the plugin Google AMP/Facebook Instant ready?
73	66
74		-~~~html
75		-<script id="parsely-cfg" data-parsely-site="example.com" src="https://cdn.parsely.com/keys/example.com/p.js"></script>
76		-~~~
	67	+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.
77	68
78		-A sample `JSON-LD` structured data for a home page or section page:
	69	+Official AMP plugin: https://wordpress.org/plugins/amp/
	70	+Official FB Instant plugin: https://wordpress.org/plugins/fb-instant-articles/
79	71
80		-~~~html
81		-<script type="application/ld+json">
82		-{"@context":"http:\/\/schema.org","@type":"WebPage","headline":"WordPress VIP","url":"http:\/\/wpvip.com\/"}
83		-</script>
84		-~~~
	72	+### How do I create a local dev environment to make changes to the `wp-parsely` code? ###
85	73
86		-A sample `JSON-LD` meta tag and structured data for an article or post:
	74	+See [the wiki](https://github.com/Parsely/wp-parsely/wiki/Setting-up-a-WP-plugin-development-environment).
87	75
88		-~~~html
89		-<script type="application/ld+json">
90		-{"@context":"http:\/\/schema.org","@type":"NewsArticle","mainEntityOfPage":{"@type":"WebPage","@id":"http:\/\/wpvip.com\/2021\/04\/09\/how-the-wordpress-gutenberg-block-editor-empowers-enterprise-content-creators\/"},"headline":"How the WordPress Gutenberg Block Editor Empowers Enterprise Content Creators","url":"http:\/\/wpvip.com\/2021\/04\/09\/how-the-wordpress-gutenberg-block-editor-empowers-enterprise-content-creators\/","thumbnailUrl":"https:\/\/wpvip.com\/wp-content\/uploads\/2021\/04\/ladyatdesk.png?w=120","image":{"@type":"ImageObject","url":"https:\/\/wpvip.com\/wp-content\/uploads\/2021\/04\/ladyatdesk.png?w=120"},"dateCreated":"2021-04-09T15:13:13Z","datePublished":"2021-04-09T15:13:13Z","dateModified":"2021-04-09T15:13:13Z","articleSection":"Gutenberg","author":[{"@type":"Person","name":"Sam Wendland"}],"creator":["Sam Wendland"],"publisher":{"@type":"Organization","name":"The Enterprise Content Management Platform | WordPress VIP","logo":"https:\/\/wpvip.com\/wp-content\/uploads\/2020\/11\/cropped-favicon-dark.png"},"keywords":[]}
91		-</script>
92		-~~~
	76	+## Screenshots ##
93	77
94		-### Contributing
	78	+#### 1. The main settings screen of the wp-parsely plugin ####
	79	+
95	80
96		-Development, code hosting and issue tracking of this plugin happens on the [wp-parsely GitHub repository](https://github.com/Parsely/wp-parsely/). Active development happens on the `develop` branch and releases are made off the `trunk` branch.
	81	+#### 2. The standard JavaScript include being inserted before `</body>` ####
	82	+
97	83
98		-To run the plugin locally or to contribute to it, please check the instructions in the [CONTRIBUTING](https://github.com/Parsely/wp-parsely/blob/develop/docs/CONTRIBUTING.md) file.
	84	+#### 3. A sample `JSON-LD` meta tag for a home page or section page ####
	85	+
99	86
100		-## Installation
	87	+#### 4. A sample `JSON-LD` meta tag for an article or post ####
	88	+
101	89
102		-The plugin requires an active Parse.ly account. [Sign up for a free demo of Parse.ly](https://www.parsely.com/getdemo?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely).
	90	+## Changelog ##
103	91
104		-For more information, please visit the [installation instructions](https://docs.parse.ly/wordpress-plugin-setup/) in the official documentation.
	92	+### 1.12 ###
	93	+* Adds ability to use repeated meta tags instead of ld+json tags for metadata
	94	+* Code cleanup to conform to WordPress VIP standards
	95	+* Minor bugfixes
105	96
106		-## Frequently Asked Questions
	97	+### 1.11 ###
	98	+* Adds ability to use Parsely API with widget
	99	+* Adds ability to track or not track custom page and post types
	100	+* Adds ability to disable Javascript tracking
	101	+* Minor bugfixes
107	102
108		-Please visit the [Commonly Asked Questions page](https://docs.parse.ly/plugin-common-questions/) in the official documentation.
	103	+### 1.10 ###
	104	+* Adds ability to filter final JSON-LD output
	105	+* Adds the ability to use a custom taxonomy as tags
	106	+* Adds AMP / Facebook Instant integration with official AMP / FBIA plugins from Automattic
	107	+* Fixes bug related to HTTPS canonicals
109	108
110		-## Changelog
	109	+### 1.9 ###
	110	+* Ability to assign custom taxonomies as section
	111	+* Bug fix related to adding section to tag field
111	112
112		-Please visit the [changelog](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).
	113	+### 1.8 ###
	114	+* Updated documentation for installation and local development
	115	+* Allow developers to adjust the tag list and the category reported for a post
	116	+* Added support for themes to extend the reported authors
113	117
114		-## Screenshots
	118	+### 1.7 ###
	119	+* Use JSON-LD / schema.org for parsely-page data instead of proprietary format
	120	+* Added support for multiple authors if using the Co-Authors Plus plugin https://wordpress.org/plugins/co-authors-plus/
115	121
116		-1. The Parse.ly Dashboard Widget, showing the website's top posts.
117		- 
118		-2. The Parse.ly Stats Column (on the right), showing information about content that is being tracked as Posts.
119		- 
120		-3. The Parse.ly Engagement Boost feature.
121		- 
122		-4. The Parse.ly Editor Sidebar, featuring the Title Suggestions panel.
123		- 
124		-5. The Parse.ly Editor Sidebar, featuring the Smart Linking panel.
125		- 
126		-6. The Parse.ly Editor Sidebar, featuring the Related Posts panel.
127		- 
128		-7. The Parse.ly Editor Sidebar, featuring the Performance Stats panel.
129		- 
130		-8. The Parse.ly Excerpt Suggestions in the Post Editor's settings. Also available in the Parse.ly Editor Sidebar.
131		- 
132		-9. The Recommendations Block, showcasing links to related content on your site.
133		- 
134		-10. A view of the Parse.ly Dashboard Overview. Parse.ly offers analytics that empower you to better understand how your content is performing.
135		- 
	122	+### 1.6 ###
	123	+* Maintenance release with multiple changes needed for WordPress VIP inclusion
	124	+* Migrated to WP Settings API
	125	+* Various syntax changes in line with Automattic's guidelines
	126	+* Removed the tracker_implementation option, plugin now uses Standard implementation for all installs
	127	+* Updated much of the copy in settings page
	128	+* Updated screenshots
	129	+
	130	+### 1.5 ###
	131	+* Added support for new option - "Use Categories as Tags"
	132	+* Fixed bug that caused wp-admin bar to be hidden when "Do not track authenticated in users" was selected
	133	+* Fixed WP category logic bug that failed on users with custom post types
	134	+
	135	+### 1.4 ###
	136	+* Added early support for post tags
	137	+* Fixed permalink errors on category/author/tag pages
	138	+* Added version output to both templates and settings pages
	139	+* Renamed API key to Site ID to avoid confusion
	140	+
	141	+### 1.3 ###
	142	+* Added option to not track or not track authenticated users (default is to not track authenticated users)
	143	+* Removed async implementation option
	144	+* Updated API key retrieval instructions
	145	+* Added activation/deactivation hooks
	146	+* null categories are now set to "Uncategorized"
	147	+
	148	+### 1.2 ###
	149	+* Support for using top-level categories for posts instead of the first active post the plugin finds
	150	+* parsely-page meta tag now outputs it's value using 'content' attribute instead of 'value'
	151	+* Minor fixes to outputting to use proper WordPress functions
	152	+
	153	+### 1.1 ###
	154	+* Added ability to add prefix to content IDs
	155	+* Ensured plugin only uses long tags `<?php` instead of `<?`
	156	+* Security updates to prevent HTML/JavaScript injection attacks (values are now sanitized)
	157	+* Better error checking of values for API key / implementation method
	158	+* Bug fixes
	159	+
	160	+### 1.0 ###
	161	+* Initial version
	162	+* Support for parsely-page and JavaScript on home page and published pages and posts as well as archive pages (date/author/category/tag)
	163	+