From b0061bd40834e9a97f32f975018568dacb570da1 Mon Sep 17 00:00:00 2001 From: Blake-Madden <66873089+Blake-Madden@users.noreply.github.com> Date: Fri, 6 Dec 2024 16:08:00 -0500 Subject: [PATCH] Formatting fixes to the manual --- docs/manual/gui/editing.qmd | 8 ++++++++ docs/manual/gui/options.qmd | 7 ++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/manual/gui/editing.qmd b/docs/manual/gui/editing.qmd index ecc6fe8..062af8f 100644 --- a/docs/manual/gui/editing.qmd +++ b/docs/manual/gui/editing.qmd @@ -18,6 +18,8 @@ Clipboard operations (e.g., `r keys("Cut")`, `r keys("Copy")`, and `r keys("Past From the `r keys("Insert")` button, options are available for inserting and converting content within the editor to fix various warnings. +### Translator Comment {-} + For example, to fix warnings about strings needing context, place the cursor into the editor in front of a resource loading call (e.g., `_("TABLE")`). Next, click the `r keys("Insert")` button on the ribbon and select **Translator Comment...**. Enter a comment that will explain to the translators what "TABLE" means in this context, providing guidance for how they should translate it. @@ -28,6 +30,8 @@ Click `r keys("OK")` and your comment with "TRANSLATORS: " prefixed will be inse This warning is emitted when the option **Check for ambiguous strings that lack a translator comment** (from the **Source Code** settings) is checked. ::: +### Encode Extended ASCII Characters {-} + To fix warnings about extended ASCII characters needing to be encoded, select the text in the editor which contains these characters. Next, click the `r keys("Insert")` button on the ribbon and select **Encode Extended ASCII Characters...**. You will then be prompted about how the selection will be re-encoded. @@ -40,10 +44,14 @@ By following the aforementioned steps, this will be re-encoded to "B\\U00000142\ This warning is emitted when the option **Unencoded extended ASCII characters** (from the **Additional Checks** settings) is checked. ::: +### Mark for Translation {-} + To mark a string as translatable, select the string in the editor and select **Mark for Translation...** from the `r keys("Insert")` button. From the **Mark for Translation** dialog, options are available for choosing which translation function to use, along with providing a domain or context (if applicable). The translation marking functions available are compatible with *gettext*, *wxWidgets*, and *Qt*. +### Mark as Non-translatable {-} + To mark a string as non-translatable, select the string in the editor and select **Mark as Non-translatable...** from the `r keys("Insert")` button. From the **Mark as Non-translatable** dialog, options are available for which function to wrap the string in, along with providing an optional context and comment. These functions will mark the string as non-translatable and **Cuneiform** will ignore them during an analysis. diff --git a/docs/manual/gui/options.qmd b/docs/manual/gui/options.qmd index 490c3ad..f612446 100644 --- a/docs/manual/gui/options.qmd +++ b/docs/manual/gui/options.qmd @@ -63,8 +63,13 @@ This will check for issues such as: It is recommended to use other functions (e.g., `CString::LoadString()`) that are not limited to fixed buffer sizes; otherwise, translated strings may become truncated. - Context arguments passed to l10n functions (e.g., `tr()`) that are longer than 32 characters.\ This may indicate that the context and translatable string arguments are reversed. -- Possible strings meant for translation being passed to ID loading functions (e.g., `qtTrId`). +- Possible strings meant for translation being passed to ID loading functions (e.g., `qtTrId()`). +:::: +:::: {.optionssection data-latex=""} +::: {.optionssectiontitle data-latex=""} +Run the following checks (*continued...*) +::: **Check for ambiguous strings that lack a translator comment**: select this to check for possibly ambiguous strings that lack a translator comment. **Deprecated macros and functions**: select this to check for deprecated text macros and functions.