doc/features_list.rst
brancholdstable
changeset 5422 0865e1e90674
parent 5136 d795cac8ad40
child 10235 684215aca046
equal deleted inserted replaced
4985:02b52bf9f5f8 5422:0865e1e90674
       
     1 =================
       
     2 CubicWeb features
       
     3 =================
       
     4 
       
     5 This page  tries to resume features found in the bare cubicweb framework,
       
     6 how mature and documented they are.
       
     7 
       
     8 :code maturity (CM):
       
     9 
       
    10   - 0: experimental, not ready at all for production, may be killed
       
    11 
       
    12   - 1: draft / unsatisfying, api may change in a near future, much probably in long
       
    13        term
       
    14 
       
    15   - 2: good enough, api sounds good but will probably evolve a bit with more
       
    16     hindsight
       
    17 
       
    18   - 3: mature, backward incompatible changes unexpected (may still evolve though,
       
    19     of course)
       
    20 
       
    21 
       
    22 :documentation level (DL):
       
    23 
       
    24   - 0: no documentation
       
    25 
       
    26   - 1: poor documentation
       
    27 
       
    28   - 2: some valuable documentation but some parts keep uncovered
       
    29 
       
    30   - 3: good / complete documentation
       
    31 
       
    32 
       
    33 Instance configuration and maintainance
       
    34 =======================================
       
    35 
       
    36 +====================================================================+====+====+
       
    37 |  FEATURE                                                           | CM | DL |
       
    38 +====================================================================+====+====+
       
    39 | setup - installation                                               | 2  | 3  |
       
    40 | setup - environment variables                                      | 3  | 2  |
       
    41 | setup - running modes                                              | 2  | 2  |
       
    42 | setup - administration tasks                                       | 2  | 2  |
       
    43 | setup - configuration file                                         | 2  | 1  |
       
    44 +--------------------------------------------------------------------+----+----+
       
    45 | configuration - user / groups handling                             | 3  | 1  |
       
    46 | configuration - site configuration                                 | 3  | 1  |
       
    47 | configuration - distributed configuration                          | 2  | 1  |
       
    48 | configuration - pyro                                               | 2  | 2  |
       
    49 +--------------------------------------------------------------------+----+----+
       
    50 | multi-sources - capabilities                                       | NA | 0  |
       
    51 | multi-sources - configuration                                      | 2  | 0  |
       
    52 | multi-sources - ldap integration                                   | 2  | 1  |
       
    53 +--------------------------------------------------------------------+----+----+
       
    54 | usage - custom ReST markup                                         | 2  | 0  |
       
    55 | usage - personal preferences                                       | 2  | 1  |
       
    56 +--------------------------------------------------------------------+----+----+
       
    57 
       
    58 
       
    59 Core development
       
    60 ================
       
    61 
       
    62 +====================================================================+====+====+
       
    63 |  FEATURE                                                           | CM | DL |
       
    64 +====================================================================+====+====+
       
    65 | base - concepts                                                    | NA | 3  |
       
    66 | base - security model                                              | NA | 2  |
       
    67 | base - database initialization                                     | 2  | 1  |
       
    68 +--------------------------------------------------------------------+----+----+
       
    69 | rql - base                                                         | 2  | 2  |
       
    70 | rql - write                                                        | 2  | 2  |
       
    71 | rql - function                                                     | 2  | 0  |
       
    72 | rql - outer joins                                                  | 2  | 1  |
       
    73 | rql - aggregates                                                   | 2  | 1  |
       
    74 | rql - subqueries                                                   | 2  | 0  |
       
    75 +--------------------------------------------------------------------+----+----+
       
    76 | schema - base                                                      | 2  | 3  |
       
    77 | schema - constraints                                               | 3  | 2  |
       
    78 | schema - security                                                  | 2  | 2  |
       
    79 | schema - inheritance                                               | 1  | 1  |
       
    80 | schema - customization                                             | 1  | 1  |
       
    81 | schema - introspection                                             | 2  | 1  |
       
    82 +--------------------------------------------------------------------+----+----+
       
    83 | vregistry - appobject                                              | 2  | 2  |
       
    84 | vregistry - registration                                           | 2  | 2  |
       
    85 | vregistry - selection                                              | 3  | 2  |
       
    86 | vregistry - core selectors                                         | 3  | 3  |
       
    87 | vregistry - custom selectors                                       | 2  | 1  |
       
    88 | vregistry - debugging selection                                    | 2  | 1  |
       
    89 +--------------------------------------------------------------------+----+----+
       
    90 | entities - interfaces                                              | 2  | ?  |
       
    91 | entities - customization (dc_,...)                                 | 2  | ?  |
       
    92 | entities - app logic                                               | 2  | 2  |
       
    93 | entities - orm configuration                                       | 2  | 1  |
       
    94 | entities - pluggable mixins                                        | 1  | 0  |
       
    95 | entities - workflow                                                | 3  | 2  |
       
    96 +--------------------------------------------------------------------+----+----+
       
    97 | dbapi - connection                                                 | 3  | 1  |
       
    98 | dbapi - data management                                            | 1  | 1  |
       
    99 | dbapi - result set                                                 | 3  | 1  |
       
   100 | dbapi - transaction, undo                                          | 2  | 0  |
       
   101 +--------------------------------------------------------------------+----+----+
       
   102 | cube - layout                                                      | 2  | 3  |
       
   103 | cube - new cube                                                    | 2  | 2  |
       
   104 +--------------------------------------------------------------------+----+----+
       
   105 | migration - context                                                | 2  | 1  |
       
   106 | migration - commands                                               | 2  | 2  |
       
   107 +--------------------------------------------------------------------+----+----+
       
   108 | testlib - CubicWebTC                                               | 2  | 1  |
       
   109 | testlib - automatic tests                                          | 2  | 2  |
       
   110 +--------------------------------------------------------------------+----+----+
       
   111 | i18n - mark string                                                 | 3  | 2  |
       
   112 | i18n - customize strings from other cubes / cubicweb               | 3  | 1  |
       
   113 | i18n - update catalog                                              | 3  | 2  |
       
   114 +--------------------------------------------------------------------+----+----+
       
   115 | more - reloading tips                                              | NA | 0  |
       
   116 | more - site_cubicweb                                               | 2  | ?  |
       
   117 | more - adding options in configuration file                        | 3  | 0  |
       
   118 | more - adding options in site configuration / preferences          | 3  | ?  |
       
   119 | more - optimizing / profiling                                      | 2  | 1  |
       
   120 | more - c-c plugins                                                 | 3  | 0  |
       
   121 | more - crypto services                                             | 0  | 0  |
       
   122 | more - massive import                                              | 2  | 0  |
       
   123 | more - mime type based conversion                                  | 2  | 0  |
       
   124 | more - CWCache                                                     | 1  | 0  |
       
   125 +--------------------------------------------------------------------+----+----+
       
   126 
       
   127 
       
   128 Web UI development
       
   129 ==================
       
   130 
       
   131 +====================================================================+====+====+
       
   132 |  FEATURE                                                           | CM | DL |
       
   133 +====================================================================+====+====+
       
   134 | base - web request                                                 | 2  | 2  |
       
   135 | base - exceptions                                                  | 2  | 0  |
       
   136 | base - session, authentication                                     | 1  | 0  |
       
   137 | base - http caching                                                | 2  | 1  |
       
   138 | base - external resources                                          | 2  | 2  |
       
   139 | base - static files                                                | 2  | ?  |
       
   140 | base - data sharing                                                | 2  | 2  |
       
   141 | base - graphical chart customization                               | 1  | 1  |
       
   142 +--------------------------------------------------------------------+----+----+
       
   143 | publishing - cycle                                                 | 2  | 2  |
       
   144 | publishing - error handling                                        | 2  | 1  |
       
   145 | publishing - transactions                                          | NA | ?  |
       
   146 +--------------------------------------------------------------------+----+----+
       
   147 | controller - base                                                  | 2  | 2  |
       
   148 | controller - view                                                  | 2  | 1  |
       
   149 | controller - edit                                                  | 2  | 1  |
       
   150 | controller - json                                                  | 2  | 1  |
       
   151 +--------------------------------------------------------------------+----+----+
       
   152 | views - base                                                       | 2  | 2  |
       
   153 | views - templates                                                  | 2  | 2  |
       
   154 | views - boxes                                                      | 2  | 1  |
       
   155 | views - components                                                 | 2  | 1  |
       
   156 | views - primary                                                    | 2  | 1  |
       
   157 | views - tabs                                                       | 2  | 1  |
       
   158 | views - xml                                                        | 2  | 0  |
       
   159 | views - text                                                       | 2  | 1  |
       
   160 | views - table                                                      | 2  | 1  |
       
   161 | views - plot                                                       | 2  | 0  |
       
   162 | views - navigation                                                 | 2  | 0  |
       
   163 | views - calendar, timeline                                         | 2  | 0  |
       
   164 | views - index                                                      | 2  | 2  |
       
   165 | views - breadcrumbs                                                | 2  | 1  |
       
   166 | views - actions                                                    | 2  | 1  |
       
   167 | views - debugging                                                  | 2  | 1  |
       
   168 +--------------------------------------------------------------------+----+----+
       
   169 | form - base                                                        | 2  | 1  |
       
   170 | form - fields                                                      | 2  | 1  |
       
   171 | form - widgets                                                     | 2  | 1  |
       
   172 | form - captcha                                                     | 2  | 0  |
       
   173 | form - renderers                                                   | 2  | 0  |
       
   174 | form - validation error handling                                   | 2  | 0  |
       
   175 | form - autoform                                                    | 2  | 2  |
       
   176 | form - reledit                                                     | 2  | 0  |
       
   177 +--------------------------------------------------------------------+----+----+
       
   178 | facets - base                                                      | 2  | ?  |
       
   179 | facets - configuration                                             | 2  | 1  |
       
   180 | facets - custom facets                                             | 2  | 0  |
       
   181 +--------------------------------------------------------------------+----+----+
       
   182 | css - base                                                         | 1  | 1  |
       
   183 | css - customization                                                | 1  | 1  |
       
   184 +--------------------------------------------------------------------+----+----+
       
   185 | js - base                                                          | 1  | 1  |
       
   186 | js - jquery                                                        | 1  | 1  |
       
   187 | js - base functions                                                | 1  | 0  |
       
   188 | js - ajax                                                          | 1  | 0  |
       
   189 | js - widgets                                                       | 1  | 1  |
       
   190 +--------------------------------------------------------------------+----+----+
       
   191 | other - page template                                              | 0  | 0  |
       
   192 | other - inline doc (wdoc)                                          | 2  | 0  |
       
   193 | other - magic search                                               | 2  | 0  |
       
   194 | other - url mapping                                                | 1  | 1  |
       
   195 | other - apache style url rewrite                                   | 1  | 1  |
       
   196 | other - sparql                                                     | 1  | 0  |
       
   197 | other - bookmarks                                                  | 2  | 1  |
       
   198 +--------------------------------------------------------------------+----+----+
       
   199 
       
   200 
       
   201 Repository development
       
   202 ======================
       
   203 
       
   204 +====================================================================+====+====+
       
   205 |  FEATURE                                                           | CM | DL |
       
   206 +====================================================================+====+====+
       
   207 | base - session                                                     | 2  | 2  |
       
   208 | base - more security control                                       | 2  | 0  |
       
   209 | base - debugging                                                   | 2  | 0  |
       
   210 +--------------------------------------------------------------------+----+----+
       
   211 | hooks - development                                                | 2  | 2  |
       
   212 | hooks - abstract hooks                                             | 2  | 0  |
       
   213 | hooks - core hooks                                                 | 2  | 0  |
       
   214 | hooks - control                                                    | 2  | 0  |
       
   215 | hooks - operation                                                  | 2  | 2  |
       
   216 +--------------------------------------------------------------------+----+----+
       
   217 | notification - sending email                                       | 2  | ?  |
       
   218 | notification - base views                                          | 1  | ?  |
       
   219 | notification - supervisions                                        | 1  | 0  |
       
   220 +--------------------------------------------------------------------+----+----+
       
   221 | source - storages                                                  | 2  | 0  |
       
   222 | source - authentication plugins                                    | 2  | 0  |
       
   223 | source - custom sources                                            | 2  | 0  |
       
   224 +--------------------------------------------------------------------+----+----+