ଛାଞ୍ଚ:TOC templates/doc ନିମନ୍ତେ ଆଧାର ଦେଖିବେ

{{documentation subpage|e.g.[[Template:TOC|TOC]]}}

==Usage==
These templates are designed to aid in producing tables of contents (TOCs) using a standardised set of table sections. They are begun with a {{tl|TOC begin}} and are ended with {{tl|TOC end}}.

The aim of these templates is to divorce the TOC from the underlying code. If you have a new circumstance to format, perhaps the best option is to make a new template, rather than hack an old one to fit.

===TOC begin===

;Parameters
* {{parameter|align}}: alignment of the table on the page, defaults to central (optional)
* {{parameter|width}}: table width (optional, any CSS units), <code>| width = 100%</code>
* {{parameter|max-width}}: table max-width (optional, any CSS units), <code>| max-width = 600px</code>
* {{parameter|sc}}: applies small-caps to the entire table (optional), <code>| sc = yes</code>
* {{parameter|style}}: applies any other free-form style to the entire table (optional/no default), <code>| style = line-height:1</code>
* {{parameter|plus}}: allows addition of separate code (optional), eg. to set table attributes <code>| plus = cellpadding <nowiki>{{=}}</nowiki> 5</code> {{gap}}{{smaller|( refer [[Template:=]] )}}

===Naming convention===

Template are named by the colspan of their cells (in order) and the salient feature of any cells that are not "normal".

For example, a row of three single cells is {{tl|TOC row 1-1-1}}, and a row with a colspan-2 cell followed by a single cell is {{tl|TOC row 2-1}}. If a cell has no colspan but a salient feature, the "1" from that cell is omitted: {{tl|TOC row 1-out-1}}

===Special cases===

* {{tl|TOC row c}}: a single cell, text centred, with a colspan given in the first parameter, and contents in the second.
* {{tl|TOC row r}}: a single cell, text right-aligned, with a colspan given in the first parameter, and contents in the second.

===3-column tables===

3-column tables are perhaps the most common type. The "normal" condition if for the first and last columns to be right-aligned, and the middle column to be left aligned.

* {{tl|TOC row 1-1-1}}: three single cells, right-left-right aligned, respectively
* {{tl|TOC row 2-1}}: a colspan=2 cell and a normal cell. Left and right aligned respectively.

;Hanging indents
* {{tl|TOC row 1-out-1}}: three single cells, but the middle cell has a {{tl|hanging indent}} applied.
* {{tl|TOC row 2out-1}}: same as "2-1", but the first cell has a hanging indent.
* {{tl|TOC row 1-dot-1}}: same as "1-out-1", but the middle cell also has a dot-trailer appended.
** Optional: use symbol= to set dot character(s), space= to set number of spaces (default: one dot and 5 spaces)
*** Use spaces= to set spaces between (symbols.)
* {{tl|TOC row 2dot-1}}: same as "2out-1", but the first cell also has a dot-trailer appended.

;Different alignment
* {{tl|TOC row 1-r-1}}: three single cells, left-right-right aligned, respectively.
* {{tl|TOC row 1-c-1}}: three single cells, left-center-right aligned, respectively.

====Example====
{{TOC begin}}
{{TOC row c | 3  | {{x-larger|Table of Contents: {{tl|TOC row c}}}} }}
{{TOC row 2-1    | Introduction, Preface and Other Front Matter : {{tl|TOC row 2-1}}|1}}
{{TOC row 1-1-1  | 1 |Chapter 1: {{tl|TOC row 1-1-1}}|2}}
{{TOC row 1-1-1  | 2 |Chapter 2: {{tl|TOC row 1-1-1}} {{lorem ipsum}}|3}} 
{{TOC row r | 3  | {{tl|TOC row r}} Plates illustrating various things }}
{{TOC row 1-out-1 |3 |Chapter 3: {{tl|TOC row 1-out-1}} {{lorem ipsum}}|4}} 
{{TOC row 2out-1  | {{tl|TOC row 2out-1}} {{lorem ipsum}}|5}}
{{TOC row 1-dot-1 |4 |Chapter 4: {{tl|TOC row 1-dot-1}} {{lorem ipsum}}|6}} 
{{TOC row 2dot-1  | {{tl|TOC row 2dot-1}} {{lorem ipsum}}|7}}
{{TOC end}}

===4-column tables===

The "normal" condition if for the first, second and last columns to be right-aligned, and the third column to be left aligned.

* {{tl|TOC row 1-1-1-1}}
* {{tl|TOC row 2-1-1}}


{{TOC begin}}
{{TOC row c | 4  | {{x-larger|Table of Contents: {{tl|TOC row c}}}} }}
{{TOC row 2-1-1  | Introduction | {{tl|TOC row 2-1-1}}|1}}
{{TOC row 1-1-1-1| 1 | a |Section 1: {{tl|TOC row 1-1-1-1}}|2}}
{{TOC row 1-1-1-1|   | b |Section 2: {{tl|TOC row 1-1-1-1}} {{lorem ipsum}}|3}} 
{{TOC end}}

==Page breaking==

If a table is broken across multiple, as is common for long TOCs, you need to add a {{tl|nop}} to the top of every page body, to prevent the transclusion running the last line of the previous page into the first line of that page. You also need to put a {{tl|TOC begin}} in the header of the page to make it render properly in the Page: [[H:NS|namespace]], and you should close the table in the footer of every page except the last:

;First page body
<pre>
{{TOC begin}}
{{TOC row.....}}
</pre>

;First page footer
<pre>
{{TOC end}}
</pre>

;Middle page header
<pre>{{TOC begin}}</pre>

;Middle pages body
<pre>
{{nop}}
{{TOC row.......}}
{{TOC row.......}}
</pre>

;Middle pages footer
<pre>{{TOC end}}</pre>

;Last page header
<pre>{{TOC begin}}</pre>

;Last page body
<pre>
{{nop}}
{{TOC row....}}
{{TOC end}}
</pre>


==See also==
{{#lst:Help:Templates|navigation templates}}

<!-- template categories and interwiki links -->
<includeonly>
[[Category:Experimental table templates]]

</includeonly>