Mailman Patch #444879: Improved archiver index control

Description

This patch should improve the quality of search results returned by search engines such as htdig where the search engine's index builder is responsive to strings embedded in the HTML pages that are the subject of the indexing. Typically such strings can be used to restrict the text within the HTML which is added to the search indexes by the indexer.

Typically, the use of this patch will reduce the incidence of irrelevant results being returned by the search engine.

This patch:

• Allows strings for enabling and disabling indexing to be defined in mm_cfg.py.
• Embeds those strings in the pages generated as the HTML version of a list's archive by Mailman interanl Pipermail archiver.

While this patch is a necessary precursor for the Mailman Patch #444884 (Mailman/htdig integration) its use is not restricted to working with htdig. It can be configured to use whatever indexing-on/indexing-off strings are acceptable to the search engine that will be used to search your mail archives. For further discussion see the contents of file README.NOINDEXtags installed by this patch.

Applicability

Versions of this patch are avaliable for Mailman version 2.0.13, 2.1 final and later.

Necessary Precursors

There are no necessary precursors for Mailman 2.1.3 and later.

The following patch must first be applied if this patch is being applied to Mailman 2.1.2

1. Mailman Patch #728836 for MM 2.1.2

The following patch must first be applied if this patch is being applied to Mailman 2.1 final or 2.1.1.

1. Mailman Patch #661138 for MM 2.1 final and 2.1.1

There are no necessary precursors for Mailman 2.0.13

Changes Made

The templates used by Mailman builtin Pipermail archiver to generate HTML versions of archived emails are modified to incorporate the defined indexing-on and indexing-off strings.

In the case of Mailman 2.0.13 the templates used are string variables embedded in the Mailman archiver code. These are modified by this patch as is the code that generates the HTML pages in $run/Mailman/Archive/HyperArch.py.

In the case of Mailman 2.1 final and latter such templates have been abstracted into per language sub-directories of the $run/templates directory. The template files are modified by this patch as is the code that generates the HTML pages in $run/Mailman/Archive/HyperArch.py.

Applying the patch

Apply the patch from within the Mailman build directory using the command:

    patch -p1 < path-to-patch-file

Download Patch File

MM Version	Download
2.1.11
2.1.10
2.1.9
2.1.8	Uses the same patch as MM 2.1.7
2.1.7
2.1.6
2.1.4
2.1.3
2.1.2
2.1.1
2.1 final
2.0.13