Help:Section: Difference between revisions

Revision as of 15:33, 10 August 2019

Latest revision as of 01:06, 24 November 2024

(18 intermediate revisions by 13 users not shown)

Line 1:

{{MovedToMediaWiki}}

{{H:h|editor toc}}

A page can be divided into '''sections''', using the section heading syntax.

==Creation and numbering of sections==

'''Sections''' are created by creating their headings, as below:

<pre>

==Section==

===Subsection===

====Sub-subsection====

</pre>

Headers with only one equals sign on a side (<nowiki>=text here=</nowiki>) causes a title the size of the page name. On Wikimedia wikis they are used only sparingly and in prescribed circumstances.

When you create a section header, you can't have other content on the same line. For example ==Section Header==&lt;br> will not work.

With the preference setting [[Help:Preferences#Advanced_options|Auto-number headings]] section numbering appears at each heading.

Section names should preferably be unique within a page. This applies even for the names of subsections. Disadvantages of duplicate section names, even as subsections of different sections, include:

*after section editing one confusingly arrives at the wrong section; see also below.

*the automatic edit summary on editing a section is ambiguous

A section (or sections) of a page can be an included separate page (or template), without changing the appearance of a page. See [[Help:Template#Composite_pages]]. This way a separate edit history is in effect provided for the section. Also this allows watching it separately.

In a page calling a template with sections, the sections in the template are numbered according to their position in the rendered page, e.g. if the template tag is in the third section, then the first section of the template is numbered four. Any text in the template before its first section shows up as part of the section with the template tag, and any text after the tag before a new heading shows up as part of the last section of the template. This may be done deliberately, but can usually better be avoided (see also below).

In MediaWiki, a section header in wikitext is [http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/includes/Parser.php?view=markup defined by] a regular expression, <code>/(^={1,6}.*?={1,6}\s*?$)/m</code> ("m" refers to multi-line mode).

==Table of contents (TOC)==

For each page with more than three headings, a '''table of contents (TOC)''' is automatically generated from the section headings, unless:

*(for a user) [[Help:preferences|preferences]] are set to turn it off

*(for an article) the [[Help:Magic words|magic word]] <tt><nowiki>__NOTOC__</nowiki></tt> (with '''two underscores''' on either side of the word) is added in the edit box

When either <nowiki>__FORCETOC__</nowiki> or <nowiki>__TOC__</nowiki> (with '''two underscores''' on either side of the word) is placed in the wikitext, a TOC is added even if the page has fewer than four headings.

With <nowiki>__FORCETOC__</nowiki>, the TOC is placed before the first section heading. With <nowiki>__TOC__</nowiki>, it is placed at the same position where this code is placed. This allows any positioning, e.g. on the right or in a table cell. In old versions of MediaWiki, it also allows multiple occurrence, e.g. in every section (However, this seems only useful if the sections are long, so that the TOCs take up only a small part of the total space.).

https://upload.wikimedia.org/wikipedia/commons/d/d5/Somali_Youth_Development_Foundation_%28SYDF%29.jpg

There may be some introductory text before the TOC, known as the "lead". Although usually a heading after the TOC is preferable, <nowiki>__TOC__</nowiki> can be used to position the TOC correctly (i.e., not too low), rather than inserting a meaningless heading.

Using <nowiki>__NOTOC__</nowiki> it is possible to disable the normal table of contents. Section links, as explained below, allow creating '''compact TOC's''', e.g. alphabetical <tt><nowiki>[[#A|A]] [[#B|B]]</nowiki></tt> etc.

Summary:

{{H:TOC variables}}

== Moving the table of contents ==

The Table of contents can be forced onto a floating table on the right hand of the screen with the code below:

<nowiki>&nbsp;{| align="right"

| __TOC__

|}</nowiki>

===Globally limiting the TOC depth===

It is possible to limit the depth of sub-sections to show in the TOC globally using $wgMaxTocLevel. If configuration setting $wgMaxTocLevel in LocalSettings.php is set to 3 for example, only first and second level headings show up in the TOC.

Until version [http://svn.wikimedia.org/svnroot/mediawiki/tags/REL1_10_0RC1/phase3/RELEASE-NOTES 1.10.0rc1], there is a bug in the parser making a limited TOC display incorrectly. A simple solution is proposed in bug report [[bugzilla:6204|6204]].

==Hidden comments==

To make hidden comments, add the HTML <tt>'''<nowiki><!-- </nowiki>'''</tt> tag, type what you want to hide, then end it with <tt>'''<nowiki> --></nowiki>'''</tt>&nbsp;, like this:

<nowiki><!-- TEXT HERE WILL NOT BE DISPLAYED --></nowiki>

The HTML standard calls for a space character between the tags and the text.{{citation needed}} Many browsers accept the tags without the spaces, but you're safest using them for full compatibility.

Hidden comments are used mainly as notices to people editing a page. MediaWiki supports this HTML, so you can use this code on this or any other MediaWiki wiki as well as in building your own website.

==Section linking==

In the HTML code for each section there is an {{h:mlw|HTML element|Anchor|"id" attribute}} holding the section title. This enables [[w:hyperlink|linking]] directly to sections. These section anchors are automatically used by MediaWiki when it generates a table of contents for the page, and therefore when a section heading in the ToC is clicked, it will jump to the section. Also, the section anchors can be manually linked directly to one section within a page.

The HTML code generated at the beginning of this section, for example, is:

<source lang="html"><h2><span class="mw-headline" id="Section_linking">Section linking</span></h2></source>

A link to this section ([[Help:Section#Section linking|Section linking]]) looks like this:

:<tt><nowiki>[[Help:Section#Section_linking|Section linking]]</nowiki></tt>

To link to a section in the same page you can use <tt><nowiki>[[#section name|displayed text]]</nowiki></tt>, and to link to a section in another page <tt><nowiki>[[page name#section name|displayed text]]</nowiki></tt>.

The anchors disregard the depth of the section; a link to a subsection or sub-subsection etc. will be <tt><nowiki>[[#subsection name]]</nowiki></tt> and <tt><nowiki>[[#sub-subsection name]]</nowiki></tt> etc.

An underscore and number are appended to duplicate section names. E.g. for three sections named "Example", the names (for section linking) will be "Example", "Example_2" and "Example_3". However, after editing section "Example_2" or "Example_3" (see below), one, confusingly, arrives at section "Example" from the [[Help:edit summary|edit summary]]. For a workaround, see [[#Linking to a specific place in the text]].

If a section has a blank space as heading, it results in a link in the TOC that does not work. For a similar effect see [[Help:Parser function#NS:0|NS:0]].

===Section linking with arbitrary id===

<span id="id_with_space"></span>Unfortunately, section link anchors can change invisibly. If an article has several (sub)sections with the same name, their links will be distinguished by "&nbsp;2", "&nbsp;3", and so on added at the end of all but the first. If you link to the third section with a particular name, and someone later adds (or deletes or renames) a section with the same name above that one, the link you made will point to the wrong section, or one that doesn't exist.

You can avoid this with the HTML '''span''' tag with the '''id''' attribute:

:<tt><nowiki><span id="anchor_name"></span></nowiki></tt>

Be sure to use a name that is not likely to be duplicated. One way to do this is to incorporate the titles of the higher-level sections, at least in abbreviated form, e.g., <tt>Ontario-Natural_features</tt> for the "Natural features" subsection of the "Ontario" section of an article about the provinces of Canada. (This example is made-up, but the principle applies.)

Sadly, this won't work with some very old browsers. In some older versions of Mediawiki (at least in 1.4.10), it won't work even with new browsers if the '''id''' has a space in it. For example:

&lt;span id="'''Ontario-Natural features'''"&gt;(optional text)&lt;/span&gt; '''''[won't work]'''''

&lt;span id="'''Newfoundland-Natural_features'''"&gt;(optional text)&lt;/span&gt; '''''[will work]'''''

...

See ''<nowiki>[[#Ontario-Natural features|natural features of Ontario]]'' and ''[[#Newfoundland-Natural features|natural features of Newfoundland]].</nowiki>''

If the '''id''' has spaces, links to it will not work. Change the spaces to underscores in the '''id''', and the ''link'' will work with either underscores or spaces, as expected.

'''Notes:'''

* Using the [[Help:Preferences#Date format|date formatting feature]] in section headings complicates section linking.

* An internal link in a section heading does not give complications in terms of section linking:

**[[#Demo abc]]

**[[Help:Section#Demo http:.2F.2Fa]]

**http://meta.wikimedia.org/wiki/Help:Section#Demo_http:.2F.2Fa

* The [[Help:Piped link#Pipe_trick|pipe trick]] does not work for section links:

** <tt><nowiki>[[#section|]]</nowiki></tt> -> [[#section|]]

** <tt><nowiki>[[page#section|]]</nowiki></tt> -> [[page#section|]]

** <tt><nowiki>[[namespace:page#section|]]</nowiki></tt> -> [[namespace:page#section|]]

For linking to an arbitrary position in a page see [[Help:Link#Manual_anchors|manual anchors]].

=== Section linking and redirects ===

A link that specifies a section of a redirect page corresponds to a link to that section of the target of the redirect.

A [[Help:redirect|redirect]] to a section of a page may also work in some environments (see bug [[bugzilla:218|218]]), try e.g. the redirect page [[Help:Section#Section linking and redirects|Section linking and redirects]]. (One might have to force reload CSS style sheets.)

A complication is that, unlike renaming a page, renaming a section does not create some kind of redirect. Also there is no separate [[help:What links here#Limitations and workarounds|backlink feature for sections]], pages linking to the section are included in the list of pages linking to the page. Possible workarounds:

*Instead of linking directly to a section, link to a page that redirects to the section; when the name of the section is changed, change the redirect target. This method also provides more or less a "what links here" for sections (look for redirects linking to the page, select the one linking to the section; this may be recognized from the name even if the section name has changed).

*Put an anchor and link to that

*Put a comment in the wikitext at the start of a section listing pages that link to the section

*Make the section a separate page/template and either transclude it into, or just link to it from, its parent page; instead of linking to the section one can then link to the separate page.

Redirect pages can be categorized by adding a category tag after the redirect command. In the case that the target of the redirect is a section this has to some extent the effect of categorizing the section: through the redirect the category page links to the section; however, unless an explicit link is put, the section does not link to the category. On the category page redirects are displayed with class redirect-in-category, so they can be shown in e.g. italics; this can be defined in [[MediaWiki:Common.css]]. See also {{mlww|Categorizing redirects}}.

==Section editing==

Sections can be separately edited by clicking special edit links labeled "[edit]" by the heading, or by right clicking on the section heading, depending on the [[help:preferences|preferences]] set. This is called "section editing feature". Section editing feature will take you to an edit page by a URl such as

{{SERVER}}/w/wiki.phtml?title=Help:Section&action=edit&section=2

Note that here section ''numbers'' are used, not section ''titles''; subsections have a single number, e.g. section 2.1 may be numbered 3, section 3 is then numbered 4, etc. You can also directly type in such URL's in the address bar of your browser.

This is convenient if the edit does not involve other sections and one needs not have the text of other sections at hand during the edit (or if one needs it, open the section edit link in a new window, or during section editing, open the main page in a different window). Section editing alleviates some problems of large pages.

"<nowiki>__NOEDITSECTION__</nowiki>" anywhere on the page will remove the edit links and disable editing by right-clicking on the section heading. It will not disable section editing itself: the URL for that still works.

Inserting a section can be done by editing either the section before or after it, merging with the previous section by deleting the heading. Note that in these cases the preloaded section name in the edit summary is not correct, and has to be changed or deleted.

===Adding a section at the end===

=== Editing before the first section ===

In general, no particular link for editing the introductory text before the first section heading is provided ([[bugzilla:156]]). However, section editing feature can also be applied to this part by giving 0 as the section number such as {{SERVER}}/w/wiki.phtml?title=Help:Section&action=edit&section=0 . A less cumbersome way to obtain this link is to use any section edit link of the page, and change the number of the section to zero.

Javascript can also create this URL, see [[w:Wikipedia:WikiProject User scripts/Scripts/Edit Top]].

The <tt>[[template:Edit-top-section|<nowiki>{{Edit-first-section}}</nowiki>]]</tt> and <tt>[[Template:Edit-top-section|<nowiki>{{Edit-top-section}}</nowiki>]]</tt> templates create an edit link for the section 0. Each is positioned slightly differently. Copy these templates to your wiki. ''(Note: These are not available on the English Wikipedia due the availability of "Special:Preferences > Gadgets > User Interface Gadgets".)''

See also [[Help:Section editing demo]].

===Preview===

The preview in section editing does not always show the same as the corresponding part of the full page, e.g. if on the full page an image in the previous section intrudes into the section concerned.

The edit page shows the list of templates used on the whole page, i.e. also the templates used in other sections.

=== Subsections ===

Subsections are included in the part of the section that is edited. Section numbering is relative to the part that is edited, so on the relative top level there is always just number 1, relative subsections all have numbers starting with 1: 1.1., 1.2, etc.; e.g., when editing subsection 3.2, sub-subsection 3.2.4 is numbered 1.4. However, the heading ''format'' is according to the absolute level.

===Editing a page with large sections===

If a page has very large sections, or is very large and has no division into sections, and one's browser or connection does not allow editing of such a large section, then one can still:

*append a section by specifying a large section number (too large does not matter); however, one has to start with a blank line before the new section heading

*append content to the last section by not starting with a section heading; however, with the limitations of one's browser or connection, one cannot revert this, or edit one's new text.

If one can view the wikitext of a large section, one can divide the page into smaller sections by step by step appending one, and finally deleting the original content (this can be done one large section at a time). Thus temporarily there is partial duplication of the content, so it is useful to put an explanation in the edit summary.

{{Help:Editing sections of included templates}}

=== Sections within parser functions ===

When conditionally (using a [[help:ParserFunctions|parser function]]) transcluding a template with sections, edit links of this and subsequent sections will edit the wrong section or give the error mesage that the section does not exist (although the page (including TOC) is correctly displayed and the TOC links correctly). This is because for the targets of the edit links the content of conditionally included templates is considered part of the page itself, and the sections are counted after expansion.

Thus the edit links of the sections of the included template link to the page itself instead of the template, and the edit links after the included template link to the correct page but the wrong section number.

More generally conditional sections give such a complication.

The problem does not occur when transcluding a template with a conditional name (which has more advantages). Use {{tim|void}} for the template to transclude to produce nothing.

===Editing a footnote===

To edit a footnote rendered in a section containing the code <nowiki><references /></nowiki>, edit the section with the footnote mark referring to it, see [[Help:Footnotes]].

===Viewing a section===

The section editing feature can also be used to just ''view'' a section without loading the whole page. There is no other way.

==Sections vs. separate pages vs. transclusion==

Advantages of separate pages:

*[[help:what links here|what links here]] feature

*separate edit histories

*some template limits apply ''per page''

*automatic redirect on renaming

*loading a small page is faster than loading a large page

*can separately be put in categories (however, see also below)

*with [[Semantic MediaWiki]]: have separate annotations

Advantages of one large page with sections:

*loading one large page is faster and more convenient than loading several small ones

*searching within one large page (the page itself or the wikitext) with a local search function is faster and in some respects better than searching several pages (for which one has to search the whole project); also the TOC provides for convenient navigation.

*enforces the cohesion of a concept that while having several definitions needs independent editing.

An alternative is [[Help:Template#Composite_pages|composing a page of other pages using the template feature]] (creating a [[w:compound document|compound document]] by [[w:Wikipedia:transclusion|Transclusion]]). This allows easy searching within the combined rendered page, but not in the combined wikitext. As a disadvantage, a title for each page has to be provided. For the pre-expand include size limit this is disadvantageous even compared with one large page: the pre-expand include size is the sum of the pre-expand include sizes of the components plus the sum of sizes of the wikitexts of the components.

==Sections and TOC ==

=== Making a heading that does not show up in ToC ===

In some older versions, if you didn't want a heading to show up in the generated Table of Contents at the top of the page, you could use HTML to make the heading.

<pre><h2>A level-2 heading that shouldn't show up in the TOC</h2></pre>

But that no longer is supported; by design, HTML headings now show up in the TOC no matter what; see the discussion at https://phabricator.wikimedia.org/T8575.

A simple extension can give you the ability to create non-TOC headings. Try the following, which was written using instructions from [https://www.mediawiki.org/wiki/Extending_wiki_markup Extending wiki markup]:

<source lang="php">

<?php

# H3ForCommentsButNotInTOC.php

# Example WikiMedia extension

# with WikiMedia's extension mechanism it is possible to define

# new tags of the form

# <TAGNAME> some text </TAGNAME>

# the function registered by the extension gets the text between the

# tags as input and can transform it into arbitrary HTML code.

# Note: The output is not interpreted as WikiText but directly

# included in the HTML output. So Wiki markup is not supported.

# To activate the extension, include it from your LocalSettings.php

# with: include("extensions/YourExtensionName.php");

$wgExtensionFunctions[] = "wfH3ForComments";

function wfH3ForComments() {

global $wgParser;

# register the extension with the WikiText parser

# the first parameter is the name of the new tag.

# In this case it defines the tag <example> ... </example>

# the second parameter is the callback function for

# processing the text between the tags

$wgParser->setHook( "xh3", "renderxh3" );

}

# The callback function for converting the input text to HTML output

function renderxh3( $input, $argv, &$parser ) {

$output = "<h3>$input</h3>";

return $output;

}

</source>

Then of course you have to install the extension by adding the following to LocalSettings.php:

require_once("extensions/H3ForCommentsButNotInTOC.php");

To add an <nowiki><h3></nowiki> heading that won't show up in the TOC, do it as:

<xh3>Text for an h3 heading that won't be in the TOC</xh3>

This is pretty crude, and only provides for an H3-level heading. Perhaps someone who actually knows PHP (instead of doing monkey-see-monkey-do programming like I just did) could add code to create tags for H1, H2, and H4.

'''UPDATE:''' To add it for all HTML heading levels, handle nested wikitext, and also avoid the cross-site scripting/HTML injection vulnerability (outputting untrusted user input as HTML), the following will do:

<source lang="php">

<?php

# HeaderNotInTOC.php

# To activate the extension, include it from your LocalSettings.php

# with: require_once( "$IP/extensions/HeaderNotInTOC.php" );

$wgExtensionFunctions[] = "wfHeaderNotInTOC";

function wfHeaderNotInTOC() {

global $wgParser;

# register the extension with the WikiText parser

# the first parameter is the name of the new tag.

# the second parameter is the callback function for

# processing the text between the tags

$wgParser->setHook( "xh1", "wfHeaderNotInTOCxh1" );

$wgParser->setHook( "xh2", "wfHeaderNotInTOCxh2" );

$wgParser->setHook( "xh3", "wfHeaderNotInTOCxh3" );

$wgParser->setHook( "xh4", "wfHeaderNotInTOCxh4" );

$wgParser->setHook( "xh5", "wfHeaderNotInTOCxh5" );

$wgParser->setHook( "xh6", "wfHeaderNotInTOCxh6" );

}

# Helper function to output headings

function wfHeaderNotInTOCparse($input, $level, $parser)

{

return "<h$level>" . $parser->recursiveTagParse($input) . "</h$level>";

}

# The callback functions for converting the input text to HTML output

function wfHeaderNotInTOCxh1( $input, $argv, $parser ) {

return wfHeaderNotInTOCparse($input, 1, $parser);

}

function wfHeaderNotInTOCxh2( $input, $argv, $parser ) {

return wfHeaderNotInTOCparse($input, 2, $parser);

}

function wfHeaderNotInTOCxh3( $input, $argv, $parser ) {

return wfHeaderNotInTOCparse($input, 3, $parser);

}

function wfHeaderNotInTOCxh4( $input, $argv, $parser ) {

return wfHeaderNotInTOCparse($input, 4, $parser);

}

function wfHeaderNotInTOCxh5( $input, $argv, $parser ) {

return wfHeaderNotInTOCparse($input, 5, $parser);

}

function wfHeaderNotInTOCxh6( $input, $argv, $parser ) {

return wfHeaderNotInTOCparse($input, 6, $parser);

}

</source>

=== Making text show up in TOC that is not part of a formal section title===

Text that is not part of a section title, can be forced to be interpreted as a TOC entry, by wrapping it in header tags such as <code><nowiki><h4>...</h4></nowiki></code>. Within the header tags, formatting can be set or customized as usual. Example usage (the second example has additional formatting fixes for reference):

<pre>

{| class="navbox collapsible collapsed" style="text-align: left; border: 0px; margin-top: 0.2em;"

|-

! style="background-color: #f2dfce;" | <h4>Stuff</h4>

|-

| Contents about stuff here

|}

{| class="navbox collapsible collapsed" style="text-align: left; border: 0px; margin-top: 0.2em;"

|-

! style="background-color: #f2dfce;padding-top:0;padding-bottom:0" |

<h4 style="margin:0; padding:0;font-size:95%">More stuff</h4>

|-

| Contents about more stuff here

|}

</pre>

treats the header of the collapse boxes as section titles, adds them to TOC, but does not create or require formal "section titles" to exist in the page itself.

Although ''highly'' non-recommended, it is also possible to create a TOC entry that does not appear in the article text, but will still act correctly as an anchor (for example, to follow it with a section header of slightly different wording):

<pre>

<h4 style='display: none'>Your heading here</h4>

</pre>

== Hiding the Main page heading at the top ==

Add this code to '''YourLanguage:MediaWiki:Common.css''' (substituting ''NameOfYourPage'' for the correspondent translation into your language:<pre>.page-NameOfYourMainPage .firstHeading { display:none; }</pre>

== Sections for demo above ==

=== Demo [[meta:Sandbox|abc]] ===

This section is linked to from [[#Section linking]].

=== Demo http://a ===

This section is linked to from [[#Section linking]].

==Section size policies==

The size of sections may vary, depending on what kind of subject is described and other variables. "Hard" knowledge, e.g. biochemistry articles, presenting many names and mechanisms in a short interval may have shorter section size, while, on the other hand, "soft" knowledge, like articles concerning movies, may have longer ones. There is no strict rule about how long a section may be, just as with [[Wikipedia:Article size|wikipedia article size]]. Nevertheless, a proper section size is probably somewhere between 80 and 500 words. More specifically, "hard" knowledge articles should contain between 80 and 250, while "soft" ones may contain more than 250. Individual circumstances decides - many short sections makes it easier to find the desired information about a subject, but might, when used in excess, disturb the fluency of an article.

==See also==

*[[Help:Preferences]]

*[[Help:Magic words]]

*[[mw:Extension:Auto-Anchor]]

{{H:f|langs=|enname=Section}}

[[Category:Editor handbook]]