Pomoc:Szablony

Ta strona opisuje szablony wykorzystywane na tej wiki.

Szablony są niezwykle przydatnym narzędziem, zapewniającym wiele ułatwień:

• Jednolitość stylu - przy odpowiednim wykorzystaniu szablonów, strony będą miały utrzymany identyczny wygląd. Również, wykorzystanie szablonu jest dużo prostsze niż ręczne wykonywanie formatowanie.
• Brak konieczności powtarzania się - strony zawierające bardzo podobną zawartość są generowane z odpowiedniego szablonu (przykład - metoda clear() dla kontenerów). Ewentualnej zmiany nie trzeba wykonywać na dziesiątkach/setkach stron korzystających z szablonu, ale tylko na stronie tego szablonu.
• Skrócenie kodu - większość pracy związana z formatowaniem i wyglądem została już wykonana, znajduje się w szablonach i nie zaśmieca treści kodu stron.

Ta wiki korzysta z wielu szablonów. Pełna lista jest dostępna na stronie [1]. Jako że ta wiki wykorzystuje Mediawiki CMS, wszystkie szablony dostępne na Wikipedii mogą też być użyte tutaj. Dodatkową korzyścią jest możliwość wykorzystania dokumentacji szablonów do nauki składni szablonów Mediawiki.

Poniżej znajdują się najczęściej używane szablony wraz z krótkim opisem.

Listy

Rodzina szablonów do wyświetlania list

• dcl list **** : Do tworzenia list funkcji/pól składowych.
• ddcl list **** : Do tworzenia szczegółowych list deklaracji (tych zawiuerających faktyczny kod deklaracji)
• tdcl list **** : Do tworzenia list typu identyfikator - definicja (lub wyjaśnienie). Wykorzystywane m.in. przy definicjach typów (typedef) i wartościach typów wyliczeniowych.
• sdcl list **** : Do tworzenia list reprezentujących różne składnie of a language feature. Używane na podstronach cpp/language
• param list **** : Do tworzenia list objaśniających parametry funkcji.

Wypisywanie znaków składni

Dokumentacja

Szablony używane do produkowania znaków specjalnych:

{{!}} - sprowadza się do |

{{!!}} - sprowadza się do ||

{{=}} - sprowadza się do =

{{==}} - sprowadza się do ==

{{!=}} - sprowadza się do |=

Formatowanie

Dokumentacja

Dodaje formatowanie do załączonego tekstu

{{tt|text}} - czcionka monospace* ( atrybut html <tt>)

{{ttb|text}} - pogrubiona czcionka monospace* (atrybuty html <tt><b>)

{{small|text}} - mała czcionka (atrybut html <small>)

{{smalltt|text}} - mała czcionka monospace* (atrybuty html <small><tt>)

*monospace - czcionka o stałej szerokości znaków

Podświetlanie składni

Dokumentacja

Szablony używane do podświetlania składni.

{{c| 1=kod| lang=język(opcjonalne)}} - bazowy szablon przeznaczony do kolorowania kodu w tekście, tj. nie wydziela w żaden sposób kodu. Parametr lang jest opcjonalny; wartość zwracana przez {{get_lang}} jest użyta jako domyślna.

{{source| 1=kod| lang=język(opcjonalne)}} - bazowy szablon przeznaczony do podświetlania składni dużej ilości kodu. Parametr lang jest opcjonalny; wartość zwracana przez {{get_lang}} jest użyta jako domyślna.

{{eq fun| lang=język|kod1|kod2(opcjonalne)|...|kod4(opcjonalne)}} - gdzie kod1, kod2, itd. to kod dla każdej z wersji opisywanego szablonu funkcji. Jeśli do szablonu nie został podany kod, w miejscu wywołania zostanie umieszczona ramka {{todo}}. Parametr lang jest opcjonalny; wartość zwracana przez {{get_lang}} jest użyta jako domyślna.

{{example| opis(opcjonalne)| lang=język(opcjonalne)| code=Kod| p=true_jeśli_niedeterministyczny(opcjonalne)}} - bazowy szablon przeznaczony do umieszczania przykładów. Jeśli code nie jest obecny, szablon doda w miejsce wywołania sekcję {{todo}}. Parametr lang jest opcjonalny; wartość zwracana przez {{get_lang}} jest użyta jako domyślna. output określa wyjście, które zostanie wypisane po wykonaniu kodu. Jeśli wyjście nie jest deterministyczne, aby to zaznaczyć można ustawić p jako true. (Wtedy zamiast "wyjście" wyświetlane jest "możliwe wyjście".)

Linki

Dokumentacja

Szablony używane do tworzenia linków.

Linki bezwzględne:

{{ltt|path|title (opcjonalne)}} - link do strony używający jej ścieżki bezwzględnej. Domyślnym tytułem jest ostatni fragment ścieżki. Czcionka linku to teletype.

{{ltf|path|title (opcjonalne)}} - link do strony używający jej ścieżki bezwzględnej. Domyślnym tytułem jest ostatni fragment ścieżki. Czcionka linku to teletype. Parentheses indicating function are appended.

{{cpp/ltt|path|title (opcjonalne)}} - link do strony używający jej ścieżki bezwzględnej. Domyślnym tytułem jest ostatni fragment ścieżki. Czcionka linku to teletype. std:: indicating std namespace is prepended.

{{cpp/ltf|path|title (opcjonalne)}} - link do strony używający jej ścieżki bezwzględnej. Domyślnym tytułem jest ostatni fragment ścieżki. Czcionka linku to teletype. Parentheses indicating function are appended. std:: indicating std namespace is prepended.

{{l2tt|page|title1 (opcjonalne)| title2 (opcjonalne)}} link do strony używający jej ścieżki bezwzględnej. Tytuł jest tworzony z dwóch ostatnich części ścieżki. :: jest wstawiane pomiędzy nie. Każdą z tych części można nadpisać, odpowiednio przez title1 i title2. Czcionka linku to teletype.

{{l2mtt|page|title1 (opcjonalne)| title2 (opcjonalne)}} - tworzy złożony link(ang). Tytuł jest tworzony z dwóch ostatnich części ścieżki. :: jest wstawiane pomiędzy nie. Każdą z tych części można nadpisać, odpowiednio przez title1 i title2. Czcionka linku to teletype.

Linki względne:

{{rl|page|title (opcjonalne)}} - tworzy link względny do tej strony. Link pojawia się z normalną czcionką.

{{rlp|page|title (opcjonalne)}} - tworzy link względny do strony macierzystej(ang). Link pojawia się z normalną czcionką.

{{rlt|page|title (opcjonalne)}} - tworzy link względny do tej strony. Link pojawia się z czcionką teletype.

{{rlpt|page|title (opcjonalne)}} - tworzy link względny do strony macierzystej(ang). Link pojawia się z czcionką teletype.

{{rlf|page|title (opcjonalne)}} - tworzy link względny do tej strony. The link appears in teletype font and parentheses indicating a function are appended.

{{rlpf|page|title (opcjonalne)}} - tworzy link względny do strony macierzystej(ang). The link appears in teletype font and parentheses indicating a function are appended.

Przypisy

Rodzina szablonów {{mark}}

Dokumentacja

Tworzy adnotację. Niektóre adnotacje zostały już zdefiniowane:

Różne

{{mark deprecated}} sprowadza się do (przestarzałe)

{{mark optional}} sprowadza się do (opcjonalne)

{{mark implicit}} sprowadza się do (niejawnie zadeklarowany)

{{mark typedef}} sprowadza się do (typedef)

{{mark enum}} sprowadza się do (enum)

{{mark keyword}} sprowadza się do (sł.kluczowe)

{{mark language}} sprowadza się do (język)

Standardy

{{mark c++03}} sprowadza się do (C++03)

{{mark since c++03}} sprowadza się do (od C++03)

{{mark until c++03}} sprowadza się do (do C++03)

{{mark c++11}} sprowadza się do (C++11)

{{mark since c++11}} sprowadza się do (od C++11)

{{mark until c++11}} sprowadza się do (do C++11)

{{mark c95}} sprowadza się do (C95)

{{mark since c95}} sprowadza się do (od C95)

{{mark until c95}} sprowadza się do (do C95)

{{mark c99}} sprowadza się do (C99)

{{mark since c99}} sprowadza się do (od C99)

{{mark until c99}} sprowadza się do (do C99)

{{mark c11}} sprowadza się do (C11)

{{mark since c11}} sprowadza się do (od C11)

{{mark until c11}} sprowadza się do (do C11)

{{mark since none}} sprowadza się do (od {std})

{{mark until none}} sprowadza się do (do {std})

Funkcje

{{mark fun}} sprowadza się do (funkcja)

{{mark tfun}} sprowadza się do (szablon funkcji)

{{mark ptfun}} sprowadza się do (specjalizacja szablonu funkcji)

{{mark mem fun}} sprowadza się do (publiczna metoda)

{{mark mem sfun}} sprowadza się do (publiczna statyczna metoda)

{{mark mem vfun}} sprowadza się do (wirtualna publiczna metoda)

{{mark priv mem fun}} sprowadza się do (prywatna metoda)

{{mark prot mem fun}} sprowadza się do (chroniona metoda)

{{mark prot mem vfun}} sprowadza się do (witualna chroniona metoda)

{{mark macro fun}} sprowadza się do (makro funkcyjne)

Klasy

{{mark class}} sprowadza się do (klasa)

{{mark tclass}} sprowadza się do (szablon klasy)

{{mark talias}} sprowadza się do (szablon aliasu)

{{mark ptclass}} sprowadza się do (specjalizacja szablonu klasy)

{{mark mem class}} sprowadza się do (publiczna klasa składowa)

{{mark priv mem class}} sprowadza się do (prywatna klasa składowa)

{{mark prot mem class}} sprowadza się do (chroniona klasa składowa)

Stałe

{{mark macro const}} sprowadza się do (stała [makro])

{{mark const}} sprowadza się do (stała)

{{mark mem const}} sprowadza się do (stałe pole)

{{mark mem sconst}} sprowadza się do (statyczne stałe pole)

Obiekty

{{mark mem obj}} sprowadza się do (publiczny obiekt składowy)

{{mark priv mem obj}} sprowadza się do (prywatny obiekt składowy)

{{mark prot mem obj}} sprowadza się do (chroniony obiekt składowy)

Rodzina szablonów {{cmark}}

Dokumentacja

Tworzy adnotację do funkcji. Niektóre adnotacje zostały już zdefiniowane:

{{cmark virtual}} sprowadza się do [virtual]

{{cmark static}} sprowadza się do [static]

{{cmark deleted}} sprowadza się do [deleted]

Oznaczanie wersji standardu

Dokumentacja

Used to declare that certain part of the description in valid to only specific revisions of the standard.

{{rev begin|noborder=true_if_noborder}}

Begins the set of text snippets specific to a specific revision(s) of the standard. If the noborder parameter is true then the table is displayed with no border and as little padding as possible.

{{rev|since=since-std(opcjonalne)|until=until-std(opcjonalne)|text}}

Specifies that text is valid only for standard revisions since since-std until until-std (until-std is not inclusive).

{{rev end}} Ends the set of text snippets specific to a specific revision(s) of the standard.

{{rrev|noborder=true_if_noborder(opcjonalne)|since=since-std(opcjonalne)|until=until-std(opcjonalne)|text}}

A combined {{rev begin}}/{{rev}}/{{rev end}}, for when only a single {{rev}} is needed.

{{rrev multi|noborder=true_if_noborder(opcjonalne)|sinceX=since-std(opcjonalne)|untilX=until-std(opcjonalne)|revX=text|...}}

A combined {{rev begin}}/{{rev}}/{{rev end}}. Up to 7 snippets are supported. The default for sinceX is untilX-1 and default for untilX is sinceX+1. Thus, it is most useful when the snippets are relatively short and the revision ranges consecutive. This template may be substituted.

{{rev inl|since=since-std(opcjonalne)|until=until-std(opcjonalne)|noborder=true_if_noborder|text}}

Same as {{rev}}, just is displayed inline. {{rev begin}} and {{rev end}} must not be used.

Border is omitted if the noborder parameter is true.

Paski nawigacyjne

Dokumentacja

Szablon wykorzystywany do dodania paska nawigacyjnego. Z reguły każda strona niebędąca szablonem powinna mieć własny pasek nawigacyjny.

{{navbar
| style =

| heading1 = 
| content1 = 

| heading2 = 
| content2 = 

| heading3 = 
| content3 = 

...

| heading8 = 
| content8 = 

}}

Odstępy

Dokumentacja

Szablony zajmujące się obróbką znaków spacji.

{{space|number}} - wypisuje number znaków spacji

{{space as|text}} - wypisuje tyle znaków spacji, ile znaków ma text. Przydatne do wytwarzania odpowiednich wcięć treści szablonu.

{{trim|text}} - przycina spacje z obu stron parametru text.

Wymagania rzutowania

Dokumentacja

Sablony używane do oznaczanie, że pewien typ musi być konwertowalny do innego. All these templates can emit either of the requirements that it must be possible to convert an object of particular type to another type or it must be possible to dereference an object of particular type and then convert it to another type. This behavior depends an the supplied parameters (t means plain type, p - type that must be dereferenced first).

{{cast rreq| base_type| rt=type or rp=pointer_type}} - base_type must be convertible to rt or *rp.

{{cast req1| base_type| t1=type or p1=pointer_type}} - t1 or *p1 must be convertible to base_type.

{{cast req2| base_type1| base_type2| t1=type or p1=pointer_type| t2=type or p2=pointer_type (optional)}} - t1 or *p1 must be convertible to base_type1 or t2 or *p2 must be convertible to base_type2. If neither t2 nor p2 is supplied, it is assumed that t1 or *p1 must be convertible to both base_type1 or base_type2.

Porządkujące

Dokumentacja

Szablony wykorzystywane do oznaczania stron, wymagających jeszcze pracy. W związku z masą materiału do przetłumaczenia potrzebne jest oznaczenie i zgrupowanie niedokończonych artykułów - poniższe szablony to umożliwiają.

{{todo|powód(opcjonalne)}} =>

{{marktodo|powód(opcjonalne)|tekst do oznaczenia}} => tekst do oznaczenia(TODO)

{{translate}} =>

{{marktranslate|text not translated yet}} => text not translated yet(wymaga tłumaczenia)

{{workinprogress}} => {{toreview|liczba naturalna, np. 1(opcjonalne)}} =>

Dodatkowy opis znajduje się na stronie każdego z szablonów.

Wskazania związane z tłumaczeniem

Dokumentacja

Szablon służący do oznaczenia fragmentu o mało znanym / nieintuicyjnym tłumaczeniu. Przydatny do dodatkowego oznaczenia pojęcia, jeśli jego znaczenia nie dało się jednoznacznie przetłumaczyć, po przetłumaczeniu jego znaczenie nie jest jasne z kontekstu itp.

Przykłady użycia:

{{ang|iterator zakońcowy|past-the-end iterator}} sprowadza się do iterator zakońcowy(ang)

{{ang|rozwiązywanie przeciążeń|overload resolution}} sprowadza się do rozwiązywanie przeciążeń(ang)