- 3. Tworzenie własnej dokumentacji
3.1. Struktura katalogowa - 3. Tworzenie własnej dokumentacji
« Poprzedni - 3.2. Plik settings.ini
Następny »
3.1. Struktura katalogowa
Dokumentacja TypeFriendly musi mieć odpowiednią strukturę katalogową. Utwórz gdzieś w swoim projekcie katalog na jej przechowywanie (np. /docs) i utwórz w nim następujące foldery:
/input
/pl
/output
/sort_hints.txt
/settings.ini
Zasady są bardzo proste: w katalogu /input znajdują się podkatalogi reprezentujące poszczególne wersje językowe, a w nich umieszczamy charakterystyczne dla każdej z nich pliki tekstowe. Dodatkowo możemy umieścić tu folder /media przechowujący obrazki i inną grafikę wykorzystywaną w dokumentacji. W /output TypeFriendly będzie zapisywać wygenerowane dokumentacje, dlatego upewnij się, że nadałeś mu uprawnienia do zapisu. Bezpośrednio w głównym katalogu zapisywane są pliki z ustawieniami, w których możesz wpływać na różne aspekty dokumentacji. Najważniejszym z nich jest settings.ini zawierający ustawienia główne. sort_hints.txt zawiera wskazówki dotyczące sortowania stron dokumentacji. Dokładna budowa każdego z plików wyjaśniona jest dalej.
3.1. Struktura katalogowa
3. Tworzenie własnej dokumentacji- « Poprzedni
3. Tworzenie własnej dokumentacji - Następny »
3.2. Plik settings.ini