blob: 2ea6d9c544d170083c5d46caabc7b9ea6159901a [file] [log] [blame]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<title>@documentlanguage (GNU Texinfo 6.8dev)</title>
<meta name="description" content="@documentlanguage (GNU Texinfo 6.8dev)">
<meta name="keywords" content="@documentlanguage (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Internationalization.html" rel="up" title="Internationalization">
<link href="_0040documentencoding.html" rel="next" title="@documentencoding">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="g_t_0040documentlanguage">
<div class="nav-panel">
<p>
Next: <a href="_0040documentencoding.html" accesskey="n" rel="next"><code class="code">@documentencoding <var class="var">enc</var></code>: Set Input Encoding</a>, Up: <a href="Internationalization.html" accesskey="u" rel="up">Internationalization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="g_t_0040documentlanguage-ll_005b_005fcc_005d_003a-Set-the-Document-Language">14.1 <code class="code">@documentlanguage <var class="var">ll</var>[_<var class="var">cc</var>]</code>: Set the Document Language</h3>
<a class="anchor" id="documentlanguage"></a>
<a class="index-entry-id" id="index-documentlanguage"></a>
<a class="index-entry-id" id="index-Language_002c-declaring"></a>
<a class="index-entry-id" id="index-Locale_002c-declaring"></a>
<a class="index-entry-id" id="index-Document-language_002c-declaring"></a>
<p>The <code class="code">@documentlanguage</code> command declares the current document
locale. Write it on a line by itself, near the beginning of the file.
</p>
<div class="example">
<pre class="example-preformatted">@documentlanguage <var class="var">ll</var>[_<var class="var">cc</var>]
</pre></div>
<p>Include a two-letter ISO&nbsp;639-2 language code (<var class="var">ll</var>) following
the command name, optionally followed by an underscore and two-letter
ISO&nbsp;3166 two-letter country code (<var class="var">cc</var>). If you have a
multilingual document, the intent is to be able to use this command
multiple times, to declare each language change. If the command is
not used at all, the default is <code class="code">en_US</code> for US English.
</p>
<p>As with GNU Gettext (see <cite class="cite"><a data-manual="gettext" href="https://www.gnu.org/software/gettext/manual/html_node/index.html#Top">Gettext</a></cite>), if the country
code is omitted, the main dialect is assumed where possible. For
example, <code class="code">de</code> is equivalent to <code class="code">de_DE</code> (German as spoken in
Germany).
</p>
<a class="index-entry-id" id="index-Document-strings_002c-translation-of"></a>
<p>For Info and other online output, this command changes the translation
of various <em class="dfn">document strings</em> such as &ldquo;see&rdquo; in cross-references
(see <a class="pxref" href="Cross-References.html">Cross-references</a>), &ldquo;Function&rdquo; in defuns (see <a class="pxref" href="Definition-Commands.html">Definition Commands</a>), and so on. Some strings, such as &ldquo;Node:&rdquo;, &ldquo;Next:&rdquo;,
&ldquo;Menu:&rdquo;, etc., are keywords in Info output, so are not translated
there; they are translated in other output formats.
In DocBook output <code class="code">@documentlanguage</code> sets the language for
following sections.
</p>
<a class="index-entry-id" id="index-txi_002dcc_002etex"></a>
<p>For TeX, this command causes a file <samp class="file">txi-<var class="var">locale</var>.tex</samp> to
be read (if it exists). If <code class="code">@documentlanguage</code> argument
contains the optional &lsquo;<samp class="samp">_<var class="var">cc</var></samp>&rsquo; suffix, this is tried first.
For example, with <code class="code">@documentlanguage de_DE</code>, TeX first looks
for <samp class="file">txi-de_DE.tex</samp>, then <samp class="file">txi-de.tex</samp>.
</p>
<p>Such a <samp class="file">txi-*</samp> file is intended to redefine the various English
words used in TeX output, such as &lsquo;Chapter&rsquo;, &lsquo;See&rsquo;, and so on. We
are aware that individual words like these cannot always be translated
in isolation, and that a very different strategy would be required for
ideographic (among other) scripts. Help in improving Texinfo&rsquo;s
language support is welcome.
</p>
<a class="index-entry-id" id="index-Hyphenation-patterns_002c-language_002ddependent"></a>
<p><code class="code">@documentlanguage</code> also changes TeX&rsquo;s current hyphenation
patterns, if the TeX program being run has the necessary support
included. This will generally not be the case for <code class="command">tex</code>
itself, but will usually be the case for up-to-date distributions of
the extended TeX programs <code class="command">etex</code> (DVI output) and
<code class="command">pdftex</code> (PDF output). <code class="command">texi2dvi</code> will use the
extended TeXs if they are available (see <a class="pxref" href="Format-with-texi2dvi.html">Format with <code class="command">texi2dvi</code></a>).
</p>
<a class="index-entry-id" id="index-ISO-639_002d2-language-codes"></a>
<a class="index-entry-id" id="index-ISO-3166-country-codes"></a>
<a class="index-entry-id" id="index-Language-codes"></a>
<a class="index-entry-id" id="index-Country-codes"></a>
<p>Since the lists of language codes and country codes are updated
relatively frequently, we don&rsquo;t attempt to list them here. The valid
language codes are on the official home page for ISO&nbsp;639,
<a class="url" href="http://www.loc.gov/standards/iso639-2/">http://www.loc.gov/standards/iso639-2/</a>. The country codes and
the official web site for ISO&nbsp;3166 can be found via
<a class="url" href="http://en.wikipedia.org/wiki/ISO_3166">http://en.wikipedia.org/wiki/ISO_3166</a>.
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="_0040documentencoding.html"><code class="code">@documentencoding <var class="var">enc</var></code>: Set Input Encoding</a>, Up: <a href="Internationalization.html">Internationalization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>