[richfaces-issues] [JBoss JIRA] (RF-12017) Template handling

Tue Feb 28 13:15:37 EST 2012

     [ https://issues.jboss.org/browse/RF-12017?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dupont Dupont updated RF-12017:
-------------------------------

    Description: 
This functionnality will enable easily import a theme into it's own application.

It's quite related to template handling in JSF 2.2 [1].

A template / theme will consist of :
 * 1..n : the necessary xhtml file for the site layout.
 * 0..n : images.
 * 0..n : css files or ecss files.
 * 0..n : js files.
 * 0..1 : resource-mapping.property
 * 1 : skin.properties

Requirements :
 * easy installation
   adding a template / theme must be just a matter of drag & drop (so all the resources must be a stand alone directory).
 * easy modification
   the developer must be able to customize the template / theme.
   Implies :
   ** template/theme resources must be expanded (not zipped or jarred)
   ** hot reloading all common theme related resource modification must be hot reloaded.

Proposed organization : 
 * src/main/webapp/resources/templates/theme1/template.xhtml
 * src/main/webapp/resources/templates/theme1/img
 * src/main/webapp/resources/templates/theme1/css
 * src/main/webapp/resources/templates/theme1/js
 * src/main/webapp/resources/templates/theme1/theme1.skin.properties
 * src/main/webapp/resources/templates/theme1/resource-mapping.properties

TBD :
 * this JIRA must define common names for template parts (i.e. menu, title, content) in order to be able
 		to use different themes with the same jsf files.

Sample usage (jsf file using a template) :

{code:xml}
<ui:composition template="#{theme.template}" xmlns="http://www.w3.org/1999/xhtml"  
  xmlns:h="http://java.sun.com/jsf/html"  
  xmlns:ui="http://java.sun.com/jsf/facelets"
  xmlns:f="http://java.sun.com/jsf/core">

	<ui:define name="title">Gallery</ui:define>

	<ui:define name="content">
	My custom content
	</ui:define>

</ui:composition>
{code}

[1] 
http://weblogs.java.net/blog/lamineba/archive/2011/11/12/multi-templating-system-jsf-22-what-does-it-mean-you
http://weblogs.java.net/blog/lamineba/archive/2011/10/03/conventional-ui-design-facelets-and-jsf-22
https://svn.java.net/svn/jsf-extensions~svn/branches/SPEC_532_MODULAR_JSF

[2] Discussion on this topic : http://transcripts.jboss.org/channel/irc.freenode.org/%23richfaces/2012/%23richfaces.2012-02-28.log.html

  was:

This functionnality will enable easily import a theme into it's own application.

It's quite related to template handling in JSF 2.2 [1].

A template / theme will consist of :
 * 1..n : the necessary xhtml file for the site layout.
 * 0..n : images.
 * 0..n : css files or ecss files.
 * 0..n : js files.
 * 0..1 : resource-mapping.property
 * 1 : skin.properties

Requirements :
 * easy installation
   adding a template / theme must be just a matter of drag & drop (so all the resources must be a stand alone directory).
 * easy modification
   the developer must be able to customize the template / theme.
   Implies :
   ** template/theme resources must be expanded (not zipped or jarred)
   ** hot reloading all common theme related resource modification must be hot reloaded.

Proposed organization : 
 * src/main/webapp/resources/templates/theme1/template.xhtml
 * src/main/webapp/resources/templates/theme1/img
 * src/main/webapp/resources/templates/theme1/css
 * src/main/webapp/resources/templates/theme1/js
 * src/main/webapp/resources/templates/theme1/theme1.skin.properties
 * src/main/webapp/resources/templates/theme1/resource-mapping.properties

TBD :
 * this JIRA must define common names for template parts (i.e. menu, title, content) in order to be able
 		to use different themes with the same jsf files.

Sample usage (jsf file using a template) :

{code:xml}
<ui:composition template="#{theme.template}" xmlns="http://www.w3.org/1999/xhtml"  
  xmlns:h="http://java.sun.com/jsf/html"  
  xmlns:ui="http://java.sun.com/jsf/facelets"
  xmlns:f="http://java.sun.com/jsf/core">

	<ui:define name="title">Gallery</ui:define>

	<ui:define name="content">
	My custom content
	</ui:define>

</ui:composition>
{code}

[1] 
http://weblogs.java.net/blog/lamineba/archive/2011/11/12/multi-templating-system-jsf-22-what-does-it-mean-you
http://weblogs.java.net/blog/lamineba/archive/2011/10/03/conventional-ui-design-facelets-and-jsf-22
https://svn.java.net/svn/jsf-extensions~svn/branches/SPEC_532_MODULAR_JSF

> Template handling
> -----------------
>
>                 Key: RF-12017
>                 URL: https://issues.jboss.org/browse/RF-12017
>             Project: RichFaces
>          Issue Type: Feature Request
>      Security Level: Public(Everyone can see) 
>            Reporter: Dupont Dupont
>
> This functionnality will enable easily import a theme into it's own application.
> It's quite related to template handling in JSF 2.2 [1].
> A template / theme will consist of :
>  * 1..n : the necessary xhtml file for the site layout.
>  * 0..n : images.
>  * 0..n : css files or ecss files.
>  * 0..n : js files.
>  * 0..1 : resource-mapping.property
>  * 1 : skin.properties
> Requirements :
>  * easy installation
>    adding a template / theme must be just a matter of drag & drop (so all the resources must be a stand alone directory).
>  * easy modification
>    the developer must be able to customize the template / theme.
>    Implies :
>    ** template/theme resources must be expanded (not zipped or jarred)
>    ** hot reloading all common theme related resource modification must be hot reloaded.
> Proposed organization : 
>  * src/main/webapp/resources/templates/theme1/template.xhtml
>  * src/main/webapp/resources/templates/theme1/img
>  * src/main/webapp/resources/templates/theme1/css
>  * src/main/webapp/resources/templates/theme1/js
>  * src/main/webapp/resources/templates/theme1/theme1.skin.properties
>  * src/main/webapp/resources/templates/theme1/resource-mapping.properties
> TBD :
>  * this JIRA must define common names for template parts (i.e. menu, title, content) in order to be able
>  		to use different themes with the same jsf files.
> Sample usage (jsf file using a template) :
> {code:xml}
> <ui:composition template="#{theme.template}" xmlns="http://www.w3.org/1999/xhtml"  
>   xmlns:h="http://java.sun.com/jsf/html"  
>   xmlns:ui="http://java.sun.com/jsf/facelets"
>   xmlns:f="http://java.sun.com/jsf/core">
> 	<ui:define name="title">Gallery</ui:define>
> 	<ui:define name="content">
> 	My custom content
> 	</ui:define>
> </ui:composition>
> {code}
> [1] 
> http://weblogs.java.net/blog/lamineba/archive/2011/11/12/multi-templating-system-jsf-22-what-does-it-mean-you
> http://weblogs.java.net/blog/lamineba/archive/2011/10/03/conventional-ui-design-facelets-and-jsf-22
> https://svn.java.net/svn/jsf-extensions~svn/branches/SPEC_532_MODULAR_JSF
> [2] Discussion on this topic : http://transcripts.jboss.org/channel/irc.freenode.org/%23richfaces/2012/%23richfaces.2012-02-28.log.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira