Pomoc:Podświetlanie składni: Różnice pomiędzy wersjami
→Podświetlania składni: skoro green, to green, nie blue :P |
Nie podano opisu zmian |
||
Linia 1: | Linia 1: | ||
{{podświetl}} |
{{podświetl}} |
||
== |
== Kolorowanie składni, a MediaWiki == |
||
{{Infobox|Najlepiej korzystać z tego rozwiązania. Jest ono zalecane, ale w niektórych przypadkach może okazać się wygodniejsze drugie rozwiązanie, podane niżej.}} |
|||
Całkiem niedawno (maj 2007) samo oprogramowanie MediaWiki daje nam możliwość podświetlania składni, więc nie trzeba uciekać do JavaScriptowych trików. W najprostrzy sposób wykorzystujemy w tym celu znacznik. <nowiki><source lang="język"></source></nowiki> np. |
|||
<nowiki> |
|||
<source lang="python"> |
|||
silnia = lambda x: x==0 or x*silnia(x-1) |
|||
print silnia(10) |
|||
</source> |
|||
</nowiki> |
|||
Otrzymamy: |
|||
<source lang="python"> |
|||
silnia = lambda x: x==0 or x*silnia(x-1) |
|||
print silnia(10) |
|||
</source> |
|||
Powyższe rozwiązanie jest '''zalecane''', ale w niektórych przypadkach można wykorzystać sposób podany niżej. Jednakże nie powinno się mieszać obydwu metod w jednym podręczniku. |
|||
Więcej na ten temat można poczytać na [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi stronie MediaWiki]. |
|||
== Podświetlania składni (JavaScript) == |
|||
{| class="wikitable" style="width: 20%; clear: right; float: right; padding: 2px; margin-left: 5px; text-align: center" |
{| class="wikitable" style="width: 20%; clear: right; float: right; padding: 2px; margin-left: 5px; text-align: center" |
||
|- |
|- |
||
Linia 51: | Linia 73: | ||
Na szczęście pomimo tego większość przeglądarek obsługuje 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]]). |
Na szczęście pomimo tego większość przeglądarek obsługuje 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]]). |
||
== Korzystanie ze skryptu == |
=== Korzystanie ze skryptu === |
||
Aby skrypt się załadował w danym pliku należy umieścić w pewnym miejscu szablon {{S|podświetl}} i tylko tyle. |
Aby skrypt się załadował w danym pliku należy umieścić w pewnym miejscu szablon {{S|podświetl}} i tylko tyle. |
||
Linia 136: | Linia 158: | ||
</div> |
</div> |
||
== Rozwiązywanie problemów == |
=== Rozwiązywanie problemów === |
||
=== Podświetlanie a własne formatowanie === |
==== 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: |
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: |
||
* Zdefiniować domyślny język za pomocą {{S|podświetl|<nowiki>|skrót języka</nowiki>}}. |
* Zdefiniować domyślny język za pomocą {{S|podświetl|<nowiki>|skrót języka</nowiki>}}. |
Wersja z 18:52, 25 maj 2007
Kolorowanie składni, a MediaWiki
Najlepiej korzystać z tego rozwiązania. Jest ono zalecane, ale w niektórych przypadkach może okazać się wygodniejsze drugie rozwiązanie, podane niżej. |
Całkiem niedawno (maj 2007) samo oprogramowanie MediaWiki daje nam możliwość podświetlania składni, więc nie trzeba uciekać do JavaScriptowych trików. W najprostrzy sposób wykorzystujemy w tym celu znacznik. <source lang="język"></source> np.
<source lang="python"> silnia = lambda x: x==0 or x*silnia(x-1) print silnia(10) </source>
Otrzymamy:
silnia = lambda x: x==0 or x*silnia(x-1)
print silnia(10)
Powyższe rozwiązanie jest zalecane, ale w niektórych przypadkach można wykorzystać sposób podany niżej. Jednakże nie powinno się mieszać obydwu metod w jednym podręczniku.
Więcej na ten temat można poczytać na stronie MediaWiki.
Podświetlania składni (JavaScript)
Język | Skrót |
---|---|
C | c |
C++ | cpp |
JavaScript | js |
Pascal | pas |
PHP | php |
Python | py |
Chyba każdy się zgodzi, że odpowiednio podświetlony kod danego języka programowania 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:
<font color=blue>#include</font> <iostream> <font color=blue>using namespace</font> std; <font color=green>int</font> main() { cout << "Hello World\n"; <font color=blue>return</font> 0; }
Otrzymujemy:
#include <iostream> using namespace std; int main() { cout << "Hello World\n"; return 0; }
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, traci mnóstwo czasu na kolory, a jakość i czytelność kodu wiki jest raczej kiepska.
Na szczęście pomimo tego większość przeglądarek obsługuje 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).
Korzystanie ze skryptu
Aby skrypt się załadował w danym pliku należy umieścić w pewnym miejscu szablon {{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 lang-(skrót języka). Na przykład, aby podświetlić kod C++, napiszemy:
<pre class="lang-cpp"> #include <iostream> using namespace std; int main() { cout << "Hello World\n"; return 0; } </pre>
I otrzymamy
#include <iostream> using namespace std; int main() { cout << "Hello World\n"; return 0; }
Natomiast pisząc:
<pre class="lang-py"> def silnia(a): if a == 0: return 1 return a*silnia(a-1) print silnia(30) </pre>
otrzymamy:
def silnia(a): if a == 0: return 1 return a*silnia(a-1) print silnia(30)
Z kolei, gdy napiszemy <tt class="lang-cpp">using namespace std;</tt> otrzymamy using namespace std;.
W tabeli na górze strony została wypisana liczba obsługiwanych języków przez skrypt i jaki posiada dany 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. Skrypt także daje nam możliwość zdefiniowania domyślnego języka za pomocą {{podświetl||skrót języka}}. Na przykład, jeśli kod strony będzie wyglądał tak:
{{podświetl|python}} 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.
Otrzymamy:
def dodaj(a, b): return a + b
Instrukcja def służy do definiowania funkcji w Pythonie, podobnie jak function w Javie Script.
Rozwiązywanie problemów
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:
- Zdefiniować domyślny język za pomocą {{podświetl||skrót języka}}.
- Zamiast z bloku pre skorzystać z tt.
W przypadku, gdy zdefiniujemy domyślny język, możemy pisać tak jak zawsze, dodając dodatkowe wcięcia do kodu i formatując go np.
{{podświetl|py}} Kod źródłowy: def test(): print "OK" '''a = 10''' # bardzo ważne
Otrzymamy:
Kod źródłowy:
def test(): print "OK" a = 10 # bardzo ważne
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.
<tt class="lang-py">def test(): print "OK" '''a = 10''' # bardzo ważne</tt> </div>
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 <span>...</span> i po problemie np.
{{podświetl|cpp}} <span>Słowo void, czy return już dla nas nic nie znaczy.</span>
Otrzymamy:
Słowo void, czy return już dla nas nic nie znaczy.
Brakuje języka
Jeśli chcesz, aby została dodana obsługa pewnego języka, porozmawiaj o tym w Barze. W przypadku znalezienia jakiś błędów w skrypcie, także powinieneś o tym tam napisać.