Podstawowe informacje o STC

STC, czyli Smart Text Converter jest mechanizmem do konwersji treści z postaci zwykłego tekstu do postaci HTML'a. Do tego celu używa się znaczników.

Znaczniki

Znaczniki są to zapisy, które umieszcza się w treści w celu modyfikacji jego wyglądu. Znaczniki dzielimy na dwa rodzaje: otwierające i zamykające.

Znaczniki otwierające

Znaczniki otwierające mają następującą budowę:

[znacznik_otwierajacy parametr1=wartosc1 parametr2=wartosc2 ... parametr_n=wartosc_n ]

Znacznikami otwierającymi informujemy, że chcemy zmodyfikować styl treści, która następuje po znaczniku. Niektórym znacznikom możemy przekazywać parametry za pomocą których konfigurujemy dodatkowo zachowanie znacznika - więcej na temat parametrów dowiesz się później. Znaczniki otwierające należy zawsze kończyć znacznikami zamykającymi. Wyjątkiem od tej zasady są znaczniki jednostronne, o których dowiesz się później.

Znaczniki zamykające

Znaczniki zamykające mają następującą budowę:

[/znacznik_zamykajacy]

Za pomocą znaczników zamykających powiadamiamy mechanizm, że styl, którego używaliśmy chcemy zakończyć. Tym samym styl formatowania treści powróci do stanu sprzed zastosowania określonego znacznika. Znacznik zamykający nazywa się tak samo jak otwierający z tą różnicą, że jest poprzedzony slashem /. Znacznik zamykający nie przyjmuje również żadnych parametrów.

Znaczniki jednostronne

Znaczniki jednostronne mają taką samą budowę jak znaczniki otwierające. Zasadniczą różnicą jednak jest to, że znacznik nie ma wpływu na styl treści, która jest za znacznikiem jednostronnym. Celem znacznika jednostronnego jest wstawienie jakiegoś 'obiektu' do dokumentu, a jego ścieżkę dostępu bądź inne cechy konfigurujemy za pomocą parametrów przekazanych wewnątrz znacznika. Obiektem może być np. obrazek czy też link do strony zewnętrznej.

Wstawianie znaczników w treści w postaci tekstu

W związku z tym, że mechanizm STC przetwarza treść pozbawioną formatowania, znakiem specjalnym jest znak [. Jeżeli chcemy wstawić w treści znak [ czasami będziemy musieli go poprzedzić backslashem, czyli napisać \[. Poprzez wstawienie backslasha możemy anulować wywołanie polecenia parsera, czyli zapis \[b] wyświetli nam [b] zamiast wykonać polecenie pogrubienia tekstu.

Przykład

Zanim przejdziemy do omawiania dokładniejszego znaczników przedstawię teraz krótki przykład demonstrujący działanie w praktyce znaczników.

Treść zaformatowana

To jest jakiś tekst w którym zastosowano różne znaczniki HTML'a. Aby napisać znacznik [b] w postaci tekstu, należy poprzedzić go backslashem.

Treść źródłowa