[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

Next revision
Previous revision
Next revisionBoth sides next revision
howtos:misc:how-to_translate_a_document_in_asciidoc_format [2014/01/01 11:41 (UTC)] – created didierspaierhowtos:misc:how-to_translate_a_document_in_asciidoc_format [2014/01/01 12:46 (UTC)] – [Preserve the markup] didierspaier
Line 24: Line 24:
 ===== Recommendations ===== ===== Recommendations =====
  
-Of course you'll need to get acquainted with AsciiDoc markup syntax. The reference document is the [[http://asciidoc.org/userguide.html|AsciiDoc User Guide]] but for a starter, you could just read this [[http://powerman.name/doc/asciidoc|AsciiDoc cheatsheet]]. Even faster, assuming that ''asciidoc'' is installed just type in a terminal:+Of course you'll need to get acquainted with AsciiDoc markup syntax. The reference document is the [[http://asciidoc.org/userguide.html|AsciiDoc User Guide]] but for a starter, you could just read this [[http://powerman.name/doc/asciidoc|AsciiDoc cheatsheet]]. Even faster, assuming that ''asciidoc'' is installed this command, typed in a terminal:
   asciidoc --help syntax > asciidoc.txt   asciidoc --help syntax > asciidoc.txt
 will write the AsciiDoc Markup Syntax Summary in file asciidoc.txt that you can then display with a pager or print. will write the AsciiDoc Markup Syntax Summary in file asciidoc.txt that you can then display with a pager or print.
  
 ==== 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 
  
 howtos:misc:how-to_translate_a_document_in_asciidoc_format ()