Skip to content

Latest commit

 

History

History
70 lines (36 loc) · 3.16 KB

index.md

File metadata and controls

70 lines (36 loc) · 3.16 KB
Raw

#Developers' Reference

Developers' Reference primarily consists of API references of the different core Umbraco APIs. In many cases, the references come with code snippets with simple examples. For a more in-depth study of the different APIs, consult the "using-umbraco" and "extending-umbraco" sections of the documentation.

##Common Pitfalls & Anti-patterns

This section is ultra important! It will describe many common pitfalls that developers fall in to. Make sure you read this section - it might just save your site!

##API Documentation

####C# API Documentation

Note: opens a documentation browser that is different from the documentation section you're viewing now, we're planning to integrate both.

C# API references for the Umbraco Core and Web libraries

####Backoffice UI API documentation

Note: opens a documentation browser that is different from the documentation section you're viewing now, we're planning to integrate both.

Angular, JS, CSS & Less UI API references for building Umbraco backoffice components

##Security

information on Umbraco security, it's various security options and configuring how authentication & authorization works in Umbraco

##Configuration

Information about all of Umbraco's configuration files and options.

##IoC & Dependency Injection

Info about setting up IoC/Dependency Injection to work with Umbraco

##Templates

Working with Umbraco templates: views, partial views, child actions, razor syntax, macros and working with JavaScript/Css.

##Querying & models

Information about the data models used to display content in Umbraco and the various ways of querying it.

##Routing & Controllers

How routing works within Umbraco, how content is mapped to URLs and how URLs are generated for content. This section also describes the types of Controllers used in Umbraco, how they work and how they get routed.

##Searching

Details on how to implement search capabilities for your Umbraco website using Examine, which is a Lucene-based search engine for Umbraco.

##Events

Event model covering all major aspects of the system for triggering custom code or automation.

##Rest APIs

How to use Web API with Umbraco to easily create REST services.

##Management APIs

APIs that focus on creating, updating and deleting.

##Plugins

The term 'Plugins' refers to any types in Umbraco that are found in assemblies that are used to extend and/or enhance the Umbraco application.

##Caching

Describes how to work with caching custom data structures in Umbraco. If you are creating Umbraco packages that have custom data sources and you want to cache some of this data, it's important to understand how caching works in Umbraco and to understand how it affects Umbraco installations in load balanced environments.