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

    From KDE UserBase Wiki
    Revision as of 17:16, 4 June 2011 by Yurchor (talk | contribs) (Created page with "Набір інструментів")
    (diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

    Інформація

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


    Визначення місця для вашої сторінки

    Структура каталогів

    Програма
    Програма/Усування помилок
    Програма/Настанови щодо xxx
    Програма/Підручник
    Програма/Підручник/Вступ
    Програма/Підручник/Розділ_1
    Програма/Підручник/Розділ_xxx

    Не додавайте мовної панелі i18n

    {{Template:I18n/Language Navigation Bar|Toolbox}}

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

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

    {|class="tablecenter vertical-centered"
    |[[Image:YourScreenshot.png|250px|thumb]]
    |Описовий текст
    |}
    

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

    Використовуйте жирний і курсив

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

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

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

    Використовуйте різні шаблони для даних, які вводить користувач, і для даних, які буде виведено у відповідь у терміналі. У відповідь на використання коду {{Input|1=цей фрагмент коду слід ввести користувачеві}} буде показано

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

    Дані, виведені у терміналі слід показувати у подібний же спосіб, за допомогою шаблону. Якщо буде вказано {{Output|1=користувач має прочитати це у konsole}}, ви побачите

    користувач має прочитати це у konsole

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

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

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

    Списки, нумеровані і ненумеровані

    • Наступний пункт
      • Підпункт
    • Третій пункт</nowiki>

    дасть таке:

    • Одна зірка
    • Наступний пункт
      • Підпункт
    • Третій пункт

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

    # Одинарна решітка # Другий пункт ## Підпункт # Третій пункт

    дасть:

    1. Одинарна решітка
    2. Другий пункт
      1. Підпункт
    3. Третій пункт

    Варто надавати перевагу ненумерованим спискам.

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

    Існує два різновиди посилань, про які варто знати, внутрішні, на іншу сторінку UserBase, та посилання на зовнішні сторінки.

    Для посилання на внутрішні сторінки можна скористатися таким форматуванням: [[PageLayout]], якщо назва сторінки збігається з назвою посилання. Але такі посилання є незручними для перекладу. Краще скористатися форматом [[PageLayout|Page Layout]], щоб полегшити завдання перекладачам. Часто назвою посилання є частина речення. У такому разі слід скористатися таким кодом:

    [[PageLayout|ця сторінка]]

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

    ця сторінка

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

    [http://techbase.kde.org/Schedules наш план робіт]

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

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

    І нарешті, у попередньому перегляді вашої сторінки ви зможете перевірити посилання. Наведіть вказівник миші на посилання, щоб переконатися, що воно веде на належну сторінку. Червоними посиланнями можна скористатися для створення сторінок.

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

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

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

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

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

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

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

    дасть:

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

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

    Для додавання нотатки або попередження скористайтеся таблицею, ось так:

    Зауваження Якась важлива інформація
    :{| |[[Image:help-hint.png]]||'''Підказка'''||Щось, про що важливо пам’ятати |}
    Підказка Щось, про що важливо пам’ятати
    :{| |[[Image:dialog-warning.png|32px]]||'''Попередження'''||Це небезпечно |}
    Попередження Це небезпечно

    Для показу нотатки або попередження, яке є достатньо важливим, щоб наголосити на них, призначено два шаблони Info і Warning. Використання:

    {{info|Це інший спосіб показу вашої інформації}}

    Information

    Це інший спосіб показу вашої інформації


    або

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

    Warning

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



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

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

    Корисні шаблони

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

     Див. примітку

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


    Подробиці щодо цієї програми можна знайти на домашній сторінці відповідного проекту

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

    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


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

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

    Under Construction

    This is a new page, currently under construction!


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

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

    Підсторінки Toolbox/uk


    Поєднати введення з виведенням можна за допомогою підсвічування синтаксису GeSHi. Область введення даних виглядатиме так

    {{Input|<syntaxhighlight lang="php" line>
    # Ініціалізація типового коду
    $preIP = dirname( __FILE__ );
    require_once( "$preIP/includes/WebStart.php" );
    </syntaxhighlight>}}

    отримаємо:

    # Ініціалізація типового коду
    $preIP = dirname( __FILE__ );
    require_once( "$preIP/includes/WebStart.php" );
    

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

    Under Construction

    This is a new page, currently under construction!


    Намагайтеся не створювати структури, рівень вкладеності у якій перевищує три. Здебільшого, достатньою для викладу буде така структура:

    Якщо можливо, варто розпочати основну сторінку програми саме з цього елемента. Відповідний код:

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

    Одинарні лапки використовуються для позначення слів з напівжирною та курсивною гарнітурою.

    * призначено для створення ненумерованих списків. Комбінацію ** призначено для створення пунктів другого рівня вкладеності:

     :* Одна зірка
    
    ===Додавання окремого зображення, вирівняного за центром===
    
    <div style="white-space:pre;">
    :{|style="width:95%; border:2px dotted #BCBCBC; background:lemonchiffon" align="center"
    |<nowiki>{|class=tablecenter
    |[[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|Це важлива інформація}} відповідатиме тексту

    Інформація

    Це важлива інформація


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

    Note

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


    {{Tip|Корисна порада, щось, що слід запам’ятати}} відповідатиме тексту

    Tip

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


    {{Warning|Обережно! Це небезпечно!}} відповідатиме тексту

    Warning

    Обережно! Це небезпечно!


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

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

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


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

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

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

    Template:Prevnext/uk


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

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


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