Створення підручника з програми

From KDE Wiki Sandbox
Revision as of 16:12, 30 July 2018 by Yurchor (talk | contribs) (Created page with "* Вбудовування відео у поточній реалізації має певні обмеження: можна в...")
Other languages:

Нотатки

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

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

  • Назва_програми/Manual # Сторінка змісту
    • Назва_програми/Manual/An Introduction to Назва_програми
    • Назва_програми/Manual/Configuration Choices
    • Назва_програми/Manual/The First Time you use Назва_програми
    • Назва_програми/Manual/розділ 1
      • Назва_програми/Manual/розділ 1/підрозділ 1
      • Назва_програми/Manual/розділ 1/підрозділ 2

тощо.

Інформація
Назви сторінок не повинні точно відповідати структурі документа. У наведеному вище прикладі ви можете просто скористатися назвою Програма/Підручник/підрозділ 2 замість Програма/Підручник/розділ 1/підрозділ 2. Те саме стосується нижчих рівнів ієрархії (звичайно ж, якщо у процесі назви не дублюються ).


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


Щоб у автоматично створеному підручнику у форматі Docbook був той самий зміст, що і на UserBase, а посилання у Docbook працювали, варто дотримуватися таких настанов:

  • У змісті підручника у форматі Docbook всі розділи і підрозділи буде показано незалежно від того, чи є у них власна сторінка. З іншого боку, підрозділи високого рівня вкладеності не буде показано, навіть якщо у цих підрозділів є власна сторінка.
  • На кожній сторінці розділу у верхній частині має бути заголовок, розділу (== ... ==), підрозділу (=== ... ===) або підпідрозділу (==== ... ====), інакше структура підручника у форматі Docbook відрізнятиметься від задуманої.
  • Заголовок розділу або підрозділу має точно збігатися з назвою сторінки, інакше посилання у Docbook працюватимуть не так, як це має бути.
  • Назви підрозділів має бути записано так: ===Назва===, навіть якщо цей розділ є розділом найвищого рівня на сторінці. Якщо не дотримуватися цього правила, структуру Docbook буде спотворено. Так само, якщо у вашому підручнику є дуже довгі підрозділи, які поділено на окремі сторінки, кожна з таких сторінок повинна мати власний заголовок у такому форматі: ====Назва====.
  • Підрозділи, які не має бути показано на сторінці змісту, і які не мають власної сторінки, у Docbook мають рівень 4 або нижче, тобто заголовок рівня ==== або нижче.
  • Посилання на сторінках підручника мають точно збігатися з назвами сторінок (тобто не повинно бути переспрямувань)
  • Якщо ви робите посилання на підрозділ сторінки, вам слід додати позначку на відповідному місці сторінки. Якщо ви цього не зробите, посилання у перекладах не працюватимуть.
Зауваження
У підручнику у форматі DocBook кожен підрозділ (===) матиме окрему сторінку, навіть якщо цей підрозділ є частиною довшої сторінки UserBase. Це означає, що розділ (==), який складається з декількох підрозділів, але не містить тексту перед першим підрозділом, матиме сторінку Docbook, на якій не буде нічого, окрім посилань на підрозділи.


Пам’ятайте!
Якщо вам захочеться змінити заголовок основного підрозділу сторінки (перший заголовок), важливо також змінити відповідним чином назву сторінки та всі посилання так, щоб вони збігалися з новою назвою.


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


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

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

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

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

Зміст

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

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

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


Правила форматування

Якщо ви маєте наміт перетворити підручник до придатного до перекладу формату Docbook, слід взяти до уваги деякі обмеження щодо форматування.

  • Нотатки і попередження у Docbook не можуть мати альтернативних назв. Не пишіть чогось подібного до
    {{Remember|2=Don't Forget This!|1=You can use...}}
    Частину 2=... у Docbook буде пропущено. Скрипт перетворення сторінки вікі у Docbook може не спрацювати як слід. Просто напишіть
    {{Remember|1=You can use...}}
  • Вбудовування відео у поточній реалізації має певні обмеження: можна вбудовувати лише відео з YouTube та Vimeo і можна передавати лише один аргумент (ідентифікатор відео).

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

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

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

Інші приклади використання DPL можна знайти на сторінці User:Claus_chr/DPL.

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

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

Створення підручника у форматі DocBook

Щойно роботу над створеним вами підручником буде завершено, ви можете перетворити його на підручник у форматі DocBook, щоб ним можна було користуватися як звичайним підручником до програми KDE. Докладний опис перетворення можна знайти на цій сторінці.

Retrieved from "https://wikisandbox.kde.org/index.php?title=Writing_an_Application_Manual/uk&oldid=398334"