Invenzzia »

Invenzzia... po polsku

Słowo kluczowe - dokumentacja

Kanał wpisów - Kanał komentarzy

Sunday, 08 February 2009

Wiki.invenzzia.org

Invenzzia Tagged under: dokumentacja invenzzia website wiki

Dzisiaj oficjalnie zostało uruchomione wiki Invenzzii, na wszyscy zainteresowani będą mogli publikować porady, artykuły oraz inne materiały poświęcone projektom open-source takim, jak Open Power Template czy TypeFriendly. W przeciągu ostatnich kilku dni konfigurowałem MediaWiki oraz instalowałem niezbędne dodatki, jednak wciąż jeszcze sporo pozostało do zrobienia. Jak widać, na wiki brakuje wielu stron pomocy i szablonów technicznych, jednak powinny one zostać w najbliższych dniach dodane. Zachęcam wszystkich do opisywania tam swoich rozwiązań, pomysłów oraz dodatków - wystarczy do tego jedynie konto na naszym forum i znajomość języka angielskiego, jako że wiki dostępne jest tylko w nim.

Zyx 2009-02-08, 17:10

2 komentarzy

Saturday, 20 September 2008

Pożegnanie z Polską

Invenzzia Tagged under: dokumentacja invenzzia website

Dzisiaj kolektywnie doszliśmy do wniosku, że postawienie na polskich programistów i język polski było dużym błędem. Sprawa tłumaczeń i utrzymywania dwujęzyczności okazała się trudniejsza, a z rodzimej części, zamiast spodziewanego odezwu, słyszymy głównie krytykę, że forum jest puste, społeczność nikła i tekstów mało. Dokładniejszy przegląd sytuacji zawarłem na moim blogu i nie chcę się tu powielać, ograniczając się jedynie do skutków dla Invenzzii.

Czytaj dalej »

Zyx 2008-09-20, 17:21

2 komentarzy

Wednesday, 20 August 2008

OPT 2.0.0-dev7

Open Power Template Tagged under: development dokumentacja opt2 releases

3 miesiące i 10 dni. Tyle zajęło przepisywanie dotychczasowego kodu OPT do nowej, lepszej wersji. Dziś w końcu uznałem, że dotarł on do punktu, w którym może aspirować do miana "dev7" i odpowiednia paczka znalazła się w działach "Download". Zmian jest sporo, głównie związanych z API biblioteki, którą teraz się nieco inaczej inicjuje. Poprawiłem też nieco kompilator, dodając do szablonów parę nowych możliwości oraz znacząco rozbudowałem dokumentację, która zresztą dołączona jest do wydania.

Czytaj dalej »

Zyx 2008-08-20, 11:31

4 komentarzy

Wednesday, 02 July 2008

TypeFriendly

TypeFriendly Tagged under: development dokumentacja typefriendly

Z eXtremem ciężko pracujemy, by pierwsza wersja ujrzała w końcu światło dzienne i jesteśmy już bardzo blisko. W związku z tym chciałbym bliżej przedstawić ten projekt, który z pewnością powinni docenić inni programiści, autorzy rozmaitych skryptów i poszukujących sensownego narzędzia do generowania dokumentacji. Pomysł na napisanie TypeFriendly zrodził się w mojej głowie po nieudanych zmaganiach z dodaniem paru niezbędnych rzeczy do parsera XSLT dla DocBook. Widać choćby po dokumentacji PHP, co można z tym zrobić (kolorowanie składni, wiele różnych formatów, ogromna ilość pomocnych znaczników), ale nie dajmy się zwariować. To są wręcz tygodnie siedzenia, by osiągnąć podobny efekt. Pomijam już fakt, że byłby on słabo przenośny... wolałem poświęcić te tygodnie na stworzenie czegoś bardziej przydatnego.

Czytaj dalej »

Zyx 2008-07-02, 20:51

0 komentarzy

Saturday, 10 May 2008

OPT 2.0.0-dev6

Open Power Template Tagged under: development dokumentacja opt2

Do ściągnięcia dostępna jest wreszcie kolejna wersja rozwojowa OPT. Jej zawartość opisałem w poprzednim wpisie, dlatego tu dodam tylko, że wbrew zapowiedziom, nie ma jeszcze instrukcji opt:grid z powodów, które zaraz wyjaśnię. Ponadto nie da się jeszcze ustawiać statusu escape'owania dla pojedynczego szablonu, ale takowy z globalnej konfiguracji i ustawień wyrażenia w klamerkach już działa ładnie. Za to dodałem implementację instrukcji opt:capture i częściową opt:cycle. Polskich użytkowników z pewnością ucieszy informacja, że podczas długiego weekendu doprowadziłem do względnego porządku nasz nowy system dokumentowania TypeFriendly i OPT 2 ma już nową, ładną dokumentację :)

Czytaj dalej »

Zyx 2008-05-10, 14:15

5 komentarzy

Saturday, 08 March 2008

Dokumentacje

Tagged under: dokumentacja

Jak dotąd, wszystkie dokumentacje tworzymy w pakiecie bazującym na DocBooku (dodanych kilka drobnych znaczników), z których wersja HTML-owa tworzona jest arkuszami XSLT. Istniejące systemy przetwarzania automatycznie dbają o utworzenie nawigacji między rozdziałami oraz podział tego na pojedyncze pliki, o ile wybraliśmy taki tryb. Niestety, utworzenie kompletnego frameworka dla dokumentacji jest okropnie skomplikowane, co tłumaczy fakt, dlaczego całość zapisana jest póki co w jednym wielkim pliku XML, a przykłady nie mają kolorowania składni. Do tego dochodzi problem z parserami XSLT. Choć w DocBooku piszę od dawna, postanowiłem znaleźć alternatywne rozwiązanie i rozpocząć projekt gotowego do użycia generatora dokumentacji napisanego w PHP i korzystającego z prostszej składni. eXtreme ochrzcił go mianem TypeFriendly.

Czytaj dalej »

Zyx 2008-03-08, 22:29

4 komentarzy