[ZDP] ZDP-Tools Plans

[Tom Deprez]

Hi Maik,

Already back again? Great!
How is school?

> * Topics and Subjects in Meta-Tags
>
> Add the topics in the HTML Meta-Tags
>
Sorry, don't understand, what are you going to do?
>
> * Notification
>
> Notification per meta_type, for example you get an Email everytime a
comment
> is added. Maybe Notification folder in MemberFolder ?

Nice. This we need certainly.

> Notification per path prefix. Everytime something is added to an object
with
> the path prefix "/projects/zdptools/", and Email is sent.

Don't know if this is so important

> Combined Notification
>
> For example I would like to be notified when a comment is added to
> "/projects/zdptools/".
>
> Notification to Maintainer
>
> Notification to Writers
>
> Summary Notification after a period of time
>
> Notification on demand
>
So you're talking about a customizable notification? Great!

>
> * Mailbag
>
> It would be nice to have a Mailing list tracker on the ZDP site, where all
> messages, which are sent to all of the Zope mailing lists are kept. The
> messages could then be used for searching on specific topics, and could
also
> be directly reused when new pieces of documentation are written.

Is this so important? I don't know if this can be that easely implemented
(ie. the classification of the mails).
At the moment, people can always browse the mailling lists. Indeed it will
be very handy, but I don't know if it is possible.

> Reusing pieces of documentation right now means to track the mailing
lists,
> using your own mail reader, or going to one of the online Mailing list
> trackers like egroups, and then cutting and pasting the message into your
> documentation.
>
> Just taking over content is not nice without giving credit to the original
> author. It is also not very user-friendly because much of the discussion,
> which has been surrounding the posting in the original discussion thread
is
> simply lost. The original thread can be very useful for ZDP visitors, who
> may want to have a look at it when they see it quoted.
>
> Right now, giving a pointer to the original post is hard, because you can
> not be sure whether the site you are pointing to always keeps the URL, or
> for what is worse, even disappears. We need to be sure that a quoted
message
> along with it's thread still exists in the future.
>
> We don't have enough space on the ZDP site to keep the whole Zope mailing
> lists, and so we are planning to digest the incoming mails only for a
> certain period of time. Afterwards, the mails will be deleted if they
> haven't appeared in a thread that has been quoted.

This must be certainly done!

> We don't have the ressources to update the Mailing List Tracker everytime
a
> mail is sent to a mailing list. So, to quote a mail, we need to manually
> upload all mails which have been written to that list since the last
update.
> We also need to update threads to which new mails have been posted in the
> meantime.
>
> We also lack a tool for uploading messages to the Zope site. We could
extend
> the Mailbag product by Tres Seaver which uses the Python 'rfc822' and
> 'mailbox' modules to parse messages and mailboxes.
>
> Lately, Tres Seaver has rewritten Mailbag, refactoring the logic into
Python
> classes. The corresponding ZClasses for the presentation layer still have
to
> be rewritten, but can possibly be taken over from the previous Mailbag
> version.
>
> To get the mail into Zope, a program needs to be written that calls
Mailbag
> via ZClient when a mail arrives. Another type of program could be useful
for
> importing existing Mailboxes into Zope.
>
> For delivery, an MDA like procmail could spawn a program out of a .forward
> file and ask it to upload the mail to a Zope folder according to a
> predefined set of recipies.
>
> There exists a Python program called getmail which takes mail from a POP3
> server and delivers it into a mailbox. The delivery part of this program
> uses a getmailrc which could be used instead of the procmail recipies.

mmmm..... what about making a database adapter.... DAPOP3Mail? :-)

> Once the mail is in a local installation on a ZDP members own Zope server,
> it is easy to export the email and upload it to the ZDP site. From there,
> the ZDP members can quote the message easily by directly pointing to the
> URL.
>
> This way, we may not get a complete mail archive, but at least we can
always
> be sure that the quoted mails and their surrounding thread exist.
>
>
>
> * Changes History
>
> Changes could be gathered for ZDP-Tools and bundled with a new release to
a
> Changes.txt.
>
> Generally we need to capture changes to all that is added or changed. At
the
> bottom of every form there should be a field where you can take a not on
> what you changed or added. This information would be gathered in a Changes
> Folder.

Yup is needed.

> * Style Guide Tips and Zope Tips
>
> On a login Screen or in the Management interface there could be a place
> where Tips can be displayed at random.

Correct, thought on this also. Had already a nice layout for this. However,
my idea stopped there, because I didn't know how to implement the layout
without a JaveApplet.

> * Information Architecture
>
> For Members and Visitors, there should be a different view in the content.
> Members should see the projects they are involved in and their own
> documents. Reviewer should see what documents need a Reviewer. Generally
the
> information architecture shpuld match the users view of the information
> space.
>
>
>
> * Contributor History
>
> There should be Contributor Folders, in which all Contributors should be
> stored that have ever changed or worked on the document. Possibly the
> Changes history could be stored there as well ?
>
>
>
> * Role Grant
>
> There should be a mechanism by which Roles can be granted to members. The
> Roles would also change the view on the information space for the member.
>
>
>
> * Review Process
>
> Writers who need a Reviewer can send a mail to a Reviewer to ask for
> reviewing. This is more personal than just setting the NeedsReviewer
> property. Reviewers can select in what Subjects/Topics they are axpert and
> Writers select among Reviewers when they ask a Reviewer.
>
mmm, what about just making a page where all the drafts are displayed which
need a reviewer? Instead of mailing?
>
> * ZDP-Tools RoadMap
>
> Publish this Plan. Define Tasks.
>
>
>
> * List of Zope Products
>
> List of all Zope Products, perhaps also with Source code. Categorize the
> products.
>
>
>
> * Zope Source Code on ZDP
>
> Regularly upload the Zope Code to the ZDP site to have it searchable in
the
> ZCatalog.
>
> Use py2html to create the HTML files.
>
> PyFontify colorizes the Python Scripts
>
> load_site for uploading the Code via ZClient
>
> Mirror Howtos and Tips of the ZDP site
>
> This could be done by adding WebSiteLink instances for every Howto on
> Zope.org to the Howto Project folder. In the WebsiteLink the abstract and
> the author information could be added. The original content of the Howtos
> can be stored in the Link but will only be displayed on demand. People
> should look at the Zope.org site first. This way the reader is sure to
> always have a recent version of the howto, but also can find it on the ZDP
> site in the Catalog.
>
>
>
> * Threaded Discussions
>
> Comments in Comments -> Thread
>
>
>
> * Use form_ everywhere
>
> In the constructors of some ZClasses the form_ templates are still not
used
> (e.g. Member ZClass).
>
>
>
> * List members with their Roles
>
>
>
> * Add more Roles
>
>
>
> * Search by meta_type
>
>
>
> * Let Anonymous see ZDP-Tools Implementation
>
>
>
> * Take over Zope.org look
>
>
>
> * Aging of Documents
>
> Get an Awareness about the age of a document. Define colors or numbers for
> the age.
>
>
>
> * Transformation of Documents
>
> Cut and Paste. Delete and Shredd. Transform Meta_types.
>
>
>
> * Different supported views in a Drop Down list
>
> Show_Flat, Show_Flat_short, ...
>
>
>
> * Announce as News Item
>
> In the constructor give a field where you can directly add a news item for
> what you are adding.
>
>
>
> * Personal bookmarks
>
> A link can be added to a personal links section, which can be seen on your
> management Interface for quick reference.
>
>
>
> * Other meta_types by this author
>
> Links to other stuff a member has written
>
>
>
> * Complete ZDP-Tools Documentation
>
> The ZDP-Tools Documentation should be completed before adding new features
> :-)
>
That's a task which I can do at the moment. Working on the ZDP-Tools
documentation. Just tell me what still has to be documented. Have you read
my doc about publishing a draft in ZBook? Something to add/change?
>

Tom.