FluxboxPL.org:Konwencja w artykułach/Szkic

Z FluxboxPL.org

< FluxboxPL.org:Konwencja w artykułach
Wersja z dnia 16:17, 6 kwi 2008 autorstwa .azhag (dyskusja | edycje) (FluxboxPL.org:Konwencja w artykułach/Szkic przeniesiono do FluxboxPL.org:Konwencja w artykułach/Szkic: naprawa tytułów)
(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)
Skocz do: nawigacja, szukaj

Szkic konwencji


Konwencja ogólna

Prawa autorskie

Większość wpisów na portalu udostępnionych jest na licencji Creative Commons 2.5 by-nc, o czym informuje stopka.

Jeżeli tekst objęty jest inną licencją to załączona jest stosowna informacja.

Język

Poprawne pisanie

Portal ma w nazwie symbol "PL", a w tytule przymiotnik "polski", więc wszelkie treści musza być napisane w tym właśnie języku.

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

Język polski jest wystarczająco bogaty, by gros z wyrazów pochodzenia obcego zastąpić polskimi odpowiednikami.
Pomocne mogą być:

Pisownia wyrazów "Fluxbox" i "Linux"

Na temat odmiany rzeczowników zakończonych na literę X trwa spór językoznawców, my na potrzeby portalu i forum przyjęliśmy za formalnie obowiązującą wymianę końcówki -x na -ks w przypadkach innych niż mianownik liczby pojedynczej

M.   Linux      Fluxbox
D.   Linuksa    Fluxboksa
C.   Linuksowi  Fluxboksowi
B.   Linuksa    Fluxboksa
N.   Linuksem   Fluxboksem
Msc. Linuksie   Fluxboksie

Pisownia nazwy naszego menedżera okien jest niejasna, na stronie fluxbox.org znaleźć można pisownię fluxbox, Fluxbox, FluxBox. Za obowiązującą przyjęliśmy pisownię

Fluxbox

Emotikony

Uśmieszki w żaden sposób nie wzbogacają oficjalnego tekstu, dlatego zdecydowanie odradzamy używania we wpisach emotikon.

W komentarzu wyraźnie wydzielonym z właściwego tekstu możemy sobie ostatecznie pozwolić na emotkę, ale to też w umiarkowanych ilościach.

Inne uwagi

Fluxbox może działać nie tylko na systemach z jądrem Linux, część czytelników (a nawet jeden z administratorów) nie używa w ogóle GNU/Linuksa. Dlatego sugerujemy używanie słowa "system" zamiast "dystrybucja", które nie jest właściwym określeniem systemów opartych o inne jądra (chyba że masz na myśli konkretną dystrybucję GNU/Linuksa).

Tagi

Aby tekst był czytelniejszy używamy odpowiednich tagów.

  • ścieżki i nazwy plików otaczamy tagiem <tt></tt>, przykład: ~/.fluxbox/init
  • nazwy programów piszemy czcionką pogrubioną, przykład: gimp
  • listingi piszemy tekstem preformatowanym, przykład:
Mod1 F1 :Workspace 1
Mod1 F2 :Workspace 2
Mod1 F3 :Workspace 3
Mod1 F4 :Workspace 4
  • polecenia piszemy tekstem preformatowanym lub otaczamy tagiem <code></code>, przykłady: echo $USER
dpkg -l | grep fluxbox | awk '{print $2}'

Komunikaty

Czasami zachodzi potrzeba zakomunikowania czytelnikowi pewnej sprawy. Aby zachować spójność w podobnych komunikatach można skorzystać z szablonów.

Uwaga

Szablon Uwaga służy do ostrzeżenie czytelnika przed potencjalnym zagrożeniem związanym z poradą lub zwrócenie uwagi na inną ogólną sprawę związaną z tekstem.

Przykład użycia: {{Uwaga|Zastosowanie się do porad zawartych w tekście powoduje kernel panic}} daje w efekcie

Uwaga.png
Uwaga! Zastosowanie się do porad zawartych w tekście powoduje kernel panic


Różne systemy

Użyj tego szablonu, jeżeli chcesz powiadomić czytelnika, że podane w tekście ścieżki i nazwy plików konfiguracyjnych mogą się różnić w zależności od używanego systemu operacyjnego. (TODO)

Licencja

Ten szablon służy do powiadomienia czytelnika, że tekst z jakichś powodów objęty jest inną niż CC-by-nc licencją. (TODO)

Niepoprawna nazwa

Nazwy niektórych programów zaczynają się od małej litery, np. gentoo. Z powodu ograniczeń technicznych MediaWiki, pierwsza litera artykułu zawsze zostaje zamieniona na wielką. Możesz posłużyć się szablonem {{lowercase}} aby poinformować o tym czytelnika.

Można też podawać czytelnikowi zupełni inną nazwę, posługując się {{lowercase|jEdNa MaŁa, DrUgA DuŻa}}, co da:

Właściwy tytuł tego artykułu to jEdNa MaŁa, DrUgA DuŻa. Z powodu ograniczeń technicznych tytuł tego artykułu jest nieprawidłowy.


Nowe teksty

Nowe teksty powinny w pierwszej kolejności trafić do kategorii Tekstów do akceptacji, aby był czas na ewentualne przedyskutowanie artykułu, wyłapanie błędów i nieścisłości przed oficjalnym umieszczeniem ich we właściwej kategorii.
Tekst zostanie przeniesiony po około 3-4 dniach od ostatniej uwagi w Dyskusji danego tekstu. W przypadku Artykułów o subiektywnym charakterze czas ten może być krótszy.

Aby prawidłowo oznaczyć nowy, nie zaakceptowany jeszcze tekst należy w pierwszej linijce umieścić kod

{{do akceptacji}}

W pewnych przypadkach (np. przerzucenie rozwiązania wypracowanego na forum, przeniesienie tekstu z innej strony) można umieścić tekst od razu we właściwym miejscu. W takim wypadku zostaniesz o tym powiadomiony - nie rób tego na własną rękę.

Przykładowe tematy nowych tekstów możesz znaleźć na stronie FluxboxPL.org:Propozycje tekstów.

Brudnopis

Wszelkie eksperymenty możesz śmiało przeprowadzać w publicznym brudnopise. Należy jednak pamiętać, że tekst w publicznym brudnopisie może każdy edytować i nie zostanie on w nim na zawsze.

Jeżeli chcesz napisać jakiś tekst "na brudno" i mieć pewność, że nikt go przypadkiem nie skasuje lepiej użyj osobistego brudnopisu. Możesz w nim tworzyć podstrony, np. Użytkownik:Twój_login/Brudnopis/Artykuł_testowy.

Edycje i Dyskusje

Większość tekstów zamieszczonych na stronach FluxboxPL.org objętych jest licencją Creative Commons 2.5 by-nc, a sam portal wykorzystuje silnik MediaWiki. W związku z tym każda zalogowana osoba może je edytować. Jednak niektóre osoby mogą sobie nie życzyć cudzej ingerencji w ich tekst. Dlatego bardzo prosimy, aby nie dokonywać samodzielnie większych zmian w cudzych tekstach (zwłaszcza w Artykułach, w których często autorzy zamieszczają osobiste, subiektywne zdanie), tylko przekazywać uwagi ich autorom.

Służy do tego strona Dyskusji danego artykuły - jeżeli chcesz zwrócić uwagę na błąd, niedomówienie, zamieścić jakiś komentarz - możesz to śmiało zrobić właśnie w tym miejscu. Nie trzeba być zalogowanym aby edytować strony Dyskusji.

Jeżeli zauważysz w tekście drobny błąd - literówkę, błąd ortograficzny, brak kropki czy przecinka - nie krępuj się i popraw go od razu.

Wszelkie objawy wandalizmu będą piętnowane, a ich autory karani (w skrajnych przypadkach przez odcięcie możliwości edycji stron).

Podpis

Teksty z kategorii Artykuły (jako osobistą wypowiedź) autorzy powinni zawsze podpisać, aby oddzielić podpis od tekstu dobrze jest zastosować poziomą linię (----).

Autorzy howto lub prezentacji programu mają prawo podpisać swoją pracę. Osobom modyfikującym gotowe prace to prawo nie przysługuje.

Jeżeli tekst na FluxboxPL.org przeniesiony jest z innego serwisu to można (a w pewnych przypadkach wręcz trzeba) w podpisie zawrzeć informację gdzie tekst pierwotnie był opublikowany.

Konwencja w Howto

Howto 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 tym dziale 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.

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


Przykładowa konstrukcja tekstu

Sugerujemy, aby w tekście ujęte były następujące zagadnienia:

  • krótkie przedstawienie problemu
  • wyjaśnienie co może powodować ów problem
  • przedstawienie rozwiązania (kilku sposobów, jeśli istnieją) wraz z wyjaśnieniem co właśnie zrobiliśmy
  • linki do tekstów omawiających podobne zagadnienie

Pamiętaj, że nie jest to ścisły dogmat, a jedynie propozycja - jeżeli Twój tekst będzie zbudowany w inny sposób nie znaczy bynajmniej, że zostanie przez nas odrzucony.

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, niezależne od bibliotek GNOME-a czy KDE, jednak nic nie stoi na przeszkodzie, by zaprezentować np. File Rollera, jeżeli ktoś ma ochotę.

Przykładowa konstrukcja tekstu

W prezentacji dobrze jest zawrzeć:

  • przedstawienie, jaki jest główny cel programu (archiwizer, odtwarzacz plików multimedialnych, czytnik RSS, etc.)
  • jak zbudowany jest interfejs lub interfejsy (ncurses, GTK 1/2, QT, www, wiersz poleceń, etc.)
  • wypunktowanie ciekawych/przydatnych funkcji programu
  • zależności programu
  • przykładowe obrazy prezentujące program
  • krótka instrukcja obsługi, jeśli program jest nietypowy w użyciu
  • link do strony domowej oraz innych stron opisujących

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

Oczywiście nie są to ścisłe nakazy, a jedynie propozycja. Konstrukcja Twojego tekstu zależy wyłącznie od Ciebie.

Konwencja w Artykułach

Dział ten przeznaczony jest na nieco luźniejsze teksty, obejmujące szerszą tematykę niż jeden konkretny problem.

Przykładowy tekst jaki może być zamieszczony w Artykułach to np. opis krok po kroku jak zainstalować i doprowadzić do stanu używalności Fluxboksa, dogłębne opisanie tego menedżera okien, etc.

Teksty opublikowane w Artykułach mogą zawierać opinie - nawet niepochlebne - autora. Należy jednak pamiętać, że są to opinie tylko i wyłącznie autora i musi on podjąć konsekwencje swoich słów. Między innymi z tego powodu zaleca się unikanie niekonstruktywnej krytyki.

Dział ten jest zdecydowanie luźniejszy niż pozostałe, teksty zamieszczone w nim nie muszą mieć zbliżonej konstrukcji. Jak będzie zbudowany tekst w tym dziale zależy wyłącznie od jego autora.

Konwencja na Stronie głównej

Na Stronie głównej znajduje się krótki opis Fluxboksa oraz krótkie wiadomości, przede wszystkim aktualności ze świata Fluxboksa i naszego portalu, a także ważniejsze wiadomości ze świata FLOSS.

Propozycję wiadomości możesz podesłać któremuś z adminów portalu (najlepiej azhagowi) przez e-mail, priva na forum, na stronie dyskusji Strony głównej lub w jakikolwiek inny sposób.

Strona ta została zablokowana przed edycję przez zwykłego użytkownika, jeżeli masz jakieś uwagi zamieść je na stronie Dyskusji.

Konstrukcja wiadomości

Wiadmości zbudowane są na szablonie zgodnie z klasyczną konstrukcją informacji:

  • Lid - pierwszy akapit, będący wstępem do wiadomości, mający w skrócie przekazać o czym jest cała wiadomość (tak aby czytelnik po przeczytaniu tylko lidu był w stanie mniej-więcej wiedzieć co chcieliśmy przekazać w newsie)
  • Body - treść wiadomości
  • Puenta (opcjonalnie) - ostatni akapit zawierający uzupełnienie wiadomości (bez którego jednak informacja nadal byłaby pełna), jakiś krótki komentarz, "smaczek", etc.

Konstrukcja tekstu wiadomości powinna kolejno odpowiadać na pytania "kto? co? gdzie? kiedy? dlaczego? w jakim celu? z jakimi skutkami".

Proporcje wiadomości powinny z grubsza odpowiadać poniższemu schematowi:

______________________________
\                            /
 \           Lid            /
  \________________________/
   \                      /
    \                    /
     \       Body       /
      \                /
       \              /
        \____________/
          __________ 
          \        /
           \Puenta/
            \    /
             \  /
              \/
Narzędzia osobiste