Aktualizacja dokumentacji
Podział dokumentacji na sekcje
Dokumentacja została podzielona na sekcje, zgodnie z licznymi sugestiami.
Dotychczasowy opis został rozdzielony na następujące sekcje:
- Opis
- Składnia
- Zwracana wartość
- Typ
- Notatki
- Przykład
- Uwagi
W związku z podziałem opisu na sekcje, wszelkie dotychczasowe opisy uległy gruntownej zmianie.
Mimo starań, część opisów mogła zostać niepoprawnie skonwertowana, za co serdecznie przepraszam.
Jeśli zauważycie niepoprawnie opisaną funkcję, np. pełen "stary" opis w polu opis, niepodzielony, śmiało poprawcie
Mam nadzieję, że nowa forma dokumentacji przyniesie spore korzyści, a konwersja nie jest aż taka nieudana.
Nowy wygląd dokumentacji
Live link: clamp
Edycja opisu odbywa się sekcjami
Możemy zmienić nazwę funkcji w polu tekstowym, jej typ w polu wyboru, oraz dowolne sekcje w osobnych edytorach.
Edytor przykładu jest przeznaczony na kod SMA, więc jako jedyny jest edytorem tekstowym (HTML z ukrytym paskiem narzędzi).
Jak dotychczas, przy edycji, możemy na bieżąco podejrzeć nowy wygląd opisu, oraz porównać proponowany opis z bieżącym wizualnie, oraz na 4 różne sposoby w tabeli.
Przy okazji, poprawione zostało ładowanie porównania blokowego z ciasteczek.
Zmiana kolorowania składni
Kolorowanie geshi zostało zastąpione standardowym prettyprintem, dzięki czemu składnia jest lepiej kolorowana.
Zmianie uległ skrypt JS, który ładuje kolorowanie składni, w przypadku problemów, proszę o kliknięcie Ctrl+F5 (lub Ctrl+R).
Więcej drobnych zmian
Część elementów wymagających poprawy, została dopracowana, trochę zyskało nową formę graficzną, nieco zmieniony też został układ poszczególnych sekcji na stronie.
Szczegóły aktualizacji znajdują się w changelogu: AMXX.pl/dokumentacja?do=changelog
Zaznaczę tutaj 2 najistotniejsze z tych drobniejszych poprawek:
- + Dodano linki do funkcji i kolorowane linki do profili autorów w widoku logów
- $ Propozycje osób z możliwością moderacji opisów, nie wymagają dłużej akceptacji
AMXX.pl API
Do publicznego użytku zostało oddane AMXX.pl API, znajdujące się pod adresem api.amxx.pl
API na chwilę obecną posiada kilka metod, pozwalających w łatwy sposób na pobranie opisów funkcji.
Najprawdopodobniej API zostanie rozszerzone o kolejne metody, póki co, oczekuję zgłoszeń ew. błędów.
API pozwala na pobranie zasobów dokumentacji, m.in. w JSON, JSONP, czy XML, co pozwoli na proste tworzenie dokumentacji offline, etc.
Jeśli uznacie API za przydatne i uważacie, że przydadzą się kolejne metody, formy, etc., piszcie śmiało, zapraszam do dyskusji nt. dalszego rozwoju dokumentacji.