[doc] Dokumentacja Chameleona, Wszystkie uwagi wraz z ortografią Opcje

[Bastion]

Polonistą nie jestem dlatego proszę o rzucenie okiem. Interesuje mnie czy :

- jest w miarę czytelnie
- czy łatwo idzie uzyskać informacje
- czy jest w miare zrozumiale jak na doc'a
- wszystko co sie nie podoba

http://www.vertis.com.pl/doc/

Ten post edytował Bastion 28.04.2006, 12:45:56

[dr_bonzo]

Teraz ja (IMG:http://forum.php.pl/style_emoticons/default/tongue.gif)
Forma uwag: rozna; moje odczucia, moje wskazowki, nakazy (IMG:http://forum.php.pl/style_emoticons/default/tongue.gif) (szybciej sie popprostu je pisze (IMG:http://forum.php.pl/style_emoticons/default/smile.gif) ), itd

1. http://www.vertis.com.pl/doc/doku.php?id=instalacja

Kod

  $chown nobody:nobody templates_php
  $chmod 700 templates_php (...)

Skoro zapisujesz znak zachety a zeby wykonacz chowna trzeba byc rootem -- to przydalby sie '#' zamiast '$' i dopisek ze trzeba byc rootem.

2. (link ten sam)

Dla każdej aplikacji używającej Chameleona utwórz katalogi o następujących nazwach :

Przeciez nie trzeba takich nazw uzywac -- konfigurujesz obiekt Chameleon nazwami tych katalogow -- dopisz ze sa to defaultowe nazwy i mozna uzyc innych i t tym-a-tymn miejscu to ustawic.

3. http://www.vertis.com.pl/doc/doku.php?id=budowa_szablonow

zmienna - ciąg liter i cyfr, nie zawierajcy spacji, tworzący nazwe zmiennej.

a co robi tam foo_bar? spracyzuj dozwolone znaki (ew. oddaj regexpa walidujacego nazwe).

4.

tablica - podobnie jak zmienna, z tą jednak różnicą, że posiadaja dodatkowy parametr określający klucz danej tablicy.

A jak ja indeksujemy? Jak indeksowac liczbamnia a jak stringami (chodzi o apostrofy/cydzysl.)


5.

Zarówno funkcje jak i modyfikatory mogą posiadać jeden lub więcej parametrów

Tablice tez.
Brakowalo mi odnosnikow "parametr jest opisany tutaj (click)" do opisu parametrow w opisie tablic, funkcji itd.
Dalej nie ma info o apostrofach dla parametrow tekstowych.

6.

Liczba, która znajduje się w zmiennej zostanie zamieniona na jednostki w Bajtach a wynik zostanie zaokrąglony do dwóch miejsc po przecinku.

A jest co zaokraglac? Przeciez nie podaje sie wielkosci pliku w stylu: 3,45B -- bo bajty sa tylko cale (nie da sie zapisac pojedynczych bitow). Troche niejasno to napisales.

7.

[PHP] pobierz, plaintext 
<?php
/* Jeśli szablon posiada plik cache, nie ma potrzeby definiować zmiennych */
	if (!$tpl -> cached())
	{
		/* Ustawienie zmiennych "kto" oraz "co" */
		$tpl -> setVar('kto', 'misiu');
?>
[PHP] pobierz, plaintext 

Dotyczy kodu Chameleona -- a nie prosciej dla usera byloby dodanie takze do metody setVar() sprawdzenia :

[PHP] pobierz, plaintext 
<?php
if ( $this->cached() )
{
	return
	}
//... ustawianie zmiennej
?>
[PHP] pobierz, plaintext 

Wtedy mozna by pominac ta konstrukcje warunkowa if ( ! tpl->cached() )

8. http://www.vertis.com.pl/doc/doku.php?id=modyfikatory

Brakuje opisu definiujacego koplejnosc parametrow, tzn. "parametry sa wypisane w kolejnosci w jakiej musza/maja wystepowac w modyfikatorze", lub dodaj je w definicji modyfikatora: modyfikator( param1, par2, ... )

9. http://www.vertis.com.pl/doc/doku.php?id=funkcje

required expresion - warunek do spełnienia

Kiedy warunek NIE jest spelniony? Gdy warunek === FALSE czy np. "" lub zero (0)?


10. list()

Opis : Listuje zawartość tablicy, powtarzając blok zamkniety znacznikiem {@end}

(Smartyego nie pamietam juz) Nie rozumiem jak dziala list()... Mam tablice TAB
{@list(TAB)}
{TAB['indeks']} <<< tutaj TAB jest elementem tablicy TAB? a 'indeks' wyciaga element (drugi wymiar) tego elementu?
{@end}

Poza tym ta tablica chyba nie musi byc jednowymiarowa? Bo mozna chyba zagniezdzac list()'a?

11. math()

Jak wstawiac wyrazenie matematyczne jako parametr? W apostrofach, bez? Jakie funkje, operatory sa dostepne?



12. http://www.vertis.com.pl/doc/doku.php?id=pluginy

Każdy modyfikator musi posiadać początkowe dwa parametry :
&$chameleon

Niby referencja jest zaznaczona w nazwie parametru a jednak przydala by sie notka ze te parametry musza byc przekazywane przez referencje -- przeciez to jest wazne gdy chcemy zmodyfikowac zmienna.


13. JAk dziala modyfikator?
Kiedy jest zmieniona na stale wartos podanej zmiennej? Co trzeba zrobic zeby ja na stale zmienic (oproch $overwrite), chyba ($input = 'cosNowego' (IMG:http://forum.php.pl/style_emoticons/default/questionmark.gif) ?)?
Co sie dzieje z wartosci zwrocona przez modyfikator?

14.

Może przetworzyć wprowadzoną informację i wyświetlić ją dokumencie wyjściowym,
Może trwale zmodyfikować wprowadzoną informację zmieniając jej charakter,
Może tworzyć nowe zmienne szablonu na podstawie podanych parametrów,

Jak to zrobic?

XX.

Jeśli zauważyłeś błąd w dokumentacji

Chyba tak (IMG:http://forum.php.pl/style_emoticons/default/tongue.gif)

Tyle (IMG:http://forum.php.pl/style_emoticons/default/smile.gif)