9.6.5 Example

Let's use an example to illustrate how the use of the reference language, the version change type and the synced-with pointer allows to keep track of translation status.

The table below shows the version history of two language variants of a Daisy document, the reference language "EN" and the translated variant "FR".

Time progresses from top to bottom, in each row either a change to the reference language or the translated variant is shown.

Document 1-DSY
Reference language EN						Translated variant FR
Version	Change type	State	last major change version	live major change version		Version	Synced-with	LangInSync() ?
V1	Major	Draft	V1	NULL				(does not exist)
V2	Major	Publish	V2	V2				(does not exist)
						V1		No
						V2	EN:V2	Yes
V3	Minor	Publish	V2	V2				Yes
V4	Major	Draft	V4	V2				No
						V3	EN:V4	Yes

Note that all versions have the same properties available, even though not shown in the table above. That is, the reference language versions also have a synced-with pointer, but it will not be used, and the translated variant has also change type, state, etc., but they are mostly irrelevant for the translation management.

To make the example more concrete, here is what happened, row-by-row:

EN version 1: Ron, who is reponsible for the documentation of his company's new product 'X' creates a document in Daisy.  The document is not ready for publication so he saves the document as draft.

EN version 2: Ron continues his work on the document.  The document is ready for prime time, so he publishes it.

FR version 1: Jacques is responsible for maintaining the product documentation in French.  He is halfway done with his translation, so he saves his document (normally he would save as draft, this is not shown in the table above because it does not matter for translation management).

FR version 2: Jacques finishes his translation of the to document and indicates this by setting the synced-with field.

EN version 3: Ron notices he made a small typo and fixes this.  Since his change does not influence what the translations, he marks his change as being a 'minor' change.

EN version 4: Ron starts adding content to his work.  His work is not ready for publishing so, again, he saves as draft.

FR version 3: Jacques notices that he needs to update the French translation to reflect the changes Ron made to the English version.

In the last step, one could wish not to translate the document until it is published, for this, you could use the LiveNotInSync('live') condition in the query language.