hashfix/support.html at main · David-Summers/hashfix · 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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>HashFix Support</title>
    <style>
        * {
            margin: 0;
            padding: 0;
            box-sizing: border-box;
        }

        body {
            font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
            background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
            padding: 40px 20px;
            min-height: 100vh;
        }

        .container {
            max-width: 800px;
            margin: 0 auto;
            background: white;
            border-radius: 12px;
            padding: 40px;
            box-shadow: 0 8px 24px rgba(0, 0, 0, 0.15);
        }

        h1 {
            color: #667eea;
            margin-bottom: 10px;
            font-size: 32px;
        }

        h2 {
            color: #333;
            margin-top: 30px;
            margin-bottom: 15px;
            font-size: 22px;
            border-bottom: 2px solid #667eea;
            padding-bottom: 8px;
        }

        h3 {
            color: #555;
            margin-top: 20px;
            margin-bottom: 10px;
            font-size: 18px;
        }

        p {
            color: #666;
            line-height: 1.6;
            margin-bottom: 15px;
        }

        ul, ol {
            margin-left: 25px;
            margin-bottom: 15px;
            color: #666;
        }

        li {
            margin-bottom: 8px;
            line-height: 1.5;
        }

        code {
            background: #f4f4f4;
            padding: 2px 6px;
            border-radius: 3px;
            font-family: 'Courier New', monospace;
            color: #d63384;
        }

        .example-box {
            background: #f8f9fa;
            border-left: 4px solid #667eea;
            padding: 15px;
            margin: 15px 0;
            border-radius: 4px;
        }

        .warning-box {
            background: #fff3cd;
            border-left: 4px solid #ffc107;
            padding: 15px;
            margin: 15px 0;
            border-radius: 4px;
        }

        .info-box {
            background: #e7f3ff;
            border-left: 4px solid #0066cc;
            padding: 15px;
            margin: 15px 0;
            border-radius: 4px;
        }

        .contact {
            background: #667eea;
            color: white;
            padding: 20px;
            border-radius: 8px;
            margin-top: 30px;
            text-align: center;
        }

        .contact a {
            color: white;
            text-decoration: underline;
        }

        table {
            width: 100%;
            border-collapse: collapse;
            margin: 15px 0;
        }

        table th {
            background: #667eea;
            color: white;
            padding: 12px;
            text-align: left;
        }

        table td {
            border: 1px solid #ddd;
            padding: 10px;
        }

        table tr:nth-child(even) {
            background: #f8f9fa;
        }
    </style>
</head>
<body>
    <div class="container">
        <h1>HashFix Support & Documentation</h1>
        <p><strong>Version:</strong> 1.0.0 | <strong>Author:</strong> Mark Robinson</p>

        <h2>What is HashFix?</h2>
        <p>
            HashFix is an Outlook add-in that automatically corrects improperly formatted hashtags in your emails before sending.
            It runs silently in the background and fixes common hashtag formatting mistakes without interrupting your workflow.
        </p>

        <h2>How It Works</h2>
        <p>
            When you click "Send" in Outlook, HashFix automatically scans your email and fixes any hashtag formatting issues.
            The process is completely automatic and happens in milliseconds.
        </p>

        <h3>What Gets Fixed?</h3>
        <table>
            <tr>
                <th>Before (Incorrect)</th>
                <th>After (Fixed)</th>
            </tr>
            <tr>
                <td><code># tag</code></td>
                <td><code>#tag</code></td>
            </tr>
            <tr>
                <td><code>#  marketing</code> (double space)</td>
                <td><code>#marketing</code></td>
            </tr>
            <tr>
                <td><code># 2024</code></td>
                <td><code>#2024</code></td>
            </tr>
            <tr>
                <td><code>#    team</code> (multiple spaces)</td>
                <td><code>#team</code></td>
            </tr>
        </table>

        <h2>Features</h2>
        <ul>
            <li><strong>Automatic Correction:</strong> Fixes hashtags without requiring manual intervention</li>
            <li><strong>OnSend Event:</strong> Runs when you click Send, ensuring all emails are properly formatted</li>
            <li><strong>Activity Tracking:</strong> View statistics and history in the taskpane</li>
            <li><strong>HTML-Safe:</strong> Preserves email formatting, links, and styles</li>
            <li><strong>Soft-Block Mode:</strong> Allows sending even if processing fails (fail-safe)</li>
        </ul>

        <h2>Installation</h2>

        <h3>Method 1: Outlook on the Web (Office 365)</h3>

        <h4>New Outlook Web (Current UI)</h4>
        <ol>
            <li>Go to <a href="https://outlook.office.com">Outlook on the web</a> and sign in</li>
            <li>Click the <strong>Apps</strong> icon (waffle/grid icon) in the left sidebar</li>
            <li>Click <strong>Get Add-ins</strong> (or search for it)</li>
            <li>Select <strong>My add-ins</strong> tab on the left</li>
            <li>Scroll down and click <strong>➕ Add a custom add-in</strong> → <strong>Add from file</strong></li>
            <li>Download the manifest file: <a href="https://David-Summers.github.io/hashfix/manifest.xml">manifest.xml</a></li>
            <li>Click <strong>Browse</strong> and select the downloaded manifest.xml file</li>
            <li>Click <strong>Upload</strong> and accept the warning</li>
            <li>The add-in will appear in the ribbon when composing emails</li>
        </ol>

        <h4>Classic Outlook Web (Older UI)</h4>
        <ol>
            <li>Go to <a href="https://outlook.office.com">Outlook on the web</a></li>
            <li>Click the <strong>Settings</strong> gear icon (top right)</li>
            <li>Search for "add-ins" or go to <strong>View all Outlook settings</strong> → <strong>General</strong> → <strong>Manage add-ins</strong></li>
            <li>Click <strong>My add-ins</strong> (left panel)</li>
            <li>Under <strong>Custom add-ins</strong>, click <strong>➕ Add a custom add-in</strong> → <strong>Add from file</strong></li>
            <li>Download and upload the manifest.xml file</li>
            <li>Accept the warning and click <strong>Install</strong></li>
        </ol>

        <h3>Method 2: New Outlook for Windows (Microsoft 365)</h3>
        <ol>
            <li>Open <strong>New Outlook</strong> (toggle in top-right corner if in classic Outlook)</li>
            <li>Click <strong>Apps</strong> in the left navigation bar</li>
            <li>Click <strong>Get Add-ins</strong></li>
            <li>Select <strong>My add-ins</strong> tab</li>
            <li>Click <strong>➕ Add a custom add-in</strong> → <strong>Add from file</strong></li>
            <li>Download manifest.xml from the repository</li>
            <li>Browse to the file and click <strong>Upload</strong></li>
            <li>Restart Outlook</li>
        </ol>

        <h3>Method 3: Classic Outlook Desktop (Windows)</h3>
        <ol>
            <li>Open <strong>Outlook Desktop</strong></li>
            <li>Go to <strong>Home</strong> tab → <strong>Get Add-ins</strong> (or <strong>Store</strong>)</li>
            <li>Click <strong>My add-ins</strong> in the left panel</li>
            <li>Click <strong>➕ Add a custom add-in</strong> → <strong>Add from file</strong>
                <ul>
                    <li>If you see "Add from URL", you can use: <code>https://David-Summers.github.io/hashfix/manifest.xml</code></li>
                </ul>
            </li>
            <li>Browse to the downloaded manifest.xml file</li>
            <li>Click <strong>Install</strong></li>
            <li>Restart Outlook</li>
        </ol>

        <h3>Method 4: Outlook for Mac</h3>
        <ol>
            <li>Download the manifest.xml file from: <a href="https://David-Summers.github.io/hashfix/manifest.xml">manifest.xml</a></li>
            <li>Open <strong>Finder</strong> and press <strong>Cmd+Shift+G</strong> (Go to Folder)</li>
            <li>Paste this path: <code>~/Library/Containers/com.microsoft.Outlook/Data/Documents/wef</code></li>
            <li>Create the <code>wef</code> folder if it doesn't exist</li>
            <li>Copy manifest.xml into the wef folder</li>
            <li>Restart Outlook</li>
        </ol>

        <h3>Download Manifest File</h3>
        <p>
            You can download the manifest file directly from:<br>
            <code>https://David-Summers.github.io/hashfix/manifest.xml</code>
        </p>
        <p>
            Right-click and "Save as" or use curl/wget:
        </p>
        <pre style="background: #f4f4f4; padding: 10px; border-radius: 4px;">curl -O https://David-Summers.github.io/hashfix/manifest.xml</pre>

        <div class="info-box">
            <strong>Note:</strong> HashFix requires Outlook Mailbox API version 1.10 or higher.
            This is available in modern versions of Outlook (2021+, Outlook on the web, and Microsoft 365).
        </div>

        <h2>Usage</h2>

        <h3>Automatic Mode (Default)</h3>
        <p>
            Simply compose and send emails normally. HashFix will automatically scan and fix hashtags when you click "Send".
            You don't need to do anything special.
        </p>

        <h3>Viewing Activity</h3>
        <ol>
            <li>In Outlook, compose a new email</li>
            <li>Click the "HashFix" button in the ribbon</li>
            <li>The taskpane will open showing:
                <ul>
                    <li>Current status</li>
                    <li>Total fixes applied</li>
                    <li>Session statistics</li>
                    <li>Recent activity log</li>
                </ul>
            </li>
        </ol>

        <h2>Troubleshooting</h2>

        <h3>Add-in not appearing in Outlook</h3>
        <ul>
            <li>Ensure you're using a supported version of Outlook</li>
            <li>Try restarting Outlook</li>
            <li>Check that the manifest URL is correct</li>
            <li>Verify your internet connection (add-in files are hosted on GitHub Pages)</li>
        </ul>

        <h3>Hashtags not being fixed</h3>
        <ul>
            <li>Check the browser console (F12) for error messages</li>
            <li>Ensure the add-in is enabled in Outlook settings</li>
            <li>Verify that Office.js is loading correctly</li>
            <li>Try sending a test email with <code># test</code> to verify functionality</li>
        </ul>

        <h3>TaskPane shows "0" fixes but hashtags were fixed</h3>
        <ul>
            <li>SessionStorage might have been cleared</li>
            <li>Click "Refresh Activity" to reload the logs</li>
            <li>Note: Statistics reset when you close Outlook</li>
        </ul>

        <div class="warning-box">
            <strong>Important:</strong> If HashFix encounters an error while processing your email, it will still allow
            the email to send (fail-safe mode). Check the browser console for any error messages.
        </div>

        <h2>Privacy & Security</h2>
        <p>
            HashFix processes your email content locally in the browser. No email content is sent to external servers.
            The add-in only:
        </p>
        <ul>
            <li>Reads the email body when you click "Send"</li>
            <li>Modifies hashtag formatting</li>
            <li>Stores anonymous statistics in sessionStorage (local only)</li>
        </ul>

        <h2>Permissions Required</h2>
        <ul>
            <li><strong>ReadWriteMailbox:</strong> Required to read and modify email content during the send event</li>
        </ul>

        <h2>Technical Details</h2>

        <h3>Event-Based Architecture</h3>
        <p>
            HashFix uses the Outlook <code>OnMessageSend</code> event with <strong>SoftBlock</strong> mode.
            This means the add-in runs automatically when you send emails and allows sending even if processing fails.
        </p>

        <h3>Pattern Matching</h3>
        <p>
            The add-in uses the regular expression <code>/#\s+(\w+)/g</code> to find and fix hashtags.
            This matches a hash symbol followed by one or more spaces, then word characters or numbers.
        </p>

        <h3>HTML Preservation</h3>
        <p>
            HashFix uses DOMParser to safely parse and modify email HTML without breaking formatting,
            links, images, or other content.
        </p>

        <h2>Frequently Asked Questions</h2>

        <h3>Does HashFix work with plain text emails?</h3>
        <p>
            Yes, HashFix works with both HTML and plain text emails. The add-in reads the email as HTML
            (which Outlook provides even for plain text) and preserves the format.
        </p>

        <h3>Can I disable HashFix temporarily?</h3>
        <p>
            Yes, you can disable the add-in in Outlook settings:
        </p>
        <ul>
            <li>Go to "Get Add-ins" → "My add-ins"</li>
            <li>Find "HashFix On-Send" and toggle it off</li>
        </ul>

        <h3>Does it work in Outlook Mobile?</h3>
        <p>
            Currently, OnMessageSend events are not supported in Outlook Mobile. HashFix only works in
            Outlook Desktop and Outlook on the Web.
        </p>

        <h3>Can I customize what gets fixed?</h3>
        <p>
            The current version focuses on hashtag spacing issues. If you'd like additional functionality,
            please contact the developer.
        </p>

        <h2>Version History</h2>
        <ul>
            <li><strong>1.0.0</strong> (2025) - Initial release
                <ul>
                    <li>Automatic hashtag spacing correction</li>
                    <li>OnMessageSend event handler</li>
                    <li>Activity tracking and statistics</li>
                    <li>Taskpane UI</li>
                </ul>
            </li>
        </ul>

        <div class="contact">
            <h2 style="color: white; margin-bottom: 10px;">Need Help?</h2>
            <p>
                For support, bug reports, or feature requests, please contact:<br>
                <strong>Mark Robinson</strong><br>
                <a href="https://github.com/David-Summers/hashfix">GitHub Repository</a>
            </p>
        </div>
    </div>
</body>
</html>