Znaczniki HTML/XML
Serwis Olsztyńska Strona Rowerowa http://www.rowery.olsztyn.pl umożliwia tworzenie opisów tras wykorzystując prosty język znaczników. Znaczniki zostały dobrane w taki sposób by przygotowywany tekst był czytelny w dowolnym edytorze tekstu.
Celem dokumentu jest przedstawienie zasad używania znaczników formatujących tekst opisów zamieszczanych w Serwisie OSR.
Definicje
Ilekroć w dokumencie zostaną użyte poniższe terminy, wyrażenia i skróty, będą miały one następujące znaczenie:
- OSR - Serwis Olsztyńska Strona Rowerowa http://www.rowery.olsztyn.pl
- HTML - język opisu stron WWW http://www.w3.org
- XML - strukturalny język opisu dokumentów.
Konwencje nazw
W opisach zastosowano następujące konwencje:
- Ważne informacje na temat działania poszczególnych opcji poprzedzono słowem UWAGA
- Parametry opcjonalne zapisano w nawiasach kwadratowych np. "[ID-TRASY/]ID-ZDJĘCIA"
Poprawne warianty parametrów to "ID-ZDJĘCIA" oraz "ID-TRASY/ID-ZDJĘCIA" - Warianty opcji rozdzielono znakiem '|' np. "ID-ZDJĘCIA [left|right]"
Poprawne warianty opcji to "ID-ZDJĘCIA", "ID-ZDJĘCIA left" lub "ID-ZDJĘCIA right" (opcje "left" i "right" wykluczają się wzajemnie)
Stosowanie znaczników
Działy w których dozwolone jest stosowanie znaczników HTML/XML:
- Wieści (news).
- Opisy tras rowerowych (route).
- Rower i okolice (info).
- Księga gości (guestbook, znaczniki ograniczone do zestawu <br/> <a></a>).
- Podsumowanie ankiety.
- Opisy zdjęć.
W pozostałych działach wprowadzony tekst jest najpierw filtrowany a znalezione znaczniki HTML/XML usuwane - dotyczy to działów:
- Komentarze (tras, ankiet).
- Forum.
Znaczniki inne niż opisane w dokumencie są przez system filtrowane i usuwane.
Większość znaczników można łączyć ze sobą i zagnieżdżać, np.:
<b><i>tekst pochyły i wytłuszczony</i></b>
Należy pamiętać by w przypadku stosowania kombinacji znaczników zachować ich właściwą kolejność.
Formatowanie tekstu
Możliwe jest wytłuszczanie, pochylanie, podkreślanie tekstu. Oczywiście można łączyć wszystkie znaczniki ze sobą.
Możliwe jest <b>wytłuszczanie</b>, <i>pochylanie</i>, <u>podkreślanie</u> tekstu. Oczywiście można <b><i><u>łączyć</u></i></b> wszystkie znaczniki ze sobą.
Paragrafy mogą być tworzone za pomocą znaczników <p></p>. Bloki tekstu mogą mieć odmienne formatowanie (<p align="right">powoduje wyrównanie tekstu do prawej strony</p>). Wymuszenie nowej linni następuje przez umieszczenie w tekście znacznika <br/>.
Kolor tekstu można zmieniać stosując znacznik <color></color>, którego parametrem jest kod koloru - nazwa lub liczba szesnastkowa zgodna ze standardami WWW.
<color red>czerwony tekst</color> <color #FF0000>czerwony tekst</color>
Oczywiście jest możliwe ukrycie fragmentu tekstu, który zostanie przesłany do przeglądarki ale nie zostanie wyświetlony. Za takie działanie odpowiada znacznik <comment></comment> zamieniający tekst w komentarz HTML.
<comment>ten tekst będzie niewidoczny</comment>
Linki
Linki w zależności od elementu docelowego mogą być tworzone za pomocą znaczników HTML oraz specjalnych znaczników OSR. W najprostszym przypadku link można utworzyć za pomocą znaczników <a></a>
<a href="http://www.rowery.olsztyn.pl">OSR</a>
Powyższy przykład tworzy link o nazwie "OSR" prowadzący do strony WWW. Adres docelowy (href) musi być poprzedzony nazwą protokołu http://.
Znacznik <url></url> również tworzy link o nazwie takiej samej jak adres docelowej strony WWW . Poniższe dwie konstrukcje są więc sobie równoważne (tak jak poprzednio adres docelowy musi być poprzedzony nazwą protokołu).
<url>http://www.rowery.olsztyn.pl</url> <a target="_bank" href="http://www.rowery.olsztyn.pl">http://www.rowery.olsztyn.pl</a>
By uprościć tworzenie linków prowadzących do różnych zasobów serwisu OSR powstał znacznik <link></link> w poniższych odmianach:
Opis znacznika | Format |
---|---|
link do opisu trasy | <link route ID-TRASY>opis</link> |
link do galerii zdjęć 1) | <link gallery>opis</link> <link gallery ID-TRASY>opis</link> |
link do zdjęcia 2) | <link photo ID-ZDJĘCIA>opis</link> <link photo ID-TRASY/ID-ZDJĘCIA>opis</link> |
link do zdjęcia panoramicznego | <link panorama ID-ZDJĘCIA>opis</link> <link panorama ID-TRASY/ID-ZDJĘCIA>opis</link> |
link do ankiety | <link vote ID-ANKIETY>opis</link> |
link do artykułu 3) | <link info ID-ARTYKUŁU>opis</link> |
link do wiadomości 4) | <link news ID-WIADOMOŚCI>opis</link> |
Kilka dodatkowych uwag:
- Linki powodują otworzenie docelowej strony w tym samym oknie przeglądarki. Wyjątkiem są znaczniki <link panorama></link> oraz <url></url>, które powodują wyświetlenie danych w oddzielnym oknie przeglądarki.
- Do wszystkich zdjęć linki mogą być tworzone zarówno przez <link photo></link> jak też <link panorama></link>.
- Wszystkie linki utworzone za pomocą znacznika <link></link> są wyróżniane kolorem. Nie jest konieczne dodatkowe formatowanie linku by wyróżniał się z tekstu opisu.
UWAGA
Wszystkie ID wymienione w tabeli powyżej (ID-TRASY, ID-ZDJĘCIA itp.) muszą być zapisane jako TRZYCYFROWE LICZBY z ewentualnymi zerami wiodącymi.
Na przykład: 000, 010, 012/012
Grafika
System automatycznie tworzy galerię zdjęć z danej trasy oraz dołącza do opisu losowo wybrane zdjęcie. Poza tymi możliwościami grafikę do opisu trasy można wstawić na dwa sposoby:
- Za pomocą znacznika HTML <img/>
- Za pomocą specjalnego znacznika <include></include>
W przypadku znacznika <img/> ależy podać właściwą lokalizację pliku, który zostanie wyświetlony "wewnątrz" opisu. Możliwe jest określenie położenia zdjęcia względem tekstu przez stosowanie modyfikatorów np. align="right". Opcjonalny modyfikator title umożliwia nadanie komentarza wyświetlanego jako tooltip przez większość przeglądarek internetowych.
<img src="http://www.wp.pl/i/const/v3/logo.gif" title="obrazek" align="right"/>
Powyższy przykład spowoduje wyświetlenie obrazka pobranego spod adresu wskazanego przez modyfikator href. Obrazek będzie miał tytuł "obrazek" i będzie znajdował się po prawej stronie okienka.
Znacznik <include></include> umożliwia dołączanie do opisu miniaturek zdjęć publikowanych w seriwisie OSR.
<include photo [ID-trasy/]ID-zdjęcia [left|right]>tytuł</include> <include photo 012/012 left>zdjęcie 12 z trasy 12</include>
Tak jak w przypadku powyżej istnieje możliwość określenia położenia zdjęcia względem tekstu (modyfikator [left|right]).
Listy
OSR wspiera tylko listy nie numerowane tworzone za pomocą znaczników <ul><li></ul>. Listy mogą być zagnieżdżone.
<ul>to jest drzewko <li>gałąź-1/1 <ul>dodatkowe drzewko <li>gałąź-2/1 <li>gałąź-2/2 </ul> <li>gałąź-1/2 </ul>
Tabele
Znaczniki <table><tr><td></td></tr></table> umowżliwiają formowanie tabel. Nie jest możliwe zamieszczanie nagłówków tabel (znacznik <th> nie jest obsługiwany) ale jest możliwe zagnieżdżanie tabel.
<table> <tr> <td>wiersz 1 kolumna 1</td> <td>wiersz 1 kolumna 2</td> </tr> <tr> <td>wiersz 2 kolumna 1</td> <td>wiersz 2 kolumna 2</td> </tr> </table>
Separatory
Jedynym sposobem na wizualne rozgranicznie fragmentów opisu jest znacznik <hr/>. Powoduje on wyświetlenie poziomej linni przez całą dostępną szerokość okienka.
Kontakt z administratorami
W przypadku wszelkich wątpliwości skontaktuj się z administratorami Serwisu Olsztyńska Strona Rowerowa http://www.rowery.olsztyn.pl
Adresy e-mail: