`gs.group.messages.base` API¶

There are two parts to the API supplied by the gs.group.messages.base product: there is a viewlet and some utilities.

Viewlet¶

The gs.group.messages.base product supplies a viewlet — for the group page (gs.group.home) — called gs-group-messages-base. In turn it contains a viewlet manager that creates a slot for the various views of the list of messages. (In the user-documentation this is generally referred to as the archive.)

The viewlet manager provides the interface interfaces.IGroupHomepageMessages.

class gs.group.messages.base.interfaces.IGroupHomepageMessages[source]¶: A viewlet manager for the messages on the group homepage

The viewlets that provide lists for the Group page register against this interface.

<browser:viewlet
  name="gs-group-messages-topics-tab"
  manager="gs.group.messages.base.interfaces.IGroupHomepageMessages"
  template="browser/templates/topics.pt"
  class=".topicstab.TopicsTab"
  permission="zope2.Public"
  weight="10"
  title="Topics" />

The viewlets and viewlet manager combine to create tabs, using the Bootstrap tabs system. The title of each viewlet becomes the tab-title, with the content of the viewlet becoming the tab-panel. All the tabs are marked-up with WAI:ARIA roles. The viewlet itself has the HTML id attribute value gs-group-messages-base-tabs

Utilities¶

There are utilities for file icons and for formatting file sizes. These happen to be used in many different contexts, so the functions are placed here.

File icons¶

In GroupServer the file icons are actually characters. The icon font supplied by gs.content.css turns the character into a glyph.

gs.group.messages.base.get_icon(mimeType)[source]¶

Get the icon (character) for a particular MIME-type

Parameters:	mimeType (str) – The mime-type to look up
Returns:	The character for the icon representing the MIME type
Return type:	unichr

Example¶

Call the function:

f['icon'] = get_icon(f['mime_type'])

Use the icon in the page template:

<a class="icon-alone" href="#" tal:attributes="href f/url; title f/name">
  <span aria-hidden="true" data-icon="&#x1f3a8;"
        tal:attributes="data-icon f/icon"></span>
  <span class="screen-reader-text">File type:
    <span tal:content="f/mime_type">application/octet-stream</span>
  </span>
</a>

File sizes¶

File sizes are displayed in the list of attached posts in both email and on the web, and on the Image page, hence the presence of the file_size_format() function here. It formats the size so it has the appropriate unit (b, kb, mb, gb, tb…) after it, or it displays empty.

gs.group.messages.base.file_size_format(bytes)[source]¶

A humanized string for a given amount of bytes

Parameters:	bytes (int) – The number of bytes
Returns:	The file size with the units
Return type:	str

gs.group.messages.base API¶