Update to theming document, important news for themers

7 messages Options
Embed this post
Permalink
vedaw () Update to theming document, important news for themers
Reply Threaded More More options
Print post
Permalink
Hi All,

After some poking around in a theme today, I realized that something had
changed in the 1.1.3 version of the plone.app.layout egg. The upshot of this
change meant that any new themes being developed with this newer egg would
break when installed on an older 3.x version of Plone.

I've added a section called "3.1 Theme Compatibility Between Different 3.x
Versions of Plone" to this document to try to ensure best practices moving
forward:

http://plone.org/documentation/tutorial/customizing-main-template-viewlets/o
verriding-a-class-viewlet

While this is a documentation update, it's also important for themers to
understand that something has changed under the covers. And, for the OOTB
project in particular, themers should strive for backwards compatibility.

If my notes here are unclear, please let me know.

Thanks!

- Veda


-------------------
Veda Williams, ONE/Northwest
Web Developer / Skinner




------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi () Re: [OOTB Plone Themes discussion] Update to theming document, important news for themers
Reply Threaded More More options
Print post
Permalink
We shouldn't break things in 3.x, please report this as a bug. A theme that works on 3.0 should work on 3.1 (unless it's impossible and has a very very good reason).

On Tue, Dec 9, 2008 at 5:02 PM, Veda Williams <[hidden email]> wrote:
Hi All,

After some poking around in a theme today, I realized that something had
changed in the 1.1.3 version of the plone.app.layout egg. The upshot of this
change meant that any new themes being developed with this newer egg would
break when installed on an older 3.x version of Plone.

I've added a section called "3.1 Theme Compatibility Between Different 3.x
Versions of Plone" to this document to try to ensure best practices moving
forward:

http://plone.org/documentation/tutorial/customizing-main-template-viewlets/o
verriding-a-class-viewlet


While this is a documentation update, it's also important for themers to
understand that something has changed under the covers. And, for the OOTB
project in particular, themers should strive for backwards compatibility.

If my notes here are unclear, please let me know.

Thanks!

- Veda


-------------------
Veda Williams, ONE/Northwest
Web Developer / Skinner





--
Archive: http://www.openplans.org/projects/ootb-plone-themes/lists/ootb-plone-themes-discussion/archive/2008/12/1228870935366
To unsubscribe send an email with subject "unsubscribe" to [hidden email].  Please contact [hidden email] for questions.




--
Alexander Limi · http://limi.net

------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi · http://limi.net

David Glick-2 () Re: [OOTB Plone Themes discussion] Update to theming document, important news for themers
Reply Threaded More More options
Print post
Permalink
Some javascript/style in this post has been disabled (why?)
I feel the need to clarify: A theme that works on 3.0 *will* continue to work on 3.1.

A theme created just for 3.1 should be easier to create because you can customize a template by setting template= in ZCML rather than making a viewlet subclass.

If you want to create a theme that is compatible with both, you can make a subclass and do
    render = index = ViewPageTemplateFile(...)

However in that case you won't be able to override using template= in ZCML in Plone 3.1.x.  If you want something that's compatible with 3.0.x and 3.1.x AND lets you customize in this way in 3.1.x, you can set just index and then include the following in your viewlet subclass:
def render(self):
return self.index()

Sorry for the confusion; my intent with this change was to make things simpler.  I still think it does for the common case of a theme that is not distributed and doesn't need to be backwards-compatible with 3.0.x.

David

On Dec 9, 2008, at 5:47 PM, Alexander Limi wrote:

We shouldn't break things in 3.x, please report this as a bug. A theme that works on 3.0 should work on 3.1 (unless it's impossible and has a very very good reason).

On Tue, Dec 9, 2008 at 5:02 PM, Veda Williams <[hidden email]> wrote:
Hi All,

After some poking around in a theme today, I realized that something had
changed in the 1.1.3 version of the plone.app.layout egg. The upshot of this
change meant that any new themes being developed with this newer egg would
break when installed on an older 3.x version of Plone.

I've added a section called "3.1 Theme Compatibility Between Different 3.x
Versions of Plone" to this document to try to ensure best practices moving
forward:

http://plone.org/documentation/tutorial/customizing-main-template-viewlets/o
verriding-a-class-viewlet


While this is a documentation update, it's also important for themers to
understand that something has changed under the covers. And, for the OOTB
project in particular, themers should strive for backwards compatibility.

If my notes here are unclear, please let me know.

Thanks!

- Veda


-------------------
Veda Williams, ONE/Northwest
Web Developer / Skinner





--
Archive: http://www.openplans.org/projects/ootb-plone-themes/lists/ootb-plone-themes-discussion/archive/2008/12/1228870935366
To unsubscribe send an email with subject "unsubscribe" to [hidden email].  Please contact [hidden email] for questions.




--
Alexander Limi · http://limi.net
------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

David Glick
Web Developer
ONE/Northwest

New tools and strategies for engaging people in protecting the environment

work: (206) 286-1235 x32
mobile: (206) 679-3833

Subscribe to ONEList, our email newsletter!
Practical advice for effective online engagement





------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
David Glick-2 () Re: Update to theming document, important news for themers
Reply Threaded More More options
Print post
Permalink
In reply to this post by vedaw
I fixed some incorrect indenting and factual and nomenclature errors  
in your docs addition.

However, on further thought, I think OOTB themes that need backwards  
compatibility should just use:
render = ViewPageTemplateFile(...)

...just like we always have done (until Plone 3.1.x).

Doing it that way means the viewlet can't be overridden by a ZCML  
template= declaration on another layer, but what I just realized is  
that it can't anyway, because you can only have one theme-specific  
layer at a time.  So that concern is irrelevant.

Using 'index' is really only relevant for Plone itself and add-on  
products.

David

On Dec 9, 2008, at 5:02 PM, Veda Williams wrote:

> Hi All,
>
> After some poking around in a theme today, I realized that something  
> had
> changed in the 1.1.3 version of the plone.app.layout egg. The upshot  
> of this
> change meant that any new themes being developed with this newer egg  
> would
> break when installed on an older 3.x version of Plone.
>
> I've added a section called "3.1 Theme Compatibility Between  
> Different 3.x
> Versions of Plone" to this document to try to ensure best practices  
> moving
> forward:
>
> http://plone.org/documentation/tutorial/customizing-main-template-viewlets/o
> verriding-a-class-viewlet
>
> While this is a documentation update, it's also important for  
> themers to
> understand that something has changed under the covers. And, for the  
> OOTB
> project in particular, themers should strive for backwards  
> compatibility.
>
> If my notes here are unclear, please let me know.
>
> Thanks!
>
> - Veda
>
>
> -------------------
> Veda Williams, ONE/Northwest
> Web Developer / Skinner
>
>
>
>
> ------------------------------------------------------------------------------
> SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas,  
> Nevada.
> The future of the web can't happen without you.  Join us at MIX09 to  
> help
> pave the way to the Next Web now. Learn more and register at
> http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
> _______________________________________________
> Plone-docs mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/plone-docs

David Glick
Web Developer
ONE/Northwest

New tools and strategies for engaging people in protecting the  
environment

http://www.onenw.org
[hidden email]
work: (206) 286-1235 x32
mobile: (206) 679-3833

Subscribe to ONEList, our email newsletter!
Practical advice for effective online engagement
http://www.onenw.org/full_signup





------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi () Re: [OOTB Plone Themes discussion] Update to theming document, important news for themers
Reply Threaded More More options
Print post
Permalink
In reply to this post by David Glick-2
I see. That makes sense, although then it should come with the appropriate disclaimers. :)

Will the standard paster output still produce something that is compatible with both?

On Tue, Dec 9, 2008 at 6:15 PM, David Glick <[hidden email]> wrote:
I feel the need to clarify: A theme that works on 3.0 *will* continue to work on 3.1.

A theme created just for 3.1 should be easier to create because you can customize a template by setting template= in ZCML rather than making a viewlet subclass.

If you want to create a theme that is compatible with both, you can make a subclass and do
    render = index = ViewPageTemplateFile(...)

However in that case you won't be able to override using template= in ZCML in Plone 3.1.x.  If you want something that's compatible with 3.0.x and 3.1.x AND lets you customize in this way in 3.1.x, you can set just index and then include the following in your viewlet subclass:
def render(self):
return self.index()

Sorry for the confusion; my intent with this change was to make things simpler.  I still think it does for the common case of a theme that is not distributed and doesn't need to be backwards-compatible with 3.0.x.

David

On Dec 9, 2008, at 5:47 PM, Alexander Limi wrote:

We shouldn't break things in 3.x, please report this as a bug. A theme that works on 3.0 should work on 3.1 (unless it's impossible and has a very very good reason).

On Tue, Dec 9, 2008 at 5:02 PM, Veda Williams <[hidden email]> wrote:
Hi All,

After some poking around in a theme today, I realized that something had
changed in the 1.1.3 version of the plone.app.layout egg. The upshot of this
change meant that any new themes being developed with this newer egg would
break when installed on an older 3.x version of Plone.

I've added a section called "3.1 Theme Compatibility Between Different 3.x
Versions of Plone" to this document to try to ensure best practices moving
forward:

http://plone.org/documentation/tutorial/customizing-main-template-viewlets/o
verriding-a-class-viewlet


While this is a documentation update, it's also important for themers to
understand that something has changed under the covers. And, for the OOTB
project in particular, themers should strive for backwards compatibility.

If my notes here are unclear, please let me know.

Thanks!

- Veda


-------------------
Veda Williams, ONE/Northwest
Web Developer / Skinner





--
Archive: http://www.openplans.org/projects/ootb-plone-themes/lists/ootb-plone-themes-discussion/archive/2008/12/1228870935366
To unsubscribe send an email with subject "unsubscribe" to [hidden email].  Please contact [hidden email] for questions.




--
Alexander Limi · http://limi.net
------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

David Glick
Web Developer
ONE/Northwest

New tools and strategies for engaging people in protecting the environment

work: (206) 286-1235 x32
mobile: (206) 679-3833

Subscribe to ONEList, our email newsletter!
Practical advice for effective online engagement







--
Alexander Limi · http://limi.net

------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi · http://limi.net

vedaw () Re: [OOTB Plone Themes discussion] Update to theming document, important news for themers
Reply Threaded More More options
Print post
Permalink
Some javascript/style in this post has been disabled (why?)
Re: [Plone-docs] [OOTB Plone Themes discussion] Update to theming document, important news for themers Basically, we’re looking at a documentation issue. The paster output should be fine, there’s just some education that needs to happen here to make sure the knowledge is translated to the community at large.

- Veda


On 12/9/08 6:36 PM, "Alexander Limi" <[hidden email]> wrote:

I see. That makes sense, although then it should come with the appropriate disclaimers. :)

Will the standard paster output still produce something that is compatible with both?

On Tue, Dec 9, 2008 at 6:15 PM, David Glick <[hidden email]> wrote:
I feel the need to clarify: A theme that works on 3.0 *will* continue to work on 3.1.

A theme created just for 3.1 should be easier to create because you can customize a template by setting template= in ZCML rather than making a viewlet subclass.

If you want to create a theme that is compatible with both, you can make a subclass and do
    render = index = ViewPageTemplateFile(...)

However in that case you won't be able to override using template= in ZCML in Plone 3.1.x.  If you want something that's compatible with 3.0.x and 3.1.x AND lets you customize in this way in 3.1.x, you can set just index and then include the following in your viewlet subclass:
def render(self):
return self.index()

Sorry for the confusion; my intent with this change was to make things simpler.  I still think it does for the common case of a theme that is not distributed and doesn't need to be backwards-compatible with 3.0.x.

David

On Dec 9, 2008, at 5:47 PM, Alexander Limi wrote:

We shouldn't break things in 3.x, please report this as a bug. A theme that works on 3.0 should work on 3.1 (unless it's impossible and has a very very good reason).

On Tue, Dec 9, 2008 at 5:02 PM, Veda Williams <[hidden email]> wrote:
 
Hi All,
 
 After some poking around in a theme today, I realized that something had
 changed in the 1.1.3 version of the plone.app.layout egg. The upshot of this
 change meant that any new themes being developed with this newer egg would
 break when installed on an older 3.x version of Plone.
 
 I've added a section called "3.1 Theme Compatibility Between Different 3.x
 Versions of Plone" to this document to try to ensure best practices moving
 forward:
 
 http://plone.org/documentation/tutorial/customizing-main-template-viewlets/o
 verriding-a-class-viewlet <http://plone.org/documentation/tutorial/customizing-main-template-viewlets/overriding-a-class-viewlet>
 
 While this is a documentation update, it's also important for themers to
 understand that something has changed under the covers. And, for the OOTB
 project in particular, themers should strive for backwards compatibility.
 
 If my notes here are unclear, please let me know.
 
 Thanks!
 
 - Veda
 
 
 -------------------
 Veda Williams, ONE/Northwest
 Web Developer / Skinner
 

 
 
 
 --
 Archive: http://www.openplans.org/projects/ootb-plone-themes/lists/ootb-plone-themes-discussion/archive/2008/12/1228870935366
 To unsubscribe send an email with subject "unsubscribe" to [hidden email].  Please contact [hidden email] for questions.
 
 




------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
vedaw () Re: Update to theming document, important news for themers
Reply Threaded More More options
Print post
Permalink
In reply to this post by David Glick-2
Thanks for the sanity check, David. I tried. :)


On 12/9/08 6:32 PM, "David Glick" <[hidden email]> wrote:

> I fixed some incorrect indenting and factual and nomenclature errors
> in your docs addition.
>
> However, on further thought, I think OOTB themes that need backwards
> compatibility should just use:
> render = ViewPageTemplateFile(...)
>
> ...just like we always have done (until Plone 3.1.x).
>
> Doing it that way means the viewlet can't be overridden by a ZCML
> template= declaration on another layer, but what I just realized is
> that it can't anyway, because you can only have one theme-specific
> layer at a time.  So that concern is irrelevant.
>
> Using 'index' is really only relevant for Plone itself and add-on
> products.
>
> David
>
> On Dec 9, 2008, at 5:02 PM, Veda Williams wrote:
>
>> Hi All,
>>
>> After some poking around in a theme today, I realized that something
>> had
>> changed in the 1.1.3 version of the plone.app.layout egg. The upshot
>> of this
>> change meant that any new themes being developed with this newer egg
>> would
>> break when installed on an older 3.x version of Plone.
>>
>> I've added a section called "3.1 Theme Compatibility Between
>> Different 3.x
>> Versions of Plone" to this document to try to ensure best practices
>> moving
>> forward:
>>
>> http://plone.org/documentation/tutorial/customizing-main-template-viewlets/o
>> verriding-a-class-viewlet
>>
>> While this is a documentation update, it's also important for
>> themers to
>> understand that something has changed under the covers. And, for the
>> OOTB
>> project in particular, themers should strive for backwards
>> compatibility.
>>
>> If my notes here are unclear, please let me know.
>>
>> Thanks!
>>
>> - Veda
>>
>>
>> -------------------
>> Veda Williams, ONE/Northwest
>> Web Developer / Skinner
>>
>>
>>
>>
>>
----------------------------------------------------------------------------->>
-

>> SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas,
>> Nevada.
>> The future of the web can't happen without you.  Join us at MIX09 to
>> help
>> pave the way to the Next Web now. Learn more and register at
>> http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
>> _______________________________________________
>> Plone-docs mailing list
>> [hidden email]
>> https://lists.sourceforge.net/lists/listinfo/plone-docs
>
> David Glick
> Web Developer
> ONE/Northwest
>
> New tools and strategies for engaging people in protecting the
> environment
>
> http://www.onenw.org
> [hidden email]
> work: (206) 286-1235 x32
> mobile: (206) 679-3833
>
> Subscribe to ONEList, our email newsletter!
> Practical advice for effective online engagement
> http://www.onenw.org/full_signup
>
>
>
>


------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs