LOCALE:...:ORG.3PM(1)

πŸ’– LOCALE:...:ORG.3PM(1) πŸ’–

okay so bestie, welcome to the manual page for LOCALE:...:ORG.3PM(1), straight from the User Contributed Perl Documentation shelf. The title line is folded into this intro so we don't duplicate it β€” main character energy only, periodt. ✨

πŸŽ€ NAME πŸŽ€

Locale::Po4a::Org β€” convert Org documents from/to PO files. that's it, that's the vibe, and it slays πŸ’…

πŸ¦‹ SYNOPSIS πŸ¦‹

here's the exact setup, no cap β€” copy it like your fave playlist:

        [type:org] /path/to/master.org              \
               $lang:/path/to/translation.$lang.org \
               opt:"                                \
               --option skip_keywords='             \
                   include                          \
                   export_file_name                 \
                   link'                            \
               --option skip_properties='           \
                   copying                          \
                   NOBLOCKING                       \
                   ORDERED'"

🌈 DESCRIPTION 🌈

okay so the po4a (PO for anything) project has one goal: make translations β€” and honestly the maintenance of translations β€” way easier by using gettext tools in places nobody expected, like documentation. iconic behavior honestly πŸ‘‘

Locale::Po4a::Org is the module that helps you translate documentation in the Org format, used by Org Mode (https://orgmode.org/). yep, that's the whole cute little mission 🫢

🧚 CONFIGURATION 🧚

bestie, here are the knobs. turn them with care, they're literally options:

skip_keywords

Space-separated list of keywords which won't be translated. that's the whole rule β€” keywords go in, translations stay out πŸ™ˆ

skip_properties

Space-separated list of properties which won't be translated. same energy as above, but for properties ✨

skip_heading

if this is a true value, skip translating headings. why? because when your translation is converted to Texinfo format, translating headings can make node names become bizarre. this option prevents that. thank u, next πŸ’…

πŸ’€ STATUS OF THIS MODULE πŸ’€

ngl, this module is in an early stage of development. it's been tested successfully on simple Org files, such as the Org Mode Compact Guide (https://orgmode.org/guide/). slay for the simple stuff πŸ’–

but it does not support the full Org syntax (https://orgmode.org/worg/org-syntax.html). footnotes and nested plain lists cannot currently be parsed, for example. that's the tea, don't expect it to eat everything yet 😭

πŸŽ€ SEE ALSO πŸŽ€

πŸ‘‘ AUTHORS πŸ‘‘

  • gemmaro <gemmaro.dev@gmail.com>

Copyright Β© 2024 gemmaro.

This program is free software; you may redistribute it and/or modify it under the terms of GPL v2.0 or later (see the COPYING file). periodt, read the license bestie πŸ’œ


byeee 🫢 this page's footer says perl v5.42.0, dated 2025-07-13, and it's signing off as LOCALE:...:ORG.3PM(1) βœ¨πŸ’–

πŸ“¦ where this page comes from