MD parser
Warning
Updating a project that contains an MD file with a changed structure can corrupt the translations in the Rigi project!
Updates of MD files can hardly be recognized, because MD files do not have IDs.
The parser generates IDs by grouping texts that are located within the same block of the following text types:
Bulleted texts.
Numbered texts.
Code.
Free texts.
HTML.
Headers.
Table rows.
Adding new lines will create a new block.
We strongly recommend cloning your project and testing the updates in a cloned project without impacting the production project.
Parser ID: MD.
Format: https://en.wikipedia.org/wiki/Markdown.
Key features:
Extracts translatable texts from MD files.
Writes targets with the same encoding and line endings as the source.
Parser settings:
Write log to MD-file (
appendlog).Default:
false.This setting can be useful for debugging. When it is enabled, the structure (String ID and text) is written as a comment to the target file.
Example 19.Content of MD file (file ID is
fileid)## header 1 Text1 Text2 Text3 ### header 1.1 Text4 Text5 Text6 ### header 1.2 Text7 Text8 Text9 ## header 2 Text10
When the
appendlogcheckbox is selected, the output of the MD file will include the logs:## header 1 Text1 Text2 Text3 ### header 1.1 Text4 Text5 Text6 ### header 1.2 Text7 Text8 Text9 ## header 2 Text10 <!-- Log structure (turn off via parser settings) SECTION ----------------------------- SECTION ----------------------------- 1_header~header1~1T0 : Header 1_tables1~tablerow1~1col1 : text1 1_tables1~tablerow1~2col2 : text2 1_tables1~tablerow1~3col3 : text3 SECTION ----------------------------- 2_header~header1~1T0 : header 1 2_texts1~text1~1T0 : Text1 2_texts1~text2~1T0 : Text2 2_texts2~text1~1T0 : Text3 SECTION ----------------------------- 2_1_header~header1~1T0 : header 1.1 2_1_texts1~text1~1T0 : Text4 2_1_texts1~text2~1T0 : Text5 2_1_texts2~text1~1T0 : Text6 SECTION ----------------------------- 2_2_header~header1~1T0 : header 1.2 2_2_texts1~text1~1T0 : Text7 2_2_texts1~text2~1T0 : Text8 2_2_texts2~text1~1T0 : Text9 SECTION ----------------------------- 3_header~header1~1T0 : header 2 3_texts1~text1~1T0 : Text10 -->
For other parser settings, see the Generic parser settings article.