The family of succession templates is one with many members, and each has a different name and function. On top of that, most templates also have parameters, the number of which may range from one to more than ten. The purpose of this page is to list the templates and their parameters in a simple way, and it can serve both as a useful introductory guide to succession templates for editors inexperienced in this field and as a practical reminder of the system's details to more seasoned contributors.

The list constitutes the second section of this page; the first section introduces the important concept of parameters and categorises them, so that their descriptions in the list can be brief. The mere mention of the categories' names can then tell the editors exactly how a parameter must be used. If you are already familiar with this classification or it does not affect your search, you can go straight to the list by clicking here or by using the table of contents below.

Contents

As opposed to many ordinary templates, most succession templates require the editor to include names, titles, or other text other than the automated template names. Such text is inserted into the templates by means of parameters, single words separated from the template name and from each other by means of pipes ( | ) whose function is to alter the appearance of the cells created by these templates. When a template is to include manual text, that is separated from the parameter word by a plus sign ( = ).

Most succession templates accept parameters, the inclusion of some which is essential for the correct function of the templates, while the inclusion of others is optional. The only templates that do not accept any parameters are s-start/start, s-end/end, and most of the header templates.

The parameters can be classified into five categories: the row parameter, title parameters, basic obligatory parameters, basic optional parameters, and complementary parameters. The three following sections examine the types of parameters that the templates in the corresponding cells can accept.

These cells name the subject's predecessor and/or successor in an office or title, therefore the parameters in them usually affect the details of each succession chain's continuation in both directions.

The row parameter: It always comes right after the template name and defines the number of rows a cell will take up in a succession box (the default number is one). It is of the form rows=x, where the appropriate number should filled in the place of the "x". For more information about tables, see the Documentation page.

Title parameters: They follow the row parameter. These optional parameters change the basic label that appears in most templates. (S-non is an exception, as its message is entirely customisable.) Only one of them can be used in each template, and they are inserted as they are (no additional text is added).

Basic obligatory parameters: These are crucial to the purposes of the templates that include them and their presence is essential for the templates to work in addition to the importance of the information in these fields. The "before" parameter in s-bef is one of them; without it the cell will display the message {{before}} instead of any useful information.

Basic optional parameters: They offer additional information, and their presence, though often desirable, is not essential for the correct function of their respective templates. These include the "last" and "next" parameters in s-vac, the "heir" parameter in s-inc, and the "reason" parameter in s-new.

Complementary parameters: These offer information that serves either to clarify/disambiguate or to adapt the succession line to special transitory or other occasions. These include the "reason" parameter in s-vac and the "as" parameter wherever acceptable.

Title parameters: They are the only ones in their respective templates. As of January 2008, the headers that accept parameters are ten, and though in all of them parameters are optional in theory, the usage of some is compelled by current practice. In cases of optional parameters, it may or may not be required to leave a pipe after the template name for the default forms ("empty parameter").

Here follows a directory of all the non-header templates, with basic information about each: their place in the succession lines (predecessor (left), title (middle), or successor (right) cell), the main information they convey, and all the parameters they accept with their type (as described above) and a brief description. There is also a section for headers, with more limited information about each.

As of January 2008, there are 27 header templates for succession boxes. Out of these, ten accept parameters, creating a total of about 250 different headers. This list gives a brief description of the type of titles each header is used for and gives more details for those that take parameters. The templates' names link to their articles, where you can find exhaustive lists of their parameters. For further information on the usage of headers please see the Guidelines page.