Difference between revisions of "Common Presentation"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(6 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
--- 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>


As the logo needs to be separated from the common graphics it will be included in the standard includes JSP of the solution.
The following folders are decrepated and will be replaced:
 
The following folders could be moved:


# eSciDoc_CSS_v2/
* eSciDoc_CSS_v2/
# favicon.ico
* favicon.ico
# images/ (??)
* images/ (??)
# skins/
* skins/


=Builds=
=Builds=
Line 49: Line 72:
=JavaScript Strategy=
=JavaScript Strategy=


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 overwrite style can be written to extend css.
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:


jQuery can't phase out at this point in time. Manual JS scripting is also still necessary.
<pre>
/componentCSS/externalOverrides_js.css.
</pre>


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.