Внесок у dtdocs on darktable user manual

Огляд

Mon, 01 Jan 0001 00:00:00 +0000

На цій сторінці визначено посібник зі стилю для dtdocs та інформацію про те, як зробити свій внесок у проект.

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

Структура та зміст посібника були ретельно обмірковані на основі таких критеріїв:

Посібник повинен бути вичерпним – він повинен описувати всю функціональність, доступну в Darktable
Він повинен мати узгоджену та логічну структуру, і кожен елемент функціональності повинен мати своє логічне місце в цій структурі
Він повинен бути настільки довгим, наскільки це потрібно, але настільки коротким, наскільки це можливо – стислість обов’язкова
Він повинен бути об’єктивним
Функціональність слід пояснити один раз і лише один раз (за винятком вказівок щодо базового робочого процесу в розділі огляду)
Зображення слід включати лише там, де це необхідно для поліпшення розуміння ключових принципів, і вони не повинні містити текст, хіба що цього не уникнути

Нас, як правило, не цікавить:

Розробка та розгортання

Mon, 01 Jan 0001 00:00:00 +0000

Документація Darktable зберігається в репозиторії dtdocs. Зміни вносяться через пул-реквести (див. робочий процес). Переклади підтримуються через Weblate; див. переклади.

🔗Збірка

Повний набір виводів (сайт у форматі HTML, EPUB та PDF-файли для кожної мови) створюється за допомогою ./tools/build-all.sh <базова_адреса>

Це генерує перекладений контент з PO-файлів, потім створює HTML-сайт, EPUB та один PDF-файл для кожної увімкненої мови. Вихідні дані записуються в теку public/, а PDF-файли — у public/<мова>/darktable_user_manual.pdf.

Вимоги: Hugo (розширений), weasyprint та po4a для кроку перекладу.

Робочий процес

Mon, 01 Jan 0001 00:00:00 +0000

Ці інструкції розраховані на те, що у вас вже є обліковий запис GitHub та встановлено Git. Переконайтеся, що git є у вашому PATH, виконавши команду git у будь-якому терміналі або cmd та перевіривши, чи не виводиться помилка, наприклад, “command not found”. Якщо у вас не встановлено git, дотримуйтесь цих інструкцій.

🔗Документування ще недокументованих функцій

Ми особливо зацікавлені в документуванні закритих пул-реквестів, які потребують доповнень або змін до цього посібника. Пул-реквести, що потребують документування, мають мітку GitHub documentation: pending.

Стилі та домовленості

Mon, 01 Jan 0001 00:00:00 +0000

Нижче детально описано стиль написання та домовленості, що використовуються в цьому посібнику.

🔗Формат

Цей веб-сайт створений у чистому markdown, використовуючи деякі розширення. Спочатку він був розроблений для роботи з Hugo SSG, але призначений бути достатньо портативним, щоб його можна було легко опублікувати за допомогою іншої програми, якщо потрібно.

Файли повинні відображатися в UTF-8 і не повинні містити перенесення рядків у параграфах.

🔗Структура

Далі показано структуру прикладу головної глави з підрозділами на веб-сайті dtdocs.

Налаштування перекладів

Mon, 01 Jan 0001 00:00:00 +0000

Переклади документації Darktable підтримуються через Weblate.

🔗Огляд налаштування та потоку інформації для перекладів за допомогою Weblate

Коротко:

Документація зберігається англійською мовою у файлах .md, що знаходяться в content/*.md.
Звідти ведеться POT-файл (po/content.pot) усіх рядків, які можна перекласти.
Weblate підтримує окремі PO-файли для кожної мови (po/content.{мова}.po), які містять перекладені рядки.
Після розгортання документації, файли .md для кожної мови генеруються за допомогою generate-translations.sh, які Hugo потім перетворює на файли .html та варіанти EPUB та PDF.

🔗З GitHub до Weblate: синхронізація джерельних рядків

Оригінальні англійські файли (content/*.md) змінюються через пул-реквест на GitHub (див. робочий процес).

Посібник перекладачів

Mon, 01 Jan 0001 00:00:00 +0000

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

Переклади підтримуються через Weblate. Незареєстровані користувачі можуть додавати пропозиції щодо перекладів. Щоб зробити внесок у переклади, вам потрібно зареєструватися у Weblate.

Ми не приймаємо автоматизовані переклади, виконані за допомогою ШІ, без перевірки людиною та контролю якості.

Рекомендована література:

Посібник зі стилів та домовленостей: Формальності та домовленості щодо створення dtdocs
Налаштування перекладів містить інформацію про те, як дані передаються між репозиторієм dtdocs на GitHub та Weblate.