Template:TOC right/doc - Revision history

imported>Slate Vesper at 17:41, 13 July 2013

2013-07-13T17:41:45Z

← Older revision		Revision as of 19:41, 13 July 2013
Line 1:		Line 1:
	<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->		<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

	# {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.		#{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.
	# {TOC nest right}} Operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. '''TOC nest right''' will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.		#{TOC nest right}} Operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. '''TOC nest right''' will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.
	::When using the TOC nest right template logout and check that it appears correctly with the default skin in Internet Explorer and an ~~[[Wikipedia:Acid2~~\|Acid2]] compatible browser (or Firefox). The problem is ''Some browsers'' render the page in different orders relative to HTML blocks or block elements (including images, tables, and infoboxes... so most of our pages! FixHTML (also called FixBunching) "forces" rendering to' behave~~' '~~' itself. So prophylactic use is a good idea, and is a really good idea on pages with lots of images.		::When using the TOC nest right template logout and check that it appears correctly with the default skin in Internet Explorer and an {{Wiki\|Acid2}} compatible browser (or Firefox). The problem is ''Some browsers'' render the page in different orders relative to HTML blocks or block elements (including images, tables, and infoboxes... so most of our pages! FixHTML (also called FixBunching) "forces" rendering to 'behave' itself. So prophylactic use is a good idea, and is a really good idea on pages with lots of images.

	=== 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 the '''clear''' parameter (see below) to prevent collision with images and text.		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 {{Wiki\|Lead section#Elements of the lead\|elements of the lead}}. Use the '''clear''' parameter (see below) to prevent collision with images and text.

	=== Parameters (optional) ===		===Parameters (optional)===
			;clear
			:Sets the {{Wiki\|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 ~~{{Wiki\|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~~.		;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]].

	~~;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.

	* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.		==Cautions==
	* If the TOC is floated left of a bulleted list, the bullets will be hidden.		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 monobook.css file which will apply site wide.

	== Cautions ==
	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 monobook.css file which will apply site wide.

	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.		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.

imported>Thisismyrofl: Acid2 is not within the scope of this wiki, so I pipe the link to lead to Wikipedia instead.

2013-07-13T00:10:22Z

Acid2 is not within the scope of this wiki, so I pipe the link to lead to Wikipedia instead.

← Older revision		Revision as of 02:10, 13 July 2013
Line 3:		Line 3:
	# {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.		# {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.
	# {TOC nest right}} Operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. '''TOC nest right''' will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.		# {TOC nest right}} Operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. '''TOC nest right''' will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.
	::When using the TOC nest right template logout and check that it appears correctly with the default skin in Internet Explorer and a [[Acid2]] compatible browser (or Firefox). The problem is ''Some browsers'' render the page in different orders relative to HTML blocks or block elements (including images, tables, and infoboxes... so most of our pages! FixHTML (also called FixBunching) "forces" rendering to' behave' '' itself. So prophylactic use is a good idea, and is a really good idea on pages with lots of images.		::When using the TOC nest right template logout and check that it appears correctly with the default skin in Internet Explorer and an [[Wikipedia:Acid2\|Acid2]] compatible browser (or Firefox). The problem is ''Some browsers'' render the page in different orders relative to HTML blocks or block elements (including images, tables, and infoboxes... so most of our pages! FixHTML (also called FixBunching) "forces" rendering to' behave' '' itself. So prophylactic use is a good idea, and is a really good idea on pages with lots of images.

	=== Usage ===		=== Usage ===

imported>Vatsa1708 at 06:32, 24 March 2013

2013-03-24T06:32:29Z

← Older revision		Revision as of 08:32, 24 March 2013
Line 10:		Line 10:
	=== 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 {{Wiki\|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.

imported>D. Cello: /* Cautions */

2010-04-22T06:48:55Z

Cautions

← Older revision		Revision as of 08:48, 22 April 2010
Line 26:		Line 26:
	Unless the section in which the template TOC right is placed is long enough, the result may well be undesirable.		Unless the section in which the template 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~~.		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.

imported>D. Cello: Created page with ' # {TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right …'

2010-04-22T06:48:25Z

Created page with ' # {TOC right}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right …'

Páàjì titun

# {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.
# {TOC nest right}} Operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. '''TOC nest right''' will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.
::When using the TOC nest right template logout and check that it appears correctly with the default skin in Internet Explorer and a [[Acid2]] compatible browser (or Firefox). The problem is ''Some browsers'' render the page in different orders relative to HTML blocks or block elements (including images, tables, and infoboxes... so most of our pages! FixHTML (also called FixBunching) "forces" rendering to' behave' '' itself. So prophylactic use is a good idea, and is a really good idea on pages with lots of images.

=== 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 the '''clear''' parameter (see below) to prevent collision with images and text.

=== 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>.

;width: Set the CSS width.

;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.

== Cautions ==
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 monobook.css file which will apply site wide.

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 template 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.