Handbook translating

From PC-BSD Wiki
Revision as of 15:16, 22 December 2013 by Tigersharke (Talk | contribs)

Jump to: navigation, search


Anyone is welcome to help with translating the handbook into other languages. MediaWiki can now be used for the translation work of version 9.2 and may be the method used in the future, although the old method could still be used but at a cost of delayed access. The mediawiki method may be the quickest to make available to the public.


The task should be as simple as choosing through the mediawiki link "translate this page" and selecting the desired language. Then use the mediawiki mechanism to do your work.

  • leave the UseTOC line as is (paste source text and "save translation" for that line) if there is no "title=<translate what is here>" portion.
  • It may be considered the most important step, to localize all of the page titles for those pages listed in the Template:Phrase-table of contents of the PC-BSD®_Users_Handbook because that section will automagically "import" those translated page titles.
  • Page links that use template:local such as {{local|link=handbook translating}} will appear as localized links if their page title has been translated, and more complex links also work, such as {{local|static=Warden®/{{release}}|anchor=Using Template Manager|Template Manager}} are displayed as Template Manager.

Caveat: Although no explanation may be given, if a page previously marked to be translated (especially the templates for "word-.." or "phrase-.." which are used by the Navigation and other templates) gets marked as discouraged on the Special:PageTranslation page let someone know that you wish to be able to translate it.

NOTE: Further instructions may be added to this page or linked from here to an entirely new page as needed.

Earlier methods

Since at that time we were not able to get MediaWiki to provide a working translation plugin, and other structures (templates) were not yet in place, below is how our translation process had worked.

Handbook v9.1

  • Documentation in the wiki gets "frozen" a few weeks before release so that they can be translated.
  • The text (in odt format) is sent to the translations mailing list and emailed back when it is finished.

An expected "Freeze" date depends on the results of FreeBSD's RC process.

Some teams may use Google Docs™ or other sharing mechanisms to work on the translation, other teams might have only one person or divide up who does which sections. Use the method that works best or makes the task easiest.

Older versions (9.0 and 8.2)

For those who desire to translate them, we welcome your contributions and ask that you notify us so that we can help make them available. Additional formats including HTML, ODF (for OpenOffice and other software), EPUB (for e-readers), and PDF formats are available as downloads from the PC-BSD® ftp server. Translations of the Handbook are added to the ftp server as they become available, its file name indicating the language with a 2-letter ISO code.

Other languages:German 67% • ‎English 100% • ‎French 4%
Personal tools