Issue tracker: #Mediawiki-extensions-Header_Tabs

Extension:Header Tabs

From Linux Web Expert

MediaWiki extensions manual
File:OOjs UI icon advanced-invert.svg
Header Tabs
Release status: stable
File:Header Tabs screenshot.png
Implementation Parser function , User interface
Description Displays top-level headers as JavaScript-based tabs
Author(s)
Latest version 2.2.2 (September 2023)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.33+
License GNU General Public License 2.0 or later
Download
<translate> Download extension</translate>
<translate> Git</translate> [?]:

Version history
Example
Parameters
  • $wgHeaderTabsRenderSingleTab
  • $wgHeaderTabsDisableDefaultToc
  • $wgHeaderTabsAutomaticNamespaces
  • $wgHeaderTabsNoTabsInToc
  • $wgHeaderTabsEditTabLink
  • $wgHeaderTabsGenerateTabTocs
  • $wgHeaderTabsDefaultFirstTab
  • $wgHeaderTabsUseHistory
Hooks used
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Translate the Header Tabs extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The Header Tabs extension transforms top-level MediaWiki headers (i.e., headers surrounded by a single "=") into JavaScript-based tabs.

Usage

To enable tabs on a page after you installed the extension, you need to add a ‎<headertabs /> tag into the page in place where the last tab should end (everything below this tag will be shown under the tab view). Most of the time, though, you'll want to put it at the bottom of the page.

In addition to that, the page should have top-level headers defined in it like this: 

= Header title =

Each such top-level header, if it's anywhere above the ‎<headertabs /> tag, will be displayed as a tab.

Linking to tabs

You can link to a tab, both from another page and from within that same page (and, within that same page, both from another tab and from outside the tab view). This is done using the {{#switchtablink}} parser function, which is called like this: 

{{#switchtablink:Tab name|Link text|Page name}}

This will create a link to the tab with the name "Tab name", and the text of the link will read "Link text". If you want the link to a point to a tab on another page, you can optionally add the third parameter, "Page name".

Multibyte characters as well as formatting characters (e.g. bold) are not permitted if you want to link to tabs in any way.


Example

Some text above the tab view

= First section header =
This will be displayed on the first tab

{{#switchtablink:Second section header|Click here to go to the next tab...}}

= Second section header =
This will be displayed on the second tab

<headertabs/>
= Third section header =
This will be always displayed under the tab view because it's below the <headertabs/> tag.

The header titles get automatically converted into tab titles.

Download

You can download the Header Tabs code, in .zip format: https://github.com/wikimedia/mediawiki-extensions-HeaderTabs/archive/2.2.2.zip

You can also download the code directly via Git from the MediaWiki source code repository. From a command line, call the following: 

git clone https://phabricator.wikimedia.org/diffusion/EHET/extension-headertabs.git

To view the code online, including the version history for each file: https://phabricator.wikimedia.org/diffusion/EHET/browse/master/

Installation

  • <translate> [[<tvar name=2>Special:ExtensionDistributor/HeaderTabs</tvar>|Download]] and move the extracted <tvar name=name>HeaderTabs</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
    <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/HeaderTabs
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate> 
    wfLoadExtension( 'HeaderTabs' );
  • File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Modifications

Skin modification

To change the tabs' styling, see "Skin modification".

Configuration parameters

The following parameters can be modified in LocalSettings.php below the call to wfLoadExtension().

$wgHeaderTabsUseHistory

$wgHeaderTabsUseHistory defines whether tab navigation should be tracked within the browser history and within the URL, updating the hash value. By default this variable is set to true, i.e. history is used. You can disable it by adding the following: 

$wgHeaderTabsUseHistory = false;

$wgHeaderTabsRenderSingleTab

The $wgHeaderTabsRenderSingleTab variable defines if Header Tabs will activate if only a single top-level header is found. By default this variable is set to false, i.e. no tabs will be shown if only one top-level header is found. You can enable this behaviour by adding the following: 

$wgHeaderTabsRenderSingleTab = true;

$wgHeaderTabsAutomaticNamespaces

The $wgHeaderTabsAutomaticNamespaces variable defines the set of namespaces for which you don't need to add the <headertabs /> tag in order to enable tabs. If a namespace ID is defined in this variable, header tabs will activate automatically when you have two top-level headers (or one, if you have $wgHeaderTabsRenderSingleTab set to true) in an article. By default this variable holds no namespaces. You can add namespaces to this list by adding the following for each namespace: 

$wgHeaderTabsAutomaticNamespaces[] = NS_MAIN;

$wgHeaderTabsDefaultFirstTab

The $wgHeaderTabsDefaultFirstTab variable defines whether Header Tabs puts any content before the first defined header and put it into its own tab. By default this variable is set to false. You can enable this behavior by adding the default name using the following: 

$wgHeaderTabsDefaultFirstTab = 'DefaultTabName';

If using this setting, be careful not to enable $wgHeaderTabsRenderSingleTab as it will lead to tabs appearing in other parts of the UI.

$wgHeaderTabsDisableDefaultToc

The $wgHeaderTabsDisableDefaultToc variable defines whether Header Tabs will disable the MediaWiki article's table of contents (TOC) when tabs are enabled for a given article. This saves you the trouble of having to add __NOTOC__ to your article. If tabs are not enabled because of a lack of top-level headers, the table of contents will appear as usual. By default this variable is set to true, i.e. the MediaWiki TOC is disabled if header tabs are shown. You can disable this behavior by adding the following: 

$wgHeaderTabsDisableDefaultToc = false;

$wgHeaderTabsNoTabsInToc

If you want the page to have a TOC, but do not want to include the tab names in that TOC, add the following to LocalSettings.php: 

$wgHeaderTabsNoTabsInToc = true;

If, however, you only want to keep the tabs out of the TOC in some but not all pages, you can instead add the following to the top of any such pages: 

<notabtoc/>

$wgHeaderTabsGenerateTabTocs

The $wgHeaderTabsGenerateTabTocs variable defines if Header Tabs will try to generate a TOC for each tab. By default this variable is set to false, i.e. no tab TOCs will be generated. You can enable this behavior by adding the following: 

$wgHeaderTabsGenerateTabTocs = true;

$wgHeaderTabsEditTabLink

The $wgHeaderTabsEditTabLink variable defines if Header Tabs will add a edit link to the right of the tabs which let you edit only the tabs' text. By default this variable is set to true, i.e. a edit link for the tab will be shown. You can disable this behavior by adding the following: 

$wgHeaderTabsEditTabLink = false;

Version history

To see a list of changes for each version, see version history. For a list of features planned for future releases, please see roadmap.

Known limitations and issues

  • You cannot use the tag more than once. In other words, a second tag will not produce a second series of tabs.
  • Tabs render on top of infoboxes in Chrome.
  • Header Tabs will not work with the HTML Tidy tool, i.e. if $wgTidyConfig is populated.

Sections appearing outside the tabbed section

Header Tabs sections which include floated objects (such as infoboxes) may appear outside the tabs container if other content does not force the container to be large enough to hold the floated object. One resolution to this problem is to place a cleared html element at the very end of each section.

A simple, but not best-practice, means of doing this is:

<div style="clear:both"></div>

This forces this element to be considered by the browser after your floated object and thus will grow the container to fit both.

Support

The best way to seek help with this extension is to send questions to the mediawiki-l mailing list. The extension maintainers, and active users and contributors, are on this list and will be able to help you.

Contributing to the project

Bugs and feature requests

There are a number of ways to get support for Header Tabs, including questions, suggestions, bug reports and feature requests:

  • Place questions on the discussion page for Header Tabs.
  • You can submit bug reports and feature requests at MediaWiki's Phabricator site, here; enter "Header Tabs" in the "Tags" field. (The current list of known bugs and requested features for Header Tabs can be found here.)
  • Use the main MediaWiki mailing list, mediawiki-l.

Contributing patches to the project

If you found some bug and fixed it, or if you wrote code for a new feature, please either do a Git commit for it, or create a patch by going to the "HeaderTabs" directory, and typing: 

git diff > descriptivename.patch

If you create a patch, please send it, with a description, to Yaron Koren.

Translating

Translation of Header Tabs is done through translatewiki.net. The translation for this extension can be found here: https://translatewiki.net/wiki/Special:Translate?group=ext-headertabs. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

See also

Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:Header_Tabs&oldid=5525"