Difference between revisions of "Translated string key editor"

From Divinity Engine Wiki
Jump to: navigation, search
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
== Description ==
 +
The Translated String Key Panel is a panel that allows you to edit Translated string tables, files which map strings to keys (used for localization).
  
 +
<br />
 +
== Using the Translated String Key Panel ==
 +
[[File:TSKPanel_StepByStep.png|none]]
 +
<sub>The Translated String Key Panel with each component numbered</sub>
 +
 +
 +
The Translated String Key Panel consists of the following components:
 +
# [[#Menu|Menu]]
 +
# [[#Quick Menu|Quick Menu]]
 +
# [[#Translated String Table Explorer|Translated String Table Explorer]]
 +
# [[#Translated String Table Editor|Translated String Table Editor]]
 +
# [[#Find Results|Find Results]]
 +
 +
<br />
 +
=== Menu ===
 +
==== File ====
 +
[[File:TSKPanel_Menu_File.png|none]]
 +
<sub>A closeup of the File menu</sub>
 +
 +
 +
The File menu allows you to save or load the current table or all opened tables in the [[#Translated String Table Editor|Translated String Table Editor]], open the [[#The Find Dialog|Find Dialog]] or export the current translated string table as a .txt file.
 +
 +
==== View ====
 +
<br />
 +
[[File:TSKPanel_Menu_View.png|none]]
 +
<sub>A closeup of the View menu</sub>
 +
 +
 +
The View menu allows you to open the Solution Dialog.
 +
 +
<br />
 +
=== Quick Menu ===
 +
The Quick menu has many of the same options as the [[#File|File]] menu and more.
 +
 +
From left to right, the Quick menu buttons:
 +
# Create a new translated string table
 +
# Save the current translated string table opened in the [[#Translated String Table Editor|Translated String Table Editor]]
 +
# Save all opened translated string tables in the [[#Translated String Table Editor|Translated String Table Editor]]
 +
# Reload all translated string tables from disk
 +
# List Problems (opens the Solution Dialog)
 +
# Import a translated string table from a .txt file (see "Export..." under [[#File|File]])
 +
 +
<br />
 +
=== Translated String Table Explorer ===
 +
[[File:TSKPanel_TableExplorer.png|none]]
 +
<sub>The translated string table explorer</sub>
  
−
== Overview ==
+
 
−
[[File:TSKPanel_StepByStep.png|none]]
+
The Translated String Table explorer shows translated string tables in their respective project and folder as they appear in the Data folder.
 +
 
 +
<br />
 +
=== Translated String Table Editor ===
 +
[[File:TSKPanel_TableEditor.png|none]]
 +
<sub>The translated string table editor</sub>
 +
 
 +
 
 +
The Translated String Table editor allows you to edit opened translated string tables.
 +
 
 +
The table has the following columns:
 +
* Header (allows you to select/delete whole rows)
 +
* Key (the key used to access the translated string)
 +
* Content (the value of the translated string)
 +
* Speaker
 +
* ExtraData
 +
* The [...] button (opens up a multiline edit dialog to edit the translated string's content)
  
 
<br />
 
<br />
 
== The Find Dialog ==
 
== The Find Dialog ==
 
[[File:TSKPanel_Find.png|none]]
 
[[File:TSKPanel_Find.png|none]]
 +
<sub>The Translated String Key Editor's Find Dialog</sub>
 +
 +
 +
The Find dialog allows you to search all translated string tables for translated strings by key or by content.
 +
 +
The find dialog consists of the following components:
 +
* The Find textbox (the string to search for)
 +
* Key/Value radiobox
 +
*: '''Key''': search translated strings by key
 +
*: '''Value''': search translated strings by content
 +
* Match Case: whether the search is case-sensitive
 +
* Split on space: allows you to search by multiple space-seperated strings
 +
* Stop at first: search stops after a match is found
 +
 +
<br />
 +
=== Find Results ===
 +
[[File:TSKPanel_FindResults.png|none]]
 +
<sub>The find results section</sub>
 +
 +
 +
The find results section shows the results from a search query executed by the [[#The Find Dialog|Find Dialog]].
 +
 +
The table has the following columns:
 +
* Found Key (the key of a found translated string)
 +
* Found Item (the content of a found translated string)
 +
* File (the file path of a found translated string)
 +
 +
<br />
 +
== The View Panel ==
 +
[[File:TSKPanel_ViewPanel.png|none]]
 +
<sub>The TranslatedStringKeyViewPanel</sub>
 +
 +
 +
The view panel (View > View panel) shows the string as it will show up in game and with correct HTML markup.
 +
 +
The panel also allows you to select the gender of the speaker and the gender of the addressed, as the string can sometimes differ.
 +
 +
<br />

Latest revision as of 12:46, 2 October 2017

Description

The Translated String Key Panel is a panel that allows you to edit Translated string tables, files which map strings to keys (used for localization).


Using the Translated String Key Panel

TSKPanel StepByStep.png

The Translated String Key Panel with each component numbered


The Translated String Key Panel consists of the following components:

  1. Menu
  2. Quick Menu
  3. Translated String Table Explorer
  4. Translated String Table Editor
  5. Find Results


Menu

File

TSKPanel Menu File.png

A closeup of the File menu


The File menu allows you to save or load the current table or all opened tables in the Translated String Table Editor, open the Find Dialog or export the current translated string table as a .txt file.

View


TSKPanel Menu View.png

A closeup of the View menu


The View menu allows you to open the Solution Dialog.


Quick Menu

The Quick menu has many of the same options as the File menu and more.

From left to right, the Quick menu buttons:

  1. Create a new translated string table
  2. Save the current translated string table opened in the Translated String Table Editor
  3. Save all opened translated string tables in the Translated String Table Editor
  4. Reload all translated string tables from disk
  5. List Problems (opens the Solution Dialog)
  6. Import a translated string table from a .txt file (see "Export..." under File)


Translated String Table Explorer

TSKPanel TableExplorer.png

The translated string table explorer


The Translated String Table explorer shows translated string tables in their respective project and folder as they appear in the Data folder.


Translated String Table Editor

TSKPanel TableEditor.png

The translated string table editor


The Translated String Table editor allows you to edit opened translated string tables.

The table has the following columns:

  • Header (allows you to select/delete whole rows)
  • Key (the key used to access the translated string)
  • Content (the value of the translated string)
  • Speaker
  • ExtraData
  • The [...] button (opens up a multiline edit dialog to edit the translated string's content)


The Find Dialog

TSKPanel Find.png

The Translated String Key Editor's Find Dialog


The Find dialog allows you to search all translated string tables for translated strings by key or by content.

The find dialog consists of the following components:

  • The Find textbox (the string to search for)
  • Key/Value radiobox
    Key: search translated strings by key
    Value: search translated strings by content
  • Match Case: whether the search is case-sensitive
  • Split on space: allows you to search by multiple space-seperated strings
  • Stop at first: search stops after a match is found


Find Results

TSKPanel FindResults.png

The find results section


The find results section shows the results from a search query executed by the Find Dialog.

The table has the following columns:

  • Found Key (the key of a found translated string)
  • Found Item (the content of a found translated string)
  • File (the file path of a found translated string)


The View Panel

TSKPanel ViewPanel.png

The TranslatedStringKeyViewPanel


The view panel (View > View panel) shows the string as it will show up in game and with correct HTML markup.

The panel also allows you to select the gender of the speaker and the gender of the addressed, as the string can sometimes differ.


Retrieved from "https://docs.larian.game/index.php?title=Translated_string_key_editor&oldid=3538"