Dyskusja FluxboxPL.org:Konwencja w artykułach

From FluxboxPL.org

Poniżej znajduje się tekst tak, jak ja bym go widział. Feel free to make any poprawkas and dyskusjas here ;) . --Minio 14:06, 11 lut 2007 (CET)


Ta strona jest przeznaczona głównie dla moderatorów portalu i opisuje konwencje przyjęte w tekstach publikowanych.

Spis treści


[edytuj] Ogólna konwencja

[edytuj] Copyrights

Wszystkie wpisy na portalu udostępniane są na licencji Creative Commons 2.5 by-nc, o czym informuje stopka. Z tego powodu każdy może dowolnie edytować już opublikowane artykułu bez zgody lub konsultacji z autorem.

Wcześniejsza konsultacja z autorem (prywatnie lub poprzez jedną ze stron dyskusji - autora lub artykułu, który został by zmieniony) jest oznaką dobrego wychowania i jako taka jest wskazana. Zwłaszcza, gdy ingernecja w tekst miała by być znaczna.

Pomimo przyznania liberalnych praw, wszelkie objawy wandalizmu będą piętnowane a ich autory karani (w przypadkach recydywy przez odcięcie możliwości edycji stron).

[edytuj] Język

Portal ma w nazwie PL, więc wszelkie treści muszą być napisane w tym właśnie języku.

Pisanie bez polskich znaków diaktrycznych (tzw. "ogonków") jest akceptowalne, jednak niemile widziane; wymagane jest poprawianie wszelkich zauważonych braków.

Język polski jest wystarczająco bogaty, by gro z wyrazów anglojęzycznych zastąpić ich polskimi odpowiednikami. Nie ma potrzeby używania makaronizmów lub, często nieudolnie stworzonych, neologizmów.
Pomocne mogą być:


[edytuj] Ścieżki i programy

Aby odpowiednio wyróżnić z tekstu ścieżki do plików oraz używane programy, gdy zajdzie taka potrzeba, proponuję:

  • wytłuszczenie dla programów, np. import (ale już import -pause 3 ~/plik.jpg)
  • kursywa dla ścieżek lub ich elementów, np. ~/skrypty/shutdown.sh

Być może zastosowanie np. kolorów byłoby lepszym rozwiązaniem. Przydałoby się w takim wypadku stworzyć odpowiednie znaczniki mediawiki.

> Dla ścieżek proponowałbym nie kursywę, a czcionkę maszynową, np. ~/skrypty/shutdown.sh. Znaczniki <code></code> --.azhag 11:07, 12 lut 2007 (CET)
> > Jak dla mnie super - --Minio 15:46, 27 lut 2007 (CET)

[edytuj] Ostrzeżenia

Czasami zachodzi potrzeba umieszczenia ważnej informacji (np. o potencjalnych szkodach) na początku artykułu lub sekcji. Na razie stworzyłem bardzo prostą ramkę:

<div style="border: 3px red solid; padding:3px; margin-bottom:3px;">
[Tutaj wstaw tekst swojego ostrzeżenia]
</div>

Wygląda ona tak:

Minister Zdrowia ostrzega: edycja tej ramki powoduje raka i choroby serca.

Wg mnie konieczne jest stworzenie znacznika mediawiki lub odpowiedniego stylu dla ramki w CSS-ie, aby móc globalnie zmieniać ich wygląd modyfikując jeden tylko plik.

  • Zrobiłem prosty szablon Szablon:Uwaga, teraz wpisując {{uwaga|Nigdy nie jedz żółtego śniegu.}} otrzymujemy taki efekt:
Uwaga! Nigdy nie jedz żółtego śniegu.
  • Oczywiście to bardzo wczesna wersja, można (a nawet trzeba) ten szablon doszlifować, znaleźć ładniejszą ikonkę, etc. Ale jakaś baza już jest. ;)
    • wg mnie jest całkiem ładna. Ewentualnie zmienić ikonkę, ale do tego potrzeba grafika ;) (endel, marb?) --Minio 15:46, 27 lut 2007 (CET)
    • jeżeli chodzi o ikonę to ja mam słabość do zestawu Tango - emblem-important. Co najwyżej zmienić kolor jeżeli można. Marb 17:23, 27 lut 2007 (CET)

[edytuj] Konwencja w Artykułach

Nikt jeszcze żadnego nie napisał, więc nie wypowiadam się na te temat; osobiście nie wiem nawet, jakiego typu teksty mają się tam pojawiać.

[edytuj] Konwencja w Poradnikach

Poradnik nie może jedynie pomagać w rozwiązywaniu problemów - on musi również uczyć. Jakkolwiek dla niektórych może to być banalne, w poradniku powinny znajdować się dokładne tłumaczenia, co gdzie i dlaczego się robi.

Dzięki temu czytelnik zostanie wyposażony nie w sposób, ale w wiedzę. Przy pomocy poradnika będzie potrafił uzyskać efekt, jakiego oczekuje nawet, gdy nie zostanie to opisane w tym pierwszym.

Odpowiadanie jest jak danie posiłku głodnemu, ale przedstawienie drogi rozumowania jest jak nauczenie 
go samodzielnego zdobywania żywności.
Jak mądrze zadawać pytania?

[edytuj] Konwencja w Programach

Dział ma na celu przedstawienie programów dobrze działających w duecie z Fluxboksem. Jako takie będą to zazwyczaj programy minimalistyczne, jednak nic nie stoi na przeszkodzie, by zaprezentować np. File Rollera, jeżeli ktoś ma ochotę.

Prezentacja programu powinna zawierać:

  • przedstawienie, jaki jest główny cel programu (archiwizer, odtwarzacz plików multimedialnych, czytnik RSS etc.)
  • wypunktowanie ciekawych/przydatnych funkcji programu
  • link do strony domowej

Ciekawe może okazać się porównanie programu z bardziej znanymi 'alternatywami'.

Dodanie kilku przykładowych obrazów prezentujących program nie jest konieczne, ale w myśl zasady "jeden obraz wyraża więcej niż tysiąc słów" mile widziane.


Tekst jest, niestety, krótszy niż pierwotna wersja, która napisałem 6 II. Niestety, przed zrobieniem kopii zapasowej wszedłem w posiadanie awarii prądu i ponad 2h pracy zmieniły się we wspomnienie.

Proszę o wyraźne zaznaczanie dodawanego tekstu oraz upewnienie się, że opcja "To jest drobna zmiana" jest odznaczona przed kliknięciem Zapisz (chyba, że ktoś poprawia jedynie literówki nie ingerując w samą treść).

A poza tym proszę ruszyć swe szanowne cztery litery i zapełniać portal treścią ;) . --Minio 14:06, 11 lut 2007 (CET)