Help:Extension:Newsletter

Welcome to the documentation page for the Newsletter extension!

Introduction
The Newsletter extension is a tool to provide Wikimedia and MediaWiki users with a Newsletter-like service. It allows publishers to create newsletters and announce new issues, while allowing users to browse and subscribe to newsletters. The Newsletter extension uses the Notifications (previously known as Echo) tool to notify subscribed users of a Newsletter when a new issue is announced, as well as when a new subscriber or publisher is added. This extension was initially developed as a Google Summer of Code 2015 project. Currently, the Newsletter extension is not deployed on Wikimedia. You can see progress here. In the meantime, a test instance of the extension can be found here.

Viewing a Newsletter
In order to view a list of newsletters, navigate to Special:Newsletters. There, you will see a table of newsletters you can filter through. From there, you can navigate to the Newsletter of your choice by simply clicking on the link.

Subscribing/Unsubscribing
In order to subscribe or unsubscribe to a newsletter, you must first log in. you can do either one of two things:
 * Navigate to Special:Newsletters and click the subscribe/unsubscribe link on the right side of the table.
 * Navigate to the page of the desired newsletter and click the subscribe button.

Notification Preferences
By default, you will receive notifications using from the Notifications tool when you subscribe or unsubscribe to a newsletter, when a new issue is announced, and when a new subscriber or publisher is added. To configure this, navigate to the tab of your preferences and enable or disable notifications for e-mail (currently not supported) or web.

Creating a newsletter
Note: You must be in the 'sys-op' group to be able to create a newsletter. First, navigate to Special:CreateNewsletter. Then, provide the following fields: Once the newsletter has been created, you will get a success message and a link to the new newsletter will be shown.
 * Title of the newsletter
 * A link to an existing wiki page that will serve as the newsletter's main page
 * A description of the newsletter

Publishing a new issue
Note: You must have the Notifications tool, previously known as the Echo extension, installed. In order to publish a new issue of a newsletter, do the following: Once a new issue has been announced, it will notify all subscribers via the Notifications tool.
 * 1) Navigate to the newsletter's main page.
 * 2) Click the 'Announce' button in the menu at the top.
 * 3) Fill in the required fields.
 * 4) * Page title of the issue
 * 5) * Summary of the issue

Managing a newsletter
In order to manage a newsletter, navigate to the newsletter's main page and click the 'Manage' button in the menu at the top. Here are the following actions you can take from there:
 * Change the title of the newsletter
 * Change the description of the newsletter
 * Add and remove publishers by modifying the list in the text box, with each publisher separated by a newline

Adding and removing subscribers
In order to add and remove subscribers, first navigate to the newsletter's main page and click the 'View Subscribers' button in the menu at the top. This will bring you to a new page with a text box containing the existing subscribers. Add or remove subscribers from the list, ensuring that each subscriber is on his or her own line.

Deleting a newsletter
The Newsletter extension has recently migrated to ContentHandler and thus is very like. Instead of having a delete newsletter interface, deleting a newsletter can be done simply by using action=delete, which can be accessed by clicking the 'More' tab at the top and selecting 'Delete' from the dropdown.