Pomoć:Pravila i preporuke

Izvor: HrOpenWiki
Inačica od 11:21, 12. prosinca 2008. koju je unio/unijela Grof (razgovor | doprinosi)

Skoči na: orijentacija, traži

Kako pisati Wiki tesktove

Prije nego se odlučimo za pisanje nekog teksta ili njegov prenos sa pojedinih stranica (pazeći na autorska prava! po sistemu prvo pitaj, pa kopiraj) bilo bi dobro da pripazimo na par stvari prilikom pisanja ili uređivanja materijala

Ovim tekstom pokušat ću vam dati par savjeta kako pisati i što izbjegavati u tekstu zbog "lakše budućnosti"

  • Da bi uopće pristupili psanju ili uređivanju stranica morate se logirati u sustav. Iz sigurnosnih razloga zatvoreno je uređivanje Wikija nelogiranim korisnicima
  • Kod pisanja tesktova budite općeniti, pokušajte dati kvalitetnu informaciju, ali općenitu. To se posebno odnosi na opise distribucija ili aplikacija. Posebno izbjegavajte pisati koja je zadnja verzija, datume izlaska i sve stvari koje brzo zastarjevaju. Ne možemo se oslanjati na nečiju stalnu ažurnost podataka koji se mjenjaju iz mjeseca u mjesec. Bolje je dati kvalitetan link na neku stranicu nakojoj piše koja je zadnja verzija (obično su to službene stranice) nego sami prepisivati takve podatke
  • Budite što je moguće više objektivni. Ne hvalite i ne kudite. Pišite onako kako jest. Nikoga ne zanimaju vaša osobna mišljenja o npr. nekoj distri. Ako vam se ne sviđa distribucija o kojoj želite pisati, onda nemojte pisati. Wiki stranice namjenjene su za objektivnu informaciju. Za stavove služe forumi...
  • Ovo je Hrvatski Wiki pa pokušajte u što većoj mjeri koristiti hrvatske izraze. Ako neki izraz baš ne postoji ili bi bio totalno nerazumljiv i van konteksta onda pišite engleski naziv uz objašnjenje
  • Nismo svi vični pisanju i kvalitetnom slaganju rečenica. Oni kojima pisanje baš i ne ide, mogu na druge načine pomoći u izradi Wiki materijala. Npr. Uzmite sa drugih portala i foruma već napisane informacije i pretačite ih u ovaj Wiki.
  • Prije pisanja novih tekstova pogledajte da li postoji već neki tekst napisan u toj sekciji Wikija, kako bi pratili formu teksta.
  • Svaka Wiki stranica ima i svoju "paralelu" koja se zove Razgovor (drugi ribbon na vrhu stranice) i služi za diskusije, pitanja i sve ostalo vezano za sadržaj glavne stranice, pa tamo ostavljajte svoja pitanja, komentare i sl.
  • Za sve nejasnoće možete se javiti i meni (Grof) na stranicama foruma LZS-a

Tehnika pisanja stranica

U ovom tekstu dajem prijedlog o unificiranom pisanju ovih wiki stranica. Iz jednostavnog razloga kako bi se korisnik istih što lakše u njima snalazio i već prema određenom polju na stranici znao kakvu informaciju može tamo očekivati. Iz tih razloga dajem prijedlog da se stranice i malo ofarbaju, kako bi se dobio i malo življi "štih".

Pa krećemo:

Uvodna poglavlja

Uvod

Sve stranice na kojim su korisne inofrmacije, trebale bi početi sa nekim uvodnim - općenitim tekstom kao sažetkom o tome o čemu ta stranica detaljno govori u samom tijelu teksta. Na taj način postižemo preglednost na stranici, te posjetitelj iste vrlo lako može odmah vidjeti da li stranica na kojoj se nalazi sadrži točno ono što mu treba.

Dakle, sav uvod ide u ove smeđkaste okvire, da se lagano istakne od ostalog dijela teskta.

Code uvoda izgleda ovako

 {{Robelbox|theme=1|title=Uvodna poglavlja}}<div style="{{Robelbox/pad}}">
 Ovdje se piše tekst
 </div>
 {{Robelbox-close}}
 

Tijelo teksta

Sav "bitan" i opširan dio teksta koji konkretno govori o onome iz uvodnika ide u normalnu, bijelu pozadinu bez ikakvog naglaska. Tu se pišu npr. svi koraci u rješvanju nekog problema, detaljno se opisuje problem itd. Sve zavisi o prirodi teksta.

Ako tekst govori o nekim rješenjima unutar npr. operativnog sistema. Konkretno, ako je potrebno izvesti neke korake u kodu ili na CLI-u (Command Line Interpreter), tj. na konzoli ili terminalu OS-a, onda se te komande pišu obavezno u ovakvom formatu:

U ovakvim okvirima se pišu komandne linije koje se izvršavaju u konzoli
TUX.png

Ako želite u tekst stavljati slike, bilo bi dobro da se iste smještaju uz desni rub teksta, kako ne bi ometale čitača u koncentraciji na tekst. Slike mogu biti različite, mogu se smještati u u okvire itd... Sve samo da se zadrži koncepcija stranice.

U tekstovima se mogu koristiti i bullet i numerirane liste kao u ovom primjeru:

Bullet:

  • Prva stavka
  • Druga stavka
  • treća...

A moguće su i liste:

  1. stavka liste
  2. stavka liste
  3. stavka liste
  4. ....

Tekst može sadržavati kratke informativne dialoge. Predlažem postavljati uvijek sa desne strane, kao što je u ovim prijedlozima. Slijedi tekst sa opisima ovih dialoga i njihovim izgledom:


Error.png
Opasnost

Opasnosti sadrže opaske na opasne radnje.

Opasnost!

Sadrže sav tekst koji upozorava na izuzetno opasnu radnju tipa particioniranje diskova, brisanje podataka i sve ostalo što može trajno štetiti djelove operativnog sustava ili podatke.

Code izgleda ovako:

{{Dangerbox|text=Opasnosti sadrže opaske na opasne radnje.}}
 


Warning.png
Upozorenje

Upozorenja sadrže opaske na radnje na koje treba posvetiti posebnu pozornost.

Upozorenje

U dialoge upozorenja treba pisati tekstove koji se odnose na stvari koje iziskuju dodatnu pažnju čitača Wikija. Npr. ako stranica govori o kompajliranju nekog drivera, u ovakav okvir trebalo bi smjestiti tekst koji govori o tome da korisnik prije toga provjeri da li je instalirao sve potrebno kako bi kompajliranje prošlo kako treba.

Tu mogu ići i tekstovi o nekim požeeljnjim radnjama itd...

Code izgleda ovako:

{{Warningbox|text=Upozorenja sadrže opaske na radnje na koje treba posvetiti posebnu pozornost.}}
 


Info.png
Informacija

Informacije služe za skretanje pažnje na neke dodatne stvari vezane uz tekst.

Informacija

Tekstovi u informativnim dialozima mogu skretati pozornost čitača na dodatne, zgodne ali ne tako bitne stvari u temi o kojoj govori tekst, točnije na pisanje opaski. Tipa, ako tekst govori o OpenOffice-u, u takav dialog može se staviti opaska da postoje i drugi slobodni programi za pisanje teksta....

Code izgleda ovako:


 {{Infobox|text=Informacije služe za skretanje pažnje na neke dodatne stvari vezane uz tekst.}}
 


Dakle, sav "glavni" tekst piše se na ovakvoj bijeloj podlozi sa eventualnim umecima slika ili dialog boxova čiji su primjeri dati u gornjem dijelu teksta.

Osim ovog, glavnog teksta postoje još neka specifična područja na stranici koja bi trebalo dodatno označiti.


Linkovi prema drugim stranicama koje se granaju iz ove

Linkovi na daljnje stranice

Ako treba postaviti linkove na stranice koje se granaju iz trenutne, poželjno je takve linkove postaviti u jedan ovakav box, kako bi se čitaču dalo do znanja da od tuda vode linkovi za još preciznije informacije o nekoj temi.

Code izgleda ovako

{{Robelbox|theme=13|title=Linkovi prema drugim stranicama koje se granaju iz ove}}<div style="{{Robelbox/pad}}">
Ovdje se piše tekst
</div>
{{Robelbox-close}}
 
Linkovi na rješenja istog problema, ali po distribucijama

Linkovi rješenja problema po distribucijama

Iz ovakvog dialog boxa-a vode linkovi na rješenja pojedinih problema vezano za distribucije. Nemaju sve distribucije GNU/Linux-a isti redosljed i iste komande pri rješavanju istih problema. Kako bi se korisnicima distribucija olakšalo rješavanje, svaka distribucija na ovaj način ima svoje rješenje.

Code izgleda ovako

{{Robelbox|theme=3|title=Linkovi na rješenja istog problema, ali po distribucijama}}<div style="{{Robelbox/pad}}">
Ovdje se piše tekst
</div>
{{Robelbox-close}}
 
Linkovi na reference, e-mailove i ostalo

Linkovi na reference, e-mailove i ostalo

Na kraju teksta koji govori o nečemu poželjno je postaviti linkove na originalne tekstove od kuda je neka stvar pokupljena ili na linkove koji detaljnije opisuju neku stvar ali nisu na našem jeziku, pa npr na e-mailove pisaca tekstova (ako oni to žele) i ostalo....

Code izgleda ovako

{{Robelbox|theme=14|title=Linkovi na reference, e-mailove i ostalo}}<div style="{{Robelbox/pad}}">
Ovdje se piše tekst
</div>
{{Robelbox-close}}
 

Neki korisni alati pri izradi Wiki stranica

Ugradili smo na Wiki neke zgodne alate koji mogu pomoći pri ažuriranju i kreiranju Wiki stranica:

TODO sistem

U slučaju da želite nekome ostaviti poruku da nešto treba doraditi na stranici dovoljno je da na kraju teksta otipkate ovo:

{{todo|Poruka TODO zadataka|nick_kome_se_šalje}}

na primjer:

{{todo|Poruka TODO zadataka|Admin}}

a može i bez naslovljavanja na koga ovako:

{{todo|Poruka TODO zadataka}}
 

Cijela stvar izgleda ovako:

TODO: {{#todo:Poruka TODO zadataka|Admin|}}

ili

TODO: {{#todo:Poruka TODO zadataka||}}

Korisnik na kojega je TODO naslovljen primit će i e-mail poruku od Wiki sistema da ima TODO na stranici.

Bojanje sintakse CLI naredbi

Također je dodan i dodatak za bojanje naredbi unutar CLI sintakse. Ako želite malo bolje označiti sintaksu nekog Bash ili programskog codea, to možete putem ovog dodatka. Radi se prema ovom primjeru:

sudo gedit /etc/X11/xorg.conf

Eto, to bi bio moj prijedlog kako bi neka stranica trebala izgledati i koje bi elemente mogla sadržavati.

bitno je da se držimo boja ovih boxova, jer se tako stvara "navika" u pregledavanju wikija koja olakšava buduće snalaženje korisnicima.

Slobodan čuti i Vaša mišljenja koja možete pisati ili pod "razgovor" tab-u ove wiki stranice ili na LZS-u.

Pozdrav, --Grof 15:05, 23. studenog 2008. (UTC)


Za autore

Pogledajte dokumentaciju o prilagodbi sučelja i Vodič za suradnike za pomoć pri uporabi i podešavanju, te ova pravila i preporuke