Jump to content

Projekt:Pomoc policji

From mediawiki.org
This page is a translated version of the page Project:PD help and the translation is 100% complete.
Help pages are released without copyrights (as public domain)
Help pages are released without copyrights (as public domain)

Project:PD help is a project to create a set of concise user help pages for MediaWiki users, i.e. for visitors to a website which is powered by MediaWiki. The project covers all content in the Help namespace. The main entry point for this is Pomoc:Spis treści .

This help documentation is separate from the Manual (the GFDL and CC BY-SA-licensed MediaWiki administrator's manual). Contributors, please be clear about the differences! The PD help pages do not contain information for server administrators, about how to install, configure, or maintain MediaWiki software. See the 'Goal' section below, for a detailed statement of what we are trying to achieve.

Bezpieczeństwo Please do not copy and paste content from Meta-Wiki's Help pages in here. They were written under the GFDL and CC BY-SA licenses and are not in the public domain.

Cel

Celem jest dostarczenie zestawu stron, które można skopiować do nowej instalacji wiki lub włączyć do dystrybucji MediaWiki. W tym celu będą one zawierały podstawowe informacje użytkownika wraz z innymi informacjami Meta w racjonalnie zwięzłej formie. Podstawową koncepcją jest stworzenie skompresowanego "Podręcznika użytkownika", a nie pracy referencyjnej. Powinien skupiać się na tym, czego chcą użytkownicy, a nie wyjaśniać inne funkcje.

Licencja

Wkład w PD Help, jest udostępniany jako domena publiczna poprzez zrzeczenie się CC0. Jest to konieczne, aby użytkownicy mogli łatwo skopiować tekst do własnych instalacji wiki. Upewnij się, że rozumiesz następujące kwestie, zanim wniesiesz swój wkład:

  • Każda strona w pomocy policyjnej musi zawierać linię {{PD Help Page}} wskazującą licencję.
  • Żaden treść nie może być skopiowany z innych stron na te strony. Jedyne wyjątki:
  1. Zawartość kopiowana jest osobistą (np. autorem) lub masz udokumentowaną zgodę oryginalnego autora (oryginalnych autorów).
  2. Treści, które są już w Domenie publicznej, można skopiować tutaj; jednak NIE obejmuje to większość opublikowanych stron internetowych!
  • Odstawiasz się od wszystkich praw do informacji, które tutaj przekazujesz. Chociaż na tej stronie nadal będziesz mieć swoje wkłady wymienione i przypisane, inni mogą kopiować tekst bez podania kredytu i mogą go modyfikować, jak tylko uznają za stosowne.

Grupa docelowa: zwykli użytkownicy

Strony pomocy są bardzo ukierunkowane na zwykłych odwiedzających witrynę wiki.

Nie administratorzy serwerów

Nie zamierzamy kopiować pełnej dokumentacji MediaWiki. Informacje przeznaczone dla administratorów serwerów, szczegółowo opisujące instalację, konfigurację lub konserwację MediaWiki, należą do Instrukcji.

Jedynym małym wyjątkiem od tej reguły są pola 'Wskazówki dla administratorów' (opisane poniżej).

Informacje dla administratorów / biurokratów mniej widocznych

Strony pomocy nie byłyby kompletne bez opisania tego, co mogą zrobić użytkownicy 'sysop'. Jednakże, te zaawansowane funkcje nie są dostępne dla większości docelowej publiczności (większość użytkowników wiki). W związku z tym informacje te należy zachować nieznacznie oddzielone od większości treści, tak aby normalni użytkownicy nie mieli do czynienia z informacjami, które nie są dla nich istotne.

W większości Stron pomocy można uznać za konieczne krótkie wzmianki o działaniach, które wymagają uprawnień administratora; ale szczegółowe opisy procedur administratora powinny być schowane na mniej widocznych stronach lub powinny być całkowicie pominięte na stronach pomocy.

Ta sekcja jest w trakcie dyskusji

Przewodnik redagowania

  • Utwórz łącza między stronami, ale unikaj łączenia z innymi przestrzeniami nazw w MediaWiki.org. Zachowaj linki wewnętrzne do stron pomocy domeny publicznej lub twórz linki zewnętrzne (pełny adres URL) do odpowiednich zasobów, np. na meta.wikimedia.org. Ma to na celu ułatwienie kopiowania tekstu do nowych instalacji wiki. Nie używaj linków interwiki, ponieważ mogą one nie istnieć na docelowej wiki.
  • Prawdopodobnie nie chcemy nigdzie zamieniać składni {{SITENAME}}. MediaWiki to nazwa oprogramowania, które opisujemy. Jest to oprogramowanie do zarządzania treścią (CMS), które umożliwia działanie docelowej wiki, więc wszędzie tam, gdzie nasz tekst odnosi się do oprogramowania (wszędzie w pomocy), należy pozostawić dosłowny ciąg "MediaWiki". Jeśli z jakiegoś powodu tekst pomocy wspomina o nazwie witryny, to byłby to odpowiedni wyjątek (użyj {{SITENAME}}). Nie zamierzamy jednak zamieniać tego w każdym miejscu, w którym wspominamy słowo MediaWiki.
  • Tłumaczenia powinny być wykonywane po angielską wersję strony osiągnęła stabilny status. Konwencja nazewnictwa to Pagetitle/language-code (np. Pomoc:Edycja/pt).
  • Jeśli nie masz idealnego rozwiązania do nawigacji w tym podręczniku, powstrzymaj się od tworzenia szablonów nawigacyjnych i skup się najpierw na tworzeniu treści.
  • Nie używaj rozszerzeń, takich jak Cite, ponieważ nie są one instalowane we wszystkich instalacjach MediaWiki.

Formatowanie

  • Formatywanie powinno być spójne. Użyj class="wikitable" dla wszystkich tabel, które tworzysz, wyróżnij komórki lub wiersze z {{Hl1}} itp.
  • Wszystkie oznakowania i kody wiki powinny być umieszczone w tagie ‎<code> lub ‎<pre>. Pomoc w wstawieniu: {{subst:nw|text}}.
  • Wszystkie odniesienia do tekstów i opisów menu powinny być pisane kursywą.

Zrzuty ekranu

Zrzuty ekranu są przydatne. Strony pomocy PD powinny zawierać tylko zrzuty ekranu z domeny publicznej; Unikaj umieszczania logo na zrzutach ekranu i prześlij je na Commons z szablonami licencji {{MediaWiki screenshot}} (dla GPL) i $cc 0template (dla pracy użytkownika).

Obrazy są przesyłane z dokumentacją lub dostępne z Commons z InstantCommons .

Porady admina

Jeśli coś w Pomocy może być skonfigurowane przez administratora serwera, możesz wstawić 'poradę administratora' z {{Admin tip }}.

Kategoria

Wszystkie strony w przestrzeni nazw "Help:" są, według definicji, częścią projektu dokumentacji pomocy publicznej i powinny być zaklasyfikowane jako Kategoria:Pomoc . Strony pomocy dla rozszerzeń MediaWiki powinny być skategoryzowane w podkategorii Kategoria:Pomoc dla rozszerzeń .

Poprzednią kategorią dla stron w przestrzeni nazw "Help:", tym projekcie dokumentacji Pomocy w domenie publicznej, było Category:PD help. W zgodzie z prostotą kategoria jest teraz po prostu Kategoria:Pomoc i wszystkie strony zostały zaktualizowane.

Zobacz też

  • Project:Polityka językowa  — Jeśli jesteś zainteresowany pracą nad nieanglojęzycznymi wersjami stron pomocy.
  • Project:PD help/eksport  — Omówi propozycję metody tworzenia użytecznych miejsc do składania pomocy: przestrzeni nazw. Jest to jeszcze w fazie dyskusji i nie jest jeszcze funkcjonalne.