Recommended Project Setup

September 5th, 2012 at #mconf12Natascha Desmarais, Trainer & Developer at the Services Team

1

Recommended Project Setup

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

2

Use maven archetypes if possible [1]

General project layout

Blog post series [2]: “Don’t build/configure/deploy magnolia, …”

Base Setup – Starting from scratch

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

[1] http://wiki.magnolia-cms.com/display/WIKI/Module+QuickStart[2] http://dev.magnolia-cms.com/~gjoseph/dont-build-magnolia-build-your-projects http://dev.magnolia-cms.com/~gjoseph/dont-configure-magnolia-let-your-projects-configure-it http://dev.magnolia-cms.com/~gjoseph/dont-deploy-magnolia-deploy-your-project

3

Before starting:• Security concept• Multilanguage

magnolia.properties [3]SubscribersSite configurationMessages

Advanced configuration

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

[3] http://documentation.magnolia-cms.com/administration/deployment/war-file-with-multiple-configurations.html

4

How does the mechanism work?• Extends & extends-override [4]• Absolute & relative paths• What happened to “reference” and why was it

abandoned?Do not reinvent the wheel!• Use existing configurations: STK, Form, …• Extend even if there are no local changes!

Extending

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

[4] http://documentation.magnolia-cms.com/technical-guide/configuration-mechanisms.html#Extendingconfiguration http://documentation.magnolia-cms.com/reference/controls.html#Extendingconfiguration

5

Extending

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

Advantages Disadvantages✔ Maintainability

✔ Readability

✔ Automatic updates for bugfixes

✔ Easy injection of own messages

✔ Migration path

✖ No automatic notifications

✖ Extending overdone

✖ Need to implement STK / other messages

6

Module structureBypass / RessourcesTemplates vs. Inplace TemplatesExport configurationsClean backup repository

Developing in your IDE

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

7

Abstract- and DefaultMVHinfo.magnolia.module.AbstractModuleVersionHandler

info.magnolia.module.DefaultModuleVersionHandler

getBasicInstallTasks vs getExtraInstallTasksgetDefaultUpdateTask vs single deltas

Version handling

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

8

Questions?

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

September 5th, 2012 at #mconf12natascha.desmarais@magnolia-

cms.com

Natascha Desmarais, Trainer & DeveloperMagnolia International Ltd.

9

www.magnolia-cms.com

Thank you!

Version 1.0 Magnolia is a registered trademark owned by Magnolia International Ltd.

10 Version 1.1 Magnolia is a registered trademark owned by Magnolia International Ltd.

11 Version 1.1 Magnolia is a registered trademark owned by Magnolia International Ltd.

12 Version 1.1 Magnolia is a registered trademark owned by Magnolia International Ltd.