Набір інструментів

    From KDE UserBase Wiki
    Revision as of 11:58, 8 July 2011 by FuzzyBot (talk | contribs) (Updating to match new version of source page)

    Інформація

    На цій сторінці наведено приклади типового форматування коду


    Додавання вступного знімка вікна та опису

    Сторінку програми слід починати саме з такого зображення. Відповідний код:

    {|class="tablecenter vertical-centered"
    |[[Image:Ваш_знімок.png|250px|thumb]]
    |Ваш опис
    |}

    Форматування тексту

    Використання заголовків

    Додавання заголовка призводитиме до автоматичного створення розділу у «Змісті», отже визначає структуру документа. Місце у змісті визначається кількістю символів «=» доданих перед і після заголовка. Не використовуйте одинарні символи — так позначається заголовок сторінки. Заголовки найвищого рівня слід позначати так: «==Текст заголовка==», наступного рівня — «===Інший заголовок===» тощо.

    Додайте вступний знімок екрана і опис

    Одинарні лапки позначають слова напівжирним та курсивним шрифтом.

    Використовуйте форматування '''текст жирним''', щоб отримати текст жирним', і ''текст курсивом'', щоб отримати текст курсивом.

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

    Додавання фрагмента коду

    Нами створено шаблони, які допоможуть вам у правильному форматуванні фрагментів коду. Приклади використання шаблонів у різних випадках можна знайти на настанов щодо форматування.

    Якщо у вас виникають проблеми з символом вертикальної риски («|») у фрагменті коду, будь ласка, ознайомтеся з поясненням та порадами щодо форматування на відповідній сторінці.

    Додавання відступів

    «:» призначено для створення відступів. На деяких застарілих сторінках цей символ використовується по декілька разів. Цей спосіб створення відступів слід вважати застарілим, оскільки він спричиняє певні проблеми, отже такі кратні відступи має бути вилучено у разі їх виявлення. Одинарна двокрапка, «:», створює відступ на чотири символи.

    Форматування дат

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

    18 Mar 2011

    Слід вказувати повну назву місяця або її скорочену форму та рік у форматі з чотирма цифрами. День можна вказувати однією або двома цифрами.

    Списки з позначками

    Списки з позначками створюються за допомогою символу *. Другий рівень списку можна додати за допомогою послідовності **:

    * Мигдаль
    
    * Горіхи
    ** Ліщина
    
    * Родзинки
    

    дасть нам

    • Мигдаль
    • Горіхи
      • Ліщина
    • Родзинки

    Переліки

    Переліки або нумеровані списки можна отримати у подібний же спосіб за допомогою «#».

    # Просіяти
    # Змішати
    ## Ретельно розмішати
    # Запекти
    

    Отримаємо

    1. Просіяти
    2. Змішати
      1. Ретельно розмішати
    3. Запекти

    Поєднання списків з позначками та нумерованих списків

    У списку з позначками можна створити допоміжний перелік, і навпаки. Ось так:

    * Горіхи
    *# Ліщина
    *# Отримати на горіхи
    * Інші речі
    

    Отримаємо:

    • Горіхи
      1. Ліщина
      2. Отримати на горіхи
    • Інші речі

    Код

    # Горіхи
    #* Ліщина
    #* Отримати на горіхи
    # Інші речі
    

    дасть нам

    1. Горіхи
      • Ліщина
      • Отримати на горіхи
    2. Інші речі

    Зауваження

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


    Зауваження

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


    Списки

    Списки можна створювати за допомогою додавання на початку рядка ; та : відповідно. Ними можна користуватися для створення коротких описів групи пов’язаних об’єктів.

    ;Тварини
    : Вони рухаються і їдять інших істот.
    
    ;Рослини
    : Вони мають корені і споживають воду з ґрунту та сонячні промені.
    

    відповідає такому списку:

    Тварини
    Вони рухаються і їдять інших істот.
    Рослини
    Вони мають корені і споживають воду з ґрунту та сонячні промені.

    Зауваження

    Як і завжди, намагайтеся робити так, щоб кожен з пунктів відповідав окремому модулю; це може полегшити життя перекладачам.


    Додавання посилань

    Передбачено три різних типи посилань: внутрішні (на сторінки UserBase або на розділи сторінок UserBase) та зовнішні (на інші сторінки інтернету).

    Для внутрішніх посилань працездатним є формат [[Назва_сторінки]], де у дужках слід вказати назву сторінки, але цей варіант не є ідеальним з точки зору локалізації. Краще вказувати адреси у форматі [[Special:myLanguage/Назва_сторінки|Назва сторінки]], оскільки такий варіант надає змогу створювати посилання на переклади сторінок. Перехід за таким посиланням здійснюється на перекладену сторінку, якщо переклад вже було виконано. Часто посилання є частиною речення, тоді слід користуватися таким кодом:

    [[Special:myLanguage/PageLayout|ця сторінка]]

    Буде показано:

    ця сторінка

    {{Input|1=== Підсторінки {{FULLPAGENAME}} == {{Special:PrefixIndex/{{FULLPAGENAME}}/}}

    Зверніть увагу, що символ вертикальної риски (|), який використовується у конструкціях кортежів команд, якщо його буде використано без екранування призведе до пропуску всіх команд після першої вертикальної риски! Якщо увашому фрагменті коду є такі символи, їх слід вводити за кодом команди або з використанням шаблону Template:! у такий спосіб: {{Input|1=команда 1 {{!}} команда 2}} призведе до показу

    команда 1 | команда 2

    Формат посилань на зовнішні сторінки є дещо іншим:

    [http://techbase.kde.org/Schedules наш план дій]

    буде показано так:

    наш план дій. Посилання вказуватиме безпосередньо на відповідну сторінку techbase.

    Варто пам’ятати: під час попереднього перегляду сторінки посиланнями вже можна користуватися. Це корисно з двох причин: ви можете перевірити (наведенням вказівника миші), чи правильно вказано посилання, і ви можете скористатися посиланнями червоного кольору для створення сторінок.

    Ілюстрування тексту

    Додавання окремого зображення, розташованого у центрі

    [[Image:KMail-kde4.png|250px|center]]

    Зауважте, що ви можете змінювати розташування зображення. Типовим є розташування ліворуч (left). Розміри зображення залежать від його призначення, але не варто використовувати знімків екрана з розмірами, меншими за 250 пікселів (px) і більшими за 500 пікселів (px).

    Як зробити так, щоб зображення можна було натискати, і додати підпис

    Там, де буде доцільним детальніше зображення, додайте на сторінку зображення відповідних розмірів так, щоб побачити його у початкових розмірах можна було після натискання розташованої на сторінці мініатюри. Для цього слід просто додати параметр «|thumb» у опис зображення.

    Підпис (caption) також можна додати як параметр, але його буде показано, лише якщо вказано параметр «|thumb».

    Для красивого розташування декількох зображень поруч скористайтеся таблицею

    {|class="tablecenter" style="border: 1px solid grey;"
    |[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
    |-
    |[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
    |}

    дасть:


    Зауважте, що всі параметри для одного зображення містяться у [[...]], а комірки відокремлюються «||». Щоб розпочати новий рядок таблиці, вставте «|-» у новому рядку, а потім додайте «|» на початку наступного.

    Додавання нотаток і попереджень

    Для додавання нотатки або попередження скористайтеся відповідними шаблонами:

    {{Info|Це загальна інформація.}} дасть

    Information

    Це загальна інформація


    {{Note|Якась важлива на певному етапі інформація}} дасть

    Note

    Якась важлива на певному етапі інформація


    {{Tip|Корисна порада, щось, про що варто пам’ятатати}}дасть

    Tip

    Корисна порада, щось, про що варто пам’ятатати


    {{Warning|Виконання цієї дії є дуже небезпечним}} дасть

    Warning

    Виконання цієї дії є дуже небезпечним


    Там, де конче треба привернути увагу читача, можна скористатися шаблоном Remember, але ним не варто зловживати. {{Remember|1=Про цю річ не варто забувати}}

    Remember

    Про цю річ не варто забувати


    Ви також можете змінити заголовок шаблону:

    Remember

    Ви можете скористатися параметром номер 3 для зміни заголовка шаблону:
    {{Remember|3=Не забувайте про це!|1=Ви можете скористатися...}}


    Версії програм для KDE3 і KDE SC 4

    Типово вважається, що програму створено для KDE SC 4. Якщо версія для KDE SC 4 ще не готова до використання або версії для KDE 4 взагалі не існує, ймовірно, варто розповісти про версію для KDE3. У такому разі додайте піктограму {{KDE3}}, яку буде показано так: . Якщо ви маєте намір викласти дані щодо версій для KDE3 і KDE SC 4 на одній сторінці, скористайтеся піктограмою нової версії: {{KDE4}} ( )

    Інші корисні шаблони

    Додавання піктограм графічного інтерфейсу

    Найкращим способом посилання на піктограму у графічному інтерфейсі програми є зображення цієї піктограми у тексті. Зробити це можна за допомогою такого шаблону: {{Icon|list-add}}. Буде показано піктограму .

    Щоб користуватися цим шаблоном, зображення піктограми слід попередньо вивантажити на вікі. Опис вивантаження зображень можна знайти на сторінці вивантаження зображень. Знайти відповідні файли .png можна тут: usr/share/icons/oxygen. Намагайтеся використовувати піктограми розміром 16x16. Відповідний файл повинен мати назву, що починається з Icon-, наприклад, Icon-list-add.png — окрім першої частини, назва файла має відповідати звичайній назві. Зауважте, що у разі використання шаблону, вам не потрібно вказувати префікс Icon- та суфікс .png.

    Для включення пікторами можна також скористатися кодом {{Plus}}, для — кодом {{Minus}}. Ви можете додати код {{Configure}}, щоб отримати піктограму , або код {{Exit}}, щоб отримати піктограму .

    Програми спільноти

    Останні зауваження, стосуються програм, які не є частиною основного набору програм KDE. Позначити це можна за допомогою відповідної піктограми, яку слід додати за допомогою коду {{Community-app}}


     See footnote


    наприкінці речення або рядка, подібно до того, як позначається підрядкова примітка у книжках. Якщо ви додасте {{Community-app-footnote}}, буде створено підрядкову примітку, ось так:



    Support for this application can be found from the project's home page


    Внесення значних змін до вже створених сторінок

    Якщо сторінку буде відкрито для редагування доволі довго, виникне ризик конфліктів редагувань: хтось інший може внести зміни до сторінки одночасно з вами. Збереження ваших змін призведе до втрати змін інших користувачів, і навпаки. Щоб уникнути таких прикростей, додайте на сторінку тимчасовий шаблон на початку: {{Being_Edited}}. Буде показано таку панель:

    Currently Being Edited

    This page is currently being edited.
    If this notice persists for an unreasonable time, please either notify irc.freenode.org #kde-www or report on Claus chr's Talk page

    Note: Pages should not normally be marked for translation while they are being actively worked on


    Не забудьте вилучити шаблон, коли завершите редагування!

    Додавання нової складної сторінки

    Якщо вам потрібно попрацювати над сторінкою протягом доволі довгого часу, наприклад, декілька днів, ви можете скористатися шаблоном Construction: {{Construction}}. На сторінці буде показано таку панель:

    Under Construction

    This is a new page, currently under construction!


    Посилання на сусідні сторінки

    Ви можете додавати посилання на попередню або наступну сторінку за допомогою таких шаблонів:

    {{Prevnext/uk|Назва попередньої сторінки|Назва наступної сторінки|Сторінка перед цієї сторінкою|Сторінка, яка має йти наступною}}

    Template:Prevnext/uk

    Якщо сторінка є першою (немає попередньої сторінки) або останньою (немає наступної сторінки), скористайтеся таким кодом:

    {{Next|Назва наступної сторінки|Цю сторінку вам слід читати далі}}
    {{Prev|Назва попередньої сторінки|Ця сторінка передує поточній}}


    Додавання списку підсторінок

    == Subpages of {{FULLPAGENAME}} ==
    {{Special:PrefixIndex/{{FULLPAGENAME}}/}}

    є дуже корисним, якщо вам потрібен список підсторінок з активними посиланнями, ось такий:

    Subpages of Toolbox/uk

    У показаному списку будуть всі сторінки іншими мовами, тому таким способом слід користуватися обережно.