User guide: Understanding autosync feature

What is autosync?

This is one of the most important features of Anwiki.
Autosync engine ensures that all translations keep always synchronized together:
  • Autosync is automatically executed after editing a page (Edit action): changes are automatically propagated to all translations of the edited page
  • Autosync is NOT executed after translating a page (Translate action): translating a page doesn't affect the others translations

Understanding Autosync with an example

Time Comment /en/example /fr/example /de/example
13:00 A new page has been created in EN.
Translations have been created in FR and DE.
<h1>Untitled page</h1>
This page is under construction.<br/>
We are looking for:
<ul>
<li>Editors</li>
<li>Translators</li>
</ul>
<h1>Untitled page</h1>
This page is under construction.<br/>
We are looking for:
<ul>
<li>Editors</li>
<li>Translators</li>
</ul>
<h1>Untitled page</h1>
This page is under construction.<br/>
We are looking for:
<ul>
<li>Editors</li>
<li>Translators</li>
</ul>
13:05 Pages FR and DE have been translated
<h1>Untitled page</h1>
This page is under construction.<br/>
We are looking for:
<ul>
<li>Editors</li>
<li>Translators</li>
</ul>
<h1>Page sans titre</h1>
Cette page est en construction<br/>
Nous recherchons :
<ul>
<li>Des éditeurs</li>
<li>Des traducteurs</li>
</ul>
<h1>Kein Titel</h1>
Diese Seite befindet sich noch im Aufbau<br/>
Wir suchen:
<ul>
<li>Redakteure</li>
<li>Übersetzer</li>
</ul>
13:10 Page EN has been edited. Autosync engine automatically synchronizes all available translations.
<h1>Welcome</h1>
Welcome to my website!<br/>
We are looking for:
<ul>
<li>Editors</li>
<li>Cofee</li>
<li>Translators</li>
</ul>
<h1>Welcome</h1>
Welcome to my website!<br/>
Nous recherchons :
<ul>
<li>Des éditeurs</li>
<li>Cofee</li>
<li>Des traducteurs</li>
</ul>
<h1>Welcome</h1>
Welcome to my website!<br/>
Wir suchen:
<ul>
<li>Redakteure</li>
<li>Cofee</li>
<li>Übersetzer</li>
</ul>
13:15 Page FR has been translated
<h1>Welcome</h1>
Welcome to my website!<br/>
We are looking for:
<ul>
<li>Editors</li>
<li>Cofee</li>
<li>Translators</li>
</ul>
<h1>Bienvenue</h1>
Bienvenue sur mon site web !<br/>
Nous recherchons :
<ul>
<li>Des éditeurs</li>
<li>Du café</li>
<li>Des traducteurs</li>
</ul>
<h1>Welcome</h1>
Welcome to my website!<br/>
Wir suchen:
<ul>
<li>Redakteure</li>
<li>Cofee</li>
<li>Übersetzer</li>
</ul>
13:20 Page FR has been edited. Autosync engine automatically synchronizes all available translations.
<h1>Welcome</h1>
<div class="important">
Welcome to my website!
</div>
We are looking for:
<ul>
<li>Editors</li>
<li>Cofee</li>
<li>Des modérateurs</li>
</ul>
<h1>Bienvenue</h1>
<div class="important">
Bienvenue sur mon site web !
</div>
Nous recherchons :
<ul>
<li>Des éditeurs</li>
<li>Du café</li>
<li>Des modérateurs</li>
</ul>
<h1>Welcome</h1>
<div class="important">
Welcome to my website!
</div>
Wir suchen:
<ul>
<li>Redakteure</li>
<li>Cofee</li>
<li>Des modérateurs</li>
</ul>
13:25 Pages EN and DE have been translated
<h1>Welcome</h1>
<div class="important">
Welcome to my website!
</div>
We are looking for:
<ul>
<li>Editors</li>
<li>Cofee</li>
<li>Moderators</li>
</ul>
<h1>Bienvenue</h1>
<div class="important">
Bienvenue sur mon site web !
</div>
Nous recherchons :
<ul>
<li>Des éditeurs</li>
<li>Du café</li>
<li>Des modérateurs</li>
</ul>
<h1>Willkommen</h1>
<div class="important">
Willkommen auf meiner Website!
</div>
Wir suchen:
<ul>
<li>Redakteure</li>
<li>Café</li>
<li>Moderatoren</li>
</ul>

Fixing untranslatable content with <fix>

You sometimes want to fix content so that it can't be translated, and so that it can be updated immediately in all translations.
Example: a trademark or a product name, a version number, a street name, an e-mail address...
  • A fixed content is not translatable
  • A fixed content can quickly be updated in all languages: when it's edited, it immediately appears in all available translations (no need to wait for translators translation).

Illustration of the problem

The following example shows an inefficient usage of Anwiki.
Time Comment /en/example /fr/example
14:00 A new page has been created in EN.
Translation have been created in FR.
<p>Latest version of Anwiki is 0.1.0</p>
<p>Latest version of Anwiki is 0.1.0</p>
14:05 Page FR has been translated
<p>Latest version of Anwiki is 0.1.0</p>
<p>La dernière version de Anwiki est la 0.1.0</p>
14:10 Page EN has been edited
<p>Latest version of Anwiki CMS is 0.2.5</p>
<p>Latest version of Anwiki CMS is 0.2.5</p>
14:15 Page FR has been translated
<p>Latest version of Anwiki CMS is 0.2.5</p>
<p>La dernière version de Anwiki CMS est la 0.2.5</p>
Each time the product name or version number is edited, translators have to update their translations. However, product name and version number are exactly the same in every languages.

Using <fix/>

We suggest using <fix/> for preventing product name and version number to be translated.
Time Comment /en/example /fr/example
14:00 A new page has been created in EN.
Translation have been created in FR.
<p>Latest version of <fix>Anwiki</fix> is <fix>0.1.0</fix></p>
<p>Latest version of <fix>Anwiki</fix> is <fix>0.1.0</fix></p>
14:05 Page FR has been translated
<p>Latest version of <fix>Anwiki</fix> is <fix>0.1.0</fix></p>
<p>La dernière version de <fix>Anwiki</fix> est la <fix>0.1.0</fix></p>
14:10 Page EN has been edited
<p>Latest version of <fix>Anwiki CMS</fix> is <fix>0.2.5</fix></p>
<p>La dernière version de <fix>Anwiki CMS</fix> est la <fix>0.2.5</fix></p>
14:10 No need to translate FR, fixed content has been automatically updated.
Now, the product name or version number can be edited without affecting translations!

Linking multilingual content

Anwiki pages can be linked together by using the target page name as "href" attribute of HTML links.
Autosync engine automatically resolves internal links and changes it in each translation, for linking to the good translation of the target page.
Time Comment /en/example /fr/example
14:00 Initial state
Go back home
Retour à l'accueil
14:00 Page EN has been edited
<a href="en/example_page">Go back home</a>
<a href="fr/page_d_exemple">Retour à l'accueil</a>
Last edited on 04/05/2009 13:22:08
Powered by Anwiki • 0.04 sec • 2.06 MB