Difference between revisions of "Writing an Application Manual/uk"

Jump to: navigation, search
(Created page with "=== Пошук у вашому підручнику ===")
(Created page with "У вас може виникнути потреба у пошуку чогось, що ви писали раніше, але не пам’ятаєте, де саме. Вико...")
Line 53: Line 53:
 
=== Пошук у вашому підручнику ===
 
=== Пошук у вашому підручнику ===
  
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. Наприклад, щоб знайти сторінки підручника, які містять певний рядок, ви можете додати на будь-яку сторінку такий код і натиснути кнопку попереднього перегляду:
  
 
{{Input|1=<nowiki>
 
{{Input|1=<nowiki>

Revision as of 08:47, 21 August 2011

Other languages:
català • ‎dansk • ‎English • ‎français • ‎русский • ‎українська

Нотатки

Підручники буде включено як підлеглі сторінки до основної сторінки програми. Нехай, основна сторінка програми має назву 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 тощо
Flag-red.png
 
Пам’ятайте!
Будь ласка, не використовуйте знаки пунктуації у назвах сторінок — знаки пунктуації, зокрема знаки запитання або крапки, є доволі серйозною проблемою для програмного забезпечення вікі, зокрема системи перекладу.


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

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

На початковому етапі створення вашого підручника краще тримати його окремо від решти даних UserBase. Можна редагувати чернетки основної та підлеглих сторінок на сторінці обговорення вашої сторінки користувача. З цією метою нами також передбачено особливий прострі назв Draft:.

Щоб створити сторінку змісту вашого підручника, просто вкажіть у полі адреси вашої програми для перегляду інтернету http://userbase.kde.org/Draft:Назва_програми/Назва_підручника або вставте посилання [[Draft:Appname/Manual]] на сторінку, збережіть його, а потім натисніть його. За обох варіантів дій буде відкрито сторінку з повідомленням про те, що сторінки не існує, але ви можете створити її натисканням посилання.

Зміст

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

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

  • Скористайтеся посиланнями червоного кольору для створення сторінок, створюючи розділи підручника один за одним.
  • Занотовуйте на сторінці обговорення всі потрібні згодом посилання, зокрема посилання, дані для яких ще не створено.
Flag-red.png
 
Пам’ятайте!
Під час написання підручника варто дотримуватися певних правил, які зроблять вашу роботу однорідною:
  • Слідкуйте за заголовками рівнів — починати слід завжди з другого рівня (у Mediawiki перший рівень використовується для назви сторінки), тобто слід використовувати ==
  • Використовуйте однорідну систему форматування для назв програм (використовуйте замість Amaroks формат Amarok's).
  • Намагайтеся використовувати зображення лише у форматі PNG (можна використовувати JPEG (з суфіксом .jpeg, не .jpg), але під час створення Docbook вам доведеться перетворити ці зображення на зображення у форматі PNG). Ви можете зекономити час, якщо зробите все правильно від початку 16px.
  • Не використовуйте символи Unicode (не ASCII) у назвах зображень.


Пошук у вашому підручнику

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

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

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

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

Content is available under Creative Commons License SA 4.0 unless otherwise noted.