Spis treści
1. Przedmowa
2. Instalacja
Następny »

1. Przedmowa

TypeFriendly to napisany w PHP5 skrypt przeznaczony do generowania dokumentacji. Został napisany tak, aby być prostym w obsłudze oraz aby rezultaty można było osiągnąć już w kilka minut po rozpoczęciu pracy. TypeFriendly domyślnie zawiera wszystko, co niezbędne, do stworzenia dokumentacji, dzięki czemu nie trzeba wyważać otwartych drzwi.

Najważniejsze cechy TypeFriendly:

  1. Modularna budowa dokumentacji - dokumentacja generowana jest ze zwykłych plików tekstowych, a jej układ i zależności między podstronami automatycznie ustalane na podstawie nazw tych plików.
  2. Prosta składnia - dokumentację można pisać w niezwykle prostym i czytelnym formacie Markdown.
  3. Wsparcie dla dokumentacji wielojęzycznych - TypeFriendly umożliwia równoległe tworzenie dokumentacji w kilku językach, a także udostępnia narzędzia ułatwiające prace, takie jak porównywanie wersji językowych.
  4. Konfigurowalne formaty wyjściowe - aktualnie TypeFriendly potrafi generować dane w dwóch formatach: XHTML - wiele stron i XHTML - jedna strona. W trakcie projektowania jest format, który umożliwi prosty eksport dokumentacji do bazy danych w celu jej publikacji on-line, np. z komentarzami użytkownika.
  5. Różne dodatki przydatne przy dokumentowaniu kodu: kolorowanie składni, referencje, zależności między klasami...
  6. Łatwe tworzenie nawigacji.
  7. Pracuje pod Linuksem i Windowsem.

TypeFriendly dostępny jest na licencji GNU General Public License 3, co oznacza, że możesz go nie tylko używać za darmo, ale także modyfikować i dostosowywać do własnych celów.

1. Przedmowa
Spis treści
Następny »
2. Instalacja