Wordpress Styla Magazine Plugin

Installation How-to

Author: Sebastian Sachtleben, Christian Korndörfer

Compatibility: Wordpress 4.2.2 - 4.9.X

This Wordpress plugin provides the SEO and Routing functionality for a Styla by embedding Styla content on a specific path. This documentation page should provide you an overview of how Styla works in general.

Installation

1. Install and activate the following plugin to allow php in pages: https://wordpress.org/plugins/allow-php-in-posts-and-pages/

2. Copy the entire StylaMagazine folder into your wp-content/plugins folder

3. Activate the StylaMagazine plugin in Wordpress

4. Go to Settings -> StylaMagazine and configure the plugin (see Configuration). Click "Save Changes" when ready.

5. Add [php] styla_body(); [/php] on the page the magazine should be placed

6. Go to Settings -> Permalinks and hit the "Save Changes" button (you don't need to change anything on this site) - this will refresh internal redirects for all magazine urls (e.g. /story/asdf-1234)

In case routing for the Styla content does not work, please CHECK THE POINT 6. AGAIN. If you don't save this settings, the new routing settings won't kick in.

Configuration

• Domain - Domain name of the magazine to embed and provided by Styla. If unclear please contact [email protected]
• Magazine Root Path - Page slug to your magazine. Example: The slug for mydomain.com/magazine would be "magazine" and can be found on the top of the page edit. Leave empty if your magazine is supposed to be displayed on your front page (e.g. mydomain.com/)

• SEO Server - Server used to fetch SEO information for the magazine and it's content. Should not be changed without double-checking with Styla.
• Content Server - Server providing Styles and Javascript for the magazine and it's content. Should not be changed without double-checking with Styla.
• Version Server - Server providing the current Version for the magazines Styles and Scripts. Should not be changed without double-checking with Styla.

SEO Content from Styla's SEO API

The plugin uses data from Styla's SEO API to:

• generate tags like: meta tags including <title>, canonical link, og:tags, static content inserted into , robots instructions
• insert these tags accordingly into HTML of the template the page with Styla content uses

This is done to provide search engine bots with data to crawl and index all Styal URLs, which are in fact a Single-Page-Application.

Once you install and configure the module, please open source of the page on which your Styla content is embedded and check if none of the tags mentioned below are duplicated. In case robotsor link rel="canonical" or any other are in the HTML twice, make sure to remove the original ones coming from your default template. Otherwise search engine bots might not be able to crawl all the Styla content or crawl it incorrectly.

You can find more information on the SEO API on this page

Using Styla with WPML Plugin

If you use the WordPress Multilingual Plugin to localize content on your website and want to use different magazines for each language, please use your default language Styla domain name within the StylaMagazine plugin settings described in Configuration/Domain above. So if your default language is English, it should look like this:

For other languages, you will need to override this main magazine setting in the WPML plugin itself. In order to do that:

• log in to your WP backend
• navigate to WPML -> String Translations
• select StylaMagazine from the drop-down field top of the list
• set a separate styla_username per each language version handled by WPML:

For example, if your default language is English, then:

• mydomain-en is set in the plugin settings to be the default,
• mydomain-de is set in WPML String Translations setting to be used only for German language.

Changes

2.0.0

• The plugin now requests Styla page content from Styla SEO API without base path defined in its settings.
• If you update your plugin version to this one, please contact Styla to update your client settings on their end. Otherwise Styla content might not work as intended.

1.2.8

• fixed placement of seo html

1.2.7

• check if 404 template exists before including

1.2.6

• use icl_t method only when wpml is present

1.2.5

• fixed support for magazine on frontpage
• support for wpml with separate magazines per language
• remove YOAST plugin meta tags
• replace properly title tag with YOAST plugin

---

1.2.4

• added pages to rewrites
• support 404 errors with magazine on startpage

---

1.2.3

• added categories path to rewrites

---

1.2.2

• using client-scripts.styla.com instead of cdn.styla.com

---

1.2.1

• now using cURL instead of file_get_contents()

---

1.2.0

• Accepts pagination offset parameter
• 404 status header and page on non existent offsets/pages

---

1.1.2

• replace magazine title only on magazine pages

---

1.1.1

• updated the plugin to work with WPML Multilingual CMS

---

1.1.0

• using wordpress redirects instead of .htaccess redirects
• removed duplicates SEO attributes in

---

• 1.0.8 - now using CDN integration
• 1.0.7 - integrated SEO API
• 1.0.6 - Removed magazine path for the seo fetch
• 1.0.5 - Only fetch content, set statuscode and output styla magazine if magazine path matches
• 1.0.4 - Fixed seo problems for story and account urls
• 1.0.3 - Replaced file_get_contents with curl (removed 'allow__url_fopen' dependency from php.ini)
• 1.0.2 - Remove addslashes inside get_web_page method
• 1.0.1 - Allow to run magazine on a sub path
• 1.0.0 - Initial release

Known Issues

• The plugin uses the Wordpress cache which is not persist by default (see: https://codex.wordpress.org/Class_Reference/WP_Object_Cache#Persistent_Caching)