HOWTO

📝 Edit Translations

💡 Rationale

Translations are managed by editing the title or description for every language (en, nl, fr).
❗ At least the _en version is required (this is the default).

Translations are stored across different files:

• Regions → translations_regions.csv
• UI elements, short text, single words → translations_simple.csv
• Graphs & long textboxes → translations.csv

Any change to these files triggers automatic processing by a GitHub Action.

⚠️☠️ Do NOT change the translation_<language>.csv files in ./UAT_direct/translations/ directly as they will be overwritten by the processing workflow ☠️⚠️

---

✅ Steps to Edit

Follow these steps depending on your case:

1. Preparation

First edit on a new branch

1. Create a branch from uat
2. Fetch latest uat
3. Switch to your new branch

Subsequent edits on same branch

• Fetch & pull latest updates

---

2. What do you want to change?

• 🌍 Region translation → go to Step 7
• 🔘 UI element / short text / single word → go to Step 10
• 📊 Graph / longer text → go to Step 13

---

🔗 How?

🌍 translations_regions

Contains translations of regions. Example:

title_id	title_nl	title_fr	title_en
België	België	Belgique	Belgium

7. Open: ./data/output/UAT_direct/translations_regions.csv
8. Find the correct title_id and edit its translation
9. Save → Commit → Push → Final

---

🔘 translations_simple

Contains UI text, short labels, simple words. Example:

title_id	title_nl	title_fr	title_en
first_observed	jaar van eerste waarneming	année de première observation	year of first observation

10. Open: ./data/output/UAT_direct/translations_simple.csv
11. Find the title_id and edit language fields
12. Save → Commit → Push → Final

---

📊 translations

Contains complex text (graphs, long text with HTML, multi-language descriptions).
⚠️ Recommended: Use the translation_editor app ⚠️

title_id	title_nl	description_nl	title_fr	description_fr	title_en	description_en
management3-countYearGroup	Het aantal beheerde {{species}} individuen	<p>Deze grafiek…</p>	Le nombre d'individus…	<p>Ce graphique…</p>	The number of {{species}} individuals managed	<p>This graph shows…</p>

Steps:
13. Open aspbo.rproj in RStudio
14. Open ./src/translation_editor.R
15. Run the app
16. First run only: Accept prompt to load local CSV into Google Sheet ⚠️
17. Locate correct Title ID & Language
18. Update title and/or description
19. Save back to CSV
20. Commit → Push → Final

⚠️ Avoid losing changes!

• Don’t switch Title ID or Language without saving
• Ensure any Google Sheet changes are synced

---

🏁 Final

21. Wait for the 🤖 translation_processing Action to complete
22. Open a PR → Request review from @soriadelva and @sanderdevisscher

📝 Edit links pages

💡Rationale

Every species has a links page with relevant links. The links are either Generic (The large bulk of species) or Custom (Some select species). The way these links pages are edited depends on the type.

---

✅ Steps to Edit

Follow these steps depending on your case:

1. Preparation

First edit on a new branch

1. Create a branch from uat
2. Fetch latest uat
3. Switch to your new branch

Subsequent edits on same branch

1. → 3. Fetch & pull latest updates

2. Open aspbo.rproj in RStudio

---

2. What do you want to change?

• 📚 The rules and text of Generic links pages → go to generic_links
• 📘 Anything concerning a Custom links page → go to custom_links

---

3. 📚 generic_links

Depending on what specifically you want to change you'll have to take different steps

• 🇳🇱 articles → go to Step 5
• 🇳🇱 geographic annotations → go to Step 16
• 📖 general text → go to Step 21
• 🔨 general rules (🇬🇧 & 🇫🇷 articles, urls, select species urls (ea faunabeheer page)) → go to Step 25

3.1 🇳🇱 NL_article

5. Open review_nl_htmls.R
6. Click run app

• Edit/check the article of a specific species → go to Step 7
• Edit/check the article of several species → go to Step 13

3.1.1 NL_article_specific

7. Write the gbifkey of the species into Search HTML by base name
8. Click Load HTML
9. Check/Edit article using the ok, de & het buttons ℹ️ if the species is already listed the current article is highlighted in green. Clicking the other article will overwrite the current.
10. Repeat steps 7 → 9 as needed
11. Click Save Lists to save changes
12. Commit → Push → go to Step 30

3.1.2 NL_article_several

13. Use the ok, de, het & skip buttons at the bottom to Check/Edit the articles
14. Click Save Lists to save changes
15. Commit → Push → go to Step 30

3.2 🇳🇱 NL_geographic

16. Open ./src/create_new_links.Rmd
17. Goto line 137
18. Check/Edit the geo_words list to improve capitalisation of geographic annotations
19. Save the changes
20. Commit → Push → go to Step 30

3.3 📖 general_text

21. Open ./data/input/links_template.txt using notepad++ or similar
22. Check/Edit the template
23. Save the changes
24. Commit → Push → go to Step 30

3.4 🔨 general_rules

25. Open ./src/create_new_links.Rmd
26. Goto line 97
27. Check/Edit the rules
28. Save the changes
29. Commit → Push → go to Step 30

---

3.5 generic_links_final

30. Open ./src/create_new_links.Rmd
31. Goto line 175
32. Set redo_all & redo_existing as required

redo_all	redo_existing	Effect
TRUE	TRUE	Reruns all on GRIIS (inclu. non-existing but exlcu.custom)
TRUE	FALSE	Only existing (exclu. custom)
FALSE	TRUE	Skip all
FALSE	FALSE	Only non - existing

33. Click run all
34. Commit → Push changes
35. Create a PR with @soriadelva & @sanderdevisscher as reviewers

---

4. 📘 Custom_links

• The species doesn't yet have a links page (generic nor custom) → go to create custom links page
• The species has a generic links page → go to upgrade links page
• The species has a custom links page → go to edit custom links page

4.1. create_custom_links_page

36. create a new .Rmd file named <gbiftaxonkey>.Rmd in ./HTML_pages/Rmd_files/
37. add the following yaml & html code:

---
title: <gbiftaxonkey>
output: html_fragment
params:
  language: "fr"
---
<style>
h1.title {
display: none;
}
</style>

38. add & populate the following chuncks:

chunckname & settings	content
setup, include=FALSE	knitr::opts_chunck$set(echo = TRUE)
sharedinfo, echo=FALSE	- non language dependant URLs - styling - images
nl_chunck, eval=params$language=="nl", results="asis", echo=FALSE	dutch links text
en_chunck, eval=params$language=="en", results="asis", echo=FALSE	english links text
fr_chunck, eval=params$language=="fr", results="asis", echo=FALSE	french links text

39. save the changes
40. Commit → Push → go to Step 50

4.2. upgrade_generic_links_page

41. Lookup <gbiftaxonkey>.Rmd in ./HTML_pages/Rmd_files/generic_links_pages/
42. Cut & paste file into ./HTML_pages/Rmd_files/
43. Open file & edit content
44. save the changes
45. Commit → Push → go to Step 50

4.3. edit_custom_links_page

46. Open <gbiftaxonkey>.Rmd in ./HTML_pages/Rmd_files/
47. edit the file content
48. save the changes
49. Commit → Push → go to Step 50

4.4. custom_links_final

50. Open or source ./HTML_pages/Render_single_HTML.R
51. Run render_single_html("./HTML_pages/Rmd_files/<gbiftaxonkey>.Rmd", "../HTML/")
52. Commit → Push
53. Create a PR with @soriadelva & @sanderdevisscher as reviewers