cubicweb: comparison doc/tutorials/advanced/part05

equal deleted inserted replaced

-:83d7752af56a
+:99e150b6a876
 to customize it to write that ``img`` tag, as below:
 .. sourcecode:: python
 class HTMLPageHeader(basetemplates.HTMLPageHeader):
-	# override this since it's the easier way to have our bg image
+# override this since it's the easier way to have our bg image
-	# as the first element following <body>
+# as the first element following <body>
-	def call(self, **kwargs):
+def call(self, **kwargs):
 self.w(u'<img id="bg-image" src="%sbackground.jpg" alt="background image"/>'
 % self._cw.datadir_url)
-	    super(HTMLPageHeader, self).call(**kwargs)
+super(HTMLPageHeader, self).call(**kwargs)
 def registration_callback(vreg):
-	vreg.register_all(globals().values(), __name__, (HTMLPageHeader))
+vreg.register_all(globals().values(), __name__, (HTMLPageHeader))
-	vreg.register_and_replace(HTMLPageHeader, basetemplates.HTMLPageHeader)
+vreg.register_and_replace(HTMLPageHeader, basetemplates.HTMLPageHeader)
 As you may have guessed, my background image is in a :file:`background.jpg` file
 in the cube's :file:`data` directory, but there are still some things to explain
 to newcomers here:
 *
 * syt update: set z-index=0 on the img instead of z-index=1 on div#page & co to
 * avoid pb with the user actions menu
 */
 img#bg-image {
-	position: fixed;
+position: fixed;
-	top: 0;
+top: 0;
-	left: 0;
+left: 0;
-	width: 100%;
+width: 100%;
-	height: 100%;
+height: 100%;
-	z-index: 0;
+z-index: 0;
 }
 div#page, table#header, div#footer {
-	background: transparent;
+background: transparent;
-	position: relative;
+position: relative;
 }
 /* add some space around the logo
 */
 img#logo {
-	padding: 5px 15px 0px 15px;
+padding: 5px 15px 0px 15px;
 }
 /* more dark font for metadata to have a chance to see them with the background
 *  image
 */
 div.metadata {
-	color: black;
+color: black;
 }
 You can see here stuff explained in the cited page, with only a slight modification
 explained in the comments, plus some additional rules to make things somewhat cleaner:
 from cubicweb.predicates import none_rset
 from cubicweb.web.views import bookmark
 from cubes.zone import views as zone
 from cubes.tag import views as tag
 # change bookmarks box selector so it's only displayed on startup views
 bookmark.BookmarksBox.__select__ = bookmark.BookmarksBox.__select__ & none_rset()
 # move zone box to the left instead of in the context frame and tweak its order
 zone.ZoneBox.context = 'left'
 from logilab.common.decorators import monkeypatch
 from cubicweb import ValidationError
 from cubicweb.web.views import uicfg, component
 from cubicweb.web.views import basecontrollers
 # hide displayed_on relation using uicfg since it will be displayed by the box below
 uicfg.primaryview_section.tag_object_of(('*', 'displayed_on', '*'), 'hidden')
 class PersonBox(component.AjaxEditRelationCtxComponent):
-	__regid__ = 'sytweb.displayed-on-box'
+__regid__ = 'sytweb.displayed-on-box'
-	# box position
+# box position
-	order = 101
+order = 101
-	context = 'left'
+context = 'left'
-	# define relation to be handled
+# define relation to be handled
-	rtype = 'displayed_on'
+rtype = 'displayed_on'
-	role = 'object'
+role = 'object'
-	target_etype = 'Person'
+target_etype = 'Person'
-	# messages
+# messages
-	added_msg = _('person has been added')
+added_msg = _('person has been added')
-	removed_msg = _('person has been removed')
+removed_msg = _('person has been removed')
-	# bind to js_* methods of the json controller
+# bind to js_* methods of the json controller
-	fname_vocabulary = 'unrelated_persons'
+fname_vocabulary = 'unrelated_persons'
-	fname_validate = 'link_to_person'
+fname_validate = 'link_to_person'
-	fname_remove = 'unlink_person'
+fname_remove = 'unlink_person'
 @monkeypatch(basecontrollers.JSonController)
 @basecontrollers.jsonize
 def js_unrelated_persons(self, eid):
-	"""return tag unrelated to an entity"""
+"""return tag unrelated to an entity"""
-	rql = "Any F + ' ' + S WHERE P surname S, P firstname F, X eid %(x)s, NOT P displayed_on X"
+rql = "Any F + ' ' + S WHERE P surname S, P firstname F, X eid %(x)s, NOT P displayed_on X"
-	return [name for (name,) in self._cw.execute(rql, {'x' : eid})]
+return [name for (name,) in self._cw.execute(rql, {'x' : eid})]
 @monkeypatch(basecontrollers.JSonController)
 def js_link_to_person(self, eid, people):
-	req = self._cw
+req = self._cw
-	for name in people:
+for name in people:
-	    name = name.strip().title()
+name = name.strip().title()
-	    if not name:
+if not name:
-		continue
+continue
-	    try:
+try:
-		firstname, surname = name.split(None, 1)
+firstname, surname = name.split(None, 1)
-	    except:
+except:
-		raise ValidationError(eid, {('displayed_on', 'object'): 'provide <first name> <surname>'})
+raise ValidationError(eid, {('displayed_on', 'object'): 'provide <first name> <surname>'})
-	    rset = req.execute('Person P WHERE '
+rset = req.execute('Person P WHERE '
-			       'P firstname %(firstname)s, P surname %(surname)s',
+'P firstname %(firstname)s, P surname %(surname)s',
-			       locals())
+locals())
-	    if rset:
+if rset:
-		person = rset.get_entity(0, 0)
+person = rset.get_entity(0, 0)
-	    else:
+else:
-		person = req.create_entity('Person', firstname=firstname,
+person = req.create_entity('Person', firstname=firstname,
-						surname=surname)
+surname=surname)
-	    req.execute('SET P displayed_on X WHERE '
+req.execute('SET P displayed_on X WHERE '
-			'P eid %(p)s, X eid %(x)s, NOT P displayed_on X',
+'P eid %(p)s, X eid %(x)s, NOT P displayed_on X',
-			{'p': person.eid, 'x' : eid})
+{'p': person.eid, 'x' : eid})
 @monkeypatch(basecontrollers.JSonController)
 def js_unlink_person(self, eid, personeid):
-	self._cw.execute('DELETE P displayed_on X WHERE P eid %(p)s, X eid %(x)s',
+self._cw.execute('DELETE P displayed_on X WHERE P eid %(p)s, X eid %(x)s',
-			 {'p': personeid, 'x': eid})
+{'p': personeid, 'x': eid})
 You basically subclass to configure with some class attributes. The `fname_*`
 attributes give the name of methods that should be defined on the json control to
 make the AJAX part of the widget work: one to get the vocabulary, one to add a
 .. sourcecode:: python
 from cubicweb.web import facet
 class DisplayedOnFacet(facet.RelationFacet):
-	__regid__ = 'displayed_on-facet'
+__regid__ = 'displayed_on-facet'
-	# relation to be displayed
+# relation to be displayed
-	rtype = 'displayed_on'
+rtype = 'displayed_on'
-	role = 'object'
+role = 'object'
-	# view to use to display persons
+# view to use to display persons
-	label_vid = 'combobox'
+label_vid = 'combobox'
 Let's say we also want to filter according to the `visibility` attribute. This is
 even simpler as we just have to derive from the :class:`AttributeFacet` class:
 .. sourcecode:: python
 class VisibilityFacet(facet.AttributeFacet):
-	__regid__ = 'visibility-facet'
+__regid__ = 'visibility-facet'
-	rtype = 'visibility'
+rtype = 'visibility'
 Now if I search for some pictures on my site, I get the following facets available:
 .. image:: ../../images/tutos-photowebsite_facets.png

changeset 12405	99e150b6a876
parent 10491	c67bcee93248
child 12407	d4e0af0b5ad7