Редактиране на Fedora Project Wiki
Fedora Project Wiki има много ниски изисквания за регистриране на редактори. Въпреки това e необходим период от време за адаптация, когато ползвате wiki за пръв път, и затова ние имаме няколко ръководни принципа, които всички редактори трябва да следват. Тази страница осигурява тези указания, както и няколко полезни съвета. които да Ви помогнат да започнете.
Получете права за редакция
С цел да се предотврати злонамерени потребители да изтрият Fedora Project Wiki се наложи ограничаване на достъпа за редакция. За да получите такъв трябва да следвате няколко прости стъпки. Всеки би могъл да получи права за редакция.
1. Запознайте се с информацията на тази страница и на страниците, с основни указания, които трябва да се следват.
Неразбирането им води до допълнителна работа за останалите доброволци, и би могло да доведе до отнемане на правата за редактиране.
2. Създаване на профил. Това е първата стъпка за придобиване на права за редактиране. Посетете страницата (UserPreferences User Preferences) и си направете профил. Желателно е потребителското име да бъде Вашето истинско име приведено във WikiName формат. (Например ИмеФамилия, ИванИванов). Това е известно като 'CamelCase' или 'StudlyCaps' и е необходимо за създаването на wiki връзките.
.png){kind=small}
Изискваме използването на истински имена с цел идентификация и поемане на отговорност. Използването на правилния формат позволява да се създават точни wiki връзки и подпомага някои други фукнции, които използваме.
3. Попълнете Contributor License Agreement (Лицензионно Споразумение за Сътрудничесто) на страницата Fedora Account System . Подписването на CLA дава на Проектът Fedora възможността да лицензира вашите wiki статии под Open Publication License 1.0 без уговорка. Това гарантира, че вашият принос завинаги ще остане свободен и ще даде възможност на общността да го използва, променя и разпространява, точно както това става с дистрибуцията Fedora. Посетете нашата ["Legal"] секция за повече информация.
Следвайте инструкциите на адрес
Infrastructure/AccountSystem/CLAHowTo
4. Свържете се с някой от членовете на EditGroup (Група за редакция). Всеки в списъка на тази страница може да ви добави като член на EditGroup. Това е групата която има права за запис до по-голямата част на wiki. Ако вече сте контактували със някой от сътрудниците помолете го да Ви добави. Добре е, ако сте вече известен на някой, когато молите за достъп, но не е задължително. Ако нямате с кого да влезете в контакт, бихте могли да проверите и в IRC канала #fedora-websites на freenode . Ако и това не проработи добавете се в страницата EditGroupQueue page и изчакайте някой от EditGroup да Ви добави. Човекът, който направи това ще провери дали сте в cla_done групата на страницата за проверка на профил .
Ако се интересувате от поддръжката на websites, или желаета да сте част от Fedora Websites екипа, моля посетете Websites страницата.
Информация относно писането на Fedora документация посредством wiki е достъпно на адрес Писане на Wiki Документация.
Ръководни принципи
Има няколко прости положения, които трябва да следвате, когато правите промени по wiki. Казано накратко, бъдете учтиви и използвайте здрав разум. Неподчиняването на тези указания и причиняването на проблеми е добър начин правата Ви за редакция да бъдат анулирани. Ако имате въпроси, можете да ги задавате в IRC канала #fedora-websites на freenode .
Представете се
Преди да започнете да редактирате, която и да е страница приветливо се представете, като добавите информация за Вас на Вашата лична wiki страница. По време на регистрацията, автоматично получавате Ваша лична wiki страница, намираща се на адрес http://fedoraproject.org/wiki/<WikiИме>, където <WikiИме> се замества с името на Вашия wiki профил. За пример, посетете CategoryHomepage. Уверете се, че сте споменали поне Вашият email адрес. Webmaster-ите или други членове на общността може да имат нужда да контактуват с Вас относно страници, които редактирате. Има няколко начина да защитите Вашият email от недоброжелатели:
Вие трябва да прецените предимствата и недостастъците на всеки един от тях, и да изберете този, който Ви допада.
Винаги се абонирайте за страниците, които създавате или редактирате
Важно е да проследявате промените по страниците, които сте създали или редактирали, така че да можете да съгласувате работата с други, които работят по wiki съдържанието. Wiki редакторите обикновено добавят бележки по страниците за да си предават информация, като част от съвместната работа. Това помага лесно да се следят промените. Можете да намерите връзката за Абонамент в страничната лента когато влезете в системата
Бъдете предприемчиви
Бъдете предприемчиви, когато редактирате. Wiki промените се следят и могат да бъдат възстановени при необходимост. Това не означава, че трябва да бъдете безразсъдни, особено когато правите големи промени по ключови документи.
Отбягвайте ненужни промени на страници засягащи правни въпроси
Тези страници са написани с голямо старание и внимателен избор на думи. Когато променяте такива документи, най-добре е да помолите за рецензия преди да направите промяната. Можете да се свържете с Fedora Advisory Board (посетете ["Board"] страницата) за помощ.
Не осигуравяйте информация засягаща забранени теми
Не добавяйте каквато и да е информация, която нарушава закона. Помнете, че Проектът Fedora е юридическо лице в САЩ и се регулира от законите там. Отбягвайте връзки към или добавяне на информация относно собственически и несвободен софтуер, защитен от закона. Ако мислите, че имате право да направите това, отнесете го на вниманието на ["Websites"] team за обсъждане. Посетете ForbiddenItems страницата за примери на такива забранени съобщения, които да бъдат избягвани. Ако имате въпроси обърнете се към Websites team за дискусия. Ако е необходимо, ще вземат официално отношение.
Бъдете внимателни когато редактирате ключови ръководства или страници
Големи и важно ръководства като Packaging Guidelines , са в по-голямата си част работа на определен човек или група. Най-добре е да работите с тях, ако сметнете, че са необходими корекции. Важни страници, като FedoraMain или Download са, първото нещо, което повечето посетители виждат. Промени на подобни страници е необходимо да се оставят на опитни сътрудници. Ако смятате, че нещо по тези страници има нужда от промяна отнесете случая до Websites team за обсъждане.
Не променяйте страници в името на самата промяна
Ненужни редакции трябва да се избягват. Промяна на страница само за да добавите Вашето име в лога за редакция е неприемливо. Има множество страници, които имат грешки и им е небходима корекция. Вместо да се правят безмислени промени, като премахване на празно място, или промяна на връзки от fedoraproject.org на www.fedoraproject.org (първото е за предпочитане), опитайте се да намирате правописни, пунктуационни или граматически грешки, които могат да бъдат коригирани. Също така, когато правите такива малки промени маркирайте редакцията като "Незначителна промяна" като използвате съответното поле за отметка преди да я запазите.
Избягвайте да преименувате страници или да премествате съдържание без това да бъде съгласувано
Wiki страниците в повечето случаи сочат или са свързани с множество други. Важно е да съгласувате преименуване или преместване на страница и съдържание със съответните групи. Би било по-добре да се избягват такива промени, освен ако няма логично основание за това. Ако желаете да обсъдите преместването на някоя специфична тема или съобщение, то отнесете въпроса до Websites екипа.
Следвайте идеалите, на които Fedora е поддръжник
Например, опитвайте се да бъдете независими спрямо дадена десктоп среда, както и да се стремите да пишете общо разбираемо. Хората ползващи Fedora може да са нови в света на Linux и Fedora, и да им бъде трудно да разберат една технически написана статия. Освен това може да ползват GNOME, KDE, console, или друга среда. Опитайте се да се придържате към това, когато пишете инструкции. Уверете се и че Fedora отдадеността на отворения и свободен софтуер е представена правилно.
Подписвайте Вашите приложения
Когато прилагате файл към wiki страница, трябва да се подпишете с Вашият GPG ключ. Някои файлове формати, като RPM пакетите, поддържат GPG клочове, като в този случай не е небоходимо да правите отделен подпис с вашият ключ. Този в пакета е достатъчен. Подписът може да бъде прикачен към страницата заедно с файла прикачен в началото, или да бъде включен в страницата. GPG подписите позволяват на тези, които свалят вашият файл да удостоверят, че той идва от вас и не е модифициран или повреден. Това не нарушава вашата поверителност по какъвто и да е начин, а просто позволяват на другите да получат сигурност за произхода на тези файлове. Снимки и документи могат да бъдат публикувани и без подпис, но няма да навреди да ги добавите така или иначе за да удостоверите, че вие сте авторът. Ако нямате GPG ключ или искате да разберете повече посетете Cryptography.
Проверявайте за грешки
Ако не сте опитен автор, или пък знанията Ви по английски не са толкова добри, поканете някой да прегледа работата Ви. Добре написаните документи са важни за имиджа на Fedora. Дори и най-добрите автори не са застраховани от грешки. Отделете време да прегледате своите промени за да хванете някоя малка грешка.
Fedora е Общност
Когато пишете съдържание било за wiki или по принцип, помнете че Fedora е общност. Ние работим като Един, една обединена група, движеща се към общата цел. Ние нямаме нужда да разграничаваме една социална група или класа от друга. Например, нямаме нужда да разграничаваме сътрудниците на такива работещи за RedHat и на такива, които не работят там. Всички сътрудници са част от една Общност. Ще има случаи, в които класификацията, ще е необходимост, но когато е възможно това ще бъде избягвано.
Ако не сте сигурни за нещо, чувствайте се свободни да попитате
Членовете на общността ще се радват да помогнат. IRC каналът #fedora-websites на freenode е перфектното място да се обсъжда wiki или друга Fedora страница.
Наблюдавайте страници, които сте създали както и другите
Два елемента правят Wiki успешен инструмент за сътрудничество с цел отворено съдържание. Първо, имате възможност да наблюдавате съдържанието, за което носите отговорност, за да е сигурно че остава вярно и изпълнява своята мисия. Второ, имате възможност да наблюдавате останалото съдържание, неговото нарастване и развитие, и евентуалната нужда от помощ. Има няколко добри начина за наблюдение или абонамент за страница: 1. Добавете http://fedoraproject.org/wiki във вашият RSS reader. Би трябвало да намери и свали нужният файл. 2. Добавете регурялен израз за документ-а (ите), над които работите във вашите Предпочитания под Subscribed wiki pages. Например този израз следи следните документи:
Docs/Drafts/AdministrationGuide.* Docs/Draft/Glossary.* Docs/Drafts/DesktopUserGuide.*
Този израз наблюдава всички промени в областта draft :
Docs/Drafts.*
Този израз наблюдава за промени на страниците на DocsProject, включително ["Docs"] и ["Docs/Drafts"] :
Docs.*
Редактиране посредством MoinMoin
Online помощта може да бъде ценен ресурс при научаването как да се редактират wiki страници. При прегледа на тези помощни страници могат да се научат някои хитрости. Трябва да ги прегледате поне веднъж, а те ще бъдат там като бърза справка за редактиране на страници. Можете да задавате въпроси относно редакция в канала #fedora-websites на сървъра freenode.net .
Структуриране на Wiki Страница
Тази секция описва общата структура на една Wiki страница. Следвайте тези принципи при редакция на всяка Wiki страница. Има допълнителни правила използване за форматирането на Fedora документация, които са обхванати на страницата DocsProject/WritingUsingTheWiki; тези правила са необходими само ако се пишат страници за Fedora Documentation Project .
1. Заглавието на страницата се обгражда със знак за равенство =:
= Заглавие на страница =
{{Admon/note | Изключение | Страници, които ще бъдат винаги и само включени в друга страница посредством [[Inline()] -type macro не започва с header първо ниво. Структурата на тези страници е зависима от тяхната родителска страница.}}
2. Под = Заглавие на страница = и преди == Увод == секцията, включете макрос за съдържание:
= Заглавие на страница = [[Съдържание] == Увод ==
Не е нужно да включвате Съдържание ако страницата ще е малка и няма да има нужда от скролиране при четене в browser на височина 700 пиксела.
Идеята на таблицата Съдържание е да бъде по лесно за четене. Ако това е постижимо и без нея, то не е необходимо да се поставя
3. За ключовите раздели може да се използва anchor за по-прегледни връзки. Става с използването на скоби, по следният начин
{{Anchor|Име_на_раздел}}
== Име на раздел ==
4. Важни страници могат да бъдат класифицирани с поставянето на КатегорияFoo в долната част на страницата под хоризонтална линия. Заменете Foo с желаното име за Категорията, например Документи.
---- Категория Документи
Лесен начин за класификация на страници е да се избере, Добави тази страница към категория менюто, което се появява при редакция.
Страниците в Docs/Beats са само източник и не са включени в CategoryDocs страницата, защото не е предвидено да се показват като резулти при търсене на документация. Ако една страница е източник на съдържание и не е канонична или казано по друг начин URL, на което хората търсят тази информация, то не я включвайте в категория. Друг пример е което и да е съдържание в NameSpace.
5. More to Come
Бързи Полезни Съвети
Това са основни неща, които трябва да знаете за редактирането на това Wiki.
За повече информация плануваната документация, отидете на Writing Wiki Documentation.
Научаване чрез Пример
Един от най-добрите начини за научаване как да се редактира wiki е преглед на кода на вече съществуващи страници. Лесно е да се направи: 1. Намирате страница, чиито код бихте искали да видите. 2. В лентата за Навигация, намирате 'More Actions:' и я избирате. 3. Избирате опцията 'Show Raw Text'. Wiki ще ви покаже страницата като текст. Това е много ценно за научаването на някои трикове използвани от wiki редакторите преди вас. Тези трикове са ценни, позволяват ви да правите, уникални, интересни и мощни неща, които не сте мислили че са възможни. Можете да опитате това със страницата FedoraMain.
Връзки
Връзките са може би най-простото и същевременно най-хитрото нещо в MoinMoin. Най-простата форма на създаване на връзки включва wiki имена. Wiki имена са две или повече думи започваши с главна буква написани заедно. Когато използвате WikiИме не е нужно правите нещо друго. Връзката се създава автоматично. За да се предотврати създаването на връкза, когато не желаете такава трябва да прибегнете до хитрост. Най-простият начин е да сложите две между думите ето така: Wiki, което предотвратява автоматичното създаване на връзка. Ако искате да създадете връзка до подстраница или до страница, която не е Wiki име, може да използвате следният синтаксис Думи Подстраница на Проект или просто ["Име на страница"] . Избягвайте слагането на връзки към други сайтове и писането на описание в един и същ абзац. Напишете описанието, и сложете връзката към страница на следващия ред. Например:
Проверете Fedora Documentation Website за последна версия на документа, който сте започнали. [http://docs.fedoraproject.org/]
За повече информация, посетете HelpOnLinking.
Списъци
И номерирането и маркирането на списък са прости и удобни. Посетете HelpOnLists за повече информация как да ги използвате.
Таблици
Таблиците могат да бъдат много измамни, защото се държат не както се очаква от тях. Големите и широки таблици са проблематични, защото могат да излязат от определените им граници когато се гледат в по-малки прозорци в browser-a. Най-добрият съвет в тази връзка е да ползвате таблици, само когато е наистина небоходимо. Когато боравите с големи числа или малки записи, те могат да спестят доста място. Просто проверявайте старателно когато ги ползвате. Помнете, че другите могат да използват по-малки резолюции от Вашата. За повече информация посетете HelpOnTables.
Бележки, Съвети, и текст в Кутии
Общопознати като предупреждения. За да направите абзац съдържащ предупреждение напишете два вертикални черти (pipes |) в началото и в края, очертават текста, започнете с подходяща икона и включете информацията в отделен параграф:
{{Admon/tip | Това е пример за полезен съвет. | Тук е същинската информация за този съвет.}}
Тук е същинската информация за този съвет.
Разделете заглавния и втория параграф с space, за да се подравни коректно. Това са стандартни видове предупреждения:
Икона за въпрос 
Икона за полезен съвет 
Икона за Внимание 
Икона Важно 
Икона за предупреждение
За справка за други типове предупреждения Fedora Documentation Ръководство: http://fedora.redhat.com/participate/documentation-guide/s1-xml-admon.html
Отбелязване на Технически Изрази
Използвайте () за да маркирате имена на файлове, приложения, директории, пакети, потребителски профили, и други думи, които имат специално техническо значение. Това визуализира маркираните думи като monospace. Изволзвайте две единички кавички () за да маркирате имена на менюта и други елементи на графичния интерфейс. Това визуализира маркирания текст като italic.
#!html <div style="background: #eeeff1">
| Термин | Пише се като | Форматира се като | Пример |
| Имена на GUI приложения | bold face |
boldface | Firefox |
| Файлове, директории | |
monospace font |
/usr/bin/firefox
|
| Пакети | |
monospace font |
firefox-1.2.3
|
| Потребителски профили | |
monospace font |
username
|
| Други думи, които имат техническо значение | |
monospace font |
someJava.classname
|
| Част от конфигурационен файл, програмен код, и т.н.. | |
monospace font |
... Next, change the DefaultIcon setting in /etc/httpd/conf/httpd.conf to ...
|
| Менюта | two single-ticks |
italic | Applications > Internet > Firefox Web Browser |
| Други GUI или Web'UI interface element | two single-ticks |
italic | ... click the Submit button ... |
| Термини - абревиатури | two single-ticks |
italic | ... Firefox is an example of a graphical user interface or GUI. |
| Команди и daemons | |
monospace font |
grep httpd to find the PIDs of the running httpd processes.
|
| Клавиши | [Key] |
[bold brackets] | Press the [Enter] key ... |
#!html </div>
Например:
Пакетът <code>thunderbird</code> инсталира e-mail приложението '''Mozilla Thunderbird''' . За да стартирате '''Thunderbird''', изберете: ''Applications > Internet > Thunderbird Email''.
Което изглежда: Пакетът thunderbird инсталира e-mail приложението Mozilla Thunderbird . За да стартирате Thunderbird, изберете: Applications > Internet > Thunderbird Email.
Писане на примерни команди
Примерните команди са една или повече команди разделени от обясненияето им. Не използвайте prompt символи или съдържание, което показва име на машината, потребител, директория и т.н. Оградете всяка примерна команда в големи скоби, с три отварящи скоби в началото и три затварящи в края, както е показано на примера по-долу:
#!html
<pre>
{{{su -c "yum install awesome-application"
}}}
Enter the <code>root</code> password when prompted.
Което изглежда:
su -c "yum install awesome-application"
Enter the root password when prompted.
root Много команди изискват
root права. Читателят не би трябвало да е в системата като root, и затова трябва да упоменете изрично su -c или su - когато пояснявате такива команди.Ако командата изисква част, която да бъде в кавички то синтаксиса трябва да бъде " ", с единични кавички заобиколени от двойни. Например:
su -c "command -o 'Some Text' -file 'More text' foo/bar"
Опитайте сами
Опитайте новостите в Fedora Wiki Sandbox . Това е и добро място да видите някои примери.
Създаване на нови страници в Wiki
Wiki-то на Проекта Федора е голямо, и затова е необходима йерархия и организация. Най-добрият начин да научите за това е да прегледате SubPages и HelpOnCategories, както и съществуващият план за wiki. Повтарящи се имена (като /Foo/FooBar/FooBarGrue) трябва да се избягват. Включването на 'Fedora' е излишно. Същото се отнася и за 'Project' в името на страниците. Например, Fedora Websites Project е страница с 'Websites', а не 'FedoraWebsitesProject'. По-голямата част от страниците трябва да бъдат групирание като подстраници на проектите или програмите, чиято част са те. Категории се създават за различни проекти и програми, като това се прави умерено. Повечето от страниците, които създавате би трябвало да са част от Категория, както и да съдържат подходящ маркер. Ако мислите да създавате нова категория или маркер моля преди това попитайте за съвет ["Websites"] . Ако имате въпроси, чувствайте се свободнид да се обърнете към ["Websites"] team.
Важни Страници
Важни страници, като FedoraMain, трябва да се редактират умерено. Промени на такива страници трябва да бъдат обсъдени в пощенския списък или IRC преди да бъдат приложени. Специални страници, като RecentChanges, не трябва да се редактират. Някои части от wiki могат да имат различни права. Например, DocsProject има секция за създаване на нова документация, която е ограничена малко повече от останалата част на wiki. За да придобиете права за редакция на подобни страници, трябва да изълните някои допълнителни стъпки. MoinMoin има много вградени страници, които са важни за неговото нормално функциониране. Тези страници са маркирани и не се редактират. Промени по такива страница ще бъдат презаписани при update на MoinMoin софтуера.
Помощ
Ако имате въпроси относно редактирането на Fedora Project wiki, или ако се нуждаете от помощ, моля чувствайте се свободни да се свържете с ["Websites"] team. Те имат IRC канал и пощенски списък, като и двете са ефективен начин за да получите отговорите, от които се нуждаете. Ако мислиет да работите по редакцията на wiki, може би трябва да обмислите да се включите в ["Websites"] team.