[haiku-doc] Re: Another try at user guide translations

  • From: Vincent Duvert <vincent.duvert@xxxxxxx>
  • To: haiku-doc@xxxxxxxxxxxxx
  • Date: Tue, 21 Jul 2009 09:35:16 +0200

OK, I think we're progressing :)

Le 20 juil. 09 à 16:57, Humdinger a écrit :

It may prove a better idea to get a separate SVN repository for the documentation that's only write-accessed by your db. All changes big and small are then done online making it easier to keep track of "inexact" translations and being in total control at all times. At the same time we get the versioning advantages of the SVN.
Sounds good. In that case, maybe the tool could make automated commits ? (for instance, after edits to the English files, and daily for the translations)

Question: Can your system handle providing authors (of the original English pages only) with one big editor view of the whole HTML document where one can do small "intra-block" changes as well as big "add/remove/move-block" changes? Will all the small changes be tracked and the translations flagged appropriately?
That could be done relatively easily : let the authors edit (from the web interface) the XML file tagged with the _translate_id attributes. This way, it would easy to identify added, removed, moved, and edited blocks. After the edit, the tool could generate a confirmation page, displaying changes (blocks that were added, removed or changed - and in the last case, displaying the checkbox to avoid unvalidating translations) that are about to be sent. If we do this, I'm not sure if we should provide another, more user- friendly (with live preview) editor that could be used for in-block changes, or if that would just confuse users.

Are there editor-packages freely available that would provide some more functionality for creating the English original pages? For the block-editing of translations, a simple text view like it's now should suffice. When you create original pages however, it may be convenient to define some buttons to insert tags, like <span class="key|menu| button|app|cli|path"></span> or opening a panel to upload images and insert the according <img> link etc. Maybe even a HTML syntax colouring if we want to get fancy.
Insert buttons are certainly feasible. But syntax colouring would probably take more lines of code than the rest of the editor ;-)

Something else came to my mind: How can we credit the contributors?
Since we can't really add names to every block, how about a contributors page that lists all users with the number of all their committed blocks. Or better, leave away the absolute numbers and just sort the names by their commit count, separately for the different languages. This page itself should be part of the user guide. Crediting is an important factor to motivate volunteers.

Good idea ! About this, I'm currently implementing user account managements, and was wondering how the system should work.
I see two possible implementations :
- Role based system : The admin choose the role of the user (Admin, Author, Translator) in a dropdown menu - ACL based system : The admin choose any set of permissions ("Can edit documents", "Can translate to French"...) with some checkboxes.

The second system is more flexible et easier to extend, but would be less easy to use for the administrator.

Vincent

Other related posts: