.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "LOCALE::PO4A::ORG.3PM 1"
.TH LOCALE::PO4A::ORG.3PM 1 2025-11-22 "perl v5.42.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Locale::Po4a::Org \- convert Org documents from/to PO files.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 11
\& [type:org] /path/to/master.org              \e
\&        $lang:/path/to/translation.$lang.org \e
\&        opt:"                                \e
\&        \-\-option skip_keywords=\*(Aq             \e
\&            include                          \e
\&            export_file_name                 \e
\&            link\*(Aq                            \e
\&        \-\-option skip_properties=\*(Aq           \e
\&            copying                          \e
\&            NOBLOCKING                       \e
\&            ORDERED\*(Aq"
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The po4a (PO for anything) project goal is to ease translations (and
more interestingly, the maintenance of translations) using gettext
tools on areas where they were not expected like documentation.
.PP
\&\f(CW\*(C`Locale::Po4a::Org\*(C'\fR is a module to help the translation of
documentation in the Org format, used by the Org
Mode <https://orgmode.org/>.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
.IP \fBskip_keywords\fR 4
.IX Item "skip_keywords"
Space\-separated list of keywords which won\*(Aqt be translated.
.IP \fBskip_properties\fR 4
.IX Item "skip_properties"
Space\-separated list of properties which won\*(Aqt be translated.
.IP \fBskip_heading\fR 4
.IX Item "skip_heading"
If this is a true value, skip translating headings.  When your
translation is converted to Texinfo format, the translation of
headings can cause node names to become bizarre.  This option prevents
that.
.SH "STATUS OF THIS MODULE"
.IX Header "STATUS OF THIS MODULE"
This module is in an early stage of development.  It is tested
successfully on simple Org files, such as the Org Mode Compact
Guide <https://orgmode.org/guide/>.  However 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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLocale::Po4a::TransTractor\fR\|(3pm), \fBpo4a\fR\|(7)
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 1
\& gemmaro <gemmaro.dev@gmail.com>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.Vb 1
\& Copyright © 2024 gemmaro.
.Ve
.PP
This program is free software; you may redistribute it and/or modify it
under the terms of GPL v2.0 or later (see the \fICOPYING\fR file).