Template:PBB Summary

From Self-sufficiency
Revision as of 00:25, 11 July 2008 by Mr.Z-man (Talk) (Changed protection level for "Template:PBB Summary": Heavily used template [edit=sysop:move=sysop])

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Usage

This template is generally only used by User:ProteinBoxBot. When updating a page, it searches for this template and updates the summary information inside of it. All of the text inside of this box will be replaced with an updated version of the text. It is suggested that additional text be added to a page either before or after this template, but not within the template. Manually adding text within this template carries a high risk that it will be deleted/overwritten at some point in the future.

It is possible to turn updates to this template off through the Bot Control Template. A page without the Bot Control template will not update the PBB_Summary template.

{{PBB_Summary
| section_title = 
| summary_text =
}}

Parameter explanations

section_title

  • This field creates a section header directly above the summary text. If it is left blank, then no section header will be created. The bot will not change this value after placing a default value of "Summary" into the template. It is therefore possible to change or remove the section_title value without risk of the bot changing it at some point in the future.

summary_text

  • This is the actual protein summary text to display. The bot will overwrite any text added to this field during an update unless bot_update is set to no (or Not Yes).