Создание учебника по программе

This page is a translated version of the page Writing an Application Manual and the translation is 88% complete.

Outdated translations are marked like this.

Other languages:

Заметки

Учебники будут включены как подчиненные страницы к основной странице программы. Для краткости я буду называть, что главную страницу, как APPNAME . Тогда структура страниц должен быть примерно такой:

Appname
- Appname/Hints and Tips
Appname/Manual # Your Contents page
- Appname/Manual/An Introduction to Appname
- Appname/Manual/Configuration Choices
- Appname/Manual/The First Time you use Appname
- Appname/Manual/section 1
- Appname/Manual/section xxx
- Appname/Manual/Hints and Tips
- Appname/Manual/Troubleshooting
- Appname/Manual/Bug reports
- Appname/Manual/Get involved #link to techbase etc

Если некоторые из разделов учебника становятся слишком большими, вы можете разместить подразделения на отдельных страницах. Структура может быть такой:

Appname/Manual # Your Contents page
- Appname/Manual/An Introduction to Appname
- Appname/Manual/Configuration Choices
- Appname/Manual/The First Time you use Appname
- Appname/Manual/section 1
  - Appname/Manual/section 1/subsection 1
  - Appname/Manual/section 1/subsection 2

and so on.

Информация

Названия страниц не должны точно соответствовать структуре документа. В приведенном выше примере вы можете просто воспользоваться названием Программа/Учебник/"подраздел 2" вместо Программа/Учебник/"раздел 1"/"подраздел 2". То же касается низших уровней иерархии (конечно же, если в процессе названия не дублируются

).

Напоминание

Старайтесь использовать короткие названия и избегать слишком длинных путей в названии. Слишком длинные названия являются трудными для запоминания и введения, они выглядят неуклюже на страницах вики. Всегда помните: названия страниц и структура не влияют на завершенный вид учебника! Он определяется только заголовками в тексте.

Чтобы в автоматически созданном в учебнике в формате Docbook был тот же смысл, что и на UserBase, а ссылки в Docbook работали, следует придерживаться следующих установок:

В содержании учебника в формате Docbook все разделы и подразделы будет показано независимо от того, есть ли у них своя страница. С другой стороны, подразделения высокого уровня вложенности не будет показано, даже если в этих подразделений является собственная страница.

На каждой странице раздела в верхней части должен быть заголовок раздела (== ... ==), подраздела (=== ... ===) или подподраздела(==== ... ====), иначе структура учебника в формате Docbook будет отличаться от задуманного.

Заголовок раздела или подраздела должно точно совпадать с названием страницы, иначе ссылки в Docbook будут работать не так, как это должно быть.

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

Подразделения, которые не должно быть показано на странице содержания, и которые не имеют собственной страницы, в Docbook имеют уровень 4 или ниже, то есть заголовок уровня==== или ниже.

Ссылки на страницах учебника должны точно совпадать с названиями страниц (т.е. не должно быть переименований)

Если вы делаете ссылку на подраздел страницы, вам следует добавить отметку в соответствующем месте страницы. Если вы этого не сделаете, ссылки в переводах не будут работать.

Примечание

В учебнике в формате DocBook каждое подразделение (===) будет иметь отдельную страницу, даже если это подразделение является частью более длинной страницы UserBase. Это означает, что раздел (==), который состоит из нескольких подразделений, но не содержит текста перед первым подразделением, будет иметь страницу Docbook, на которой не будет ничего, кроме ссылок на подразделы.

Напоминание

Если вам захочется изменить заголовок основного подразделения страницы (первый заголовок), важно также изменить соответствующим образом название страницы и все ссылки так, чтобы они совпадали с новым названием.

Напоминание

пожалуйста, не используйте знаки препинания в названиях страниц - знаки препинания, в частности знаки вопроса или точки, является достаточно серьезной проблемой для программного обеспечения вики, в частности системы перевода.

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

Начальный этап написания учебника

На начальном этапе создания вашего учебника лучше держать его отдельно от остальных данных UserBase. Можно редактировать черновики основной и подчиненных страниц на странице обсуждения вашей страницы пользователя. С этой целью нами также предусмотрен особое наименование Draft:.

Чтобы создать страницу содержания вашего учебника, просто укажите в поле адреса вашей программы для просмотра интернет http://userbase.kde.org/Draft:Appname/Manual или вставьте ссылку [[Draft:Appname/Manual]] на страницу, сохраните его, а затем нажмите его. В обоих вариантах действий будет открыта страница с сообщением о том, что страницы не существует, но вы можете создать ее нажатием ссылки.

Содержание

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

Сборка учебника

Воспользуйтесь ссылками красного цвета для создания страниц, создавая разделы учебника один за одним.

Записывайте на странице обсуждения все нужные впоследствии ссылки, в частности ссылки, данные для которых еще не создано.

Напоминание

Во время написания учебника следует придерживаться определенных правил, которые сделают вашу работу однородной:

Следите за заголовками уровней - начинать всегда следует с второго уровня (в Mediawiki первый уровень используется для названия страницы), то есть следует использовать ==

Заглядывайте время от времени на страницы задачи и инструменты и правила форматирования.

Добавляйте пробел после символа вертикальной черты в таблицах. Это правило согласуется с традиционным форматированием вики.

Используйте однородную систему форматирования для названий программ (используйте вместо Amaroks формат Amarok's).

Старайтесь использовать изображения в формате PNG (можно использовать JPEG, но во время создания Docbook скрипт все равно преобразует изображения в формат PNG). Вы можете сэкономить время, если сделаете все правильно от начала .

Не используйте символы Unicode (не ASCII) в названиях изображений.

Formatting considerations

In order for your manual to be translatable into Docbook format there are some restrictions on formatting that should be observed.

Notes and Warnings do not support alternative titles in Docbook. Don't write something like
{{Remember|2=Don't Forget This!|1=You can use...}}
The 2=... part has no meaning in Docbook and the program transforming the wiki page to Docbook might get very confused. Just write
{{Remember|1=You can use...}}

Embed a Video has some limitations in its current implementation: Only YouTube and Vimeo are supported and only one value (the id of the video) can be passed as argument.

Поиск в вашем учебнике

У вас может возникнуть потребность в поиске того, что вы писали раньше, но не помните, где именно. Использование поля поиска вики может будет неидеальным, если вы не ищете нечто очень специфическое. Гораздо лучшие результаты поиска можно получить с помощью расширения DPL. Например, чтобы найти страницы учебника, которые содержат определенную строку, вы можете добавить на любую страницу следующий код и нажать кнопку предварительного просмотра:

<DPL>
  titlematch = %Appname/Manual%
  nottitleregexp = .*((/[a-z][a-z](.|-..)?)|([ _][(][a-z][a-z](...)?[)]))$
  namespace = | Draft
  include = *
  includematch = /string to search for/
  includemaxlength = 0
  resultsheader = Manual Pages:
  format = ,\n* [[%PAGE%|%TITLE%]]\n,,
</DPL>

Другие примеры использования DPL можно найти на странице User:Claus_chr/DPL.

Note

If You are working on the Amarok manual be aware that some of the pages deviate from the normal naming convention. To find matches on all Amarok manual pages use

titlematch = %Amarok/QuickStartGuide%|%Amarok/Manual%

(Note that there can be no space characters on either side of the '|' character)

Приготовления учебника к переводу

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

Создание руководства в DocBook

Как только ваше руководство написано, вы можете иметь его конвертировать его в руководство DocBook, так, что ваша работа может быть использован как обычное руководство KDE. Эта процедура описана на этой странице.