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

Other languages:

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

Виконання наведених на цій сторінці настанов з форматування надасть змогу акуратно і без проблем експортувати дані з метою включення до пакунків 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 на нових рядках порушує порядок пунктів у списках. Вам просто не слід переходити на новий рядок, якщо таке порушення небажане.

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

{{Input|<syntaxhighlight lang="php" line>
# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
</syntaxhighlight>}}

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

# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );

Окремі слова коду можна вказувати у тексті за допомогою теґів
```
<code></code>
```
Такий код буде показано ось так.

```
<tt> </tt>
```
можна скористатися для позначення назв файлів та каталогів. Виглядає це так: шлях/до/каталогу

Цитування

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

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

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

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

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

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

Списки

Ви можете використовувати на ваших сторінках списки різних типів: з позначками і нумеровані списки. Докладніше про це на сторінці набору інструментів.

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

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

Якщо вам потрібно розділити рядки посередині розділу і варто зробити це без поділу розділу на модулі: скористайтеся кодом <br />, доданим наприкінці рядка, там де має розпочатися новий рядок (натискати Enterне потрібно). Якщо між рядками має бути порожній рядок, скористайтеся конструкцією <br /><br />.

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

Система перекладу позначає як неточні всі переклади, у яких є незакриті дужки. Якщо вам потрібно скористатися незакритими дужками у вашому тексті, будь ласка, додайте дужки у межах теґу коментаря, ось так:

{{ Рядок <!--}}--> 

Ще один рядок <!-- {{ --> }}

Це стосується всіх типів дужок, навіть звичайних круглих дужок. (Звичайно ж, зазвичай, варто уникати порожніх рядків з модулем перекладу, — див. Цілісність фрагментів тексту.)

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

Теґи <keycap> та </keycap> позначають назви клавіш (клавіатури), наприклад, Enter
<keycap></keycap> також може позначати групу клавіш, які слід натискати одночасно, наприклад, Ctrl + Alt + F1 для запуску віртуального термінала. (Зауважте, що для поєднання таких комбінацій клавіш слід використовувати "(пробіл)+(пробіл)").
Послідовності пунктів меню слід позначати за допомогою теґів <menuchoice> та </menuchoice> . Приклад: Перегляд -> Список повідомлень -> Збирання -> Звичайний список листування
Загалом, якщо користувачеві потрібно вибрати щось, навіть не пункт меню, слід також використовувати <menuchoice></menuchoice>.

(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!".