## page was renamed from DEV/Web Interface
#pragma page-filename DEV/versions/4489286

{{{#!wiki warning
'''This page is obsolete! The information included is probably invalid and thus should be used with care'''
}}}
= New Web Interface (Postorius) =

Postorius is the main component of the administrative interface of [[../Mailman 3.0|Mailman 3]]. It is an application based on the Django framework and is currently [[https://launchpad.net/postorius/trunk/1.0.0b1|in beta]]. The project is hosted on Launchpad:

[[https://launchpad.net/postorius|https://launchpad.net/postorius]]

Postorius depends on mailman.client, the Python bindings to Mailman's REST interface:

[[https://launchpad.net/mailman.client|https://launchpad.net/mailman.client]]

== Design rationale ==

Mailman 3 comes with a new architecture which allows for a separation between the web user interface (WUI) and the mailing list engine. In fact, you can run Mailman 3 with no WUI at all, or integrate Mailman 3 with the rest of your web site by accessing the REST admin interface via mailman.client.

For standalone systems, we are developing and shipping our own updated WUI. The original Mailman 2 user interface was designed in the late 1990's so it's clearly dated, and the technology backing it is ancient, inflexible and non-standard. Today, there are tons of great Python-based web frameworks, and of course `JavaScript` is all the rage today. We want a modern, good looking, well-organized WUI that can be used with Mailman 3 but is optional for those sites that want to heavily customize their use of Mailman. Thus: Postorius!

== Guidelines ==

 1. Modern, easy to use web user interface for users, list admins, and site admins.
 1. Progressive enhancement; i.e. can use `JavaScript` for dynamic aspects, but must remain usable for non-`JavaScript` browsers, and must be friendly to screen readers.
 1. WUI templates must support internationalization by allowing us to mark up translatable texts for inclusion in the `gettext` catalog. Technology must integrate with Python's `gettext` module and/or Mailman's i18n infrastructure.
 1. WUI template system must be Python-based (framework TBD) and GPLv3 compatible.
 1. `JavaScript` library must be GPLv3 compatible (framework TBD).

== Templating systems ==

We chose the '''Django''' templating system. Some thoughts we were considering:

 * It would be nice to use the same templating system in the WUI and core engine. I'd like to be able to use templates for all email that Mailman sends
 * It should be friendly to [[../Internationalization|Internationalization]]. Meaning it should be possible to extract texts from templates and add them to a [[http://www.python.org/doc/current/library/gettext.html|gettext]] catalog.
 * Of course, written in Python 

== Developing Postorius ==

The Mailman WUI (a.k.a. Postorius) is developed on [[http://launchpad.net/postorius|Launchpad]] (code, code review, and bug reports), and we discuss it on the [[http://mail.python.org/mailman/listinfo/mailman-developers|mailman-developers]] mailing list. Please also see the bottom of the page for more resources (including mockups, feature suggestions, and prior work).

A quick 5 minute guide (if you're lucky) to get Postorius installed for development can be found here:

[[../A 5 minute guide to get the Mailman web UI running|A 5 minute guide to get the Mailman web UI running]]

A guide to run Postorius using Apache is part of the Postorius documentation:

[[http://packages.python.org/postorius/setup.html|http://packages.python.org/postorius/setup.html]]

Some preliminary notes on testing new code in Postorius (this is still a draft...):

[[http://packages.python.org/postorius/development.html|http://packages.python.org/postorius/development.html]]


Please add your name to this list, and email the mailman-developers list, if you are interested in helping out!

 * [[barry|Barry Warsaw]]
 * Patrick Ben Koetter
 * [[terri|terri]]
 * <<MailTo(anna DOT granudd AT gmail DOT com,Anna Granudd)>>
 * <<MailTo(f AT state-of-mind DOT de,Florian Fuchs)>>
 * Claudia Fleiner
 * [[benste|benste]]
 * Toshio Kuratomi
 * Sumana Harihareswara


== Wish List / Random Ideas ==

 * "moderate_all" option for admins: "Consider an admin that is reviewing a bunch of bounces/spam, etc. It might be handy for him to have some buttons to freeze the list (eg. moderate-all) in that context without having to navigate over to a different section to set that flag." (wacky via irc)
 * showing the Log in the WUI (C Nulk via Mailinglist)
 * allowing a user 'to be on vacation' (wacky via IRC)

== More resources ==

 * [[DEV/A 5 minute guide to get the Mailman web UI running|A 5 minute guide to get the Mailman web UI running]]
 * [[DEV/How to get Postorius running on Apache and mod_wsgi|How to get Postorius running on Apache and mod_wsgi]]
 * [[DEV/mailman3 in virtualenv|mailman3 in virtualenv]]
 * [[DEV/Design|Design work]] and [[DEV/Web UI Mockups|Web UI Mockups]]
 * [[DEV/Views|Views]] that Mailman 3 should support
 * [[DEV/Requirements|Requirements, such as accessibility]]
 * [[DEV/New Menu Structure_Layout|New Menu Structure_Layout]]
 * [[DEV/Previous work on UI|Previous work on UI]]
 * [[DEV/Suggestions for new Mailman 3.0 UI|Suggestions for new Mailman 3.0 UI (old)]]
 * [[DEV/Web Interface Status/2012|Old status updates]]

----