ການມີສ່ວນຮ່ວມໃນເອກະສານ on darktable user manual

ພາບລວມ

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

ໜ້ານີ້ກຳນົດແນວທາງຮູບແບບ (style guide) ສຳລັບ dtdocs ແລະ ຂໍ້ມູນກ່ຽວກັບວິທີ ການມີສ່ວນຮ່ວມໃນໂຄງການ.

ມັນຖືກລວມໄວ້ໃນຄູ່ມືຜູ້ໃຊ້ເພື່ອໃຫ້ເຈົ້າສາມາດເຫັນວິທີການສະແດງຜົນ ແລະ ວິທີການຂຽນ. ກະລຸນາໄປທີ່ GitHub ເພື່ອເບິ່ງຊອດໂຄດຂອງໜ້ານີ້.

ໂຄງສ້າງ ແລະ ເນື້ອຫາຂອງຄູ່ມືໄດ້ຖືກພິຈາລະນາຢ່າງລະອຽດໂດຍອີງຕາມເກນດັ່ງນີ້:

ຄູ່ມືຄວນຈະຄົບຖ້ວນ – ມັນຄວນຈະອະທິບາຍທຸກຟັງຊັນທີ່ມີໃນ darktable
ມັນຄວນມີໂຄງສ້າງທີ່ສອດຄ່ອງ ແລະ ເປັນເຫດເປັນຜົນ, ແລະ ທຸກໆຟັງຊັນຄວນມີບ່ອນຢູ່ທີ່ເໝາະສົມໃນໂຄງສ້າງນັ້ນ
ມັນຄວນຈະຍາວເທົ່າທີ່ຈຳເປັນ ແຕ່ສັ້ນທີ່ສຸດເທົ່າທີ່ຈະເປັນໄປໄດ້ – ຄວາມກະຊັບແມ່ນສິ່ງສຳຄັນ
ມັນຄວນຈະເປັນກາງ (objective)
ຟັງຊັນຄວນຖືກອະທິບາຍພຽງຄັ້ງດຽວເທົ່ານັ້ນ (ຍົກເວັ້ນຄຳແນະນຳຂັ້ນຕອນການເຮັດວຽກພື້ນຖານໃນສ່ວນພາບລວມ)
ຄວນໃສ່ຮູບພາບສະເພາະບ່ອນທີ່ຈຳເປັນເພື່ອຊ່ວຍໃຫ້ເຂົ້າໃຈຫຼັກການສຳຄັນເທົ່ານັ້ນ ແລະ ບໍ່ຄວນມີຂໍ້ຄວາມໃນຮູບ ຍົກເວັ້ນແຕ່ຫຼີກເວັ້ນບໍ່ໄດ້

ໂດຍທົ່ວໄປແລ້ວ ພວກເຮົາ ບໍ່ ສົນໃຈກ່ຽວກັບ:

ການປັບປ່ຽນໂຄງສ້າງຄູ່ມືໃໝ່
ການປ່ຽນພາສາ markup
ບົດຮຽນສອນວິທີການເຮັດວຽກຢ່າງລະອຽດ (ແຕ່ພວກເຮົາສົນໃຈທີ່ຈະເຜີຍແຜ່ສິ່ງເຫຼົ່ານັ້ນໃນບລັອກຂອງ darktable.org ຫຼື pixls.us)

ພວກເຮົາ ສົນໃຈ ກ່ຽວກັບ

ການແກ້ໄຂການສະກົດຄຳ ແລະ ໄວຍາກອນ
ການປັບປຸງຂໍ້ຄວາມໃຫ້ແຈ້ງຂຶ້ນ
ເອກະສານສຳລັບຟີເຈີໃໝ່

ພວກເຮົາມີຄວາມຍິນດີສະເໝີທີ່ຈະຮັບຟັງວ່າສ່ວນໃດຂອງຄູ່ມືທີ່ເຈົ້າອ່ານແລ້ວບໍ່ເຂົ້າໃຈ ແລະ ຍ້ອນຫຍັງ, ເພື່ອທີ່ພວກເຮົາຈະໄດ້ປັບປຸງເອກະສານໃຫ້ດີຂຶ້ນ.

ໂດຍທົ່ວໄປແລ້ວ, ຖ້າເຈົ້າຕ້ອງການປ່ຽນແປງຄັ້ງໃຫຍ່, ກະລຸນາເປີດ issue ແລະ ປຶກສາກັບຜູ້ເກັບຮັກສາລະບົບກ່ອນ. ສິ່ງນີ້ເພື່ອຫຼີກເວັ້ນການເຮັດວຽກທີ່ຈະບໍ່ຖືກຍອມຮັບ.

🔗ຮູບແບບການສົ່ງ (modality)

ວິທີທີ່ດີທີ່ສຸດແມ່ນການສ້າງ pull request. ເບິ່ງ workflow ສຳລັບຄຳແນະນຳລະອຽດເທື່ອລະຂັ້ນຕອນ.

ການພັດທະນາ ແລະ ການນຳໃຊ້

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

ເອກະສານຂອງ darktable ແມ່ນຖືກເກັບຮັກສາໄວ້ໃນ ຄັງເກັບ dtdocs. ການປ່ຽນແປງຕ່າງໆແມ່ນເຮັດຜ່ານ pull requests (ເບິ່ງ workflow). ສ່ວນການແປພາສາແມ່ນຈັດການຜ່ານ weblate; ເບິ່ງ translations.

🔗ການສ້າງ (Building)

ຊຸດຜົນໄດ້ຮັບທັງໝົດ (ເວັບໄຊ HTML, EPUB, ແລະ PDF ແຕ່ລະພາສາ) ແມ່ນຖືກສ້າງຂຶ້ນໂດຍ ./tools/build-all.sh <base_url>

ສິ່ງນີ້ຈະສ້າງເນື້ອຫາທີ່ແປແລ້ວຈາກໄຟລ໌ PO, ຈາກນັ້ນກໍສ້າງເວັບໄຊ HTML, EPUB, ແລະ PDF ຫນຶ່ງໄຟລ໌ຕໍ່ພາສາທີ່ເປີດໃຊ້. ຜົນໄດ້ຮັບຈະຖືກບັນທຶກ ໄວ້ພາຍໃຕ້ public/, ໂດຍ PDF ຈະຢູ່ທີ່ public/<lang>/darktable_user_manual.pdf.

ຄວາມຕ້ອງການ: Hugo (ຮຸ່ນ extended), weasyprint, ແລະ po4a ສຳລັບ ຂັ້ນຕອນການແປ.

🔗ການນຳໃຊ້ GitHub Pages (ສຳລັບການພັດທະນາ)

ເພື່ອຈຸດປະສົງໃນການພັດທະນາ, ເອກະສານຈະຖືກນຳໃຊ້ໃນ GitHub Pages ທຸກຄັ້ງທີ່ມີການ push: GitHub Action ຈະລັນ tools/build-all.sh ເພື່ອສ້າງ HTML, EPUB ແລະ PDF. ສິ່ງເຫຼົ່ານີ້ຈະຖືກ commit ໄປທີ່ branch gh-pages ຂອງຄັງເກັບ ແລະ ເຜີຍແຜ່ຜ່ານ GitHub Pages ທີ່ https://darktable-org.github.io/dtdocs/. ການສ້າງໜ້າເວັບທີ່ແປພາສາແມ່ນຖືກປິດໄວ້ໃນການນຳໃຊ້ຜ່ານ GitHub pages.

ຂັ້ນຕອນການເຮັດວຽກ

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

ຄຳແນະນຳເຫຼົ່ານີ້ຖືວ່າເຈົ້າມີບັນຊີ github ຢູ່ແລ້ວ ແລະ ໄດ້ຕິດຕັ້ງ Git ແລ້ວນຳ. ໃຫ້ແນ່ໃຈວ່າ git ຢູ່ໃນ PATH ຂອງເຈົ້າ ໂດຍການລັນຄຳສັ່ງ git ໃນ terminal ຫຼື cmd ແລະ ກວດເບິ່ງວ່າມັນບໍ່ໄດ້ແຈ້ງຂໍ້ຜິດພາດ ເຊັ່ນ “command not found”. ຖ້າເຈົ້າຍັງບໍ່ທັນໄດ້ຕິດຕັ້ງ git, ໃຫ້ປະຕິບັດຕາມຄຳແນະນຳນີ້.

🔗ການຂຽນເອກະສານສຳລັບຟີເຈີທີ່ຍັງບໍ່ທັນມີຂໍ້ມູນ

ພວກເຮົາມີຄວາມສົນໃຈເປັນພິເສດໃນການຂຽນເອກະສານສຳລັບ pull request ທີ່ຖືກປິດແລ້ວ ເຊິ່ງຈຳເປັນຕ້ອງເພີ່ມ ຫຼື ປ່ຽນແປງຂໍ້ມູນໃນຄູ່ມືນີ້. Pull request ທີ່ຕ້ອງການເອກະສານຈະຖືກຕິດປ້າຍ label ໃນ GitHub ວ່າ documentation: pending.

ຂັ້ນຕອນຫຼັກໆໃນການເຮັດມີດັ່ງນີ້:

ເບິ່ງລາຍການຂອງ Pull Requests ທີ່ຕ້ອງການເອກະສານ.
ເລືອກ Pull Request ທີ່ເຈົ້າເຂົ້າໃຈວ່າການປ່ຽນແປງນັ້ນແມ່ນຫຍັງ.
ຂຽນການປ່ຽນແປງຕາມລາຍລະອຽດໃນ workflow ດ້ານລຸ່ມ.
ເມື່ອເຈົ້າສ້າງ Pull Request, ໃຫ້ໃສ່ລິ້ງໄປຫາ pull request ຈາກຂັ້ນຕອນທີ 1 ນຳ.

🔗ຂັ້ນຕອນການເຮັດວຽກຂອງເອກະສານ

🔗ການຕັ້ງຄ່າຄັ້ງທຳອິດ

ຖ້າເຈົ້າຍັງບໍ່ທັນໄດ້ຕັ້ງຄ່າ git ໃນເຄື່ອງ, ໃຫ້ໃຊ້ສອງຄຳສັ່ງນີ້ເພື່ອຕັ້ງຄ່າຕົວຕົນຂອງເຈົ້າກ່ອນທີ່ຈະ commit:

ຮູບແບບ ແລະ ຂໍ້ກຳນົດ (styles & conventions)

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

ຕໍ່ໄປນີ້ແມ່ນລາຍລະອຽດກ່ຽວກັບຮູບແບບການຂຽນ ແລະ ຂໍ້ກຳນົດຂອງເອກະສານທີ່ໃຊ້ໃນຄູ່ມືນີ້.

🔗ຮູບແບບ (format)

ເວັບໄຊນີ້ຖືກຂຽນຂຶ້ນດ້ວຍ markdown ແທ້ໆ, ໂດຍໃຊ້ບາງສ່ວນຂະຫຍາຍ. ໃນເບື້ອງຕົ້ນມັນຖືກອອກແບບມາເພື່ອໃຊ້ກັບ Hugo SSG ແຕ່ກໍຕັ້ງໃຈໃຫ້ມັນສາມາດພົກພາໄດ້ງ່າຍ ເພື່ອໃຫ້ສາມາດສະແດງຜົນດ້ວຍແອັບພລິເຄຊັນອື່ນໄດ້ຫາກຈຳເປັນ.

ໄຟລ໌ຄວນຖືກສະແດງຜົນໃນຮູບແບບ UTF-8 ແລະ ບໍ່ຄວນມີການຂຶ້ນແຖວໃໝ່ (column wrapping) ພາຍໃນປະໂຫຍກ.

🔗ໂຄງສ້າງ

ຕໍ່ໄປນີ້ແມ່ນຕົວຢ່າງໂຄງສ້າງຂອງບົດຫຼັກທີ່ມີບົດຍ່ອຍໃນເວັບໄຊ dtdocs.

example-chapter/
   _index.md
   section1-with-subsections/
      subsection1/
         image.png
      _index.md
      subsection1.md
      subsection2.md
   section2.md
   section3.md

ບາງຂໍ້ສັງເກດກ່ຽວກັບໂຄງສ້າງຂ້າງເທິງ:

ໄຟລ໌ _index.md ຈະບໍ່ມີເນື້ອຫາໃດໆ (ມີພຽງແຕ່ metadata ເທົ່ານັ້ນ) ແລະ ຖືກໃຊ້ເພື່ອສະແດງຫົວຂໍ້ພາກສ່ວນ ແລະ ລາຍການໃນສານບານ (ToC). ໃນຕົວຢ່າງຂ້າງເທິງ example-chapter/_index.md ກຳນົດຊື່ຂອງບົດຕົວຢ່າງ ແລະ ລຳດັບທີ່ຈະປາກົດໃນສານບານຫຼັກ. ໃນທຳນອງດຽວກັນ example-chapter/section1-with-subsections/_index.md ກໍກຳນົດ metadata ສຳລັບພາກສ່ວນທຳອິດຂອງບົດ.
ໄຟລ໌ສື່ (Media files) ຄວນຖືກເກັບໄວ້ໃນໂຟນເດີທີ່ມີຊື່ດຽວກັນກັບ ໜ້າທີ່ມັນກ່ຽວຂ້ອງ. ໃນຕົວຢ່າງນີ້, example-chapter/section1-with-subsections/subsection1 ມີສື່ທີ່ກ່ຽວຂ້ອງກັບໜ້າ subsection1.md.

🔗ຂໍ້ມູນເສີມ (metadata)

Metadata ສຳລັບໄຟລ໌ markdown ແມ່ນຢູ່ສ່ວນຫົວຂອງໜ້າໂດຍໃຊ້ yaml. ສາມາດກຳນົດ metadata ໃດໆກໍໄດ້ – ສ່ວນການອ້າງອີງໂມດູນຈະມີ metadata ສະເພາະຂ້ອນຂ້າງຫຼາຍ – ແນວໃດກໍຕາມ ຕົວຢ່າງລຸ່ມນີ້ແມ່ນ metadata ພື້ນຖານສຳລັບໜ້າ example-chapter/section1-with-subsections/subsection1.md.

ການຕັ້ງຄ່າການແປພາສາ

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

ການແປເອກະສານຂອງ darktable ແມ່ນຖືກຈັດການຜ່ານ Weblate.

🔗ພາບລວມຂອງການຕັ້ງຄ່າ ແລະ ການໄຫຼຂອງຂໍ້ມູນສຳລັບການແປໂດຍໃຊ້ Weblate

ສະຫຼຸບໂດຍຫຍໍ້:

ເອກະສານຫຼັກແມ່ນເປັນພາສາອັງກິດໃນໄຟລ໌ .md ທີ່ຢູ່ໃນ content/*.md.
ຈາກນັ້ນ ໄຟລ໌ POT (po/content.pot) ທີ່ລວມເອົາຂໍ້ຄວາມ ທີ່ສາມາດແປໄດ້ ທັງໝົດຈະຖືກສ້າງຂຶ້ນ.
Weblate ຈະຈັດການໄຟລ໌ PO ຂອງແຕ່ລະພາສາ (po/content.{lang}.po) ເຊິ່ງບັນຈຸຂໍ້ຄວາມ ທີ່ແປແລ້ວ.
ເມື່ອນຳເອກະສານໄປໃຊ້, ໄຟລ໌ .md ສະເພາະແຕ່ລະພາສາຈະຖືກສ້າງຂຶ້ນໂດຍໃຊ້ generate-translations.sh ເຊິ່ງ Hugo ຈະນຳໄປສະແດງຜົນເປັນໄຟລ໌ .html, EPUB ແລະ PDF ຕໍ່ໄປ.

🔗ຈາກ GitHub ຫາ Weblate: ການຊິງໂຄຣໄນຂໍ້ຄວາມຕົ້ນສະບັບ

ໄຟລ໌ພາສາອັງກິດຕົ້ນສະບັບ (content/*.md) ຖືກປ່ຽນແປງຜ່ານ pull request ໃນ GitHub (ເບິ່ງ workflow).
GitHub action ທີ່ເຮັດວຽກທຸກຄືນຈະອັບເດດໄຟລ໌ POT (po/content.pot) ທີ່ລວມຂໍ້ຄວາມທັງໝົດດ້ວຍຄຳສັ່ວ generate-translations.sh --no-translations. ໝາຍເຫດ: ສະຄຣິບຈະອັບເດດທັງໄຟລ໌ POT ແລະ PO ແຕ່ພວກເຮົາຈະບໍ່ commit ໄຟລ໌ PO ທີ່ອັບເດດແລ້ວລົງໃນຄັງເກັບ ເນື່ອງຈາກໄຟລ໌ PO ຖືກຈັດການໂດຍ Weblate ທັງໝົດເພື່ອຫຼີກເວັ້ນບັນຫາ merge conflicts.

ຄູ່ມືສຳລັບຜູ້ແປພາສາ

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

ພວກເຮົາຍິນດີຕ້ອນຮັບເຈົ້າເຂົ້າສູ່ການຊ່ວຍແປເອກະສານຂອງ darktable. ກະລຸນາອ່ານຄູ່ມືນີ້ໃຫ້ລະອຽດເພື່ອສຶກສາຂໍ້ກຳນົດ ແລະ ຄວາມຕ້ອງການສຳລັບວຽກງານການແປ.

ການແປພາສາແມ່ນຖືກຈັດການຜ່ານ Weblate. ຜູ້ໃຊ້ທີ່ບໍ່ໄດ້ລົງທະບຽນສາມາດເພີ່ມຄຳແນະນຳໃນການແປໄດ້. ຫາກຕ້ອງການມີສ່ວນຮ່ວມໃນການແປ, ເຈົ້າຕ້ອງ ລົງທະບຽນກັບ Weblate ກ່ອນ.

ພວກເຮົາ ບໍ່ ຍອມຮັບການແປດ້ວຍ AI ແບບອັດຕະໂນມັດ ໂດຍບໍ່ຜ່ານການກວດສອບ ແລະ ຄວບຄຸມຄຸນນະພາບໂດຍມະນຸດ.

ສິ່ງທີ່ຄວນອ່ານ:

ຄູ່ມືສຳລັບ styles and conventions: ລະບຽບການ ແລະ ຂໍ້ກຳນົດກ່ຽວກັບວິທີການເຮັດ dtdocs
Translations setup ປະກອບມີຂໍ້ມູນກ່ຽວກັບການໄຫຼຂອງຂໍ້ມູນລະຫວ່າງ ຄັງເກັບ dtdocs ໃນ github ແລະ Weblate
ເອກະສານກ່ຽວກັບວິທີການ ໃຊ້ weblate

ໄປທີ່ projects page ເພື່ອເບິ່ງວ່າພາສາໃດທີ່ຕ້ອງການຄວາມຊ່ວຍເຫຼືອ ແລະ ເລືອກພາສາທີ່ເຈົ້າຊຳນານ. ຈາກນັ້ນເຈົ້າສາມາດເລີ່ມວຽກການແປໄດ້ໂດຍການເລືອກໝວດໝູ່ໃດໜຶ່ງ (ເຊັ່ນ “Untranslated strings”).

ຖ້າເຈົ້າຕ້ອງການຮູ້ວ່າຂໍ້ຄວາມທີ່ແປໄດ້ນັ້ນຢູ່ໃນສ່ວນໃດຂອງເອກະສານ, ເຈົ້າສາມາດກວດສອບໄດ້ທີ່ string information ແລ້ວໄປທີ່ details ຢູ່ເບື້ອງຂວາມື.

When translating, always preserve the original Markdown formatting — bold, italics, links, and shortcodes must appear in the translated string exactly as they do in the source.