|
Size: 4086
Comment:
|
← Revision 38 as of 2016-03-02 17:35:48 ⇥
Size: 5447
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| #pragma page-filename DEV/versions/11960492 = New Web Interface = 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 integration Mailman 3 with the rest of your web site by accessing the REST admin interface. |
## page was renamed from DEV/Web Interface #pragma page-filename DEV/versions/4489286 |
| Line 5: | Line 4: |
| For standalone systems, we want to develop and ship 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. | {{{#!wiki warning '''This page is obsolete! The information included is probably invalid and thus should be used with care''' }}} = New Web Interface (Postorius) = |
| Line 7: | Line 9: |
| Here are some [[../Web UI Mockups|Web UI Mockups]]. | 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: |
| Line 9: | Line 11: |
| Here then are some guidelines, historical notes about previous attempts to update the Mailman WUI can be found [[DEV/Previous work on UI|here]]. | [[https://launchpad.net/postorius|https://launchpad.net/postorius]] |
| Line 11: | Line 13: |
| To make suggestions the developers should consider when creating and designing the UI, please visit [[DEV/Suggestions for new Mailman 3.0 UI|this page]]. | Postorius depends on mailman.client, the Python bindings to Mailman's REST interface: |
| Line 13: | Line 15: |
| The Mailman WUI will be developed on [[https://edge.launchpad.net/mailmanweb|Launchpad]], and discussions will be conducted on the [[http://mail.python.org/mailman/listinfo/mailman-developers|mailman-developers]] mailing list. | [[https://launchpad.net/mailman.client|https://launchpad.net/mailman.client]] |
| Line 15: | Line 17: |
| Please add your name to this list if you are interested in helping out! | == Design rationale == |
| Line 17: | Line 19: |
| * [[~barry/Home|Barry Warsaw]] | 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]] |
| Line 19: | Line 60: |
| * [[../~terri|Terri Oda]] * [[../~anna.granudd@gmail.com|Anna Granudd]] * [[../~f@state-of-mind.de|Florian Fuchs]] |
* [[terri|terri]] * <<MailTo(anna DOT granudd AT gmail DOT com,Anna Granudd)>> * <<MailTo(f AT state-of-mind DOT de,Florian Fuchs)>> |
| Line 23: | Line 64: |
| * [[../~benste|benste]] == 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 == Exactly which templating system we'll choose is '''Django'''. A couple of thoughts though: |
* [[benste|benste]] * Toshio Kuratomi * Sumana Harihareswara |
| Line 33: | Line 68: |
| * 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 [[DEV/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 :-) == Status == Status updates on the development can be found and discussed [[../Web Interface Status|here]]. |
|
| Line 40: | Line 70: |
| Line 42: | Line 73: |
| ---- | * allowing a user 'to be on vacation' (wacky via IRC) == More resources == |
| Line 46: | Line 79: |
| * [[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]] |
|
| Line 48: | Line 85: |
| * [[DEV/Suggestions for new Mailman 3.0 UI|Suggestions for new Mailman 3.0 UI]] * [[DEV/Views|Views]] * [[DEV/Web Interface Status|Web Interface Status]] * [[DEV/Web UI Mockups|Web UI Mockups]] * [[DEV/mailman3 in virtualenv|mailman3 in virtualenv]] |
* [[DEV/Suggestions for new Mailman 3.0 UI|Suggestions for new Mailman 3.0 UI (old)]] * [[DEV/Web Interface Status/2012|Old status updates]] ---- |
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. It is an application based on the Django framework and is currently in beta. The project is hosted on Launchpad:
https://launchpad.net/postorius
Postorius depends on mailman.client, the Python bindings to Mailman's REST interface:
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
- Modern, easy to use web user interface for users, list admins, and site admins.
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.
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.
- WUI template system must be Python-based (framework TBD) and GPLv3 compatible.
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. Meaning it should be possible to extract texts from templates and add them to a gettext catalog.
- Of course, written in Python
Developing Postorius
The Mailman WUI (a.k.a. Postorius) is developed on Launchpad (code, code review, and bug reports), and we discuss it on the 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 guide to run Postorius using Apache is part of the Postorius documentation:
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
Please add your name to this list, and email the mailman-developers list, if you are interested in helping out!
- Patrick Ben Koetter
Anna Granudd <anna DOT granudd AT gmail DOT com>
Florian Fuchs <f AT state-of-mind DOT de>
- Claudia Fleiner
- 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
Views that Mailman 3 should support