ciiic-translation-rules 1.0.0

package/README.md

@@ -0,0 +1,201 @@
+# ciiic-translation-rules
+
+Shared translation rules and terminology for CIIIC content (English/Dutch).
+
+## Installation
+
+```bash
+npm install ciiic-translation-rules
+```
+
+## Usage
+
+### Get LLM Translation Prompts
+
+```typescript
+import { getDutchGuidelines, getEnglishGuidelines, getGuidelines } from 'ciiic-translation-rules';
+
+// Get guidelines for translating TO Dutch
+const dutchPrompt = getDutchGuidelines();
+
+// Get guidelines for translating TO English
+const englishPrompt = getEnglishGuidelines();
+
+// Or use the helper with target language
+const guidelines = getGuidelines('nl'); // or 'en'
+```
+
+### Manual Prompt (Markdown)
+
+For use cases where you can't programmatically include the rules (e.g., pasting into ChatGPT):
+
+```typescript
+import { generateMarkdownPrompt } from 'ciiic-translation-rules';
+
+// Get a complete markdown prompt with all rules
+const markdownPrompt = generateMarkdownPrompt();
+```
+
+Or use the pre-generated file included in the package: `TRANSLATION_PROMPT.md`
+
+To regenerate after editing rules:
+
+```bash
+npm run generate-prompt
+```
+
+### Access Raw Rules
+
+```typescript
+import { TRANSLATION_RULES } from 'ciiic-translation-rules';
+
+// Access organisation mappings
+console.log(TRANSLATION_RULES.organisations);
+
+// Access funding call translations
+console.log(TRANSLATION_RULES.fundingCalls);
+
+// Access CTA/button translations
+console.log(TRANSLATION_RULES.ctaTranslations);
+
+// Access CIIIC-specific terms
+console.log(TRANSLATION_RULES.ciiicSpecifics);
+
+// Access terminology mappings
+console.log(TRANSLATION_RULES.terminology);
+
+// Access newsletter phrases
+console.log(TRANSLATION_RULES.newsletterPhrases);
+
+// Access terms that should never be translated
+console.log(TRANSLATION_RULES.neverTranslate);
+```
+
+### Utility Functions
+
+```typescript
+import {
+  translateFundingCall,
+  translateOrganisation,
+  shouldNeverTranslate,
+} from 'ciiic-translation-rules';
+
+// Translate a funding call name
+const englishName = translateFundingCall(
+  'CIIIC Start: verkennend onderzoek naar immersive experiences',
+  'en'
+);
+// 'CIIIC Start: exploratory research into immersive experiences'
+
+// Translate an organisation name
+const dutchName = translateOrganisation('Creative Industries Fund NL', 'nl');
+// 'Stimuleringsfonds Creatieve Industrie'
+
+// Check if a term should never be translated
+shouldNeverTranslate('ADRIE'); // true
+shouldNeverTranslate('hello'); // false
+```
+
+## What's Included
+
+### Organisation Mappings
+- Stimuleringsfonds Creatieve Industrie ↔ Creative Industries Fund NL
+- Ministerie van OCW ↔ Ministry of Education, Culture and Science
+- Rijksoverheid ↔ Dutch Government
+- Mondriaan Fonds ↔ Mondriaan Fund
+- Filmfonds ↔ Netherlands Film Fund
+
+### Funding Call Translations
+- CIIIC Start: verkennend onderzoek... ↔ CIIIC Start: exploratory research...
+- CIIIC Kern: Vraaggestuurd... ↔ CIIIC Kern: Demand-driven...
+- ADRIE (same in both languages)
+- ITLI (same in both languages)
+
+### Button/CTA Text
+- Lees meer / Lees verder → Read more
+- Meer informatie → More information
+- Schrijf je in / Meld je aan / Aanmelden → Register / Sign up
+- Bekijk de agenda → View the agenda
+- Naar de website → Go to website
+- Deel dit bericht → Share this
+
+### CIIIC-Specific Terms
+- Programmadirecteur → Programme Director
+- Projectleider → Project Lead
+- Communicatie & Marketing → Communications & Marketing
+- Adviseur → Advisor
+- Coördinator → Coordinator
+- Communityplatform → Community Platform
+
+### Grant/Funding Terminology
+- subsidie / financiering ↔ grant / funding
+- aanvraag ↔ application
+- bijdrage ↔ contribution / grant
+- toekenning ↔ award / allocation
+- begroting ↔ budget
+- penvoerder ↔ lead applicant / consortium lead
+
+### Sector Terminology
+- creatieve industrie ↔ creative industries
+- games / gamesector ↔ games / games sector
+- extended reality / XR ↔ extended reality / XR
+- ontwikkelaar ↔ developer
+- ontwerper ↔ designer
+- kunstenaar ↔ artist
+- maker ↔ maker / creator
+
+### Newsletter Phrases
+- Bekijk deze e-mail in je browser → View this email in your browser
+- Uitschrijven → Unsubscribe
+- Voorkeuren aanpassen → Update your preferences
+- Beste lezer → Dear reader
+- Met vriendelijke groet → Kind regards
+- Hartelijke groet → Warm regards
+
+### Never Translate
+CIIIC, ADRIE, ITLI, IX, IFFR, Eurosonic Noorderslag, ESNS, @CIIIC_NL, #immersiveexperiences, Circle, Notion, Dutch Game Garden, Indigo, Control Conference
+
+### Language-Specific Rules
+
+**Dutch:**
+- Sentence case for headlines (not Title Case)
+- Informal "je/jij" (not formal "u")
+
+**English:**
+- British English spellings (colour, organise, centre)
+- British vocabulary (programme, behaviour)
+
+## Updating Rules
+
+Edit `src/index.ts` and update the `TRANSLATION_RULES` object. Then regenerate the prompt and publish:
+
+```bash
+npm run generate-prompt
+npm version patch  # or minor/major
+npm publish
+```
+
+Applications using this package can update with:
+
+```bash
+npm update ciiic-translation-rules
+```
+
+## TypeScript
+
+Full TypeScript support with exported types:
+
+```typescript
+import type {
+  TranslationRules,
+  OrganisationMapping,
+  FundingCallMapping,
+  TerminologyMapping,
+  OfficialTerm,
+  SimpleTranslation,
+} from 'ciiic-translation-rules';
+```
+
+## License
+
+MIT

package/TRANSLATION_PROMPT.md

@@ -0,0 +1,121 @@
+# CIIIC Translation Rules
+
+Use these rules when translating content between Dutch and English for CIIIC.
+
+## Organisation Names
+
+| Dutch | English | Notes |
+|-------|---------|-------|
+| Stimuleringsfonds Creatieve Industrie | Creative Industries Fund NL | Never shorten to just "Stimuleringsfonds" - always use the full name |
+| Ministerie van OCW | Ministry of Education, Culture and Science |  |
+| Rijksoverheid | Dutch Government |  |
+| Mondriaan Fonds | Mondriaan Fund |  |
+| Filmfonds | Netherlands Film Fund |  |
+
+## Funding Call Translations
+
+Use these exact translations for funding call names:
+
+| Dutch | English | Notes |
+|-------|---------|-------|
+| CIIIC Start: verkennend onderzoek naar immersive experiences | CIIIC Start: exploratory research into immersive experiences |  |
+| CIIIC Kern: Vraaggestuurd praktijkgericht onderzoek naar immersive experiences | CIIIC Kern: Demand-driven practice-oriented research into immersive experiences |  |
+| Artistic & Design Research for Immersive Experiences (ADRIE) | Artistic & Design Research for Immersive Experiences (ADRIE) | Same in both languages |
+| Immersive Tech for Learning & Inclusion (ITLI) | Immersive Tech for Learning & Inclusion (ITLI) | Same in both languages |
+
+## Button/CTA Text
+
+| Dutch | English |
+|-------|---------|
+| Lees meer | Read more |
+| Lees verder | Read more |
+| Meer informatie | More information |
+| Schrijf je in | Register |
+| Meld je aan | Sign up |
+| Aanmelden | Register |
+| Bekijk de agenda | View the agenda |
+| Naar de website | Go to website |
+| Download | Download |
+| Deel dit bericht | Share this |
+
+## CIIIC-Specific Terms
+
+| Dutch | English |
+|-------|---------|
+| Programmadirecteur | Programme Director |
+| Projectleider | Project Lead |
+| Communicatie & Marketing | Communications & Marketing |
+| Adviseur | Advisor |
+| Coördinator | Coordinator |
+| Communityplatform | Community Platform |
+
+## Terminology
+
+These terms can be used interchangeably or have specific translations:
+
+| Dutch | English | Notes |
+|-------|---------|-------|
+| immersive experiences, immersieve ervaringen | immersive experiences | In Dutch, both "immersive experiences" (English) and "immersieve ervaringen" are acceptable. The abbreviation "IX" is common in both languages. |
+| call, regeling | call, funding call, grant scheme | The English word "call" is commonly used in Dutch. "Regeling" is the formal Dutch synonym. |
+| subsidie, financiering | grant, funding |  |
+| aanvraag, aanvragen | application, apply |  |
+| bijdrage | contribution, grant |  |
+| toekenning | award, allocation |  |
+| begroting | budget |  |
+| deadline, sluitingsdatum | deadline, closing date |  |
+| honorarium | fee, honorarium |  |
+| penvoerder | lead applicant, consortium lead |  |
+| consortium | consortium |  |
+| creatieve industrie | creative industries |  |
+| games, gamesector | games, games sector |  |
+| extended reality, XR | extended reality, XR |  |
+| virtual reality, VR | virtual reality, VR |  |
+| augmented reality, AR | augmented reality, AR |  |
+| ontwikkelaar | developer |  |
+| ontwerper | designer |  |
+| kunstenaar | artist |  |
+| maker | maker, creator |  |
+
+## Newsletter-Specific Phrases
+
+| Dutch | English |
+|-------|---------|
+| Bekijk deze e-mail in je browser | View this email in your browser |
+| Uitschrijven | Unsubscribe |
+| Voorkeuren aanpassen | Update your preferences |
+| Beste lezer | Dear reader |
+| Met vriendelijke groet | Kind regards |
+| Hartelijke groet | Warm regards |
+| In deze nieuwsbrief | In this newsletter |
+
+## Official Terms
+
+Keep these in their original language (use quotes if needed):
+
+- **Rijksbrede Innovatie Agenda** (dutch) - No official English translation - keep in Dutch with quotes
+
+## Never Translate
+
+These terms should NEVER be translated - keep them exactly as-is:
+
+```
+CIIIC, ADRIE, ITLI, IX, IFFR, Eurosonic Noorderslag, ESNS, @CIIIC_NL, #immersiveexperiences, Circle, Notion, Dutch Game Garden, Indigo, Control Conference
+```
+
+## General Rules
+
+### Personal Names
+- People's names must NEVER be translated
+- Example: "Jan de Vries" stays "Jan de Vries", NOT "John of Vries"
+
+### Dutch-Specific
+- Headlines and titles: Use sentence case only (first letter capitalised, rest lowercase)
+- Use informal Dutch: Always use "je/jij/jouw" instead of "u/uw"
+- Maintain a friendly but professional tone
+
+### English-Specific
+- Use British English spellings (colour, organise, centre)
+- British vocabulary: "programme" (not "program"), "behaviour", "favour"
+
+### General Principle
+It is acceptable and often preferable to leave some terms in their original language. Proper nouns, programme names, personal names, and official terminology should generally remain unchanged or use the official translation if one exists.

package/dist/index.d.mts

@@ -0,0 +1,84 @@
+/**
+ * CIIIC Translation Rules
+ *
+ * Shared translation rules and terminology for English <-> Dutch translation.
+ * Used across CIIIC applications for consistent translations.
+ *
+ * @packageDocumentation
+ */
+interface OrganisationMapping {
+    dutch: string;
+    english: string;
+    notes?: string;
+}
+interface SimpleTranslation {
+    dutch: string;
+    english: string;
+}
+interface FundingCallMapping {
+    dutch: string;
+    english: string;
+    notes?: string;
+}
+interface TerminologyMapping {
+    dutch: string[];
+    english: string[];
+    notes?: string;
+}
+interface OfficialTerm {
+    term: string;
+    language: 'dutch' | 'english';
+    notes?: string;
+}
+interface TranslationRules {
+    organisations: OrganisationMapping[];
+    fundingCalls: FundingCallMapping[];
+    terminology: TerminologyMapping[];
+    neverTranslate: string[];
+    officialTerms: OfficialTerm[];
+    ctaTranslations: SimpleTranslation[];
+    ciiicSpecifics: SimpleTranslation[];
+    newsletterPhrases: SimpleTranslation[];
+}
+/**
+ * All translation rules and terminology mappings.
+ * Edit this object to update translation guidelines across all applications.
+ */
+declare const TRANSLATION_RULES: TranslationRules;
+/**
+ * Generate the terminology rules section for LLM prompts
+ */
+declare function generateTerminologyPrompt(): string;
+/**
+ * Get Dutch-specific translation guidelines for LLM prompts
+ */
+declare function getDutchGuidelines(): string;
+/**
+ * Get English-specific translation guidelines for LLM prompts
+ */
+declare function getEnglishGuidelines(): string;
+/**
+ * Get guidelines for a specific target language
+ */
+declare function getGuidelines(targetLanguage: 'en' | 'nl'): string;
+/**
+ * Look up the translation for a funding call name
+ * Returns undefined if no mapping exists
+ */
+declare function translateFundingCall(name: string, targetLanguage: 'en' | 'nl'): string | undefined;
+/**
+ * Look up the translation for an organisation name
+ * Returns undefined if no mapping exists
+ */
+declare function translateOrganisation(name: string, targetLanguage: 'en' | 'nl'): string | undefined;
+/**
+ * Check if a term should never be translated
+ */
+declare function shouldNeverTranslate(term: string): boolean;
+/**
+ * Generate a complete markdown prompt with all translation rules.
+ * Useful for manual use cases where you can't programmatically include the rules.
+ */
+declare function generateMarkdownPrompt(): string;
+
+export { type FundingCallMapping, type OfficialTerm, type OrganisationMapping, type SimpleTranslation, TRANSLATION_RULES, type TerminologyMapping, type TranslationRules, generateMarkdownPrompt, generateTerminologyPrompt, getDutchGuidelines, getEnglishGuidelines, getGuidelines, shouldNeverTranslate, translateFundingCall, translateOrganisation };

package/dist/index.d.ts

@@ -0,0 +1,84 @@
+/**
+ * CIIIC Translation Rules
+ *
+ * Shared translation rules and terminology for English <-> Dutch translation.
+ * Used across CIIIC applications for consistent translations.
+ *
+ * @packageDocumentation
+ */
+interface OrganisationMapping {
+    dutch: string;
+    english: string;
+    notes?: string;
+}
+interface SimpleTranslation {
+    dutch: string;
+    english: string;
+}
+interface FundingCallMapping {
+    dutch: string;
+    english: string;
+    notes?: string;
+}
+interface TerminologyMapping {
+    dutch: string[];
+    english: string[];
+    notes?: string;
+}
+interface OfficialTerm {
+    term: string;
+    language: 'dutch' | 'english';
+    notes?: string;
+}
+interface TranslationRules {
+    organisations: OrganisationMapping[];
+    fundingCalls: FundingCallMapping[];
+    terminology: TerminologyMapping[];
+    neverTranslate: string[];
+    officialTerms: OfficialTerm[];
+    ctaTranslations: SimpleTranslation[];
+    ciiicSpecifics: SimpleTranslation[];
+    newsletterPhrases: SimpleTranslation[];
+}
+/**
+ * All translation rules and terminology mappings.
+ * Edit this object to update translation guidelines across all applications.
+ */
+declare const TRANSLATION_RULES: TranslationRules;
+/**
+ * Generate the terminology rules section for LLM prompts
+ */
+declare function generateTerminologyPrompt(): string;
+/**
+ * Get Dutch-specific translation guidelines for LLM prompts
+ */
+declare function getDutchGuidelines(): string;
+/**
+ * Get English-specific translation guidelines for LLM prompts
+ */
+declare function getEnglishGuidelines(): string;
+/**
+ * Get guidelines for a specific target language
+ */
+declare function getGuidelines(targetLanguage: 'en' | 'nl'): string;
+/**
+ * Look up the translation for a funding call name
+ * Returns undefined if no mapping exists
+ */
+declare function translateFundingCall(name: string, targetLanguage: 'en' | 'nl'): string | undefined;
+/**
+ * Look up the translation for an organisation name
+ * Returns undefined if no mapping exists
+ */
+declare function translateOrganisation(name: string, targetLanguage: 'en' | 'nl'): string | undefined;
+/**
+ * Check if a term should never be translated
+ */
+declare function shouldNeverTranslate(term: string): boolean;
+/**
+ * Generate a complete markdown prompt with all translation rules.
+ * Useful for manual use cases where you can't programmatically include the rules.
+ */
+declare function generateMarkdownPrompt(): string;
+
+export { type FundingCallMapping, type OfficialTerm, type OrganisationMapping, type SimpleTranslation, TRANSLATION_RULES, type TerminologyMapping, type TranslationRules, generateMarkdownPrompt, generateTerminologyPrompt, getDutchGuidelines, getEnglishGuidelines, getGuidelines, shouldNeverTranslate, translateFundingCall, translateOrganisation };