Developers

This section focuses on how to build content rich applications backed by Crafter CMS. It covers the basic topics you need to define a content type and render that content as part of a page, component or service. It also covers topics like building queries, accessing services and extending the core platforms.

Developers need to be comfortable with Content Modeling (how to represent content in Crafter CMS for your application to retrieve said content), and how to access content items from your application/site.

Define Content

To get started with content modeling, read: Content Modeling.

Retrieve Content

To get started with content access/APIs, read: Crafter Engine.

In depth concepts and guides follow.

• Crafter CMS Architecture
• Content Modeling
• Content Inheritance
• Assets
• Templates
• Search with Elasticsearch
• GraphQL
• Plugins
• Content Targeting
• Redirects
• Testing
• Errors
• Extending Crafter Studio
• Developer Workflow

Note

Scripts and Templates Security

Crafter Engine limits access to services when developing templates or scripts, and sandboxes scripts for security by default.

Crafter Engine only allows a small list of services available to use when developing templates or scripts. There are some sites that may require services not included by default.

To expose other services, follow the guide Access to Services

Scripts are executed in a sandbox that has a blacklist of insecure expressions to prevent code that could compromise the system. There are some cases though where a site requires access to one or more of the blacklisted expressions.

To override the default script sandbox configuration, follow the guide Script Sandbox Configuration

Subsystems and API Documentation

Crafter CMS comprises a number of projects, below are the project specific documentations including APIs.

• Crafter CMS
• Crafter Docker Compose
• Crafter Core
• Crafter Commons
• Crafter Engine
• Crafter Studio
• Crafter Search
• Crafter Deployer
• Crafter Profile
• Crafter Social

Cookbook / Tutorials

• Cookbooks / Tutorials
  • Querying Content
  • Solutions: Active Cache
  • Solutions for Activiti
  • Solutions for AWS
  • Solutions for Box
  • Solutions RESTful Services
  • GraphQL
  • Crafter Marketplace
  • Best Practices
  • How-Tos
  • RTE How-tos

Below is a short set of links to other documentation for technology that Crafter CMS leverages:

Attribute Name	Usage	Links
Spring Beans Spring MVC	Server App Framework	https://spring.io/docs
Freemarker	Server side templates	http://freemarker.org/
Groovy	Server side scripting	http://groovy-lang.org/documentation.html
Elasticsearch	Search and content query	https://www.elastic.co/products/elasticsearch
Solr	Search and content query	http://lucene.apache.org/solr/resources.html
MongoDB	Crafter Profile and Social data store	https://docs.mongodb.com
GIT	Repository Implementation	https://git-scm.com/docs
RST	Documentation source format	http://docutils.sourceforge.net/rst.html

Note

Crafter CMS is a Git-based CMS. Please note that your system’s global git ignore file (list of rules for ignoring files in every Git repository on your computer) is respected by Crafter CMS. In case you find some of your content not being committed into Crafter CMS, check your global git ignore file to verify the content you’re committing is not being ignored.