Ruby on Rails SDK Documentation

First  Steps

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

Release Notes

Introduction for Developers

• The Scrivito LandscapeAn overview of what Scrivito is and how it works and what it's all about
• Widget Gallery - The Building Blocks of Your Website ContentA collection of pre-built widgets for you to use in your Rails project
• The Scrivito ArchitectureThe basics of developing a Rails application with Scrivito
• Scrivito SDK BasicsThe 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 ClassesObject classes define the data model of pages and widgets
• Creating and Modifying Object ClassesObject classes define page and widget types. Here's how to create them
• Creating and Modifying Widgets with RubyProvide pre-built pages including widgets and their default content to editors
• Attributes and Their TypeAttributes are the building blocks of page and widget types. Various attribute types exist.
• Specifying Default Attribute ValuesLearn how to specify the initial content of new CMS objects
• Working with Hierarchical Content
• Handling Reusable Content
• Turning a Widget into a Gem TutorialMake widgets independent of your application so they can be reused
• Refining Scrivito's Routing
• Building Navigations
• Modeling Object Associations

Working Copies and Permissions

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

Rendering Content

• Page and Widget Views ExplainedLearn how to provide views for rendering pages and widgets and their properties dialogs
• Creating a Page Type with WidgetsLearn what widgets are and how they work, how to create and provide them to editors
• Creating Form Widgets Tutorial
• Using Link Lists and ReferencesAbout link lists and references and how to render them on web pages
• Navigating the Page HierarchyLearn how to have navigations generated automatically for hierarchically organized website content
• Transforming Images
• Making Images Responsive Tutorial
• Customizing Error Pages TutorialHow to customize search and error pages in a Scrivito-enabled application
• Scheduling and Expiring Content TutorialYou can easily schedule event pages, advertisements, etc. to make them appear at a particular date
• Creating a Small News Site TutorialHow to create a small website, explained step by step
• Creating a Blog Tutorial
• Creating Multi-Language Websites TutorialScrivito supports implementing separate language sites served by a single application
• Complementing Shop Content TutorialLearn 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 PagesPermalinks are easy-to-memorize page names. You can individually assign them in place.
• Making Navigations Sortable TutorialHow to make navigations sortable by simply adding a custom attribute
• Providing Custom Buttons in Place TutorialYou can make in-place editing even more comfortable by providing custom buttons in editing mode.
• Writing Attribute Editors TutorialScrivito'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 TutorialNested widgets let you structure pages. Here's how to create them.
• Content Browser OverviewHow to use and configure the Scrivito Content Browser
• Scrivito Editors OverviewA 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 CDNDistribute highly available content which is served fast to end users
• Best Practices for Improving PerformanceSome tips regarding caching and how to benefit the most from it
• Keeping Your Site up if Scrivito is UnreachableScrivito 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 TutorialScrivito lets you add a custom 2nd-level cache to its cache store chain
• Utilizing Fragment Caching TutorialLearn how to further speed up page rendering using fragment caching

Searching Content

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

Deployment & Going Live

• Going LiveA bunch of recommendations for going live painlessly
• Deployment to HerokuDeploying your Scrivito Rails application to Heroku is easy
• Deployment to AWS OpsWorksHow to deploy your Scrivito Rails application to Amazon OpsWorks
• Improving In-Place Editing SecurityHere'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 TutorialA 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 EventsIn-place editing largely relies on events and how they are handled
• Fetching and Saving CMS Field ContentIn-place editing is extendable. Learn how to access pieces of content.
• Selecting CMS Content in the DOMHow to find content of a specific type on a page in order to attach special editing functionality to it
• Refreshing Page ContentHow to refresh page content after changing it with custom in-place editing functionality
• Using and Defining Editors
• Searching CMS ObjectsYou can search for CMS objects using the JavaScript API
• Creating and Deleting CMS ObjectsThe in-place editing API supports creating and deleting CMS objects
• Default Object Classes for UploadsHow to specify the type of CMS object an uploaded file is stored in
• Extending Widget, List, and Page MenusThe in-place editing API supports adding custom functionality to menus
• Copying Images and Other Binaries
• Specifying Popular Page and Widget Types