Редактирование разметки

Other languages:

Доступные инструменты

На странице руководства по форматированию приведены указания для стандартного форматирования, которые используются для облегчения перевода, и преобразования в официальные учебники (DocBook). Пожалуйста, обращайтесь к этой странице чаще, поскольку, возможно, форматирование будет улучшаться с целью упрощения перевода страниц.

Первый этап обработки 1

Исправления устаревшего форматирования

После каждого из заголовков разделов и подразделов должно быть добавлено пустая строка.

На многих страницах для форматирования отступов используются несколько пробелов. Такое форматирование было использовано в устаревшей документации к mediawiki. Впрочем, сейчас это форматирование не используется по причине проблемы с экспортом данных в другие форматы. Поэтому старайтесь заменить такие отступления отступлениями в один пробел. В неупорядоченных списках можно использовать вложенные списки.

Эмоции (смайлики) символами ASCII вызывают проблемы, поэтому от них следует избавляться. Такие эмоции можно заменить пиктограммами Oxygen малого размера (11px?), - можно воспользоваться шаблоном {{Smiley}} . Другие изображения можно найти вWikimedia Commons.

Внутренние ссылки в формате [[Translation Workflow]] следует указывать полностью: ссылки, потом видимый текст, например [[Special:myLanguage/Translation_Workflow|Translation Workflow]]

Для показа текста, который должен быть введен пользователем, использовалось различное форматирование, в частности <code>, <pre>, таблицы и панели. Теперь следует использовать для этого шаблон вики, {{Input|1=текст (может быть многострочной или однострочном)}}. Для коротких фрагментов можно использовать <code>, если текст должен быть размещен в одном блоке с другим текстом.

Для показа данных, выведенных в терминал, и сообщений об ошибках также использовались различные способы. Теперь же, следует использовать шаблон вывода: {{Output|1=данные, выведенные в терминал}}

На каждой из страниц должна быть плашка категории. Перечень категорий должен быть стандартизирован. С текущим списком категорий можно ознакомиться на любой из страниц переводчиков, ссылки на которые размещены на этой странице.

Make sure that there are no unbalanced brackets in any section. If you find unbalanced brackets then add the missing bracket(s) — possibly in a comment like this:
```
 a)
```

There should be a blank line between bullets in lists. See the sections on lists beginning with Bulleted Lists.

Tables should be split in a similar manner, so that there is a blank line between each row. The first and last items will need to have curly braces balanced.

The old method of beginning a line with a colon (":") to denote an indent causes some serious display problems, not least the navigation panel disappearing to beneath the rest of the content. If you find any such lines, please remove the colon.

Stage 2 - Guide to new markup

Marking Links for Translation

A stand-alone link, such as the application-names in Applications/Internet, should use the form [[Special:myLanguage/Ark|<translate>Ark</translate>]]

Where the link is within a sentence the whole of the link should be kept within the translatable message.

Marking sections for subpage linking

Links of the form [[OtherPage#Section|...]] do not work well with the translation system. Whenever you come across this kind of links there are a few things, that must be done:

The links itself should be changed in the usual way to [[Special:myLanguage/OtherPage#Section|...]]

In the page 'OtherPage' you should check that there is an anchor right before the section 'Section'. It should have the form
```
</translate><span id="Section"></span><translate>
```
(where of course the string "Section" should be the actual title of the section). There should be a blank line between the anchor and the section header.

Some pages have links to their own sections - often of the form [[#Section|...]]. These links should be changed just like all other subpage links to [[Special:myLanguage/ThisPage#Section|...]] (assuming the name of the page is 'ThisPage'); and do remember to check, that the corresponding anchor exists!

If the page 'OtherPage' is not marked up for translation yet then you should omit the <translate> and </translate> tags.

If a paragraph is moved or removed, take the corresponding tags with it.

Special Tags

Identify all keyboard key-names, and tag, e.g. <keycap>Enter</keycap>
Include concurrent keypresses in the <keycap> tag, e.g. Ctrl + Alt + F1. Note that the separator is (space)+(space)
Treat menu sequences in a similar manner, using the <menuchoice> tag, e.g.System Settings -> Account Details -> Social Desktop. Note that the separator is (space)->(space)

Warning

NEVER add translate section tags (the ones that look like ). The software will do any handling of tags that is required, and manually changing them will break the system.

Bold type

Identify program names and mark them as bold type, e.g. Klipper
Identify labels and names that cannot be changed by the user, and mark them as bold type.
Remove any bold type marking that were previously entered, but do not match this guideline. (See below for emphasizing a word or phrase.)
Window captions and Icon labels are also marked as bold type.

Italics

Italics can be used to give emphasis as you might in non-technical writing
Use italics on the first appearance of an unfamiliar word or phrase, and if possible link it to #Glossary or a dictionary entry.
When referencing other (external) works, titles are italicized.

Combined Bold and Italics

This should only be used in the context of an example where the user has to substitute text, e.g. "Your new addressbook records are in /home/user/share/contacts"

Tip

Simplified definitions - Programs are launched by users, components are used by programs

Issues that cause Translate problems

Several issues have been identified and discussed, and solutions proposed in the following sections:

These are usually noticed after the first markup, and it may be necessary to re-arrange spacing and/or structure to avoid the problems.

Almost finished

In the summary field at the bottom, enter that you are doing a markup edit.
Use Preview and read through the whole of your work. If you are satisfied, save the page.
Use the link in the sidebar to request release - it takes you to a page where you can add the URL of the page you have edited. Pasting your link there tells us that you believe the page to be ready for translators to work with. We will scan it, and if satisfied we will enable it for translation.