Documentation

Editor Types

The editor types ending in "-JSON" are persisted as JSON and can be expected to be parsed as JSON when retrieved on your server-side. The Node.js NPM already parses this for you but we did not do this for other server-side languages as its not necessarily standard but there are many supporing libraries that deserialize JSON.

  • INLINE  allows direct editing of text on the page itself with no editor. This is truly WYSIWYG.
     
  • HTML  is the full HTML Editor experience where you have complete control to upload images and embed plugins etc.
     
  • IMAGE-ROTATOR  is a slider made from the jQuery plugin "dumbCrossFade" and produces HTML and JavaScript to bootstrap the plugin
     
  • RAW is a pure text-based editor that is good for coding JavaScript or CSS.
     
  • TEAM allows management of a collection of team members. This is a typical use case in our eCommerce sports-driven websites. This produces HTML.
     
  • CAROUSEL-JSON  is an editor which lets the client define the slides for a carousel.

    [
       {
          "caption" : String,
          "alt" : String,
          "src" : String,
          "href" : String
       }
    ]
     
  • LINKS-JSON allows you to define a flat collection of links.

    [
      {  
        "href" : String,
        "text" : String
      }
    ]
     
  • BLOG-JSON allows you to define a collection of blog entries.

    [
      {
        "mode" : String,  // is "live" or "draft"
        "title" : String,
        "description" : String, // html version
        "summary" : String, // stripped of tags, pure text version
        "date" : Number  // persisted as "ticks", see definition of ticks for JavaScript
      }
    ]
     
  • FAQ-JSON allows you to define a collection of questions and answers.

    [
      {  
        "question" : String,
        "answer" : String
      }
    ]
     
  • IMAGES-JSON allows you to define a collection of images

    [
      {  
        "src" : String,
        "alt" : String
      }
    ]
     

Need a custom editor type?

We can do that. We would have to bill hourly in order to add a custom editor type for your business. We have many undocumented custom types that would not prove useful to note here for most customers as they are too specific. Use our contact form and request a custom editor type. Note, we are working on a way for you to define this yourself but cannot promise when as its not our top priority.