Kitaen ti taudan para iti Modulo:Hatnote/dok

{{Subpanid ti dokumentasion}}
{{Adu a panagusar}}
{{Agus-usar iti TemplateStyles|Modulo:Hatnote/styles.css}}

Daytoy ket meta-modulo a mangited kadagiti nadumaduma nga annong para iti panagaramid kadagiti hatnote. Daytoy ket isayangkatna ti plantilia ti {{tl|hatnote}}, para iti panagusar kadagiti hatnote iti ngato dagiti panid, ken ti plantilia ti {{tl|pormaten ti silpo}}, a maus-usar a mangpormat ti silpo ti wiki para iti panagusar kadagiti hatnote. Daytoy ket aglaon pay kadagiti nadumaduma nga annong para iti panagusar kadagiti sabali a hatnote a modulo ti Lua.

== Panagusar manipud iti wikitext ==

Dagiti annong iti daytoy a modulo ket saan a dagus a mabalin a mausar manipud iti #invoke, ken imbes ket a nasken a mausar babaen kadagiti plantilia. Pangngaasi a kitaen ti [[Plantilia:Hatnote]] ken [[Plantilia:Pormaten ti silpo]] para iti dokumentasion.

== Panagusar manipud kadagiti sabali a modulo ti Lua ==

Ti mangikarga daytoy a modulo manipud iti sabali a modulo ti Lua, usaren ti sumaganad a kodigo.

<syntaxhighlight lang="lua">
local mHatnote = require('Modulo:Hatnote')
</syntaxhighlight>

Kalpasanna mabalinton nga usaren dagiti annong a kas ti nadokumentuan dita baba.

=== Hatnote ===

<syntaxhighlight lang="lua">
mHatnote._hatnote(s, options)
</syntaxhighlight>

Pormatenna ti kuerdas ti <var>s</var> a kas hatnote. Daytoy ket rikpanna ti <var>s</var> kadagiti etiketa ti {{tag|div|params=class="hatnote"}}. Dagiti pagpilian ket naited iti tabla ti <var>options</var> . Dagiti pagpilian ket mairaman ti:
* <var>options.extraclasses</var> – ti kuerdas dagiti nayon a klase a maited
* <var>options.selfref</var> – no daytoy ket saan a nil wenno false, manginayon daytoy ti klase ti "selfref", inus-usar daytoy a mangibaga kadagiti bukod a reperensia iti Wikipedia (kitaen ti [[Plantilia:Selfref]]))
Ti CSS ti klase ti hatnote ket naipalawag idiay [[Module:Hatnote/styles.css]].

; Kas pagarigan 1

<syntaxhighlight lang="lua">
mHatnote._hatnote('Daytoy ket hatnote.')
</syntaxhighlight>

Maited:
{{tag|div|content=Daytoy ket hatnote.|params=class="hatnote"}}

Maiparang a kas:
{{hatnote|Daytoy ket hatnote.}}

; Kas pagarigan 2

<syntaxhighlight lang="lua">
mHatnote._hatnote('Daytoy ket hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})
</syntaxhighlight>

Maited:
{{tag|div|content=Daytoy ket hatnote.|params=class="hatnote boilerplate seealso selfref"}}

Maiparang a kas:
{{hatnote|Daytoy ket hatnote.|extraclasses=boilerplate seealso|selfref=true}}

=== Biruken ti ID ti nagan ti espasio ===

<syntaxhighlight lang="lua">
mHatnote.findNamespaceId(link, removeColon)
</syntaxhighlight>

Birukenna ti [[WP:NS|id ti nagan ti espasio]] iti kuerdas ti <var>link</var>, a nasken koma nga umiso a nagan ti panid, nga addaan iti wenno awan iti nagan ti paset. Daytoy nga annong ket saan a mabalin no ti nagan ti panid ket narikpan kadagiti kuadrado a pangrikep. No agpadpadas a mangiwaswas ti nagan ti nagan ti espasio, maikkat dagiti dua-tuldek manipud iti rugi ti silpo babaen ti kasisigud. Daytoy ket naserbi no dagiti agar-aramat ket innagananda dagiti dua-tuldek no saan dagitoy a nainget a nasken. No masapul a kitaen para kadagiti umuna a kolon, isaad ti <var>removeColon</var> iti false.

;Kas pagarigan:
: {{kodigo|mHatnote.findNamespaceId('Leon')|lua}} → 0
: {{kodigo|mHatnote.findNamespaceId('Kategoria:Dagiti leon')|lua}} → 14
: {{kodigo|mHatnote.findNamespaceId(':Kategoria:Dagiti leon')|lua}} → 14
: {{kodigo|mHatnote.findNamespaceId(':Kategoria:Dagiti leon', false)|lua}} → 0 (ti nagan ti espasio ket maduktalan a kas ti ":Kategoria", imbes a kas ti "Kategoria")

=== Agaramid ti biddut iti wikitext ===

<syntaxhighlight lang="lua">
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
</syntaxhighlight>

Pormatenna ti kuerdas ti <var>msg</var> a kas nalabbasit a mensahe ti biddut iti wikitext, nga addaan iti pagpilian a silpo iti panid ti tulong <var>helpLink</var>. Kadawyan a daytoy nga annong ket manginayon pay ti {{clc|Kategoria:Dagiti plantilia ti hatnote nga agraman kadagiti biddut}}; nupay kasta, no ti <var>addTrackingCategory</var> ket saan a false kalpasan a maipasa babaen ti [[Modulo:Wensaan]], ti kategoria ket mapasardengto. Ti kayatna a sawen daytoy ket ti kategoria ket mabalin a mapasardeng babaen kadagiti pateg ti <var>addTrackingCategory</var> a mairaman ti "no", "n", 0, "false", "saan", "s" ken {{kodigo|false|lua}}.

Kas pagarigan:
:{{kodigo|mHatnote.makeWikitextError('adda rimsua a biddut')|lua}} → <strong class="error">Biddut: adda rimsua a biddut.</strong>
:{{kodigo|mHatnote.makeWikitextError('adda rimsua a biddut', 'Plantilia:Kaspagarigan#Dagiti biddut')|lua}} → <strong class="error">Biddut: adda rimsua a biddut ([[Plantilia:Kaspagarigan#Dagiti biddut|tulong]]).</strong>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|pagipadasan||
<!-- Ikabil dagiti kategoria dita baba ken dagiti interwiki idiay Wikidata -->
[[Kategoria:Dagiti modulo ti hatnote| ]]
[[Kategoria:Dagiti modulo nga aginayon iti pagsurotan a kategoria]]
}}</includeonly>