Bzr Wiki jest silnikiem wiki, który działa dzięki Bazaar. Nie jest wymagana żadna baza danych.
Całość uzupełnia YAML.
Całość uzupełnia YAML.
Schemat pliku
Oto schemat pliku który należy do /pages:
część YAML
==content==
część HTML
==content==
część HTML
YAML: Ale z czym to się je?
Następujące znaczniki umożliwiają ustawienie właściwości strony. Yaml należy umieszczać na samym początku dokumentu. Wymagane są tylko dla plików które mają zostać umieszczone jako strona/podstrona serwisu.
| Znacznik | Opis |
|---|---|
| title | Ustawia tytuł strony. Parametr jest obowiązkowy |
| redirect | Umożliwia przekierowanie pod dany adres |
| in_progress | Należy jako liste YAML podać gałęzie w których dany dokument jest już dostępny. Przy wczytywaniu zostanie to zamienione na odpowiednią listę z linkami |
| original_link | Wyświetla link z Cherokee-Project.com w specjalnym miejscu na stronie |
| category | Należy podać 2 parametry: `name` oraz `url`. Zostaną użyte do zaprezentowania kategorii ( jak w dokumentacji ) |
URL i scieżki: Mapowanie adresów itp
Każdy , w scieżce jest zastępowany przez _. Domyślnym rozszerzeniem dla /pages jest html, i jeśli nie podano id pliku to zostaje ono dopisane do scieżki.
Czyli wywołanie /pages/pierwszy,test jest wywołaniem /pages/pierwszy_test.html
Bzr Wiki wymaga ścisłego przestrzegania podawania właściwych ścieżek do plików.
Dodatkowo pliki z /dynamic są streamowane ( eng. data streaming ).
Oprócz tego aby strony były w pełni wersjonowane każde zapytanie o plik przechodzi przez specjalny wrapper który wyłąpuje o jaki plik i w jakiej wersji chodzi. Aby wrapper działał należy każdą scieżkę do pliku uzupełnić w następujący sposób:
W przypadku braku podania tych parametrów zostaną one zastąpione domyślnymi czyli main oraz current.
Bzr Wiki wymaga ścisłego przestrzegania podawania właściwych ścieżek do plików.
- /pages dla plików które mają zawartość tekstową i są przystosowane do umieszczenia jako część serwisu ( a więc posiadają część odpowiedzialną za YAML ).
- /dynamic dla plików graficznych oraz każdego innego rodzaju pliku który może zostać osadzony na strone ( również umieszczony jako plik do pobrania ), nie muszą one posiadać YAML.
Dodatkowo pliki z /dynamic są streamowane ( eng. data streaming ).
Oprócz tego aby strony były w pełni wersjonowane każde zapytanie o plik przechodzi przez specjalny wrapper który wyłąpuje o jaki plik i w jakiej wersji chodzi. Aby wrapper działał należy każdą scieżkę do pliku uzupełnić w następujący sposób:
/pages/[[branch]]/[[revision]]/plik
[[branch]] oraz [[revision]] zostaną zastąpione przez silnik przez odpowiednie dla wywołanego pliku wartości, tworząc scieżkę, która dla tej strony wygląda:
/pages/b:main/r:me@pigmej.eu-20090814105829-kbv77n8d56igth2t/info.html
Oczywiście nic nie stoi na przeszkodzie aby podać te parametry ręcznie, aby na stałe ustawić adres. Trzeba jednak pamiętać, że poprawne wywołanie określające branch oraz rewizję wygląda:
/pages/b:nazwa_branch/r:id_rewizji/plik
W przypadku braku podania tych parametrów zostaną one zastąpione domyślnymi czyli main oraz current.
Szczegóły tej rewizji
Rewizje tego pliku
Rewizje w tej gałęzi
Data modyfikacji: 18-03-2009, 18:48:52
Autor: Jędrzej Nowak <me@pigmej.eu>
Typ formatowania: (x)html
Rewizje tego pliku
Rewizje w tej gałęzi
Data modyfikacji: 18-03-2009, 18:48:52
Autor: Jędrzej Nowak <me@pigmej.eu>
Typ formatowania: (x)html