virtualx-engine/doc/classes/ResourceImporterCSVTranslation.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporterCSVTranslation" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Imports comma-separated values
	</brief_description>
	<description>
		Comma-separated values are a plain text table storage format. The format's simplicity makes it easy to edit in any text editor or spreadsheet software. This makes it a common choice for game localization.
		[b]Example CSV file:[/b]
		[codeblock lang=text]
		keys,en,es,ja
		GREET,"Hello, friend!","Hola, amigo!",こんにちは
		ASK,How are you?,Cómo está?,元気ですか
		BYE,Goodbye,Adiós,さようなら
		QUOTE,"""Hello"" said the man.","""Hola"" dijo el hombre.",「こんにちは」男は言いました
		[/codeblock]
	</description>
	<tutorials>
		<link title="Importing translations">$DOCS_URL/tutorials/assets_pipeline/importing_translations.html</link>
	</tutorials>
	<members>
		<member name="compress" type="bool" setter="" getter="" default="true">
			If [code]true[/code], creates an [OptimizedTranslation] instead of a [Translation]. This makes the resulting file smaller at the cost of a small CPU overhead.
		</member>
		<member name="delimiter" type="int" setter="" getter="" default="0">
			The delimiter to use in the CSV file. The default value matches the common CSV convention. Tab-separated values are sometimes called TSV files.
		</member>
	</members>
</class>
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Fix documentation validation after 8352122e70ec2a582af9a713791eabbbcb935c10 2023-07-12 17:30:34 +02:00			`<class name="ResourceImporterCSVTranslation" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`<brief_description>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Imports comma-separated values`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</brief_description>`
			`<description>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Comma-separated values are a plain text table storage format. The format's simplicity makes it easy to edit in any text editor or spreadsheet software. This makes it a common choice for game localization.`
			`[b]Example CSV file:[/b]`
Use `[codeblock lang=text]` more often in class ref 2024-03-09 16:58:44 +01:00			`[codeblock lang=text]`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`keys,en,es,ja`
			`GREET,"Hello, friend!","Hola, amigo!",こんにちは`
			`ASK,How are you?,Cómo está?,元気ですか`
			`BYE,Goodbye,Adiós,さようなら`
			`QUOTE,"""Hello"" said the man.","""Hola"" dijo el hombre.",「こんにちは」男は言いました`
			`[/codeblock]`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</description>`
			`<tutorials>`
Add missing tutorials to documentation classes 2023-08-15 12:14:01 +02:00			`<link title="Importing translations">$DOCS_URL/tutorials/assets_pipeline/importing_translations.html</link>`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</tutorials>`
			`<members>`
			`<member name="compress" type="bool" setter="" getter="" default="true">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`If [code]true[/code], creates an [OptimizedTranslation] instead of a [Translation]. This makes the resulting file smaller at the cost of a small CPU overhead.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
			`<member name="delimiter" type="int" setter="" getter="" default="0">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`The delimiter to use in the CSV file. The default value matches the common CSV convention. Tab-separated values are sometimes called TSV files.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
			`</members>`
			`</class>`