Dziudek's jogger

To co przedstawię poniżej to jedna z moich koncepcji na umilenie życia czytelnikom mojego bloga w jego najnowszej odsłonie (kiedyś się pojawi :P). Oczywiście chodzi o tematy związane z webmasteringiem, a więc takie gdzie listing kodu jest nieodłączną częścią wpisu. Z reguły takie wpisy zawierają kilkanaście listingów, a wiele z nich prezentuje poszczególne etapy powstawania danego rozwiązania. Postanowiłem tą formę przekazywania informacji urozmaicić.

W tym celu stworzyłem wstępną wersję rozwiązania, które pozwoliłoby sprawnie przeglądać listing kodu. Jako, że wiele osób zwraca uwagę na nadużywanie JavaScript na stronach ja swój skrypt przemyślałem tak by ludzie z wyłączonym JS nie ucierpieli zbytnio (choć sporo stracą ;) ).

Sytuacja wyjściowa

Na początku nasz listing wyglądałby tak - jest to wersja jaką ujrzą wszyscy ci, którzy mają wyłączony JavaScript w swojej przeglądarce. Kolejne etapy zmian w kodzie jak widać stanowią kolejne elementy pre o określonej strukturze:

<pre class="code[grupa]">
        <code>
                /**
                        Komentarz do kodu
                **/
        </code>
        <code>
                Jakiś kod
        </code>
</pre>

Według mnie taka postać jest wystarczająco czytelna, a jak się bardzo komuś nie podoba - niech włączy JS :)

Dodam jeszcze, że zmienna grupa w nazwie klasy pozwala nam stworzyć kilka osobnych listingów kodu poprzez nadanie znacznikom pre tej samej wartości tej zmiennej (jeżeli spojrzycie w kod przykładowej strony to wszystko stanie się jasne, jeżeli jeszcze nie jest).

Co robi skrypt ?

No właśnie - teraz pora na skrypt :) Przy okazji dodam, że wymaga on obecności MooTools 1.1(1). A sam skrypcik wykonuje kilka ciekawych operacji, które dają równie ciekawy efekt - przede wszystkim ukrywa wszystkie znaczniki pre z danej grupy poza pierwszym, następnie tworzy prosty interfejs i pozwala czytelnikowi strony cieszyć się ładnym listingiem kodu. Wszystkie komentarze zawarte wcześniej w kodzie teraz mają swoje osobne miejsce, a czytelnik wie na jakim etapie omawiania kodu się właśnie znajduje, no i może szybko przenieść się do innego miejsca listingu. A przy okazji wpis na stronie staje się o wiele krótszy ;)

Ale to ciągle wersja beta ;)

Skrypt jest niewątpliwie dość krótki, ale oznacza to parę niedogodności:

• Z przyczyn dość praktycznych działa on poprawnie dla grup składających się z co najmniej trzech pojedynczych listingów kodu. (można to zmienić, ale po co dodawać zbędny kod),
• Pojedyncze listingi z danej grupy muszą znajdować sie jeden po drugim (tzn. może być pomiędzy nimi wszystko poza innymi listingami z innej grupy),
• Jesteśmy przywiązani do struktury listingu kodu wymaganej przez skrypt.

A teraz pytanie do Was drodzy Czytelnicy - przyda się ? Czy lepiej zostać przy starej formie prezentowania kodu lub dodać jakieś opcje (na przykład możliwość przełączania się pomiędzy listingiem "tradycyjnym" i moim ;) ) ?