Writing an Application Manual/uk

Нотатки

Підручники буде включено як підлеглі сторінки до основної сторінки програми. Нехай, основна сторінка програми має назву Appname. Тоді структура сторінок має бути десь такою:

• Appname
  • Appname/Hints and Tips
• Appname/Manual # Сторінка змісту
  • 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 # посилання на сторінку techbase тощо

Пам’ятайте!

Будь ласка, не використовуйте знаки пунктуації у назвах сторінок — знаки пунктуації, зокрема знаки запитання або крапки, є доволі серйозною проблемою для програмного забезпечення вікі, зокрема системи перекладу.

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

Developing a Manual

While developing your manual it is usually best to keep it separate from the regular UserBase content. Some prefer to edit their drafts as subpages of their Talk: page. We also have a special Draft: namespace for this purpose.

To create the content page of your manual, simply write http://userbase.kde.org/Draft:Appname/Manual in the address line of your browser, or place the [[Draft:Appname/Manual]] link in a page and then click it. Either way you will be taken to a page telling you that the page does not exist, but that you can create it clicking a link.

Зміст

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

Збирання підручника

• Скористайтеся посиланнями червоного кольору для створення сторінок, створюючи розділи підручника один за одним.

• Занотовуйте на сторінці обговорення всі потрібні згодом посилання, зокрема посилання, дані для яких ще не створено.

Пам’ятайте!

Під час написання підручника варто дотримуватися певних правил, які зроблять вашу роботу однорідною:

• Слідкуйте за заголовками рівнів — починати слід завжди з другого рівня (у Mediawiki перший рівень використовується для назви сторінки), тобто слід використовувати ==

• Зазирайте час від часу на сторінки завдань та інструментів та правил форматування.

• Додавайте пробіл після символу вертикальної риски у таблицях. Це правило узгоджується з традиційним форматуванням вікі.

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

• Намагайтеся використовувати зображення лише у форматі PNG (можна використовувати JPEG (з суфіксом .jpeg, не .jpg), але під час створення Docbook вам доведеться перетворити ці зображення на зображення у форматі PNG). Ви можете зекономити час, якщо зробите все правильно від початку .

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

Searching your manual

At some point, you may need to find something that you wrote earlier, but can't remember where. Using the wiki search box may not be ideal unless the string you search for is very specific. You can get much better control over searches using the DPL extension. For example, to to find the pages in your manual containing a certain string, you can add the following to any page:

<DPL>
  titlematch = %Appname/Manual%
  namespace = Draft
  include = *
  includematch = /string to search for/
  resultsheader = Manual Pages:
  format = ,\n* [[%PAGE%|%TITLE%]]\n,,
</DPL>

You can find more examples on using DPL on User:Claus_chr/DPL.

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

• Кроки з редагування розмітки можна знайти на сторінці приготування сторінки до перекладу. Скористайтеся порадами з цієї сторінки, оскільки застарілі стилі розмітки можуть бути непридатними до використання.