NynorsX

Et verktøy for å oversette Hovedmål til Sidemål ved bruk av Apertium i en Docker-container. For educational purposes.

Fra 2 til 6 i sidemål

NynorsX bruker Apertiums Bokmål-til-Nynorsk språkpakke for å oversette Microsoft Word dokumenter. Applikasjonen kjører i en isolert Docker-container i bakgrunnen på pc'en, – som overvåker en spesifisert mappe for .docx filer og sender oversatte Nynorsk-filer til en annen bestemt mappe.

• Ingen GUI. Alt skjer i bakgrunnen og er omtrent umulig å ta som juks (ved mindre jeg er eksamensvakt).

Språkbanken:

• Omsetjingsminne frå Nynorsk pressekontor 2022
• Omsetjingsminne frå EFTA
• Translation Memories from EFTA

Requirements:

• Python3
• Docker Desktop
• Nynorsk-motstand og dagdrømmer om nasjonalromantikken

---

---

⚠️ Viktige merknader

• Bilder, Grafer, og mer: NynorsX støtter foreløpig ikke bilder, grafer eller annet ikke-tekstinnhold i filer.
• Filnavn: : Unngå mellomrom og spesialtegn i filnavn for å forhindre panikk 5 min før innleveringsfristen.
• Oversettelseshastighet: Oversettelseshastighet avhenger av filstørrelse, komplektistet, og hardware; større filer kan ta lengre tid.
• Docker: Sørg for at Docker Desktop fortsetter å kjøre mens du bruker NynorsX. Docker er kjent for å tømme laptop-batterier fortere enn du klarer å bøye ordet "gutt" på nynorsk, men jeg har ikke opplevd noen problemer med en Apple Silicon MacBook Pro.
• Slett test filer: Det er viktig å ha en mappe uten test filer på eksamensdagen. Dog, burde alle sørge for å teste programmet på forhånd.

---

Installasjon

Steg for steg guide for å sette opp NynorsX på MacOS:

1. Installer Docker Desktop

• Download and install Docker Desktop.
• Ensure Docker Desktop is running during the entire process.

2. Last ned NynorsX

• Last ned prosjektfilene: NynorsX ZIP.
• Pakk ut den nedlastede filen til Downloads mappen din.

3. Lage mappene og sette opp Docker Container

Kjør følgende kommandoer i terminalen din, én om gangen:

mkdir -p /Users/$USER/Documents/eksamensFiler/ferdigTekst

Lager to mapper (eksamensFiler and ferdigTekst) som programmet overvåker by default.

cd /Users/$USER/Downloads/nynorsX-main

Går inn i NynorsX kildekode mappen du lastet ned.

sudo docker build -t apertium --no-cache .

Bygger Docker image for å kjøre Apertium isolert uten GUI.

4. Start the Docker Container

docker run --name apertiumDockerContainer -t -d -v /Users/$USER/Documents/eksamensFiler:/src apertium

Starter Docker kontaineren, og mounter eksamensFiler mappen inn i kontaineren.

5. Run the Python Script

python3 folderWatcherAperitumLocal.py

Starter scriptet som overvåker filer og iverksetter oversettelse av filer.

---

Bruke NynorsX

1. WORD -> Save As

   • Plasser en Nynorsk-tekstfil (f.eks. (e.g., eksamen.docx) i ~/Documents/eksamensFiler/.
   • Viktig: Bruk filnavn uten mellomrom (f.eks. (e.g., eksamen.docx, ikke: my exam.docx).

2. Vent på oversettelse:

   • Skriptet oppdager filen og oversetter den til Bokmål.
   • Sjekk ~/Documents/eksamensFiler/ferdigTekst/ for resultatet (f.eks. eksamen59430.docx).
   • Filen du legger inn i eksamensFiler mappen vil bli slettet, så sørg for at det ikke er originalen.

3. Sjekk den oversatte teksten

   • Åpne den oversatte filen i en teksteditor eller Word for å verifisere Bokmål-oversettelsen. Du må kanskje fjerne tegnet: *,som vil vises når en oversettelse er usikker.

Eksempel

1. Flytt/Lagre en test.docx fil i ~/Documents/eksamensFiler/ med en tekst på Bokmål:

   Jeg liker å lese bøker.
   

2. Vent noen sekunder.
3. Sjekk ~/Documents/eksamensFiler/ferdigTekst/ for test.doxc:

   Eg likar å lese bøker.
   

---

Feilsøking

Issue	Løsning
Docker not running	Start Docker Desktop og verifiser med docker info.
Python script fails	Sørg for at Python3 er installert (python3 --version) og at skriptet er i riktig katalog.
No output file	Bekreft at data-inn er i ~/Documents/eksamensFiler/ og ikke inneholder mellomrom i filnavnet.
Container not starting	Sjekk container-status (docker ps -a) og logger (docker logs apertiumDockerContainer).).

Trenger du hjelp?:

• Lag en issue på GitHub.
• Sjekk ut Apertium Wiki.
• Be om at Ivar Aasen ikke straffer deg for dine synder.

---

Hvordan stoppe programmet?

1. Stopp Python scriptet: Trykk Ctrl+C i terminalen.
2. Stopp Docker kontaineren:

   docker stop apertiumDockerContainer

3. (Valgfritt) Slett kontaineren:

   docker rm apertiumDockerContainer

---

Bli en del av sidemålsmotstandarane

Ønsker du å bidra? Fork GitHub repository, gjør endringer, og submit en pull request. Forslag til funksjoner eller feilrettinger er velkomne!