Як редагувати статті
Матеріал з docs.linux.org.ua — збірника документації з Unix/Linux українською мовою.
Стаття незавершена! Можливо, назва статті не відповідає змісту
Зміст |
Як додавати статті
Важливо! Не додавайте матеріали, які є об'єктами авторського права без згоди авторів! Якщо автор дав дозвіл на використання його матеріалів, або якщо матеріали розповсюджуються без обмежень, не забудьте вказати джерело, звідки взято матеріал і дату. Це полегшить пошук і оновлення в майбутньому.
Якщо ви хочете створити нову статтю, наполегливо рекомендуємо таку послідовність дій -- спочатку створіть на якійсь з існуючих сторінок посилання на вашу майбутню статтю, перейдіть по цьому посиланню, вікі-двигун вкаже на те, що така сторінка не існує і дасть вам можливість її створити. Не забудьте також віднести вашу статтю до певних категорій. Дотримання саме такої послідовності дій гарантує, що нова стаття не потрапить до статей сиріт.
Коли ви переходите на статтю, якої ще не існує ви бачите сторінку з її назвою і написом "На даний момент текст в цієї статті відсутній". Щоб створити цю сторінку натисніть на кнопку "Редарувати", введіть текст вашої статті, і натисніть "Зберегти статтю". Все -- нова стаття створена. Якщо ви захочете подивитися проміжний варіант не зберігаючи статтю -- натисніть кнопку "Показати попередній варіант".
Якщо ваша стаття величенька, одразу варто подумати про те, щоб розбити її на частини. Тоді головна стаття буди мати посилання на кшталт [[Велика стаття]], а інші частини статті можна буде знайти за посиланнями типу [[Велика стаття/Якась частина]].
Докладніше про посилання а також про категорії дивись нижче.
Стиль написання статей
По формі
Зважайте на загальний стиль матеріалу. Погано, коли в межах однієї статті можна знайти цілу купу стилів -- це неабияк втомлює. Якщо вам цікаво, почитайте статтю на нашому ресурсі про те, як не слід писати статті.
В розмовній мові (і в спілкуванні на форумах) часто використовуються сленгові назви програм і систем (наприклад, лінух, кеди, копито). Але пам'ятайте, що перевага повинна надаватись стандартним написанням (читай: латинізованим, якщо саме такою є ця назва). Це полегшить пошук за ключовими словами і зробить матеріал більш професійним на вигляд.
Перевіряйте ваш переклад програмою перевірки правопису. В деяких переглядачах тенет є вбудована перевірка правопису -- не нехтуйте нею (словник для переглядача Mozilla Firefox можна встановити звідси). Якщо програма не знаходить вашого слова, не полінуйтесь знайти його в словниках, коли слова нема й там, то, швидше за все, воно є русизмом чи діалектизмом і його не варто вживати. Зазирніть на форум перекладів на linux.org.ua, корисні для перекладачів матеріали можна знайти на сайті української команди Mozilla. Зручно вживати електронні словники -- [1], [2], [3], [4], [5], [6]
Сухий текст втомлює читача, тому радимо використовувати вікі-синтаксис для оздоблення своїх матеріалів. Докладніше про те, як створювати вікі-форматування розповідається в наступному розділі.
За змістом
Використовуйте перехресні посилання. Наприклад, якщо у тексті зустрічаються стандартні команди, які мають на нашому ресурсі сторінку підручника -- зробіть на неї посилання, наприклад, так "gawk -f ucp.awk < mypage.cp > mypageU.cp". Для стандартних команд, а також для назв функцій в тексті використовуйте моноширинний шрифт (за допомогою тегів <tt> або <code>)
Для того, щоб читачу було легше знайти вашу статтю її краще віднести до якоїсь категорії. Докладніше про категорії буде далі, але якщо коротко, то кожна категорія має свою власну сторінку, на якій автоматично перераховуються всі статті, які належать до неї. Тут приведено повний список категорій. Щоб долучити вашу сторінку до певної категорії, додайте знизу сторінки таке [[Category:<назва категорії>]]. Одна сторінка може належати одночасно до декількох категорій.
Коротка довідка з вікі-форматування
Простий монотонний текст втомлює читача. Тому радимо використовувати різноманітне оздоблення тексту для підкреслення важливої інформації ті для полегшення усвідомлення змісту написаного. Нище приведена коротенька довідка з вікі-синтаксису, якої буде цілком достатньо для початку. Більш детально про можливості вікі-синтаксису можна дізнатися на відповідній сторінці Вікіпедії.
Базові можливості
Розділи
Перш за все важливо поділити статтю на розділи. Логічно розділена стаття легше читається, в ній також легше знайти потрібну інформацію, адже можна посилатися на окремий розділ. На початку статті буде відображатися її зміст у вигляді ієрархічного списку. Крім того вікі дозволяє редагувати кожний розділ окремо, що збереже трафік і ресурси нашого сервера.
| Так відображається | Вікі-текст |
|---|---|
|
Новий розділ Підрозділ Під-підрозділ |
== Новий розділ == === Підрозділ === ==== Під-підрозділ ==== |
Абзаци
Абзаци у вікі відділяються один від одного пустим рядком. Просто перехід на новий рядок не відображається -- його можна використовувати щоб, наприклад, розділяти речення в коді. Якщо ви хочете почати ковий рядок не починаючи нового абзацу, використовуйте html-тег <br>.
| Так відображається | Вікі-текст |
|---|---|
|
Це один абзац вікі-тексту, в якому зустрічаються переходи на новий рядок, але вони не впливають на вигляд чистового варіанту. А це другий абзац, відділений від першого пустим рядком. Крім того, в цьому абзаці ми використовуємо |
Це один абзац вікі-тексту, в якому зустрічаються переходи на новий рядок, але вони не впливають на вигляд чистового варіанту. А це другий абзац, відділений від першого пустим рядком. Крім того, в цьому абзаці ми використовуємо<br> примусовий перехід на новий рядок. |
Посилання
Фундаментальними для будь-якої інформації є посилання на інші джерела. Вони дозволяють вказати на більш докладне викладення певного питання, або на авторитетне джерело. Створювати посилання у своїх статтях досить просто.
| Wiki-код | Результат | Коментар |
|---|---|---|
http://www.google.com
| http://www.google.com [7] | Найпростіший варіант -- просто написати посилання. Єдина умова -- воно обов'язково має починатися з префікса протоколу (напр. http://) |
[http://www.w3c.com World Wide Web]
[http://www.google.com]
[http://www.linux.org.ua]
| World Wide Web | Таким чином можна створити посилання з певним текстом. Необхідний текст просто слідує за самим посиланням через пробіл. Якщо альтернативного тексту не вказати, то посилання просто буде пронумеровано. |
[[Головна стаття]]
| Головна стаття docs.linux.org.ua | Посилання на статті всередині нашої обгортаються у подвійні квадратні дужки, а необов'язковий альтернативний текст посилання відділяється від назми бажаної статті вертикальною рискою "|" а не пробілом. |
Шрифти
Для поліпшення сприйняття викладеного матеріалу -- для підкреслення важливих моментів у тексті а також для цитування джерельних текстів і команд прийнято користуватися різними стилями тексту (до-речі, між тегами <nowiki></nowiki> все вікі-форматування ігнорюється):
| Так відображається | Вікі-текст |
|---|---|
| Жирний шрифт | '''Жирний шрифт'''
|
| Похилий шрифт | ''Похилий шрифт''
|
| Жирний похилий шрифт | '''''Жирний похилий шрифт''''' (п'ять апострофів підряд)
|
| Верхнійіндекс | Верхній<sup>індекс</sup>
|
| Нижнійіндекс | Нижній<sub>індекс</sub>
|
| Підкреслений текст! | <u>Підкреслений текст!</u>
|
<strike>Викреслений текст!</strike>
| |
Моноширинний шрифт
Або такий моноширинний шрифт | <code>Моноширинний шрифт</code> Або такий моноширинний шрифт (рядок просто починається з пробілу) |
Списки
Дуже важливо представляти інформацію у структурованому вигляді. Робити це дозволяють списки декількох різновидів.
| Так відображається | Вікі-текст |
|---|---|
| * Створювати списки дуже просто:
** починайте рядок з <<зірочки>>
*** кількість зірочок означає рівень в
ієрархічному списку
|
| # Нумеровані списки ## зручні ## для організації даних |
| * Можна створювати змішані списки *# та вкладати їх *#* один в один |
| ; Список означень : означення ; елемент : означення елементу Увага: Один елемент на рядок, без символу нового рядка. |
Розширені можливості
Таблиці
Іноді зручно викласти інформацію у вигляді таблиці. Вікі дозволяє це зробити двома способами -- за допомогою вікі-синтаксису або за допомогою HTML. Нище викладені основні правила створення вікі-таблиць:
| Скорочення | Що воно означає |
|---|---|
{|, |}
| Початок таблиці. Після цього маркера можна (у тому-ж рядку) додати атрибути таблиці, наприклад, border або cellspacing
|
|+
| Так починається рядок, у якому зазначається назва таблиці (це не обов'язково) |
!
| Початок першої в рядку клітинки шапки |
!!
| Початок всіх інших клітинок шапки |
|-
| Початок нового рядка |
|
| Початок нової клітинки |
|}
| Кінець таблиці |
Проста заготовка для вікі-таблиці виглядає наступним чином.
| Так відображається | Вікі-текст | ||||||
|---|---|---|---|---|---|---|---|
|
{| border="1" cellspacing="0" cellpadding="5"
|+ Бухгалтерія
! Дебет !! Кредит
|-
| 10.15
| 20.50
|-
| 4.32
| 12.50
|}
|
Увага: Докладніце про таблиці у Вікіпедії можна дізнатися тут, на самій Вікіпедії
Спеціальні символи
Деякі необхідні символи відсутні на клавіатурі, а деякі вікі-двигун автоматично перетворює на щось. Вікі дозволяє використовувати HTML-сутностями (наприклад, < для того, щоб отримати символ '<'). Докладний список цих сутностей можна знайти тут, або на вікіпедії. Найголовніші символи перераховані тут.
| Так відображається | Вікі-текст |
|---|---|
| & | & -- сам амперсанд
|
| < і > | < і > -- знаки більше і менше
|
| « і » | « і » -- лапки
|
| — | — або просто -- (два дефіси) -- довге тире
|
| – | – -- коротке тире
|
| § | § -- знак параграфу
|
| − ± · ÷ | − ± · ÷ -- Математичні оператори
|
| ™ © ® | ™ © ® -- знаки авторського на промислового права
|
Виноски
Вікі дозволяє створювати виноски з автоматичною нумерацією або ж навіть довільним позначенням. Текст виноски може бути довільним вікі-текстом. Для значка виноски екрануються символи < та >, але не &, що дозволяє використовувати довільний символ. Виноски, що використовують нечислові значки, не впливають на нумерацію. Для того, щоб змінити хід нумерації, потрібно подати бажане число як значок -- нумерація продовжиться від цього числа.
Показати самі виноски можна тільки один раз. Перелік їх після показу очищується, після чого набирається новий перелік, проте нумерація продовжується як звичайно. Правила використання виносок зведені в наступну таблицю.
| Так відображається | Вікі-текст |
|---|---|
| Перша виноска<footnote>Ось приклад.</footnote> | Перша виноска<footnote>Ось приклад.</footnote>
|
| Друга виноска<footnote>Нумерація автоматична!</footnote> | Друга виноска<footnote>Нумерація автоматична!</footnote>
|
| Виноски можуть позначатися довільними значками<footnote>[*] Отак</footnote> | Виноски можуть позначатися довільними значками<footnote>[*] Отак</footnote>
|
| Але перед квадратною душкою не має бути пробілів<footnote> [*] Інакше вийде не те, що ви хотіли</footnote> | Але перед квадратною душкою <u>не має бути</u> пробілів<footnote> [*] Інакше вийде зовсім не те, що ви хотіли</footnote>
|
| Довільний символ виноски<footnote>[ℵ]Наприклад, такий.</footnote> | Довільний символ виноски<footnote>[ℵ]Наприклад, такий.</footnote>
|
| Сота виноска<footnote>[100] Ось приклад.</footnote> | Сота виноска<footnote>[100] Ось приклад.</footnote>
|
| Наступна виноска<footnote>Нумерація і тут автоматична!</footnote> | Наступна виноска<footnote>Нумерація і тут автоматична!</footnote>
|
| <listfootnotes>Необов'язковий текст вступу</listfootnotes> | <listfootnotes>Необов'язковий текст вступу</listfootnotes>
|
Інше
В тексті статей можна використовувати зображення. Детальна стаття про використання зображень і звуків є на вікіпедії. Основне правило при використанні зображень, звуків, і взагалі всіх матеріалів на цьому ресурсі -- суворе дотримання авторський прав. Не розміщуйте тут матеріали, які є об'єктами авторського права без згоди автора.
В текстах статей можна використовувати коментарі -- вони не відображаються в чистовому варіанті, але залишаються в тексті і можуть слугувати підказками або нагадуваннями. Коментарі пишуться в стилі HTML так <!-- Текст, якого не буде видно в чистовому варіанті -->.
Спеціально для автоматичного переносу підручника man у формат вікі було створено програму wiki2man.
Докладніше про категорії
Кожна категорія має власну сторінку, на котрій в алфавітному порядку перелічені всі статті, що до неї входять — своєрідний предметний покажчик. Процес сортування й показу статей автоматичний, отож, нам не треба турбуватись про те, чи з'явиться наша стаття у правильному місці. Також використання категорій звільняє нас від того, щоби вказувати назву статті у всіх переліках, де вона могла б з'явитись. І запобігає виникненню двох статей з однаковим вмістом, з різними назвами.
Використання категорій
Коли ви створюєте нову статтю треба забезпечити читача можливостями легко її знайти. Для цього статтю треба віднести до однієї або декількох категорій. Вибираєте із переліку категорій ті, до яких відноситься ваша стаття, додаєте в кінці посилання такого виду:
[[Category:Назва категорії]]
Зазвичай статті відносяться до двох категорій -- одна відповідно тематиці статті, друга відповідно її розміру. Будь ласка, зауважте, що назви категорій чутливі до регістру символів. На сторінках категорій цього сайту міститься код, котрий можна скопіювати та вставити на Вашу сторінку.
Після того, як Ви збережете сторінку, Ви зможете побачити внизу сторінки посилання на категорії, до яких стаття належить -- як у кінці цієї сторінки. При цьому місце розташування посилання значення не має. На сторінці категорії назва Вашої статті буде вже на своєму місці, коли Ви її поновите.
Більше нічого для повноцінного користування категоріями робити не потрібно. Хіба за таким винятком: назва статті може бути не тим, за чим Ви хотіли б її сортувати. Натомість, Ви б хотіли вказати інший ключ для сортування. Тоді Ваше посилання на категорію повинно виглядати так:
[[Category:категорія|ваш ключ]]
Як організовані категорії на нашому сайті
На нашому сайті вже є достатня кількість категорій, отже, створювати власні потреби немає (взагалі, категорія створюється, якщо ви на неї посилаєтесь). Як правило, Вам потрібно буде вказати категорію за тематикою. Якщо ваша стаття концентрується на певному дистрибутиві/ОС, вкажіть відповідні категорії. Окрім того, визначіться з тим, чим є Ваш матеріал -- статтею, оглядом, ЯКЦЕ, чи великим підручником, і вкажіть посилання також і на одну з категорій «за обсягом».
Якщо ви хочете внести нову сторінку підручника (man page), натомість вкажіть лише одне посилання -- на категорію, котра представляє розділ підручника. Їх опис і призначення міститься на цій сторінці. Посилання на головну категорію з'явиться автоматично.
Зауважте ще раз: самі сторінки категорій редагувати не потрібно!
Більше щодо категорій
- Офіційна документація з категорій англійською
- Перелік усіх категорій
- Сторінки, не занесені до жодної категорії
- Сторінки, на які нема жодного посилання
Як можна допомогти проекту
- про свої статті
- про вичитку
- про переклади
- про пропозиції
- про використання обговорень
