Pomoc:Podświetlanie składni: Różnice pomiędzy wersjami

brak opisu edycji
mNie podano opisu zmian
Nie podano opisu zmian
{{podświetl}}
== Podświetlania składni ==
{| class="wikitable" style="width: 20%; clear: right; float: right; padding: 2px; margin-left: 5px; text-align: center"
|-
! Język
! KlasaSkrót
|-
| C
| lang-c
|-
| C++
| lang-cpp
|-
| JavaScript
| lang-js
|-
| Pascal
| lang-pas
|-
| Python
| lang-py
|}
Chyba każdy się zgodzi, że odpowiednio podświetlony kod danego języka programawaniaprogramowania ułatwia jego czytanie i zrozumienie. Niestety oprogramowanie Wikibooks nie daje nam takiej możliwości. Wcześniej podświetlanie składni można było uzyskać poprzez ręczne kolorowanie kodu, co było oczywiście dosyć niewygodne i uciążliwe. Na przykład wstawiając kod:
<div style="width: 70%">
<nowiki>
}
</div>
Niestety takie podejście do kolorowania kodu jest dla większości jednak uciążliwe i Wikipisarz zamiast skupić się na treści za bardzo koncentruje się na wyglądzie (zresztą nie powinno się używać znacznika '''font'''), traci mnóstwo czasu na kolory, a jakość i czytelonośćczytelność kodu wiki jest raczej kiepska.
 
Na szczęście pomimo tego większość przeglądarek obsługuje JavęJave Script, dlatego też został stworzony skrypt koloryzujący składnię różnych języków programowania (kod można znaleść w [[MediaWiki:Ext/Highlighting.js|Ext/Highlighting.js]]). Skorzystanie z niego jest dziecinnie proste, wystarczy wstawić blok '''pre''' lub '''tt''' i ustawić odpowiednią klasę przeznaczoną dla danego języka. Na przykład, aby podświetlić kod C++, napiszemy:
 
== Korzystanie ze skryptu ==
Aby skrypt się załadował w danym pliku należy umieścić w pewnym miejscu szablon {{tl|podświetl}} i tylko tyle.
 
Teraz wystarczy wstawić blok '''pre''' lub '''tt''' i ustawić klasę, która została przeznaczona dla danego języka, a klasa jest postaci <tt>lang-(skrót języka)</tt>. Na przykład, aby podświetlić kod C++, napiszemy:
<div style="width: 70%">
<nowiki>
</div>
 
GdySkolei, gdy napiszemy <nowiki><tt class="lang-cpp">using namespace std;</tt></nowiki> otrzymamy <tt class="lang-cpp">using namespace std;</tt>.
 
W tabeli na górze strony została wypisana liczba obsługiwanych języków przez skrypt i jakiejjaki klasyposiada trzebadany użyćjęzyk skrót. Należy zaznaczyć, że wielkość liter ma znaczenia.
 
W większości przypadków na jednej stronie opisujemy tylko jeden język programowania, dlatego też mamy możliwość zdefiniowania domyślnego podświetlania wewnątrz bloku '''div''' wstawiając <nowiki><div id="highlighting" class="lang-xx">zawartość strony</div></nowiki>. Podejście to ma jedną wadę, ponieważ w takim przypadku będą podświetlane jedynie te kody źródłowe, które się znajdują w tym bloku (w bloku, gdzie id="highlighting", a nie na całej stronie). Przykład:
 
W większości przypadków na jednej stronie opisujemy tylko jeden język programowania. Skrypt także daje nam możliwość zdefiniowania domyślnego języka za pomocą {{tl|podświetl|<nowiki>|skrót języka</nowiki>}}. Na przykład, jeśli kod strony będzie wyglądał tak:
<pre style="width: 70%">
{{podświetl|python}}
<div id="highlighting" class="lang-py">
 
def dodaj(a, b):
return a + b
Instrukcja <tt>def</tt> służy do definiowania funkcji w Pythonie,
podobnie jak <tt class="lang-js">function</tt> w Javie Script.
</div>
</pre>
 
Otrzymamy:
<div style="background: white; width: 70%; padding: 5px; border: 1px solid black">
<pre class="lang-py" style="width: 90%">
def dodaj(a, b):
return a + b
</div>
 
== Rozwiązywanie problemów ==
Jeśli chcesz, aby została dodana obsługa pewnego języka, porozmawiaj o tym w [[WB:BAR|Barze]]. W przypadku znalezienia jakiś błędów w skrypcie, także powinnieneś o tym tam napisać.
=== Podświetlanie a własne formatowanie ===
Załóżmy, że chcielibyśmy, aby pewna linia została w jakiś sposób została wyróżniona np. kolorem, czy pogrubieniem. W takim przypadku nie możemy skorzystać z bloku '''pre''', ale za to istnieją dwa inne rozwiązania:
* Zdefniować domyślny język za pomocą {{tl|podświetl|<nowiki>|skrót języka</nowiki>}}.
* Zamiast z bloku '''pre''' skorzystać z '''tt'''.
 
W przypadku, gdy zdefinujemy domyślny język, możemy pisać tak jak zawsze, dodając dodatkowe wcięcia do kodu i formatując go np.
<pre>
{{podświetl|py}}
Kod źródłowy:
def test():
print "OK"
'''a = 10''' # bardzo ważne
</pre>
 
Otrzymamy:
<div style="background: white; width: 70%; padding: 5px; border: 1px solid black">
Kod źródłowy:
<tt class="lang-py">def test():
print "OK"
'''a = 10''' # bardzo ważne</tt>
</div>
 
W przypadku, gdy z jakichś powodów nie możemy skorzystać z pierwszego sposobu, korzystamy oczywiście z drugiego. Zamiast korzystać z '''pre''' korzystamy z '''tt''' tworząc jednocześnie wcięcia np.
<pre style="width: 70%">
<tt class="lang-py">def test():
print "OK"
'''a = 10''' # bardzo ważne</tt>
</div>
</pre>
 
Wynik będzie identyczny z poprzednim.
 
=== Jeśli nie chcemy podświetlać ===
Załóżmy, że zdefiniowaliśmy domyślny język i tworzymy sobie jakiś tekst preformatowany, który nie chcemy podświetlać. Co możemy zrobić? Wystarczy wszystko umieścić w <nowiki><span>...</span></nowiki> i po problemie np.
<pre style="width: 70%">
{{podświetl|cpp}}
<span>Słowo void, czy return już dla
nas nic nie znaczy.</span>
</pre>
 
Otrzymamy:
<pre style="width: 70%">
Słowo void, czy return już dla
nas nic nie znaczy.
</pre>
 
=== Brakuje języka ===
Jeśli chcesz, aby została dodana obsługa pewnego języka, porozmawiaj o tym w [[WB:BAR|Barze]]. W przypadku znalezienia jakiś błędów w skrypcie, także powinnieneś o tym tam napisać.
 
[[Kategoria:Pomoc]]
6422

edycje