Everything you never knew you wanted to know about the Mercury Project
Help:Section
From RixWiki
A page can be divided into sections, using the section header syntax.
Creation of sections
Sections are created by creating their headers, see w:Wikipedia:Section#Creation of sections
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) preferences are set to turn it off
- (for an article) in the edit box the code __NOTOC__ is added
With __FORCETOC__ or __TOC__ in the wikitext a TOC is added even if the page has less than four headings.
The TOC is put before the first section header, or in the case of __TOC__, at the position of this code. Thus there may be some introductory text before it, known as the "lead". Although usually a header after the TOC is preferable, __TOC__ can be used to avoid being forced to insert a meaningless header just to position the TOC correctly, i.e., not too low.
Preferences can be set to number the sections automatically.
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 header 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).
Compact TOC
Where you have a large number of very short headings (such as letters of the alphabet) you can get a very long table of contents. An alternative is a compact TOC, which you can achieve by inserting the following text:
{{compactTOC}}
which looks like this:
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
You can do similar things with years or decades e.g.
1900s - 1910s - 1920s - 1930s - 1940s - 1950s - 1960s - 1970s - 1980s - 1990s - 2000s
Both of the above make use of section linking, see below.
Section linking
The top of each section has in the HTML code a HTML element "a"
HTML element "a" with both a "name" and an "id" attribute with the section name. This enables linking directly to sections. Section links are used by MediaWiki in a page's automatically generated Table of Contents.
The html code generated at the beginning of this section, for example, is:
<p><a name="Section_linking" id="Section_linking"></a></p> <h2>Section linking</h2>
A link to this section (Section Linking) looks like this:
[[Help:Section#Section_linking|Section Linking]]
From within the same page you can use [[#id|link_label]], and from another page [[page_name#id|link_label]].
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".
An internal link in a section header does not give complications:
An external link in a section header does not seem to allow linking to that section from within Mediawiki, except from the TOC:
For linking to an arbitrary position in a page see linking to a page.
Section editing
Sections can be separately edited ("section editing feature") by right clicking on the section header and/or special edit links, depending on the preferences set.
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 "Cancel" in a window). Section editing alleviates some problems of large pages.
Inserting a section can be done by editing either the section before or after it, merging with the previous section by deleting the header.
"__NOEDITSECTION__" anywhere on the page will remove the edit links. It will not disable section editing itself, right clicking on the section header and the url still work.
See also Help:Edit summary#Section title as automatic edit summary, Help:Section editing demo.
Editing sections of included templates
The editing facilities can also be applied to a section of an included template. For the purpose of section editing the extent of a section is governed by the headers in the calling page itself. It may consist of a part before the template tag, the template tag, and a part after the template tag, even if the template has sections.
It tends to be confusing if the extent of sections according to the system is different from what the rendered page suggests. To avoid this:
- if a template has headers, do not put any text before the first header
- in the calling page, start a new section after a template that itself has sections
It may be convenient, where suitable, to start a template with a section header, even if normally the contents of the template would not need a division into sections, and thus the template is only one section. The edit facilities for editing sections can then be used for editing the template from a page that includes it, without specially putting an edit link.
The __NOEDITSECTION__ tag in any template affects both that template, the pages it's included on, and any other templates included on the same page.
Opening a link in a header in a new window
When right click editing is enabled, you cannot right click a link in a header to open it in a new window, etc. However most browsers have an alternative way of doing that (Mozilla: middle click, ctrl+left click, type ahead find, TAB navigation; IE: shift+left click).
Horizontal dividing line
A horizontal dividing line as a division demarcation is not taken into account in the section numbering and TOC. Therefore it should not be used for dividing a page in sets of sections.
"See also" line or section
If a page consists of sections and a "see also" refers to the whole page, then make it a separate section. This is to avoid it becoming part of the prior section, to make it visible in the TOC, and to make it easily accessible through the TOC.
Alternatively, a "see also" line is sometimes put at the beginning.
A "see also" belonging to just one section can be put in that section: within a paragraph, as a separate paragraph, or as a subsection.
Text in a large font that should not begin a section
When using text in a large font that should not begin a section, e.g. to show a font, use something like
<b><font style="font-size:120%"> Example text </font></b>
giving
Example text
Blank space as header
If a (sub)section has a blank space as header, it results in a link in the TOC that does not work.
Sections vs. separate pages vs transclusion
Advantages of separate pages:
- what links here feature
- automatic redirect on renaming
- redirect to a section is not possible
- loading a small page is faster than loading a large page
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.
Another alternative is composing a page of other pages using the template feature (creating a compound document by transclusion). This allows easy searching within the combined rendered page, but not in the combined wikitext. Titles have to be provided.
Sections for demo above
Demo a
Demo http://a
See also
RixWiki-specific content and links to other help pages
| Template:Ph:Section edit this RixWiki and subject-specific template |
| Help contents Reading:
Go |
Search |
URL |
Namespace |
Page name |
Section |
Link |
Backlinks |
Piped link |
Interwiki link |
Redirect |
Variable |
Category
|
