Collective Amberjack - European Plone Symposium

collective.amberjack Massimo Azzolini RedTurtle on-line tutorials with Monday, May 31, 2010

who am I? Massimo Azzolini RedTurtle’s co-founder and project manager massimo@redturtle.net Monday, May 31, 2010

the basic idea ✓ tours for plone’s newbies ✓ show portal’s features ✓ tutor your audience link foto Monday, May 31, 2010

that’s not all folks! ✓ every product/add-on might have its amberjack tutorial ✓ just-hired people in companies needs tutorials ✓ wizards ✓ a shared tutorials’ repository Monday, May 31, 2010

the ﬁrst goal ✓ Use Amberjack to offer guided help for Plone’s ﬁrst-time users ✓ Use it in real use cases ✓ PLIP #9324: include it in a next 4.x release Monday, May 31, 2010

we already have these tours ✓ Add and publish a Folder ✓ Add and publish a Page ✓ Add and publish a News Item ✓ Add and publish an Event ✓ Format a page using the visual editor ✓ Create internal links link foto Monday, May 31, 2010

we already have these tours ✓ Create external links ✓ Upload an image ✓ Insert image on a page ✓ Upload and link to a File ✓ Using the Contents tab ✓ Using the Display menu link foto Monday, May 31, 2010

a spotlight http://www.ﬂickr.com/photos/slopjop/1300515408 Monday, May 31, 2010

you just installed Plone... and you’re an happy guy Monday, May 31, 2010

..and you need to learn it by yourself.. hum, should I just select the tour from the list? so easy? Monday, May 31, 2010

... complete the steps! one at a time, please Monday, May 31, 2010

http://www.ﬂickr.com/photos/eklektikos/2541408630/sizes/l/ the blueprint tours, steps, editors, users Monday, May 31, 2010

the blueprint ✓we want to have tours ✓we want our tours used ✓we need tours’ creators ✓just as a demo ✓programmers ✓as a guided aid ✓editors ✓run in a sandbox ✓we need different tools ✓we want them ✓python oriented ✓downloadable ✓user interface oriented ✓sharable ✓installable Monday, May 31, 2010

Do not touch Plone ✓ collective.amberjack do not changes anything in Plone itself ✓ we used unobtrusive javascript code and tours descripted through HTML http://www.ﬂickr.com/photos/dhowellphoto/3023319312 Monday, May 31, 2010

the software components amberjack library collective.amberjack.core collective.amberjack.portlet collective.amberjack.plonetour (collective.amberjack.windmill) (collective.amberjack.yourtour) Monday, May 31, 2010

the software components amberjack library collective.amberjack.core collective.amberjack.portlet collective.amberjack.plonetour (collective.amberjack.windmill) (collective.amberjack.yourtour) collective.amberjack.subskins Monday, May 31, 2010

amberjack.org ✓ developed by Arash Yalpani ✓ provides an unobtrusive javascript infrastructure for online tours ✓ not completely usable for our purposes Monday, May 31, 2010

basically it provides ✓ a fancy popup “div” with prev/next/exit buttons, fully html enabled for your steps. ✓ a mapping between a step and each url you can visit. amberjack.org Monday, May 31, 2010

some use case not fully supported ✓ in Plone a path does not identify uniquely a html page: • view a page (/plone/page-a/view) • edit a page (/plone/page-a/edit) • save a page (/plone/page-a/view) ✓ it’s not just about links, we also submit forms Monday, May 31, 2010

the solutions ✓ make the mapping between steps and url less strong: • now the steps has an order (1. 2. 3....) ✓ don’t just rely on urls to pass tour variables • use cookies Monday, May 31, 2010

collective.amberjack.core ✓ all the javascript engine ✓validators definition ✓tour definition and registration ✓ Amberjack skins • model_t ✓step definition • safari ✓ZCML configuration for • light_grey • tours • ajStep Monday, May 31, 2010

an example: add a folder ✓ the tour is made by the steps: ✓ filling a field is entering a string inside a HTML field • add_folder, • fill_out_the_fields, ✓ it’s about JS and HTML. • publish_folder, • all_done ✓ the “fill_out_the_fields” step has to: • fill the “title” field with a value • fill the “description” field with another value • save it Monday, May 31, 2010

collective.amberjack.core - tour Monday, May 31, 2010

collective.amberjack.core - tour ajTour = { 'tourId':u'basic01_add_and_publish_a_folder', 'title': _(u'Add and publish a Folder'), 'steps': (add_folder, fill_out_the_fields, publish_folder, all_done, )} Monday, May 31, 2010

collective.amberjack.core - step Monday, May 31, 2010

collective.amberjack.core - step add_folder = { 'validators': (isManager, isNotFolderCreated,), 'url': u'/', 'xpath': u'', 'xcontent': u'', 'title': _(u"Create a new folder"), 'text': _(u"Folders are one..."), 'steps': ({...}) Monday, May 31, 2010

collective.amberjack.core - microsteps Monday, May 31, 2010

collective.amberjack.core - microsteps 'steps': ( {'description': _(u"In the [Title] field, type.."), 'idStep': u'form_title', 'selector': u'', 'text': u'MyFolder'}, {'description': _(u"In the [Description] field, type .."), 'idStep': u'form_description', 'selector': u'', 'text': _("This folder will be used...")},)} Monday, May 31, 2010

collective.amberjack.core - ajStep Monday, May 31, 2010

collective.amberjack.core - ajStep ajStandardSteps = ( ... ('form_title', '#archetypes-fieldname-title input'), ('form_description', '#archetypes-fieldname-description textarea'), ... ) Monday, May 31, 2010

collective.amberjack.core - ZCML registration Monday, May 31, 2010

collective.amberjack.core - ZCML registration <collective.amberjack:tour tourdescriptor=".tour1.ajTour" /> <collective.amberjack:ajstep stepsdescriptor= ".ajStandardSteps.ajStandardSteps" /> Monday, May 31, 2010

validators ✓ isAnonymous ✓ isAuthenticated ✓ isManager ✓ isReviewer ✓ isContributor ✓ isEditor ✓ isReader http://www.ﬂickr.com/photos/traveleden/3797157077 Monday, May 31, 2010

collective.amberjack.plonetour ✓ deﬁnes the 12 tours ✓translations • english ✓ provides tour speciﬁc validators • french • isFolderCreated • italian • isNotFolderCreated • spanish ✓ZCML registration • polish • brasilian Monday, May 31, 2010

collective.amberjack.portlet ✓ provides a portlet thats draws a set of tours in a given order ✓you may choose: • portlet’s title • the list of tours from the available ones.. • ...and order them • amberjack skin type ✓it enables/disables the tours in accordion to the validators • e.g.: ﬁrst create a folder then a page Monday, May 31, 2010

http://www.ﬂickr.com/photos/orphanjones/414401592 write your own tour as simple as you need Monday, May 31, 2010

what you need to do ✓ create an empty package via paster ✓ write your tour in myTour.py ✓ add it to the available ones through ZCML ✓ translate it ✓ (opt. add custom ajSteps) http://www.ﬂickr.com/photos/domhuk/197875701 Monday, May 31, 2010

http://www.ﬂickr.com/photos/vramak/3499502280 See in action Monday, May 31, 2010

Create a folder and a page Monday, May 31, 2010

http://www.ﬂickr.com/photos/tranchis/3173646667 Coding events when the project improves Monday, May 31, 2010

Sprints ✓ Bolzano Sprint ’08 ✓ Sorrento Sprint ’09 ✓ a short summer sprint ’09 ✓ Plone conference ’09 ✓ Ferrara Sprint ’10 ✓ Sorrento Sprint ’10 http://www.ﬂickr.com/photos/johnthescone/2526186118 Monday, May 31, 2010

I want you we’ll sprint on Fri-Sun (yes, it’s tomorrow :) http://www.coactivate.org/ projects/sorrento-sprint-2010/ project-home http://www.ﬂickr.com/photos/uhuru1701/2247554605 Monday, May 31, 2010

Stages - Thesis smart students from the University of Ferrara http://www.ﬂickr.com/photos/fabio48/317814195/ Monday, May 31, 2010

What’s new? we have a team we have a plan http://www.ﬂickr.com/photos/biscuitsmlp/2246503687 Monday, May 31, 2010

http://www.ﬂickr.com/photos/anirudhkoul/3786725982 we have a team the team, actually now Monday, May 31, 2010

the main contributors ✓ Federica D'Elia ✓ Mirco Angelini ✓ Luca Fabbri ✓ Andrew Mleczko ✓ Vincent Fretin ✓ Giacomo Spettoli ✓ Andrea Benetti ✓ Massimo Azzolini http://www.ﬂickr.com/photos/snapr/484776493/sizes/o/ Monday, May 31, 2010

and during the sprints ✓ Aaron VanDerlip ✓ Michael Davis ✓ Irene Capatti ✓ Giorgio Borelli ✓ Jacopo Deyla http://www.ﬂickr.com/photos/snapr/484776493/sizes/o/ Monday, May 31, 2010

translate ‘em all ✓ Leonardo J. Caballero (es) ✓ Vincent Fretin (fr) ✓ Stefano Marchetti (it) ✓ Andrew Mleczko (pl) ✓ Tamosauskas (pt-br) http://www.ﬂickr.com/photos/snapr/484776493/sizes/o/ Monday, May 31, 2010

RedTurtle will support the project ✓ stable team to enhance ✓ Activities won't be no more and mantain the tool based on my spare time. ✓ 4 more people ✓ They are going to be ✓ you’re welcome! supported and scheduled in a more stable way. ✓ amberjack company ✓ “10 percent manifesto”-ish branded Monday, May 31, 2010

we have a plan and it’s public Monday, May 31, 2010

next release 1.1 ✓refactor the code ✓Check if the user completes the step ✓validations & preconditions ✓I wanna write what I want! ✓TTTW: discussion about poc/ implementation ✓manage prev/next buttons ✓sandbox ✓amberjack’s template for sunburst ✓1.0: implementation ✓translations: choose the right approach ✓2.0: brainstorm ✓test coverage Monday, May 31, 2010

TTTW - Tutorials Through The Web editors want to use the browser to create their tours what’s better than click and save? we’re enhancing Windmill!! Monday, May 31, 2010

Create a folder and a page - TTTW Monday, May 31, 2010

further releases ✓TTTW ✓sandbox use cases ✓create a tutorial from plone ✓portal as a sandbox ✓save it on a local or shared ✓personal folders as sandboxes repository ✓from sandbox to wizard ✓export as a package ✓“save my data, I’ll be back soon” ✓extend it ✓... ✓“import” a package Monday, May 31, 2010

References ✓ Project management: • https://launchpad.net/collective.amberjack • https://blueprints.launchpad.net/collective.amberjack • https://bugs.launchpad.net/collective.amberjack ✓ wiki & documentation • http://www.coactivate.org/projects/collectiveamberjack/ Monday, May 31, 2010

References ✓mailing list: • http://www.coactivate.org/projects/collectiveamberjack/lists/ collectiveamberjack-discussion • http://www.coactivate.org/projects/collectiveamberjack/lists/collectiveamberjack-support/ ✓code svn on collective: • http://dev.plone.org/collective/browser/collective.amberjack.buildout • http://dev.plone.org/collective/browser/collective.amberjack.core • http://dev.plone.org/collective/browser/collective.amberjack.plonetour • http://dev.plone.org/collective/browser/collective.amberjack.portlet Monday, May 31, 2010

Grazie. Thank you. Monday, May 31, 2010

Questions!? Massimo Azzolini massimo@redturtle.net http://www.ﬂickr.com/photos/seandreilinger/2326448445 Monday, May 31, 2010

http://blog.redturtle.it	248
http://www.slideshare.net	24
http://www.redturtle.it	2
http://localhost	2
http://castell.hosting.redturtle.it	2
https://www.redturtle.it	1

Collective Amberjack - European Plone Symposium

by Massimo Azzolini on May 31, 2010

Accessibility

Categories

Tags

Upload Details

Usage Rights

6 Embeds 279

Statistics

Collective Amberjack - European Plone Symposium — Presentation Transcript