PHP/Inne/Dla twórców podręcznika: Różnice pomiędzy wersjami
Usunięta treść Dodana treść
utworzenie |
generalne uzupełnienie + dodanie listy szablonów |
||
Linia 1:
{{prognavend|PHP|PHP:Inne:Pomoc}}
== Dla twórców podręcznika ==
Linia 8:
Jeżeli chcesz opisać jakąś bibliotekę, zgłoś to w dyskusji i zaproponuj spis treści. Wykaz propozycji można znaleźć na podstronie [[Programowanie:PHP:Inne:Do zrobienia|Do zrobienia]].
=== Nawigacja ===
Na górze '''każdej''' podstrony prosimy zamieszczać następujący szablon:
{{prognav|PHP|poprzedni|nastepny}}
którego kod jest następujący:
<nowiki>{{prognav|PHP|poprzedni|nastepny}}</nowiki>
Pola ''poprzedni'' oraz ''nastepny'' wypełniamy nazwami odpowiednich rozdziałów. Spis treści dostępny jest na stronie głównej podręcznika i wszelkie ważniejsze edycje należy uprzednio konsultować w dyskusji.
=== Styl ===
Linia 13 ⟶ 24:
Myślą przewodnią niniejszego podręcznika jest tzw. zasada złotego środka. Cztelnik po przeczytaniu powinien mieć wyrobiony nawyk pytania siebie czy dana rzecz jest mu rzeczywiście potrzebna w oryginalnym kształcie. Wszystkie zagadnienia powinny mieć czytelnie wyszczególnione wady oraz zalety bez dołączanych twierdzeń sugerujących, że jest to panaceum na wszystkie problemy świata.
Bardzo ważne jest graficzne rozłożenie tekstu na stronie, aby nie sprawiał wrażenia chaotycznego. Podczas edycji zawsze możemy podejrzeć, jak wprowadzone zmiany będą się prezentować. Unikajmy za wszelką cenę jednozdaniowych akapitów oraz nieracjonalnego dzielenia nimi jednolitej treści. Wskazane jest stosowanie list wypunktowanych lub numerowanych. Są bardziej przejrzyste niż normalny tekst, a przy tym zwięzłe. Używaj też ramek pomocniczych, których spis został zamieszczony niżej.
Przykładowe kody źródłowe muszą być napisane czytelnie, w oparciu o identyczne formatowanie.
#Nawiasy klamrowe otwieramy w nowej linijce
#Wcięcia trójznakowe
#W nazewnictwie posługujemy się camelStyle (tj. zmienne, funkcje itd. nazywamy jako ''nazwaFunkcji'', a nie ''nazwa_funkcji'' albo ''nazwafunkcji'').
#Poszczególne części algorytmu staramy się separować linijką przerwy
#Kod musi być skomentowany, najlepiej komentarzami jednolinijkowymi
Linia 23 ⟶ 36:
W kodach źródłowych staramy się unikać nieprawidłowych nawyków:
#Niepotrzebne zmienne tymczasowe - jeżeli są potrzebne, wyjaśniamy dlaczego. Pamiętajmy o tym szczególnie przy omawianiu baz danych, gdzie zapytania piszemy bezpośrednio w funkcji/metodzie, bez żadnej pomocniczej zmiennej ''$query'', ''$zapytanie'' itd.
#Wszystkie zmienne wcześniej inicjujemy.
#W programowaniu obiektowym każdą metodę poprzedzamy przedrostkiem ''public'', ''private'' itd.
#Nie stosujemy elementów składni typowych dla PHP 4 (np. ''var''), chyba że w opisach objaśniających różnice między wersjami.
#Konstrukcje używane niezgodnie z przeznaczeniem powinny być omijane. Zaliczają się do nich m.in. ''funkcja("$zmienna");''
=== Neutralny punkt widzenia ===
Zgodnie z zasadą Wikibooks, podręcznik powinien utrzymany być w konwencji ***neutralnego punktu widzenia***. Dotyczy to w szczególności takich rozdziałów, jak [[Programowanie:PHP:Inne:Edytory PHP|Edytory PHP]] czy [[Programowanie:PHP:Inne:Pomoc|Pomoc]], które wcale nie służą do reklamowania własnych aplikacji bądź serwisów WWW. Wszelkie kontrowersyjne materiały będą usuwane albo przeredagowane bardzo szybko.
=== Podstrony ===
* [[Programowanie:PHP:Inne:Do zrobienia|Do zrobienia]]
* [[Programowanie:PHP:Inne:Wytyczne|Wytyczne dla rozdziałów]] (czyli co każdy powinien zawierać)
=== Szablony ===
Oto wykaz szablonów używanych w podręczniku:
{| border="1" cellpadding=3 cellspacing=0 style="margin: 0; border: 1px #aaaaaa solid; border-collapse: collapse; width: 100%; background-color: #ffffff"
|- style="background-color: #efefef; font-size: 95%"
! width="25%" | Opis !! Kod !! Efekt
|-
| Ostrzeżenie czytelnika
| {{[[Szablon:Uwaga|Uwaga]]<nowiki>|</nowiki>tekst=Tekst ostrzeżenia}}
|
{{Uwaga|tekst=Tekst ostrzeżenia}}
|-
| Porada
| {{[[Szablon:Porada|Porada]]<nowiki>|</nowiki>tekst=Tekst porady}}
|
{{Porada|tekst=Tekst porady}}
|-
| Informacja
| {{[[Szablon:Infobox|Infobox]]<nowiki>|</nowiki>tekst=Tekst informacji}}
|
{{Infobox|tekst=Tekst informacji}}
|-
| Definicja
| {{[[Szablon:Definicja|Definicja]]<nowiki>|</nowiki>tekst=Tekst definicji}}
|
{{Definicja|tekst=Tekst definicji}}
|-
| Do zrobienia
| <nowiki>{{</nowiki>[[Szablon:TODO|TODO]]<nowiki>|co zrobić}}</nowiki>
| {{TODO|co zrobić}}
|-
| Do zrobienia
* do wstawiania w sekcji
* stosować tylko w rozdziałach, w których większość tekstu jest napisana
| {{tl|RDoZrobienia}}
| {{RDoZrobienia}}
|-
| Artykuł do poprawy
| {{[[Szablon:poprawić|poprawić]]<nowiki>|powód}}</nowiki>
| {{poprawić|powód}}
|}
| |||