Setup basic documentation

Author: jonnydgreen

addons/parley/parley_manager.gd

@@ -156,6 +156,7 @@ func get_plugin_version() -> String:
 
 ## Update localisation for all known Dialogue Sequences
 func register_localisation_path(path: String) -> int:
+	# TODO: do we need to consider the translation mode?
 	var pot_generation_candidates: PackedStringArray = ProjectSettings.get_setting(ParleyConstants.TRANSLATIONS_POT_FILES, [])
 	var changed: bool = false
 
@@ -174,6 +175,7 @@ func register_localisation_path(path: String) -> int:
 
 ## Update localisation for all known Dialogue Sequences
 func update_localisations(dialogue_sequences_to_register: Array[ParleyDialogueSequenceAst] = [], clean: bool = true) -> int:
+	# TODO: do we need to consider the translation mode?
 	var pot_generation_candidates: PackedStringArray = ProjectSettings.get_setting(ParleyConstants.TRANSLATIONS_POT_FILES, [])
 	var changed: bool = false
 

docs/latest/internationalisation/index.md

@@ -0,0 +1,22 @@
+---
+description: |
+  Parley supports multiple ways of handling translations for your game: using CSV files and using GNU gettext.
+---
+
+Parley supports multiple ways of handling translations for your game:
+
+- Using [CSV files](../internationalisation/localisation-using-csv.md)
+- Using [GNU gettext](../internationalisation/localisation-using-gettext.md)
+
+By default, Parley will detect the current translation mode and attempt to
+translate defined text in using the unbuilt Godot `tr` function for the
+following nodes:
+
+- [Dialogue Node](../nodes/dialogue-node.md)
+- [Dialogue Option Node](../nodes/dialogue-option-node.md)
+
+> [tip]: You can select the modes that Parley will run under and also also turn
+> off translation support in Parley in the Parley project
+> [settings](../reference/parley-settings.md).
+
+<!-- TODO: include information about characters -->

docs/latest/internationalisation/localisation-using-csv.md

@@ -0,0 +1,6 @@
+---
+description: |
+  Localisation using CSV files
+---
+
+<!-- TODO: Localisation using CSV files -->

docs/latest/internationalisation/localisation-using-gettext.md

@@ -0,0 +1,6 @@
+---
+description: |
+  Localisation using GNU gettext
+---
+
+<!-- TODO: Localisation using GNU gettext -->

docs/latest/reference/parley-settings.md

@@ -72,6 +72,9 @@ translations. It can be one of several values:
 <!-- TODO: CSV -->
 <!-- TODO: - `OFF` - No internationalisation will be applied. -->
 
+More information about internationalisation support in Parley can be found
+[here](../i18n/index.md).
+
 Setting path: `parley/translations/mode`
 
 Default: `PO`

docs/toc.ts

@@ -76,6 +76,13 @@ const toc: RawTableOfContents = {
           ["character-store", "Character Store"],
         ],
       },
+      internationalisation: {
+        title: "Internationalisation",
+        pages: [
+          ["localisation-using-csv", "Localisation using CSV files"],
+          ["localisation-using-gettext", "Localisation using GNU gettext"],
+        ],
+      },
       customisation: {
         title: "Customisation",
         pages: [