Modul dokumentacije i pomoći

Neki moduli zapravo ne zahtevaju da vi nešto radite i oni jednostavno rade svoj posao u pozadini. Međutim, ti moduli verovatno nemaju podesive opcije ili služe samo kao zavisnosti drugim modulima.

Najčešće je modul koji vas zanima onaj za koji možete podesiti dozvole i opcije. Neki projekti su jednostavni za korišćenje, tj. njihova upotreba je „intuitivna“, i biće vam relativno jasno šta možete podesiti i šta treba da uradite da biste postigli željeni rezultat.

Ako želite saznati sve detalje potrebne za pametno korišćenje upravo instaliranog modula, mogu da predložim nekoliko stvari koje bi vam mogle koristiti ili mesta gde možete potražiti informacije.

Sledeći saveti su poređani po jednostavnosti korišćenja.

Nažalost, za početnike kao što smo mi, Drupal je u stalnom razvoju, i iako smo srećni što možemo besplatno koristiti sav ogroman rad developera, njihovo vreme je ograničeno, i mogu sa sigurnošću reći da najbolji developeri nisu uvek i najrevnosniji kreatori dokumentacije za početnike kakvi smo mi, inače vas i mene ne bi bilo ovde sada.

Preporučujem vam da dokumentujete i objavite svoja iskustva i poteškoće dok učite da koristite Drupal, za dobrobit hiljada ljudi koji će biti na vašem mestu u narednim danima, mesecima i godinama.

Uzimam ovo kao krajnji izazov pri kreiranju ove dokumentacije, uprkos (ili zbog) čestih frustracija, razočaranja i izazova – korišćenja novog dokumentacionog odeljka u Drupalu – i, donekle, otklanjanja problema učenja i korišćenja Drupala koje bi drugi početnici poput vas i mene ranije mogli da reše ako bi napravili adekvatna uputstva za početnike, ali posebno sam srećan što ćete vi, moj prijatelju, imati korist od toga.

Ne morate ništa znati o „razvoju“ ili programiranju da biste podelili ono što ste „naučili“ i znate.

Metodom pokušaja i grešaka

Možete jednostavno zaroniti i početi da koristite modul ili da se igrate sa njegovim podešavanjima.

Kada istraživanjem ne možete shvatiti šta neka opcija radi ili kakve posledice može imati njeno korišćenje, jednostavno možete isprobati sve što vam intuicija kaže da je najbolje.

Kad god dođete do tačke gde modul zahteva nagađanje sa vaše strane, ne morate se brinuti da probate bilo koju opciju jer će vam pravljenje rezervne kopije sajta uvek pomoći da se vratite na prethodnu verziju sajta. Pravi li ste backup vašeg sajta, zar ne?

Pošto možda nije odmah jasno da će svi efekti koje modul ili određena opcija tog modula izazivaju biti prisutni na sajtu, zato vam savetujem da isprobavate samo jedan modul u isto vreme i da pregledate svaki kutak vašeg sajta i pokušate da koristite sajt na sve moguće načine – pravite nove stranice i testirate različite konfiguracije – pre nego što pređete na dodavanje drugog contrib modula.

U suprotnom, ako uključite više novih modula, a zatim naiđete na probleme ili situacije koje vam deluju čudno, nećete znati koji od novih modula je uzrok problema.

Sadržaj stranice projekta

Svaka stranica projekta modula je njegova početna stranica na drupal.org. Obično prvo posećujem tu stranicu kada razmišljam da li da isprobam modul ili kada imam problema ili pitanja o modulu koji sam upravo uključio.

Ako pažljivo pročitate stranicu projekta u celini, možete biti prilično sigurni da imate sve najvažnije informacije koje su vam potrebne. Na primer, ako razmatrate da li da isprobate modul, svi moduli od kojih zavisi taj modul biće navedeni negde na stranici projekta.

Stranica projekta može takođe sadržati druge korisne linkove koji se odnose na mnoge stvari vezane za taj modul.

Sadržaj stranice projekta može biti namenjen novim Drupal korisnicima ili može biti usmeren ka naprednijim korisnicima / developerima.

Link „Pročitaj dokumentaciju“ na stranici projekta (ako postoji)

U desnom stubcu (stubac koji se spušta do dna stranice na mobilnim uređajima ili u uskim prozorima pregledača) uvek ćete naći naslov „Resursi“, ispod kojeg možete ili ne morate pronaći link „Pročitaj dokumentaciju“.

Međutim, ne na svim stranicama projekta postoji link „Pročitaj dokumentaciju“, i u tom slučaju se nadamo da ćete naći korisne linkove ka dokumentaciji u glavnom delu sadržaja stranice projekta.

Kada postoji link „Pročitaj dokumentaciju“, to je ono što developeri smatraju najprikladnijim resursom za početak traženja dodatnih informacija.

Sadržaj svake stranice projekta određuje i kontroliše originalni autor tog projekta i eventualno još nekoliko ljudi kojima je autor dao ovlašćenja.

Ostali članovi drupal.org koji nemaju pristup uređivanju stranice projekta često kreiraju druge stranice na d.o. sa odličnim informacijama o modulu koji vas zanima. Nažalost, te druge stranice retko imaju linkove na samoj stranici projekta.

Pronalaženje tih stranica koje nisu povezane na stranici projekta biće objašnjeno u odeljku pretraživanja Google pretraga ograničena na drupal.org ⤵

README.txt fajl modula

README.txt fajl je istorijski služio kao zvanično mesto gde je dokumentovana sva važna i neophodna informacija za modul (ili temu), uključujući i sve što se odnosi na ažuriranje modula (ili teme) na noviju verziju.

README.txt fajl se nalazi u glavnom folderu contrib modula (ili teme) nakon izdvajanja, ako postoji.

Da biste pregledali README.txt fajl modula (ili teme) bez preuzimanja, idite na link:

http://cgit.drupalcode.org/project/PROJECT_MACHINE_NAME.git/blob/HEAD:/README.txt

Zamenite izraz PROJECT_MACHINE_NAME u URL-u iznad sa kratkim „mašinskim imenom“ konkretnog projekta.

„Mašinsko ime“ se nalazi u URL adresi vašeg pregledača kada ste na bilo kojoj stranici projekta na drupal.org, kao deo URL-a „PROJECT_MACHINE_NAME“ u sledećem primeru URL-a, koji je primer URL-a za svaki projekat:

https://www.drupal.org/project/PROJECT_MACHINE_NAME

Ako README.txt fajl ne postoji, verovatno je reč o modulu koji nema podesive opcije i koji samo radi u pozadini i neophodan je za rad drugih contrib modula.

Ako README.txt ne postoji ili jednostavno želite da pregledate svu ostalu dokumentaciju projekta, koristite sledeći URL (zamenite „PROJECT_MACHINE_NAME“):

http://cgit.drupalcode.org/PROJECT_MACHINE_NAME/tree/?id=HEAD

U gornjem desnom uglu ove stranice „drupalcode.org“ možda ćete morati da „prebacite“ na verziju Drupal kernela koju želite da istražite.

Google pretraga ograničena na drupal.org

Ako želite da pretraga bude ograničena samo na ceo sajt drupal.org, to je metoda koju ja koristim. Ovaj metod koristim često za pretraživanje drupal.org ili bilo kog drugog domena po izboru.

Idem na google.com ⎘ i ukucam:

site:drupal.org

Obratite pažnju da nema razmaka između dvotačke (":") i imena domena. Takođe, ne koristite „www.“ na početku imena domena.

Dodajte razmak posle imena domena i unesite ključne reči koje želite da pretražujete, na primer za današnju temu – ime modula.

Ponekad mi pomaže da dodatno ograničim Google pretragu na „Drupal 8“ (umesto da dobijem rezultate i za D6, D7...) tako što dodam „Drupal 8“ u polje za tekst Google pretrage. Koristeći navodnike, Google će zatim vratiti rezultate koji sadrže tačan izraz sa dva ili više reči unutar navodnika. (uglavnom)

Da biste videli koje informacije postoje o određenom modulu bilo gde na internetu, uključujući stranice unutar i van drupal.org, izostavite „site:drupal.org“ iz pretrage.

Da biste na Google pretrazi prikazali 100 rezultata po stranici umesto 10, na bilo kojoj stranici rezultata Google pretrage kliknite na ikonu „zupčanik“ u gornjem desnom uglu i u padajućem meniju izaberite „Podešavanja pretrage“. Na sledećoj stranici, pod naslovom „Google instant predlozi“, uključite opciju „Nikada ne prikazuj instant rezultate“. Zatim pod naslovom „Rezultati po stranici“ pomerite klizač maksimalno udesno. Vaše pretrage će sada trajati nekoliko milisekundi duže.

Napomena: možda ste razmišljali da koristite pretraživač koji drupal.org pruža na vrhu svojih stranica. Probavao sam to nekoliko puta i savetovao bih vam da probate i sami, ako volite besmislene vežbe.

Dugmad / linkovi „Pomoć“ na stranici „Proširenja“ vašeg sajta (ako postoje)

Na stranici „Proširenja“ vašeg sajta, desno od imena svakog modula, možete videti prvu liniju njegovog opisa ako je vaš prozor pregledača dovoljno širok.

Ako kliknete na tu prvu liniju opisa, ona će se proširiti i prikazaće ostatak opisa, kao i dugmad / linkove „Pomoć“, „Dozvole“ i „Podesi“ za taj modul, kada su ti elementi dostupni.

Ako odmah ne vidite prvu liniju opisa modula pored njegovog imena i želite je videti, pratite uputstva na stranici konfiguracije modula.

Nažalost, da biste pristupili stranici pomoći na vašem sajtu za modul, neophodno je ne samo da uvezete modul na svoj sajt, već i dugme/link „Pomoć“ će biti vidljivo samo ako je modul omogućen. Nažalost, ne svi contrib ili core moduli imaju dugme/link „Pomoć“, i nećete znati da li postoji dok ga ne uključite.

Zbog ovih problema, nikada se nisam oslanjao ni koristio dugmad „Pomoć“, mada sada vidim da često vode na stranice sa korisnim informacijama.