Manually Configuring the Preferences File

From MemberPlugin

 This article describes the format of the preferences file, and how to edit it manually.
 Most people shouldn't do this - instead use the editor - see How to Edit the Configuration File.
 So this article assumes you're happy uploading and downloading files, and don't find
 the format of the file too scary.

For an example of a preferences file, see here. The format is fairly clear; try to stick as closely as possible to this when changing it, so that you have as few problems as possible. In particular:

• Don't add/remove spaces where they don't occur in the standard one.
• Make sure you put quotes and semicolons in the right place.
• Don't use Javascript style commenting, of //, because the plugin doesn't understand that and so might pick up the value you've tried to comment out.

It will take upto 24 hours after changing configuration before all members are using it.  But if you move your mouse over (but don't click) the Disable button, it'll pick up the changes next time you reload the page.

Configurable Items

Keyword	Use
messageTypes	Generates the drop-down list in the Type field. The first four entries must be equivalent to OFFER/TAKEN/WANTED/RECEIVED, in that order. This is used for My Posts and that the Fair Offer Policy, if configured, will only show for the OFFER type. This means (for example) that you can only have one keyword that reflects an OFFER, and it must come first in the list in your configuration, but you wouldn't really want multiple keywords meaning the same thing. Any other keywords you allow (for example PPU for Pending Pick-up) should be added at the end.
INCLUDE_CUSTOM_FOOTER	Add footer to indicate that the plugin is used. This does not use FOOTER_LINE, since the text in there is specific to the Message Maker. Instead it just makes one up.
SHOW_FOP	Shows checkbox for Fair Offer Policy, labelled with string31 and string32. If selected, includes text from FOP_LINE[0], FOP_LINE[1] and FOP_LINE[2].
SHOW_FOP_SUBJECT	If SHOW_FOP is set, will add FOP_SUBJECT_TAG to the end of a subject line. This isn't included in the maximum length, so if you want to ensure that the total length is less than a certain amount you need to subtract 5 from your subject length limit.
FOP_SUBJECT_TAG	If SHOW_FOP_SUBJECT is set, string to add to the end of a subject line. Defaults to " *FOP".
string24	This is the note to the right of the Type field.
string25, string26	These are the notes to the right of the Item field.
string27, string28	These are the notes to the right of the Location field.
string29, string2A	These are the notes just above the large textbox for the Description of the item.
checkTotalLength	Whether to apply the total length limit. Defaults to true.
totalLength	Length limit to apply on the whole subject (i.e. keyword + item + location).  The default value is 63, which corresponds to when Yahoo truncates subjects.  For backwards compatibility you can also set to 0 to disable this check.
totalLengthError	The first part of the error to pop up if that length limit is violated.
totalLengthErrorSuff	The second partof the error to pop up. The plugin inserts the number of characters you need to remove in between these two parts.
network	The name of the regifting network, used in buttons, signatures etc. Defaults to "Freecycle".
checkKeywords	Whether to check the item field (that goes in the subject line) for the OFFER, TAKEN, WANTED and RECEIVED keywords, and prevent submission if they're present. Defaults to 1.
checkKeywordsMessage	The message to pop up if a keyword is found. Defaults to You have put the type of the message in your item. This is probably a mistake, as the type is inserted automatically. Please remove it.
locationInBody	Whether to put the location in the first line of the message body rather than the subject line. Defaults to 0.
locationInBodyIntro	Introductory string used with locationInBody. Defaults to "Location :".
locationPrefix	Used when putting location into subject line. Defaults to " (".
locationSuffix	Used when putting location into subject line. Defaults to ")".
includeOriginalText	Whether to include the original message text when generating TAKEN or RECEIVED messages. Defaults to 1.
IEfooter	Footer added by Internet Explorer version. Defaults to \n\n--\nCompose messages easily with Freecycle *Internet Explorer* and Firefox Plugins from http://wiki.memberplugin.org\n. The mod plugin assumes you use the standard footer, so if you change it, it won't be able to flag your message as coming from the plugin.
FFfooter	Footer added by Mozilla Firefox version. Defaults to \n\n--\nCompose messages easily with Internet Explorer and *Firefox* Freecycle Plugins from http://wiki.memberplugin.org\n.
repostOffer	Number of days before repost of OFFER is allowed. The default value is 2. Remember that the plugin only keeps messages for 31 days, after which they won't appear in My Posts. So if you set this too close to 31, there won't be much time for someone to see and use the Post Again button.
repostWanted	Number of days before repost of WANTED is allowed. The default value is 21. Remember that the plugin only keeps messages for 31 days, after which they won't appear in My Posts. So if you set this too close to 31, there won't be much time for someone to see and use the Post Again button.
showPostAgain	Whether to show the Post Again link for completed posts. Defaults to 0.
deleteDelete	Whether to delete the Delete option for members. Defaults to 1.  The Delete option remains present for moderators.
replyWarning, replyContinue	Messages to display when warning about a reply to a possibly TAKEN/RECEIVED post.

In the above, note that where is says "Defaults to 0" the 0 means false and in "Defaults to 1" then the 1 means true.

Field Verification

For each of ITEM, LOCATION, and DESCRIPTION, the following keywords are supported.

Keyword	Use
FORCE_..._PRESENT	Must be present or gives popup of error.
WARN_FOR_..._PRESENT	If not FORCE not specified and string is not present, give warning.
WARN_FOR_..._LENGTH	If length exceeds MAXIMUM_..._LENGTH, give warning.  This is now deprecated - use totalLength above which gives a better check.
WARN_FOR_..._CAPITALS	If percentage of capitals in string exceeds MAXIMUM_..._CAPS_PERCENTAGE, give warning.

Error messages for the above are:

• string00 to string03 for ITEM
• string04 to string07 for LOCATION
• string08 to string11 for DESCRIPTION

For DESCRIPTION, there is also:

Enabler	Verifier	Warning	Description
WARN_FOR_DIGITS	PHONE_DIGITS	PHONE_DIGITS_WARNING	If enabled and contains this many consecutive digits, pop up a warning.