doc/refactoring-the-css-with-uiprops.rst
author Alexandre Fayolle <alexandre.fayolle@logilab.fr>
Tue, 25 Jan 2011 12:09:59 +0100
branchstable
changeset 6889 37668bf302f5
parent 5492 da983679fab5
child 10121 23af005426bf
permissions -rw-r--r--
improve massive deletion performance change hooks.integrity._DelayedDeleteOp implementation to give it a chance of processing the entities by chunks of reasonnable size (500 entities at a time) adapt ssplanner.DeleteEntitiesStep to call a variant of glob_delete_entity with several entities. That variant calls all the before_delete_entities hooks in one go, then performs the deletion, and then calls all the after_delete_entities hooks. The deletion is performed by grouping together entities by etype and by source. adapt the HooksManager to call the hooks on a list of entities instead of on a single entity. adapt the sources to be able to delete several entities of the same etype at once. changed the source fti_(un)index_entity methods to fti_(un)index_entities taking a collection of entities.

=========================================
Refactoring the CSSs with UI properties
=========================================

Overview
=========

Managing styles progressively became difficult in CubicWeb. The
introduction of uiprops is an attempt to fix this problem.

The goal is to make it possible to use variables in our CSSs.

These variables are defined or computed in the uiprops.py python file
and inserted in the CSS using the Python string interpolation syntax.

A quick example, put in ``uiprops.py``::

  defaultBgColor = '#eee'

and in your css::

  body { background-color: %(defaultBgColor)s; }


The good practices are:

- define a variable in uiprops to avoid repetitions in the CSS
  (colors, borders, fonts, etc.)

- define a variable in uiprops when you need to compute values
  (compute a color palette, etc.)

The algorithm implemented in CubicWeb is the following:

- read uiprops file while walk up the chain of cube dependencies: if
  cube myblog depends on cube comment, the variables defined in myblog
  will have precedence over the ones in comment

- replace the %(varname)s in all the CSSs of all the cubes

Keep in mind that the browser will then interpret the CSSs and apply
the standard cascading mechanism.

FAQ
====

- How do I keep the old style?

  Put ``STYLESHEET = [data('cubicweb.old.css')]`` in your uiprops.py
  file and think about something else.

- What are the changes in cubicweb.css?

  Version 3.9.0 of cubicweb changed the following in the default html
  markup and css:

  ===============  ==================================
   old              new
  ===============  ==================================
   .navcol          #navColumnLeft, #navColumnRight
   #contentcol      #contentColumn
   .footer          #footer
   .logo	    #logo
   .simpleMessage   .loginMessage
   .appMsg	    (styles are removed from css)
   .searchMessage   (styles are removed from css)
  ===============  ==================================

  Introduction of the new cubicweb.reset.css based on Eric Meyer's
  reset css.

  Lots of margin, padding, etc.