Metadata-Version: 2.4
Name: cubicweb-folder
Version: 3.1.0
Summary: folder component for the CubicWeb framework
Home-page: http://www.cubicweb.org/project/cubicweb-folder
Author: Logilab
Author-email: contact@logilab.fr
License: LGPL
Classifier: Environment :: Web Environment
Classifier: Framework :: CubicWeb
Classifier: Programming Language :: Python
Classifier: Programming Language :: JavaScript
Requires-Python: >=3.9.2
Requires-Dist: cubicweb<6.0.0,>=4.5.2
Requires-Dist: cubicweb-web<2.0.0,>=1.0.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

Summary
-------
The `folder` cube allows to create a tree of categories and classify entities
as you're used to do in a file-system.

Usage
-----

Define the relation `filed_under` in the schema, object must
contain all entities which can be classified in a folder.

.. sourcecode:: python

  class missing_filed_under(RelationDefinition):
      name = 'filed_under'
      subject = ('ExtProject', 'Project', 'Card', 'File')
      object = 'Folder'


The `FoldersBox` shows the folders hierarchy as a tree view. It's not visible by
default (user can activate it using their preferences) but you can activate it
by default using the code snippet below:

.. sourcecode:: python

    from cubicweb_folder.views import FoldersBox
    # make the folders box visible by default
    FoldersBox.visible = True
