doc/book/en/annexes/faq.rst
author sylvain.thenault@logilab.fr
Thu, 07 May 2009 16:42:34 +0200
branchtls-sprint
changeset 1715 cba9f175da2d
parent 1599 doc/book/en/D010-faq.en.txt@38a1d0f190e2
parent 1714 doc/book/en/D010-faq.en.txt@a721966779be
child 1808 aa09e20dd8c0
permissions -rw-r--r--
merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     2
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
     3
Frequently Asked Questions
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
     4
==========================
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
     5
310
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
     6
[XXX 'copy answer from forum' means reusing text from
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
     7
http://groups.google.com/group/google-appengine/browse_frm/thread/c9476925f5f66ec6
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
     8
and
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
     9
http://groups.google.com/group/google-appengine/browse_frm/thread/d791ce17e2716147/eb078f8cfe8426e0
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
    10
and
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
    11
http://groups.google.com/group/google-appengine/browse_frm/thread/f48cf6099973aef5/c28cd6934dd72457
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
    12
]
cdd2b1247c50 [doc] add links to google-appengine forum
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 306
diff changeset
    13
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    14
Why does not CubicWeb have a template language ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    15
------------------------------------------------
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    16
344
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    17
  There are enough template languages out there. You can use your
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    18
  preferred template language if you want. [explain how to use a
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    19
  template language]
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    20
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    21
  `CubicWeb` does not define its own templating language as this was
344
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    22
  not our goal. Based on our experience, we realized that
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    23
  we could gain productivity by letting designers use design tools
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    24
  and developpers develop without the use of the templating language
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    25
  as an intermediary that could not be anyway efficient for both parties.
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    26
  Python is the templating language that we use in `CubicWeb`, but again,
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    27
  it does not prevent you from using a templating language.
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    28
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    29
  The reason template languages are not used in this book is that
344
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    30
  experience has proved us that using pure python was less cumbersome.
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    31
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    32
Why do you think using pure python is better than using a template language ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    33
-----------------------------------------------------------------------------
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    34
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    35
  Python is an Object Oriented Programming language and as such it
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    36
  already provides a consistent and strong architecture and syntax
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    37
  a templating language would not reach.
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    38
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    39
  When doing development, you need a real language and template
344
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    40
  languages are not real languages.
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    41
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    42
  Using Python enables developing applications for which code is
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    43
  easier to maintain with real functions/classes/contexts
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    44
  without the need of learning a new dialect. By using Python,
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    45
  we use standard OOP techniques and this is a key factor in a
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    46
  robust application.
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    47
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    48
Why do you use the GPL license to prevent me from doing X ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    49
-----------------------------------------------------------
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    50
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    51
  GPL means that *if* you redistribute your application, you need to
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    52
  redistribute it *and* the changes you made *and* the code _linked_
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    53
  to it under the GPL licence.
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    54
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    55
  Publishing a web site has nothing to do with redistributing
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    56
  source code. A fair amount of companies use modified GPL code
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    57
  for internal use. And someone could publish a `CubicWeb` component
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    58
  under a BSD licence for others to plug into a GPL framework without
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    59
  any problem. The only thing we are trying to prevent here is someone
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    60
  taking the framework and packaging it as closed source to his own
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    61
  clients.
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    62
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    63
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    64
CubicWeb looks pretty recent. Is it stable ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    65
--------------------------------------------
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    66
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    67
  It is constantly evolving, piece by piece.  The framework has
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    68
  evolved over the past seven years and data has been migrated from
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    69
  one schema to the other ever since. There is a well-defined way to
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
    70
  handle data and schema migration.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    71
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    72
Why is the RQL query language looking similar to X ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    73
-----------------------------------------------------
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    74
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    75
  It may remind you of SQL but it is higher level than SQL, more like
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    76
  SPARQL. Except that SPARQL did not exist when we started the project.
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    77
  Having SPARQL has a query language has been in our backlog for years.
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    78
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    79
  That RQL language is what is going to make a difference with django-
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    80
  like frameworks for several reasons.
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    81
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    82
  1. accessing data is *much* easier with it. One can write complex
344
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    83
     queries with RQL that would be tedious to define and hard to maintain
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    84
     using an object/filter suite of method calls.
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    85
344
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    86
  2. it offers an abstraction layer allowing your applications to run
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    87
     on multiple back-ends. That means not only various SQL backends
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    88
     (postgresql, sqlite, mysql), but also multiple databases at the
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    89
     same time, and also non-SQL data stores like LDAP directories and
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    90
     subversion/mercurial repositories (see the `vcsfile`
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    91
     component). Google App Engine is yet another supported target for
e0d5879a613e tweak the faq a bit
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 337
diff changeset
    92
     RQL.
337
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    93
eb329d0db467 [doc] FAQ improvements based on posts in forums.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 335
diff changeset
    94
[copy answer from forum, explain why similar to sparql and why better
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    95
  than django and SQL]
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
    96
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    97
which ajax library
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
    98
------------------
317
cf1c6178b322 we've been using jquery for a while now
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 310
diff changeset
    99
  [we use jquery and things on top of that]
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   100
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   101
`Error while publishing rest text ...`
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   102
--------------------------------------
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   103
  While modifying the description of an entity, you get an error message in
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   104
  the application `Error while publishing ...` for Rest text and plain text.
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   105
  The server returns a traceback like as follows ::
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   106
1191
216141cf47a3 remove all erudi and ginco occurences in the doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 383
diff changeset
   107
      2008-10-06 15:05:08 - (cubicweb.rest) ERROR: error while publishing ReST text
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   108
      Traceback (most recent call last):
1191
216141cf47a3 remove all erudi and ginco occurences in the doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 383
diff changeset
   109
      File "/home/user/src/blogdemo/cubicweb/common/rest.py", line 217, in rest_publish
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   110
      File "/usr/lib/python2.5/codecs.py", line 817, in open
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   111
      file = __builtin__.open(filename, mode, buffering)
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   112
      TypeError: __init__() takes at most 3 arguments (4 given)
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   113
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   114
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   115
  This can be fixed by applying the patch described in :
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   116
  http://code.google.com/p/googleappengine/issues/detail?id=48
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   117
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   118
What are hooks used for?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   119
------------------------
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   120
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   121
  Hooks are executed around (actually before or after) events.  The
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   122
  most common events are data creation, update and deletion.  They
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   123
  permit additional constraint checking (those not expressible at the
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   124
  schema level), pre and post computations depending on data
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   125
  movements.
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   126
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   127
  As such, they are a vital part of the framework.
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   128
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   129
  Other kinds of hooks, called Operations, are available
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   130
  for execution just before commit.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   131
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   132
When should you define an HTML template rather than define a graphical component?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   133
---------------------------------------------------------------------------------
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   134
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   135
  An HTML template cannot contain code, hence it is only about static
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   136
  content.  A component is made of code and operations that apply on a
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   137
  well defined context (request, result set). It enables much more
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   138
  dynamic views.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   139
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   140
What is the difference between `AppRsetObject` and `AppObject` ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   141
----------------------------------------------------------------
199
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   142
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   143
  `AppRsetObject` instances are selected on a request and a result
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   144
  set. `AppObject` instances are directly selected by id.
199
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   145
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   146
How to update a database after a schema modification?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   147
-----------------------------------------------------
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   148
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   149
  It depends on what has been modified in the schema.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   150
1350
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   151
  * Update of an attribute permissions and properties: 
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   152
    ``synchronize_eschema('MyEntity')``.
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   153
1350
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   154
  * Update of a relation permissions and properties: 
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   155
    ``synchronize_rschema('MyRelation')``.
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   156
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   157
  * Add an attribute: ``add_attribute('MyEntityType', 'myattr')``.
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   158
31e4c8d30e5d [doc] Adds how to add attribute in DB.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1348
diff changeset
   159
  * Add a relation: ``add_relation_definition('SubjRelation', 'MyRelation', 'ObjRelation')``.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   160
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   161
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   162
How to create an anonymous user?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   163
--------------------------------
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   164
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   165
  This allows to bypass authentication for your site. In the
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   166
  ``all-in-one.conf`` file of your instance, define the anonymous user
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   167
  as follows ::
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   168
1191
216141cf47a3 remove all erudi and ginco occurences in the doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 383
diff changeset
   169
    # login of the CubicWeb user account to use for anonymous user (if you want to
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   170
    # allow anonymous)
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   171
    anonymous-user=anon
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   172
1191
216141cf47a3 remove all erudi and ginco occurences in the doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 383
diff changeset
   173
    # password of the CubicWeb user account matching login
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   174
    anonymous-password=anon
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   175
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   176
  You also must ensure that this `anon` user is a registered user of
1348
28bb9efe0cc8 [doc] Add information on anonymous user configuration.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1191
diff changeset
   177
  the DB backend. If not, you can create through the administation
28bb9efe0cc8 [doc] Add information on anonymous user configuration.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1191
diff changeset
   178
  interface of your instance by adding a user with the role `guests`.
28bb9efe0cc8 [doc] Add information on anonymous user configuration.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1191
diff changeset
   179
  This could be the admin account (for development
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   180
  purposes, of course).
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   181
1348
28bb9efe0cc8 [doc] Add information on anonymous user configuration.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1191
diff changeset
   182
.. note::
28bb9efe0cc8 [doc] Add information on anonymous user configuration.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1191
diff changeset
   183
    While creating a new instance, you can decide to allow access
1378
3645800647ef [doc] Fix typo.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1354
diff changeset
   184
    to anonymous user, which will automatically execute what is
1348
28bb9efe0cc8 [doc] Add information on anonymous user configuration.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1191
diff changeset
   185
    decribed above.
28bb9efe0cc8 [doc] Add information on anonymous user configuration.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1191
diff changeset
   186
199
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   187
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   188
How to change the application logo?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   189
-----------------------------------
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   190
199
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   191
  There are two ways of changing the logo.
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   192
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   193
  1. The easiest way to use a different logo is to replace the existing
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   194
     ``logo.png`` in ``myapp/data`` by your prefered icon and refresh.
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   195
     By default all application will look for a ``logo.png`` to be
199
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   196
     rendered in the logo section.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   197
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents: 1440
diff changeset
   198
     .. image:: ../images/lax-book.06-main-template-logo.en.png
116
e2303f9b5bfa [doc] more merging and reorg
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 113
diff changeset
   199
199
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   200
  2. In your cube directory, you can specify which file to use for the logo.
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   201
     This is configurable in ``mycube/data/external_resources``: ::
345
31f88b2e3500 more translation and complements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 344
diff changeset
   202
199
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   203
       LOGO = DATADIR/path/to/mylogo.gif
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   204
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   205
     where DATADIR is ``mycubes/data``.
c603087373cd [doc] Inserted content from LAX book about templates.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   206
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   207
How to configure LDAP source?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   208
-------------------------------
335
643db91242b1 [doc] Integration of card http://intranet.logilab.fr/intra/card/eid/3355 to the book.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 317
diff changeset
   209
358
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   210
  Your instance's sources are defined in ``/etc/cubicweb.d/myapp/sources``.
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   211
  Configuring an LDAP source is about declaring that source in your
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   212
  instance configuration file such as: ::
335
643db91242b1 [doc] Integration of card http://intranet.logilab.fr/intra/card/eid/3355 to the book.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 317
diff changeset
   213
358
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   214
    [ldapuser]
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   215
    adapter=ldapuser
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   216
    # ldap host
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   217
    host=myhost
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   218
    # base DN to lookup for usres
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   219
    user-base-dn=ou=People,dc=mydomain,dc=fr
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   220
    # user search scope
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   221
    user-scope=ONELEVEL
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   222
    # classes of user
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   223
    user-classes=top,posixAccount
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   224
    # attribute used as login on authentication
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   225
    user-login-attr=uid
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   226
    # name of a group in which ldap users will be by default
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   227
    user-default-group=users
1191
216141cf47a3 remove all erudi and ginco occurences in the doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 383
diff changeset
   228
    # map from ldap user attributes to cubicweb attributes
358
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   229
    user-attrs-map=gecos:email,uid:login
335
643db91242b1 [doc] Integration of card http://intranet.logilab.fr/intra/card/eid/3355 to the book.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 317
diff changeset
   230
358
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   231
  Any change applied to configuration file requires to restart your
e7347a1e3659 [doc] Added a cook book as advised and moved ldap import scripts in the cook book. Started a howto about configuring LDAP but it will have to be reviewed by experts.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 345
diff changeset
   232
  application.
383
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   233
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   234
I get NoSelectableObject exceptions: how do I debug selectors ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   235
---------------------------------------------------------------
383
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   236
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   237
  You just need to put the appropriate context manager around view/component
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   238
  selection: ::
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   239
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   240
    from cubicweb.common.selectors import traced_selection
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   241
    with traced_selection():
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   242
        comp = self.vreg.select_object('contentnavigation', 'wfhistory',
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   243
                                       self.req, rset, context='navcontentbottom')
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   244
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   245
  This will yield additional WARNINGs, like this: ::
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   246
66804d97b919 [FAQ] debugging selectors : a new faq entry
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 358
diff changeset
   247
    2009-01-09 16:43:52 - (cubicweb.selectors) WARNING: selector one_line_rset returned 0 for <class 'cubicweb.web.views.basecomponents.WFHistoryVComponent'>
1354
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   248
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   249
How to format an entity date attribute?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   250
---------------------------------------
1354
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   251
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   252
  If your schema has an attribute of type Date or Datetime, you might
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   253
  want to format it. First, you should define your preferred format using
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   254
  the site configuration panel ``http://appurl/view?vid=systemepropertiesform``
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   255
  and then set ``ui.date`` and/or ``ui.datetime``.
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   256
  Then in the view code, use::
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   257
    
e71f704aaf40 [doc] Adds HowTo format date.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1350
diff changeset
   258
    self.format_date(entity.date_attribute)
1599
38a1d0f190e2 [doc] add FAQ about kerberos auth with postgresql
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1440
diff changeset
   259
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   260
Can PostgreSQL and CubicWeb authentication work with kerberos ?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   261
----------------------------------------------------------------
1599
38a1d0f190e2 [doc] add FAQ about kerberos auth with postgresql
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1440
diff changeset
   262
38a1d0f190e2 [doc] add FAQ about kerberos auth with postgresql
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1440
diff changeset
   263
  If you have postgresql set up to accept kerberos authentication, you can set
38a1d0f190e2 [doc] add FAQ about kerberos auth with postgresql
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1440
diff changeset
   264
  the db-host, db-name and db-user parameters in the `sources` configuration
38a1d0f190e2 [doc] add FAQ about kerberos auth with postgresql
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1440
diff changeset
   265
  file while leaving the password blank. It should be enough for your instance
38a1d0f190e2 [doc] add FAQ about kerberos auth with postgresql
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1440
diff changeset
   266
  to connect to postgresql with a kerberos ticket.
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   267
1599
38a1d0f190e2 [doc] add FAQ about kerberos auth with postgresql
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1440
diff changeset
   268
  
1715
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   269
How to load data from a script?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   270
-------------------------------
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   271
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   272
  The following script aims at loading data within a script assuming pyro-nsd is
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   273
  running and your application is configured with ``pyro-server=yes``, otherwise
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   274
  you would not be able to use dbapi. ::
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   275
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   276
    from cubicweb import dbapi
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   277
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   278
    cnx = dbapi.connection(database='instance-id', user='admin', password='admin')
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   279
    cur = cnx.cursor()
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   280
    for name in ('Personal', 'Professional', 'Computers'):
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   281
        cur.execute('INSERT Blog B: B name %s', name)
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   282
    cnx.commit()
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   283
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   284
What is the CubicWeb datatype corresponding to GAE datastore's UserProperty?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   285
----------------------------------------------------------------------------
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   286
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   287
  If you take a look at your application schema and
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   288
  click on "display detailed view of metadata" you will see that there
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   289
  is a Euser entity in there. That's the one that is modeling users. The
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   290
  thing that corresponds to a UserProperty is a relationship between
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   291
  your entity and the Euser entity. As in ::
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   292
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   293
    class TodoItem(EntityType):
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   294
       text = String()
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   295
       todo_by = SubjectRelation('Euser')
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   296
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   297
  [XXX check that cw handle users better by
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   298
  mapping Google Accounts to local Euser entities automatically]
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   299
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   300
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   301
How to implement security?
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   302
--------------------------
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   303
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   304
  This is an example of how it works in our framework::
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   305
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   306
    class Version(EntityType):
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   307
    """a version is defining the content of a particular project's
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   308
    release"""
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   309
    # definition of attributes is voluntarily missing
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   310
    permissions = {'read': ('managers', 'users', 'guests',),
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   311
                   'update': ('managers', 'logilab', 'owners',),
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   312
                   'delete': ('managers', ),
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   313
                   'add': ('managers', 'logilab',
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   314
                        ERQLExpression('X version_of PROJ, U in_group G, PROJ
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   315
                        require_permission P, P name "add_version", P require_group G'),)}
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   316
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   317
  The above means that permission to read a Version is granted to any
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   318
  user that is part of one of the groups 'managers', 'users', 'guests'.
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   319
  The 'add' permission is granted to users in group 'managers' or
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   320
  'logilab' and to users in group G, if G is linked by a permission
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   321
  entity named "add_version" to the version's project.
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   322
  ::
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   323
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   324
    class version_of(RelationType):
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   325
        """link a version to its project. A version is necessarily linked
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   326
        to one and only one project. """
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   327
        # some lines voluntarily missing
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   328
        permissions = {'read': ('managers', 'users', 'guests',),
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   329
                       'delete': ('managers', ),
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   330
                       'add': ('managers', 'logilab',
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   331
                            RRQLExpression('O require_permission P, P name "add_version",
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   332
                            'U in_group G, P require_group G'),) }
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   333
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   334
  You can find additional information in the section :ref:`security`.
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   335
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   336
  [XXX what does the second example means in addition to the first one?]
sylvain.thenault@logilab.fr
parents: 1599 1714
diff changeset
   337