Skip to content

Latest commit

 

History

History
63 lines (33 loc) · 3.19 KB

index.md

File metadata and controls

63 lines (33 loc) · 3.19 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.

##Templating

How to use templates and macros. Covers templates and macros from the basic definitions to advanced techniques and using APIs.

This section contains all of the details about both templates types: MVC & WebForms.

##Querying

Umbraco comes with various ways of querying, filtering and searching published content for use on your website.

##Searching

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

##Events

###Events (v6+)

Umbraco 6.x or later: event model covering all major aspects of the system for triggering custom code or automation.

###Legacy Events (v4)

Umbraco 4 and earlier comes with a complete event model, covering all major aspects of the system for triggering custom code or automation.

Rest APIs

###Web API (V6.1+)

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

###/Base

/Base is a extendable system for creating raw feeds directly from Umbraco using very basic URLs. This enables developers to access Umbraco data through javascript, flash or any other client. It even allows you to modify Umbraco data directly via simple URLs.

Management APIs

APIs that focus on creating, updating and deleting.

###Management APIs (V6+)

Specific to version 6.x or later: Create, update, and delete all build-in system objects like content, media, templates, content types and so on.

###Legacy Management APIs (v4)

Specific to version 4.x or earlier: Create, update, and delete all build-in system objects like documents, media, templates, document types and so on.

##Plugins (v4.10.0+)

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.

Request Pipeline (V6+)

This section explains how to generate URLs (outbound pipeline) and how Umbraco finds back a node using an URL (inbound pipeline).

##Umbraco.Library

Umbraco.Library is a XSLT extension library, built specifically for XSLT macros in Umbraco 4. It contains many utility methods which are strictly for use in XSLT, but also a number of more general purpose methods which can be used more broadly.

##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.