KWave - Příručka: 5. Vývojářův průvodce k programu Kwave

5. Vývojářův průvodce k programu Kwave

ve výstavbě
Promiňte, ale tato kapitola se musí teprve napsat... V tuto chvíli je zdrojový kód téměř úplně zdokumentován se značkami vhodnými pro KDE dokumentační nástroje. V současnosti dáváme přednost používání doxygen. Možná jednoho dne strávíme více času při psaní nástroje, který převede výstup doxygenu do něčeho, co budeme moci začlenit do zdroje docbooku (zdrojový kód této stránky z něj byl postaven).
Pokud chcete napsat přídavný modul, přispět něčím tomuto projektu (nebo snad napsat převodník zmíněný výše), pociťujte, prosím, svobodu spojit se přímo s jedním z autorů a/nebo se přihlásit k Kwave mejlovacímu seznamu. Pomoc je vždy vítána!

Vytvoření dokumentace API

Pokud máte zájem o vnitřnosti Kwave a máte nainstalován doxygen, pak můžete napsat: 
% make apidoc
pro obdržení podadresáře apicod/html s dokumentací zdrojového kódu a vnitřního rozhraní ve svém sestavovacím adresáři.

Spuštění ve zkoušecím prostředí

Pokud vyvíjíte nebo zkoušíte Kwave, potom pro vás není nezbytné nutné Kwave instalovat/odinstalovat po každém sestavení. Namísto toho můžete program použít s pomocí wrapper skriptu tam, kde byla vytvořena. Tento wrapper skript lze vytvořit následujícím příkazem: 
% make wrapper
Skript bude pojmenován kw, Změňte jej klidně tak, aby odpovídal vašemu systému, bude-li to nutné.

Warning

Aby to fungovalo nesmíte mít Kwave nainstalován ve vašem systému. Pokud ale v systému nainstalován je, nejprve jej, prosím, odinstalujte!


Přidání podpory pro nový jazyk

  1. Systém provedení:
    Upravit na nejvyšší úrovniCMakeLists.txt a přidat nový záznam k seznamu s jazyky. Hledejte proměnnou KWAVE_LINGUAS a přidejte řádek s novým jazykem. Každý záznam se skládá z dvojice jazykového kódu a názvu jazyka, jako je tento: :. Příklad: 
    fr:Francais

    Jazykový kód je kód složený ze dvou písmen, který se používá pro adresáře a názvy souborů, jak se také používají v KDE. Název jazyka se uvnitř používá pouze pro docbook dokumentaci a nápovědu, které jsou přístupnému přímým připojením k internetu. Kvůli seznamu s dostupnými kódy jazyků a názvy se, prosím, podívejte na dokumentaci s mezinárodním standardem ISO 639-2.
  2. uživatelské rozhraní:
    Jděte do zdrojového adresáře Kwave (není to adresář se sestavením), přepněte se na podadresář po a zkopírujte soubor kwave.pot do odpovídajícího .po souboru s jazykem, který chcete přidat: ".po". Poté už můžete překládat soubor s pomocí svého oblíbeného nástroje, jakým je třeba Lokalize. Příklad: 
    % cd $HOME/src/kwave
% cd po
% cp kwave.pot fr.po
% lokalize fr.po
  3. nápověda po internetu:
    Je to podobné jako postup u uživatelského rozhraní, ale vyžaduje to některé kroky navíc, protože hlavní soubor je v docbook formátu a .pot šablona je vytvářeným souborem. Jděte do zdrojového adresáře Kwave (není to adresář pro sestavení), přepněte se do podadresáře doc a vytvořte prázdný .po soubor: 
    % cd $HOME/src/kwave
% cd doc
% touch help_fr.po
    Potom změňte svůj adresář pro sestavení (např. někam do /tmp), připravte se na sestavení a pak vytvořte .pot šablonu (bezpečně si nemusíte všímat chybových hlášek, které v této době přicházejí). Tuto šablonu je potřeba zkopírovat do .po souboru ve zdrojovém adresáři nápovědy po internetu. Příklad: 
    % mkdir /tmp/kwave-build
% cd /tmp/kwave-build
% cmake $HOME/src/kwave
% make doc
% cp doc/help_en.pot $HOME/src/kwave/doc/help_fr.po
    Nyní můžete překládat .po soubor, jak to bylo vysvětleno výše: 
    % cd $HOME/src/kwave
% cd doc
% lokalize help_fr.po
  4. Snímky obrazovky:
    Pro nápovědu po internetu rovněž potřebujete snímky obrazovky, jež využívají přeložená sdělení. Toto vyžaduje sestavený a nainstalovaný balíček Kwave, takže byste měl sledovat kroky zmíněné v oddíle o Vlastnoruční kompilace a instalace. Samozřejmě, že nesmíte přejít volbu pro sestavení WITH_DOC=no nebo jakoukoli jinou volbu pro sestavení, která odstraňuje funkčnost, jinak nebudete moci získat snímky obrazovky částí, které jste zakázal.
    Pro seznam se snímky obrazovky se můžete podívat do jednoho ze jsoucích adresářů ve zdrojovém stromě, například v $HOME/doc/de. Všechny snímky obrazovky jsou v .png a měly by vyplývat z KDE požadavků na snímky obrazovky (KDE Documentation Screenshots Requirement). Zde ve zkratce:
    • Výzdoba okna: Oxygen
    • Styl prvku: Oxygen
    • Barvy: Oxygen
    • Pozadí: Uhlazená barva - Barva musí být bílá
    • Spustit X11 v režimu 72dpi
    • Soubory ukládat v 8bpp
    • Pokusit se udržet velikost každého souboru pod 20kB
  5. soubor na ploše:
    Přidat řádek s poznámkou pro nový jazyk k souboru kwave/kwave.desktop.in. Všimněte si, prosím, že tento soubor je zakódován v UTF-8! Příklad: 
    Comment[cs]=Zvukový editor pro KDE
Užitečné odkazy:
Štítky: