Skip to content
Snippets Groups Projects
Commit 498dfd89eb34 authored by Sylvain Thénault's avatar Sylvain Thénault
Browse files

(much) more cube description

parent 284b84620da5
No related branches found
No related tags found
No related merge requests found
......@@ -8,7 +8,7 @@
version = '.'.join(str(num) for num in numversion)
license = 'LGPL'
copyright = '''Copyright (c) 2003-2009 LOGILAB S.A. (Paris, FRANCE).
copyright = '''Copyright (c) 2003-2010 LOGILAB S.A. (Paris, FRANCE).
http://www.logilab.fr/ -- mailto:contact@logilab.fr'''
author = "Logilab"
......@@ -16,5 +16,25 @@
web = 'http://www.cubicweb.org/project/%s' % distname
short_desc = "blog component for the CubicWeb framework"
long_desc = """This CubicWeb component provides blogging functionnalities.
long_desc = """\
Summary
-------
The `blog` cube provides blogging functionnalities. It creates two entity types,
`Blog` and `BlogEntry`. There are related to each other by the relation
`BlogEntry entry_of Blog`.
Usage
-----
When a user submits a blog entry, it goes in a `draft` state until the blog
entry is published by an application managers. The blog entry will not be
visible until it reaches the `published` state.
When a blog entry is submitted, an email notification is automatically sent
to all the users belonging to the `managers` group of the application.
Specific boxes provided by this cube:
- `BlogEntryArchiveBox`, displays a box with the total number of blog entries
submitted by month for the last twelve months.
......@@ -20,5 +40,25 @@
CubicWeb is a semantic web application framework, see http://www.cubicweb.org
- `BlogEntryListBox`, displays a box with the latest five blog entries
published in your application as well as link to subscribe to a RSS feed.
- `BlogEntrySummary`, displays a box with the list of users who submitted
blog entries and the total number of blog entries they submitted.
This cube also provides some web services such as:
- http://xx:xxxx/blogentries/YYYY to retrieve the blog entries submitted
during the year YYYY through a RSS feed
- http://xx:xxxx/blogentries/YYYY/MM to retrieve the blog entries submitted
during the month MM of the year YYYY through a RSS feed
- http://xx:xxxx/blog/[eid]/blogentries/YYYY to retrieve the blog entries
submitted in the blog of identifier [eid], during the year YYYY through
a RSS feed
- http://xx:xxxx/blog/[eid]/blogentries/YYYY/MM to retrieve the blog entries
submitted in the blog of identifier [eid], during the month MM of the
year YYYY through a RSS feed
"""
classifiers = [
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment