wiki : Technical documentation

May 5, 2020 3:54:17 PM Thomas Dumont avatar
History fr en

lutece_banner Technical Documentation

Welcome

Lutèce is a free and open source portal engine that allows you to quickly create a dynamic web site or application.

This wiki aims to put on line and to allow the sharing by the community of the developers the tutorials of use of Lutèce. To participate in the Wiki, create an account, and share your Lutece experience!

News

Documentation

LUTECE FRAMEWORK PLUGINS LUTECE WEBSITE LUTECE
Overview
General overview
Features overview
General principles of integration

Samples
City of Paris Applications catalog
Demos Docker images

General
Software architecture
Basic Services of Lutece
Authentication - SSO - MyLutece
Cache management Important
Use of Spring Framework
Access to data
Using JPA
Bean validation (JSR 303)

Norms Important
Coding conventions
Naming rules
Documentation conventions
Logging rules
Checkstyle / PMD rules
JIRA and bug tracking rules Important
SQL Recipes
Security concerns Important
Internationalization (i18n)
GIT branching rules

Development environment
Required tools installation
Tips for Netbeans users
Tips for IntelliJ users
Tips for Eclipse users
Using Maven Important
Project Management with GitHub
How lutece-maven-plugin works
Synchronizing GitHub repositories
release
Generate Freemarker macro documentation
Create a plugin
Lutece plugins
Tutorial: Create a plugin step by step
Create plugins in Kotlin

Code generation
PluginWizard
Code Wizard

Front office
XPage
XPage sample: An HelloWorld Plugin
Create a Portlet
PageIncludeService
ContentService
MyDashboard Component
Create servlets and filters

Back Office
Administration features
AdminDashboard
Daemon
Create a LinkService
Create a ResourceService
Create a site property group
RBAC Access control

Advanced Functions
Code with workflows
Extend plugin features integration into a plugin
Expose a REST API with Lutece
Allow asynchronous file upload (Asynchronous Upload plugin)
Adapt the images before uploading them (Upload Image Plugin)
Forms protection against CSRFs (cross-site request forgery)
Intégration with the CRM plugin desk feature
Generate statistics with Elastic Search and Kibana (Plugin ElasticData)
Create JMX MBeans
Create a batch with Spring Batch
Create a Lutece website
Create a Lutèce site POM.xml
Site specific configuration

Graphical integration
Back Office graphical charter with Bootstrap
Back office Freemarker macros (Lutece v6)

Site Administration
Restrict editing of documents to some BO managers
Add redirection links to external sites from BO

Integration of plugins
Offer an appointment scheduling platform (Plugin Appointment)
Submit a participatory democracy tool (Plugin Suggest)
Create HTML content (Blog Plugin)
Integrate a Recast chatbot
Integrate a BotPress chatbot
Display a map (Leaflet Plugin)
View map data (GISMAP Plugin)

PaaS
Deploy on CloudBees deprecated
Deploy on Redhat Openshift


Ideas/Work in progress


History