Посібник користувача модуля

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

Одразу після завершення генерації

Екран завершення (див. генерацію першого модуля) містить розділ User Guide. Відкрийте його, щоб прочитати посібник просто на сторінці, і скористайтеся кнопкою копіювання в його заголовку, щоб скопіювати необроблений текст — зручно для вставлення у вікі чи тікет без попереднього завантаження.

З бібліотеки модулів, у форматі PDF

Відкрийте картку модуля в бібліотеці модулів і натисніть Guide (PDF) поруч із кнопкою Download. Це формує посібник як фірмовий PDF і завантажує його під назвою <module name>_user_guide_<language>.pdf.

Заувага

Кнопка Guide (PDF) з’являється лише тоді, коли модуль має і посібник, і архів, з якого його можна сформувати. Модуль, згенерований до того, як ця можливість з’явилася, постачається без посібника, а якщо ZIP модуля втратив чинність за 90-денним зберіганням, описаним у завантаженні модуля, кнопка зникає навіть для модуля, який його мав — формувати посібник більше нема з чого.

Кілька мов

Якщо під час налаштування запуску ви замовили переклади, OdoMate створює додаткову копію посібника для кожної мови, поряд з англійським оригіналом, який записується завжди, незалежно від того, що ви обрали. PDF, який ви завантажуєте з бібліотеки модулів, відповідає поточній мові інтерфейсу, а якщо посібник не перекладено на неї, використовується англійська — окремо обирати мову не потрібно.

Посібник просто на екрані завершення завжди англомовний, прямо з щойно завершеного запуску; лише PDF, який ви завантажуєте пізніше, відповідає мові інтерфейсу.