HelpUsTranslate: Difference between revisions

Line 58:

=== Markers in the text ===

==== Programmatic Placeholders ====

Some strings have markers in them. We use these to programmatically add information to strings while the game is running. They are an asterisk followed by a single letter (e.g. *X). These markers must be kept as an asterisk followed by the given letter, but can be placed anywhere in the string.

~~- For example, *X might be the number of fuel containers on your ship, or it might be a monetary value. If it is not clear, please ask for more context.~~

~~- There are some markers that are special:~~

~~S*X - a star system (e.g. NG11).~~

~~$*X - an amount of money. The game uses the format_currency key to format it accordingly.~~

~~L*X - the name of a star ship (e.g. PROCYON).~~

~~R*X -the name of an object type in game (e.g. Fuel, Crew, Docking Port).~~

## Escaped characters, e.g. \n

For example, *X might be the number of fuel containers on your ship, or it might be a monetary value. If it is not clear, please ask for more context.

- Some strings contain newline markers (written as \n) which should be left in appropriate places. They are used to start a new line and/or paragraphs.

There are some markers that are special:

* S*X - a star system (e.g. NG11).

* $*X - an amount of money. The game uses the format_currency key to format it accordingly.

* L*X - the name of a star ship (e.g. PROCYON).

* R*X -the name of an object type in game (e.g. Fuel, Crew, Docking Port).

==== Escaped characters, e.g. \n ====

Some strings contain newline markers (written as \n) which should be left in appropriate places. They are used to start a new line and/or paragraphs.

==== Key Bindings ====

Key bindings are of the form {ToggleMap}. As with markers, if a keybinding appears in the English, it should also appear in the Translation.

=== Example: Fixing an incorrect translation in French ===

@@ Line 58: / Line 58: @@
 === Markers in the text ===
+==== Programmatic Placeholders ====
 Some strings have markers in them. We use these to programmatically add information to strings while the game is running. They are an asterisk followed by a single letter (e.g. *X). These markers must be kept as an asterisk followed by the given letter, but can be placed anywhere in the string.
-- For example, *X might be the number of fuel containers on your ship, or it might be a monetary value. If it is not clear, please ask for more context.
-- There are some markers that are special:
-  S*X  - a star system (e.g. NG11).
-  $*X - an amount of money.  The game uses the format_currency key to format it accordingly.
-  L*X - the name of a star ship (e.g. PROCYON).
-  R*X -the name of an object type in game (e.g. Fuel, Crew, Docking Port).
-## Escaped characters, e.g. \n
+For example, *X might be the number of fuel containers on your ship, or it might be a monetary value. If it is not clear, please ask for more context.
-- Some strings contain newline markers (written as \n) which should be left in appropriate places. They are used to start a new line and/or paragraphs.
+There are some markers that are special:
+* S*X  - a star system (e.g. NG11).
+* $*X - an amount of money.  The game uses the format_currency key to format it accordingly.
+* L*X - the name of a star ship (e.g. PROCYON).
+* R*X -the name of an object type in game (e.g. Fuel, Crew, Docking Port).
+==== Escaped characters, e.g. \n  ====
+Some strings contain newline markers (written as \n) which should be left in appropriate places. They are used to start a new line and/or paragraphs.
+==== Key Bindings ====
+Key bindings are of the form {ToggleMap}. As with markers, if a keybinding appears in the English, it should also appear in the Translation.
 === Example: Fixing an incorrect translation in French ===