Difference between revisions of "Common Presentation"

From MPDLMediaWiki
Jump to navigation Jump to search
m
 
(9 intermediate revisions by 2 users not shown)
Line 8: Line 8:
As to solution specific needs resources will be stored in two places with the following structure.
As to solution specific needs resources will be stored in two places with the following structure.


==SVN==
== Solution Specific GUI Resources ==


e.g. FACES
Each svn project keeps a part of it's presentation (JS won't be separated to avoid cross side scripting)
 
/$solution$_presentation/src/main/webapp/resources
 
 
The foldes should look like that (pls. merge additional image/script locations to what is documented here):


<pre>
<pre>
- solutionResources (contains all solution specific GUI stuff)
 
-- facesJavaScript (contains solution specific JS plus plugins, if only used here)
- resources
-- javaScript (contains common JS and the jquery core)
-- commonJavaScript (should be kept in synch with other solutions)
--- jquery
--- componentJavaScript (contains JS used in common components)
-- componentJavaScript (contains JS used in common components)
--- externalJavaScript (3rd party JS resoures)
-- facesImages (contains favicon, startpage images and the like)
--- jquery (The jQuery framework)
--- eSciDoc_javascript.js: Installs component scripts and holds general JS
--- main.js: Loads main functions
 
-- $solution$Images (contains overrides for images used by solutions only: static Startpage Images, Logos, ...)
--- ...
--- ...
 
-- $solution$JavaScript (contains solution specific JS plus plugins, if only used here)
--- ...
--- ...
 
</pre>
</pre>




The common part of the presentation will be stored here: https://zim02.gwdg.de/repos/common/trunk/common_services/common_presentation/src/main/resources/
The common part of the presentation will be stored here: https://subversion.mpdl.mpg.de/repos/common/trunk/common_services/common_presentation/
 
== New Common GUI Resources ==


<pre>
<pre>
-- css (contains the css for all solutions)
-- cssFramework (contains the css for all solutions)
--- componentCSS
--- componentCSS (e.g. css for list display)
--- globalCSS (framework core, standard element sizes)
--- globalImages (images valid for all solutions (e.g. eSciDoc Logo), may get overridden by solution specific stuff)
--- themes (themes and standard skins are all stored here, and will be deployed as needed)
--- themes (themes and standard skins are all stored here, and will be deployed as needed)
---- skin_skin1 (contains logo, icons as well)
---- skin_skin1 (contains logo, icons as well)
----- images (icon library)
----- styles (appearance layer)
---- skin_skin2
---- skin_skin2
---- skin_skin3
----- images (icon library)
----- styles (appearance layer)
---- skin_ ...
----- images (icon library)
----- styles (appearance layer)
</pre>
</pre>


The following folders are decrepated and will be replaced:


Problem: jQuery vs. RichFaces ($)
* eSciDoc_CSS_v2/
 
* favicon.ico
The following folders could be moved:
* images/ (??)
 
* skins/
# eSciDoc_CSS_v2/
# favicon.ico
# images/ (??)
# skins/


Problem: Logo is solution specific and needs a different folder: move to PNG.
=Builds=
 
* How should resources be fetched when deployment happens?


Common presentation will be defined as dependency.
Common presentation will be defined as dependency.
* How/Where are stored for productive solutions?
Should stay like it is now. Will be done like PubMan if an installer is made.
=Flexibility=
* Is there a need to address solution specific parts of the presentation separately?


=JavaScript Strategy=
=JavaScript Strategy=


* RichFaces proved to be a nice way for dynamic stuff DARIAH/imeji
If dynamic patterns are needed UIE checks http://livedemo.exadel.com/richfaces-demo/richfaces/actionparam.jsf?s=darkX to suggest one. If feasability is given, an overwrite style will be written to extend css:
* RF components can be styled flexible


It doesn't make sense anymore to grab more jQuery stuff for future development while more and more RichFaces components are used.
<pre>
 
/componentCSS/externalOverrides_js.css.
# how and when to phase out jQuery?
</pre>
# where to store additional css classes for jQuery?
# how to plug in additional jQuery stuff into JSF/RichFaces (if possible/necessary)? 
 
Doesn't make sense time. JS can't be unified on short term base.


A separate css file should be created to overwrite richfaces scc: rich_overwrite_js.css.


</div>
</div>


 
[[Category: User Interface Engineering]]
[[Category:Interface Development| ]]

Latest revision as of 14:29, 25 April 2012

Precondition[edit]

CSS/JS resources in the presentation layer are maintained redundantly across solutions. As GUI 2.0 is common for all solutions it can be maintained and deployed in a more common manner to prevent diverging sources.

Places[edit]

As to solution specific needs resources will be stored in two places with the following structure.

Solution Specific GUI Resources[edit]

Each svn project keeps a part of it's presentation (JS won't be separated to avoid cross side scripting)

/$solution$_presentation/src/main/webapp/resources


The foldes should look like that (pls. merge additional image/script locations to what is documented here):


- resources
-- commonJavaScript (should be kept in synch with other solutions)
--- componentJavaScript (contains JS used in common components)
--- externalJavaScript (3rd party JS resoures)
--- jquery (The jQuery framework)
--- eSciDoc_javascript.js: Installs component scripts and holds general JS
--- main.js: Loads main functions

-- $solution$Images (contains overrides for images used by solutions only: static Startpage Images, Logos, ...)
--- ...
--- ...

-- $solution$JavaScript (contains solution specific JS plus plugins, if only used here)
--- ...
--- ...


The common part of the presentation will be stored here: https://subversion.mpdl.mpg.de/repos/common/trunk/common_services/common_presentation/

New Common GUI Resources[edit]

-- cssFramework (contains the css for all solutions)
--- componentCSS (e.g. css for list display)
--- globalCSS (framework core, standard element sizes)
--- globalImages (images valid for all solutions (e.g. eSciDoc Logo), may get overridden by solution specific stuff)
--- themes (themes and standard skins are all stored here, and will be deployed as needed)
---- skin_skin1 (contains logo, icons as well)
----- images (icon library)
----- styles (appearance layer)
---- skin_skin2
----- images (icon library)
----- styles (appearance layer)
---- skin_ ...
----- images (icon library)
----- styles (appearance layer)

The following folders are decrepated and will be replaced:

  • eSciDoc_CSS_v2/
  • favicon.ico
  • images/ (??)
  • skins/

Builds[edit]

Common presentation will be defined as dependency.

JavaScript Strategy[edit]

If dynamic patterns are needed UIE checks http://livedemo.exadel.com/richfaces-demo/richfaces/actionparam.jsf?s=darkX to suggest one. If feasability is given, an overwrite style will be written to extend css:

/componentCSS/externalOverrides_js.css.