Dalmapedia:Standardi modula i predložaka

Dalmapedia: Standardi modula i predložaka

Ova stranica sadrži preporuke i smjernice za izradu, održavanje i budući razvoj Lua modula, predložaka, infookvira i SEO sustava na projektu Dalmapedia.

Svrha standardizacije jest:

• osigurati ujednačen izgled članaka;
• pojednostavniti održavanje koda;
• omogućiti lakše uključivanje novih suradnika;
• smanjiti mogućnost pogrešaka;
• olakšati buduće nadogradnje.

Opća načela

• Kod treba biti pregledan, čitljiv i komentiran.
• Nazivi parametara trebaju biti dosljedni.
• Novi moduli i predlošci trebaju biti unatrag kompatibilni kad god je to moguće.
• Izbjegavati nepotrebno umnažanje gotovo istoga koda.
• Kad god je moguće, koristiti postojeće pomoćne funkcije.

Standardni pomoćni blokovi Lua modula

Dohvaćanje parametara

<syntaxhighlight lang="lua"> local function getArg(args, name)

   local value = args[name]

   if not value then
       return ""
   end

   return mw.text.trim(value)

end </syntaxhighlight>

Obrada wikiteksta

<syntaxhighlight lang="lua"> local function pp(frame, text)

   if not text or text == "" then
       return ""
   end

   return frame:preprocess("\n" .. text)

end </syntaxhighlight>

Automatski opis za SEO

<syntaxhighlight lang="lua"> local function makeDescription(

   naslov,
   prijevod,
   definicija

)

   local desc = naslov

   if prijevod ~= "" then
       desc = desc
           .. " – "
           .. prijevod
   end

   if definicija ~= "" then
       desc = desc
           .. ". "
           .. definicija
   end

   return desc

end </syntaxhighlight>

Standardni parametri slika

Infookviri podržavaju:

|Slika=
|Slika2=
|Slika3=
...
|Slika20=

|Opis slike=
|Licenca slike=
|Pozicija slike=
|Veličina slike=
|Alt slike=

Preporučene pozicije slika

• zaglavlje
• objasnjenje
• definicija
• napomena
• znacenja
• primjeri
• sinonimi
• antonimi
• etimologija
• srodne
• frazeologija
• sintagma
• izvori
• dno

SEO standard

Dalmapedia koristi predložak:

{{SEO}}

SEO se po mogućnosti generira automatski iz Lua modula.

Automatski SEO

• description
• image
• image_alt

Ručni SEO override

|SEO ključne riječi=
|SEO slika=
|SEO alt=

Ako se SEO parametri ne ispune:

• opis se generira automatski;
• ključne riječi generiraju se automatski;
• prva slika postaje SEO slika;
• alt opis generira se automatski.

Standardni raspored parametara u infookvirima

Natuknica

|Dalmatinski=
|Hrvatski=
|Vrsta riječi=
|Izgovor=
|Izgovor audio=

Slike

|Slika=
|Opis slike=
|Licenca slike=
|Pozicija slike=
|Veličina slike=
|Alt slike=

SEO

|SEO ključne riječi=
|SEO slika=
|SEO alt=

Objašnjenje i značenja

|Objašnjenje=
|Definicija=
|Napomena=

|Značenje1=
|Značenje2=
|Značenje3=
|Značenje4=
|Značenje5=
|Značenje6=

Dodatne napomene

|Napomena1=
|Napomena2=
|Napomena3=
|Napomena4=

Jezični podaci

|Primjeri=
|Sinonimi=
|Antonimi=
|Srodne riječi=
|Frazeologija=
|Sintagma=
|Etimologija=

Izvori

|Izvor=
|Izvori=

Video

|Video1=
|Video2=
|Video3=

Kategorije

Kad god je moguće, kategorije se generiraju automatski.

Podržane su posebne početne skupine:

• Lj
• Nj
• Dž

U svim ostalim slučajevima koristi se prvo slovo naziva stranice.

Dokumentacija predložaka

Svaki predložak treba sadržavati:

• svrhu predloška;
• primjer uporabe;
• opis parametara;
• preporuke za uporabu;
• kategoriju predloška.

Dokumentacija modula

Svaki modul treba imati zaglavlje:

<syntaxhighlight lang="lua"> -- Dalmapedia -- Modul:NazivModula -- Verzija: -- Datum: -- Status: -- Stabilnost: -- Kompatibilnost: </syntaxhighlight>

Preporučuje se voditi i dnevnik promjena:

<syntaxhighlight lang="lua"> -- v1.0 -- v1.0.1 -- v1.0.2 </syntaxhighlight>

Načelo razvoja Dalmapedije

Prvo sadržaj, zatim automatizacija, a tek potom izgled.

Dalmapedia je prvenstveno digitalni libar Dalmacije. Tehnička rješenja trebaju služiti očuvanju, predstavljanju i dugoročnom održavanju znanja o Dalmaciji, njezinoj povijesti, jeziku, pomorstvu, podmorju i kulturnoj baštini.

Od fjake do podmorja.