← All changes | README.md +84 -85 3.16.0 → 2.5.1 View file →

		@@ -1,14 +1,13 @@
1	1	# Parse.ly
2	2
3		-Stable tag: 3.16.0
4		-Requires at least: 5.2
5		-Tested up to: 6.5
6		-Requires PHP: 7.2
	3	+Stable tag: 2.5.1
	4	+Requires at least: 4.0
	5	+Tested up to: 5.6
	6	+Requires PHP: 5.6
7	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
	8	+Tags: analytics, parse.ly, parsely, parsley
	9	+Contributors: parsely, hbbtstar, jblz, mikeyarce, GaryJ, parsely_mike
11	10
12	11	The Parse.ly plugin facilitates real-time and historical analytics to your content through a platform designed and built for digital publishing.
13	12
14	13	## Description
		@@ -16,117 +15,117 @@
16	15	Designed and built for digital publishers, Parse.ly helps you understand how your audience is connecting to your content.
17	16
18	17	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.
19	18
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.
	19	+Join industry leaders -- like Mashable, Slate, News Corp, and Conde Nast -- who already use Parse.ly to bring clarity to content, audience, and analytics.
21	20
	21	+### Features
	22	+
	23	+- Get started with Parse.ly right away: the plugin automatically inserts the required metadata and JavaScript on all your published pages and posts.
	24	+- Choose what format the metadata takes, and whether logged-in users should be included in the analytics.
	25	+- If you've purchased access to the Parse.ly API, add a widget to your site with article recommendations personalized to individual users.
	26	+
22	27	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!
23	28
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).
	29	+## Installation
25	30
26		-### Features
	31	+The plugin requires an active Parse.ly account. Parse.ly gives creators, marketers, and developers the tools to understand content performance, prove content value, and deliver tailored content experiences that drive meaningful results.
	32	+[Sign up for a free trial of Parse.ly](http://www.parsely.com/trial/?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely).
27	33
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.
	34	+### Install the plugin from within WordPress
29	35
30		-#### Automated integration
	36	+1. Visit the Plugins page from your WordPress dashboard and click "Add New" at the top of the page.
	37	+1. Search for "parse.ly" using the search bar on the right side.
	38	+1. Click "Install Now" to install the plugin.
	39	+1. After it's installed, click "Activate" to activate the plugin on your site.
31	40
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).
	41	+### Install the plugin manually
36	42
37		-#### The Parse.ly Content Helper
	43	+1. Download the plugin from WordPress.org or get the latest release from our [Github Releases page](https://github.com/Parsely/wp-parsely/releases).
	44	+1. Unzip the downloaded archive.
	45	+1. Upload the entire `wp-parsely` folder to your `/wp-content/plugins` directory.
	46	+1. Visit the Plugins page from your WordPress dashboard and look for the newly installed Parse.ly plugin.
	47	+1. Click "Activate" to activate the plugin on your site.
38	48
39		-The [Content Helper](https://docs.parse.ly/plugin-content-helper/) is a set of content insight tools including:
40		-- The [Parse.ly Dashboard Widget](https://docs.parse.ly/plugin-content-helper/#h-dashboard) - Displays the site's top posts in the WordPress Dashboard.
41		-- The [Parse.ly Stats Column](https://docs.parse.ly/plugin-content-helper/#h-posts) - Displays published post performance for the last 7 days in Post Lists.
42		-- The [Parse.ly Editor Sidebar](https://docs.parse.ly/plugin-content-helper/#h-editor) - This sidebar is integrated into the WordPress Editor and offers insights about the content currently being edited such as:
43		- - [Title Suggestions](https://docs.wpvip.com/parse-ly/wp-parsely-features/title-suggestions/) - Generates title suggestions for the post/page currently being edited.
44		- - [Smart Linking](https://docs.wpvip.com/parse-ly/wp-parsely-features/smart-linking/) - Automatically adds links to the current content that point to the most relevant and top-performing posts.
45		- - [Related Posts](https://docs.parse.ly/plugin-content-helper/#h-related-posts) - Displays a list of the website’s most successful posts, similar to the post/page currently being edited.
46		- - [Performance Stats](https://docs.parse.ly/plugin-content-helper/#h-see-performance-details) - Displays performance metrics about the content currently being edited.
47		-- The [Parse.ly Excerpt Generator](https://docs.wpvip.com/parse-ly/wp-parsely-features/excerpt-generator/) - A Post Editor settings enhancement that generates an excerpt for the post/page currently being edited.
	49	+## Frequently Asked Questions
48	50
49		-#### The Parse.ly Recommendations Block
	51	+### Where do I find my Site ID?
50	52
51		-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/).
	53	+Your Site ID is likely your own site domain name (e.g., `mysite.com`). You can find this in your Parse.ly account.
52	54
53		-#### Advanced integrations support
	55	+### Why can't I see Parse.ly code on my post when I preview?
54	56
55		-While the plugin works out of the box for basic integrations, it offers a host of features that easily allow for advanced integration scenarios:
56		-- 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.
57		-- 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/).
58		-- 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.
59		-- Last but not least, a wide range of hooks is available in order to customize the plugin's functionality even further.
	57	+The code will only be placed on posts and pages which have been published in WordPress to ensure we don't track traffic generated while you're still writing a post or page.
60	58
61		-### Documentation and resources
	59	+You may also be not tracking logged-in users, via one of the settings.
62	60
63		-- [Plugin Documentation](https://docs.parse.ly/wordpress-plugin-setup/).
64		-- [Commonly Asked Questions](https://docs.parse.ly/plugin-common-questions/).
65		-- [Changelog](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).
	61	+### How can I edit the values passed to the JSON-LD metadata?
66	62
67		-**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.
	63	+You can use the `wp_parsely_metadata` filter, which sends three arguments: the array of metadata, the post object, and the `parsely_options` array:
68	64
69		-### Sample Parse.ly metadata
	65	+ add_filter( 'wp_parsely_metadata', 'filter_parsely_metadata', 10, 3 );
	66	+ function filter_parsely_page( $parsely_metadata, $post, $parsely_options ) {
	67	+ $parsely_metadata['articleSection'] = '...'; // Whatever values you want Parse.ly's Section to be.
	68	+ return $parsely_metadata;
	69	+ }
70	70
71		-The standard Parse.ly JavaScript tracker inserted before the closing `body` tag:
	71	+This filter can go anywhere in your codebase, provided it always gets loaded.
72	72
73		-~~~html
74		-<script id="parsely-cfg" data-parsely-site="example.com" src="https://cdn.parsely.com/keys/example.com/p.js"></script>
75		-~~~
	73	+### Is the plugin compatible with AMP and Facebook Instant Articles?
76	74
77		-A sample `JSON-LD` structured data for a home page or section page:
	75	+It is! The plugin hooks into Automattic's official plugins for [AMP](https://wordpress.org/plugins/amp/) and [Facebook Instant Articles](https://wordpress.org/plugins/fb-instant-articles/).
78	76
79		-~~~html
80		-<script type="application/ld+json">
81		-{"@context":"http:\/\/schema.org","@type":"WebPage","headline":"WordPress VIP","url":"http:\/\/wpvip.com\/"}
82		-</script>
83		-~~~
	77	+AMP support is enabled automatically if the Automattic AMP plugin is installed
84	78
85		-A sample `JSON-LD` meta tag and structured data for an article or post:
	79	+For Facebook Instant Articles support, enable "Parsely Analytics" in the "Advanced Settings" menu of the Facebook Instant Articles plugin.
86	80
87		-~~~html
88		-<script type="application/ld+json">
89		-{"@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":[]}
90		-</script>
91		-~~~
	81	+### Does the plugin support dynamic tracking?
92	82
93		-### Contributing
	83	+This plugin does not currently support dynamic tracking (the tracking of multiple pageviews on a single page).
94	84
95		-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.
	85	+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.
96	86
97		-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.
	87	+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.
98	88
99		-## Installation
	89	+### How do I create a local dev environment to make changes to the `wp-parsely` code?
100	90
101		-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).
	91	+See [the wiki](https://github.com/Parsely/wp-parsely/wiki/Setting-up-a-WP-plugin-development-environment).
102	92
103		-For more information, please visit the [installation instructions](https://docs.parse.ly/wordpress-plugin-setup/) in the official documentation.
	93	+## Screenshots
104	94
105		-## Frequently Asked Questions
	95	+1. The main admin screen of the Parse.ly plugin, showing some of the settings.
	96	+ 
106	97
107		-Please visit the [Commonly Asked Questions page](https://docs.parse.ly/plugin-common-questions/) in the official documentation.
	98	+2. The settings for the Parse.ly Recommended Widget. Engage your visitors with predictive and personalized recommendations from Parse.ly.
	99	+ 
	100	+3. A view of the Parse.ly Dashboard Overview. Parse.ly offers analytics that empowers you to better understand how your content is peforming.
	101	+ 
108	102
109		-## Changelog
	103	+## Sample Parse.ly metadata
110	104
111		-Please visit the [changelog](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).
	105	+The standard Parse.ly JavaScript tracker inserted before the closing `body` tag:
112	106
113		-## Screenshots
	107	+ <!-- START Parse.ly Include: Standard -->
114	108
115		-1. The Parse.ly Dashboard Widget, showing the website's top posts.
116		- 
117		-2. The Parse.ly Stats Column (on the right), showing information about content that is being tracked as Posts.
118		- 
119		-3. The Parse.ly Editor Sidebar, featuring the Title Suggestions panel.
120		- 
121		-4. The Parse.ly Editor Sidebar, featuring the Smart Linking panel.
122		- 
123		-5. The Parse.ly Editor Sidebar, featuring the Related Posts panel.
124		- 
125		-6. The Parse.ly Editor Sidebar, featuring the Performance Stats panel.
126		- 
127		-7. The Parse.ly Excerpt Generator in the Post Editor's settings.
128		- 
129		-8. The Recommendations Block, showcasing links to related content on your site.
130		- 
131		-9. A view of the Parse.ly Dashboard Overview. Parse.ly offers analytics that empower you to better understand how your content is performing.
132		- 
	109	+ <script data-cfasync="false" id="parsely-cfg" data-parsely-site="example.com" src="https://cdn.parsely.com/keys/example.com/p.js"></script>
	110	+
	111	+ <!-- END Parse.ly Include: Standard -->
	112	+
	113	+A sample `JSON-LD` structured data for a home page or section page:
	114	+
	115	+ <!-- BEGIN Parse.ly 2.5.0 -->
	116	+ <script type="application/ld+json">
	117	+ {"@context":"http:\/\/schema.org","@type":"WebPage","headline":"WordPress VIP","url":"http:\/\/wpvip.com\/"}
	118	+ </script>
	119	+ <!-- END Parse.ly -->
	120	+
	121	+A sample `JSON-LD` meta tag and structured data for an article or post:
	122	+
	123	+ <!-- BEGIN Parse.ly 2.5.0 -->
	124	+ <script type="application/ld+json">
	125	+ {"@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":[]}
	126	+ </script>
	127	+ <!-- END Parse.ly -->
	128	+
	129	+## Changelog
	130	+
	131	+See the [change log](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).