deepl-cli/examples/09-xml-tag-handling.sh at main · DeepLcom/deepl-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
#!/bin/bash
# Example 9: Advanced XML Tag Handling
# Demonstrates fine-tuned control over XML/HTML translation with tag handling parameters

set -e  # Exit on error

echo "=== DeepL CLI Example 9: Advanced XML Tag Handling ==="
echo

# Check if API key is configured
if ! deepl auth show &>/dev/null; then
  echo "❌ Error: API key not configured"
  echo "Run: deepl auth set-key YOUR_API_KEY"
  exit 1
fi

echo "✓ API key configured"
echo

# Create temporary directory for example files
TEMP_DIR="/tmp/deepl-example-09"
mkdir -p "$TEMP_DIR"

echo "1. Basic XML tag preservation (default behavior)"
echo "   Input: <p>Hello world</p>"
deepl translate "<p>Hello world</p>" --to es --tag-handling xml
echo

echo "1b. HTML tag handling mode:"
echo "    Use --tag-handling html for HTML content (smarter than xml for HTML):"
deepl translate "<p>Hello <strong>world</strong>, welcome to <a href='#'>our site</a></p>" --to es --tag-handling html
echo

echo "2. Disable automatic XML structure detection"
echo "   Useful when you want manual control over tag handling"
echo "   Input: <doc><section>Welcome to our platform</section></doc>"
deepl translate "<doc><section>Welcome to our platform</section></doc>" --to es --tag-handling xml --outline-detection false
echo

echo "3. Specify tags that split sentences"
echo "   Tags like <br/> and <hr/> act as sentence boundaries"
echo "   Input: <div>First sentence<br/>Second sentence<hr/>Third sentence</div>"
deepl translate "<div>First sentence<br/>Second sentence<hr/>Third sentence</div>" --to es --tag-handling xml --splitting-tags "br,hr"
echo

echo "4. Specify non-splitting tags (preserve content structure)"
echo "   Code blocks and preformatted text shouldn't be split"
echo "   Input: <doc><code>let x = 1; let y = 2;</code><p>This is a paragraph.</p></doc>"
deepl translate "<doc><code>let x = 1; let y = 2;</code><p>This is a paragraph.</p></doc>" --to es --tag-handling xml --non-splitting-tags "code,pre"
echo

echo "5. Ignore specific tags and their content"
echo "   Scripts, styles, and other non-translatable content"
# Create a test HTML file
cat > "$TEMP_DIR/page.html" << 'EOF'
<html>
<head>
  <style>body { color: blue; }</style>
  <script>console.log("Hello");</script>
</head>
<body>
  <h1>Welcome to our website</h1>
  <p>This content will be translated.</p>
  <noscript>Please enable JavaScript.</noscript>
</body>
</html>
EOF

echo "   Translating HTML file while ignoring <script>, <style>, and <noscript> tags..."
deepl translate "$TEMP_DIR/page.html" --to es --tag-handling xml --ignore-tags "script,style,noscript" --output "$TEMP_DIR/page.es.html"
echo "   ✓ Translated to: $TEMP_DIR/page.es.html"
echo "   (Scripts and styles remain untranslated)"
echo

echo "6. Combine multiple XML tag handling options"
echo "   Fine-tuned control for complex XML strings"
# Create a complex XML string (inline translation, not document translation)
XML_INPUT='<article><content><section><h1>Technical Documentation</h1><p>This is the introduction.</p><code>function example() { return true; }</code><p>More content here.<br/>Next line after break.</p></section><script>trackPageView();</script></content></article>'

echo "   Input XML string:"
echo "   $XML_INPUT"
echo
echo "   Using all XML tag handling options together:"
deepl translate "$XML_INPUT" --to de --tag-handling xml \
  --outline-detection false \
  --splitting-tags "br,hr,section" \
  --non-splitting-tags "code,pre,kbd" \
  --ignore-tags "script,style"

echo
echo "   ✓ Translated complex XML with custom tag handling"
echo

echo "7. Real-world example: Translate technical documentation HTML"
# Create a technical doc example
cat > "$TEMP_DIR/docs.html" << 'EOF'
<html>
<head>
  <title>API Documentation</title>
  <style>.highlight { background: yellow; }</style>
</head>
<body>
  <h1>REST API Reference</h1>
  <p>Welcome to our API documentation.</p>

  <h2>Authentication</h2>
  <p>Use the following code to authenticate:</p>
  <pre>
const apiKey = "your-api-key";
fetch("/api/endpoint", {
  headers: { "Authorization": `Bearer ${apiKey}` }
});
  </pre>

  <p>For more information, visit our website.</p>

  <script>
  // Analytics code
  ga('send', 'pageview');
  </script>
</body>
</html>
EOF

echo "   Translating technical documentation with code preservation:"
deepl translate "$TEMP_DIR/docs.html" --to fr --tag-handling xml \
  --non-splitting-tags "pre,code" \
  --ignore-tags "script,style" \
  --output "$TEMP_DIR/docs.fr.html"

echo "   ✓ Translated technical docs to French"
echo "   - Code blocks preserved (not split into sentences)"
echo "   - Scripts and styles ignored (not translated)"
echo "   - Output: $TEMP_DIR/docs.fr.html"
echo

echo "8. Use case: Localize XML configuration strings"
# Create a config XML string (inline translation)
CONFIG_XML='<config><app><name>MyApplication</name><welcome-message>Welcome to our application</welcome-message><help-text>Click here for help</help-text></app><system><version>1.0.0</version><api-endpoint>https://api.example.com</api-endpoint></system></config>'

echo "   Input XML config:"
echo "   $CONFIG_XML"
echo
echo "   Translating app messages while preserving system config:"
deepl translate "$CONFIG_XML" --to ja --tag-handling xml \
  --non-splitting-tags "system,version,api-endpoint"

echo
echo "   ✓ Translated config XML to Japanese"
echo "   - User-facing messages translated"
echo "   - System configuration preserved"
echo

echo "Tip: XML tag handling parameters are powerful for:"
echo "  • Localizing HTML websites"
echo "  • Translating technical documentation"
echo "  • Processing custom XML formats"
echo "  • Preserving code blocks and special content"
echo "  • Fine-tuned control over sentence splitting"
echo

echo "Note: All XML tag handling flags require --tag-handling xml"
echo
echo "   XML tag handling works with:"
echo "   • Inline XML/HTML strings (as shown in examples 1-4, 6, 8)"
echo "   • HTML document files (as shown in examples 5, 7)"
echo "   • Text translation with embedded XML/HTML"
echo

echo "Cleaning up temporary files..."
rm -rf "$TEMP_DIR"
echo "✓ Cleanup complete"

echo
echo "=== All examples completed successfully! ==="