MediaWiki/Extension/Labeled Section Transclusion

<languages/> Vorlage:Extension <translate> The Labeled Section Transclusion extension allows selective transclusion of marked-off sections of text, parsing wikitext as normal. Its functionality is similar to an enhanced version of the <tvar name=onlyinclude>Vorlage:Tag</tvar> tag with normal wiki transclusion, which selects sections for inclusion. It is enabled on all Wikimedia wikis.

While normal transclusion is primarily intended to transclude large portions of small templates, labeled section transclusion is intended for small portions of large pages.

However, there are some differences. In the native template transclusion, sections are marked by behavior; thus you can have only one (possibly non-contiguous) section to be included or skipped.

Here, sections are marked by name, and behavior is chosen by the caller, which can include or skip sections as needed. Different pages can include or exclude selected sections; there can be arbitrary numbers of sections, which can also overlap arbitrarily.

Marking sections by name rather than behavior allows edit section links to be rendered more appropriately for getting excerpts from larger texts, since the extension can now account for sections that are skipped in the beginning of the page, allowing transcluded sections to be offset appropriately.

Installation

</translate> Vorlage:ExtensionInstall

<translate> There is also a [[<tvar name=ext>Special:MyLanguage/Extension:Gadgets</tvar>|Gadget]] in use on Wikisource.org wikis that makes it possible to define sections with a simplified <tvar name=code>## label ##</tvar> syntax.</translate> <translate> Its code can be found at Wikisource:MediaWiki:Gadget-Easy_LST.js.</translate> <translate>

Functions

Transclude any marked part

Step 1: Mark off sections

Mark off sections in the text using <tvar name=section>Vorlage:Tag</tvar> tags like this: </translate>

<section begin="chapter1" />this is a chapter 1<section end="chapter1" />

<translate> Note that these tags are not HTML/XML, and do not use the normal attribute syntax.</translate> <translate> For this reason, and because the <tvar name=begin>begin</tvar> and <tvar name=end>end</tvar> markers are individual, rather than normal XML open/close tags, this allows nested or overlapping sections. This allows you to insert section tags without worrying about interfering with other sections.</translate>

Step 2a: Transclude the section

Call the parser function <tvar name=lst>#lst</tvar> to transclude it, i.e. to transclude a section called <tvar name=section>chapter1</tvar> from a page called <tvar name=page>articleX</tvar>: </translate>

{{#lst:articleX|chapter1}}

<translate> The target article defines the location of the section; its behavior is determined by the parser function.

Step 2b: Transclude the page but excluding the section

To transclude a page, but exclude a specified section, use the <tvar name=lstx>#lstx</tvar> function: </translate>

{{#lstx:articleX|chapter1}}

<translate> Optionally, you may add replacement text to the excluded section. </translate>

{{#lstx:articleX|chapter1|replacement_text}}

<translate> Example: </translate>

{{#lstx:articleX|chapter1|See chapter 1 in [[articleX]].}}

<translate> The replacement text will appear in the area where the section is skipped (excluded).

Discontiguous sections

It is possible to have multiple sections with the same name; in this case, every section with that name will be included/excluded. This is especially useful to mark various discussions.

Section ranges

These functions have an additional, optional argument to specify a section range; i.e. {{#lst:articleX|chapter1|chapter3}}, to include everything from the beginning of chapter 1 to the end of chapter 3. This allows using empty marker pairs to mark one end of the section, possibly in a template. A similar mechanism is currently used at the French Wikisource.

Substitution

This also works with substitution; it's even possible for an article to substitute a section of itself. One use of this provides a neat way to archive talk pages: Mark the text to be archived using <tvar name=code1><section begin=archive /></tvar>, etc. Then create an archive page with the text, using <tvar name=code2>{{subst:#lst:talk_page|archive}}</tvar>, which copies archived sections. Lastly, replace the contents of talk_page with <tvar name=code3>{{subst:#lstx:talk_page|archive}}</tvar> to remove those sections.

There is optional support for transcluding sections of text marked with the normal headings, i.e. <tvar name=code>==this section==</tvar>. If installed, this is done with the lsth function.

Transclude before the first heading

To transclude the introduction of a page (i.e. the content before the first heading), use </translate>

{{#lsth:pagename}}

Transclude a specific section

You can also transclude the whole content of the <tvar name=section1>sectionX</tvar> (which includes all its sub-sections but excludes the heading of <tvar name=section2>sectionX</tvar> itself). </translate>

{{#lsth:pagename|sectionX}}

<translate> Things to note:

Only the first occurrence of the <tvar name=section>sectionX</tvar> is transcluded if you have more than one section with the same name.</translate>

Make sure you type what the heading of <tvar name=section>sectionX</tvar> is in wikitext, not how it is displayed. For example if the heading of the section is <tvar name=code1>==List of [[Extension]]==</tvar>, you should type "<tvar name=code2>List of [[Extension]]</tvar>" not "<tvar name=code3>List of Extension</tvar>".</translate>

When transcluding a section from a page marked for translation using the translate extension, transclude from the language-specific version.</translate> <translate> E.g. from pagename/en rather than from pagename.</translate>

The matching is case insensitive, to prevent links from breaking due to case changes.

Transclude multiple sections

You can also transclude from the first occurrence of <tvar name=section1>sectionX</tvar> (excluding the heading of <tvar name=section2>sectionX</tvar> itself) until it reaches the next occurrence of <tvar name=section3>sectionY</tvar>. Note that <tvar name=section4>sectionY</tvar> acts as a stop point so the transclusion doesn't contain the content of <tvar name=section5>sectionY</tvar>. </translate>

{{#lsth:pagename|sectionX|sectionY}}

Notes about skipped headings

Since the traditional transclusion in MediaWiki isn't intended to transclude sections, it doesn't account for skipped headings. As a result, if you were to transclude a template with multiple headings, and skip the first heading, then all of the edit sections links would point to the wrong section in the template.

When this extension is used (with MediaWiki 1.9 or later), the <tvar name=lst>#lst</tvar> and <tvar name=lsth>#lsth</tvar> functions count headings in the "skipped" beginning part, and offset transcluded headings appropriately. This will allow these links to point to the correct section in the simple case.

Note that <tvar name=lstx>#lstx</tvar> does not count skipped headings, and that skipped headings within discontiguous sections are not offset. </translate><translate> But it seems it has been fixed now (likely when ported to MediaWiki's new preprocessor). The transcluded headings can be linked to the correct sections</translate>.

Localisation

Internally, the parser functions all use the <tvar name=lst>lst</tvar> prefix, for consistency with the name of the extension. Since this acronym may be confusing to non-developers, readable English variants have been introduced, so the functions can currently be called from either name. </translate>

<translate> function</translate>	English	Deutsch	עברית (RTL)	português
#lst	#section	#Abschnitt	#קטע	#trecho
#lstx	#section-x	#Abschnitt-x	#בלי קטע	#trecho-x
#lsth	#section-h

<translate> Additionally, the tag can now be localised; currently:</translate> English, Deutsch, עברית, português; <translate> i.e.:</translate>

English: <section begin=x/> ... <section end=x/>
Deutsch: <Abschnitt Anfang=x/> ... <Abschnitt Ende=x/>
עברית (RTL): <קטע התחלה=א> ... <קטע סוף=א> (<translate> "start" code to the right and "end" code to the left</translate>)
português: <trecho começo=x/> ... <trecho fim=x/>

<translate> Each localization is enabled only if the page matches the respective content language.

Limitations

{{#lsth:pagename|sectionX}} only works on the first section if multiple sections have name sectionX. Only the first occurrence of sectionX is transcluded if an article has more than one section with the same name.</translate>
<translate> While it is possible to use this extension across namespaces, [[<tvar name=EnableScaryTranscluding>Special:MyLanguage/Manual:$wgEnableScaryTranscluding</tvar>|interwiki references]] are not resolved.</translate> <translate> It is not yet possible, for example, to include part of a Wikisource page into a remote MediaWiki installation.</translate>

Section tags cannot themselves be transcluded in order to work on other pages. <tvar name=code>{{#lst:}} and {{#lstx:}}</tvar> work only if section tags appear directly in the wikitext of the transcluded page. This means, for instance, that these tags cannot be embedded in a template using [[<tvar name=tl-params>Special:MyLanguage/Help:Templates#Parameters</tvar>|template parameters]] and [[<tvar name=parser-fns>Special:MyLanguage/Parser functions</tvar>|parser functions]]. The <tvar name=tag1>#tag</tvar> magic word does not work with section tags.</translate>

As of 2014, section tags don't have any effect when used inside a template parameter. If page A contains a text {{B|X}}, there's no way {{#lst:A|...}} can access X.

Examples

wikisource:user:sanbeg/Includer is an early demonstration that shows several of the basic features.