Release Notes

GroupServer 14.03 — Ouzo utilised as an unguent

Authors: Michael JasonSmith
Bill Bushey
Dan Randow
Contact: Michael JasonSmith <mpj17@onlinegroups.net>
Date: 2014-03-20
Organization: GroupServer.org
Copyright: This document is licensed under a Creative Commons Attribution-Share Alike 4.0 International License by OnlineGroups.net.

1   Introduction

It has been seventeen months since the last release of GroupServer (Absinthe, 12.11). The major delay was caused by the creation of a new user-interface for GroupServer. Almost all the changes to GroupServer are user-visible — and include a new notifications, and updated systems for adding people. You can get Ouzo immediately.

2   Changes to GroupServer

The most significant change to GroupServer in the Ouzo release is the new style pages. In addition the system for adding people in bulk has been completely rewritten, there has been an extensive notifications update, and other updates.

2.1   New style pages

The main update to GroupServer has been the implementation of new pages on the Web interface (Issue 3423). The navigation has been extensively reworked: there is an updated layout for most pages, and pages have been integrated with Twitter Bootstrap [1]. The profile images are now (mostly) square, with new code to improve their performance. In addition the pages have been made more responsive, and the performance of the pages has been improved.

Acknowledgements:
 The pages were redesigned by Mike Harding from Cactuslab, to whom all praise should be given.

2.1.2   Updated layout

The Group page [2] and Site homepage [3] have been updated so they have asymmetric columns — with less important information placed in the smaller column on the right. Both make use of Twitter Bootstrap, the updated profile images, and the updated lists.

The Group page gets an updated About area, and Change about page (Issue 3871). The Site homepage gets a new Welcome area (Issue 3869) in addition to an updated Introduction (Issue 3870).

The layout of the Topic page and Post page have been updated to move the metadata (such as who posted the message, and when) to the left of the post (Issue 3455).

The Image page, which displays an image that has been posted to a group, has been updated to reflect the layout of the Topic page. Problems with SVG images have also been resolved (Issue 3663).

Most of the other pages have been updated to take Twitter Bootstrap and the new navigation into account.

2.1.3   Twitter Bootstrap

The GroupServer user-interface is now based on Twitter Bootstrap 2.3. The look of every single page has changed significantly as a consequence.

The tabs, on the Group page and Site page, have dropped the use of jQuery.UI tabs in favour of the Bootstrap Tabs. The Popover class is used to show information including the privacy of a group and posts, encouragement for the new administrator, and the Share widget.

2.1.4   Profile images

Another major change has been with the profile images. They are now shown in more places and at multiple resolutions. In addition most of the images are square. If a group member has not set an image a missing profile image image is shown.

2.1.4.1   Multiple resolutions

The profile-images in releases of GroupServer prior to Ouzo were restricted to 81×108 pixels. Now the content provider [4] is able to supply profile images at a range of resolutions (Issue 588). In addition the image compression enhancements have also been rolled out to the profile image, so small images are now directly embedded into the page.

2.1.4.2   Square

The profile images are now square by default [5]. These square images are shown in more places, such as in the new Recently active list on the Group page (Issue 3873), the Profile link at the top of every page, and the Post message area of the Topic and Start topic pages.

2.1.5   Updated lists

At its core GroupServer provides lists of things: groups, topics, posts, files, and people. All these lists have been updated to improve the hierarchy of information.

  • The Groups list on the Site page now lists all the visible groups, making the Groups page redundant (Issue 3449).
  • The Files icons for a topic are no-longer shown by default. Instead a single attachment-icon is shown, and icons for the files are displayed in a tooltip.
  • Who made the most recent post, and when, is more prominently displayed.
  • The topic-keywords are labelled Keywords.
  • There is a new list of Recently active members on the Group page, which is loaded through AJAX (Issue 3873).
  • The list of Files has been moved to the secondary column of the Group page, from the main area.

2.1.6   Responsive

The GroupServer web pages are now more responsive to the size of device (Issue 3909). This allows the pages to look good from screens found on desktops, down to small feature phones. This allows people to keep up with conversations anywhere and any time. Some pages, such as the Image page (Issue 3508) have had particular attention to ensure the page works well at multiple sizes.

2.1.7   Performance

The performance Web interface has been massively improved. The primary way of doing this has been with refactored JavaScript. In addition image compression has been increased and font icons introduced. Finally, many small changes have been made to the layout of the pages to reduce the time to glass.

2.1.7.1   Refactored JavaScript

All the JavaScript used by GroupServer has been refactored into separate modules (Issue 344). This makes documentation and maintenance far easier, at the expense of speed. To compensate, all JavaScript (including that supplied by jQuery [6] and Twitter Bootstrap [7]) is deferred until after the paged has been shown [8]. In addition, all the JavaScript has been minified to reduce the amount of data that is transported, and to speed the parsing by the Web browser. Finally, almost all the JavaScript is asynchronously loaded [9].

The JavaScript code loads and assists with navigating the lists of recent topics, posts and files. This code has been refactored so the all the lists share the same code (Issue 3507). In addition the lists are only loaded when the corresponding tab is visible. Combined this greatly reduces the number of requests required to load the page.

Strict mode has been enabled for all the core JavaScript modules, and some of the other modules. This has the combined effect of reducing the number of errors, and improving performance by allowing the browser to optimise the code.

2.1.7.2   Image compression

Many JPEG images that are posted by group members have very low compression (or very high quality, depending how you like to look at it). GroupServer now produces thumbnails with aggressive compression by default (Issue 663). As the dimensions of the image are reduced the quality of the image is also dropped — making the images far smaller [10]. When images are particularly small a data-URI is used to directly embed the image into the page, reducing the need to make an HTTP request to fetch the image.

2.1.7.3   Font icons

The new user-interface uses a font to provide the different icons in the interface (Issue 3788). These are quick to load and render. In addition they are independent of the resolution of the device, so work well in the new responsive user interface.

2.2   Adding people

The system for adding people to a group has undergone many improvements, primarily to the pages that allow the new member details to be uploaded by CSV, but also to the system that allows existing site members to be invited to join a group.

The systems for inviting people in bulk [11] — and adding people in bulk [12] — using a CSV file have been completely rewritten (Issue 3494). Both systems now use AJAX and JSON to parse the CSV file, and invite [13] or add [14] individual people. This, combined with widgets provided by Twitter Bootstrap, allows for continual progress updates, avoids server timeouts, and is massively more usable.

On a more minor note, the page for inviting site members to join a group has been enhanced with the addition of email-addresses, which helps distinguish between people with similar names (Issue 452).

2.3   Notifications update

Most of the notifications in GroupServer have been updated in Ouzo (Issue 3892). Premailer is now used to embed CSS into the HTML-formatted messages. The CSS itself is specified using a system of "skins" that is very similar to what is used for the Web pages [15], and the default look is very similar to the Web user interface [16].

Almost all the notifications have been moved to the file-system — rather than requiring templates in the ZMI (Issue 269) — and the use of the new notifications is now far more consistent than before.

2.3.1   Topic digests

The system for producing the topic digests [17] has been completely rewritten (Issue 408). The digest email is provided in both HTML and plain-text formats. In addition the code for sending the digests [18] has been rewritten, so it uses less memory, and is more secure (Issue 3415 and Issue 3417).

2.4   Other updates

As well as the major rewrite of the user-interface a number of smaller changes have been made with the Ouzo release that makes GroupServer more useful, more usable, and easier to maintain.

Autocomplete with Start a topic:
The Start a topic page [19] now has type-ahead (provided by Twitter Bootstrap) that suggests the names of existing topics in the group (Issue 282).
Show password:
All password entries (for login and setting a password) now have a toggle to allow a group member to hide his or her password in public places (Issue 519) [20].
Attachment detection:
The code for determining the attachments to show, and the attachments to hide, has been rewritten to allow more attachments through (Issue 4073).
Join and leave log:
The Join and leave log has been moved to the Members page (Issue 3683).
WMYeditor updated:
The WYMeditor is used to provide editing of HTML content such as the About area in a group. It has been updated to work with jQuery 1.9 (Issue 3868).
Keywords on the Topic page:
Keywords, summarising what has been discussed, are now shown at the top of the Topic page (Issue 877)
Privacy on the Group page:
The privacy setting for a group is shown on the Group page, near the email address for the group (Issue 3914).
Accessibility:
WAI-ARIA attributes have been added throughout GroupServer to improve the accessibility.
Python 3 updates:

The slow journey to convert GroupServer from Python 2 to Python 3 has been started. At this stage three sets of changes have been made, or are being made:

  • Ensuring the code is consistent with PEP-8,
  • Switching to Unicode literals where possible (PEP-3112), and
  • Switching to absolute import (PEP-328).

3   Get Ouzo

To get Ouzo go to the Downloads page for GroupServer and follow the GroupServer Installation documentation. Those who already have a functioning installation can update an existing GroupServer system.

3.1   Update an Existing GroupServer System

To update a system running the Absinthe release of GroupServer (12.11) to Ouzo (14.03) carry out the following steps.

  1. Download the Ouzo tar-ball from the GroupServer download page.

  2. Uncompress the tar-ball:

    $ tar cfz groupserver-14.03.tar.gz
    
  3. Change to the directory that contains your existing GroupServer installation.

  4. Make a backup of your custom configuration:

    $ cp custom.cfg custom-bk.cfg
    $ cp config.cfg config-bk.cfg
    
  5. Copy the new configuration files to your existing GroupServer installation:

    $ cp ../groupserver-14.03/*.cfg .
    
  6. Restore your custom configuration:

    $ mv custom-bk.cfg custom.cfg
    $ mv config-bk.cfg config.cfg
    
  7. In your existing GroupServer installation run:

    $ ./bin/buildout -n
    
  8. Restart your GroupServer instance.

4   Resources

[1]The product for supplying the CSS is located at <https://source.iopen.net/groupserver/gs.content.js.bootstrap>
[2]The code responsible for laying out the Group page is provided by <https://source.iopen.net/groupserver/gs.group.home>
[3]The code responsible for laying out the Site homepage is provided by <https://source.iopen.net/groupserver/gs.site.home>
[4]The product for supplying the profile-image content provider is located at <https://source.iopen.net/groupserver/gs.profile.image.base>
[5]The product for supplying the square profile-image is located at <https://source.iopen.net/groupserver/gs.profile.image.square>
[6]The product for supplying the jQuery JavaScript is located at <https://source.iopen.net/groupserver/gs.content.js.jquery.base>
[7]The product for supplying the Twitter Bootstrap code is located at <https://source.iopen.net/groupserver/gs.content.js.bootstrap>
[8]The product for determining what JavaScript is loaded, and how, is provided by <https://source.iopen.net/groupserver/gs.content.layout>
[9]The code for asynchronously loading the JavaScript is provided by <https://source.iopen.net/groupserver/gs.content.js.loader/>
[10]The code for determining how images should be displayed is provided by <https://source.iopen.net/groupserver/gs.image.base> and <https://source.iopen.net/groupserver/gs.image.square>
[11]The code for inviting people by uploading a CSV file is provided by <https://source.iopen.net/groupserver/gs.group.member.invite.csv>
[12]The code for adding people by uploading a CSV file is provided by <https://source.iopen.net/groupserver/gs.group.member.add.csv>
[13]The code for inviting someone by JSON is provided by <https://source.iopen.net/groupserver/gs.group.member.invite.json>
[14]The code for adding someone by JSON is provided by <https://source.iopen.net/groupserver/gs.group.member.add.json>
[15]The code for specifying the CSS for the HTML-formatted notifications is provided by <https://source.iopen.net/groupserver/gs.content.email.css>
[16]The code for specifying the layout of the messages is provided by <https://source.iopen.net/groupserver/gs.content.email.layout>
[17]The system for generating the topic digests is provided by <https://source.iopen.net/groupserver/gs.group.messages.topicdigest>
[18]The system for sending the topic digests is provided by <https://source.iopen.net/groupserver/gs.group.messages.senddigest>
[19]The Start a topic page is provided by <https://source.iopen.net/groupserver/gs.group.messages.starttopic>
[20]The toggle to show or hide a password is provided by <https://source.iopen.net/groupserver/gs.profile.password>