doc/3.14.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 07 Oct 2011 11:59:20 +0200
changeset 7920 5146c63e8e34
parent 7878 dcdccb495e78
child 7992 4ff9f25cb06e
permissions -rw-r--r--
backport stable
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7878
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
     1
Whats new in CubicWeb 3.14
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
     2
==========================
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
     3
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
     4
API changes
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
     5
-----------
7827
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
     6
7859
15809afe093b [migration doc] talk about changes in Entity.fetch_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7828
diff changeset
     7
* `Entity.fetch_rql` `restriction` argument has been deprecated and should be
15809afe093b [migration doc] talk about changes in Entity.fetch_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7828
diff changeset
     8
  replaced with a call to the new `Entity.fetch_rqlst` method, get the returned
15809afe093b [migration doc] talk about changes in Entity.fetch_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7828
diff changeset
     9
  value (a rql `Select` node) and use the RQL syntax tree API to include the
15809afe093b [migration doc] talk about changes in Entity.fetch_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7828
diff changeset
    10
  above-mentionned restrictions.
15809afe093b [migration doc] talk about changes in Entity.fetch_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7828
diff changeset
    11
15809afe093b [migration doc] talk about changes in Entity.fetch_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7828
diff changeset
    12
  Backward compat is kept with proper warning.
15809afe093b [migration doc] talk about changes in Entity.fetch_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7828
diff changeset
    13
7827
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    14
* `Entity.fetch_order` and `Entity.fetch_unrelated_order` class methods have been
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    15
  replaced by `Entity.cw_fetch_order` and `Entity.cw_fetch_unrelated_order` with
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    16
  a different prototype:
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    17
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    18
  - instead of taking (attr, var) as two string argument, they now take (select,
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    19
    attr, var) where select is the rql syntax tree beinx constructed and var the
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    20
    variable *node*.
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    21
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    22
  - instead of returning some string to be inserted in the ORDERBY clause, it has
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    23
    to modify the syntax tree
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    24
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    25
  Backward compat is kept with proper warning, BESIDE cases below:
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    26
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    27
  - custom order method return **something else the a variable name with or
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    28
    without the sorting order** (e.g. cases where you sort on the value of a
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    29
    registered procedure as it was done in the tracker for instance). In such
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    30
    case, an error is logged telling that this sorting is ignored until API
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    31
    upgrade.
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    32
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    33
  - client code use direct access to one of those methods on an entity (no code
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    34
    known to do that)
9bbf83f68bcc [entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    35
7828
749e1a67987f [entity] rename Entity._rest_attr_info into cw_rest_attr_info (closes #1942759)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7827
diff changeset
    36
* `Entity._rest_attr_info` class method has been renamed to
749e1a67987f [entity] rename Entity._rest_attr_info into cw_rest_attr_info (closes #1942759)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7827
diff changeset
    37
  `Entity.cw_rest_attr_info`
749e1a67987f [entity] rename Entity._rest_attr_info into cw_rest_attr_info (closes #1942759)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7827
diff changeset
    38
749e1a67987f [entity] rename Entity._rest_attr_info into cw_rest_attr_info (closes #1942759)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7827
diff changeset
    39
  No backward compat yet since this is a protected method an no code is known to
749e1a67987f [entity] rename Entity._rest_attr_info into cw_rest_attr_info (closes #1942759)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7827
diff changeset
    40
  use it outside cubicweb itself.
749e1a67987f [entity] rename Entity._rest_attr_info into cw_rest_attr_info (closes #1942759)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7827
diff changeset
    41
7875
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    42
* `AnyEntity.linked_to` has been removed as part of a refactoring of this
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    43
  functionality (link a entity to another one at creation step). It was replaced
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    44
  by a `EntityFieldsForm.linked_to` property.
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    45
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    46
  In the same refactoring, `cubicweb.web.formfield.relvoc_linkedto`,
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    47
  `cubicweb.web.formfield.relvoc_init` and
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    48
  `cubicweb.web.formfield.relvoc_unrelated` were removed and replaced by
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    49
  RelationField methods with the same names, that take a form as a parameter.
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    50
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    51
  **No backward compatibility yet**. It's still time to cry for it.
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    52
  Cubes known to be affected: tracker, vcsfile, vcreview
65e460690139 [form, entity] refactor '__linkto', now handled by the entity form, not the entity itself. Closes #1931543
Florent Cayré <florent.cayre@gmail.com>
parents: 7859
diff changeset
    53
7878
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    54
* `CWPermission` entity type and its associated require_permission relation type
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    55
  (abstract) and require_group relation definitions have been moved to a new
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    56
  `localperms` cube. With this have gone some functions from the
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    57
  `cubicweb.schemas` package as well as some views. This makes cubicweb itself
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    58
  smaller while you get all the local permissions stuff into a single,
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    59
  documented, place.
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    60
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    61
  Backward compat is kept for existing instances, **though you should have
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    62
  installed the localperms cubes**. A proper error should be displayed when
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    63
  trying to migrate to 3.14 an instance the use `CWPermission` without the new
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    64
  cube installed. For new instances / test, you should add a dependancy on the
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    65
  new cube in cubes using this feature, along with a dependancy on cubicweb >=
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    66
  3.14.
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    67
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    68
* jQuery has been updated to 1.6.4. No backward compat issue known (yet...)
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    69
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    70
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    71
Unintrusive API changes
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    72
-----------------------
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    73
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    74
* refactored properties forms (eg user preferences and site wide properties) to
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    75
  ease overridding
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    76
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    77
* table view allows to set None in 'headers', meaning the label should be fetched
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    78
  from the result set as done by default
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    79
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    80
* new `anonymized_request` decorator to temporary run stuff as an anonymous
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    81
  user, whatever the currently logged in user
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    82
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    83
* new 'verbatimattr' attribute view
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    84
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    85
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    86
User interface changes
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    87
----------------------
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    88
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    89
* breadcrumb is properly kept when creating an entity with __linkto
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    90
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    91
* users and groups management now really lead to that (i.e. includes *groups*
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    92
  management)
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    93
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    94
* new 'jsonp' controller with 'jsonexport' and 'ejsonexport' views
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    95
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    96
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    97
Configuration
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    98
------------
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
    99
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
   100
* add option 'resources-concat' to make javascript/css files concatenation
dcdccb495e78 [doc] more doc about what's new in 3.14
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7875
diff changeset
   101
  optional