Template:TOC right/doc - Revision history

RogueScholar: Copyedit for clarity

2022-09-16T07:01:40Z

Copyedit for clarity

← Older revision		Revision as of 07:01, 16 September 2022
Line 1:		Line 1:
	{{tl\|TOC right}} forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.		{{Documentation subpage}}
			{{Notice\|It contains usage information, categories and other content that is not part of the original template page.\|''NOTICE:'' This is a documentation subpage for [[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}<br />

			The <kbd style="font-size: 1.15em; font-weight: 800;"><nowiki>{{</nowiki>[[Template:TOC right\|TOC right]]<nowiki>}}</nowiki></kbd> template forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.

	== Usage ==		== Usage ==
	Insert ~~<code>{{~~{{BASEPAGENAME}}~~}}</code>~~ at the point in the page where you want the top of the Table of Contents box to appear. Use with {{tl\|-}} or {{tl\|~~clear~~}} to prevent collision with text; use the '''clear''' ~~parameter~~ (see below) to prevent collision with images.		Insert {{Tlx\|{{BASEPAGENAME}}}} at the point in the page where you want the top of the Table of Contents box to appear. Use with {{Tlx\|-}} or {{Tlx\|Clear}} to prevent collision with text; use the '''clear''' attribute (see below) to prevent collision with images.
			* Avoid placing the TOC in a visually poor location; crossing a section division is probably a poor idea.
			* If the TOC is floated left of a bulleted list, the bullets will be hidden.

	=== Parameters (optional) ===		=== Parameters (optional) ===
			{{Glossary}}
			{{Term\|term=clear}}
			{{Defn\|defn=Sets the [[wikipedia:CSS\|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, {{Para\|clear\|right}} (which is the default) will place the element underneath all the right-floating elements before it. Valid values for {{Para\|clear}} are: <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>.
			{{Term\|term=width}}
			{{Defn\|defn=Set the CSS width.}}
			{{Term\|term=limit}}
			{{Defn\|defn=Limits the depth of subheadings shown. For instance, using {{Para\|limit\|4}} will hide the fourth level and deeper subheadings in the hierarchy. And {{Para\|limit\|2}} will hide all subheadings, leaving only the main headings. This is implemented as a CSS class in the [[MediaWiki:Common.css]].}}
			{{Glossary end}}

	~~;clear : Sets the [[w:Cascading Style Sheets~~\|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=right</code> (which is the default) will place the element after all the right floating elements before it. Options are <code>left<~~/code>, <code>right</code>, <code>both</code>, or <code~~>~~none~~<~~/code~~>.		== See also ==
			* {{Tl\|TOC left}}<includeonly>
			<!-- Categories go here -->

	~~;width~~: ~~Set the CSS width.~~		[[Category:Formatting templates]]</includeonly><noinclude>

	;limit: Limits the depth of subheadings shown. For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy. And <code>limit=2</code> will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the [[MediaWiki:Common.css]].

	* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
	* If the TOC is floated left of a bulleted list, the bullets will be hidden.

	~~== See also ==~~
	* {{tl\|TOC left}}

	~~<includeonly>~~		[[Category:Template documentation pages]]</noinclude>
	[[Category:~~Formatting templates~~]]
	</~~includeonly~~>

Ned Scott: /* See also */

2013-06-27T10:18:44Z

Ned Scott at 10:14, 27 June 2013

2013-06-27T10:14:22Z

← Older revision		Revision as of 10:14, 27 June 2013
Line 1:		Line 1:
	~~{{TOC right}}~~		{{tl\|TOC right}} forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.
	# {{tl\|TOC right}} forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.

	=== Usage ===		== Usage ==
	Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the page where you want the top of the Table of Contents box to appear. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.		Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the page where you want the top of the Table of Contents box to appear. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.

Ned Scott at 10:12, 27 June 2013

2013-06-27T10:12:19Z

← Older revision		Revision as of 10:12, 27 June 2013
Line 1:		Line 1:
	{{TOC right}}		{{TOC right}}
	# {{tl\|TOC right}} forces the auto-generated Table of Contents for ~~an article~~ to appear in a table that is floated to the right side of the page, in order to improve ~~article~~ layout.		# {{tl\|TOC right}} forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.

	=== Usage ===		=== Usage ===
	Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the ~~article~~ where you want the top of the Table of Contents box to appear. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.		Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the page where you want the top of the Table of Contents box to appear. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.

	=== Parameters (optional) ===		=== Parameters (optional) ===

Ned Scott at 10:10, 27 June 2013

2013-06-27T10:10:36Z

← Older revision		Revision as of 10:10, 27 June 2013
Line 16:		Line 16:
	* If the TOC is floated left of a bulleted list, the bullets will be hidden.		* If the TOC is floated left of a bulleted list, the bullets will be hidden.

	==See also==		== See also ==
	* {{tx\|TOCleft}}		* {{tl\|TOCleft}}

	<includeonly>		<includeonly>
	[[Category:Formatting templates]]		[[Category:Formatting templates]]
	</includeonly>		</includeonly>

Ned Scott at 10:10, 27 June 2013

2013-06-27T10:10:16Z

← Older revision		Revision as of 10:10, 27 June 2013
Line 1:		Line 1:
	~~<noinclude>{{Documentation subpage}}</noinclude>~~
	~~<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->~~
	{{TOC right}}		{{TOC right}}
	# {{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page, in order to improve article layout.		# {{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page, in order to improve article layout.

	=== Usage ===		=== Usage ===
	Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear~~. This should usually be after the text of the lead section, and just before the first section heading, in accordance with [[Wikipedia:Lead section#Elements of the lead]]~~. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.		Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.

	=== Parameters (optional) ===		=== Parameters (optional) ===

	;clear : Sets the [[Cascading Style Sheets\|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=right</code> (which is the default) will place the element after all the right floating elements before it. Options are <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>.		;clear : Sets the [[w:Cascading Style Sheets\|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=right</code> (which is the default) will place the element after all the right floating elements before it. Options are <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>.

	;width: Set the CSS width.		;width: Set the CSS width.
Line 18:		Line 16:
	* If the TOC is floated left of a bulleted list, the bullets will be hidden.		* If the TOC is floated left of a bulleted list, the bullets will be hidden.

	~~== Cautions ==~~		==See also==
	Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this. Instead add a CSS class to your current skin's .css file, which will apply site wide. Go to [[Special:Mypage/skin.css]], which redirects to your current [[WP:SKIN\|skin]]'s CSS file.		* {{tx\|TOCleft}}

	Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.

	~~Unless the section in which the {{tl\|TOC right}} is placed is long enough, the result may well be undesirable.~~

	It should only be used in cases where the TOC gets in the way of other content or is detrimental to the layout of the page; it should ''not'' simply be used for aesthetics since it tampers with the standard appearance of articles. See [[Help:Section#Floating the TOC]] for further guidelines.

	== See also ==
	* [[Help:Section#Floating the TOC]]
	* {{~~Lts~~\|TOCleft}}
	* [[Help:Magic words#Table of contents\|Help:Magic words]]

	~~<includeonly>~~
	~~<!-- ADD CATEGORIES BELOW THIS LINE -->~~
	~~[[Category:Wikipedia table of contents templates\|Right]]~~

	~~<!-- ADD INTERWIKIS BELOW THIS LINE -->~~
	~~</includeonly>~~

	<includeonly>		<includeonly>
	[[ar:~~قالب:فهرس يمين]]~~		[[Category:Formatting templates]]
	~~[[ro:Format:Cuprins dreapta]]~~
	~~[[ur:سانچہ:دائیں فہرست~~]]
	</includeonly>		</includeonly>

Ned Scott: 86 revisions

2013-06-27T10:06:07Z

86 revisions

← Older revision	Revision as of 10:06, 27 June 2013
(No difference)

216.253.230.130 at 23:17, 17 June 2013

2013-06-17T23:17:11Z

← Older revision		Revision as of 23:17, 17 June 2013
Line 1:		Line 1:
	<noinclude>{{Documentation subpage}}</noinclude>		<noinclude>{{Documentation subpage}}</noinclude>
	<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->		<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
	{{TOC ~~left~~}}		{{TOC right}}
	# {{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page, in order to improve article layout.		# {{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page, in order to improve article layout.

216.253.230.130 at 23:15, 17 June 2013

2013-06-17T23:15:29Z

← Older revision		Revision as of 23:15, 17 June 2013
Line 1:		Line 1:
	<noinclude>{{Documentation subpage}}</noinclude>		<noinclude>{{Documentation subpage}}</noinclude>
	<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->		<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
	{{TOC ~~right~~}}		{{TOC left}}
	# {{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page, in order to improve article layout.		# {{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page, in order to improve article layout.

>DixonDBot@en.wikipedia.org: Migrating 35 interwiki links, now provided by Wikidata on d:Q5626794

2013-03-29T06:09:23Z

Migrating 35 interwiki links, now provided by Wikidata on d:Q5626794

@@ Line 37: / Line 37: @@
 <!-- ADD INTERWIKIS BELOW THIS LINE -->
-[[af:Sjabloon:TOCright]]
+</includeonly>
 [[ar:قالب:فهرس يمين]]
 [[ro:Format:Cuprins dreapta]]
 [[ur:سانچہ:دائیں فہرست]]
 </includeonly>

← Older revision		Revision as of 10:18, 27 June 2013
Line 16:		Line 16:

	== See also ==		== See also ==
	* {{tl\|~~TOCleft~~}}		* {{tl\|TOC left}}

	<includeonly>		<includeonly>
	[[Category:Formatting templates]]		[[Category:Formatting templates]]
	</includeonly>		</includeonly>