6 The packages ``cubicweb`` and ``cubicweb-dev`` installs a command line tool

     6 The packages ``cubicweb`` and ``cubicweb-dev`` install a command line

     7 for *CubicWeb* called ``cubicweb-ctl``. This tool provides a wide range of

     7 tool for *CubicWeb* called ``cubicweb-ctl``. This tool provides a wide

     8 commands described in details in :ref:`cubicweb-ctl`.

     8 range of commands described in details in :ref:`cubicweb-ctl`.

     9 

     9 

    10 Once your *CubicWeb* development environment is set up, you can create a new

    10 Once your *CubicWeb* development environment is set up, you can create

    11 cube::

    11 a new cube::

    43 required by the class EntityType and must be less than 50 characters.

    43 required and must be less than 50 characters.  The

    44 The description is a string that is not constrained.

    44 description is a string that is not constrained.

    51 the full-text index and has no constraint.

    51 the database full-text index and has no constraint.

   175 Each entity defined in a model inherits default views allowing

   175 Each entity defined in a model is associated with default views

   176 different rendering of the data. You can redefine each of them

   176 allowing different rendering of the data. You can redefine each of

   177 according to your needs and preferences. So let's see how the

   177 them according to your needs and preferences. So let's see how the

   186   - an identifier (all objects in *CubicWeb* are entered in a registry

   186   - an identifier (all objects in *CubicWeb* are recorded in a

   187     and this identifier will be used as a key)

   187     registry and this identifier will be used as a key)

   191 A view has a set of methods complying

   191 A view has a set of methods complying with the `View` class interface

   192 with the `View` class interface (`cubicweb.common.view`).

   192 (`cubicweb.common.view`).

   197 A view is applied on a `result set` which contains a set of

   197 A view is applied on a `result set` which contains a set of entities

   198 entities we are trying to display. *CubicWeb* uses a selector

   198 we are trying to display. *CubicWeb* uses a selector mechanism which

   199 mechanism which computes for each available view a score:

   199 computes for each available view a score: the view with the highest

   200 the view with the highest score is then used to display the given `result set`.

   200 score is then used to display the given `result set`.  The standard

   201 The standard library of selectors is in

   201 library of selectors is in ``cubicweb.selector``.

   202 ``cubicweb.common.selector`` and a library of methods used to

   203 compute scores is available in ``cubicweb.vregistry.vreq``.

   207 to find the best way to render the data.

   205 to find the most appropriate way to render the data.

   208 

   206 

   209 For example, the view named ``primary`` is the one used to display

   207 For example, the view named ``primary`` is the one used to display a

   210 a single entity. We will now show you how to customize this view.

   208 single entity. We will now show you how to create a primary view for

   211 

   209 BlogEntry.

   212 

   210 

   213 View customization

   211 

   214 ~~~~~~~~~~~~~~~~~~

   212 Primary view customization

   215 

   213 ~~~~~~~~~~~~~~~~~~~~~~~~~~

   216 If you wish to modify the way a `BlogEntry` is rendered, you will have to

   214 

   217 overwrite the `primary` view defined in the module ``views`` of the cube

   215 If you wish to modify the way a `BlogEntry` is rendered, you will have

   218 ``cubes/blog/views.py``.

   216 to subclass the `primary` view, for instance in the module ``views``

   219 

   217 of the cube ``cubes/blog/views.py``.

   220 We can for example add in front of the publication date a prefix specifying

   218 

   221 that the date we see is the publication date.

   219 The standard primary view is the most sophisticated view of all. It

   220 has more than a call() method. It is a template. Actually the entry

   221 point calls the following sequence of (redefinable) methods:

   222 

   223  * render_entity_title

   224 

   225  * render_entity_metadata

   226 

   227  * render_entity_attributes

   228 

   229  * render_entity_relations

   230 

   231  * render_side_boxes

   232 

   233 Excepted side boxes, we can see all of them already in action in the

   234 blog entry view. This is all described in more details in

   235 :ref:`primary`.

   236 

   237 We can for example add in front of the publication date a prefix

   238 specifying that the date we see is the publication date.

   227   from cubicweb.web.views import baseviews

   244   from cubicweb.selectors import implements

   228 

   245   from cubicweb.web.views import primary

   229 

   246 

   230   class BlogEntryPrimaryView(baseviews.PrimaryView):

   247   class BlogEntryPrimaryView(primary.PrimaryView):

   231 

   248     __select__ = implements('BlogEntry')

   232     accepts = ('BlogEntry',)

   249 

   233 

   250       def render_entity_attributes(self, entity):

   234     def render_entity_title(self, entity):

   251           self.w(u'<p>published on %s</p>' %

   235         self.w(u'<h1>%s</h1>' % html_escape(entity.dc_title()))

   252                  entity.publish_date.strftime('%Y-%m-%d'))

   236 

   253           super(BlogEntryPrimaryView, self).render_entity_attributes(entity)

   237     def content_format(self, entity):

   238         return entity.view('reledit', rtype='content_format')

   239 

   240     def cell_call(self, row, col):

   241         entity = self.entity(row, col)

   242 

   243         # display entity attributes with prefixes

   244         self.w(u'<h1>%s</h1>' % entity.title)

   245         self.w(u'<p>published on %s</p>' % entity.publish_date.strftime('%Y-%m-%d'))

   246         self.w(u'<p>%s</p>' % entity.content)

   247 

   248         # display relations

   249         siderelations = []

   250         if self.main_related_section:

   251             self.render_entity_relations(entity, siderelations)