MotławaWiki:Zanim zaczniesz edycje

Zanim zaczniesz edycję, prosimy o zapoznanie się z istniejącym stanem haseł w celu rozpoznania "klimatu" przekazu danych.

Podstawową sprawą przy edycji/dodawaniu pojęć jest:

• układanie haseł w sposób jednoznaczny (trafiających jednoznacznie w sedno problemu) - nie używać pojęć wieloznacznych w celu określenia konkretnego problemu.
• pisać jasno i przejrzyście (aby osoba nie będąca wprost w temacie wiedziała o co chodzi) z użyciem formatowania WIKI celem lepszego uwypuklenia niektórych opcji treści
• dopasować stosowne kategorie (przynajmniej jedną!) do edytowanego zagadnienia (może występować po kilka kategorii, jednak wszystkie powinny mieć logiczne uzasadnienie). Lista kategorii znajduje się tu: Specjalna:Kategorie
• opisując zagadnienie, trudniejsze terminy (słowa) potraktuj jako linki celem ich późniejszego wyjaśnienia (nie każdy czytający musi znać wszystkie skróty i terminy) - taka jest zasada Wiki
• W miarę możliwości nie używać skrótów wewnętrznych (np. FV) bo przeciętny user zapewne nie wie, że to oznacza Fakturę Vat
• Jeśli już zapiszesz coś to po chwili przeczytaj całą zawartość patrząc z perspektywy zielonego usera
• W przypadku natrafienia na hasło, z którym nie jesteś w stanie dać sobie rady (napisane jest niejasno) prosimy na górze jego strony dopisać szablon: {{PisaćJaśniej}} da to efekt:

Ten artykuł wymaga opisania w sposób jasny dla ludzi z zewnątrz zgodnie z zaleceniami edycyjnymi. Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{PisaćJaśniej}} z kodu tego artykułu.

• W przypadku natrafienia na hasło wymagające dopracowania prosimy na górze jego strony dopisać szablon: {{Dopracować}} da to efekt:

Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

• Jeśli dane hasło jest przeładowane i lepszym rozwiązaniem by było utworzenie haseł pokrewnych to możesz zaproponować aby dana sekcja hasła stała się osobnym pojęciem poprzez dodanie {{Podziel sekcję}}, da to efekt:

Zasugerowano, aby ta sekcja została przeniesiona do nowego artykułu.

• Jeśli dane hasło jest placem budowy to wpisz koniecznie na górze: {{PracaWre}} - niech inni wiedzą że to nie jest finalna wersja. Po zakończeniu prac wystarczy usunąć podany znacznik. Wynik dodania znacznika da efekt:

Ten artykuł jest w trakcie tworzenia, nie wszystkie odnośniki mogą działać poprawnie lub być rozwinięte Możesz nam pomóc przy rozbudowie dokumentacji systemu - zobacz jak możesz tego dokonać

• Jeśli zawartośc danej strony jest przeklejana z automatu (nie edytowania/pisana ręcznie) to proszę dodać na górze strony przypis: {{automat}} - niech inni wiedzą że to nie jest finalna wersja. Po zakończeniu prac wystarczy usunąć podany znacznik. Wynik dodania znacznika da efekt:

Strona wygenerowana automatycznie - jeśli widzisz jakieś nieścisłości to popraw!

• __NOTOC__ - ukrywa spis treści generowany automatycznie.
• Jeśli potrzebujesz wtrącić kod poza Wiki to użyj w tym celu składni:

 <nowiki> tekst poza wiki </nowiki>

• Jeśli potrzebujesz wtrącić cytat kodu pascala lub SQL to użyj składni (przykłąd dla pascala):
  

<source lang=pascal> 
begin
  aS := Obj.Text;
end; </source>

co w efekcie da:

 
 begin
   aS := Obj.Text;
 end;

• Nasze szablony

• Jeśli coś mimo to jest nie jasne to atakuj w tej sprawie Sebastiana ;)