Pisanje GnuCash dokumentacije
Ako te zanima, kako poboljšati GnuCash dokumentaciju, tu si na pravom mjestu. Ova stranica pruža potrebne informacije o tome kako započeti.
Kao što su volonteri s vremenom razvili GnuCash aplikaciju, tako su i dobrovoljni programeri i korisnici napisali dokumentaciju, kako bi pomogli drugima naučiti raditi s GnuCashom. Rezultat ovog zajedničkog rada su dva glavna dokumenta: Priručnik za pomoć i Vježbe i koncepti.
GnuCash zajednica je zahvalna za svaku pomoć pri održavanju i poboljšanju programa i njegove dokumentacije. Ako želiš pisati, uređivati ili prevoditi GnuCash dokumentaciju, na ovoj ćeš stranici naći smjernice za pridruživanje zajednici.
GnuCash dokumentaciju možeš pregledati i preuzeti sa stranice s dokumentacijom.
Uvod
GnuCash dokumentacija se sprema u xml datotekama. Točnije, koristi se sustav docbook. To je relativno fleksibilan sustav koji koristi xml za ulazne datoteke, te je u stanju generirati dokumentaciju u nekoliko različitih izlaznih formata (html, pdf …).
Ako želiš pregledati ili napisati GnuCash dokumentaciju, morat ćeš znati xml. Neka osnovna znanja o sustavu docbook su također dobrodošla.
Sljedeće poveznice se odnose na daljnje web stranice, koje ti mogu pomoći u procesu dokumentiranja i recenziranja.
- DocBook: The Definitive Guide
- DocBook XSL: The Complete Guide
- GNOME Human Interface Guidelines
- Translating_the_GnuCash_Guide_and_Help: Iako se na GnuCash wiki stranici zapravo obrađuju teme o prevođenju dokumentacije, ona sadrži neke korisne informacije o radu s docbook datotekama.
- Documentation_Update_Instructions: Priručnik s detaljnim opisom za rad s dokumentacijom (aktualiziranje i održavanje).
Preporučujemo i pretplaćivanje na gnucash-devel.
Smjernice za Gnome dokumentaciju
Kao što je već rečeno, novi se dokumenti temelje na docbook sustavu. Sve zainteresirane molimo, da po mogućnosti slijede ove smjernice prilikom recenziranja i/ili pisanja dokumenata.
Gdje nabaviti izvornu građu dokumentacije
Trebat ćeš noviju kopiju izvorne dokumentacije. Pregledaj modul dokumentacije u gnucash‑docs git spremištu. Recenzenti mogu početi raditi i s trenutačno dostupnim dokumentima.
Za one koji ne poznaju Git, GnuCash wiki sadrži opis, koji je prilagođen GnuCash kodu. Za dohvaćanje izvorne građe dokumentacije umjesto izvornog programa, zamijeni „gnucash” s „gnucash‑docs” u navedenim git naredbama, na ovaj način:
git clone https://github.com/Gnucash/gnucash-docs.git
Postoje dva glavna paketa GnuCash dokumentacije, koji služe kao pomoć korisnicima: Priručnik za pomoć i Vježbe i koncepti. Pomoću gornje naredbe preuzet će se izvorni kod obaju paketa.
Autori dokumentacije
Nabavi kopiju izvorne dokumentacije kao što je gore opisano i započni s izmjenama. Kad si zadovoljan/na svojim promjenama, možeš započeti ispravak pokretanjem sljedeće naredbe u osnovnom direktoriju dokumentacije (obično gnucash‑docs, osim ako si je preimenovao/la):
git diff > my-patch-name.patch
Izvještaju o grešci zatim priloži ispravak na odgovarajuću komponentu documentacije u GnuCash bazi podataka grešaka. Pogledaj i GnuCash wiki stranicu na bugzilli za daljnje pojedinosti o dostavljanju ispravaka.
NAPOMENA: nekad je bilo u redu poslati ispravku izravno na pretplatničku listu gnucash‑devel. To više ne preporučujemo, jer se ispravak lako gubi u masi mnogih rasprava. Umjesto toga, priloži ispravak za greške u Bugzilli (na postojeću grešku ili na novu). Ako inzistiraš slati ispravke na gnucash-devel, moraš je priložiti izvještaju, a ne umetnuti/upisati u izvještaj.
Molimo te da obavijestiš druge autore o tome, koji odjeljak želiš obraditi. Proslijedi ga na gnucash-devel, tako da ostali mogu reći „pa ja već radim na tome” ili „nastavi s radom”.
Također možda želiš zadržati lokalnu kopiju stare dokumentacije, koja ti može pomoći prilikom pisanja. Ta dokumentacija još uvijek sadrži mnoge korisne informacije, koje nisu prenesene u nove dokumente.
Recenzenti
Nabavi kopiju izvorne dokumentacije kao što je gore opisano i počni je komentirati.
Najbolji način za čuvanje komentara o dokumentima i za njihovo jednostavno nalaženje je koristiti bugs.gnucash.org sustav za slanje grešaka o dokumentaciji. To se može uraditi i pomoću bug‑buddy.
