Настанови з форматування

    From KDE UserBase Wiki
    Revision as of 15:05, 13 June 2011 by Yurchor (talk | contribs) (Created page with "* Використання шаблонів Input та Output на нових рядках порушує порядок пунктів у списках. Вам просто н...")

    Нами створено окремі сторінки з описом компонування сторінки та синтаксису з кодом прикладів.

    Виконання наведених на цій сторінці настанов з форматування надасть змогу акуратно і без проблем експортувати дані з метою включення до пакунків KDE.

    Напівжирний стиль

    Напівжирним стилем слід користуватися для позначення таких елементів:

    • Заголовків вікон
    • Типових міток, які не може бути змінено користувачем
    • Підписів під піктограмами
    • Назв програм

    Приклад:

    • Позначення фрагмента тексту призведе до копіювання тексту до буфера Klipper.

    Курсивний стиль

    Курсив слід використовувати для позначення таких елементів:

    • виокремлених слів та словосполучень, як під час створення звичайних документів;
    • заголовків під час посилання на інші роботи;
    • першого використання якогось терміну.

    Приклади:

    • На цьому кроці варто зберегти результати вашої роботи.
    • Докладніше про це можна дізнатися з книги Samba 3 by Example...
    • Підручники KDE зберігаються у форматі Docbook.

    Підказка

    Програми запускають користувачі, компоненти використовуються програмами.


    Поєднання напівжирного та курсивного стилів

    Таким поєднанням можна скористатися для замінного тексту або позначення змінної.

    Приклади:

    • Для встановлення з’єднання з вашим віддаленим сервером, віддайте команду ssh користувач@назва.домену у Konsole.
    • У дистрибутивах з системою керування пакунками rpm команда rpm -q назва_пакунка повертає дані у форматі пакунок-версія-випуск.

    Моноширинний шрифт

    Код слід подавати моноширинним шрифтом, зазвичай у рамці, як це показано нижче. Для виведеного тексту колір тла буде фіолетово-сірим.

    • Для програмного коду (окремих рядків чи блоків) слід використовувати шаблони для забезпечення однорідності.
    • Користуйтеся шаблоном Input ось так:
      {{Input|1=<nowiki>
      qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
      rm -r ~/.kde/share/apps/nepomuk
      rm -r ~/.kde4/share/apps/nepomuk
      nepomukserver</nowiki>}}
      Результат буде ось таким:
      qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
      rm -r ~/.kde/share/apps/nepomuk
      rm -r ~/.kde4/share/apps/nepomuk
      nepomukserver


    • Шаблон Output працює ось так:
      {{Output|1=<nowiki>terminal output 
      is also shown as code, 
      but on a grey background</nowiki>}}
      результат:
      terminal output 
      is also shown as code, 
      but on a grey background

    Зауваження

    Скористайтеся форматом 1=<nowiki> якийсь текст </nowiki>, щоб уникнути хибного показу даних.


    • Використання шаблонів Input та Output на нових рядках порушує порядок пунктів у списках. Вам просто не слід переходити на новий рядок, якщо таке порушення небажане.
    • You can also combine input/output areas with GeSHi syntaxhiglighting. An input area like this
      {{Input|<syntaxhighlight lang="php" line>
      # Initialise common code
      $preIP = dirname( __FILE__ );
      require_once( "$preIP/includes/WebStart.php" );
      </syntaxhighlight>}}
      will result in
      # Initialise common code
      $preIP = dirname( __FILE__ );
      require_once( "$preIP/includes/WebStart.php" );
      
    • Окремі слова коду можна вказувати у тексті за допомогою теґів
      <code></code>
      Такий код буде показано ось так.
    • <tt> </tt>
      можна скористатися для позначення назв файлів та каталогів. Виглядає це так: шлях/до/каталогу

    Цитування

    Для цитат з інших джерел або інших сторінок слід використовувати теґи <blockquote> та </blockquote>. Цитати буде показано з відступом курсивним шрифтом.

    Приклад показу тексту з використанням міток blockquote.

    Текст у заголовках розділів

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

    Текст у шаблонах Information, Note, Tip та Warning

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

    Списки

    You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the Toolbox page.

    Цілісність фрагментів тексту

    After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!

    If you need a linebreak in the middle of a section, the preferred way to achieve this is without breaking units is to use <br /> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <br /><br />.

    Відповідність дужок

    The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:

    {{ A line <!-- }} --> 
    
    Another line <!-- {{ --> }}

    This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see Keeping things together.)

    Спеціальні мітки

    • <keycap> and </keycap> denote (keyboard) key names e.g. Enter
    • <keycap></keycap> can also be used around groups of keys to be used concurrently, e.g. Ctrl + Alt + F1 to launch a virtual terminal. (Note that Note that "(space)+(space)" is used to link keys to be pressed concurrently).
    • Sequences of menu choices should use <menuchoice> and </menuchoice> for example View -> Message List -> Aggregation -> Standard Mailing List
    • In general, if the user needs to choose an element, even if it is not in a menu, the <menuchoice></menuchoise> markup should be used.

    (Note the use of "(space)->(space)" to denote the sequence of clicks.)

    Дані, придатні для перекладу

    Everything that is translatable is contained within <translate> and </translate> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".