Modul:Lencong/doc

Ini ialah laman pendokumenan untuk Modul:Lencong

Halaman ini punya modul Lua digunakan in system messages.
Perubahan ke atasnya mungkin akan menyebabkan perubahan serta merta kepada antara muka pengguna Wikipedia.
Untuk mengelakkan gangguan besar-besaran, sebarang perubahan sepatutnya diuji pada modul punya subhalaman kotak pasir atau laman uji kaji, atau pada module sandbox anda. Perubahan yang sudah diuji boleh ditambah pada laman ini dalam suntingan tunggal. Sila bincangkan perubahan pada laman perbincangan sebelum melaksanakannya.

Modul ini ditaraf beta, dan dapat digunakan. Ia masih baharu dan harus digunakan dengan berhati-hati agar hasilannya seperti yang dijangkakan.

Modul ini menerima nama sebuah laman. Ia menentukan sama ada laman itu sebuah lencongan; jika ya, ia akan mencari laman, menyari sasaran dan memulangkan nama sasaran sebagai teks. Cara menggunanya ialah {{#invoke:lencong|main|nama-laman-sasaran-lencongan}}.

Templat lazimnya tidak menerima ataupun menyediakan tanda kurung siku [ ], justeru untuk memaparkan hasilan sebagai sebuah pautan, gunakan [[{{#invoke:lencong|main|nama-laman-sasaran-lencongan}}]]. Pautan merah akan ditimbulkan jika laman sasaran tidak wujud. Ralat akan ditimbulkan jika nama modul (dalam kes ini, lencong) disalah eja atau ditaip dengan huruf besar seperti yang biasa dilakukan (yakni, #LENCONG) akan tetapi tidak ada ralat akan dipaparkan jika fail bukan sebuah lencongan (teks asal dipulangkan) ataupun jika nama fail kosong (mulangkan laman kosong).

Walau bagaimanapun, jika parameter tanda kurung siku diberi sebagai nilai tak kosong, tanda kurung siku akan dilanjutkan dan dipaparkan pada laman.