Documentation

Quick Start

This brief guide will provide you with the basic knowledge on how to install, run, and discover Jahia in 30 to 60 minutes.

It will introduce you to the basic operations of Jahia such as creating, editing, moving and deleting content; as well as organizing web site structure, adding interactive features and, lastly, publishing your work.

Editors Guide

This guide is intended for users accessing the Edit Mode, which is the most comprehensive editing mode offered by the application. Users working in Edit Mode are commonly grouped under the term “publisher” which bundles several profiles (simple editor, editor, proofreader, translator…).

Administration Guide

This guide covers the overall platform management features, mainly the creation of virtual sites, users and roles. Most server management features are only available to the super administrator (root) account.

It also presents the features available for each virtual site created on the platform. These functionalities are used more frequently than the platform management features and they are available to users with the “site administrator” role.

Contributors Guide

There are several access levels in Jahia. Each is adapted to users with different profiles and tasks. This guide is intended for users with access to Contribute Mode, which is the application’s simplified work mode. These users are grouped together under the name “contributors.” All contributors share access to the same functions and are not further divided into more specialized profiles.

This guide provides an overview of all functions available in Contribute Mode. Depending on the particular configuration of your website pages, some of the functions in Contribute Mode may not always be accessible because the administrators have chosen to set it up that way. However, all functions described here are potentially accessible to contributors. If a function you need does not appear on a given page, you can ask your administrators to change this setting.

Modules List

This document presents all the Content Composite modules available in Jahia. This document is in a Work In Progress, please check it regularly for updates.

How-to use spring configurations to modify Jahia GWT Interfaces

From Jahia 6.5, you can embed spring configuration files directly in your module. The goal of this documentation is to show you what you can do with this spring files in order to modify / extend Jahia’s Edit Mode GUI (created and compiled with GWT).

Download the Documentation

How-to use spring configurations to extend Jahia

You can embed spring configurations directly in your modules without modifying the core application files. This approach provides two major benefits: reusability (you can reuse your modules from project to project) and safer upgrade path (a Jahia upgrade doesn’t impact the non Jahia modules). The goal of this documentation is to show some examples of what you can do with those spring files.

Download the Documentation

How-to use filters

At the hearth of Jahia is the mechanism of filtering. During the rendering of web pages, content grabbed from the JCR goes through several consecutive filters (like a chain) that operates transformations or internal operations (like putting fragments in cache for instance).

As a developer, you can add your own filters to add your own operations. One of the main interests is that the content delivered to the visitors is modified according to the filters it went through but remains clean and untouched in the repository.

Thanks to prepare, execute and finalize methods, the developer can put some information in the rendering context before the HTML generation, modify the generated fragment and start some operations after the finalization of the object rendering.

The goal of this documentation is to explain you how to create a filter “structure” in a Jahia  module (from version 6.5), and then to give you a concrete example.

Download the Documentation

Technical Overview

This document contains a technical introduction to Jahia.

It is designed to help readers with technical skills such as systems integrators, developers, testers or others get an introduction to the Technology inside Jahia. It is not meant to be a user’s guide or an administration’s guide. Please refer to the corresponding documents if that is what you are looking for.

Taglibdoc and Javadoc  v6.6.0.0

Javadoc

• jahia6.6.0.0/javadoc/ (online)
• jahia6.6.0.0/jahia-root-6.6.0.0-javadoc.zip (download)

Taglibdoc

• jahia6.6.0.0/taglib/ (online)
• jahia6.6.0.0/jahia-taglib-6.6.0.0-tlddoc.zip (download)

Multi Channel Rendering

This document presents the various possibilities to address multi-channel rendering needs for your CMS/WCM projects using Jahia. Our product offers several techniques to render your content in any type of formats.

Jahiapedia

The Jahiapedia 6.6 gathers all technical documentation ( apt files) related to the new version. 

GO TO THE APT INDEX

>> Short Cut to  "REST API"
>> Short Cut to "From Development to  Production"
>> Short Cut to "Macros"
>>Short Cut to "URL rewritting"
>>Short Cut to "Internationalization"
>>Short Cut to "Notifications"
>>Short Cut to "Caches"
>>Short Cut to "Workflow"
>>Short Cut to "Query System"
>>Short Cut to "Roles"
>>Short Cut to "Using Apache HTTP server in front of Jahia"
>>Short Cut to "Contribute Mode"
>>Short Cut to "Rules"

Templating and Integration Guide

For template developers, Jahia 6.5 and now Jahia 6.6 are not just new versions of an already proven platform or a minor update free of consequences. Instead, from a developer’s point of view, they present all the characteristics of a restart from scratch.  After years of relatively incremental improvements on templates development mechanisms, the Jahia team went back to the drawing board to offer users a rapid, robust, scalable, understandable and hopefully fun development environment.

This guide covers only the tip of the iceberg: the upper layers. This represents already a very large amount of new information and techniques to learn, and despite the fact that we won’t go deeper there is already an extremely rich range of possibilities that we invite you to discover in these upper layers.

Go to the Documentation

Portlet Guide

Jahia includes an embedded portal server, which is based on the Apache Pluto reference implementation of the JCR Portlet API specification. The goal of this implementation is to offer support for integrators who need to embed portlets on content pages. This means that any portlet API compliant application may be integrated with Jahia in a few simple steps.

You can access the documentation of Jahia's previous version in clicking here.

Go the Previous Versions Documentation