Ця стаття подає загальні рекомендації щодо того, як писати переклади ?сторінок підручника й публікувати їх тут. Автори й перекладачі, що бажають зробити внесок у переклад сторінок підручника, повинні якнайретельніше дотримуватись цих рекомендацій; якщо ви бачите, що їх десь недотримано, будь ласка, не пишіть вебмайстрові, а спробуйте виправити цю недоладність самі — це, як правило, буде швидше, аніж писати листа, чекати, аж його прочитають, і лишень потім буде зроблено виправлення. Отже, зробивши навіть малий внесок, ви заощадите багато часу, й не лише свого.
Стиль і мова
Як правило, підходить усе, що й для інших типів технічної документації. Стиль варто використовувати такий, як ніби всі ці сторінки — частини довідника. Зокрема, заголовки розділів повинні називатись однотипно, й на це є не лише стилістичні причини.
Так склалося, що програми, котрі працюють із сторінками підручника, орієнтуються на те, що певні розділи мають знані їм назви. Зокрема, програма apropos чітко «знає», що кожна сторінка має розділ «НАЗВА» окресленого формату, й використовує той розділ для побудування своєї бази даних (точніше, вона знає, як це буде англійською). Можливо, будуть написані знаряддя для роботи з українськими сторінками підручника, тож варто полегшити роботу програмістам.
Зрештою, користувачі також звикли до такої однотипності, котра, втім, є хорошою рисою будь-якого довідника.
Наскільки вдало підібрані переклади для таких стандартних заголовків, вирішувати не мені, однак вони досить однозначні й повинні використовуватись на всіх сторінках. Якщо когось не влаштовує запропонований варіант перекладу, то перш ніж відмовлятись від нього, все ж заохочую подивитись на ті сторінки, де його вже застосовано, як також і на ті, котрі ще повинні будуть перекладатись. Якщо цей переклад буде вдалим для всіх сторінок, і запевне кращим, ніж існуючий, то можна його запропонувати. А втім, потім треба буде виправити абсолютно всі перекладені сторінки підручника... Причому чим швидше, тим краще.
| Англійською | Українською |
|---|---|
| Name | Назва |
| Synopsis | Використання (можна було б використовувати слово «Синопсис», проте воно більшості читачів незнайоме, та й «Використання» — це власне те, що такі розділи описують, і двозначностей чи відповідностей я ще не бачив) |
| Description | Опис |
| Author | Автор |
| Reporting Bugs | Зголошення помилок |
| Copyright | Авторські права |
| See Also | Дивіться також |
| Return Value | Повернене значення |
| Conforming To | Відповідність стандартам |
| Notes | Примітки |
| Files | Файли |
| Environment | Середовище |
| Example | Приклад |
Інші заголовки навряд чи можна назвати стандартними, тож їх перекладати можна на власний розсуд.
Посилання на інші сторінки
Згадки інших програм, функцій і тому подібних речей, про які також написано сторінки підручника, необхідно робити посиланнями. Правильне посилання виглядає так: ?Man:Man<розділ>/<сторінка>.<суфікс>. <Розділ> — це число, як правило, від 1 до 8. <Суфікс> найчастіше дорівнює розділові, хоч іноді може різнитись (наприклад, для програм віконної системи X цей суфікс буває не 1, а 1x). Приклад: ?Man:Man1/chmod.1.
Вишукане форматування
Намагайтесь уникати таблиць і власних стилів, якщо це тільки можливо. Зображень не подавайте зовсім. Однак можете повною мірою користати зі списків. Майте на увазі, що генерація сторінок підручника здійснюється автоматично програмою wiki2man.
Розміщення
Якщо ви вже знайомі з тим, як вікі організовує сторінки, то могли з вищеподаного прикладу здогадатись, як виглядає назва сторінки. Це завжди
Man:Man_розділ_/_назва_._суфікс_.
Так виглядає ваш системний каталог /usr/share/man. Тут варто дотримуватись такої самої схеми. Значення розділу, назви й суфіксу описано трохи вище.
Окрім цього, потрібно зробити одне перенаправлення: назва.суфікс, котре буде вказувати на сторінку підручника. Це слід робити для полегшення тим користувачам, котрі використовуватимуть сайт як заміну своєї команди man; вводити потрібно набагато менше.
Робити ще одне перенаправлення, котре не містить суфіксу, не потрібно.