Ruby on Rails SDK Documentation

First  Steps

• Getting Started with the Rails SDK
  Getting started is easy. Just register for a test drive and set up your first Scrivito website project.
• Setting Up the Example Application
  The example app includes everything you need for your first Scrivito-enabled Rails app
• Integrating Scrivito into Your Rails Application Tutorial
  Firing up a Rails project that utilizes Scrivito CMS
• Utilizing the Bootstrap or Foundation Framework Tutorial

Release Notes

Introduction for Developers

• The Scrivito Landscape
  An overview of what Scrivito is and how it works and what it's all about
• Widget Gallery – The Building Blocks of Your Website Content
  A collection of pre-built widgets for you to use in your Rails project
• The Scrivito Architecture
  The basics of developing a Rails application with Scrivito
• Scrivito SDK Basics
  The Scrivito SDK lets you access CMS content from within your Rails application and in-place on web pages
• SDK Cheat Sheet

CMS Data Structures

• CMS Objects, Widgets, and Classes 
  Scrivito's basic data structures and their purpose
• Using Object Classes
  Object classes define the data model of pages and widgets
• Creating and Modifying Object Classes
  Object classes define page and widget types. Here's how to create them
• Creating and Modifying Widgets with Ruby
  Provide pre-built pages including widgets and their default content to editors
• Attributes and Their Type
  Attributes are the building blocks of page and widget types. Various attribute types exist.
• Specifying Default Attribute Values
  Learn how to specify the initial content of new CMS objects
• Working with Hierarchical Content
• Handling Reusable Content
• Turning a Widget into a Gem Tutorial
  Make widgets independent of your application so they can be reused
• Refining Scrivito's Routing
• Building Navigations
• Modeling Object Associations
• Migrating to Model-Based Object Classes
  Page and widget model classes are no longer stored in the CMS. Here's how to migrate your data.
• Maintaining CMS Object Classes with Migrations
  Migrations let you modify CMS data structures programmatically

Working Copies and Permissions

• About Working Copies
  Working copies are like sandboxes where editors and teams can maintain content independently of each other
• Introduction to Permissions
  Learn how to fine-tune the actions editors may take as they edit content in place (video).
• Making an Editor a Supereditor Tutorial
  Learn how to define Scrivito users' scope of action
• Defining Users and Their Permissions Tutorial
  Scrivito has a customizable permissions system that lets you control who may change or publish content
• Adding a Log-in Page to Your Application Tutorial
  Every website featuring personalization requires a way to log in. Providing a log-in page is easy.

Rendering Content

• Page and Widget Views Explained
  Learn how to provide views for rendering pages and widgets and their properties dialogs
• Creating a Page Type with Widgets
  Learn what widgets are and how they work, how to create and provide them to editors
• Creating Form Widgets Tutorial
• Using Link Lists and References
  About link lists and references and how to render them on web pages
• Navigating the Page Hierarchy
  Learn how to have navigations generated automatically for hierarchically organized website content
• Transforming Images
• Making Images Responsive Tutorial
• Customizing Error Pages Tutorial
  How to customize search and error pages in a Scrivito-enabled application
• Scheduling and Expiring Content Tutorial
  You can easily schedule event pages, advertisements, etc. to make them appear at a particular date
• Creating a Small News Site Tutorial
  How to create a small website, explained step by step
• Creating a Blog Tutorial
• Creating Multi-Language Websites Tutorial
  Scrivito supports implementing separate language sites served by a single application
• Complementing Shop Content Tutorial
  Learn how to add Scrivito's in-place editing to an existing Rails application that uses its own data source

Customizing In-Place Editing

• Customizing a Widget Tutorial
• Limiting Available Widget and Page Types 
  How to restrict the use of widgets and page types to keep your layout consistent
• Assigning Permalinks to Pages
  Permalinks are easy-to-memorize page names. You can individually assign them in place.
• Making Navigations Sortable Tutorial
  How to make navigations sortable by simply adding a custom attribute
• Providing Custom Buttons in Place Tutorial
  You can make in-place editing even more comfortable by providing custom buttons in editing mode.
• Writing Attribute Editors Tutorial
  Scrivito's JS API lets you create your own in-place editing controls. Learn how to provide additional editing functions to Scrivito users.
• Creating a Nested Widget Tutorial
  Nested widgets let you structure pages. Here's how to create them.
• Content Browser Overview
  How to use and configure the Scrivito Content Browser
• Scrivito Editors Overview
  A collection of JavaScript editors and a content browser for adding, updating, and deleting website content
• SEO Made Easy

Performance & Stability

• Fast Content Delivery through a CDN
  Distribute highly available content which is served fast to end users
• Best Practices for Improving Performance
  Some tips regarding caching and how to benefit the most from it
• Keeping Your Site up if Scrivito is Unreachable
  Scrivito helps you to keep your site up and running. Learn how to further harden your application against network failures.
• Using a Second-Level Data Cache Tutorial
  Scrivito lets you add a custom 2nd-level cache to its cache store chain
• Utilizing Fragment Caching Tutorial
  Learn how to further speed up page rendering using fragment caching

Searching Content

• Introduction to Searching
  Scrivito includes search functionality you can use directly in your Rails application
• How to Build a Paginated Search Page Tutorial
  The Scrivito search API lets you paginate search results using batches. See how it works.
• Navigations from Searches Tutorial
  Create navigations by searching for CMS objects matching the criteria of your choice
• Creating a Search Page with Faceting Tutorial
• Search API Examples
  Examples for utilizing the search API provided by the Scrivito SDK

Deployment & Going Live

• Going Live
  A bunch of recommendations for going live painlessly
• Deployment to Heroku
  Deploying your Scrivito Rails application to Heroku is easy
• Deployment to AWS OpsWorks
  How to deploy your Scrivito Rails application to Amazon OpsWorks
• Improving In-Place Editing Security
  Here's how you can secure your Scrivito-based website against cross-site scripting attacks.

Content Import & Export

• From Static Content to Widgets
• Importing Data into the CMS Tutorial
  A guide on importing content from JSON files into the CMS
• Exporting CMS Content Tutorial

Solidus E-Commerce Integration

• Introduction to Solidus
• Preparing the Rails App Tutorial
• Defining the Routing Tutorial
• Granting Scrivito Users Access Tutorial
• Rendering Scrivito Content with Solidus Layout Tutorial
• Generating Page Titles & Using Scrivito's Navigation Tutorial
• Creating a Products Widget Tutorial
• Headers, Footers, and a Sidebar Extension Tutorial

In-Place Editing API

• The Editing Process Flow
• Catching Editing Events
  In-place editing largely relies on events and how they are handled
• Fetching and Saving CMS Field Content
  In-place editing is extendable. Learn how to access pieces of content.
• Selecting CMS Content in the DOM
  How to find content of a specific type on a page in order to attach special editing functionality to it
• Refreshing Page Content
  How to refresh page content after changing it with custom in-place editing functionality
• Using and Defining Editors
• Searching CMS Objects
  You can search for CMS objects using the JavaScript API
• Creating and Deleting CMS Objects
  The in-place editing API supports creating and deleting CMS objects
• Default Object Classes for Uploads
  How to specify the type of CMS object an uploaded file is stored in
• Extending Widget, List, and Page Menus
  The in-place editing API supports adding custom functionality to menus
• Copying Images and Other Binaries
• Specifying Popular Page and Widget Types