[2024-feb-29] Sad news: Eric Layton aka Nocturnal Slacker aka vtel57 passed away on Feb 26th, shortly after hospitalization. He was one of our Wiki's most prominent admins. He will be missed.

Welcome to the Slackware Documentation Project

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
howtos:misc:how-to_translate_a_document_in_asciidoc_format [2014/01/01 12:44 (UTC)] – [Recommendations] didierspaierhowtos:misc:how-to_translate_a_document_in_asciidoc_format [2015/06/25 13:07 (UTC)] (current) – [Sources] Make "* Originallly ..." a list item. Yes, me too... didierspaier
Line 29: Line 29:
  
 ==== Preserve the markup ==== ==== Preserve the markup ====
-Be careful to preserve the markup as is if you are not sure of the syntax. For instance, adding or removing spaces or "newline" characters can have unexpected effects. Here are a few examples :+Be careful to preserve the markup as isif you are not sure of the syntax. For instance, adding or removing spaces or "newline" characters can have unexpected effects. Here are a few examples :
   * Beginning a paragraph with a space will generate a 'literal paragraph' displayed with a specific font   * Beginning a paragraph with a space will generate a 'literal paragraph' displayed with a specific font
-  * '= some text' will generate a level 0 header (document title), but only if '=' is the first character of the line, there is a space after it and it'there is a blank line before+  * '= some text' will generate a level 0 header (document title), but only if '=' is the first character of the line, there is a space after it and there is a blank line before.
   * ' +' appended to a line will generate a 'line break' only if there is space before the '+', that should be the last character of the line    * ' +' appended to a line will generate a 'line break' only if there is space before the '+', that should be the last character of the line 
  
Line 40: Line 40:
 ==== Check the rendering of your translation ==== ==== Check the rendering of your translation ====
  
-If you translate using a text editor, just issue an 'asciidoc' command then display the generated file and compare it with the genuine one. For instance, assuming that your translation of genuine.txt is translation.txt:+If you translate using a text editor, just issue an ''asciidoc'' command then display the generated file and compare it with the genuine one. For instance, assuming that your translation of genuine.txt is translation.txt:
   asciidoc genuine.txt   asciidoc genuine.txt
   asciidoc translation.txt   asciidoc translation.txt
Line 49: Line 49:
 ==== Translate or not translate, that is the question ==== ==== Translate or not translate, that is the question ====
  
-Following words have a special meaning for Transifex and should not be translated when they begin an admonition paragraphs (often replaced by icons): TIP, NOTE, IMPORTANT, WARNING and CAUTION.+Following words have a special meaning for Transifex and should not be translated when they begin an admonition paragraph (and are often replaced by icons): TIP, NOTE, IMPORTANT, WARNING and CAUTION.
  
-Generally speaking, links and URLs should not be translated, but associated caption can, depending on the context. In following examples (taken ''from ascii doc --help syntax'' only value of ''caption'' may be translated:+Generally speaking, links and URLs should not be translated, but associated caption may, depending on the context. In following examples (taken ''from ascii doc --help syntax'' only value of ''caption'' may be translated:
   Document links:   Document links:
   [[id]]                      (define link target)   [[id]]                      (define link target)
Line 69: Line 69:
 <!-- * Original source: [[http://some.website.org/some/page.html]] --> <!-- * Original source: [[http://some.website.org/some/page.html]] -->
 <!-- Authors are allowed to give credit to themselves! --> <!-- Authors are allowed to give credit to themselves! -->
-* Originally written by [[wiki:user:didierspaier]]+  * Originally written by [[wiki:user:didierspaier]]
 <!-- * Contributions by [[wiki:user:yyy | User Y]] --> <!-- * Contributions by [[wiki:user:yyy | User Y]] -->
  
 howtos:misc:how-to_translate_a_document_in_asciidoc_format ()