Merge pull request #18 from mpj17/master

Tweaking the topic keywords and updating the FAQ

develop.cfg

@@ -7,6 +7,7 @@ extends =
 eggs +=
      i18ndude
      transifex-client
+     Sphinx
 extensions = mr.developer
 
 # The following assumes that the site and databases have been
@@ -23,7 +24,18 @@ parts =
     doneMesg
 
 [versions]
+# i18ndude makes internationalisation easer
 i18ndude = 4.0.1
+
+# Sphinx generates the documentation
+Sphinx = 1.5a2
+# Required by Sphinx
+alabaster = 0.7.3
+Babel = 2.3.4
+imagesize = 0.7.1
+snowballstemmer = 1.2.0
+
+# Transifex is used for localisation
 transifex-client = 0.12.2
 # Transifex Client requires urllib3
 urllib3 = 1.18

docs/faq.rst

@@ -57,6 +57,66 @@ How do I...
 
   [From OnlineGroups.net Support]
 
+.. index::
+   single: Host name
+   single: Domain name
+   single: Proxy
+   double: Email; Domain
+   double: Email; Configuration
+   double: Site; Address
+
+.. _changeName:
+
+... change the host name?
+
+  GroupServer uses two slightly different host names: one for the
+  web-site and one for the mail-host. To change the host name for
+  the site both will have to be changed.
+
+  * Change the host name for the web site.
+
+     #. Log into the :ref:`ZMI <ZMI Login>`.
+     #. Visit the :file:`DivisionConfiguration` for your site (by
+        default :file:`/groupserver/Content/initial_site/`).
+     #. Change the :guilabel:`canonicalHost` property to the new
+        name.
+     #. Click the :guilabel:`Save changes` button.
+     #. Change the proxy forwarding (see :doc:`proxy-configure`).
+
+  * Change the various names for the mail-host.
+
+     #. Log into the :ref:`ZMI <ZMI Login>`.
+     #. Visit the :file:`DivisionConfiguration` for your site (by
+        default :file:`/groupserver/Content/initial_site/`).
+     #. Change the :guilabel:`emailDomain` to the new name, which
+        may or may not be the same as the
+        :guilabel:`canonicalHost` property. The
+        :guilabel:`emailDomain` property of the
+        :guilabel:`DivisionConfiguration` is used by the *Start*
+        *a* *group* page to determine the email-address of a new
+        group (``{groupId}@{emailDomain}``). (If absent the
+        :guilabel:`emailDomain` of the
+        :guilabel:`GlobalConfugration` object is used.)
+     #. Click the :guilabel:`Save changes` button.
+
+     #. Change the email address for each and every group.
+
+        #. Log into the :ref:`ZMI <ZMI Login>`.
+        #. Visit the :file:`ListManager` for your site (by
+           default :file:`/groupserver/ListManager`).
+        #. For each group
+
+           #. Select the group
+           #. Select the :guilabel:`Property` tab.
+           #. Change the :guilabel:`mailto` property so it
+              contains the correct address.
+           #. Click the :guilabel:`Save changes` button.
+
+     #. Change the configuration for :command:`postfix` (see
+        :doc:`postfix-configure`).
+
+  <http://groupserver.org/r/topic/2DdgBqagGaFs6cuCctFUfA>
+
 .. index::
    single: User group
    double: Site; Start
@@ -424,7 +484,7 @@ How do I...
   #. Open the mailing list object for the group.
   #. Copy the list of members to be moderated from the text
      editor into the ``moderated_members`` list.
-  #. Click the *Save changes* button.
+  #. Click the :guilabel:`Save changes` button.
 
   <http://groupserver.org/r/post/7r2kAxK3Y4zUPJgvl2A2rz>
 

docs/release-notes-1211.rst

@@ -48,7 +48,10 @@ groups`_, and the new `profile search`_ will help administrators
 find the profiles of participants. Finally, `SVG thumbnails`_ are
 now shown.
 
-.. index::
+.. index:: !Search
+   pair: Topic; Keywords
+   pair: Topic; Search
+   pair: Post; Search
    pair: Email; Search
 
 New search system

docs/release-notes-1403.rst

@@ -142,6 +142,15 @@ page, and the *Post message* area of the *Topic* and *Start topic* pages.
 
 .. _Issue 3873: https://redmine.iopen.net/issues/3873
 
+.. index::
+   pair: Files; List
+   pair: Group; List
+   pair: Group; Page
+   pair: Topic; Keywords
+   pair: Topic; List
+   pair: Post; Most recent
+   triple: Group; Member; Recently active
+
 Updated lists
 -------------
 

docs/release-notes-yymm.rst

@@ -7,7 +7,7 @@ Unreleased
 
 :Authors: `Michael JasonSmith`_;
 :Contact: Michael JasonSmith <mpj17@ldots.org>
-:Date: 2016-10-18
+:Date: 2016-10-21
 :Organization: `GroupServer.org`_
 :Copyright: This document is licensed under a
   `Creative Commons Attribution-Share Alike 4.0 International
@@ -77,8 +77,9 @@ the new notification (finally) closes `Issue 269`_.
 
 
 .. index::
-   pair: Profile; Activity log
    pair: Notification; Welcome
+   pair: Profile; Activity log
+   pair: Topic; Keywords
    triple: Group; Member; Invite
 
 Minor improvements
@@ -93,14 +94,16 @@ Minor improvements
 * The **Invite members in bulk** system is now more robust, as it
   will handle *tab* separated values, as well as *comma*
   separated values (CSV), with thanks to `Piers Goodhew`_.
-* The *favicon* images have been optimised.
+* Email addresses and web-page addresses are now omitted from the
+  **topic keywords**, closing `Bug 3919`_ and `Bug 4028`_.
 * The image-processing code is now more robust, including the
   scaling of very wide and very short images, with thanks to
   `Donald Winship`_ for pointing out the issue.
 * Errors in the :doc:`development` documentation have been fixed,
   with thanks to `Nick Bell`_.
 * The creation of a development build of GroupServer is now
   easier, and better documented.
+* The *favicon* images have been optimised.
 * :pep:`484` type hints have been added to some low-level
   libraries.
 
@@ -109,6 +112,8 @@ Minor improvements
 .. _Nick Bell: http://groupserver.org/p/3Fkga91WZ1O65yPEh0QYOb
 .. _Donald Winship:
    http://groupserver.org/p/1cQiyqkdTbIFKQjlqzq49Z
+.. _Bug 3919: https://redmine.iopen.net/issues/3939
+.. _Bug 4028: https://redmine.iopen.net/issues/4028
 
 ----------
 Get Sherry
@@ -144,6 +149,18 @@ GroupServer to Sherry (YY.MM) carry out the following steps.
 
         $ ./bin/buildout -N
 
+#.  Update the SQL function that generates the topic keywords:
+
+      ::
+
+        $ shopt -s globstar  # This makes the ** below work
+        $ psql -U {psql_user} -h {psql_host} {psql_dbname} -f \
+          eggs/gs.group.messages.topic.base*/**/03-keywords.sql 
+
+    Where ``{psql_user}``, ``{psql_host}``, ``{psql_dbname}`` are
+    the name of your PostgreSQL user, host, and database, as
+    configured during your :doc:`groupserver-install`.
+
 #.  Restart your GroupServer instance (see
     :doc:`groupserver-start`).
 

versions.cfg

@@ -86,7 +86,7 @@ gs.group.messages.post.text = 1.1.2.dev20160512175029
 gs.group.messages.privacy = 2.2.0.dev20141112220851-7be820f93e83
 gs.group.messages.ratelimit = 2.0.0.dev20140611201548-b0034ee91a4c
 gs.group.messages.text = 1.1.0.dev20160411225400
-gs.group.messages.topic.base = 4.0.6.dev20160128192927
+gs.group.messages.topic.base = 4.0.7.dev20161021150837
 gs.group.messages.topic.digest.base = 4.0.2.dev20150921221711
 gs.group.messages.topic.digest.daily = 1.0.0.dev20150424154422-a4dd51e675a5
 gs.group.messages.topic.digest.send = 3.1.1