Manual:Tag extensions/ar

غالبا ما ستجد بعض المشاريع وحدها أنه من المفيد توسيع وسم الويكي المدمج باستخدام إمكانات إضافية، سواء كانت من ناحية معالجة السطور البرمجية البسيطة وصولا إلى سبل استرداد معلومات كاملة. تسمح امتدادات الوسوم للمستخدمين إنشاء وسوم جديدة مخصصة تفعل ما ذكرناه هنا. يمكن للمرء على سبيل المثال استخدام امتداد وسوم كي يضيف وسم  بسيط يعمل على إضافة نموذج تبرع إلى صفحة ما. إن الامتداد جنبا إلى جنب مع دوال المعرب اللغوي والروابط هي أفضل سبيل لتغيير وظائف برمجيات ميدياويكي أو تحسينها. عليك دائما التحقق من المصفوفة قبل الشروع في العمل على امتداد ما كي تتأكد أنه لا يوجد شخص آخر فعل ما سوف تشرع في عمله.

يتألف امتداد وسوم بسيط من دالة استدعاء التي توصل بالمعرب اللغوي حتى يتمكن حينما يعمل المعرب اللغوي من البحث عن كافة حالات ذكر وسم معين واستبداله وبالتالي استدعاء دالة الاستدعاء المعنية كي عرض صيغة إتش تي إم إل الفعلية.

مثال
In extension.json, set up the hooks:

And add the hook into a PHP file

يسجل هذا المثال دالة استدعاء من أجل وسم. حينما يضيف مستخدم هذا الوسم إلى صفحة مثل هذه: ، سيتولى المعرب اللغوي استدعاء دالة   ومن ثم تمرير أربعة متغيرات:


 * $input : مدخلات بين وسوم  و  أو null لو كان الوسم «مغلق - closed» أي
 * $args : متغيرات الوسوم، التي تدخل كما يجري إدخال نعوت وسوم إتش تي إم إل؛ هذه هي سلسلة مترابطة تفهرس حسب اسم النعت.
 * $parser : المعرب اللغوي الرئيسي (كائن المعرب اللغوي)؛ تستخدم الامتدادات المتقدمة المستوى هذه كي تحصل على العنوان حسب السياق وكذلك إعراب نصوص الويكي وتوسيع الأقواس وتسجيل علاقات الوصلات واعتمادها على بعضها البعض وخلافه.
 * $frame : الهيكل الرئيسي (عنصر PPFrame). يستخدم جنبا إلى جنب مع $parser لأغراض تزويد المعرب اللغوي بمعلومات كاملة عن السياق الذي استدعي فيه الامتداد.

لمزيد من الأمثلة المفصلة، طالع مثال امتداد الوسوم

النعوت
هيا بنا نشاهد مثال آخر:

يضيف هذا المثال النعوت التي مررت إلى الوسم مع قيمها. لا جدال أن هذا الأمر يسمح بوجود تحديد مرن للوسوم الجديدة والمخصصة. ربما تحدد على سبيل المثال امتداد وسوم يسمح للمستخدم بإضافة نموذج اتصال إلى صفحة المستخدم ذاته، مستخدما كود برمجي كالتالي.

ثمة وفرة فعلية في امتدادات الوسوم متاحة لبرمجيات ميدياويكي وبعضها مدرج على هذا الموقع بينما الآخرين يمكن العثور عليهم مستخدما بحث سريع على الوب. بينما أن عدد من هذه الامتدادات متخصص إلى حد ما من ناحية حالات الاستخدام، يوجد كم كبير الامتدادات المحبوبة شائعة الاستخدام التي تقدم مستويات مختلفة من السمات.

الأعراف
طالع لتتعرف على الهيئة العامة وكيفية تنصيب امتداد.

نشر امتداداتك

 * 1) أنشئ صفحة جديدة على موقع الويكي هذا تحمل اسم Extension:&lt;extension_name> تحمل معلومات عن امتدادك وكيفية تنصيبه ولقطات من الشاشة أثناء استخدامه. يوجد قالب مؤاتي جاهز لإضافة تلك المعلومات يحمل اسم . طالع صفحة القالب لتطلع على مزيد من المعلومات. يتعين عليك أيضا أن تضيف أكبر كم ممكن من التفاصيل إلى متن الصفحة ومن الحصيف أن تزور الصفحة تكرارا كي ترد على أسئلة المستخدمين على صفحة النقاش الملحقة. تأكد أيضا من أن الصفحة أضيفت إلى.
 * 2) يجب أن تسجل الامتدادات التي تحدد وصلات جديدة داخل كود الامتداد البرمجي في صفحة سجل وصلات الامتدادات.
 * 3) أبلغ القائمة البريدية mediawiki-l.

See also publishing your extension.

Security concerns
You'll notice above that the input in the examples above is escaped using  before being returned. It is vital that all user input is treated in this manner before echoing it back to the clients, to avoid introducing vectors for arbitrary HTML injection, which can lead to cross-site scripting vulnerabilities.

Loading modules
The right way to add modules for your extension is to attach them to the ParserOutput rather than to $wgOut. The module list will then be automatically taken from the ParserOutput object and added to $wgOut even when the page rendering is pre-cached. If you are directly adding the modules to $wgOut they might not be cached in the parser output.

Timing and extensions
If you change the code for an extension, all pages that use the extension will, theoretically, immediately reflect the results of new code. Technically speaking, this means your code is executed each and every time a page containing the extension is rendered.

In practice, this is often not the case, due to page caching - either by the MediaWiki software, the browser or by an intermediary proxy or firewall.

To bypass MediaWiki's parser cache and ensure a new version of the page is generated, click on edit, replace "action=edit" in the URL shown in the address bar of your browser by "action=purge" and submit the new URL. The page and all templates it references will be regenerated, ignoring all cached data. The purge action is needed if the main page itself is not modified, but the way it must be rendered has changed (the extension was modified, or only a referenced template was modified).

If this is not sufficient to get you a fresh copy of the page, you can normally bypass intermediary caches by adding '&rand=somerandomtext' to the end of the above URL. Make sure 'somerandomtext' is different every time.

How do I disable caching for pages using my extension?
Since MediaWiki 1.5, the parser is passed as the third parameter to an extension. This parser can be used to invalidate the cache like this:

Regenerating the page when another page is edited
Maybe you don't want to disable caching entirely, you just want the page to be regenerated whenever another page is edited, similar to the way that template transclusions are handled. This can be done using the parser object that is passed to your hook function. The following method was lifted from and appears to work for this purpose.

Fine grained adjustment of caching behavior
You can use fine grained caching for your extension by using cache keys to differentiate between different versions of your extension output. While rendering you can add cache keys for every feature by adding an addExtraKey method to your hook function, e.g.:

However, modifying $parser->getOptions during parse means that the extra option keys aren't included when trying to get a cached page, only when rendering a page to go into cache, so you can use the PageRenderingHash hook to set extra options. PageRenderingHash is run both when putting a page into cache, and getting it out, so its important to only add new keys to the hash if they're not already there. e.g:

Some important notes on this:

! is used a separator for different rendering options Be warned that addExtraKey does not tell the parser cache that the extra key is in use, and thus can easily result in breaking the cache if you are not careful.
 * Using "!setting1=$value" instead of just "!$value" in the confstr ensures that the parser cache does not become messed up if different extensions are installed or their load order changes.
 * Some people use  instead of.

Since version 1.16
Parser hook functions are passed a reference to the parser object and a frame object; these should be used to parse wikitext.

has been around since version 1.8. Its advantages include simplicity (it takes just one argument and returns a string) and the fact that it parses extension tags in, so you can nest extension tags.

The second parameter to recursiveTagParse,, is an optional argument introduced in MW 1.16 alpha (r55682).

In other words, content such as  will be recognized and converted into the appropriate value. Although this unlikely to be the desired behavior, this was the only option available before MW 1.16.
 * If  is provided (using the value of   passed to your extension), then any template parameters in   will be expanded.
 * If  is not provided (e.g.,  ), or if   is set to false, then template parameters will not be expanded;   will not be altered.

However, one step of parsing that is still skipped for tags, even when using recursiveTagParse, is Parser::preSaveTransform. preSaveTransform is the first step of parsing, responsible for making permanent changes to the about-to-be saved wikitext, such as:

(, ~ ,  )  Without this step, shorthand links such as Help:Contents are considered to be invalid, and are left in their wikitext form when parsed.
 * Converting signatures
 * Expanding link labels, also known as the pipe-trick (e.g., changing Help:Contents into Contents ).
 * Expanding templates.

The original call to preSaveTransform intentionally skips such conversions within all extension tags. If you need pre save transform to be done, you should consider using a parser function instead. All tag extensions can also be called as a parser function using  which will have pre save transform applied.

Since version 1.5
Since MediaWiki 1.5, XML-style parameters (tag attributes) are supported. The parameters are passed as the second parameter to the hook function, as an associative array. The value strings have already had HTML character entities decoded for you, so if you emit them back to HTML, don't forget to use, to avoid the risk of HTML injection.

How can I avoid modification of my extension's HTML output?
The return value of a tag extension is considered almost parsed text, which means its not treated as pure html, but still modified slightly. There are two main things that are done to the output of a tag extension (Along with a couple other minor things):

Strip markers are certain items which are inserted at various stages of processing wikitext to act as a marker to re-insert removed content at a later time. This is not something extensions usually need to worry about. This can sometimes be an issue in some extensions.
 * Replace strip markers.
 * which turns *'s into lists, and turns any line starting with a leading space into a &lt;pre&gt; among other things.

Tag extensions also support returning an array instead of just a string (Much like parser functions) in order to change how the return value is interpreted. The 0th value of the array must be the HTML. The "markerType" key can be set to  in order to stop further parsing. Doing something like  would ensure that the $html value is not further modified and treated as just plain html.

How do I get my extension to show up on Special:Version?
In order for your extension to be displayed on the MediaWiki Special:Version page, you must assign extension credits within the PHP code.

To do this, add a  variable as the first executable line of code before the hook line or function definition.

An example extension credit is:

Replace  with one of the following (unless your extension falls under multiple classes&mdash;then create a credit for each class):


 * 'specialpage'&mdash;reserved for additions to MediaWiki Special Pages;
 * 'parserhook'&mdash;used if your extension modifies, complements, or replaces the parser functions in MediaWiki;
 * 'variable'&mdash;extension that add multiple functionality to MediaWiki;
 * 'media'&mdash;used if your extension is a media handler of some sort
 * 'other'&mdash;all other extensions.

The  is the name of an interface/i18n message that describes your extension that will need to be defined in your extension's i18n.php file. If you omit this field, the  field will be used instead.

Retrieving the tag name inside of the callback
Suppose you have several tags  and   that share the same callback, and inside the callback function, you want to obtain the name of the tag that invoked the callback.

The short answer is: the tag name ( or  ) is not present in any of the callback's arguments. But you can work around this by dynamically constructing a separate callback for each tag:

Toolbar buttons
provides an editing toolbar, allowing users to add tags into their editor by simply clicking a button. If you want a toolbar button for your new tag, create a file named something like  in your extension's   folder. The file should look like this:

Further details about customizing this file can be found here. Once you've created the file, you need to register it with so it will be delivered to visitors; this is done by editing your  :

Then, in your PHP file:

طالع أيضا

 * – List of special tag/variables like,  , ...
 * – List of parser tags in use on Wikimedia wikis.