Editing Template:S-start/doc (section)

====''s-break'' (the "|-" character) ====
In theory, it is necessary for the box to work to place "|-" between every line of the box, even if every cell is restricted to its own line. However, "|-" is already imbedded into most of the templates, so it is no longer necessary to add it to boxes that consist of simple one-row lines, with the exceptions of templates ''s-vac'' and ''s-non'': if a line ends with one of these templates, you need to place this character or the computer will not recognize a new row. Similarly, if a line begins with ''s-vac'', the character must be placed before that row.

Still, things are different with more complex tables that incorporate multiple-row cells covering more than one lines each. Complex patterns are created and it is not always easy for the computer to display all the lines correctly. This is why ''s-break'' is so important in these cases, and although its placement is unneeded between many of the lines, it is much more preferable to use it redundantly in a table than to create a non-functional box, where it will often be difficult to locate the mistake.

That said, and even though it is a safe option to place ''s-break'' between every pair of lines in a box, it is naturally better to avoid such practices to the extent this is possible. Here follow a few simple tips that can limit its redundant usage to a minimum without leading to mistakes:

*When considering the placement of ''s-break'', it is important to note the presence or absence of succession templates in a line. That is, a template for a multiple-line cell is always placed at the line from which the cell starts, therefore that line has a template for that cell while the other lines that share the cell do not. As a result, a line from which multi-line cells begin but into which no cell continues from a higher line has templates for all three cells and there is not any need to place the character before it unless this is necessitated by the presence of a ''s-vac'' or ''s-non'' template.

:In the following example, note the lack of 's-break'' between the first and the second line and, more importantly, between the fourth and fifth lines:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before}}</nowiki>
::<nowiki>{{s-ttl|title=|years=}}</nowiki>
::<nowiki>{{s-aft|after=}}</nowiki>
::<nowiki>{{s-bef|rows=2|before=}}</nowiki>
::<nowiki>{{s-ttl|title=|years=}}</nowiki>
::<nowiki>{{s-aft|rows=3|after=}}</nowiki>
::<nowiki>{{s-break}}</nowiki>
::<nowiki>{{s-ttl|title=|years=}}</nowiki>
::<nowiki>{{s-break}}</nowiki>
::<nowiki>{{s-bef|before=}}</nowiki>
::<nowiki>{{s-ttl|title=|years=}}</nowiki>
::<nowiki>{{s-bef|before=}}</nowiki>
::<nowiki>{{s-ttl|title=|years=}}</nowiki>
::<nowiki>{{s-aft|after=}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

*When only the predecessor cell of a line stretches between the line in question and a previous one (it does not matter whether it continues into a lower line), ''s-break'' needs not be inserted between that line and the previous one. Similarly, if only the successor cell covers multiple lines and begins in a line above the one in question, then the ''s-break'' that could follow the concerned line's ''s-ttl'' parameter can be omitted. And the situation is even easier with a multi-row title cell (a rarer occurrence), as it is usually not directly affected by line changes. Generally, it is easier for the computer to separate the lines when only one template is missing from a row's three.

*Always use the preview button before saving. If you are not certain about the inclusion of a ''s-break'', you can try removing it and then previewing the page; if a succession box has an error, that will generally be readily visible. Keep in mind that each line in a box ought to have three cells, each line and column should align perfectly, and the two side columns should have the same width, which normally is slightly smaller than that of the middle column (a 3 to 4 ratio).

Have a look at the following example. In its first iteration (left), ''s-break'' is used to separate every line from its previous and next ones. In its second version (right), ''s-break'' is used only as many times as it is necessary for the box to work properly: none. The result is exactly the same in both cases, and can be seen below the code.

{{col-begin}}
{{col-break}}
::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=Mary}}</nowiki>
::<nowiki>{{s-ttl|rows=2|title=President of the Balkans|years=1982–1992}}</nowiki>
::<nowiki>{{s-aft|after=William}}</nowiki>
::<nowiki>{{s-break}}</nowiki>
::<nowiki>{{s-bef|rows=2|before=Nicholas}}</nowiki>
::<nowiki>{{s-aft|after=Edgar}}</nowiki>
::<nowiki>{{s-break}}</nowiki>
::<nowiki>{{s-ttl|title=King of New Zealand|years=1990–1997}}</nowiki>
::<nowiki>{{s-aft|after=Helen}}</nowiki>
::<nowiki>{{s-break}}</nowiki>
::<nowiki>{{s-bef|before=Richard}}</nowiki>
::<nowiki>{{s-ttl|title=King of Southeast Asia|years=1990–present}}</nowiki>
::<nowiki>{{s-inc|rows=2|heir=Lee}}</nowiki>
::<nowiki>{{s-break}}</nowiki>
::<nowiki>{{s-bef|before=George}}</nowiki>
::<nowiki>{{s-ttl|title=Governor of Borneo|years=2003–present}}</nowiki>
::<nowiki>{{s-end}}</nowiki>
{{col-break}}
::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=Mary}}</nowiki>
::<nowiki>{{s-ttl|rows=2|title=President of the Balkans</nowiki>
::<nowiki>|years=1982–1992}}</nowiki>
::<nowiki>{{s-aft|after=William}}</nowiki>
::<nowiki>{{s-bef|rows=2|before=Nicholas}}</nowiki>
::<nowiki>{{s-aft|after=Edgar}}</nowiki>
::<nowiki>{{s-ttl|title=King of New Zealand</nowiki>
::<nowiki>|years=1990–1997}}</nowiki>
::<nowiki>{{s-aft|after=Helen}}</nowiki>
::<nowiki>{{s-bef|before=Richard}}</nowiki>
::<nowiki>{{s-ttl|title=King of Southeast Asia</nowiki>
::<nowiki>|years=1990–present}}</nowiki>
::<nowiki>{{s-inc|rows=2|heir=Lee}}</nowiki>
::<nowiki>{{s-bef|before=George}}</nowiki>
::<nowiki>{{s-ttl|title=Governor of Borneo</nowiki>
::<nowiki>|years=2003–present}}</nowiki>
::<nowiki>{{s-end}}</nowiki>
{{col-end}}

{{s-start}}
{{s-bef|before=Mary}}
{{s-ttl|rows=2|title=President of the Balkans|years=1982–1992}}
{{s-aft|after=William}}
{{s-bef|rows=2|before=Nicholas}}
{{s-aft|after=Edgar}}
{{s-ttl|title=King of New Zealand|years=1990–1997}}
{{s-aft|after=Helen}}
{{s-bef|before=Richard}}
{{s-ttl|title=King of Southeast Asia|years=1990–present}}
{{s-inc|rows=2|heir=Lee}}
{{s-bef|before=George}}
{{s-ttl|title=Governor of Borneo|years=2003–present}}
{{s-end}}