Handbook translating

From PC-BSD Wiki
Jump to: navigation, search


NOTE: This page may have frequent updates not related to transcluded content.

RST Format

The latest method to be used for the maintenance of the PC‑BSD® Handbook. Editing will be handled a different way, outside of the wiki, beginning with version 10.1.2. Further details can be found on the PC‑BSD® github site.[1] Translations of the handbook text might be done via pootle but this needs to be confirmed.

Versions prior to 10.1.2

Anyone is welcome to help with translating the handbook into other languages. MediaWiki was used for the translation work starting with version 9.2 and including 10.1.1. Older versions of the handbook might be added to the wiki in the future, this would increase the number of languages on the wiki and ease translation of the next handbooks. 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 translation mechanism to do your work.

WARNING Although no explanation may be given, if a page previously marked to be translated (especially the
Handbook translating/common page which contains words 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. A wiki page most frequently will automatically be unset for
translation if the original/parent was recently edited. In this case the page may have the message
"Translate this page; This page has changes since it was last marked for translation."
near upper left.

Some tips

  • 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 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 auto-localize in place, where {{local|link=Handbook translating}} will appear as Handbook translating if the page title ("Handbook translating" in this example) has been translated using the translation system at Handbook translating. However, the wiki will not render a link if it leads to the current page (itself), the result will be ordinary text without any link styles.
  • Application names should not be translated (AppCafe, LifePreserver, Warden, etc)
  • The Wiki Style guidelines and template quick reference sheet may help with understanding how/why some things are done.
  • If you have installed the stylish extension for Firefox or Chrome browsers, there is a Stylesheet for editors that can make some things a little more visible.
Figure  Is there no version? a: Translate Help
Adjust Preferences

Features of the wiki are configurable, try any or all of these and see which you like or help most.
In the editing tab:

  • Enable "Show edit toolbar (requires JavaScript)"
  • Enable "Enhanced translation editor (JavaScript)"
  • Adjust the "Assistant languages"

In the Gadget tab:

  • Enable <gadget-Edittools>
  • Enable Make syntax stand out colorfully in the edit box.

Successful translation

Thus far it has been determined that being able to translate may depend upon one of two things:

  1. Your account will exist for a predetermined amount of time and a preset number of edits (in agreement with policy) are made.
    A request to a wiki bureaucrat (Krismoore, Drulavigne, Jpaetzel) for translator (and/or translation reviewer) membership could speed/obviate above, if fully implemented.
  2. Kindly ask an admin (Krismoore, Yerenkow, MelanieV, Drulavigne, Jpaetzel, Tigersharke), or bureaucrat, or other successful editor to "fake" translate 100% the desired page.

Templates with link localization

Some of the more commonly used techniques.

Requires that a value be passed to the template to allow for a localization effect. Where alternate text is used, then that alternate text would need to be translated.
{{Citelink|url=complete URL|txt=alternate text}}
{{Citelink|shortcut|url=page URL|txt=alternate text}}
{{Citelink|shortcut|txtAb=alternate text}}
Using these templates will automagically provide a localized result. They need not be adjusted or translated, though they may replace the standard wiki markup method for a similar effect. Where alternate text is used, then that alternate text would need to be translated.
Provides a method to localize internal links.
{{local|link=page name}}
{{local|link=page name|alternate text}}
{{local|link=page name|anchor=sub-heading|alternate text}}

Words on the wiki

Translated words and phrases
Some templates that are otherwise automatic may require some elements to be localized separately. These are translated on the Handbook translating/common page.

Table  Is there no version? a: Words and phrases for translation [Tables 1]
T:id English

word or phrase

How/where used

11 NOTE:


NOTE: Text content here. template:note


 WARNING  Text content here. template:warning


 DANGER!  Text content here. template:danger
14 References


15 Next:


Icon hover text template:NavHeader
16 Previous:


Icon hover text template:NavHeader
17 Table of Contents

Table of Contents

The header for Table of Contents on Table of Contents and other versions of the published wiki PC‑BSD® Users Handbook.
18 Return to Table of Contents

Return to Table of Contents

Icon hover text template:NavHeader
19 Tables


template:tbl-init, template:groupRef, and template:groupRefHeading. A simple identifier for groups of them which get listed at the bottom of a page which have them.
20 Work in Progress: PC‑BSD® Users Handbook (Rolling Release)

Work in Progress: PC‑BSD® Users Handbook (Rolling Release)

PC‑BSD® Users Handbook/10.1.2.
21 PC‑BSD® Users Handbook (Published Release 10.1.1)

PC‑BSD® Users Handbook (Published Release )

PC‑BSD® Users Handbook/10.1.1 and other versions of the published wiki PC‑BSD® Users Handbook.
22 What's new in 10.1.1

What's new in

Visible on Table of Contents and a swapTitle for the What's New page.
23 The following wiki translations are also available or are in progress:

The following wiki translations are also available or are in progress:

Visible on colophon, transcluded from colophon/<version> pages.
24 Out-of-date


template:outdated to be used on old wiki pages that are not very applicable.
25 Copyright© 2011 - 2015, The PC‑BSD® Project.

Copyright© 2011 - 2015, The PC‑BSD® Project.

At least three pages: Colphon, License, Preface/<version>.
26 <references group="Tables"/>
  1. Table  Is there no version? a: Words and phrases for translation
Where <references/> is used - intended for templates.
27 Figure


28 Table  Is there no version? 

Table  Is there no version? 

template:tbl-init for the caption, it automates the numbering part for a result like “Table 8.20a: rest of caption”, while the “a: rest of caption” part is added by the editor on the page.
29 PC‑BSD® Users Handbook

PC‑BSD® Users Handbook

PC‑BSD® Users Handbook/10.1.1 and other versions of the published wiki PC‑BSD® Users Handbook.

The items below are translated elsewhere, the link in the English column should direct you to it.

T:id English word or phrase How/where used
n/a PC‑BSD® was released on . PC‑BSD® was released on . Appears similar to “PC‑BSD® 10.1.1 was released on 02 February 2015.” on the Colophon page.
n/a The Users Handbook is available in the following formats: The Users Handbook is available in the following formats: Appears similar to “The 10.1.1 Users Handbook is available in the following formats:” on the Colophon page.



Table  Is there no version? b: [Tables 1]

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 on this wiki is "frozen" for several weeks before a new release which means it is closed to edits. During this time translations can be made.
  • 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.


  1. https://github.com/pcbsd/pcbsd/blob/master/src-qt5/docs/README.md


  1. Table  Is there no version? b:
Other languages:German 67% • ‎English 100% • ‎French 4%
Personal tools