doc/book/en/devrepo/cubes/available-cubes.rst
branchstable
changeset 5394 105011657405
parent 2477 7baebaf44fc2
child 5608 f9ab62103ad4
equal deleted inserted replaced
5393:875bdc0fe8ce 5394:105011657405
       
     1 
       
     2 Available cubes
       
     3 ---------------
       
     4 
       
     5 An instance is based on several basic cubes. In the set of available
       
     6 basic cubes we can find for example :
       
     7 
       
     8 Base entity types
       
     9 ~~~~~~~~~~~~~~~~~
       
    10 * addressbook_: PhoneNumber and PostalAddress
       
    11 * card_: Card, generic documenting card
       
    12 * event_: Event (define events, display them in calendars)
       
    13 * file_: File (to allow users to upload and store binary or text files)
       
    14 * link_: Link (to collect links to web resources)
       
    15 * mailinglist_: MailingList (to reference a mailing-list and the URLs
       
    16   for its archives and its admin interface)
       
    17 * person_: Person (easily mixed with addressbook)
       
    18 * task_: Task (something to be done between start and stop date)
       
    19 * zone_: Zone (to define places within larger places, for example a
       
    20   city in a state in a country)
       
    21 
       
    22 
       
    23 Classification
       
    24 ~~~~~~~~~~~~~~
       
    25 * folder_: Folder (to organize things but grouping them in folders)
       
    26 * keyword_: Keyword (to define classification schemes)
       
    27 * tag_: Tag (to tag anything)
       
    28 
       
    29 Other features
       
    30 ~~~~~~~~~~~~~~
       
    31 * basket_: Basket (like a shopping cart)
       
    32 * blog_: a blogging system uxing Blog and BlogEntry entity types
       
    33 * comment_: system to attach comment threads to entities)
       
    34 * email_: archiving management for emails (`Email`, `Emailpart`,
       
    35   `Emailthread`), trigger action in cubicweb through email
       
    36 
       
    37 
       
    38 
       
    39 
       
    40 
       
    41 .. _addressbook: http://www.cubicweb.org/project/cubicweb-addressbook
       
    42 .. _basket: http://www.cubicweb.org/project/cubicweb-basket
       
    43 .. _card: http://www.cubicweb.org/project/cubicweb-card
       
    44 .. _blog: http://www.cubicweb.org/project/cubicweb-blog
       
    45 .. _comment: http://www.cubicweb.org/project/cubicweb-comment
       
    46 .. _email: http://www.cubicweb.org/project/cubicweb-email
       
    47 .. _event: http://www.cubicweb.org/project/cubicweb-event
       
    48 .. _file: http://www.cubicweb.org/project/cubicweb-file
       
    49 .. _folder: http://www.cubicweb.org/project/cubicweb-folder
       
    50 .. _keyword: http://www.cubicweb.org/project/cubicweb-keyword
       
    51 .. _link: http://www.cubicweb.org/project/cubicweb-link
       
    52 .. _mailinglist: http://www.cubicweb.org/project/cubicweb-mailinglist
       
    53 .. _person: http://www.cubicweb.org/project/cubicweb-person
       
    54 .. _tag: http://www.cubicweb.org/project/cubicweb-tag
       
    55 .. _task: http://www.cubicweb.org/project/cubicweb-task
       
    56 .. _zone: http://www.cubicweb.org/project/cubicweb-zone
       
    57 
       
    58 To declare the use of a component, once installed, add the name of the component
       
    59 to the variable `__use__` in the file `__pkginfo__.py` of your own component.
       
    60 
       
    61 .. note::
       
    62   The listed cubes above are available as debian-packages on `CubicWeb's forge`_.
       
    63 
       
    64 .. _`CubicWeb's forge`: http://www.cubicweb.org/project?vtitle=All%20cubicweb%20projects