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

Other languages:

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

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

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

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

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

Приклад:

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

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

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

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

Приклади:

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

Підказка

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

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

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

Some examples:

To connect to your remote server, type ssh [email protected] in Konsole.
In rpm-based distributions, the command rpm -q packagename will result in package-version-release.

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

Code should be presented in mono-spaced text, usually boxed, as shown below. Input text will be on a pale yellow background. For output text, the background colour will be violet-grey.

Для програмного коду (окремих рядків чи блоків) слід використовувати шаблони для забезпечення однорідності.

Use the Input template like this:

{{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>}}

This will display like this:

qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
rm -r ~/.kde/share/apps/nepomuk
rm -r ~/.kde4/share/apps/nepomuk
nepomukserver

Output works the same way:

{{Output|1=<nowiki>terminal output 
is also shown as code, 
but on a grey background</nowiki>}}

which displays as

terminal output 
is also shown as code, 
but on a grey background

Note

Note the use of 1=<nowiki> some text </nowiki> to avoid situations that break the display format

Starting an Input or Output template on a new line will break the display format if it is within lists. Simply continue on the same line if you need to correct this.

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" );

Single code words can be kept in-line by using
```
<code></code>
```
It will display like this.

```
<tt> </tt>
```
is useful for displaying filenames and paths. This looks like this: a/path/to/here

Цитування

The tags <blockquote> and </blockquote> should be used when quoting other works or other pages. This produces a proportional italic font, with some padding.

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

Text in Section Headers

Even though the criteria above may be met, do not use Bold text in section headers or in links.

Text in Information, Note, Tip or Warning Templates

Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.

Lists

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

Keeping things together

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 />.

Unbalanced brackets

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.)

Special Tags

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