% git clone https://git.FreeBSD.org/doc.git ~/doc
Chapter 8. Translations
Table of Contents
This is the FAQ for people translating the FreeBSD documentation (FAQ, Handbook, tutorials, manual pages, and others) to different languages.
It is very heavily based on the translation FAQ from the FreeBSD German Documentation Project, originally written by Frank Gründer firstname.lastname@example.org and translated back to English by Bernd Warken email@example.com.
8.1. What do i18n and l10n mean?
i18n means internationalization and l10n means localization. They are just a convenient shorthand.
i18n can be read as "i" followed by 18 letters, followed by "n". Similarly, l10n is "l" followed by 10 letters, followed by "n".
8.2. Is there a mailing list for translators?
Yes. Different translation groups have their own mailing lists. The list of translation projects has more information about the mailing lists and web sites run by each translation project. In addition there is firstname.lastname@example.org for general translation discussion.
8.3. Are more translators needed?
Yes. The more people that work on translation the faster it gets done, and the faster changes to the English documentation are mirrored in the translated documents.
You do not have to be a professional translator to be able to help.
8.4. What languages do I need to know?
Ideally, you will have a good knowledge of written English, and obviously you will need to be fluent in the language you are translating to.
English is not strictly necessary. For example, you could do a Hungarian translation of the FAQ from the Spanish translation.
8.5. What software do I need to know?
It is strongly recommended that you maintain a local copy of the FreeBSD Git repository (at least the documentation part). This can be done by running:
git.FreeBSD.org is a public
This will require the git-lite package to be installed.
You should be comfortable using git. This will allow you to see what has changed between different versions of the files that make up the documentation.
For example, to view the differences between revisions
2191c44469 of documentation/content/en/articles/committers-guide/_index.adoc, run:
% git diff abff932fe8 2191c44469 documentation/content/en/articles/committers-guide/_index.adoc
Please see the complete explanation of using Git in FreeBSD in the FreeBSD Handbook.
8.6. How do I find out who else might be translating to the same language?
The Documentation Project translations page lists the translation efforts that are currently known about. If others are already working on translating documentation to your language, please do not duplicate their efforts. Instead, contact them to see how you can help.
If no one is listed on that page as translating for your language, then send a message to the FreeBSD documentation project mailing list in case someone else is thinking of doing a translation, but has not announced it yet.
8.7. No one else is translating to my language. What do I do?
Congratulations, you have just started the "FreeBSD your-language-here Documentation Translation Project". Welcome aboard.
First, decide whether or not you have got the time to spare. Since you are the only person working on your language at the moment it is going to be your responsibility to publicize your work and coordinate any volunteers that might want to help you.
Write an email to the Documentation Project mailing list, announcing that you are going to translate the documentation, so the Documentation Project translations page can be maintained.
If there is already someone in your country providing FreeBSD mirroring services you should contact them and ask if you can have some webspace for your project, and possibly an email address or mailing list services.
Then pick a document and start translating. It is best to start with something fairly small - either the FAQ, or one of the tutorials.
8.8. I have translated some documentation, where do I send it?
That depends. If you are already working with a translation team (such as the Japanese team, or the German team) then they will have their own procedures for handling submitted documentation, and these will be outlined on their web pages.
If you are the only person working on a particular language (or you are responsible for a translation project and want to submit your changes back to the FreeBSD project) then you should send your translation to the FreeBSD project (see the next question).
8.9. I am the only person working on translating to this language, how do I submit my translation?
First, make sure your translation is organized properly. This means that it should drop into the existing documentation tree and build straight away.
Directories below this are named according to the language code they are written in, as defined in ISO639 (/usr/share/misc/iso639 on a version of FreeBSD newer than 20th January 1999).
Hugo need the language codes in lowercase.
For example, instead of
Currently, the FreeBSD documentation is stored in a top level directory called documentation/. Directories below this are named according to the language code they are written in, as defined in ISO639 (/usr/share/misc/iso639 on a version of FreeBSD newer than 20th January 1999).
If your language can be encoded in different ways (for example, Chinese) then there should be directories below this, one for each encoding format you have provided.
Finally, you should have directories for each document.
For example, a hypothetical Swedish translation might look like:
documentation/ content/ sv/ books/ faq/ _index.adoc
sv is the name of the translation, in lang form.
Note the two Makefiles, which will be used to build the documentation.
Use git diff command to generate a diff and send it to the reviews system.
% git diff > sv-faq.diff
You should use Bugzilla to submit a report indicating that you have submitted the documentation. It would be very helpful if you could get other people to look over your translation and double check it first, since it is unlikely that the person committing it will be fluent in the language.
Someone (probably the Documentation Project Manager, currently Documentation Engineering Team <doceng@FreeBSD.org>) will then take your translation and confirm that it builds. In particular, the following things will be looked at:
makein the root directory work correctly?
If there are any problems then whoever is looking at the submission will get back to you to work them out.
If there are no problems your translation will be committed as soon as possible.
8.10. Can I include language or country specific text in my translation?
We would prefer that you did not.
For example, suppose that you are translating the Handbook to Korean, and want to include a section about retailers in Korea in your Handbook.
There is no real reason why that information should not be in the English (or German, or Spanish, or Japanese, or …) versions as well. It is feasible that an English speaker in Korea might try to pick up a copy of FreeBSD whilst over there. It also helps increase FreeBSD’s perceived presence around the globe, which is not a bad thing.
If you have country specific information, please submit it as a change to the English Handbook (using Bugzilla) and then translate the change back to your language in the translated Handbook.
8.10.1. Addressing the reader
In the English documents, the reader is addressed as "you", there is no formal/informal distinction as there is in some languages.
If you are translating to a language which does distinguish, use whichever form is typically used in other technical documentation in your language. If in doubt, use a mildly polite form.
8.10.2. Do I need to include any additional information in my translations?
The header of the English version of each document will look something like this:
--- title: Why you should use a BSD style license for your Open Source Project releaseinfo: "$FreeBSD: head/en_US.ISO8859-1/articles/bsdl-gpl/article.xml 53942 2020-03-01 12:23:40Z carlavilla $" trademarks: ["freebsd", "intel", "general"] --- = Why you should use a BSD style license for your Open Source Project
The exact boilerplate may change, but it will always include a $FreeBSD$ line and the phrase
The FreeBSD Documentation Project.
Note that the $FreeBSD$ part is expanded automatically by Git, so it should be empty (just
$FreeBSD$) for new files.
Your translated documents should include their own FreeBSD line, and change the
FreeBSD Documentation Project line to
The FreeBSD language Documentation Project.
In addition, you should add a third line which indicates which revision of the English text this is based on.
So, the Spanish version of this file might start:
--- title: Soporte para segundos intercalares en FreeBSD releaseinfo: "$FreeBSD: head/es_ES.ISO8859-1/articles/leap-seconds/article.xml 53090 2019-06-01 17:52:59Z carlavilla $" --- = Soporte para segundos intercalares en FreeBSD
Last modified on: December 11, 2021 by Sergio Carlavilla Delgado