Invenzzia » Projekty / TypeFriendly

TypeFriendly

TypeFriendly jest generatorem opracowań i podręczników w formacie HTML. Napisany jest w PHP5 i umożliwia pisanie dokumentów w prostej i czytelnej składni Markdown.

TypeFriendly to projekt generatora podręczników HTML-owych napisany w PHP5, którego głównym założeniem jest prostota użytkowania. W porównaniu z innymi zaawansowanymi systemami takimi, jak DocBook, nie musisz samodzielnie opracowywać całego zestawu narzędziowego do zapewnienia odpowiedniej funkcjonalności. Z TypeFriendly dostajesz gotowe do użycia wszystko, co potrzeba i możesz zacząć pisanie swojego podręcznika w przeciągu paru minut.

Cechy TypeFriendly:

  1. Dokumentacja generowana z plików tekstowych tworzonych w przejrzystym i łatwym do nauczenia się formacie Markdown, opatrzonych dodatkowymi tagami.
  2. Automatyczne łączenie plików w rozdziały i sekcje na podstawie ich nazw.
  3. Intuicyjne zarządzanie kolejnością rozdziałów.
  4. Automatyczne tworzenie nawigacji.
  5. Wsparcie dla kolorowania składni wielu różnych języków.
  6. Dodatkowe narzędzia do opisu API obiektowego.
  7. Wsparcie dla wielojęzycznych dokumentacji, w tym narzędzie do kontroli aktualności wybranej wersji językowej.
  8. Kilka dostępnych systemów wyjścia.
  9. Elegancka oprawa graficzna generowanych dokumentacji.

TypeFriendly może być wykorzystany do różnych celów:

  1. Tworzenie podręcznika użytkownika dla Twojego projektu.
  2. Publikowanie książki lub zbioru artykułów w formacie HTML.
  3. Dokumentowanie Twojego projektu.
  4. Przygotowywanie wewnętrznych opracowań łatwo dostępnych w sieci.

Obecnie TypeFriendly jest podstawowym narzędziem dokumentacyjnym w Invenzzii i nie zamierzamy zamykać się wyłącznie w świecie HTML-a. Celem jest stworzenie systemu publikowania książek oraz opracowań w najpopularniejszych dostępnych formatach z bardzo czytelnej, tekstowej formy źródłowej. Aktualna wersja, 0.1.1 jest do pobrania w dziale Download.