Table of contents
What is Setka Editor?
Setka Editor is a WYSIWYG editor for online publications and blogs. It allows users to create beautiful and complex layouts for written content and visually standout digital publishing quickly and easily — all without having to code or rely on developers.
The Setka Editor plugin for WordPress has successfully passed a code review and is available for the WordPress VIP GO platform. This review affirms the high quality of our development efforts and guarantees the stability and functionality for Setka-powered websites and visual-rich pages.
Setka Editor integration
Integration of Setka Editor and a CMS comes in 2 stages:
- Content Design System Manager (CDSM) integration — to update styles from the CDSM account and the editor itself.
- Editor initialization on a CMS' post editor page.
How to register and configure Setka Account
To start the integration, it is necessary to create Setka Account (if you don't have one). After the registration, go to "Integrations" on editor.setka.io and select "Add your domain" in the "Set your domain" block. Then select "Via API" as an integration type.
What is necessary for the integration
- Fill in the license key. It is located in your Setka Account, on the "CMS Integration" page. It is not necessary to create a text field in an interface of your CMS, you can just add it into code. The license key is being transferred with your GET-requests.
- Fill in the Editor config URL in the "CMS Integration" -> "Other" tab.
Editor config URL is an address on which you will receive a recent version of the editor and style updates, created in the Content Design System Manager (CDSM), into to your CMS. On initial sync, you will also receive a public_token, which is required for several editor functions to work, e.g. for commenting and inserting embeds via URL.
Important note: the link should be specified with a protocol (http/https) for the correct integration.
Note: it is not possible to specify a local server (localhost, 127.0.0.1). Public IP-address on DNS servers should match the domain. Set up a tunnel with an external address, if you want to test an interaction with a local server, e.g. with the localtunnel service.
Company — a Setka client, each company of which has a website with a license key and an account in the Content Design System Manager (CDSM).
License key — company's unique ID, used to connect client websites with the CDSM.
Public key (public token) — a public ID used to send auxiliary requests from the editor to the CDSM. You can receive it in response to initial synchronization. The public key must be handled to editor initialization.
Content Design System Manager (CDSM) (located in Setka Account):
- A company account.
- An interface for creating and editing styles (fonts, text formats, color palettes, etc.) and layout grid (column parameters, indentations, and margins).
- An API for an automatic connection between client website and Setka Editor.
editor.min.js — editor's main JS file (hereinafter – editor.js).
editor.min.css — main CSS file, contains editor's interface styles (hereinafter — editor.css).
Post — HTML-code of the post, wrapped into <div class=“stk-post”>...</div>.
Style — set of CSS rules for text styles, fonts, colors, dividers, etc., defines a corporate identity. Being edited in the CDSM.
Grid — set of CSS rules for building modular grids with columns and indents, used in post layouts and mobile versions. Being edited in the CDSM.
Styles and grids can be built-in or custom. They are being created in CDSM. CDSM generates a new pair of files on each change:
company.min.css — CSS rules for all the company's styles and grids (hereinafter — company.css).
company.json — JSON metadata of styles, grids, etc. (hereinafter — company.json).
public.js — JS file with scripts to launch interactive elements of a post (animations and galleries). Activates on external post pages only.
Is Setka Editor compatible with my CMS?
Setka Editor is currently available on WordPress, Drupal, Magento, and Ghost, and can be integrated with any platform, such as Joomla, MOD X, Typo3, or your own-written CMS.
Does Setka Editor code meet the requirements of SEO?
Setka Editor generates well-structured code that meets the requirements of SEO. In the development of Setka Editor, we pay a lot of attention to semantics and correct code structure following the HTML5 standard. Setka Editor edits the page content only, thus it generates the code with a less nesting level, unlike tools that generate the entire page (page builders). Less-nested HTML code allows faster page loading. Setka Editor also correctly tags headers and allows filling-in an alternate text for images.
How Setka Editor exports the content?
Setka Editor uses its' own tree data structure. Each layout element (paragraph, image, grid, etc.) is presented as an object with properties and connections to other elements. It allows to stay unattached to HTML representation of a document and export the content in any required format, e.g. JSON.
Where and how my content is stored?
All the content is stored as an HTML-code in our database. CSS files can be stored on a client side or delivered via Setka Editor CDN.