Pomoc:Formatowanie
Z Winogrona.org
Na stronach wiki technicznie możliwe jest wstawianie pewnych fragmentów kodu języka HTML i XHTML, które służą do tworzenia stron internetowych, nie jest to jednak specjalnie zalecane. Przy edycji i tworzeniu artykułów należy używać formatowania zgodnego z mechanizmem Wiki (tzw. WikiTagi), którego opis znajdziesz poniżej.
Poniżej znajduje się zbiór metod formatowania tekstu, dostępnych w ramach mechanizmu wiki:
Spis treści |
Rozdziały, akapity, listy i linie
Opis / Wygląd przykładowy | Kod do przykładu |
---|---|
Nagłówki – do sześciu znaków = obejmujących tekst. Pierwszego nagłówka nie powinno się używać, ponieważ jest nim tytuł całego artykułu. Zasadniczo najczęściej używa się nagłówków od drugiego do czwartego stopnia.
CzęśćRozdziałPodrozdziałpoziom 4poziom 5poziom 6 |
= Część = == Rozdział == === Podrozdział === ==== poziom 4 ==== ===== poziom 5 ===== ====== poziom 6 ====== |
Nowe akapity – po prostu dwa razy naciśnij enter.
Pojedyncze przejście do nowej linii nic nie robi. Ale pusta linijka rozpoczyna nowy akapit. |
Pojedyncze przejście do nowej linii nic nie robi. Ale pusta linijka rozpoczyna nowy akapit. |
Wymuszenie nowego wiersza – XHTML
Można wymusić przejście do nowej linii |
Można wymusić przejście do nowej linii<br /> bez rozpoczynania nowego akapitu. |
Lista nienumerowana
|
* Listy są pożyteczne: ** systematyzują tekst ** przejrzyście wyglądają |
Listy numerowane
|
# Wyliczenia (listy numerowane) też są pożyteczne # bardzo systematyzują tekst ## łatwo się je czyta |
Definicje
|
; Pojęcie1 : Definicja pierwsza ; Pojęcie2 : Definicja druga |
Listy złożone:
|
# Lista numerowana #* Pierwszy element #* Drugi element # Więcej elementów |
Wcięcia w tekście tworzy się przez rozpoczynanie linii od ":".
Tekst bez wcięcia
|
Tekst bez wcięcia : wcięcie pojedyncze :: wcięcie podwójne :::: wcięcie wielokrotne |
Tekst preformatowany (wcięty, czcionka nieproporcjonalna, wiersze nie będą łamane ani łączone przez przeglądarkę)
można uzyskać przez poprzedzenie każdego wiersza spacją lub
ujęcie w znaczniki XHTML:
Tekst bez wcięcia IF (linia zaczyna się od białego znaku) THEN będzie formatowana tak jak jest wpisana; specjalnym rodzajem czcionki; linie nie będą się składać; ENDIF jest to przydatne do: • wklejania uprzednio sformatowanego tekstu; • opisów algorytmów; • ascii artu; |
Tekst bez wcięcia IF (linia zaczyna się od białego znaku) THEN będzie formatowana tak jak jest wpisana; specjalnym rodzajem czcionki; linie nie będą się składać; ENDIF jest to przydatne do: • wklejania uprzednio sformatowanego tekstu; • opisów algorytmów; • ascii artu; |
Listingi programów – możliwe jest automatyczne kolorowanie składni źródeł programów, trzeba je ująć między znaczniki <source lang="kod języka"> i </source>
<source lang="c"> int main(int argc, char **argv) { int x = 0; return x; } </source> |
<source lang="c"> int main(int argc, char **argv) { int x = 0; return x; } </source> |
Tekst wycentrowany – XHTML
Tekst można centrować.
|
<div style="text-align: center">Tekst można centrować.</div> |
Poziome linie rozdzielające – co najmniej cztery znaki - w dowolnym miejscu wiersza
powyżej poniżej i jeszcze niżej |
powyżej ---- poniżej ---- i jeszcze niżej |
Polecenia formatujące, znaki specjalne
Uwaga: nie każda przeglądarka potrafi poprawnie wyświetlać wszystkie znaki specjalne!
Należy zwrócić uwagę, że nie trzeba się tego uczyć na pamięć – podstawowe znaki specjalne są dostępne przy oknie edycji tekstu.
Opis | Wygląd przykładowy | Kod do przykładu |
---|---|---|
Wyróżnienia tekstu |
Tekst pisany kursywą |
''Tekst pisany kursywą''<br /> '''Tekst pogrubiony'''<br /> '''''Tekst pisany pogrubioną kursywą'''''<br /> Także w równaniach (wzorach): '''F''' = '''''m''''' ''a''. |
Zmniejszenie czcionki (niezalecane, lepiej użyć sposobu poniżej) |
czcionka zmniejszona |
czcionka zmniejszona<br /> wygląda <small>właśnie tak </small> |
Zwiększenie czcionki (niezalecane, lepiej użyć sposobu poniżej) |
czcionka zwiększona |
czcionka zwiększona<br /> wygląda <big>właśnie tak </big> |
Zmiany czcionki |
Zmiana koloru czcionki Zmiana wielkości czcionki |
<span style="color: red">Zmiana koloru czcionki</span> <span style="font-size: 80%">Zmiana wielkości czcionki</span> |
Czcionka o równych szerokościach znaków, używana do oznaczania określeń technicznych technical terminology |
Font do technicznych pojęć |
Font do <tt>technicznych pojęć</tt> |
Przekreślenie i podkreślenie |
Można |
Można <del>przekreślać</del> tekst<br /> i <u>podkreślać</u> go. |
Indeks dolny i górny |
górny: x2 dolny: x2 |
górny: x<sup>2</sup> dolny: x<sub>2</sub> |
Formatowanie spisu treści
Spis treści jest generowany automatycznie przez mechanizm Wiki, jeśli w tekście pojawią się więcej niż trzy nagłówki. Istnieją trzy komendy związane z formatowaniem spisu treści. Są to:
- __TOC__ (w tym miejscu pojawi się spis treści)
- __NOTOC__ (spisu treści w ogóle nie będzie widać na stronie)
- __FORCETOC__ (wymuszone zostanie pojawienie się spisu treści)
Dodatkowo istnieje polecenie __NOEDITSECTION__, pozwalające na zablokowanie możliwości edycji sekcji (domyślnie można edytować pojedynczą sekcję zamiast całego artykułu). Ściślej – znikną po prostu linki dające możliwość edycji ("[Edytuj]"), które standardowo pojawiają się przy tytule każdej sekcji.
Natomiast, jeśli użyjesz szablonu {{Spis treści}} to spis treści będzie przylegał do prawej krawędzi strony i jednocześnie będzie opływany z lewej strony przez tekst.
Ukrywanie treści i pokazywanie kodu
- Aby ukryć treść można użyć nastepującego kodu:
<!-- ta treść nie będzie widoczna na stronie -->,
co spowoduje, że treść pomiędzy znakami < > nie będzie widoczna na samej stronie po jej zapisaniu, ale będzie ją mozna zobaczyć po wybraniu opcji edytuj. Po <! i bezpośrednio przed > można wprowadzić większą liczbę znaków "-", aby komunikat był dobrze widoczny przy wybraniu opcji edytuj.
- Aby pokazać kod, jaki jest użyty, np. właśnie na stronach pomocy, używa się specjalnego kodu <nowiki>
Powoduje to, że zastosowany kod "nie działa".
Przykładowo [[link]] normalnie działający w taki sposób:
po zastosowaniu kodu <nowiki>[[link]]</nowiki> będzie widoczny właśnie w postaci [[link]] po zapisaniu strony.
Uwaga Aby pokazać bardziej skomplikowany kod, np. tabeli, zastosowanie <nowiki> powoduje, że sam kod się spłaszcza:
{| class="wikitable" |- ! Pierwsza kolumna ! Druga ! Trzecia |- | Tu coś wpiszemy | i tu coś | i tu jeszcze coś |}
Można wówczas zrobić to w taki sposób, że <nowiki> wpisujemy nad kodem, który chcemy pokazać, jednak przed <nowiki> wolną spację i analogicznie pod prezentowanym kodem z wolną spacją dajemy </nowiki> :
<nowiki> {| class="wikitable" |- ! Pierwsza kolumna ! Druga ! Trzecia |- | Tu coś wpiszemy | i tu coś | i tu jeszcze coś |} </nowiki>
W efekcie otrzymujemy kod prostej tabelki
{| class="wikitable" |- ! Pierwsza kolumna ! Druga ! Trzecia |- | Tu coś wpiszemy | i tu coś | i tu jeszcze coś |}
- Można zamiast tego użyć łatwiejszej opcji <pre>
<pre>
{| class="wikitable" |- ! Pierwsza kolumna ! Druga ! Trzecia |- | Tu coś wpiszemy | i tu coś | i tu jeszcze coś |}
</pre>
Co da taki sam efekt. (Informacje o sposobach tworzenia samych tabel znajddziesz tutaj)
Selektywne włączanie treści
Składnia wiki posiada mechanizm pozwalający na załączanie treści jednej strony przez inną. Efekt taki można najłatwiej uzyskać wstawiając w treść strony, która załącza treść innej kod:
{{Nazwa strony załączanej}}
Zazwyczaj wykorzystuje się ten mechanizm w celu użycia szablonu. Jeśli na stronie która jest załączana chcielibyśmy umieścić treść, która nie będzie widoczna po załączeniu lub też treść która będzie widoczna wyłącznie na stronie załączanej, a ukryta zostanie po załączeniu musimy użyć specjalnych znaczników:
<noinclude>Tekst widoczny tylko na stronie na której został wpisany</noinclude>
<includeonly>Treść widoczna tylko po włączeniu w treść innej strony</includeonly>
<onlyinclude>Tylko treść wewnątrz tego znacznika pojawi się po użyciu szablonu. Widoczna ona będzie również w samym szablonie.</onlyinclude>
W praktyce znacznika <noinclude></noinclude> używa się np w szablonach, po to by sam szablon umieścić w jakiejś kategorii, a strona która go używa nie znalazła się w tej kategorii. Można też tym znacznikiem ograniczyć widoczność opisu szablonu, który powinien być widoczny na stronie szablonu, ale oczywiście zostać ukryty na stronie, która używa szablonu. Znacznikiem <noinclude> ogranicza się również linki interwiki do identycznych szablonów, ale znajdujących się w projektach w innych językach. Poniżej treść przykładowego szablonu.
<noinclude>Tutaj jest opis szablonu. [[Kategoria:Szablony wstawiające treść]] [[en:Template:Name]]</noinclude>
Znacznika <includeonly></includeonly> używa się do ukrywania w treści szablonu tekstu, który na stronie szablonu nie powinien się pojawić, ale powinien pojawić się na stronie która użyje szablonu. Również tym znacznikiem powinno być ograniczone dopisanie do kategorii do której ma być dopisana strona korzystająca z szablonu, ale sam szablon nie. Znacznikiem <includeonly> ogranicza się również widoczność kodu szablonu, który do poprawnej pracy wymaga podania parametrów. Na stronie korzystającej z szablonu parametry są umieszczone, natomiast na stronie samego szablonu brak parametrów może powodować wyświetlanie komunikatów o błędzie. Przykładowy fragment szablonu znajduje się poniżej.
<includeonly>Ten tekst zostanie wstawiony w treść strony z szablonu. [[Kategoria:Strony korzystające z szablonów]]</includeonly>
Możliwe jest wzajemne zagnieżdżanie znaczników <noinclude> oraz <includeonly>, nie ma jednak ono sensu praktycznego.
Znacznik <onlyinclude></onlyinclude> tworzy osobny mechanizm niezależny od znaczników <noinclude> oraz <includeonly>. Użycie go powoduje, że w szablonie będzie widoczna treść zarówno umieszczona wewnątrz znacznika <onlyinclude>, jak i na zewnątrz tego znacznika. Jednak na stronie która korzysta z szablonu widoczna będzie wyłącznie treść wewnątrz znacznika <onlyinclude>. Użycie <onlyinclude> upraszcza kod szablonu, ale nie pozwala na zapisanie w treści szablonu kategorii, która ma być wstawiona w treść strony korzystającej z szablonu, ale nie pojawić się na stronie szablonu. Poniżej przykład szablonu korzystającego z <onlyinclude>.
Tutaj jest opis szablonu. [[Kategoria:Szablony wstawiające treść]] [[en:Template:Name]] <onlyinclude>Tylko ten tekst zostanie wstawiony w treść strony z szablonu, ale będzie również widoczny na stronie szablonu.</onlyinclude>