Introduction

Introduction

Please consider all the material of this wiki as a work in progress: we are always tuning the documentation as soon as we receive feedback from users: we consider these pages as a starting point toward a better documentation (which makes Entando a better platform)

As of Jan 2013, we are in the process of releasing new documents for the community.
If you follow us on Twitter, Facebook and linkedIn or our LinkedIn Group you'll be kept informed as soon as we upload new material.

Documents organization

The material in these pages is always relative to the current version of Entando

We are uploading and arranging the materials so to meet the needs of the newcomers:

In the General documentation section are listed the following guides:

• Migration from Entando 3.0 to 3.2
  This step by step guide shows the procedure to port the core of your Entando 3.0 installation to version 3.2
• Setup a Java development environment for the Entando Platform
  This document explains how to setup a development environment for Java developers. Those who are approaching "Entando" for the first time will find all the software needed in the first place to run, and then a few configuration hints to develop on the Entando platform.
• Entando in production: how to prepare a server, how to deploy your Entando based application
  This step-by-step guide shows to system or network administrators how to setup a basic server where to deploy your project.
• Entando: an unexpected journey. Or, my portal from scratch.
  This guide shows how to create a new portal from scratch in minutes.
• The Entando model
  This is an overall view of the model of the platform. Users, Groups, Contents etc. are introduced from an high level perspective, without going too deep in the subject.
• Build an Entando portal
  The material contained in this page resumes some of the concepts already seen in the Entando Model, to deepen subjects such as Pages, Contents and Widgets; the aim is to provide quick information to build a portal.
• Pattern for application services creation and integration
  This developers-oriented document shows the way and the conventions adopted to create Application Services in the Entando core.
• Plugin Pattern
  This guide explains how to create applications services in form of Entando plugins.
• Entando Rest API Engine
  This guide shows how to implement a REST based service

In the Community Plugins section we are going to list the plugins made available for the community.

• Action Logger tracks all the operations performed in the administration area.
• Content Versioning tracks the different versions of a content, allowing the restoration of a previous state.
• Email Sender allows system services to send notification by email
• LDAP allows to autenticate users from a LDAP server
• Newsletter adds a nice newsletter service to your Entando installation
• RSS Aggregator converts the feeds of a given URL into portal contents
• RSS allows to serve the portal contents through RSS channels
• Manage User Profile associates a customized profile to a standard Entando user
• User Registration let users register themselves to the portal and later to sign in
• Web Dynamic Forms allows administrators create dynamic forms in the portal
• Address Book creates an address book using the public users profiles of the portal and lets users add their own
• CAS Client uthenticate users against a CAS server

The guides of the following plugins have not been yet translated.

• Calendar adds a calendar with the events of the day
• Content Feedback let users rate and comment portal contents
• Content Workflow let administrators create a precise process to follow in order to write and approve a new content
• Fast Content Edit allows administrator edit contents directly from the portal pages
• My Portal Plus let users arrange the widgets in a page with the drag and drop
• Share With let visitors share portal contents in their preferred social network
• Widget Replicator echoes the Widget contained in a given frame of a page in another page of the portal
• Survey - Questionnaire lets administrator create polls for the portal visitors
• Avatar let users associate an avatar taken from Gravatar to their portal account
• Tag Cloud adds a tag-cloud in the portal which contains the categories of the most-viewed contents
• Content Types - Categories relations establishes a relation between categories of a content and its content types
• Faceted Navigation enables faceted navigation of the portal contents organized by categories
• GeoReferenced contents adds geographic reference to portal contents
• Image Map adds a new attribute to the CMS which allows editors add images with clickable regions in contents
• Photo gallery adds a photogallery to the portal
• Statistics elaborates the statistical figures relative to portal pages and published contents
• Token API let users access Entando platform REST APIs through a security token
• Front Shortcut allows portal administrators to edit, configure and manage contents, services and pages directly from the front-end of the portal.

top

In the Some quick links and use cases we propose several step-by-step guides which address some of the most common beginner questions. These documents assume that the developer already knows how to use Maven and have read the general documentation above. The following documents are relevant to developers:

• How to start my own portal based on mavenized Entando
  This short guide explains how to deploy a new Entando portal project in minutes.
• How to add some Plugins to my own portal based on mavenized Entando
  This guide explains how to add a plugin to the Entando portal created in the previous guide
• What if I want to write and test a new feature in my own portal?
  As the portal grows, every good programmer should test new features: this short guide gives very useful hints
• How to port a Plugin from basic Entando to mavenized Entando
  This guides helps developers to port a plugin to a Mavenized version of Entando
• How to start a brand new Plugin
  The title pretty says it all!

top

I need help!

The best place to ask for help is Google groups
All our effort is aimed at building a community so we always try our hardest to answer as soon as possible.

All the relevant questions in the Google Groups will be included in the FAQ section

top