Help:Extension:WebFonts

From MediaWiki.org
Jump to: navigation, search

Other languages:
العربية • ‎বাংলা • ‎dansk • ‎Deutsch • ‎Deutsch (Sie-Form)‎ • ‎Zazaki • ‎English • ‎British English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎ગુજરાતી • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Ripoarisch • ‎Lëtzebuergesch • ‎Baso Minangkabau • ‎मराठी • ‎Bahasa Melayu • ‎Nederlands • ‎occitan • ‎ଓଡ଼ିଆ • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎русский • ‎shqip • ‎தமிழ் • ‎Türkçe • ‎українська • ‎ייִדיש • ‎中文

This is user documentation for web fonts functionality. Technical documentation for the WebFonts extension is also available.

Many scripts for languages do not have proper fonts easily available. This may be because the operating systems does not have the fonts installed and the user does not know how to install them, or because the user is reading the wiki from a shared computer without the needed fonts installed. Because of all these reasons, providing the content in certain languages is facing issues. Web fonts solves this by embedding the fonts in wiki pages. The fonts are downloaded automatically so that the reading experience is complete and the reader doesn't see gibberish, questions marks or squares instead of letters.

Usage

WebFonts menu for an anonymous user

When the extension is installed and enabled, along with the login, preferences link in the wiki page, a menu will appear to select a font for the page. By default, the first font in that menu will be applied to the wiki. A user can change the font and it will be remembered across the pages. Optionally, the user can disable the font embedding too; this choice will also remembered across pages, even for next visits, for 30 days. The menu will not appear if there is no text in the page in a language WebFonts extension supports.

If the font is available in user's local system, font will not be downloaded from the MediaWiki server. It will be taken from the user's computer. Otherwise, the font will be downloaded from the server the first time it is needed. Next time onwards, the font will be taken from the local cache.

Disable web fonts

To disable WebFonts when you are not logged in: open the WebFonts menu and choose the bottom option "<webfonts-reset>" (see screenshot). This disables the functionality using a cookie for 30 days. Cached font files may remain rendered for "font-family" styles.

To disable WebFonts when you are logged in: "Preferences" ‎→ "Appearance" ‎→ Uncheck option "<webfonts-enable-preference>" ‎→ Click "Save" to save your settings.

List of supported scripts, languages and fonts

There is web fonts support for many scripts. Below you can find an exhaustive list of all scripts that are currently supported and the languages they are active for by default.

Arabic script

Supported languages: Persian (fa).

  • Iranian Sans

Assamese and Bengali script

Supported languages: Bengali (bn), Assamese (as) and Bishnupriya Manipuri (bpy).

  • Lohit Bengali (default)
  • Lohit Assamese

Devanagari script

Supported languages: Hindi (hi), Marathi (mr), Maithili (mai), Bhojpuri (bh, bho), Goan Konkani (gom), Ahirani (ahr).

  • Lohit Devanagari
  • Samyak Devanagari (not available in menu because of rendering issues)
  • Madan (not available in menu because of rendering issues)

Ethiopic (Geʻez) script

Supported languages: Amharic (am), Tigrinya (ti)

  • AbyssinicaSIL

Gujarati script

  • Lohit Gujarati
  • Samyak Gujarati

Gurmukhi script

  • Lohit Punjabi
  • Saab

Hebrew script

  • Miriam CLM
  • Taamey Frank CLM

Khmer script

Supported languages: Khmer (km).

  • KhmerOSbattambang
  • KhmerOSbokor
  • KhmerOSfreehand
  • KhmerOSmuol
  • KhmerOSmuollight
  • KhmerOSmuolpali
  • KhmerOSsiemreap

Kannada script

Supported languages: Kannada (kn), Tulu (tcy)

  • Lohit Kannada
  • Kedage

Latin script

  • Charis SIL – supports Min Dong Chinese
  • Perizia
  • RufScript
  • Ubuntu – stylized font made by Ubuntu

Malayalam script

  • AnjaliOldLipi
  • Meera
  • RaghuMalayalam

Myanmar (Burmese) script

  • Masterpiece Uni Sans
  • Myanmar3
  • Padauk-Regular
  • Yunghkio

Oriya script

  • Lohit Oriya
  • Utkal

Saurashtra script

  • Pagul

Tamil script

  • Lohit Tamil
  • Thendral
  • Thenee

Telugu script

  • Lohit Telugu
  • Pothana2000
  • Vemana2000

Advanced use

There are two ways in wiki text to trigger web fonts functionality. Text can be tagged with a language code and with a specific font style. When language tagging is used, the default web font for that language will be used. Language tagging is necessary when the language is different from the language of a page. Language tagging is encouraged, because it will also lead to improved search engine results, spell-checking, speech synthesis, speech recognition, etc.

To mark a paragraph of text as Hindi and load the default web font for it:

Source text Result
<div lang="hi">नमूना पाठ</div>
नमूना पाठ

To mark a paragraph of text as Hindi and load the non-standard web font "Samyak Devanagari" for it:

Source text Result
<div lang="hi" style="font-family: 'Samyak Devanagari'">नमूना पाठ</div>
नमूना पाठ


Limitations and known issues

Even if a browser supports web fonts, there is no guarantee that it can render the text correctly. This is often a problem for example in Indic scripts, where the glyphs are not just placed one after another without any changes, like in Latin and Cyrillic scripts. The correct rendering and rendering quality also depend on the browser and the operating system that is used. Modern web browsers and operating systems like recent Linux desktop distributions, Mac OS X and Windows 7 perform pretty well, but older web browsers (like Internet Explorer 6) and operating systems like Windows XP may provide a sub-optimal user experience.

Because of the flash of unstyled text (FOUT) that happens on first load, this technology gets unpractical if the font files grow very big. This currently prevents adding fonts for Chinese for example. The WebFonts extension does not support partial font downloading, where only those glyphs that are used in the page would be loaded.

Web fonts are currently not supported for Internet Explorer 6 on any Windows version or Internet Explorer 8 on Windows XP because of known issues.

A list of known issues is in the MediaWiki bug tracker.

New scripts, languages and translations

Only free fonts can be used for web fonts. The font license must allow redistributing the font and converting it to another formats. SIL Open Font License is preferred. Bugs or bad rendering caused by missing hinting information in the font may prevent using a font as a web font. If you are aware of a suitable font, please request it to be added in the the bug tracker.

Please report all issues in the bug tracker and translate this functionality at translatewiki.net.