利用者:Acekacinski/PL/Main Page/Meta:PL/Guides/Writer Guide

    テンプレート:Meta:Guides/index

Witamy

Edycja stron "Podręcznika Blendera" jest bardzo prosta. Wystarczy stworzyć konto na wiki Blender i następnie:

• Naciśnij przycisk "Edytuj" który jest w nagłówku na górze strony.
• Wprowadź zmiany w tekście (jeśli nie bardzo orientujesz się w edycji stron tutaj znajdziesz pomoc.
• Naciśnij przycisk "Zapisz" (z dołu strony)

Aby tworzyć bardziej skomplikowane strony (tzn. uzupełnianie opisów nowych funkcji Blendera, tworzenie brakujących stron, itd...), proszę zapoznać się z zasadami edycji stron na tej Wiki (linki na górze strony).

Wprowadzenie

Dokument ten ma na celu pomóc w edycji, szczególnie dla nowych autorów i pozwoli na wprowadzanie poprawek i nowych tekstów do Podręcznika Użytkownika Blendera jak szybko i efektywnie, jak to możliwe.

Wszystkich użytkowników Blendera zapraszamy do pomocy w tworzeniu instrukcji obsługi Blendera. Podręcznik użytkownika jest duży (21 rozdziałów i ponad 600 stron) i wymaga stałej konserwacji. Użytkownicy mogą pomóc na dwa sposoby:

• powiadamiając administratora o jakichkolwiek problemach;
• poprzez aktualizację strony, aby likwidować problemy.

Jak w przypadku innych części dokumentacji Blendera, podręcznik został napisany i utrzymywany jako dokument Wikimedia. Każda nowa wersja Blendera (2,49, 2,5, 2,6 itd.) ma swoją własną wersję instrukcji.

Kontakt

Fundacja blendera wyznacza administratorów stron podręcznika którzy są odpowiedzialni za jego twożenie. W razie problemów można do nich napisać email z pytaniem.

Ponadto istnieje szersze grono społeczności Blendera zainteresowane tworzeniem instrukcji obsługi. Kontakt z nimi jest możliwy na dwa spsoby:

• Lista mailingowa: bf-docboard Jej główne zadania to dystrybucja dokumentów, omawianie pomysłów i śledzenie postępów.(Wymagana rejestracja).
• Kanał IRC: #blenderwiki na irc.freenode.net. Spotkania, nieformalne dyskusje, itp. Zobacz "Chat" w celu uzyskania dalszych informacji na temat korzystania z IRC.

Wskazówki edycyjne

Głównym celem wiki jest zapewnienie, że zawartość każdej strony daje użytkownikowi jasny, zwięzły i aktualny opis funkcji Blender w aktualnej wersji. Ponadto strony powinny odpowiadać kontekstowi instrukcji obsługi (patrz poniżej), dzięki czemu możemy zachować jednolity układ stron.

Uprawnienia do edycji

Nie musisz poprosić o prawa do edycji, ponieważ używamy systemu Captcha w celu sprawdzenia czy zmiany dokonano przez ludzi, a nie "boty".

Wystarczy utworzyć konto mediaWikii odpowiedzieć na e-mail z potwierdzeniem, aby uzyskać prawo do edycji stron wiki.

Mediawiki edycja i inne funkcje

Zmiany są dokonywane z wykorzystaniem funkcji edycyjnych MediaWiki. Ponadto system wiki zawiera szereg udogodnień dla nawigacji, dyskusji, śledzenia i oglądanie zmian na stronach oraz innych bardziej zaawansowanych funkcji.

Stronapomocy podaje szczegóły i instrukcje dotyczące funkcji edycyjnych MediaWiki.

Style, szablony i tłumaczenia

• Postępuj zgodnie z określonym stylem.
• Korzystaj z szablonów aby uzyskać informacje dotyczące szczegółów edycji wiki , ułatwień itp.
• Jeśli chcesz tłumaczyć dokumentację przecytaj "zasady tłumaczenia".

Pisownia i gramatyka

• Jeśli to możliwe proszę używać amerykańskich zasad pisowni i gramatyki podczas edycji i tworzenia treści wiki. Na przykład "color" a nie "colour", "organization" a nie "organisation".
• Dla API, skryptów i innych treści języka programowania, należy również przestrzegać zasady pisowni amerykańskiej które są bardziej praktyczne.

Biblioteka ikon

• To jest dobry pomysł, aby wstawiać przyciski i ikony przy opisywaniu działań dla użytkowników. Zobacz"Biblioteka ikon".

Struktura dokumentacji

Strony podręcznika są przedstawione w formie sórki Naiad, która ma trzy panele:

• Nawigacja (nazwa stron i struktura)
• zawartość strony
• struktura strony (tytuł/podtytuł).
  • [Tylko jedna lub dwie z tych kolumn może pojawić się na ekranach o niskiej rozdzielczości]

Zawartość kolumny nawigacji nie można zmienić. Nazwa strony i struktura dla bieżącej wersji podręcznika użytkownika Blender były przedmiotem dyskusji i kompromisu między administratorami dokumentacji i społecznoścą Blendera. Wszelkie zmiany mają wielki wpływ na strukturę dokumentacji,kategoryzację silnika wyszukiwania itd.; zobacz struktura dokumentu wiki. Więc prosimy:

• Dokonywać aktualizację (edytuj, koryguj i poprawiaj) treści istniejących stron;
• Nie aktualizuj tytułów stron
• NIE aktualizuj strony nazw plików.

Jeśli chcesz zaproponować zmiany w strukturze dla przyszłych wersji, prosimy o kontakt:Administratorem koordynującym.

Updating Pages

Setting up to become a User Manual writer is simple. Just

• register on bf-docboard
• open a mediaWiki account (See Login/Create Account, top right corner of screen)

Then minor edits (grammar, corrections to comply with style guide) can be made directly by editing the wiki Manual page.

For major page edits, you can choose your method according to your confidence and experience.

EITHER:

• Go ahead and make your changes in the wiki Manual page. BUT ALSO, once you are satisfied with your corrections, please
  • email bf-docboard with subject "Re: Page Update" giving the category and filename(s) you have modified, so we can communicate if there are any issues with your changes.
  • add a brief note on the Discussion for the page saying what (and, if appropriate, why) you made the changes. Add a Signature and date to your discussion note.

OR

• Use your User Space to get a Review of your proposed changes before altering the real wiki Manual page. This can be done as follows (assuming the name you have chosen is XXXX):
  • Go to your user page and open edit mode (e.g. http://wiki.blender.org/index.php/User:XXXX)
  • Make a link to a new page with the appropriate address and save, e.g. Window types to correspond with http://wiki.blender.org/index.php/Doc:2.6/Manual/Interface/Window_types
  • The new link will display in red as there's nothing in the new page yet
  • Click the red link to open up edit mode for the new page
  • Open a new browser tab, open the wiki manual page that you want to fix, then go into edit mode
  • Copy and paste from the wiki manual page to the corresponding version on your user page and save your user page version
  • Add an InProgress template to the wiki page (so that people know someone is working on it) and save it
  • Now you can edit your user-page file to make your proposed changes.
  • When you're finished, email bf-docboard with subject "Re: Review Request" for a review by a more experienced writer (eg. an Admin Board member). They will work with you to polish the page if required, then help you to move it to replace the original wiki manual.
  • add a brief note on the Discussion for the page saying what (and, if appropriate, why) you made the changes. Add a Signature and date to your discussion note.

You may like to add the page to your Watchlist, and watch it, so that you follow any future changes to your edits.

Please note that, if your changes are not considered by the Board to improve the page, they may revert your changes. The Admin Board Coordinator has final decision on all matters of Blender Manual content.

Page Content Guide

The content of the Manual page describing a Blender facility (text, images, links, etc) should give sufficient detail of the current version of the facility to enable a new user to make full and effective use of the facility.

Titles, Sections and Headings

Titles, headings and sub-headings are enclosed using strings of = characters. The Page Structure panel of the page automatically updated to the the structure and headings in the current page.

In addition, formatting such as bold/italic fonts, indented lists, bulleted lists etc. can be otained in the same way using strings of * and other characters (you can see these used by 'edit' on this page). See Help:Formatting for a complete description of the range of formatting options available.

Please note (again): do NOT change with main title of your page without very good reason (and consultation with the Admin Coordinator).

Page Text

The text should describe the feature as fiully and succinctly as possible.

Check that the text gives a full description of:

• the purpose of the facility
• all the user controls (buttons, lists, check-boxes, etc)
• any special information required to use the facility.

Links

Links to another page in the wiki (internal links) are obtained by strings of the form

[[Main Page|different text]]

For other links, see Help:Links for a detailed explanation of the range of facilities available.

Images

Images can be used in a page by adding

[[File:example.jpg|caption]]"

in your text. See Help:Images for full details of the wiki image facilities, the range of file-types that can be used, and advice on image sizing.

The upload process is started using the menu from the Wiki button (Bottom RH corner of screen). Image files are entered into a date-ordered list, and are held with various information items such as upload date, author name, and caption.

Headers and Footers

In the first line of a page, put this

{{Page/Header|<blender version>|<previous page>|<next page>}}

In the last line of a page, put this

{{Page/Footer|<blender version>|<previous page>|<next page>}}

<previous page> and <next page> being valid links to proper pages.

The user can then use the following clickable Icons:

• Left arrow: previous page (shows red if page doesn't exist)
• Right arrow: next page (shows red if page doesn't exist)
• Up arrow: up one level in pages hierarchy

Categories

Categories provide global automatic indexes that are useful as tables of contents. A list of the Categories in use in Doc2.6/Manual is given in the wiki Special Page "Categories" (See list for "Wiki" button at bottom RH corner of screen). Please ensure that your page includes a statement of the form

[[Category: <yourCategory>]]

Examples of Good and Bad Wiki Style

We are starting a collection of pages with good style representative of the variety of approaches and templages that are favored and bad pages representative of the main style faux pas to avoid.