DELETE from blocks WHERE bid="sub_email_success" AND category = "email"; ALTER TABLE blocks DROP PRIMARY KEY, ADD PRIMARY KEY(bid,theme,language); UPDATE blocks SET category="Admin Pages" WHERE bid="admin_boxes_form"; UPDATE blocks SET description="

This block is used to create the Box Admin Tool page. It must contain all of the form elements used in the Box Admin page, and should be self-contained HTML. The special keys recognised are:

\n
\n
admin_boxes_errormsg
\n
A message indicating whether a save was successful or not, and if not, the text of the error message
\n
admin_boxes_box_menu
\n
The select box used to choose a box to edit
\n
admin_boxes_delete_check
\n
The delete checkbox displayed when a box is being edited
\n
admin_boxes_template_menu
\n
The select box used to choose the box template to use for a particular box
\n
admin_boxes_template_link
\n
A link to the block admin tool to edit the box template selected for the box currently being edited
\n
admin_boxes_choose_checked
\n
The \"checked\" status of the checkbox which determines whether or not the users can choose to show or hide that particular box in their display preferences
\n
admin_boxes_boxid
\n
The name of the box currently being edited
\n
admin_boxes_title
\n
The title of the box currently being edited
\n
admin_boxes_description
\n
The description of the box currently being edited
\n
admin_boxes_content
\n
The perl code of the box currently being edited
\n
\n

Do not change the names of the form elements, or remove any form elements, or box editing may fail in unexpected ways.

" WHERE bid="admin_boxes_form"; UPDATE blocks SET category="Page Templates" WHERE bid="admin_template"; UPDATE blocks SET description="This block is used to build most pages on the site. It must be a full HTML page; dynamic content is added through the use of special keys. The special keys recognised are:

\n
\n
subtitle
\n
This is replaced with an appropriate subtitle indicating which page is currently being viewed.
\n
CONTENT
\n
This is replaced with any other content specific to the page being requested. It is provided by the function or box named in the Ops Admin Tool which handles the op (the first pseudo-directory) of the page.

\n

This block is used to create the Admin Tools pages, including the Blocks Admin Tool, so be very careful when changing it. If you break this block, you will not be able to use any of the Admin Tools anymore and will not be able to fix it without going directly to the database.

" WHERE bid="admin_template"; UPDATE blocks SET category="Ads" WHERE bid="advertising_account_disclaimer"; UPDATE blocks SET description="

This block is displayed in the form that collects extra information from advertisers when they create an \"advertiser account\". It is only relevant if the variable req_extra_advertiser_info is set to 1. It should contain whatever extra terms your site requires of an advertising account, if they are distinguished from regular accounts. There are no special keys.

" WHERE bid="advertising_account_disclaimer"; UPDATE blocks SET category="Ads,Emails" WHERE bid="ad_approval_mail"; UPDATE blocks SET description="

This block is emailed to a user when an advertisement he submitted has been approved by a site admin. It should be plain text and say that the ad has been approved. The special keys recognised are:

\n
\n
REASON
\n
The reason given by the administrator when approving the ad, if any
\n
TITLE
\n
The title of the advertisement approved
\n
TEXT1
\n
The \"TEXT1\" field of the advertisement approved
\n
URL
\n
The url the advertisement points to
\n
VIEWS_LEFT
\n
The number of impressions remaining
\n
IMPRESSIONS
\n
The number of impressions to buy (only used in ad renewal, which is yet another unimplemented ad features)
\n
AD_ID
\n
The internal ID number of the advertisement approved
\n
sitename
\n
The contents of the variable sitename
\n
site_url
\n
The contents of the variable site_url
\n
local_email
\n
The contents of the variable local_email
\n
\n

The last three are not technically special keys, but since emails are not sent through the normal page processing, keys are not substituted normally. No keys other than the ones listed here will be interpolated. Not all available keys are necessarily relevant.

" WHERE bid="ad_approval_mail"; UPDATE blocks SET category="Ads" WHERE bid="ad_confirm_text"; UPDATE blocks SET description="

This block is displayed on the advertisement preview screen when a user is submitting an ad. It should be a self-contained bit of text and should explain how to make changes if the previewed ad is not what the submittor wanted, and how to purchase if it is. There are no special keys.

" WHERE bid="ad_confirm_text"; UPDATE blocks SET category="Ads,Emails" WHERE bid="ad_disapproval_mail"; UPDATE blocks SET description="

This block is emailed to a user when an advertisement he submitted has been disapproved by a site admin. It should be plain text and say that the ad has been disapproved. The special keys recognised are:

\n
\n
REASON
\n
The reason given by the administrator when disapproving the ad, if any
\n
TITLE
\n
The title of the advertisement disapproved
\n
TEXT1
\n
The \"TEXT1\" field of the advertisement disapproved
\n
URL
\n
The url the advertisement points to
\n
VIEWS_LEFT
\n
The number of impressions remaining
\n
IMPRESSIONS
\n
The number of impressions to buy (only used in ad renewals, which is yet another unimplemented ad feature)
\n
AD_ID
\n
The internal ID number of the advertisement disapproved
\n
sitename
\n
The contents of the variable sitename
\n
site_url
\n
The contents of the variable site_url
\n
local_email
\n
The contents of the variable local_email
\n
\n

The last three are not technically special keys, but since emails are not sent through the normal page processing, keys are not substituted normally. No keys other than the ones listed here will be interpolated. Not all available keys are necessarily relevant.

" WHERE bid="ad_disapproval_mail"; UPDATE blocks SET category="Ads,Emails" WHERE bid="ad_renewal_mail"; UPDATE blocks SET description="not used. Yet another unimplemented ad feature." WHERE bid="ad_renewal_mail"; UPDATE blocks SET category="Ads" WHERE bid="ad_step1_rules"; UPDATE blocks SET description="

This block is displayed as the first step when a user starts submitting ads. It should be self-contained HTML, and should explain all of the rules, terms, and conditions for ad submission before the actual submission process begins.

\n

There is one special key: NEXT_LINK which is the \"I agree\" button.

" WHERE bid="ad_step1_rules"; UPDATE blocks SET category="Ads" WHERE bid="ad_submit_help"; UPDATE blocks SET description="

This block is displayed at the bottom of ad submission step 3. It should be self-contained HTML, and should contain general instructions for ad submission. There are no special keys.

" WHERE bid="ad_submit_help"; UPDATE blocks SET category="Ads,Page Templates" WHERE bid="ad_test_template"; UPDATE blocks SET description="

This block is used to display a single ad for preview purposes without counting impressions. It must be a complete HTML page, and should contain a call to the show_ad box. There are no special keys.

" WHERE bid="ad_test_template"; UPDATE blocks SET category="Polls,Stories" WHERE bid="attach_poll_message"; UPDATE blocks SET description="

This block is displayed below the story submission form and above the attached poll submission form. It should be self-contained HTML and should contain an explanation of polls attached to stories. There are no special keys.

" WHERE bid="attach_poll_message"; UPDATE blocks SET category="Stories" WHERE bid="author_edit_console"; UPDATE blocks SET description="

This block is displayed below a story in the queue for the author only. It should be self-contained HTML, and should explain the process for cancelling stories. The special keys recognised are:

\n
\n
author_edit_form
\n
The form including the delete checkbox and the edit button if the story is in the edit queue
\n
author_edit_instructions
\n
Instructions to the author for the editing process, displayed only if the story is in the edit queue. The contents are taken from the block author_edit_instructions
\n
" WHERE bid="author_edit_console"; UPDATE blocks SET category="General" WHERE bid="bars"; UPDATE blocks SET description="

This block is used as a separator in the page title. It should be short and have no HTML tags in it. There are no special keys.

" WHERE bid="bars"; UPDATE blocks SET category="Box Templates" WHERE bid="blank_box"; UPDATE blocks SET description="

This block is used to provide a container for box output, and is not used directly in the page templates. It should be self-contained HTML, and provide a \"blank\" frame for the box output. The special keys recognised are:

\n
\n
title
\n
The title of the box; if the box code returns a value for the title, that is used, otherwise the title field set in the Boxes Admin Tool is used
\n
content
\n
The main body of the box. This is the only thing the box code must return; if the box returns nothing or an empty string, the entire box (and its template) is not displayed at all
\n
bid
\n
The internal name for the box.
\n
" WHERE bid="blank_box"; UPDATE blocks SET category="Page Templates" WHERE bid="blank_template"; UPDATE blocks SET description="

This block is a complete, blank HTML page. No header, footer, or CONTENT. It must be a complete HTML page. This template is used for commands which do not display pages, such as the logout or redirect ops.

" WHERE bid="blank_template"; UPDATE blocks SET category="Admin Pages" WHERE bid="block_category_list"; UPDATE blocks SET description="

This block is used to build the list of category links in the Blocks Admin Tool. It is repeated as many times as necessary to display all the categories. It should contain a complete single line (by default a table row) that can be inserted into the containing block (by default a table with no rows) present in the block edit_block (This block is placed as many times as necessary in the spot designated by the special key catlist). Multiple instances of the special keys listed below are permitted in this block. The special keys recognised are:

\n
\n
item_url
\n
The url-safe name of the category; you must insert it into the URL of the hyperlink yourself.
\n
item
\n
The display name of the category, typically used as the text of the hyperlink
\n
" WHERE bid="block_category_list"; UPDATE blocks SET category="Box Templates" WHERE bid="box"; UPDATE blocks SET description="

This block is used to provide a container for box output, and is not used directly in the page templates. It should be self-contained HTML, and provide the frame seen around the boxes in the sidebar. The special keys recognised are:

\n
\n
title
\n
The title of the box; if the box code returns a value for the title, that is used, otherwise the title field set in the Boxes Admin Tool is used
\n
content
\n
The main body of the box. This is the only thing the box code must return; if the box returns nothing or an empty string, the entire box (and its template) is not displayed at all
\n
bid
\n
The internal name for the box.
\n
" WHERE bid="box"; UPDATE blocks SET category="Colours" WHERE bid="box_title_bg"; UPDATE blocks SET description="

This block is used wherever a colour value is needed to set the colour of the sidebar box title bars. It should be a hex colour value, including the #, such as #000000 for black. There are no special keys.

" WHERE bid="box_title_bg"; UPDATE blocks SET category="Fonts" WHERE bid="box_title_font"; UPDATE blocks SET description="

This block is used in box templates before the box title. It should be a complete opening font or text style indicator, such as a font or b tag. It must be properly closed by the contents of the block box_title_font_end. There are no special keys.

" WHERE bid="box_title_font"; UPDATE blocks SET category="Fonts" WHERE bid="box_title_font_end"; UPDATE blocks SET description="

This block is used in box templates after the box title. It should be a complete closing font or text style indicator, such as a closing font or b tag. It must properly close the tags opened in the block box_title_font. There are no special keys.

" WHERE bid="box_title_font_end"; UPDATE blocks SET category="Ads" WHERE bid="buy_ad_impression_message"; UPDATE blocks SET description="not used. Yet another unimplemented ad feature." WHERE bid="buy_ad_impression_message"; UPDATE blocks SET category="Comments" WHERE bid="comment"; UPDATE blocks SET description="

This block is used to format each topical comment attached to a story or poll. It is not used directly in any block, but is called repeatedly in the code, once for each topical comment displayed. (Editorial comments use the block moderation_comment). This should be a self-contained chunk of HTML code that can be nested arbitrarily deep. The special keys recognised are:

\n
\n
uid
\n
The numeric user ID of the comment poster
\n
edit_user
\n
The edit user link, only displayed if the user viewing the page has the perm edit_user.
\n
name
\n
The nickname of the comment poster
\n
date
\n
A formatted time/date string
\n
subject
\n
The subject of the comment
\n
new
\n
The contents of the block new_comment_marker, if the comment is not yet marked as read for the user viewing the comment. Use this, not new_comment_marker, in this block.
\n
member
\n
The contents of the block mark_(groupname), if it exists for the poster's group
\n
sig
\n
The user's signature, if one is set.
\n
rating_format
\n
If ratings are turned off, or the user chooses not to see ratings, this is blanked; if ratings should be displayed, this is replaced with the contents of the block rating_format which may use the special keys score and num_ratings to display the current ratings.
\n
comment
\n
The body of the comment
\n
cid
\n
The comment ID. This plus the sid uniquely identifies each comment.
\n
actions
\n
The parent, reply, delete, toggle, and dynamic mode expand and collapse links; each part according to permissions.
\n
user_info
\n
A link to the comment poster's user info page.
\n
sid
\n
The story ID. This plus the cid uniquely identifies each comment; this alone uniquely identifies each story or poll.
\n
score
\n
The comment's current score, an average of all the ratings.
\n
num_ratings
\n
The number of ratings given to the comment.
\n
email
\n
The user's \"fake email\" from their user preferences in a mailto: link, if present
\n
url
\n
The user's homepage from their user preferences in a link, if present
\n
replies
\n
All comment replies. If in threaded or minimal, this is formatted as just the subject; if in nested, this is formatted as the full comment.
\n
" WHERE bid="comment"; UPDATE blocks SET category="Comments" WHERE bid="commentdisclaimer"; UPDATE blocks SET description="

This block is displayed just above the comment posting form. Put whatever message or warning you want displayed every time somebody posts a comment. This should be self-contained HTML. There are no special keys.

" WHERE bid="commentdisclaimer"; UPDATE blocks SET category="Colours" WHERE bid="comment_head_bg"; UPDATE blocks SET description="

This block is used wherever a colour value is needed to set the background colour of the comment header (which typically contains the subject and poster's information, but not the comment itself). It should be a hex colour value, including the #, such as #000000 for black. There are no special keys.

" WHERE bid="comment_head_bg"; UPDATE blocks SET category="Comments" WHERE bid="comment_num_format_end"; UPDATE blocks SET description="

This block is used just after the number of total comments attached to a story. It should be a complete closing font or text style indicator, such as a font or b tag. It must properly close the tags opened by the contents of the block comment_num_format_start. There are no special keys.

" WHERE bid="comment_num_format_end"; UPDATE blocks SET category="Comments" WHERE bid="comment_num_format_start"; UPDATE blocks SET description="

This block is used just before the number of total comments attached to a story. It should be a complete opening font or text style indicator, such as a font or b tag. It must be properly closed by the contents of the block comment_num_format_end. There are no special keys.

" WHERE bid="comment_num_format_start"; UPDATE blocks SET category="Comments" WHERE bid="comment_plural"; UPDATE blocks SET description="

This block is used to provide a plural suffix if there is more than one comment attached to a story. It is simply appended to the value in comment_word where appropriate. There are no special keys.

" WHERE bid="comment_plural"; UPDATE blocks SET category="Comments" WHERE bid="comment_posted_message"; UPDATE blocks SET description="

This block is displayed after a user has successfully posted a message. It should contain a message telling the user so. The table structure in this block should not be changed as it is very much not self-contained and is like that in the code as well. Ugly ugly ugly. There are no special keys.

" WHERE bid="comment_posted_message"; UPDATE blocks SET category="Comments" WHERE bid="comment_word"; UPDATE blocks SET description="

This block contains the word used for comments in the comment count on the front page. This should be the singular form; the plural suffix is set in the block comment_plural. There are no special keys.

" WHERE bid="comment_word"; UPDATE blocks SET category="Ads" WHERE bid="confirm_ad_renew"; UPDATE blocks SET description="

This block is used during the final confirmation step of ad renewal. It should be reasonably self-contained HTML and contain a message explaining that this is the final confirmation step before the ad renewal is actually processed. There are no special keys. Ad renewal is yet another unimplemented ad feature.

" WHERE bid="confirm_ad_renew"; UPDATE blocks SET category="Ads" WHERE bid="confirm_purchase_impressions"; UPDATE blocks SET description="yet another unimplemented ad feature" WHERE bid="confirm_purchase_impressions"; UPDATE blocks SET category="Page Templates" WHERE bid="content_only_page_template"; UPDATE blocks SET description="

This block can be used where you want Scoop to output only the content, with no HTML page wrapper at all. It should contain only the special key CONTENT and nothing else. The special key CONTENT is replaced with the output of whichever function or box is run using this block as its page template (see the Ops Admin Tool).

" WHERE bid="content_only_page_template"; UPDATE blocks SET category="Page Templates" WHERE bid="cron_template"; UPDATE blocks SET description="

This block is used to format Scoop's cron system output. It parsed by run_cron.pl and should not be changed as neither users nor administrators ever use it directly.

" WHERE bid="cron_template"; UPDATE blocks SET category="Page Templates" WHERE bid="default_template"; UPDATE blocks SET description="

This block is used to build most pages on the site. It must be a full HTML page; dynamic content is added through the use of special keys. The special keys recognised are:

\n
\n
subtitle
\n
This is replaced with an appropriate subtitle indicating which page is currently being viewed.
\n
dynamicmode_javascript
\n
This is replaced with javascript for the dynamic comment display if the page template is being used for comment display.
\n
STORY
\n
This is replaced with either the poll display or the story display, if either are being viewed.
\n
CONTENT
\n
This is replaced with any other content specific to the page being requested. It is provided by the function or box named in the Ops Admin Tool which handles the op (the first pseudo-directory) of the page. This can be forms, comments, special pages, or custom content from your own boxes.
\n
" WHERE bid="default_template"; UPDATE blocks SET category="Fonts" WHERE bid="dept_font"; UPDATE blocks SET description="

This block is used to format the \"from the x department\" string attached to stories, if the variable show_dept is turned on. It should be a complete opening font or text style indicator, such as a font or b tag. It must be properly closed by the contents of the block dept_font_end. There are no special keys.

" WHERE bid="dept_font"; UPDATE blocks SET category="Diaries" WHERE bid="diary_submission_message"; UPDATE blocks SET description="

This block is displayed just underneath a user's diary when they have just posted it. It should contain a message informing the user that their diary was successfully saved, and is otherwise free-form, self-contained HTML. There are no special keys.

" WHERE bid="diary_submission_message"; UPDATE blocks SET category="Story Digests" WHERE bid="digest_headerfooter"; UPDATE blocks SET description="

This block is displayed at the top and bottom of the story digest email sent to users who request it. It should name the site and introduce the digest in a way suited for any frequency. This should be plain text, with no HTML formatting. If either of the blocks digest_header or digest_footer exist, they override this block for the email header and footer, respectively. Because this is an email and is not sent through the usual processing given an HTML page, the only keys that work at all are the special keys defined for this block. The following special keys are recognised:

\n
\n
FREQUENCY
\n
This key is replaced with the digest frequency requested by the user receiving the email, which may be daily, weekly, or monthly.
\n
USERID
\n
The numeric user ID of the recipient of the digest
\n
NICKNAME
\n
The nickname of the recipient of the digest
\n
" WHERE bid="digest_headerfooter"; UPDATE blocks SET category="Story Digests" WHERE bid="digest_storyformat"; UPDATE blocks SET description="

This block is used to format each story summary in the story digest email sent to users who request it. This should be plain text, with no HTML formatting. Because this is an email and is not sent through the usual processing given an HTML page, the only keys that work at all are the special keys defined for this block. The following special keys are recognised:

\n
\n
sid
\n
The story ID for the story being formatted. This is used in url (below) to create the full URL of the story and probably isn't needed on its own.
\n
tid
\n
The \"alt text\" of the topic attached to the story.
\n
aid
\n
The author's nickname.
\n
nick
\n
The author's nickname.
\n
time
\n
The time and date the story was posted on.
\n
title
\n
The title of the story
\n
dept
\n
The \"department\" of the story, if that feature is turned on in Site Controls (show_dept).
\n
introtext
\n
The story summary; that part of the story that is displayed on the index page of the scoop site. HTML line breaks are converted to newlines, links have their URL displayed beside the link text, and all other HTML tags are stripped. The intro text is then wrapped to 75 columns.
\n
section
\n
The title of the section the story is filed in.
\n
url
\n
The full URL of the story, built from the site's base URL and the story's sid.
\n
\n" WHERE bid="digest_storyformat"; UPDATE blocks SET category="Story Digests" WHERE bid="digest_subject"; UPDATE blocks SET description="

This block is used as the subject line of the story digest email sent to users who request it. This should be plain text, with no HTML formatting. Because this is an email and is not sent through the usual processing given an HTML page, none of the usual keys will work. This block has no special keys.

" WHERE bid="digest_subject"; UPDATE blocks SET category="Emails" WHERE bid="donate_email_pledge"; UPDATE blocks SET description="

This block is an email sent to a user who has pledged to send a donation. It should be plain text and contain the amount the user has pledged and a reminder to send the amount. Putting the mailing address in this block is probably a good idea too. Because this is an email and is not sent through the usual processing given an HTML page, no keys except the following special keys will work.

\n
\n
AMOUNT
\n
The amount pledged.
\n
" WHERE bid="donate_email_pledge"; UPDATE blocks SET category="Emails" WHERE bid="donate_email_success"; UPDATE blocks SET description="

This block is an email sent to a user who has made a donation. It should be plain text and indicate that the donation has been received. Because this is an email and is not sent through the usual processing given an HTML page, no keys except the following special keys will work.

\n
\n
AMOUNT
\n
The amount donated.
\n
" WHERE bid="donate_email_success"; UPDATE blocks SET category="General" WHERE bid="dot"; UPDATE blocks SET description="

This block is used whenever a dot or list item indicator of some sort is needed. It is called directly by other blocks, never assembled as part of a special key, and recognizes no special keys itself.

" WHERE bid="dot"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_collapse_bottom_link"; UPDATE blocks SET description="

This block should contain either the text or an image used as the link to collapse a comment when expanded comments are viewed in either of the dynamic modes. If it is an image, it should have an alt element to stand in if the image is missing. It is placed with the actions at the bottom of the comment; the block dynamic_collapse_link is the one placed at the top. This block has no special keys.

" WHERE bid="dynamic_collapse_bottom_link"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_collapse_link"; UPDATE blocks SET description="

This block should contain either the text or an image used as the link to collapse a comment when expanded comments are viewed in either of the dynamic modes. If it is an image, it should have an alt element to stand in if the image is missing. It is placed near the subject at the top of the comment; the block dynamic_collapse_bottom_link is the one used at the bottom. This block has no special keys.

" WHERE bid="dynamic_collapse_link"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_collapse_thread_link"; UPDATE blocks SET description="

This block should contain either the text or an image used as the link to collapse an entire subthread of comments when expanded comments are viewed in either of the dynamic modes. If it is an image, it should have an alt element to stand in if the image is missing. It is placed with the actions at the bottom of the comment. This block has no special keys.

" WHERE bid="dynamic_collapse_thread_link"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_expand_link"; UPDATE blocks SET description="

This block should contain either the text or an image used as the link to expand a single comment when viewing comments in either of the dynamic modes. If it is an image, it should have an alt element to stand in if the image is missing. It is placed near the subject at the top of the comment. This block has no special keys.

" WHERE bid="dynamic_expand_link"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_expand_thread_link"; UPDATE blocks SET description="

This block should contain either the text or an image used as the link to expand an entire subthread of comments when comments are viewed in either of the dynamic modes. If it is an image, it should have an alt element to stand in if the image is missing. It is placed with the actions at the bottom of the comment. This block has no special keys.

" WHERE bid="dynamic_expand_thread_link"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_js_tag"; UPDATE blocks SET description="

This block is what allows dynamic comments to work. On pages where comments are viewed and dynamic comment mode is active, the key |dynamicmode_javascript| is replaced with the contents of this block. (That key is best placed in the header block, so it is always available.) This block should only be modified to reflect the location of the dynamic-comments.js file, which it loads. This block has no special keys." WHERE bid="dynamic_js_tag"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_loading_link"; UPDATE blocks SET description="

This block contains the image tag that will replace the expand/collapse link when a comment is in the process of being loaded/unloaded. This shouldn't actually be a link, just a marker of the same size and format as dynamic_expand_link and dynamic_collapse_link. This block has no special keys.

" WHERE bid="dynamic_loading_link"; UPDATE blocks SET category="Comments" WHERE bid="dynamic_loading_message"; UPDATE blocks SET description="

This block contains the message that will replace the comment title or comment when that comment is in the process of being loaded or unloaded. This should be small and indicate that Scoop is working on it and the comment or comment title will appear shortly.

" WHERE bid="dynamic_loading_message"; UPDATE blocks SET category="Comments,Page Templates" WHERE bid="dynamic_template"; UPDATE blocks SET description="

This block is a nearly empty page template used for loading individual comments in dynamic mode. It must contain the correct BODY onload event. You probably shouldn't change this, since it will never be seen directly anyway. There are two special keys: mainpid and dynamicmode; both are set by the code to indicate whether or not dynamic comments are in use.

" WHERE bid="dynamic_template"; UPDATE blocks SET category="Colours" WHERE bid="editqueuespam_bg"; UPDATE blocks SET description="

This block is used as a background colour in the story list for stories in the edit queue that the user has voted \"Spam\" on, to make it easy to remember which ones they can safely ignore while they remain in the edit queue. It should contain a hex colour value or a recognized colour name. It only applies if both the edit queue and the edit queue anti-spam button are turned on. This block has no special keys.

" WHERE bid="editqueuespam_bg"; UPDATE blocks SET category="Colours" WHERE bid="editqueuestory_bg"; UPDATE blocks SET description="

This block is used as a background colour in the story list for stories in the edit queue, to distinguish them from stories that may be voted on. It should contain a hex colour value or a recognized colour name.It only applies if the edit queue is turned on. This block has no special keys.

" WHERE bid="editqueuestory_bg"; UPDATE blocks SET category="Admin Pages" WHERE bid="edit_block"; UPDATE blocks SET description="

This block is used to build the block editing form. It should contain the admin page structure, set up the form, and contain all of the special keys listed below to ensure that block editing is not broken. This block recognizes the following special keys:

\n
\n
catlist
\n
The list of all block categories in the current theme, linkified to bring you to the form with all blocks in that category within the current theme. The list itself is built using the block block_category_list as many times as necessary to display all of the categories.
\n
category
\n
Either the block name or the category name (depending on whether you're in single block or category edit mode) and the name of the theme you're currently working in, just so it's easier to remember where you are.
\n
update_msg
\n
Any save, status, or error messages generated due to one of your actions in this admin tool.
\n
theme_sel
\n
The list of themes across the top of the page that allows you to switch between which theme you're working in. The current theme is not linkified, all others are.
\n
html_check
\n
The checkbox that determines if Scoop should check the HTML of the block when saving. Valid HTML is determined by the block all_html.
\n
form_body
\n
The body of the block editing form. This will either be the single block form from edit_one_block or the category edit form from edit_cat_blocks, depending on whether you are editing one block or an entire category.
\n
\n

Be very careful when changing this block, as it is used to build the interface required to change it back if it is broken. Changing the form elements is strongly not recommended.

" WHERE bid="edit_block"; UPDATE blocks SET category="Admin Pages" WHERE bid="edit_cat_blocks"; UPDATE blocks SET description="

This block is used to build the block editing form when in category view. It should contain one line of the category view (that is, the code for one block only). This block recognizes the following special keys:

\n
\n
name
\n
The name of the block, formatted as a link to the single block edit form for that block.
\n
value
\n
A textarea field containing the value of the block.
\n
description
\n
The block description.
\n
" WHERE bid="edit_cat_blocks"; UPDATE blocks SET category="Admin Pages" WHERE bid="edit_cat_vars"; UPDATE blocks SET description="

This block is used to build the Site Control editing form when in category view. It should contain one line of the category view (that is, the code for one variable only). This block recognizes the following special keys:

\n
\n
name
\n
The name of the variable, formatted as a link to the single variable edit form for that variable.
\n
value
\n
A field containing the value of the variable. Depending on the variable type, this may be a checkbox (boolean), a short text field (number), a longer text field (text), or a textarea field (textarea).
\n
description
\n
The variable description.
\n
" WHERE bid="edit_cat_vars"; UPDATE blocks SET category="Stories" WHERE bid="edit_instructions"; UPDATE blocks SET description="

This block is displayed underneath the text of a story in the edit queue, informing readers of its status. This should be a reasonably self-contained bit of HTML and text which explains the process of story editing from the point of view of a reader who is not the author. This block recognizes the following special key:

\n
\n
spam_form
\n
This is replaced with the contents of edit_instructions_abuse if the edit queue anti-spam feature is turned on.
\n
" WHERE bid="edit_instructions"; UPDATE blocks SET category="Stories" WHERE bid="edit_instructions_abuse"; UPDATE blocks SET description="

This block is displayed underneath the text of a story in the edit queue, if the edit queue anti-spam feature is activated. This should be a reasonably self-contained bit of HTML which explains what the spam button is to be used for and sets up the form for the spam button. All of the hidden form elements are required. This block recognizes the following special keys:

\n
\n
sid
\n
The story ID of the current story.
\n
formkey
\n
A formkey element used to help prevent duplicate votes, scripted votes, and other form spoofing strategies.
\n
" WHERE bid="edit_instructions_abuse"; UPDATE blocks SET category="Admin Pages" WHERE bid="edit_one_block"; UPDATE blocks SET description="

This block is used to build the single block edit form for the Blocks Admin Tool. It contains the form elements and special keys required for block editing to work. This block recognizes the following special keys:

\n
\n
blockselect
\n
The select form element listing all the blocks available to edit.
\n
catselect
\n
The select form element listing all the categories available to file a block in.
\n
bid
\n
The name of the block (block ID).
\n
value
\n
The value of the block.
\n
theme
\n
The name of the theme the block should be saved in.
\n
curr_theme
\n
The name of the theme you are currently working in. If a new block is created and the theme (above) is left empty, this value is used in its place, so blocks are created where you'd expect them.
\n
description
\n
The description of the block.
\n
" WHERE bid="edit_one_block"; UPDATE blocks SET category="Admin Pages" WHERE bid="edit_one_var"; UPDATE blocks SET description="

This block is used to build the single variable edit form for the Site Controls Admin Tool. It contains the form elements and special keys required for variable editing to work. This block recognizes the following special keys:

\n
\n
varselect
\n
The select form element listing all the variables available to edit.
\n
catselect
\n
The select form element listing all the categories available to file a variable in.
\n
name
\n
The name of the variable.
\n
value
\n
The value of the variable.
\n
typeselect
\n
The select form element listing the possible variable types.
\n
description
\n
The description of the variable.
\n
" WHERE bid="edit_one_var"; UPDATE blocks SET category="Admin Pages" WHERE bid="edit_ops"; UPDATE blocks SET description="

This block is used to build the ops editing form. It should contain the admin page structure, set up the form, and contain all of the special keys listed below to ensure that op editing is not broken. This block recognizes the following special keys:

\n
\n
msg
\n
Status or error messages from the update just performed.
\n
op_list
\n
The drop-down box containing all of the ops in the system.
\n
opcode
\n
The name of the currently loaded op. Not a form field, just the value.
\n
tmpl_list
\n
The drop-down box containing all of the page templates (blocks ending in _template)
\n
func
\n
The name of the function or box run when the currently loaded op is requested. Not a form field, just the value.
\n
is_box_checked
\n
The \"checked\" property of the checkbox that determines whether or not the function named above is a box or not. Not a form field, just the value.
\n
perm_list
\n
The drop-down box containing all of the permissions in the system.
\n
aliases
\n
The aliases of the currently loaded op. Not a form field, just the value.
\n
urltemplates
\n
The URL templates of the currently loaded op. Not a form field, just the value.
\n
enabled_checked
\n
The \"checked\" property of the checkbox that determines whether or not the currently loaded op is enabled. Not a form field, just the value.
\n
desc
\n
The description of the currently loaded op. Not a form field, just the value.
\n
delete_check
\n
If an op is loaded, this is replaced with a table row containing the delete checkbox and label. Otherwise, it's removed.
\n
edit_box
\n
A link to the Boxes Admin Tool and the box associated with the currently loaded op, if the function named is marked as being a box and that box exists in the database.
\n
" WHERE bid="edit_ops"; UPDATE blocks SET category="Admin Pages" WHERE bid="edit_var"; UPDATE blocks SET description="

This block is used to build the Site Controls editing form. It should contain the admin page structure, set up the form, and contain all of the special keys listed below to ensure that variable editing is not broken. This block recognizes the following special keys:

\n
\n
catlist
\n
The list of all variable categories, linkified to bring you to the form with all variables in that category. The list itself is built using the block var_category_list as many times as necessary to display all of the categories.
\n
category
\n
The name of the category you're currently editing.
\n
update_msg
\n
Any save, status, or error messages generated due to one of your actions in this admin tool.
\n
form_body
\n
The body of the variable editing form. This will either be the single variable form from edit_one_var or the category edit form from edit_cat_vars, depending on whether you are editing one variable or an entire category.
\n
" WHERE bid="edit_var"; UPDATE blocks SET category="Box Templates" WHERE bid="empty_box"; UPDATE blocks SET description="

This block is a box template that should have absolutely nothing but the content special key in it, so that the box output has no frame and will not mess up the formatting of whatever part of the page it's placed on. The special key content is replaced with the output of whichever box uses it as a wrapper.

" WHERE bid="empty_box"; UPDATE blocks SET category="Page Templates" WHERE bid="error_template"; UPDATE blocks SET description="

The HTML output generated by Scoop if it runs into certain types of errors. Don't change this, except maybe to put your email address in it and ask the user to send you a copy of the text in the page. Everything on this page is a special key.

" WHERE bid="error_template"; UPDATE blocks SET category="General" WHERE bid="footer"; UPDATE blocks SET description="

This block is used at the bottom of each page. It should be fairly self-contained HTML, and contain any copyright notices and badges you want displayed at the bottom of all pages. This block has no special keys.

" WHERE bid="footer"; UPDATE blocks SET category="FZ" WHERE bid="fz_ad_url"; UPDATE blocks SET description="forumzilla support is going to be removed in the near future. Ignore this block." WHERE bid="fz_ad_url"; UPDATE blocks SET category="FZ" WHERE bid="fz_navigation_url"; UPDATE blocks SET description="forumzilla support is going to be removed in the near future. Ignore this block." WHERE bid="fz_navigation_url"; UPDATE blocks SET category="FZ" WHERE bid="fzdisplay_template"; UPDATE blocks SET description="forumzilla support is going to be removed in the near future. Ignore this block." WHERE bid="fzdisplay_template"; UPDATE blocks SET category="General" WHERE bid="header"; UPDATE blocks SET description="

This block is used at the top of each page. It should be fairly self-contained HTML, and contain any site-wide navigation you want displayed at the top of all pages. This block has one special key; dynamicmode_iframe is replaced with an IFRAME tag on pages displaying dynamic comments, and with nothing otherwise.

" WHERE bid="header"; UPDATE blocks SET category="Stories" WHERE bid="hotlist_link"; UPDATE blocks SET description="

This block is used as the text of the link used to add a story to a user\'s personal hotlist. It is only displayed to users who are logged in and who have not hotlisted that story; the block hotlist_remove_link is displayed to users who have already hotlisted the story. This block has no special keys.

" WHERE bid="hotlist_link"; UPDATE blocks SET category="Stories" WHERE bid="hotlist_remove_link"; UPDATE blocks SET description="

This block is used as the text of the link used to remove a story from a user\'s personal hotlist. It is only displayed to users who are logged in and who have hotlisted that story; the block hotlist_link is displayed to users who have not hotlisted the story. This block has no special keys.

" WHERE bid="hotlist_remove_link"; UPDATE blocks SET category="Page Templates" WHERE bid="index_template"; UPDATE blocks SET description="

This block is used to build the front and section story index pages. It must be a full HTML page; dynamic content is added through the use of special keys. The special keys recognised are:

\n
\n
subtitle
\n
This is replaced with the display name of the section being displayed.
\n
CONTENT
\n
This is replaced with the story summaries for all of the stories that should be displayed on this page. It is built using the block story_summary once for each story displayed.
\n
\n" WHERE bid="index_template"; UPDATE blocks SET category="Preferences" WHERE bid="interface_prefs_main_form"; UPDATE blocks SET description="

This block is used to build the page for the interface preferences form, one of the userprefs pages. It should be self-contained HTML and contain the page title and the special keys listed below:

\n
\n
nickname
\n
The nickname of the user changing his preferences
\n
title_msg
\n
Any error or status messages regarding the save
\n
interface_form
\n
The entire form containing all preferences supported by Scoop
\n
" WHERE bid="interface_prefs_main_form"; UPDATE blocks SET category="Accounts" WHERE bid="login_box"; UPDATE blocks SET description="

Despite its name, this is not a box template. It is an entire static box used to present the login form and new account link in place of the user box to a visitor who is not logged in. It should be self-contained HTML. It should contain the special key below:

\n
\n
LOGIN_ERROR
\n
The error message generated from a failed login attempt. The text and format of the error messages are set in the blocks login_error_message, login_mailed_message, or login_mail_failed, depending on which error was encountered.
\n
\n

The block must contain the following form elements or the login process will not work properly:

\n
\n
FORM
\n
The form should post to the root directory of your site.
\n
Username field
\n
The text input field must be named \"uname\"
\n
Password field
\n
The password input field must be named \"pass\"
\n
Login button
\n
The button that submits both above fields for login must be named \"login\"
\n
Mail forgotton password button
\n
The button that submits the username field for creation of a new password must be named \"mailpass\"
\n
" WHERE bid="login_box"; UPDATE blocks SET category="Accounts" WHERE bid="login_error_message"; UPDATE blocks SET description="

This is the error message displayed in the login_box if either the username or password (or both) are incorrect. This block contains the special key \"uname\" which is replaced with the username entered in the login form.

" WHERE bid="login_error_message"; UPDATE blocks SET category="Accounts" WHERE bid="login_mailed_message"; UPDATE blocks SET description="

This is the status message displayed in the login_box when a new password has successfully been mailed to the user. This block contains the special key \"uname\" which is replaced with the username entered in the login form.

" WHERE bid="login_mailed_message"; UPDATE blocks SET category="Accounts" WHERE bid="login_mail_failed"; UPDATE blocks SET description="

This is the error message displayed in the login_box when Scoop could not send the email containing the user's new password as requested. This block contains the special key \"uname\" which is replaced with the username entered in the login form.

" WHERE bid="login_mail_failed"; UPDATE blocks SET category="Ads,Emails" WHERE bid="mail_ad_almost_done_msg"; UPDATE blocks SET description="

This is the text of the email sent to the sponsor of an ad when his ad campaign is almost finished. Whether or not this email is sent at all is determined by the variable mail_ad_reminders. The number of impressions remaining when the email is sent is determined by the variable mail_ad_reminder_on. This block should have no HTML formatting, and recognizes no keys except the special keys listed below, as it is not sent through the normal page processing. The special keys recognized are:

\n
\n
sitename
\n
The value of the sitename variable
\n
site_url
\n
The value of the site_url variable
\n
local_email
\n
The value of the local_email variable
\n
TITLE
\n
The title of the advertisement
\n
TEXT1
\n
The text field of the advertisement
\n
URL
\n
The URL in the ads link
\n
VIEWS_LEFT
\n
The number of impressions remaining until the ad expires
\n
AD_ID
\n
The internal ID number of the ad
\n
" WHERE bid="mail_ad_almost_done_msg"; UPDATE blocks SET category="Ads,Emails" WHERE bid="mail_ad_done_msg"; UPDATE blocks SET description="

This is the text of the email sent to the sponsor of an ad when his ad campaign is finished. Whether or not this ad is sent at all is determined by the variable mail_ad_reminders and mail_ad_finished_reminder. Both must be on for the email to be sent. This reminder email is sent when the last impression is used up. For an advance warning, see the block mail_ad_almost_done_msg. This block should have no HTML formatting, and recognizes no keys except the special keys listed below, as it is not sent through the normal page processing. The special keys recognized are:

\n
\n
sitename
\n
The value of the sitename variable
\n
site_url
\n
The value of the site_url variable
\n
local_email
\n
The value of the local_email variable
\n
TITLE
\n
The title of the advertisement
\n
TEXT1
\n
The text field of the advertisement
\n
URL
\n
The URL in the ads link
\n
AD_ID
\n
The internal ID number of the ad
\n
" WHERE bid="mail_ad_done_msg"; UPDATE blocks SET category="Subscriptions" WHERE bid="mark_Subscribers"; UPDATE blocks SET description="

This block is inserted in the comment headers for users in the Subscribers group. It should be a small bit of self-contained HTML. It is placed with a special key in the blocks comment and moderation_comment. This block has no special keys." WHERE bid="mark_Subscribers"; UPDATE blocks SET category="Stories" WHERE bid="moderate_head"; UPDATE blocks SET description="

This block is used at the top of the story moderation form, after the user has voted on a story in the queue. It should be self-contained HTML, and summarize the story's current standing in the queue. The special keys recognized are:

\n
\n
score
\n
The story's current score.
\n
votes
\n
The total number of votes cast.
\n
" WHERE bid="moderate_head"; UPDATE blocks SET category="Comments" WHERE bid="moderation_comment"; UPDATE blocks SET description="

This block is used to format each editorial comment attached to a story or poll. It is not used directly in any block, but is called repeatedly in the code, once for each editorial comment displayed. (Topical comments use the block comment). This should be a self-contained chunk of HTML code that can be nested arbitrarily deep. The special keys recognised are:

\n
\n
uid
\n
The numeric user ID of the comment poster
\n
edit_user
\n
The edit user link, only displayed if the user viewing the page has the perm edit_user.
\n
name
\n
The nickname of the comment poster
\n
date
\n
A formatted time/date string
\n
subject
\n
The subject of the comment
\n
new
\n
The contents of the block new_comment_marker, if the comment is not yet marked as read for the user viewing the comment. Use this, not new_comment_marker, in this block.
\n
member
\n
The contents of the block mark_(groupname), if it exists for the poster's group
\n
sig
\n
The user's signature, if one is set.
\n
rating_format
\n
If ratings are turned off, or the user chooses not to see ratings, this is blanked; if ratings should be displayed, this is replaced with the contents of the block rating_format which may use the special keys score and num_ratings to display the current ratings.
\n
comment
\n
The body of the comment
\n
cid
\n
The comment ID. This plus the sid uniquely identifies each comment.
\n
actions
\n
The parent, reply, delete, toggle, and dynamic mode expand and collapse links; each part according to permissions.
\n
user_info
\n
A link to the comment poster's user info page.
\n
sid
\n
The story ID. This plus the cid uniquely identifies each comment; this alone uniquely identifies each story or poll.
\n
score
\n
The comment's current score, an average of all the ratings.
\n
num_ratings
\n
The number of ratings given to the comment.
\n
email
\n
The user's \"fake email\" from their user preferences in a mailto: link, if present
\n
url
\n
The user's homepage from their user preferences in a link, if present
\n
replies
\n
All comment replies. If in threaded or minimal, this is formatted as just the subject; if in nested, this is formatted as the full comment.
\n
" WHERE bid="moderation_comment"; UPDATE blocks SET category="Ads" WHERE bid="new_advertiser_html"; UPDATE blocks SET description="

This block is displayed on the account signup page if the user is creating an advertising account. This is yet another unimplemented ad feature. Advertising accounts are only partly implemented; for now, there is no automated way to collect extra information from advertisers.

" WHERE bid="new_advertiser_html"; UPDATE blocks SET category="Fonts" WHERE bid="new_comment_format_end"; UPDATE blocks SET description="

This block is used to format the number of new comments in a story on the index page. It should be a closing HTML tag that matches the formatting tag used in the block new_comment_format_start.

" WHERE bid="new_comment_format_end"; UPDATE blocks SET category="Fonts" WHERE bid="new_comment_format_start"; UPDATE blocks SET description="

This block is used to format the number of new comments in a story on the index page. It should be an opening HTML tag that matches the closing tag used in the block new_comment_format_end.

" WHERE bid="new_comment_format_start"; UPDATE blocks SET category="Comments" WHERE bid="new_comment_marker"; UPDATE blocks SET description="

This block is inserted in the comment if the user has not yet read this comment, according to Scoop's read-tracking system. It replaces the special key |new| in the blocks comment and moderation_comment.

" WHERE bid="new_comment_marker"; UPDATE blocks SET category="Stories" WHERE bid="new_story_marker"; UPDATE blocks SET description="

This block is inserted in the story summary if the user has not yet read this story, according to Scoop's read-tracking system. It replaces the special key |new| in the block story_summary.

" WHERE bid="new_story_marker"; UPDATE blocks SET category="General" WHERE bid="new_user_html"; UPDATE blocks SET description="

This block contains the explanation of the account creation process as well as the form the user fills in to create an account. It should be reasonably self-contained. It must contain the following form elements:

\n
\n
FORM
\n
The form should post to your site's rootdir.
\n
op
\n
This should be a hidden field with a value of \"newuser\".
\n
tool
\n
This should be a hidden field with a value of \"writeuser\".
\n
formkey
\n
This should be a hidden field with a value of \"|formkey|\" (see special keys, below).
\n
nickname
\n
This should be a text field with a default value of \"|uname|\" (see special keys, below).
\n
email
\n
This should be a text field with a default value of \"|email|\" (see special keys, below).
\n
button
\n
A submit button to send the fields in.
\n
\n

The following special keys are recognized:

\n
\n
error
\n
Any error messages (such as invalid characters in the nickname field).
\n
uname
\n
Usually blank; if there is an error with the email field, this is the nickname entered by the user.
\n
email
\n
Usually blank; if there is an error with the nickname field, this is the email address entered by the user.
\n
formkey
\n
A code-generated formkey used to hinder scripts trying to make large numbers of accounts.
\n
" WHERE bid="new_user_html"; UPDATE blocks SET category="General" WHERE bid="next_page_link"; UPDATE blocks SET description="

This block is the text of the link displayed at the bottom of the front and section index pages if there are more stories published earlier than those displayed. It should be self-contained HTML. The following special key is recognized:

\n
\n
maxstories
\n
The value of the variable maxstories, or the user preference \"Number of story summaries to show\" if set.
\n
" WHERE bid="next_page_link"; UPDATE blocks SET category="General" WHERE bid="next_previous_links"; UPDATE blocks SET description="

This block is used to create the next and previous page links at the top and bottom of the section index pages.

\nFIXME: not implemented correctly. Links won't disappear if not needed. Leave blank for now and it'll work." WHERE bid="next_previous_links"; UPDATE blocks SET category="Fonts" WHERE bid="norm_font"; UPDATE blocks SET description="

This block is used extensively in the default install. It should be a complete opening FONT tag. It must match the closing tag set in the block norm_font_end. If it is not a FONT tag, the user-selected font size and face from the display preferences page will not work properly.

" WHERE bid="norm_font"; UPDATE blocks SET category="Fonts" WHERE bid="norm_font_end"; UPDATE blocks SET description="

This block is used extensively in the default install. It should be a closing FONT tag, or otherwise close the tag opened in the block norm_font.

" WHERE bid="norm_font_end"; UPDATE blocks SET category="Fonts" WHERE bid="norm_font_face"; UPDATE blocks SET description="

The default font face used in a user's display preferences.

" WHERE bid="norm_font_face"; UPDATE blocks SET category="Fonts" WHERE bid="norm_font_size"; UPDATE blocks SET description="

The default font size used in a user's display preferences.

" WHERE bid="norm_font_size"; UPDATE blocks SET category="Stories" WHERE bid="no_body_txt"; UPDATE blocks SET description="

This block is used as the text of the link leading to the full story and comments, when there is no story body, only an intro. If there is a story body, the block readmore_txt is used instead.

" WHERE bid="no_body_txt"; UPDATE blocks SET category="Ads" WHERE bid="no_submit_ad_perm"; UPDATE blocks SET description="

This block is displayed if a user without the submit_ad perm (set in the Groups Admin Tool) tries to submit an ad. It should be customized depending on which criteria your site uses to determine who may submit advertisements.

" WHERE bid="no_submit_ad_perm"; UPDATE blocks SET category="Payments" WHERE bid="paypal_canceled"; UPDATE blocks SET description="

This block is displayed when an ad purchase paid via paypal is canceled. It should be self-contained HTML and should indicate that the order has been canceled.

" WHERE bid="paypal_canceled"; UPDATE blocks SET category="Payments" WHERE bid="paypal_finished"; UPDATE blocks SET description="

This block is displayed when an ad purchase paid via paypal is completed. It should be self-contained HTML and should indicate that payment has been received and the advertisement is pending approval by an administrator.

" WHERE bid="paypal_finished"; UPDATE blocks SET category="Polls" WHERE bid="poll_block"; UPDATE blocks SET description="

This block is used to format the poll results when displayed as the main content of the page. The following special keys are recognized:

\n
\n
title
\n
The poll question
\n
poll_image
\n
The poll results, with poll answers beside images representing the votes. The image file used is set in the block poll_img, and the width used to represent 100% is set in the block poll_img_width.
\n
" WHERE bid="poll_block"; UPDATE blocks SET category="Polls" WHERE bid="poll_img"; UPDATE blocks SET description="

This is the name of the file to use when building the poll image. The file should be in the images directory. The value of this block should not have any path information. The image is stretched horizontally to the desired width, so it should not have any horizontal detail that may be deformed.

" WHERE bid="poll_img"; UPDATE blocks SET category="Polls" WHERE bid="poll_img_width"; UPDATE blocks SET description="

This block determines the maximum width in pixels of the poll bar, and the width of the bar used for the poll option with 100% of the votes. All poll bar widths are percentages of this value corresponding to the percentage of votes the option received. It should be a number only.

" WHERE bid="poll_img_width"; UPDATE blocks SET category="Ads" WHERE bid="preview_text_ad_template"; UPDATE blocks SET description="

This block is used in conjunction with text_ad_template. It should be substantially the same, but set reasonable dimensions for the template. It is used when previewing ads. The special keys recognized are:

\n
\n
FILE_PATH
\n
The path to the image file used in the ad. This does not include the value set in the variable ad_server_url.
\n
TEXT1
\n
The text the ad sponsor entered in the text1 field.
\n
TEXT2
\n
The text the ad sponsor entered in the text2 field.
\n
TITLE
\n
The text the ad sponsor entered in the title field.
\n
LINK_URL
\n
The URL of the page being advertised.
\n
SID
\n
The story ID associated with the ad, if ad comments are active. See the Scoop Admin Guide for details on setting up ad comments.
\n
REDIRECT_URL
\n
The URL used in the actual link of the ad, for clickthrough counting. The URL of the page advertised is not required in the actual link, but you may put it there in a dummy cgi variable (such as url=) so users know where they're going.
\n
" WHERE bid="preview_text_ad_template"; UPDATE blocks SET category="General" WHERE bid="prev_page_link"; UPDATE blocks SET description="

This block is the text of the link displayed at the top and bottom of the front and section index pages if there are more stories published more recently than those displayed. It should be self-contained HTML. The following special key is recognized:

\n
\n
maxstories
\n
The value of the variable maxstories, or the user preference \"Number of story summaries to show\" if set.
\n
" WHERE bid="prev_page_link"; UPDATE blocks SET category="Comments" WHERE bid="rating_format"; UPDATE blocks SET description="

This block is used in the comment and moderation_comment blocks for the rating value display. This allows the entire rating value to disappear if the user has turned off ratings in their user preferences. The following special keys are recognized:

\n
\n
sid
\n
The story ID of the comment.
\n
cid
\n
The comment ID
\n
score
\n
The averaged score earned by the comment, or \"none\"
\n
num_ratings
\n
The number of people who have rated this comment.
\n
" WHERE bid="rating_format"; UPDATE blocks SET category="Stories" WHERE bid="readmore_txt"; UPDATE blocks SET description="

This block is used as the text of the link leading to the full story and comments, when there is a story body. If there is no story body, the block no_body_txt is used instead.

" WHERE bid="readmore_txt"; UPDATE blocks SET category="Ads" WHERE bid="renew_ad_message"; UPDATE blocks SET description="

This block is displayed on the ad renewal page. It should contain a message encouraging people to renew their ads. There are no special keys. Ad renewals are yet another unimplemented ad feature.

" WHERE bid="renew_ad_message"; UPDATE blocks SET category="Ads" WHERE bid="renew_ad_no_permission"; UPDATE blocks SET description="

This block is displayed if a user tries to renew somebody else's ad. It should contain a message indicating that a given account can only renew ads submitted by that same account. There are no special keys. Ad renewals are yet another unimplemented ad feature.

" WHERE bid="renew_ad_no_permission"; UPDATE blocks SET category="Ads" WHERE bid="renew_choose_ad"; UPDATE blocks SET description="

This block is displayed if a user tries to visit the ad renewal page without specifying which ad to renew. It should contain instructions for finding the ad renewal link. There are no special keys. Ad renewals are yet another unimplemented ad feature.

" WHERE bid="renew_choose_ad"; UPDATE blocks SET category="Ads" WHERE bid="renew_confirm_message"; UPDATE blocks SET description="not used. Yet another unimplemented ad feature." WHERE bid="renew_confirm_message"; UPDATE blocks SET category="FZ" WHERE bid="rss_box"; UPDATE blocks SET description="forumzilla support is going to be removed in the near future. Ignore this block." WHERE bid="rss_box"; UPDATE blocks SET category="FZ" WHERE bid="rss_template"; UPDATE blocks SET description="forumzilla support is going to be removed in the near fiture. Ignore this block." WHERE bid="rss_template"; UPDATE blocks SET category="General" WHERE bid="scoop_intro"; UPDATE blocks SET description="

This block contains introductory information and is displayed in the left column of the front page when you first install Scoop. There is useful information on where to get help in this block, so make a note of it before deleting. This block should not be displayed on a live site, because its content is of no interest except to the administrator.

" WHERE bid="scoop_intro"; UPDATE blocks SET category="Colours" WHERE bid="sectiononlystory_bg"; UPDATE blocks SET description="

This block is used as a row background colour in the Story List Admin Tool, for those stories that are published to section only, including ad stories and user diaries. This should be a hex colour value including the #, such as #000000 for black." WHERE bid="sectiononlystory_bg"; UPDATE blocks SET category="General" WHERE bid="section_links"; UPDATE blocks SET description="

This block contains the links to the different sections available on the site. It is typically displayed in the page header but can be used anywhere. Any sections that exist but aren't linked here are typically hard for visitors to find, so don't forget to update it when you change your sections.

" WHERE bid="section_links"; UPDATE blocks SET category="General" WHERE bid="slogan"; UPDATE blocks SET description="

This block is used in the browser's title bar. It should contain a witty saying that describes your site and should not contain the name of the site or any HTML formatting commands. It is only used on the site's index pages.

" WHERE bid="slogan"; UPDATE blocks SET category="Fonts" WHERE bid="smallfont"; UPDATE blocks SET description="

This block should be a complete opening FONT tag. It must match the closing tag set in the block smallfont_end.

" WHERE bid="smallfont"; UPDATE blocks SET category="Fonts" WHERE bid="smallfont_end"; UPDATE blocks SET description="

This block should be a closing FONT tag, or otherwise close the tag opened in the block smallfont.

" WHERE bid="smallfont_end"; UPDATE blocks SET category="Fonts" WHERE bid="spell_err"; UPDATE blocks SET description="

This block is used to format misspelled words if the spellchecking system is installed and active. It should be a complete opening font tag or other formatting tag. It should match its closing tag set in the block spell_err_end.

" WHERE bid="spell_err"; UPDATE blocks SET category="Fonts" WHERE bid="spell_err_end"; UPDATE blocks SET description="

This block is used to format misspelled words if the spellchecking system is installed and active. It should be a closing tag for whatever is in the block spell_err.

" WHERE bid="spell_err_end"; UPDATE blocks SET category="Stories" WHERE bid="story_body"; UPDATE blocks SET description="

This block is used to format the body (extended copy only) of a story. It should be self-contained HTML. It recognizes one special key, bodytext, which is replaced with the formatted contents of the extended copy field of the story.

" WHERE bid="story_body"; UPDATE blocks SET category="Stories" WHERE bid="story_info"; UPDATE blocks SET description="

This block displays information about the story and links to some of the things you can do. It recognizes one special key, story_info, which is replaced with the story name, number and type of comments, and the 'post a comment' and 'edit' links as permissions allow.

" WHERE bid="story_info"; UPDATE blocks SET category="Colours" WHERE bid="story_mod_bg"; UPDATE blocks SET description="

This block is used as a row background colour in the story voting queue. It is applied to stories in the voting queue that the user has not yet voted on. It should be a hex colour value, including the #.

" WHERE bid="story_mod_bg"; UPDATE blocks SET category="Colours" WHERE bid="story_nav_bg"; UPDATE blocks SET description="

This block is used as the background colour for the story navigation bar, which provides links to the next and previous stories at the bottom of the current story body. It should be a hex colour value, including the #.

" WHERE bid="story_nav_bg"; UPDATE blocks SET category="Stories" WHERE bid="story_separator"; UPDATE blocks SET description="

This block is placed between the story_summary and story_body blocks when building the story page. It can contain any HTML and is usually used when visual separation between the two parts of the story is wanted.

" WHERE bid="story_separator"; UPDATE blocks SET category="Stories" WHERE bid="story_summary"; UPDATE blocks SET description="

This block is used to format the story headlines and introtext, both on the index pages and the story pages. It should be a self-contained bit of HTML that lays out the story's information. The following special keys are recognized:

\n
\n
info
\n
The author's name and the story's \"department\" (if used)
\n
title
\n
The story's title
\n
introtext
\n
The formatted contents of the story's introtext field
\n
hotlist
\n
The link to either add or remove the story to the user's hotlist. Blank for anonymous users and stories that haven't been published yet.
\n
topic_img
\n
The topic image, linked to the search results for that topic.
\n
topic_text
\n
The alt text for the topic image as a text link, linked to the search results for that topic.
\n
time
\n
The localized time the story was posted.
\n
sid
\n
The story ID; can be used in custom links.
\n
section_icon
\n
The file name of the section icon; can be used in an IMG tag to display an icon.
\n
section_title
\n
The title of the section.
\n
aid
\n
The nickname of the story author
\n
section
\n
The title of the section.
\n
new
\n
The new story marker; displays the contents of the block new_story_marker if the logged-in user has not yet read the story, otherwise blank.
\n
readmore
\n
The link to the full story, drawing on either the block readmore_txt or no_body_txt as appropriate. Also the link to edit the story, if the user has the appropriate perms.
\n
stats
\n
The number of comments and unread comments, and the number of words in the story.
\n
section_link
\n
The section title as a link to the section index page
\n
" WHERE bid="story_summary"; UPDATE blocks SET category="Page Templates" WHERE bid="story_template"; UPDATE blocks SET description="

This block is used to build the story and comment display pages. It must be a full HTML page. The special keys recognised are:

\n
\n
subtitle
\n
This is replaced with an appropriate subtitle indicating which page is currently being viewed.
\n
dynamicmode_javascript
\n
This is replaced with javascript for the dynamic comment display if the page template is being used for comment display.
\n
STORY
\n
This is replaced with either the poll display or the story display, if either are being viewed.
\n
CONTENT
\n
This is replaced with any other content specific to the page being requested. It is provided by the function or box named in the Ops Admin Tool which handles the op (the first pseudo-directory) of the page.
\n
" WHERE bid="story_template"; UPDATE blocks SET category="Stories" WHERE bid="story_vote_form"; UPDATE blocks SET description="

This is the form used to vote on stories in the voting queue. The following form elements must be present:

\n
\n
FORM
\n
The form should post to the sites rootdir
\n
op
\n
This should be a hidden field, named op, with a value of \"displaystory\"
\n
sid
\n
This should be a hidden field, named sid, with a value of \"|sid|\" (see special keys, below)
\n
mode
\n
This should be a hidden field, named mode, with a value of \"moderate\"
\n
vote
\n
This should be a select or other multi-value field, with possible values of 1, 2, 0, or -1, representing votes for front page, section only, abstention, or hiding, respectively. Options may be removed or renamed, but the basic meaning of the values cannot be changed.
\n
save
\n
This submit button should have a value of \"Vote\"
\n
\n

The following special keys are recognized:

\n
\n
sid
\n
The story ID
\n
formkey
\n
A hidden field used for security and form validation, to help stop scripts.
\n
" WHERE bid="story_vote_form"; UPDATE blocks SET category="Stories" WHERE bid="submission_guidelines"; UPDATE blocks SET description="

This block is displayed above the story submission form. It should be self-contained HTML and should explain the site's submission guidelines. Keep in mind that the majority of people will at most skim this when going to post a story, so put the most important points up top.

" WHERE bid="submission_guidelines"; UPDATE blocks SET category="Stories" WHERE bid="submission_message"; UPDATE blocks SET description="

This block is displayed below the story body when it has been submitted to the queue. It should be self-contained HTML and should explain what will happen to the user's story now that it has been submitted.

" WHERE bid="submission_message"; UPDATE blocks SET category="Colours" WHERE bid="submittedstory_bg"; UPDATE blocks SET description="

This block is used as a row background colour in the Story List Admin Tool and the moderation queue, for those stories that are in the voting queue awaiting votes. This should be a hex colour value including the #, such as #000000 for black." WHERE bid="submittedstory_bg"; UPDATE blocks SET category="RDF" WHERE bid="submit_rdf_message"; UPDATE blocks SET description="

This block is displayed just above the form used to submit an RDF file explaining what the form is for.

" WHERE bid="submit_rdf_message"; UPDATE blocks SET category="Page Templates" WHERE bid="submit_template"; UPDATE blocks SET description="

This block is the page template used to build the story and ad submission forms. It must be a full HTML page. The special keys recognised are:

\n
\n
subtitle
\n
This is replaced with an appropriate subtitle indicating which page is currently being viewed.
\n
STORY
\n
This is replaced with either the poll display or the story display, if either are being viewed.
\n
CONTENT
\n
This is replaced with any other content specific to the page being requested. It is provided by the function or box named in the Ops Admin Tool which handles the op (the first pseudo-directory) of the page.
\n
" WHERE bid="submit_template"; UPDATE blocks SET category="Subscriptions" WHERE bid="subscribe"; UPDATE blocks SET description="

This block is displayed on a user's preferences page if they are not already subscribed, if they have the allow_subscription perm, and if the variable use_subscriptions is on. This should be a short note encouraging users to subscribe and should provide a link to the subscription purchase page. There are no special keys.

" WHERE bid="subscribe"; UPDATE blocks SET category="Subscriptions" WHERE bid="subscribe_denied_message"; UPDATE blocks SET description="

This block is displayed if a user attempts to subscribe while not having the appropriate permissions. It should be self-contained HTML and should explain why the user cannot subscribe.

" WHERE bid="subscribe_denied_message"; UPDATE blocks SET category="Subscriptions" WHERE bid="subscribe_intro_text"; UPDATE blocks SET description="

This block is displayed on the subscription page. It should be self-contained HTML and should describe the subscription options and what extra features are available to subscribers.

" WHERE bid="subscribe_intro_text"; UPDATE blocks SET category="Page Templates" WHERE bid="subscribe_template"; UPDATE blocks SET description="

This block is the page template used for subscription signup and payment. It must be a full HTML page. The special keys recognized are:

\n
\n
subtitle
\n
This is replaced with an appropriate subtitle indicating which page is currently being viewed.
\n
CONTENT
\n
This is replaced with any other content specific to the page being requested. It is provided by the function or box named in the Ops Admin Tool which handles the op (the first pseudo-directory) of the page.
\n
" WHERE bid="subscribe_template"; UPDATE blocks SET category="Subscriptions,Emails" WHERE bid="sub_email_success"; UPDATE blocks SET description="

This block is the body of an email sent to a user when Scoop has successfully added to their subscription. It should not contain any HTML formatting, and recognizes no keys except the special keys listed below, because it does not go through the normal page processing before being emailed. The special keys recognized are:

\n
\n
TYPE
\n
The name of the type of subscription bought or renewed
\n
MONTHS
\n
The number of months bought or renewed
\n
EXP_DATE
\n
The new expiry date of the subscription
\n
sitename
\n
The value of the variable sitename
\n
site_url
\n
The value of the variable site_url
\n
local_email
\n
The value of the variable local_email
\n
" WHERE bid="sub_email_success"; UPDATE blocks SET category="Subscriptions,Emails" WHERE bid="sub_manual_change_email"; UPDATE blocks SET description="

This block is the body of an email sent to the site administrator (at the addresses in the variable admin_alert) notifying them of a user who has bought a subscription but cannot be placed in the subscriber group automatically. This is determined by the perm sub_allow_group_change. It should not contain any HTML formatting, and recognizes no keys except the special keys listed below, because it does not go through the normal page processing. The special keys recognized are:

\n
\n
NICK
\n
The nickname of the user who bought the subscription
\n
TYPE
\n
The name of the type of subscription bought or renewed
\n
MONTHS
\n
The number of months bought or renewed
\n
URL
\n
The URL the administrator should visit to review the subscription
\n
sitename
\n
The value of the variable sitename
\n
site_url
\n
The value of the variable site_url
\n
local_email
\n
The value of the variable local_email
\n
" WHERE bid="sub_manual_change_email"; UPDATE blocks SET category="Payments,Subscriptions" WHERE bid="sub_paypal_canceled"; UPDATE blocks SET description="

This block is displayed when a user cancels a subscription purchase while using paypal. It should be self-contained HTML and should let the user know that the transaction has been canceled.

" WHERE bid="sub_paypal_canceled"; UPDATE blocks SET category="Payments,Subscriptions" WHERE bid="sub_paypal_finished"; UPDATE blocks SET description="

This block is displayed when a user has finished paying for a subscription using paypal. It should be self-contained HTML and should let the user know that the transaction has been completed.

" WHERE bid="sub_paypal_finished"; UPDATE blocks SET category="Ads" WHERE bid="text_ad_template"; UPDATE blocks SET description="

This block is used to provide the layout for the simple text ad type. It should be self-contained HTML. The special keys recognized are:

\n
\n
FILE_PATH
\n
The path to the image file used in the ad. This does not include the value set in the variable ad_server_url.
\n
TEXT1
\n
The text the ad sponsor entered in the text1 field.
\n
TEXT2
\n
The text the ad sponsor entered in the text2 field.
\n
TITLE
\n
The text the ad sponsor entered in the title field.
\n
LINK_URL
\n
The URL of the page being advertised.
\n
SID
\n
The story ID associated with the ad, if ad comments are active. See the Scoop Admin Guide for details on setting up ad comments.
\n
REDIRECT_URL
\n
The URL used in the actual link of the ad, for clickthrough counting. The URL of the page advertised is not required in the actual link, but you may put it there in a dummy cgi variable (such as url=) so users know where they're going.
\n

The special keys used in the ad template become the required fields for the ad, as well as the only fields permitted.

" WHERE bid="text_ad_template"; UPDATE blocks SET category="Admin Pages" WHERE bid="theme_list"; UPDATE blocks SET description="

This block creates the admin tool structure for the block theme overview. It contains a form and two special keys. The form elements are:

\n
\n
FORM
\n
The form should post to |rootdir|/admin/blocks/overview
\n
show
\n
The submit button should have the name \"show\"
\n
\n

The following special keys are recognized:

\n
\n
themesel
\n
A set of checkboxes, one for each theme, to allow the admin to select which themes to display in the overview.
\n
list
\n
The list of all blocks in the selected theme. Matching blocks in two different themes are displayed in the same row, so you can see at a glance which blocks will be replaced when applying themes.
\n
" WHERE bid="theme_list"; UPDATE blocks SET category="Box Templates" WHERE bid="titled_box"; UPDATE blocks SET description="

This block is used as a box template, and is not used directly from other blocks. It should be self-contained HTML and provide a box with a title bar. The following special keys are recognized:

\n
\n
title
\n
The title of the box; either a value explicitly returned by the box code, or the text in the box title field if nothing is explicitly returned.
\n
content
\n
The content of the box; the text that the box code returns after running.
\n
" WHERE bid="titled_box"; UPDATE blocks SET category="Colours" WHERE bid="title_bgcolor"; UPDATE blocks SET description="

This block is used anywhere a title bar needs a background (except in the sidebar boxes, which use box_title_bg). It should be a hex colour value, including the #.

" WHERE bid="title_bgcolor"; UPDATE blocks SET category="Fonts" WHERE bid="title_font"; UPDATE blocks SET description="

This block is used to format titles. It should be a complete opening font or other formatting tag. It must match the closing tags in the block title_font_end.

" WHERE bid="title_font"; UPDATE blocks SET category="Fonts" WHERE bid="title_font_end"; UPDATE blocks SET description="

This block is used to format titles. It should be a closing font or other formatting tag. It must match the opening tags in the block title_font.

" WHERE bid="title_font_end"; UPDATE blocks SET category="Comments" WHERE bid="trusted_info_message"; UPDATE blocks SET description="

This block is displayed on a user's own user info page when they are a trusted user. (See the Scoop Admin Guide for more information on trusted and untrusted users and mojo, which determines trust level.) It should notify the user of their trusted status, and either explain what it means or link to a page that explains what it means.

" WHERE bid="trusted_info_message"; UPDATE blocks SET category="Colours" WHERE bid="undisplayedstory_bg"; UPDATE blocks SET description="

This block is used as the background colour for a line in the Story List Admin Tool for stories that have been voted down in the queue or hidden by an admin. It should be a hex colour value, including the #." WHERE bid="undisplayedstory_bg"; UPDATE blocks SET category="Comments" WHERE bid="untrusted_post_message"; UPDATE blocks SET description="

This block is displayed above the comment posted message when an untrusted user posts a comment. (See the Scoop Admin Guide for more information on trusted and untrusted users and mojo, which determines trust level.) It should notify the user of their untrusted status, and either explain what it means or link to a page that explains what it means.

" WHERE bid="untrusted_post_message"; UPDATE blocks SET category="General" WHERE bid="user_prefs_message"; UPDATE blocks SET description="

This block is displayed instead of the form when a user who is not logged in tries to change his display or comment preferences. It should be self-contained HTML and explain that accounts are required to set preferences. There are no special keys.

" WHERE bid="user_prefs_message"; UPDATE blocks SET category="Admin Pages" WHERE bid="var_category_list"; UPDATE blocks SET description="

This block is used on the Site Controls Admin Tool, to build the list of categories above the form. This should be one row of a table as many cells wide as desired. The special keys may be repeated; each time they are repeated they will be replaced with the values for a different category. The special keys recognized are:

\n
\n
item_url
\n
The part of the URL after /admin/vars/ that will lead to the category overview form.
\n
item
\n
The name of the category.
\n
\n

The special keys, if repeated, should all be repeated the same number of times, and each set should be associated, so as not to mix up the title and destination of the links.

" WHERE bid="var_category_list"; UPDATE blocks SET category="Stories" WHERE bid="vote_console"; UPDATE blocks SET description="

This block is displayed below the story body for stories still in the voting queue. It should be self-contained HTML and explain what the voting is for. The special key vote_form is replaced with the actual form.

" WHERE bid="vote_console"; UPDATE vars SET description="

This variable determines whether or not non-Superusers will have access to the site. The possible values are 0) everybody has access, as normal; and 1) only accounts in the Superuser group will be allowed normal access. The default value is 0.
\nThis variable should only be set to 1 when you are making changes to the site or upgrading the code, and want to deny general access while still having access yourself. When this variable is set to 1, all non-Superuser accounts will be sent 503 Service Unavailable, which you can then configure however you like via Apache's ErrorDocument directive. If set to 1, make sure not to log out, or you will have to change it back to 0 via the mysql shell. The group which can access the site when this variable is active is not configurable.

" WHERE name="safe_mode"; UPDATE vars SET description="

This variable replaces the numeric values for ratings with text labels. The numbers are still there behind the scenes, but this allows you to specify right in the rating form what the different numbers mean. The possible values are a comma-separated string of values, from lowest to highest (including the 'hide' value for trusted users as the first entry). The default value is blank, meaning numbers only are used in the rating form.
\nSo users know what the averaged score means in relation to the text labels, it's a good idea to include the numeric value in the text label.

" WHERE name="rating_labels"; UPDATE vars SET description="

This variable determines the number of ratings that must be done before the comment's rating is calculated and its value applied to a users mojo score. The possible values are any positive number. The default value is 1.
\nThis can prevent a single malicious vote from hiding a comment if set above 1.

" WHERE name="minimum_ratings_to_count"; UPDATE vars SET description="

This variable determines whether or not multiple ratings from the same client IP address are counted when determining a comment's score and a user's mojo. The possible values are: 0) allow any number of ratings from one IP; and 1) only count the first rating from any given IP address. The default value is 0.
\nBefore turning this variable on, consider that there are several situations in which multiple ratings may appear to come from the same IP. One is the case of a lot of computers behind a firewall; all of the computers will appear to come from one IP even though there are many people and many computers. Another is the case of a computer lab, where many users may log on or off of any number of computers at different times, and two different users may rate the same comment from the same computer. This variable does not affect the normal behaviour of only allowing one rating per account.

" WHERE name="filter_ratings_by_ip"; UPDATE vars SET description="

This variable sets the default for the user preference \"Show Hidden Comments\". The possible values are: no) never show comments with scores below rating_min; yes) always show comments with scores below rating_min; and untilrating) show all comments until the user has rated them, then show or hide comments based on score. The default value is untilrating.
\nOnly trusted users have access to this preference. All other users cannot see comments with scores below rating_min.

" WHERE name="default_hidingchoice"; UPDATE vars SET description="

This variable sets the numeric value of the hide rating. The possible values are any number below rating_min. The default value is blank.
\nIf this variable is blank or zero, a value one below rating_min is used.

" WHERE name="hide_rating_value"; UPDATE vars SET description="

This variable determines whether or not the 'main' op (front page request, no path) will allow an EVAL block in its URL Templates field. The possible values are: 0) do not allow EVALs; and 1) allow EVALs. The default value is 0.
\nThis is useful if you have subdomains that you want to have different front pages, such as using news.mysite.org instead of www.mysite.org/section/news, or nickname.mysite.org instead of www.mysite.org/user/nickname/diary. To use the domain name as part of the path, the variable use_host_parse must be turned on. See the Scoop Admin Guide for details on Ops and how they use EVAL blocks.

" WHERE name="main_op_eval"; UPDATE vars SET description="

This variable determines whether or not visitors should be tracked for the \"who's online?\" box. The possible values are: 0) do not track visitors; and 1) track visitors. The default value is 0.
\nThis only keeps user ID, IP address, and a timestamp, it does no other hit tracking. It is really only useful for seeing when a user last requested a page from your site.

" WHERE name="use_whosonline"; UPDATE vars SET description="

This variable determines whether or not a user is allowed to renew an existing advertisement. The possible values are: 0) renewals are not allowed; and 1) renewals are allowed. The default value is 1.
\nThis variable has no effect unless the advertising system is active. If ad renewals are permitted, the renewal link is shown on the ad statistics page which only the ad owner can see. Ad renewal is yet another unimplemented ad feature. Leave this off.

" WHERE name="allow_ad_renewal"; UPDATE vars SET description="

This variable affects the judging process for new advertisements. The possible values are: 0) Only paid ads will be presented for judging and approval, or 1) All ads not yet approved will be presented for judging and approval, regardless of paid status.
\nThe default value is 1. Free ads are automatically marked as paid when submitted. Setting this variable to 0 is recommended, so you don't have to sort through a mixture of paid and unpaid ads awaiting approval.
\nThis variable has no effect unless the variable use_ads is set to 1.

" WHERE name="ads_judge_unpaid"; INSERT IGNORE INTO vars VALUES('ads_use_cc', '0', '', 'bool', 'Payment Processing'); INSERT IGNORE INTO vars VALUES('ads_use_paypal', '0', '', 'bool', 'Payment Processing'); INSERT IGNORE INTO vars VALUES('default_displaystatus', '0', '', 'num', 'Stories'); INSERT IGNORE INTO vars VALUES('real_initial_rating', '0', '', 'bool', 'Comments'); UPDATE vars SET description="

This variable determines whether or not Scoop will provide a link to pay for ads or subscriptions via credit card. The possible values are: 0) do not offer credit card payments as an option; or 1) offer credit card payments as an option. The default value is 0.
\nTo use credit card payments, you must have an SSL-enabled webserver, a certificate, and a credit card merchant account. Scoop currently only supports the Linkpoint credit card processor, which requires a proprietary module. If you want to use credit card payments through scoop, email rusty@kuro5hin.org for help, he has very reasonable rates.

" WHERE name="ads_use_cc"; UPDATE vars SET description="

This variable determines whether or not Scoop will provide a link to pay for ads or subscriptions via paypal. The possible values are: 0) do not offer paypal as an option; or 1) offer paypal as an option. The default value is 0.
\nTo use paypal payments, you must have a paypal account. If you will be doing any kind of traffic, you will probably find that their free account is not sufficient, and you have to go with one of their pay accounts.

" WHERE name="ads_use_paypal"; UPDATE vars SET description="

This variable determines what the default display status should be when the story edit form is opened. The possible values are: -3) Editing; -2) Voting; -1) Never Display (deleted); 0) Always Display (front page); 1) Only Display in Section. The default value is 0.
This variable is used if the story edit form is loaded without a story, as in the New Story Admin Tool or the regular submit story form for users with the perm story_displaystatus_select.

" WHERE name="default_displaystatus"; UPDATE vars SET type="bool" WHERE name="diary_topics"; UPDATE vars SET description="

This variable determines whether or not users can select topics other than `diary' for their diaries. The possible values are: 0) users may not select a topic; and 1) users may select any topic available to regular stories. The default value is 0.

" WHERE name="diary_topics"; UPDATE vars SET description="

This variable determines whether or not the initial rating on a comment counts as a \"real\" rating or if it disappears on the first rating done by a user. The possible values are: 0) initial rating is overridden by first user rating; or 1) initial rating counts as the first real rating.
This variable has no effect unless the variable use_initial_rating is set to 1. The actual rating value given to a new comment is set in the variables anonymous_default_points and user_default_points.

" WHERE name="real_initial_rating"; UPDATE vars SET description="

This variable determines whether or not newly posted comments are given an initial rating. The possible values are: 0) do not give an initial rating; and 1) give an initial rating. The default value is 0.
\nThe initial rating is completely overridden by the first real rating given by another user, unless the variable real_initial_rating is set to 1. The actual value of the initial rating given is set in the variables anonymous_default_points and user_default_points.

" WHERE name="use_initial_rating"; UPDATE vars SET description="

This variable determines the maximum amount of memory Scoop's cache is allowed to use per site and per process. The possible values are any positive number followed by one of b) bytes; k) kilobytes; m) megabytes; g) gigabytes. The default value is 5M. If no unit is specified, `bytes' is assumed.
This is a per-site and per-process value so if you have two sites running and apache has 5 processes handling them, you will have a maximum of 5*5*2 = 50 megabytes of memory taken up by Scoop's cache. If this number is set too large, your server may run out of available memory, degrading performance. If this number is set too small, Scoop will be forced to hit the database a lot more frequently, degrading performance.

" WHERE name="max_cache_size"; UPDATE vars SET description="

This variable contains the email address associated with your Paypal account and is used to receive payments from advertising or subscriptions. The default value is an invalid email address.
To set up payment processing, see the Scoop Admin Guide.

" WHERE name="paypal_business_id"; UPDATE vars SET description="

This variable lists the sections whose story navigation bar should only contain other stories from that section. The possible value is a comma-separated list of section names. The default value is the diary and ad sections.
This only has an effect if the variable disable_story_navbar is set to 0. If the current story is not from one of the sections listed, then only stories also not in this list are considered when building the story navbar. If the current story is from one of the sections listed, then only stories also in that one section are considered when building the story navbar.

" WHERE name="story_nav_bar_sections"; UPDATE vars SET description="

This variable contains a comma-separated list of domains that may not be used to create a new account with. The default value lists the ever-popular `nospam.com' and the by-definition-invalid `example.com'.
If a user tries to create an account with an email address in one of the blocked domains, he is told so and cannot create an account with that address.

" WHERE name="blocked_domains"; DELETE FROM vars WHERE name="op_aliases"; DELETE FROM vars WHERE name="op_templates";