Building an artist community website with ArchGenXML / Poseidon

www.jazkarta.com 866.864.4918Building an Artist Community Website (9/21/05)

Building an artist community website

with Poseidon / ArchGenXML / Plone

Nate AunePlone Conference

Vienna, AustriaSept. 21, 2005

Building an Artist Community Website (9/21/05) www.jazkarta.com 866.864.4918

Who am I?

• Developer and owner, Jazkarta Consulting (www.jazkarta.com)

• Musician - saxophonist and composer (www.nateaune.com/music/)

• Founder of Plone4Artists project (www.plone4artists.org)


Overview• What is Archetypes?

• What is UML?

• What is ArchGenXML?

• Build a model using UML

• Transform the model into a Plone product

• Multimedia

• Questions?

jazkarta.com/presentations/artist-community.pdf


What is Archetypes?

• Framework for developing Plone products

• Automatically creates view and edit pages

• Maintains unique object IDs

• Creates references between objects


Archetypes framework

• Field validation

• Standard security setup

• Alternate storage options

• Data transformation capabilities


Archetypes schemas


Example Archetype: Artist

schema= Schema(( StringField('title'), ImageField('photo'), LinesField('instrument'),))

class Artist(BaseContent) schema = BaseSchema + schema

registerType(Artist,PROJECTNAME)


Widgetsschema= Schema(( StringField('title', widget=StringWidget( label=’Artist name’, size=20), ), ImageField('photo', widget=ImageWidget( label=’Headshot’), ), LinesField('instrument', widget=MultiSelectionWidget( label=’Instruments’), multiValue=1, ),))


What is UML?

• UML = Uniform Modeling Language

• Standard widely-adopted graphical language

• Describes the artifacts of software systems

• Focus on conceptual representations


Artist: Described in UML


Poseidon UML tool


What is ArchGenXML?

• Command line utility

• Auto-generates code from a UML model

• No round-trip support yet

• Custom code is preserved upon regeneration


Why use ArchGenXML? (part 1)

• You want to save time

• You are a lazy programmer

• You don’t like to reinvent the wheel

• You don’t like copying and pasting code

• You make heavy use of references and interfaces


Why use ArchGenXML? (part 2)

• You have big projects with many different content types

• You want or need a well-documented interface to your product

• You like structured model- and pattern-driven software development

• You want to maintain your project in the future without getting a headache


UML to Archetypes using ArchGenXML

schema= Schema(( StringField('title', widget=StringWidget( label=’Artist name’, size=20), ), ImageField('photo', widget=ImageWidget( label=’Headshot’), ), LinesField('instrument', widget=MultiSelectionWidget( label=’Instruments’), multiValue=1, ),))


UML speak to AT speak• product

• content type

• method

• field

• property

• subclass, view

• package

• class

• operation

• attribute

• tagged value

• stereotype


In practice

• 1) Save your model to the Products dir

• 2) Run the ArchGenXML script

• 3) Restart Zope

• 4) Install the newly generated product

svn co svn://svn.plone4artists.org/trunk/ArtistSite


Running the script$ cd /var/local/zope/instance1/Products$ ArchGenXML/ArchGenXML.py -o ArtistSite ArtistSite.zumlArchGenXML 1.4 devel 4(c) 2003 BlueDynamics GmbH, under GNU General Public License 2.0 or later

set outfilename [string] to ArtistSiteParsing...===============opening zargoXMI version: 1.2using xmi 1.2+ parseroutfile: ArtistSiteGenerating...==============method bodies will be preserved>>> Starting new Product: ArtistSite Generating class: Artist$


ArtistSite product dir

$ ls Products/ArtistSiteArtist.py __init__.py i18n skinsExtensions config.py refresh.txt version.txt$

Restart ZopeInstall product using QuickInstaller


Artist.py• Inserts documentation

• Placeholders for custom code

• i18n message ids

• Using ArtistSite/model/generate_source.sh

• Inserts author information

• Creates i18n msg catalog .pot file

• strips HTML from doc strings


Add new artist


Edit artist form


View artist


Static vocabulary

• Define a static vocabulary of instruments


Dynamic vocabulary

Use ATVocabularyManager to manage list of instruments


Dynamic vocab cont...


Containment

Use the solid rhomb to make a strict containment‘Artist’ instances can only be added to an ‘Artists’ instance


Artist container


Override base class

The artists folder will get large, so make it a BTreeFolder


Stereotype <<large>>

• Select the class

• Click on the stereotypes button (...)

• Select the ‘stub’ stereotype


References

Create a direct association

results in:

Reference fieldgroup to artist(s)


Group edit form

Group is associated with artists


Reference Browser Widget as default


Configure browser widget

Select the end point

Make multivaluedSpecify relationship

Define query


Adding references


Back references


Backreferences

Groups that artist belongs to


Stereotype <<member>>

Add the ‘member’ stereotype to tell ArchGenXML to subclass CMFMember


Registration form

• SiteMember is installed

• Replaces default member

• Easy way to create new member types


Stereotype <<stub>>

• Add content types to your model without having them get generated

• Makes it easy to integrate 3rd party products into your custom product

• Adds allowed_content_types to your class


<<stub>>

• Select the class

• Click on the stereotypes button (...)

• Select the ‘stub’ stereotype


PloneMall

• Example of a sophisticated e-commerce framework built using UML

• See the UML model here:

• http://www.plonemall.com/uml/UML-beta2.png/image_view_fullscreen


SiteEvent : a custom event type

• Subclass ATEvent and add your own fields


Associate with venue

• Make a:

• Venues container

• Venue content type

• Direct association from SiteEvent to Venue


What I didn’t cover• Methods

• Additional Stereotypes

• actions, portal_tool, abstract, ordered

• Generalization (Interfaces)

• Workflow

• Unit testing

• Documentation


Acknowledgements• Philipp Auersperg (Blue Dynamics)

• Jens Klein (jensens)

• Martin Aspeli (optilude)

• Fabiano Weimar dos Santos (xiru)

• Bernie Snizek (DrZoltron)

• Blue Dynamics - conference organizers

• Plone communityGo to Jens and Phil’s ArchGenXML talk!


Links• How to subclass ATContentType in 7 minutes

•http://plone.org/documentation/how-to/subclass-atct-using-archgenxml• ArchGenXML product page - http://plone.org/products/archgenxml

• ArchGenXML getting started tutorial by Jens Klein

• http://plone.org/documentation/tutorial/archgenxml-getting-started

• ArchGenXML manual (with screenshots)

• http://plone.org/documentation/archetypes/archgenxml-manual

• Intro to Archetypes by Sidnei da Silva, published on ZopeMag.com

• http://www.zopemag.com/Issue006/Section_Articles/article_IntroToArchteypes.html

• Archetypes: Customizing Plone in 60 seconds (PDF) by Andy McKay

• http://www.enfoldsystems.com/About/Talks/archetypes.pdf

• Archetypes Fields Quick Reference by Maik Röder

• http://plone.org/documentation/archetypes/arch_field_quickref_1_3_1

• Archetypes Widgets Quick Reference by Maik Röder

• http://plone.org/documentation/archetypes/arch_widget_quickref_1_3_1


Multimedia in Plone

• Multimedia = audio, video, photo, etc.

• Currently limited built-in support for these media file types

• No definitive multimedia package for Plone


Existing 3rd party products• Audio

• ATAudio, Plodcasting, PloneRadio

• Video

• ATVideo, lilix.movie, Parwin

• Photo

• ATPhoto, CMFPhoto, ZPhotoSlides


PloneMultimedia• PloneMultimedia

• ATAudio

• ATVideo

• ATPhoto

• Common ‘base’ products in which to build custom multimedia products

• Add-on product for ATContentTypes


Subclass ATCT• ATAudio - subclass ATFile

• inherit methods: cleanupFilename, download, getIcon

• validators: checkFileSize

• ATPhoto - subclass ATImage

• getEXIF, ATFolder template-mixin (Display menu)


Upload audio file

• Type in a description

• Upload file

• Click ‘Next’ button


Metadata

• ATAudio extracts metadata

• Auto-populates form fields

• Extensible genres

• Upload album art


Audio view page

• Embedded player

• Play in popup window

• Stream to external media player

• Download to FS

Drag-n-drop MP3s

Drag-n-drop MP3s to WebDAV folder MP3s appear in recordings folder

Metadata extracted

Song Metadata (from iTunes)

ATAudio auto-extracts ID3 tags


CD view page


Flash player

• Flash popup player

• Uses XSPF playlist

• Jump forward/backward through tracks


Demo


Thanks to...

• ATAudio team

• Volodymr Cherepanyak (chervol)

• Rocky Burt (RockyBurt)

• Salim Fadhley (_salimfadhley)

• jenner (for adding Flash player support)


Multimedia sprint

• This thursday and friday at the Hotel Academia!

• http://plone.org/events/sprints/multimedia

• Ask Nate for a map to the hotel


Multimedia Resources• http://plone.org/products/ataudio

• http://plone.org/products/plonemultimedia

• http://plone4artists.org

• Mailing list: [email protected] with subject “subscribe”

• Mailing list: [email protected] with subject “subscribe”


Questions?

Building an artist community website with ArchGenXML / Poseidon

Technology

Transcript of Building an artist community website with ArchGenXML / Poseidon