Tkabber Wiki

Tkabber Wiki:Довідка
Login

Tkabber Wiki:Довідка

Ця сторінка призначена для тих, хто побажав взяти участь у проекті Tkabber Wiki як автор статей або перекладач. Головне призначення нижченаведеного — визначити стиль оформлення, для того щоб усі статті на вигляд були схожими, не занадто майоріли жирним і похилим шрифтом і були ясними для розуміння. (Прохання врахувати, що в даний момент не все на вікі оформлено відповідно до цих правил, але виправлення ведуться, і зрештою все буде наведено до єдиного стилю.)

Якщо у вас є якісь пропозиції по оформленню, будь ласка, зв'яжіться або з bigote, або з kostix, або з lknight.

Для обговорення робіт на вікі створена окрема конференція xmpp:tkabber-wiki@confernce.jabber.ru. Вхід на неї — за запрошенням, тобто вам спочатку треба виловити кого-небудь із нас.

Отже, почнемо.

Зміст

Якщо ви не працювали з вікі раніше

Тепер про оформлення

У перших рядках просимо пам'ятати, що структура вікі може мінятися (у тому числі і вами), але робити це потрібно дуже обережно, попередньо обговоривши зміни з адміністраторами проекту (див. посилання вище). Якщо в статті, що ви хочете пересунути, є "двійники" на інших мовах, то ж саме треба зробити й з ними. Тому ми й просимо повідомляти про бажані зміни.

Для авторів нових статей

Перед тим як писати нову статтю, подивіться, чи немає вже іншої статті, що більш-менш повно розкриває цю тему. Якщо така стаття є, можливо, вам варто просто доповнити її. Якщо ж це не так, то для початку треба визначитися, у який розділ помістити посилання на неї, і... зробити це посилання :) А потім можна вже приступати до написання. Не пошкодуйте п'яти хвилин і ознайомтеся із правилами оформлення статей. Може виявитися корисним і перегляд вихідного коду (по команді "правити" у верхньому меню) якої-небудь існуючої статті, де є елементи, які ви збираєтеся використати у своїй статті. І звичайно, ми не хочемо заганяти всіх у тверді рамки — зрештою, зміст важливіше форми. Оформлення статті — справа смаку автора, але намагайтеся зрозуміти й читачів — адже це їм буде важко розбиратися в каші зі стилів, якщо автор про це не подбає. Не забувайте, що перед збереженням сторінки її можна попередньо переглянути (є кнопка "Попередній перегляд"). До того ж, намагайтеся писати без помилок ;)

Тепер про стилі.

Застосування відбою пробілом

Один з убудованих стилів розмітки вікі — відбій пробілом, тобто рядок, що виділяється, починається із пробілу. У результаті застосування цього стилю виділений текст міститься в гарну рамочку з рожевим тлом. У нас цей стиль буде застосовуватися для:

Намагайтеся побудувати речення так, щоб виділення не розривало його або, принаймні, мало пристойний вигляд.

Застосування HTML

Основні стилі розмітки вже вбудовані у вікі, тому особою потреби у використанні тегів HTML немає. Більш того: зловживання ними забруднює вихідний текст статей, робить переклад і виправлення важкими. Проте, у деяких випадках застосування HTML цілком виправдане. Приклад — це от довге тире, що і повинно використатися замість популярного нині дефіса -. Ще один приклад — стрілки → і ←, кутові дужки < і >, значок акценту &#769;, що ставиться слідом за буквою, над якою хочемо поставити наголос.

Якщо вам потрібно оформити відсутність шматка коду в прикладі, використайте спеціальний символ &middot; — "·" Наприклад:

proc a b {
    puts ouch!

    · · · · ·

    puts text
}

При використанні посилань, розділові знаки, "дотичні" останнього слова в посиланні, виключаються з її тіла. Приклад: У випадку сумнівів не забувайте про попередній перегляд і про '''[[Sandbox]].''' → У випадку сумнівів не забувайте про попередній перегляд і про пісочниця.

Застосування тега <tt>

Застосування жирного шрифту

У цієї вікі жирний шрифт використається для:

Застосування похилого шрифту

Похилий шрифт в нашій вікі застосовується для виділення досить довгих шматків тексту в загальному оповіданні (одне речення або частина складносурядного або складнопідрядного речення як мінімум), тобто у випадках, коли жирний шрифт занадто звертає на себе увагу. У цьому випадку знаки пунктуації, що завершують виділений текст, включаються у виділення. Якщо вам знадобилося акцентувати яке-небудь слово в похилому тексті, припустимо скористатися для цього жирним шрифтом. При цьому знаки пунктуації, що впритул прилягають до жирного слова, до виділення жирним включаються, якщо це звичайне слово, і виключається, якщо це шматок коду або шлях до файлу: ~/.tkabber/config.tcl. (Розумію, що на словах це виглядає заплутано — переглянете код цієї сторінки, і ви все зрозумієте. Або ж просто придивитеся до фінальної крапки попереднього речення — вона звичайна :)) Намагайтеся не зловживати змішанням стилів або близьким сусідством жирного й похилого тексту.

Якщо вам потрібно виділити курсивом цілий абзац або кілька реченнь, краще скористатися тегом <cite>.

Вживання смайликів у тексті

Якщо вам подобаються смайлики, користуйтеся на здоров'я, але, як кажуть, без шаленості ;) Тобто, намагайтеся звести їхнє вживання до мінімуму. Що ж робити з розділовими знаками наприкінці речення, після якого вставляється смайлик? Нам здається, що смайлик цілком замінює крапку ;) Після розділового знака він якось не дуже добре виглядає. Всередині речення вживати з обережністю, краще розділити речення на два більш простих, як тільки що продемонстровано (...заміняє крапку, тому що після розділового знака...). Але, взагалі, пам’ятайте, що гарний жарт повинен бути жартом і без смайликів :-)))))

Інші елементи оформлення

  1. Нумеровані списки, теж можуть стати в нагоді (зверніть увагу, вони можуть бути й вкладеними, як зараз).

Докладніше про їх читайте в статті про розмітку Вікіпедії.

Якщо потрібно поставити наголос над голосною в українському слові, не використовуйте "ерзац-наголоси" — акцентовані західноєвропейські голосні (повторюся, мова не йде про "законні" випадки, коли вживається іноземне слово). Для знака наголосу в Unicode існує спеціальний символ U+0301. У коді HTML він записується як &#769; і ставиться після "наголошеної" голосної: Тка&#769;ббер → Тка́ббер. Дуже докладно про різні символи, які можуть стати в пригоді при оформленні статей, написано у Вікіпедії.

Якщо вам потрібно вставити "підпис", наприклад, як автора патча, уведіть у будь-якому місці рядка:

Не обмежуйте себе тільки тими способами форматування тексту, що зазначено тут. На сторінці розмітки Вікіпедії можна знайти цілу безліч інших, і якщо щось підходить для вашої статті — хоробро додавайте цей прийом сюди. Однак рекомендуємо не зловживати різноманітними стилями. Намагайтеся триматися золотої середини й застосовувати виділення лише там, де без нього не обійтися.

Пісочниця

Побавитися з розміткою можна у пісочниці.

Перекладачам

Що треба робити при перекладі на нову мову з нуля

  1. Якщо вашої мови немає у списку, звертайтеся до самого головного адміну вікі LKnight або, якщо він не виловлюється, до Bigote. Bigote новий субдомен сам зробити не може, але може спробувати виловити LKnight'а ;) Крім того, потрібно буде допомогти адміністраторам проекту відредагувати навігаційне меню нової вікі, а також поставити посилання на свою вікі на Самій Головній Сторінці і підправити і її навігаційне меню.
  2. Субдомен створений. Зареєструйтеся у знов створеній версії вікі, а також на інших версіях (тому що інакше ви не одержите доступу до коду статей-джерел, і, крім того, вам треба буде додавати посилання на ваші статті в усі іншомовні версії).
  3. З якої статті найкраще почати переклад? Звичайно ж, із цієї от самої довідки! Так ви й самі розберетеся зі стилем оформлення статей, і іншим авторам, що говорять мовою призначення, допоможете.
  4. Набирайте в браузері http://код_вашого_мови.tkabber.jabe.ru, і вашому погляду відкриється заголовна сторінка нової версії вікі (порожня, природно). У лівій частині сторінки, під логотипом, розташоване навігаційне меню. Тисніть там на посилання, що веде на локальну сторінку допомоги. В окремому вікні або табі браузера відкрийте оригінальну статтю Допомоги, з якої ви робите переклад, відкрийте обидві на редагування й скопіюйте вихідний код статті-джерела в порожнє вікно редагування вашої статті. Збережете вашу статтю й натисніть "Скасувати" у статті-джерелі. Потім знову відкрийте на редагування вашу статтю, і можете перекладати.
  5. Пам’ятайте, що тепер треба забезпечити перехресні посилання на інші мовні версії цієї статті. Для цього, в якому-небудь місці коду вашої статті (найкраще на самому початку) додайте рядок такого виду: [[en:Main Page]], де префікс "en" означає мова іншої версії, а "Main Page" — це її назва на цій мові. Двокрапка, що йде між префіксом і назвою статті, пробілами не відділяється, а пишеться разом і із префіксом, і з першим словом назви. Зберігайте статтю, і тепер ви побачите в нижній частині навігаційного меню новий розділ: посилання на іншомовні версії даної статті. Необхідно додати стільки посилань, скільки є інших версій статті. Звичайно, необхідно також відредагувати також всі ці версії, таким чином, щоб в них теж були посилання на новий переклад.
  6. Які ще статті мають пріоритет? Наступною за важливістю є, звичайно, Головна сторінка — та, що з'являється, коли ви просто набираєте в адресному рядку "голу" адресу вікі. За нею йде стаття Ткаббер ЧЗП — колекція відповідей на найпоширеніші питання, які можуть допомогти багатьом читачам нової версії вікі. Потім ми рекомендуємо перевести статті, на які є посилання із ЧЗП, і якщо є подальші відсилання — то і їх теж. Ну а далі вибір за вами :) Не забудьте, що на вікі є спеціальна службова стаття Всі сторінки, де ви можете оглянути поглядом майбутній фронт робіт і бути в курсі, що ще чекає своєї черги на переклад.
  7. Декілька порад по перекладу таких понять як [[Учасник:bigote]], [[Службова:Recentchanges]] і таке інше.
    • Ви вже відредагували й зберегли сторінку довідки, тепер ідіть на сторінку останніх виправлень (вашою мовою вона буде називатися якось по-іншому), і там ви побачите посилання на тільки що створену статтю, а поруч буде написано ваш нік. Клацніть на ньому мишею, і у вашій персональній сторінці, що відкрилася на редагування, (яку, до речі, не зашкодить заповнити, повідомивши хоча б ваш JID для зв'язку з вами) подивіться на її назву. Повинно фігурувати щось схоже на "Редагування Учасник:Bigote" (це українською, але можна привести приклад і на іншій мові). Тобто, якщо вам буде потрібно вставити посилання на персональну сторінку учасника, зареєстрованого на вашій версії вікі, використайте шаблон [[Учасник:bigote]]. Якщо ж у цього учасника немає персональної сторінки на вашій мові, але є, приміром, російська або англійська сторінка, то можете дати интервікі-посилання на неї в такий спосіб: [[:ru:Участник:bigote|Bigote]] — вона буде виглядати як локальне посилання, але вести буде на персональну статтю іншої версії. Код мови, звичайно, буде залежати від того, на яку версію вікі ви посилаєтеся.
    • У такий же спосіб упізнаються назви інших спеціальних статей. (Можна просто навести на посилання, що вас цікавить, мишею, і тоді в статус-барі браузера ви побачите повне посилання, з якого треба вичленувати назву статті для вставки в посилання у вихідному коді статті.)

Переклад на рідну мову

Коли ви перекладаєте на рідну мову, часто виникає проблема у використанні специфічних термінів, що стосуються світу IT. З одного боку, в українській мові вже давно прижилися транслітерації деяких термінів, такі як "файл", "біндинг", а також адаптовані іноземні слова: "гвинт", "аська". З іншого боку, для деяких речей має сенс дати адекватний український переклад, наприклад, "список контактів" замість "ростер" (хоча в цьому конкретному випадку можна посперечатися). Який варіант вибрати — вирішувати вам, але у кожному разі намагайтеся не переходити у крайнощі. Нерозумно перекладати "binding" як "прив'язка" — переважна більшість читачів вас не зрозуміє. Але так само нерозумно транслітеризувати якийсь термін тільки тому, що він іноземний. Часто цілком можна писати в статті українською, на самому початку давши вихідний термін і розшифрувавши його. На нашої вікі є спеціальний розділ — Термінологія, де ви можете проконсультуватися щодо незрозумілих слів, а також доповнити його, якщо вважаєте за потрібне.

Ще одна проблема перекладу на українську мову (у загальному випадку, між мовами різних язикових груп) — кальки. Намагайтеся уникати дослівних перекладів. Якщо якась фраза вам не дуже зрозуміла, дослівний переклад її не врятує, а навпаки — скалічить. У більшості випадків при подібних утрудненнях цілком можна домогтися гарного перекладу, спростивши зміст фрази або розбивши довге речення на два простих. У крайньому випадку, залишіть поруч у дужках вихідну фразу — вікі тим і гарна, що все можна поправити й не один раз. Щось не можете зробити ви — зроблять інші. До речі, якщо при читанні статті, переведеної кимось іншим, ви бачите кальку, що ріже вуха, не полінуєтеся подивитися це місце у вихідній статті й поправте переклад. Якщо ви не знаєте вихідної мови, але якесь місце в перекладі вам все-таки не подобається, не соромтеся скористатися Обговоренням (посилання можна знайти у верхньому службовому меню, розташованому над кожною статтею).

Переклад на чужу мову

Всі ми знаємо, що для того, щоб зробити гарний переклад, треба в першу чергу дуже добре володіти мовою, на яку перекладаєш. Найчастіше й перекладають на рідну мову, але іноді доводиться перекладати на чужі. Що можна порадити для цього випадку стосовно до нашої вікі?

Переклад меню

У нашої вікі редагувати меню можна лише адміністраторам проекту. Зв'яжіться або з Bigote, або з Lknight.

Локалізація Ткаббера

У каталозі Ткаббера є папка з назвою msgs, усередині якої лежать файли повідомлень на різних мовах. Якщо ви бачите, що вашої мови серед них немає, і вам хотілося б Ткаббер локалізувати, можете зайнятися перекладом самостійно. Також може мати сенс оновлення існуючого перекладу, тому що процес розробки не стоїть на місці. У Ткаббера є убудований засіб, що полегшує життя перекладачеві, але краще опишемо увесь процес окремими кроками.

Обновляємо існуючі повідомлення

  1. Спочатку треба встановити саму останню версію Ткаббера з svn-репозиторія.

    • Встановіть, якщо у вас немає, клієнта subversion;
    • створіть робочий каталог, наприклад, ~/tkabber-svn, і перейдіть до нього cd tkabber-svn;

    • потім у терміналі наберіть

      svn co https://svn.xmpp.ru/repos/tkabber/trunk .

      (Це означає: "одержати вміст транка проекту Ткаббер у поточний каталог".)

    • Якщо ви отримали помилку "svn: SSL is not supported", наберіть ту ж команду, тільки замість https напишіть http.

    • У результаті описаних заклинань у вас у робочому каталозі з'явиться два підкаталоги: tkabber і tkabber-plugins — це саме програма і її плагіни.

  2. Починаємо роботу (у прикладі дається італійська мова, вам треба ставити свою). *

        cd tkabber

*

        tclsh ./contrib/extract-translations/extract.tcl . msgs/it.msg >../it.msg

*

        tclsh ./contrib/extract-translations/extract.tcl . -v msgs/it.msg >../it.msg.1
Створення нової версії

Кроки, що описано вище, вам треба буде проробити й у випадку перекладу з нуля, хіба що потрібно буде взяти за зразок оформлення вашого файлу який-небудь із існуючих (той же англійський, наприклад). У першому рядку не забудьте поставити дату створення файлу, а трохи нижче — залишити ваше ім'я й контакти (у вигляді коментарю, звичайно).

Що ще перекладати?
  1. Крім файлу повідомлень ваша_мова.msg непогано б створити файл ресурсів BWidget — ваша_мова.rc, якщо його ще немає. Кажучі просто, у цьому файлі лежать назви кнопок і інших елементів інтерфейсу Ткаббера. У каталозі msgs вже є російська й польська версії, які можуть бути зразком для оформлення.
  2. Різноманітні плагіни теж мають свої повідомлення. Скачайте з svn-репозиторія свіжі плагіни: svn co http://svn.xmpp.ru/repos/tkabber/trunk/tkabber-plugins tkabber-plugins і подивіться — у кожному плагіні є свій каталог msgs. Уперед! ;)
  3. У директорії Ткаббера є каталог trans, де перебувають повідомлення, що використовуються новим плагіном "Remote Control" ("Віддалене керування"). На даний момент є основною (і єдиної) російська версія, але сподіваємося, що в найближчому часі файл буде переведено на англійську і, в такий спосіб, стане доступним для перекладу на багато інших мов. Формат файлу схожий, за винятком початку рядка повідомлення: ::trans::trset ru