Нами створено окремі сторінки з описом компонування сторінки та синтаксису з кодом прикладів.
| Важливо |
|---|
| Виконання наведених на цій сторінці настанов з форматування надасть змогу акуратно і без проблем експортувати дані з метою включення до пакунків KDE. Деякі з настанов можуть виявитися незастосовними до мов, відмінних від англійської. Дані щодо цього можна знайти на відповідних сторінках мов, посилання на які наведено на сторінці Translation Workflow. Якщо посилання на сторінку вашої мови ще немає, будь ласка, додайте його і викладіть там настанови щодо форматування сторінок вашою мовою. |
Напівжирним стилем слід користуватися для позначення таких елементів:
Приклад:
Курсив слід використовувати для позначення таких елементів:
Приклади:
| Підказка |
|---|
| Програми запускають користувачі, компоненти використовуються програмами. |
Таким поєднанням можна скористатися для замінного тексту або позначення змінної.
Приклади:
KDE UserBase Wiki 
• 
• 
• 
• ssh користувач@назва.домену у Konsole.
rpm -q назва_пакунка повертає дані у форматі пакунок-версія-випуск.
Код слід подавати моноширинним шрифтом, зазвичай у рамці, як це показано нижче. Для виведеного тексту колір тла буде фіолетово-сірим.
{{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|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|<syntaxhighlight lang="php" line>
# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
</syntaxhighlight>}} буде показано так:
# Initialise common code
<code></code>Такий код буде показано
ось так. Зауважте, що якщо перед теґом <code> є символ нового рядка, дані буде показано не так, як вам би того хотілося.
<tt> </tt>можна скористатися для позначення назв файлів та каталогів. Виглядає це так: шлях/до/каталогу
| Попередження |
|---|
| Фрагменти коду у рядках мають бути доволі короткими. Рядок коду, розділений між кількома рядками, виглядає дивно і незграбно. Пам’ятайте: навіть якщо на вашому комп’ютері все виглядає добре, роздільність екранів користувачів може бути зовсім іншою. Якщо текст виглядає добре на всіх роздільностях, можливі проблеми з перекладами. Для коду варто користуватися шаблоном Input, хіба що цей код є доволі компактним. |
| Зауваження |
|---|
| Будь ласка, уникайте використання команд оболонки та іншого коду як дієслів у реченнях. Такі речення буде дуже важко правильно перекласти. Завжди використовуйте команди як власні назви. |
Для цитат з інших джерел або інших сторінок слід використовувати теґи <blockquote> та </blockquote>. Цитати буде показано з відступом курсивним шрифтом.
Приклад показу тексту з використанням міток blockquote.
Навіть якщо виконуються описані вище умови, не використовуйте напівжирний стиль у заголовках розділів і посиланнях.
Не використовуйте напівжирний стиль у тексті шаблонів. Курсив слід використовувати для підкреслення певних моментів і не зловживати ним.
Ви можете використовувати на ваших сторінках списки різних типів: з позначками і нумеровані списки. Докладніше про це на сторінці набору інструментів.
Після завершення редагування вашого тексту до нього буде автоматично додано елементи, потрібні для системи перекладу. Пропущений рядок для цієї системи означає початок нового модуля. Під час перекладу перекладачі, зазвичай, працюють лише з одним модулем одночасно, тому важливо пропускати рядки там, де має бути створено окремий модуль. Зазвичай, кожен абзац має бути окремим модулем. Не допускайте поділу одного речення між окремими модулями!
Якщо вам потрібно розділити рядки посередині розділу і варто зробити це без поділу розділу на модулі: скористайтеся кодом <br />, доданим наприкінці рядка, там де має розпочатися новий рядок (натискати Enterне потрібно). Якщо між рядками має бути порожній рядок, скористайтеся конструкцією <br /><br />.
Система перекладу позначає як неточні всі переклади, у яких є незакриті дужки. Якщо вам потрібно скористатися незакритими дужками у вашому тексті, будь ласка, додайте дужки у межах теґу коментаря, ось так:
<!--}}-->{{ Рядок
Ще один рядок <!-- {{ --> }}
Це стосується всіх типів дужок, навіть звичайних круглих дужок. (Звичайно ж, зазвичай, варто уникати порожніх рядків з модулем перекладу, — див. Цілісність фрагментів тексту.)
{{Input|1=cmd1 {{!}} cmd2}}. Буде показано: cmd1 | cmd2
{{Input|cmd1 | cmd2}}</wiki></code>, буде показано {{Input|cmd1 | cmd2}}
Тобто вважатиметься, що <code>cmd2</code> є другим параметром шаблону, у нашому прикладі такий параметр просто не використовується.
У багатьох випадках можна просто обмежити фрагмент тексту з вертикальною рискою теґами <nowiki><nowiki>... </nowiki>, ось так: <code>{{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}. Буде показано: cmd1 | cmd2
Всі частини, які можна локалізувати має бути обмежено теґами <translate> і </translate>. Здебільшого, такими фрагментами тексту є і елементи з зображеннями, оскільки ці зображення часто слід замінювати локалізованими версіями, щоб їх могли зрозуміти читачі. Корисно дотримуватися правила: «Сумніваєшся? Краще включи!».
