- 3. Tworzenie własnej dokumentacji
3.4. Składnia pliku - 3.3. Rozdziały
« Poprzedni - 3.4.1. Wprowadzenie
Następny »
3.4. Składnia pliku
Spis treści
- 3.4.1. Wprowadzenie
- 3.4.2. Akapity i tekst
- 3.4.3. Wyróżnienia
- 3.4.4. Wstawki kodu
- 3.4.5. Nagłówki
- 3.4.6. Linki
- 3.4.7. Grafika i obrazki
- 3.4.8. Listy porządkowe
- 3.4.9. Bloki kodu
- 3.4.10. Tabelki
- 3.4.11. Listy definicji
- 3.4.12. Przypisy
- 3.4.13. Bloki cytatu i ramki informacyjne
- 3.4.14. Wstawki HTML
- 3.4.15. Zaawansowane użycie
Przykładowy plik rozdziału wygląda następująco:
Title: Tytuł
Opcja1: Wartość
Opcja2: Wartość
ListaUstawień:
- Wartość 1
- Wartość 2
---
Treść rodziału
W ustawieniach umieszczamy kolejne znaczniki w sposób pokazany powyżej. Obowiązkowy jest Title, ale jest też kilka innych. Właściwie ich lista zależy bardziej od tego, w jakim formacie wyjściowym będziemy generować dokumentację. Można bardzo łatwo opracować własny i zacząć używać tam nowe znaczniki - zostanie to omówione dalej.
Treść nagłówka od właściwej treści rodziału rodzielamy co najmniej trzema pauzami --- otoczonymi pojedynczymi pustymi linijkami.
Do formatowania treści rodziału używana jest składnia "PHP Markdown Extra" z paroma rozszerzeniami i modyfikacjami. Spotkać się z nią można na wielu stronach internetowych, ponieważ parsery są publicznie dostępne, stąd istnieje szansa, że już ją znasz. Gdyby jednak nie, odwiedź stronę jednego z parserów (np. tę podaną powyżej), by dowiedzieć się więcej. W następnych rodziałach szczegółowo została opisana składnia tego języka oraz wyszczególnione zostały drobne modyfikacje zastosowane w TypeFriendly.
Zobacz także:
3.4. Składnia pliku
3. Tworzenie własnej dokumentacji- « Poprzedni
3.3. Rozdziały - Następny »
3.4.1. Wprowadzenie