Template:Script/Arabic/doc

This template is to render properly Arabic-based scripts which don't use the main Arabic alphabet, also to ensure that Arabic diacritics appear properly.

It is also used for the template:Arabic alphabet shapes.

Usage

 * to give you


 * The 1st parameter is mandatory and contains the text written in the Arabic script.
 * The optional  parameter can be used to override the generated style (for example another font size) or to specify additional CSS formattings (e.g. color).
 * The optional  parameter can be used for specifying additional HTML attributes (for example a descriptive  ).

Use simple ... for inline citation of Arabic language. Use rtl-para for entire paragraphs of Arabic text, however, they do not force choosing the fonts in that template.

Implementation
The template contains this phrase:


 * The font size was fixed at 125% for better readability.
 * The style  is provided by Template:Script/styles arabic.css and present to remove boldness, e.g. in section titles, because Arabic diacritics are best read only in normal weight, but also because some fonts do not exist in bold styles; without it, other fallback fonts would be used instead (possibly with lover coverage), or boldness may be synthetized from a non-bold font (making most diacritics unreadable).
 * Specifying the HTML attribute  in a   HTML element is sufficient to also activate on Wikipedia the   style which is part of the site-wide CSS stylesheet; this HTML attribute also activates the CSS style "direction: rtl" (which should be implemented by default in browsers, but is also set in the site-wide CSS stylesheet). This attribute can be disabled via no_rtl_mark with value   or   if necessary.

Fonts information
Template intended to force following fonts if installed:
 * Free fonts:
 * Scheherazade New or Scheherazade
 * Lateef (lacks a bold weight)
 * Amiri (appears feathery on Windows; errors with combining shadda with kasra and some Rohingya diacritics )
 * Noto Naskh Arabic
 * Droid Arabic Naskh (better at smaller sizes; has an error in displaying ريال )
 * Noto Sans Arabic
 * Harmattan (lacks a bold weight; errors with combining shadda with kasra)

These fonts contain all Arabic character defined in Unicode (see Arabic script in Unicode) for text in the various languages that use the Arabic script, but not all the redundant glyphs used in stylizing.

If the previous fonts are not installed, other fallback fonts would display:
 * Non-free fonts:
 * SF Arabic (is a complete Apple font)
 * Arial, Times New Roman (essentially look the same; lack a few characters; errors with combining shadda with kasra) Arabic Transparent
 * Caribri (only the newer versions render Arabic)
 * Microsoft Sans Serif (lacks a few characters; lacks a bold weight; errors with combining shadda with kasra)
 * Segoe UI (lacks a few characters; errors with combining shadda with kasra; in older versions, lacked a normal weight)
 * Sakkal Majalla (errors with combining shadda with kasra)
 * Microsoft Uighur (lacks a few characters; has errors with combining shadda with kasra; lacked a bold weight on older versions)
 * Arabic Typesetting (lacks a bold weight; errors with combining shadda with kasra)

How to override fonts in user's preferences
Any user can use another font with a different size by writing the following on his custom CSS. (see Help:User style)

An example making the font size 105%, and choosing Droid Arabic Naskh to be the main font with Arial as an additional font :
 * Font names containing spaces (or any other character than a letter) need to be put between  or.
 * The list of fonts should always be terminated by the pseudo-font names "sans-serif" and/or "serif", to allow using the fonts defined in user preferences in their browser, or the fonts set by default in browsers.
 * You may choose to add the line-height phrase if you wanted to make lines in a paragraph more spaced from each other, or less spaced.  Remember to put it before the }. The more number percentage, the more space is added. If you wanted to decrease the line height spacing, decrease the percentage. You may use any number (e.g. 85% or 140%) or use the special value "normal" which will properly use the minimum setting of the line-height recommended by each candidate font.
 * Some Arabic-based letters aren't rendered properly by some old versions of Times New Roman, such as: 0.6em which is used in Pashto and Uyghur; the newest versions of the following fonts render it properly: Scheherazade New, Scheherazade, Lateef, Amiri, Noto Naskh Arabic, Droid Arabic Naskh, Noto Sans Arabic, Harmattan, Arial, 'Times New Roman', 'Sakkal Majalla', 'Microsoft Uighur', 'Arabic Typesetting', 'Microsoft Sans Serif', 'Segoe UI'. (The newest versions which are available free-of-charge online are marked as bold.)


 * A demonstration with Scheherazade New or Scheherazade added first at 175%: موسوعة  That font is freely available online, but if you chose to use it, you must increase the text size, because it shows it very small compared to other fonts.
 * A demonstration with Droid Arabic Naskh added first at 105%: موسوعة  However, it has an error in displaying the word (ريال ), it is folded on itself, rather than normally rendered in naskh.
 * A demonstration with Noto Naskh Arabic added first at 125%: موسوعة  That font is freely available online.
 * A demonstration with Harmattan added first at 125%: موسوعة  That font is freely available online.

Example:

Another example without the notes:

Template Data
{	"params": { "1": {},		"no_rtl_mark": {}, "size": {}, "style": {}, "attributes": {} },	"paramOrder": [ "1",		"no_rtl_mark", "size", "style", "attributes" ] }