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

Other languages:

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

Пам’ятайте!

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

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

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

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

Приклад:

Позначення фрагмента тексту призведе до копіювання тексту до буфера 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

Note

Зверніть увагу на використання 1=<nowiki> текст </nowiki>. Частину тексту не може бути показано через небажану обробку його кодом вікі. Блок <nowiki>...</nowiki> захищає вміст від обробки. Крім того, якщо у тексті шаблону використано n=, обробник може виконати обробку з помилками. Початковий код 1= захистить такі рядки від обробки. Якщо цей код не буде використано, розмітка не працюватиме.

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

Для назв файлів і шляхів слід використовувати шаблон Path (див. нижче).

Попередження

Фрагменти коду у рядках мають бути доволі короткими. Рядок коду, розділений між кількома рядками, виглядає дивно і незграбно. Пам’ятайте: навіть якщо на вашому комп’ютері все виглядає добре, роздільність екранів користувачів може бути зовсім іншою. Якщо текст виглядає добре на всіх роздільностях, можливі проблеми з перекладами. Для коду варто користуватися шаблоном Input, хіба що цей код є доволі компактним.

Зауваження

Будь ласка, уникайте використання команд оболонки та іншого коду як дієслів у реченнях. Такі речення буде дуже важко правильно перекласти. Завжди використовуйте команди як власні назви.

Цитування

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

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

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

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

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

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

Списки

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

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

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

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

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

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

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

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

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

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

Натискання клавіш та вибір пунктів меню

Теґи <keycap> та </keycap> позначають назви клавіш (клавіатури), наприклад, Enter
<keycap></keycap> також може позначати групу клавіш, які слід натискати одночасно, наприклад, Ctrl + Alt + F1 для запуску віртуального термінала. (Зауважте, що для поєднання таких комбінацій клавіш слід використовувати "(пробіл)+(пробіл)").
Послідовності пунктів меню слід позначати за допомогою теґів <menuchoice> та </menuchoice> . Приклад: Перегляд -> Список повідомлень -> Збирання -> Звичайний список листування
Загалом, якщо користувачеві потрібно вибрати щось, навіть не пункт меню, слід також використовувати <menuchoice></menuchoice>.
Якщо ви пишете сторінку підручника, вам слід завжди використовувати описану вище розмітку. Для інших сторінок можете скористатися шаблоном для введення пунктів меню: {{Menu|Top|sub|...}}. Наприклад, {{Menu | View | Message List | Aggregation | Standard Mailing List}} дає View → Message List → Aggregation → Standard Mailing List
Якщо хочете скористатися <menuchoice>, але з → замість ->, можете вписати код & rarr; (без пробілу між & та r!), ось так: <menuchoice> View</menuchoice> & rarr; <menuchoice>Message List</menuchoice>, щоб отримати View → Message List. (Зауважте, що символ → має бути розташовано поза межами теґів menuchoice, щоб його було показано належним чином.)

Файли і шлях и до файлів

Традиційно, назви файлів та шляхи позначаються теґами <tt>...</tt>.

<tt>~/.kde/share</tt>

дає

~/.kde/share

Крім того, для цього передбачено шаблон, яким варто користуватися для нових сторінок UserBase (але не для сторінок підручників, будь ласка!):

{{Path | ~/.kde/share }}

дає

 ~/.kde/share

Проблеми з символом вертикальної риски

Іноді можуть виникнути проблеми з використанням символу вертикальної риски, наприклад, під час додавання параметрів у шаблоні. У такому разі слід скористатися шаблоном {{!}}, який буде показано як символ вертикальної риски. Наприклад, якщо вам потрібен рядок команди, що містить символ вертикальної риски, у межах шаблону {{Input|...}}, найпростішим способом досягти потрібного результату буде такий: {{Input|1=cmd1 {{!}} cmd2}}. Буде показано:

cmd1 | cmd2

Якщо ви напишете просто {{Input|cmd1 | cmd2}}, буде показано

cmd1

Тобто вважатиметься, що cmd2 є другим параметром шаблону, у нашому прикладі такий параметр просто не використовується.

У багатьох випадках можна просто обмежити фрагмент тексту з вертикальною рискою теґами <nowiki>... </nowiki>, ось так: {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}. Буде показано:

cmd1 | cmd2

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

Всі частини, які можна локалізувати має бути обмежено теґами <translate> і </translate>. Здебільшого, такими фрагментами тексту є і елементи з зображеннями, оскільки ці зображення часто слід замінювати локалізованими версіями, щоб їх могли зрозуміти читачі. Корисно дотримуватися правила: «Сумніваєшся? Краще включи!».