documentation-hub 5.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (271) hide show
  1. package/.eslintrc.json +43 -0
  2. package/.github/workflows/build.yml +64 -0
  3. package/.github/workflows/ci.yml +39 -0
  4. package/.vscode/extensions.json +3 -0
  5. package/Current.md +97 -0
  6. package/DocHub_Image.png +0 -0
  7. package/README.md +666 -0
  8. package/USER_GUIDE.md +1173 -0
  9. package/Updater.md +311 -0
  10. package/build/256x256.png +0 -0
  11. package/build/512x512.png +0 -0
  12. package/build/app-update.yml +4 -0
  13. package/build/create-icon.js +208 -0
  14. package/build/icon.ico +0 -0
  15. package/build/icon.png +0 -0
  16. package/build/icon_1024x1024.png +0 -0
  17. package/dist/assets/Analytics-BpsG9895.js +1 -0
  18. package/dist/assets/Card-IAZin8kp.js +1 -0
  19. package/dist/assets/CurrentSession-B-rFkHvf.js +12 -0
  20. package/dist/assets/Dashboard-C_5gMb0q.js +1 -0
  21. package/dist/assets/Documents-CqZ25axS.js +1 -0
  22. package/dist/assets/Input-l89xwXBi.js +1 -0
  23. package/dist/assets/Reporting-DqdHJY_a.js +1 -0
  24. package/dist/assets/Search-XNbu5z_3.js +1 -0
  25. package/dist/assets/SessionManager-lH9hZfzH.js +1 -0
  26. package/dist/assets/Sessions-ClZOPYNc.js +1 -0
  27. package/dist/assets/Settings-DUEHGURa.js +11 -0
  28. package/dist/assets/index-8xUe8ptc.js +24 -0
  29. package/dist/assets/index-RYyJqF7O.css +1 -0
  30. package/dist/assets/path-BkOl0AGO.js +1 -0
  31. package/dist/assets/promises-ID_B9S-h.js +1 -0
  32. package/dist/assets/urlHelpers-TvgahX0r.js +1 -0
  33. package/dist/assets/useToast-yRSO1dkm.js +1 -0
  34. package/dist/assets/vendor-charts-RkGK5ROP.js +36 -0
  35. package/dist/assets/vendor-db-l0sNRNKZ.js +1 -0
  36. package/dist/assets/vendor-react-BVZ_anCF.js +4 -0
  37. package/dist/assets/vendor-search-Dw8P0qyA.js +1 -0
  38. package/dist/assets/vendor-ui-BU7NfluV.js +53 -0
  39. package/dist/electron/PowerAutomateApiService-LfW09ZGr.js +147 -0
  40. package/dist/electron/main-CXkNtyv-.js +19789 -0
  41. package/dist/electron/main.js +5 -0
  42. package/dist/electron/preload.js +1 -0
  43. package/dist/icon.png +0 -0
  44. package/dist/index.html +27 -0
  45. package/docs/CODEBASE_ANALYSIS_REPORT.md +309 -0
  46. package/docs/DEBUG_LOGGING_GUIDE.md +244 -0
  47. package/docs/README.md +115 -0
  48. package/docs/TOC_WIRING_GUIDE.md +344 -0
  49. package/docs/analysis/Bullet_Symbol_Bug_Analysis.md +136 -0
  50. package/docs/analysis/DOCXMLATER_ANALYSIS_SUMMARY.txt +169 -0
  51. package/docs/analysis/Document_Processing_Issues_Analysis.md +704 -0
  52. package/docs/analysis/FIELD_PRESERVATION_ANALYSIS.md +1200 -0
  53. package/docs/analysis/INDENTATION_PRESERVE_ANALYSIS.md +181 -0
  54. package/docs/analysis/INDENTATION_PRESERVE_IMPLEMENTATION.md +207 -0
  55. package/docs/analysis/List_Implementation.md +206 -0
  56. package/docs/analysis/List_Implementation_Accuracy_Report.md +366 -0
  57. package/docs/analysis/PROCESSING_OPTIONS_UI_UPDATES.md +220 -0
  58. package/docs/analysis/RefactorStyles.md +852 -0
  59. package/docs/analysis/STYLE_PARAMETER_ENHANCEMENT.md +143 -0
  60. package/docs/analysis/docxmlater-comparison-todo-2025-11-13.md +636 -0
  61. package/docs/analysis/docxmlater-implementation-analysis-2025-11-13.md +340 -0
  62. package/docs/analysis/docxmlater-template_ui-integration-analysis.md +263 -0
  63. package/docs/analysis/github-issues-to-create.md +237 -0
  64. package/docs/api/API_README.md +538 -0
  65. package/docs/api/API_REFERENCE.md +751 -0
  66. package/docs/api/TYPE_DEFINITIONS.md +869 -0
  67. package/docs/architecture/FONT_EMBEDDING_GUIDE.md +318 -0
  68. package/docs/architecture/docxmlater-functions-and-structure.md +726 -0
  69. package/docs/docxmlater-readme.md +1341 -0
  70. package/docs/fixes/EXECUTION_LOG_TEST_BASE.md +573 -0
  71. package/docs/fixes/HYPERLINK_TEXT_SANITIZATION.md +253 -0
  72. package/docs/fixes/README.md +37 -0
  73. package/docs/github-issues/issue-1-body.md +125 -0
  74. package/docs/github-issues/issue-10-body.md +850 -0
  75. package/docs/github-issues/issue-2-body.md +200 -0
  76. package/docs/github-issues/issue-3-body.md +270 -0
  77. package/docs/github-issues/issue-4-body.md +169 -0
  78. package/docs/github-issues/issue-5-body.md +173 -0
  79. package/docs/github-issues/issue-6-body.md +158 -0
  80. package/docs/github-issues/issue-7-body.md +171 -0
  81. package/docs/github-issues/issue-8-body.md +407 -0
  82. package/docs/github-issues/issue-9-body.md +515 -0
  83. package/docs/github-issues/issue-tracker.md +274 -0
  84. package/docs/github-issues/predictive-analysis-2025-10-18.md +2131 -0
  85. package/docs/implementation/List_Framework_Refactor_Plan.md +336 -0
  86. package/docs/implementation/PRIMARY_TEXT_COLOR_FEATURE.md +217 -0
  87. package/docs/implementation/RELEASE_PLAN_v2.1.0.md +362 -0
  88. package/docs/implementation/RefactorStyles.md +588 -0
  89. package/docs/implementation/implement-plan.md +489 -0
  90. package/docs/implementation/missing-helpers-implementation.md +391 -0
  91. package/docs/implementation/refactor-plan.md +520 -0
  92. package/docs/implementation/session-implementation-complete.md +233 -0
  93. package/docs/implementation/session-management-plan.md +250 -0
  94. package/docs/setup-checklist.md +77 -0
  95. package/docs/versions/changelog.md +345 -0
  96. package/electron/customUpdater.ts +656 -0
  97. package/electron/main.ts +2441 -0
  98. package/electron/memoryConfig.ts +187 -0
  99. package/electron/preload.ts +394 -0
  100. package/electron/proxyConfig.ts +340 -0
  101. package/electron/services/BackupService.ts +452 -0
  102. package/electron/services/DictionaryService.ts +402 -0
  103. package/electron/services/LocalDictionaryLookupService.ts +147 -0
  104. package/electron/services/PowerAutomateApiService.ts +231 -0
  105. package/electron/services/SharePointSyncService.ts +474 -0
  106. package/electron/windowsCertStore.ts +427 -0
  107. package/electron/zscalerConfig.ts +381 -0
  108. package/eslint.config.js +92 -0
  109. package/jest.config.js +52 -0
  110. package/package.json +214 -0
  111. package/postcss.config.mjs +6 -0
  112. package/public/icon.png +0 -0
  113. package/publish-release.ps1 +5 -0
  114. package/renovate.json +30 -0
  115. package/src/App.tsx +216 -0
  116. package/src/__mocks__/p-limit.js +12 -0
  117. package/src/__mocks__/styleMock.js +1 -0
  118. package/src/components/common/BugReportButton.tsx +44 -0
  119. package/src/components/common/BugReportDialog.tsx +193 -0
  120. package/src/components/common/Button.tsx +153 -0
  121. package/src/components/common/Card.tsx +86 -0
  122. package/src/components/common/ColorPickerDialog.tsx +177 -0
  123. package/src/components/common/ConfirmDialog.tsx +96 -0
  124. package/src/components/common/DebugConsole.tsx +275 -0
  125. package/src/components/common/EmptyState.tsx +183 -0
  126. package/src/components/common/ErrorBoundary.tsx +98 -0
  127. package/src/components/common/ErrorDetailsDialog.tsx +153 -0
  128. package/src/components/common/ErrorFallback.tsx +218 -0
  129. package/src/components/common/Input.tsx +109 -0
  130. package/src/components/common/Skeleton.tsx +184 -0
  131. package/src/components/common/SplashScreen.tsx +81 -0
  132. package/src/components/common/Toast.tsx +155 -0
  133. package/src/components/common/Tooltip.tsx +79 -0
  134. package/src/components/common/UpdateNotification.tsx +320 -0
  135. package/src/components/comparison/ComparisonWindow.tsx +374 -0
  136. package/src/components/comparison/SideBySideDiff.tsx +486 -0
  137. package/src/components/comparison/index.ts +8 -0
  138. package/src/components/document/DocumentUploader.tsx +288 -0
  139. package/src/components/document/HyperlinkPreview.tsx +430 -0
  140. package/src/components/document/HyperlinkService.md +1484 -0
  141. package/src/components/document/Hyperlink_Technical_Documentation.md +496 -0
  142. package/src/components/document/InlineChangesView.tsx +707 -0
  143. package/src/components/document/ProcessingProgress.tsx +303 -0
  144. package/src/components/document/ProcessingResults.tsx +256 -0
  145. package/src/components/document/TrackedChangesDetail.tsx +530 -0
  146. package/src/components/document/TrackedChangesPanel.tsx +546 -0
  147. package/src/components/document/VirtualDocumentList.tsx +240 -0
  148. package/src/components/editor/DocumentEditor.tsx +723 -0
  149. package/src/components/editor/DocumentEditorModal.tsx +640 -0
  150. package/src/components/editor/EditorQuickActions.tsx +502 -0
  151. package/src/components/editor/EditorToolbar.tsx +312 -0
  152. package/src/components/editor/TableEditor.tsx +926 -0
  153. package/src/components/editor/index.ts +18 -0
  154. package/src/components/layout/Header.tsx +190 -0
  155. package/src/components/layout/Sidebar.tsx +313 -0
  156. package/src/components/layout/TitleBar.tsx +190 -0
  157. package/src/components/navigation/CommandPalette.tsx +233 -0
  158. package/src/components/navigation/KeyboardShortcutsModal.tsx +173 -0
  159. package/src/components/sessions/ChangeItem.tsx +408 -0
  160. package/src/components/sessions/ChangeViewer.tsx +1155 -0
  161. package/src/components/sessions/DocumentComparisonModal.tsx +314 -0
  162. package/src/components/sessions/ProcessingOptions.tsx +297 -0
  163. package/src/components/sessions/ReplacementsTab.tsx +438 -0
  164. package/src/components/sessions/RevisionHandlingOptions.tsx +87 -0
  165. package/src/components/sessions/SessionManager.tsx +188 -0
  166. package/src/components/sessions/StylesEditor.tsx +1335 -0
  167. package/src/components/sessions/TabContainer.tsx +151 -0
  168. package/src/components/sessions/VirtualSessionList.tsx +157 -0
  169. package/src/components/sessions/sessionToProcessorManager.tsx +420 -0
  170. package/src/components/settings/CertificateManager.tsx +410 -0
  171. package/src/components/settings/SegmentedControl.tsx +88 -0
  172. package/src/components/settings/SettingRow.tsx +52 -0
  173. package/src/contexts/GlobalStatsContext.tsx +396 -0
  174. package/src/contexts/SessionContext.tsx +2129 -0
  175. package/src/contexts/ThemeContext.tsx +428 -0
  176. package/src/contexts/UserSettingsContext.tsx +290 -0
  177. package/src/contexts/__tests__/GlobalStatsContext.test.tsx +390 -0
  178. package/src/global.d.ts +273 -0
  179. package/src/hooks/useDocumentQueue.tsx +210 -0
  180. package/src/hooks/useToast.tsx +55 -0
  181. package/src/main.tsx +10 -0
  182. package/src/pages/Analytics.tsx +386 -0
  183. package/src/pages/CurrentSession.tsx +1174 -0
  184. package/src/pages/Dashboard.tsx +319 -0
  185. package/src/pages/Documents.tsx +317 -0
  186. package/src/pages/Projects.tsx +250 -0
  187. package/src/pages/Reporting.tsx +386 -0
  188. package/src/pages/Search.tsx +349 -0
  189. package/src/pages/Sessions.tsx +285 -0
  190. package/src/pages/Settings.tsx +2662 -0
  191. package/src/services/HyperlinkService.ts +1085 -0
  192. package/src/services/document/DocXMLaterProcessor.ts +617 -0
  193. package/src/services/document/DocumentProcessingComparison.ts +856 -0
  194. package/src/services/document/DocumentSnapshotService.ts +575 -0
  195. package/src/services/document/WordDocumentProcessor.ts +10509 -0
  196. package/src/services/document/__tests__/DocXMLaterProcessor.hyperlinks.test.md +311 -0
  197. package/src/services/document/__tests__/WordDocumentProcessor.integration.test.ts +515 -0
  198. package/src/services/document/__tests__/WordDocumentProcessor.test.ts +812 -0
  199. package/src/services/document/blanklines/BlankLineManager.ts +658 -0
  200. package/src/services/document/blanklines/__tests__/paragraphChecks.test.ts +281 -0
  201. package/src/services/document/blanklines/helpers/blankLineInsertion.ts +87 -0
  202. package/src/services/document/blanklines/helpers/blankLineSnapshot.ts +251 -0
  203. package/src/services/document/blanklines/helpers/clearCustom.ts +121 -0
  204. package/src/services/document/blanklines/helpers/contextChecks.ts +117 -0
  205. package/src/services/document/blanklines/helpers/imageChecks.ts +51 -0
  206. package/src/services/document/blanklines/helpers/paragraphChecks.ts +236 -0
  207. package/src/services/document/blanklines/helpers/removeBlanksBetweenListItems.ts +91 -0
  208. package/src/services/document/blanklines/helpers/removeTrailingBlanks.ts +35 -0
  209. package/src/services/document/blanklines/helpers/tableGuards.ts +21 -0
  210. package/src/services/document/blanklines/index.ts +67 -0
  211. package/src/services/document/blanklines/rules/additionRules.ts +337 -0
  212. package/src/services/document/blanklines/rules/indentationRules.ts +317 -0
  213. package/src/services/document/blanklines/rules/removalRules.ts +362 -0
  214. package/src/services/document/blanklines/rules/ruleTypes.ts +92 -0
  215. package/src/services/document/blanklines/types.ts +29 -0
  216. package/src/services/document/helpers/ImageBorderCropper.ts +377 -0
  217. package/src/services/document/helpers/__tests__/whitespace.test.ts +272 -0
  218. package/src/services/document/helpers/whitespace.ts +117 -0
  219. package/src/services/document/list/ListNormalizer.ts +947 -0
  220. package/src/services/document/list/index.ts +45 -0
  221. package/src/services/document/list/list-detection.ts +275 -0
  222. package/src/services/document/list/list-types.ts +162 -0
  223. package/src/services/document/processors/HyperlinkProcessor.ts +370 -0
  224. package/src/services/document/processors/ListProcessor.ts +257 -0
  225. package/src/services/document/processors/StructureProcessor.ts +176 -0
  226. package/src/services/document/processors/StyleProcessor.ts +389 -0
  227. package/src/services/document/processors/TableProcessor.ts +2238 -0
  228. package/src/services/document/processors/__tests__/HyperlinkProcessor.test.ts +314 -0
  229. package/src/services/document/processors/__tests__/ListProcessor.test.ts +291 -0
  230. package/src/services/document/processors/__tests__/StructureProcessor.test.ts +257 -0
  231. package/src/services/document/processors/__tests__/TableProcessor.hlp-tips-bullets.test.ts +459 -0
  232. package/src/services/document/processors/__tests__/TableProcessor.test.ts +1604 -0
  233. package/src/services/document/processors/index.ts +28 -0
  234. package/src/services/document/types/docx-processing.ts +310 -0
  235. package/src/services/editor/EditorActionHandlers.ts +901 -0
  236. package/src/services/editor/index.ts +13 -0
  237. package/src/setupTests.ts +47 -0
  238. package/src/styles/global.css +782 -0
  239. package/src/types/backup.ts +132 -0
  240. package/src/types/dictionary.ts +125 -0
  241. package/src/types/document-processing.ts +331 -0
  242. package/src/types/docxmlater-augments.d.ts +142 -0
  243. package/src/types/editor.ts +280 -0
  244. package/src/types/electron.ts +340 -0
  245. package/src/types/globalStats.ts +155 -0
  246. package/src/types/hyperlink.ts +471 -0
  247. package/src/types/operations.ts +354 -0
  248. package/src/types/session.ts +427 -0
  249. package/src/types/settings.ts +112 -0
  250. package/src/utils/MemoryMonitor.ts +248 -0
  251. package/src/utils/cn.ts +6 -0
  252. package/src/utils/colorConvert.ts +306 -0
  253. package/src/utils/diffUtils.ts +347 -0
  254. package/src/utils/documentUtils.ts +202 -0
  255. package/src/utils/electronGuard.ts +62 -0
  256. package/src/utils/indexedDB.ts +915 -0
  257. package/src/utils/logger.ts +717 -0
  258. package/src/utils/pathSecurity.ts +232 -0
  259. package/src/utils/pathValidator.ts +236 -0
  260. package/src/utils/processingTimeEstimator.ts +153 -0
  261. package/src/utils/safeJsonParse.ts +62 -0
  262. package/src/utils/textSanitizer.ts +162 -0
  263. package/src/utils/urlHelpers.ts +304 -0
  264. package/src/utils/urlPatterns.ts +198 -0
  265. package/src/utils/urlSanitizer.ts +152 -0
  266. package/src/vite-env.d.ts +11 -0
  267. package/tsconfig.electron.json +19 -0
  268. package/tsconfig.json +36 -0
  269. package/tsconfig.node.json +12 -0
  270. package/typedoc.json +45 -0
  271. package/vite.config.ts +152 -0
package/USER_GUIDE.md ADDED
@@ -0,0 +1,1173 @@
1
+ # Documentation Hub - Complete User Guide
2
+
3
+ Welcome to **Documentation Hub**, your professional desktop application for processing and managing Word documents with ease. This guide will walk you through every feature and help you make the most of the application.
4
+
5
+ ## Table of Contents
6
+
7
+ 1. [Getting Started](#getting-started)
8
+ 2. [Navigation Overview](#navigation-overview)
9
+ 3. [Dashboard](#dashboard)
10
+ 4. [Working with Sessions](#working-with-sessions)
11
+ 5. [Sessions Page](#sessions-page)
12
+ 6. [Document Processing](#document-processing)
13
+ 7. [Documents Page](#documents-page)
14
+ 8. [Analytics](#analytics)
15
+ 9. [Search](#search)
16
+ 10. [Plugins](#plugins)
17
+ 11. [Projects & Team](#projects--team)
18
+ 12. [Profile](#profile)
19
+ 13. [Settings & Customization](#settings--customization)
20
+ 14. [Keyboard Shortcuts](#keyboard-shortcuts)
21
+ 15. [Tips & Best Practices](#tips--best-practices)
22
+ 16. [How Settings Link to Document Processing](#how-settings-link-to-document-processing)
23
+
24
+ ---
25
+
26
+ ## Getting Started
27
+
28
+ ### First Launch
29
+
30
+ When you first launch Documentation Hub, you'll see the **Dashboard** - your central hub for managing document processing sessions and viewing productivity statistics.
31
+
32
+ ### Understanding the Interface
33
+
34
+ The application features a modern, clean interface with three main areas:
35
+
36
+ - **Sidebar** (Left): Primary navigation menu
37
+ - **Header** (Top): Breadcrumb navigation, current time, quick actions, and theme switcher
38
+ - **Main Content Area** (Center): Your workspace for each page
39
+
40
+ ---
41
+
42
+ ## Navigation Overview
43
+
44
+ ### Sidebar Navigation
45
+
46
+ The sidebar on the left is your primary navigation tool and can be collapsed/expanded by clicking the circular button on its edge.
47
+
48
+ **Main Navigation Items:**
49
+
50
+ - **Dashboard** - Your home base showing session overview and statistics
51
+ - **Active Sessions** - Dynamically appears under Dashboard when you have open sessions
52
+ - Each active session is listed with a small dot icon
53
+ - Click the X button to close a session (appears on hover)
54
+ - **Sessions** - View and manage all your document processing sessions
55
+ - **Analytics** - Visual charts and productivity insights
56
+ - **Team** - Collaborate with team members
57
+ - **Documents** - Browse and manage your document library
58
+ - **Plugins** - Extend functionality with add-ons
59
+ - **Search** - Powerful document search across all sessions
60
+
61
+ **Bottom Navigation:**
62
+
63
+ - **Profile** - Your personal information and settings
64
+ - **Settings** - Application preferences and customization
65
+
66
+ ### Header Bar
67
+
68
+ The header provides contextual information and quick actions:
69
+
70
+ - **Breadcrumbs** - Shows your current location (clickable for quick navigation)
71
+ - **Page Description** - Brief explanation of the current page
72
+ - **Clock Widget** - Real-time clock display
73
+ - **Lightning Bolt Icon** - Opens Command Palette (Ctrl+K)
74
+ - **Theme Switcher** - Toggle between Light and Dark modes
75
+
76
+ ### Hidden Features
77
+
78
+ - **Easter Egg**: Click the "D" logo in the sidebar 5 times quickly to open developer tools
79
+
80
+ ---
81
+
82
+ ## Dashboard
83
+
84
+ The Dashboard is your starting point and provides an at-a-glance view of your productivity.
85
+
86
+ ### Statistics Overview
87
+
88
+ Four main metric cards display your all-time statistics:
89
+
90
+ 1. **Documents Processed** - Total documents you've processed
91
+ 2. **Hyperlinks Checked** - Total hyperlinks validated
92
+ 3. **Feedback Imported** - Total feedback comments imported
93
+ 4. **Time Saved** - Estimated time saved (calculated at 101 seconds per hyperlink)
94
+
95
+ Each card shows:
96
+
97
+ - Current total value
98
+ - Today's activity count
99
+ - Comparison to yesterday (trending up/down/no change)
100
+
101
+ ### Quick Actions
102
+
103
+ Two buttons in the top-right corner:
104
+
105
+ - **New Session** - Create a new document processing session
106
+ - **Load Session** - Open a previously saved session
107
+
108
+ ### Recent Sessions
109
+
110
+ Below the statistics, you'll see a list of your most recently accessed sessions, showing:
111
+
112
+ - Session name (editable)
113
+ - Number of documents in the session
114
+ - Last modified time
115
+ - Current status (active/inactive)
116
+
117
+ Click any session to open it and continue working.
118
+
119
+ ---
120
+
121
+ ## Working with Sessions
122
+
123
+ Sessions are the core concept in Documentation Hub. A session is a workspace where you group related documents for batch processing.
124
+
125
+ ### Creating a New Session
126
+
127
+ 1. Click **New Session** from the Dashboard or sidebar
128
+ 2. Enter a descriptive session name
129
+ 3. Click **Create Session**
130
+
131
+ You'll be taken to the session workspace immediately.
132
+
133
+ ### Session Workspace
134
+
135
+ The session workspace features multiple tabs for different aspects of your work:
136
+
137
+ #### Session Tab (Main)
138
+
139
+ **Statistics Cards:**
140
+
141
+ - Documents processed
142
+ - Hyperlinks checked
143
+ - Feedback imported
144
+ - Time saved (with breakdown)
145
+
146
+ **Document Upload Area:**
147
+
148
+ - Drag and drop Word documents (.docx files) into the designated area
149
+ - Or click **Select Files** to browse and choose documents
150
+ - Multiple files can be added at once
151
+
152
+ **Document List:**
153
+ Each document in your session displays:
154
+
155
+ - File name
156
+ - File size
157
+ - Status icon:
158
+ - Clock icon = Pending (not yet processed)
159
+ - Spinning loader = Processing (currently being processed)
160
+ - Green checkmark = Completed (processing finished)
161
+ - Red alert = Error (processing failed)
162
+ - Action buttons:
163
+ - **Process** - Start processing the document (only for pending documents)
164
+ - **Process Documents** - Process all pending documents at once
165
+ - **Open in Word** - Opens the processed document in Microsoft Word (only for completed documents)
166
+ - **X** - Remove document from session
167
+
168
+ #### Processing Options Tab
169
+
170
+ Configure which operations to apply to your documents:
171
+
172
+ **Available Operations:**
173
+
174
+ - **Fix Content IDs** - Appends content identifiers to hyperlinks
175
+ - **Fix Internal Hyperlinks** - Validates and corrects internal document links
176
+ - **Update TOC Hyperlinks** - Refreshes Table of Contents hyperlinks
177
+ - **Validate Document Styles** - Ensures consistent style formatting
178
+ - **Validate Header2 Tables** - Checks formatting of tables under Header 2 sections
179
+ - **Check External Hyperlinks** - Validates all external URLs
180
+ - **Import Feedback** - Processes and imports document comments
181
+ - **Apply List Formatting** - Standardizes bullet points and numbered lists
182
+ - **Apply Table Uniformity** - Ensures consistent table formatting
183
+ - **Apply Table Shading** - Applies background colors to table rows
184
+
185
+ **Table Shading Options:**
186
+
187
+ - Configure different colors for Header2 tables vs. other tables
188
+ - Use the color picker dialogs to choose custom colors
189
+
190
+ Toggle each option on/off using the switches. Your selections are saved with the session.
191
+
192
+ #### Styles Editor Tab
193
+
194
+ Customize the visual appearance of your processed documents:
195
+
196
+ **Main Text Customization:**
197
+
198
+ - Font family
199
+ - Font size
200
+ - Font color
201
+ - Bold/italic styling
202
+ - Character spacing
203
+ - Line height
204
+
205
+ **Secondary Text Customization:**
206
+
207
+ - Same options as main text but for secondary elements
208
+ - Descriptions and supporting content
209
+
210
+ **Live Preview:**
211
+ Shows how your text styling will appear in the document.
212
+
213
+ **List Bullet Settings:**
214
+
215
+ - Choose between standard bullets or custom characters
216
+ - Configure indentation and spacing
217
+ - Set bullet colors
218
+
219
+ **Quick Save Button:**
220
+
221
+ - Saves all style preferences to the session
222
+
223
+ #### Replacements Tab
224
+
225
+ Set up automatic text replacements to apply during processing:
226
+
227
+ 1. Enter text to find in the "Find" field
228
+ 2. Enter replacement text in the "Replace With" field
229
+ 3. Click **Add Rule** to save
230
+ 4. View all active replacement rules in the list below
231
+ 5. Remove rules by clicking the trash icon
232
+
233
+ Useful for:
234
+
235
+ - Standardizing terminology
236
+ - Correcting common typos
237
+ - Updating product names or abbreviations
238
+
239
+ #### Tracked Changes Tab
240
+
241
+ View a detailed diff of what changed in your documents after processing:
242
+
243
+ - Side-by-side comparison of before and after
244
+ - Highlighted changes show exactly what was modified
245
+ - Useful for auditing and understanding the processing impact
246
+
247
+ ### Saving and Closing Sessions
248
+
249
+ Click **Save and Close Session** (top-right) to:
250
+
251
+ - Save all session settings and document states
252
+ - Close the session workspace
253
+ - Return to the Dashboard
254
+
255
+ Your session is automatically saved and can be reopened later from the Dashboard or Sessions page.
256
+
257
+ ---
258
+
259
+ ## Sessions Page
260
+
261
+ The Sessions page provides a comprehensive overview of all your document processing sessions, both active and archived.
262
+
263
+ ### Accessing the Sessions Page
264
+
265
+ Click **Sessions** in the sidebar to view all your sessions in one place.
266
+
267
+ ### View Modes
268
+
269
+ Switch between two view styles using the toggle buttons in the top-right:
270
+
271
+ **Grid View:**
272
+
273
+ - Card-based layout showing sessions in a grid
274
+ - Shows 3 columns on large screens, 2 on medium, 1 on small
275
+ - Best for visual browsing and quick identification
276
+
277
+ **List View:**
278
+
279
+ - Compact list format with additional details
280
+ - Shows extended statistics inline
281
+ - Best for viewing many sessions at once
282
+
283
+ ### Search and Filter
284
+
285
+ Use the search box at the top to quickly find sessions by name. Results filter in real-time as you type.
286
+
287
+ ### Session Cards
288
+
289
+ Each session card displays:
290
+
291
+ **Header:**
292
+
293
+ - Folder icon
294
+ - Session name
295
+ - Status badge (active/inactive in green or gray)
296
+ - Delete button (appears on hover)
297
+
298
+ **Statistics:**
299
+
300
+ - Number of documents in the session
301
+ - Total time saved (in minutes)
302
+
303
+ **Metadata:**
304
+
305
+ - Creation date
306
+ - Last modified date
307
+
308
+ **Additional Info (List View Only):**
309
+
310
+ - Documents processed count
311
+ - Hyperlinks checked count
312
+ - Feedback imported count
313
+ - Time saved breakdown
314
+
315
+ ### Session Actions
316
+
317
+ **Opening a Session:**
318
+
319
+ - Click anywhere on the session card
320
+ - The session opens in the Session Workspace
321
+ - Recent activity updates automatically
322
+
323
+ **Deleting a Session:**
324
+
325
+ - Hover over the session card
326
+ - Click the trash icon in the top-right corner
327
+ - Confirm deletion in the dialog that appears
328
+ - **Warning**: Deletion is permanent and cannot be undone
329
+
330
+ ### Creating New Sessions
331
+
332
+ Click the **New Session** button in the top-right corner to create a session directly from this page.
333
+
334
+ ### Empty State
335
+
336
+ If you don't have any sessions yet, you'll see a helpful message prompting you to create your first session.
337
+
338
+ ---
339
+
340
+ ## Document Processing
341
+
342
+ ### Processing Workflow
343
+
344
+ 1. **Add Documents** - Upload Word files to your session
345
+ 2. **Configure Options** - Choose which operations to apply
346
+ 3. **Process** - Click the Process button on individual documents or "Process Documents" for batch processing
347
+ 4. **Review** - Check the Tracked Changes tab to see what changed
348
+ 5. **Open** - Click "Open in Word" to view and use the processed document
349
+
350
+ ### Processing Status
351
+
352
+ Watch the status icons to track progress:
353
+
354
+ - **Pending** (Clock) - Waiting to be processed
355
+ - **Processing** (Spinning) - Currently being processed
356
+ - **Completed** (Green Check) - Successfully processed and ready
357
+ - **Error** (Red X) - Processing failed (check error message)
358
+
359
+ ### Toast Notifications
360
+
361
+ During processing, you'll see helpful notifications:
362
+
363
+ - **Processing Started** - Shows which operations are being applied
364
+ - **Processing Complete** - Confirms success and reminds you to open the document
365
+ - **Processing Failed** - Explains what went wrong
366
+
367
+ ### Opening Processed Documents
368
+
369
+ Once processing is complete (green checkmark):
370
+
371
+ 1. Click the **green "Open in Word" button**
372
+ 2. The document opens in Microsoft Word
373
+ 3. Review the changes and save as needed
374
+ 4. The original file remains untouched (backups are created automatically)
375
+
376
+ ---
377
+
378
+ ## Documents Page
379
+
380
+ The Documents page provides a centralized library view of all documents across all your sessions.
381
+
382
+ ### Accessing the Documents Page
383
+
384
+ Click **Documents** in the sidebar to browse your entire document collection.
385
+
386
+ ### Search and Filtering
387
+
388
+ **Search Box:**
389
+
390
+ - Located at the top with a magnifying glass icon
391
+ - Search by document name or session name
392
+ - Results update instantly as you type
393
+
394
+ **Status Filter:**
395
+
396
+ - Filter by document processing status
397
+ - Options: All, Completed, Pending, Error
398
+ - Shows count for each status category
399
+ - Click any filter button to apply
400
+
401
+ ### Document Cards
402
+
403
+ Each document is displayed in a card showing:
404
+
405
+ **Document Information:**
406
+
407
+ - File icon (colored by status)
408
+ - Document name
409
+ - Session name (which session it belongs to)
410
+ - File path (where it's stored)
411
+
412
+ **Status Indicators:**
413
+
414
+ - Green checkmark = Completed
415
+ - Yellow clock = Pending
416
+ - Red alert = Error
417
+
418
+ **Quick Actions:**
419
+
420
+ - **Open in Word** - Opens the document in Microsoft Word (completed documents only)
421
+ - **Show in Folder** - Opens File Explorer to the document's location
422
+ - Hover over any document for action buttons
423
+
424
+ ### Viewing Options
425
+
426
+ Documents are organized in a clean list format with:
427
+
428
+ - Session grouping (documents from the same session appear together)
429
+ - Status badges for quick visual identification
430
+ - File metadata display
431
+
432
+ ### Empty States
433
+
434
+ If you don't have any documents yet, you'll see a message encouraging you to:
435
+
436
+ - Create a new session
437
+ - Add documents to existing sessions
438
+
439
+ ### Use Cases
440
+
441
+ The Documents page is ideal for:
442
+
443
+ - Finding a specific document across multiple sessions
444
+ - Reviewing all completed documents at once
445
+ - Identifying documents with processing errors
446
+ - Accessing documents without remembering which session they're in
447
+ - Quick file management and organization
448
+
449
+ ### Integration with Sessions
450
+
451
+ - Click on any document's session name to jump directly to that session
452
+ - Documents reflect real-time status updates
453
+ - Changes in sessions are immediately visible in the Documents page
454
+
455
+ ---
456
+
457
+ ## Analytics
458
+
459
+ The Analytics page provides powerful visualizations of your productivity over time.
460
+
461
+ ### View All Modes
462
+
463
+ Choose between three time ranges:
464
+
465
+ - **Daily** - Last 30 days of activity
466
+ - **Weekly** - Last 12 weeks of activity
467
+ - **Monthly** - Last 12 months of activity
468
+
469
+ Switch views using the buttons at the top.
470
+
471
+ ### Statistics Summary
472
+
473
+ Four metric cards show your all-time totals:
474
+
475
+ - Documents Processed
476
+ - Hyperlinks Checked
477
+ - Feedback Imported
478
+ - Time Saved
479
+
480
+ ### Charts
481
+
482
+ **Documents Processed Over Time:**
483
+
484
+ - Line chart showing document processing trends
485
+ - Helps identify busy periods and productivity patterns
486
+
487
+ **Activity Breakdown:**
488
+
489
+ - Bar chart showing all metrics side-by-side
490
+ - Compare documents, hyperlinks, feedback, and time saved
491
+
492
+ **Performance Comparison:**
493
+
494
+ - Multi-line chart showing all metrics on one graph
495
+ - Spot correlations and trends across different activities
496
+
497
+ ### Resetting Statistics
498
+
499
+ The **Reset All Stats** button (top-right) clears all historical data:
500
+
501
+ - Use with caution - this cannot be undone
502
+ - Confirmation dialog ensures you don't accidentally reset
503
+
504
+ ---
505
+
506
+ ## Search
507
+
508
+ The Search page lets you find documents across all sessions with powerful filtering.
509
+
510
+ ### Basic Search
511
+
512
+ 1. Type your query in the large search box
513
+ 2. Results appear instantly as you type
514
+ 3. Uses fuzzy search to find partial matches
515
+
516
+ ### Advanced Filters
517
+
518
+ Click the **Filter icon** in the search box to reveal:
519
+
520
+ **Status Filter:**
521
+
522
+ - All Status - Show everything
523
+ - Completed - Only processed documents
524
+ - Pending - Only unprocessed documents
525
+ - Error - Only failed documents
526
+
527
+ **Session Filter:**
528
+
529
+ - Dropdown to select a specific session
530
+ - Or choose "All Sessions" to search everywhere
531
+
532
+ ### Keyboard Navigation
533
+
534
+ Efficient keyboard controls for power users:
535
+
536
+ - **↑ Arrow Up** - Move selection up
537
+ - **↓ Arrow Down** - Move selection down
538
+ - **Enter** - Open selected document's session
539
+
540
+ The selected result is highlighted and auto-scrolls into view.
541
+
542
+ ### Search Results
543
+
544
+ Each result shows:
545
+
546
+ - Document name
547
+ - Session name it belongs to
548
+ - File path
549
+ - Status icon
550
+ - Right arrow to open
551
+
552
+ Click any result to jump to that document's session.
553
+
554
+ ---
555
+
556
+ ## Plugins
557
+
558
+ The Plugins page is your marketplace for extending Documentation Hub's functionality.
559
+
560
+ ### Plugin Categories
561
+
562
+ Browse by category:
563
+
564
+ - **All Plugins** - Everything available
565
+ - **Document** - Document processing enhancements
566
+ - **UI & Theme** - Visual customization
567
+ - **Integration** - External service connections
568
+ - **Automation** - Workflow automation tools
569
+
570
+ ### Plugin Statistics
571
+
572
+ Three cards at the top show:
573
+
574
+ - **Installed** - Number of plugins you've installed
575
+ - **Active** - Number of plugins currently enabled
576
+ - **Available** - Total plugins in the marketplace
577
+
578
+ ### Plugin Cards
579
+
580
+ Each plugin displays:
581
+
582
+ **Information:**
583
+
584
+ - Name and description
585
+ - Version number
586
+ - Author (DocHub Team or Community)
587
+ - Category icon
588
+ - Star rating (out of 5)
589
+ - Download count
590
+ - Verified badge (for official plugins)
591
+
592
+ **Actions:**
593
+
594
+ - **Install** - Download and install the plugin
595
+ - **Enable/Disable Toggle** - Turn the plugin on/off
596
+ - **Uninstall** - Remove the plugin completely
597
+
598
+ ### Popular Plugins
599
+
600
+ - **PDF Export** - Export documents as PDFs
601
+ - **Cloud Sync** - Sync to cloud storage
602
+ - **Advanced Analytics** - Extended reporting features
603
+ - **Theme Builder** - Create custom themes
604
+ - **Batch File Renamer** - Auto-rename processed files
605
+
606
+ ### Managing Plugins
607
+
608
+ 1. **To Install**: Click the Install button on any uninstalled plugin
609
+ 2. **To Enable**: Toggle the switch to the "on" position (blue)
610
+ 3. **To Disable**: Toggle the switch to the "off" position (gray)
611
+ 4. **To Uninstall**: Click the trash icon or Uninstall button
612
+
613
+ Installed plugins appear at the top of the list.
614
+
615
+ ---
616
+
617
+ ## Projects & Team
618
+
619
+ The Projects and Team pages provide collaboration features for team-based workflows.
620
+
621
+ ### Projects Page
622
+
623
+ The Projects page helps you manage multiple projects with team collaboration.
624
+
625
+ **Accessing the Projects Page:**
626
+
627
+ - Click **Projects** in the sidebar (visible under Team navigation item)
628
+
629
+ **Project View Options:**
630
+
631
+ - **Grid View** - Visual card layout with project tiles
632
+ - **List View** - Detailed table format with all project information
633
+
634
+ **Project Information:**
635
+ Each project card displays:
636
+
637
+ - Project name and description
638
+ - Current status (Planning, In Progress, Review, etc.)
639
+ - Progress bar showing completion percentage
640
+ - Team member count
641
+ - Last updated timestamp
642
+ - Color-coded status indicator
643
+
644
+ **Project Actions:**
645
+
646
+ - Click any project to view details
647
+ - Create new projects with the "New Project" button
648
+ - Search projects by name or description
649
+ - Filter by status or team assignment
650
+
651
+ **Use Cases:**
652
+
653
+ - Coordinate document processing across multiple projects
654
+ - Track team progress on large documentation initiatives
655
+ - Organize sessions by project context
656
+ - Monitor project timelines and milestones
657
+
658
+ ### Team Page
659
+
660
+ The Team page facilitates collaboration with colleagues.
661
+
662
+ **Accessing the Team Page:**
663
+
664
+ - Click **Team** in the sidebar
665
+
666
+ **Team Features:**
667
+
668
+ - View all team members
669
+ - See who's working on which sessions
670
+ - Track collective productivity
671
+ - Coordinate document processing workflows
672
+ - Share sessions and processing configurations
673
+
674
+ **Collaboration Benefits:**
675
+
676
+ - Consistent document processing across the team
677
+ - Shared style templates and replacement rules
678
+ - Centralized statistics and analytics
679
+ - Coordinated project timelines
680
+
681
+ ---
682
+
683
+ ## Profile
684
+
685
+ The Profile page contains your personal information and account settings.
686
+
687
+ ### Accessing Your Profile
688
+
689
+ Click **Profile** in the bottom section of the sidebar.
690
+
691
+ ### Profile Information
692
+
693
+ **Personal Details:**
694
+
695
+ - Profile picture or avatar
696
+ - Display name
697
+ - Email address
698
+ - User role or title
699
+ - Account creation date
700
+
701
+ **Quick Stats:**
702
+
703
+ - Your personal contribution to team metrics
704
+ - Individual productivity statistics
705
+ - Recent activity summary
706
+
707
+ **Account Actions:**
708
+
709
+ - Edit profile information
710
+ - Update contact details
711
+ - Change password (if applicable)
712
+ - Manage account preferences
713
+ - View account activity history
714
+
715
+ **Integration:**
716
+ Your profile integrates with:
717
+
718
+ - Session history (shows your sessions)
719
+ - Global statistics (tracks your contributions)
720
+ - Team collaboration (displays your role)
721
+
722
+ ### Privacy & Security
723
+
724
+ - Profile visibility settings
725
+ - Data privacy preferences
726
+ - Connected accounts and integrations
727
+ - Session sharing permissions
728
+
729
+ ---
730
+
731
+ ## Settings & Customization
732
+
733
+ The Settings page offers extensive customization options, organized into logical sections.
734
+
735
+ ### Navigation
736
+
737
+ The left sidebar provides quick access to all setting categories:
738
+
739
+ - **Account** - Profile information
740
+ - **Customization** - Appearance and Typography
741
+ - **System** - Language, Updates, API Connections, Storage, Submit Idea
742
+
743
+ Use the search box at the top to quickly find specific settings.
744
+
745
+ ### Profile Settings
746
+
747
+ Manage your personal information:
748
+
749
+ - First Name
750
+ - Last Name
751
+ - Email Address
752
+
753
+ **Quick Actions:**
754
+
755
+ - Export Settings - Save all your preferences to a file
756
+ - Import Settings - Load preferences from a backup file
757
+ - Save Changes - Apply your edits
758
+
759
+ ### Appearance Settings
760
+
761
+ **Theme Mode:**
762
+ Choose between Light and Dark themes:
763
+
764
+ - **Light** - Bright, clean interface for daytime use
765
+ - **Dark** - Easy on the eyes for low-light environments
766
+
767
+ **Interface Density:**
768
+ Control spacing and compactness:
769
+
770
+ - **Comfortable** - Spacious, relaxed layout
771
+ - **Compact** - Tighter spacing, more content visible
772
+ - **Minimal** - Maximum density, minimal padding
773
+
774
+ **Accent Color:**
775
+ Choose from 8 preset colors or create a custom color:
776
+
777
+ - Blue, Purple, Green, Orange, Pink, Cyan, Indigo
778
+ - **Custom** - Opens a color picker for any color you want
779
+
780
+ **Visual Effects:**
781
+
782
+ - **Glass morphism effects** - Blur and transparency effects
783
+ - **Smooth animations** - Transitions and micro-interactions
784
+
785
+ Toggle each on/off based on your preference and system performance.
786
+
787
+ **Custom Theme Colors:**
788
+ For advanced users, enable custom colors to override:
789
+
790
+ - Primary color
791
+ - Background color (text color auto-adjusts for contrast)
792
+ - Header color (text color auto-adjusts)
793
+ - Sidebar color (text color auto-adjusts)
794
+ - Border color
795
+
796
+ Click each color swatch to open the color picker dialog.
797
+
798
+ ### Typography Settings
799
+
800
+ **Live Preview:**
801
+ See your changes in real-time with sample text.
802
+
803
+ **Quick Presets:**
804
+ Four one-click presets:
805
+
806
+ - **Reading** - Comfortable for long-form content
807
+ - **Compact** - Dense for information-heavy screens
808
+ - **Presentation** - Large, bold for displays
809
+ - **Default** - Reset to factory settings
810
+
811
+ **Font Settings:**
812
+
813
+ - **Family** - Choose from 11 fonts including Inter, Roboto, Poppins, monospace fonts, and even Webdings for fun
814
+ - **Size** - 12px to 20px slider
815
+ - **Weight** - Light, Regular, Medium, Semibold, Bold
816
+ - **Style** - Normal or Italic
817
+
818
+ **Spacing Settings:**
819
+
820
+ - **Letter Spacing** - Tight to Wide (-0.05em to 0.1em)
821
+ - **Line Height** - Compact to Spacious (1.0 to 2.0)
822
+
823
+ All changes update the preview in real-time.
824
+
825
+ ### Language & Region Settings
826
+
827
+ **Language:**
828
+ Choose your display language:
829
+
830
+ - English (US)
831
+ - Español (Spanish)
832
+ - 中文 (Mandarin Chinese)
833
+
834
+ **Timezone:**
835
+ Select from US timezones and common international zones:
836
+
837
+ - US: Hawaii, Alaska, Pacific, Mountain, Central, Eastern
838
+ - International: UTC, London, Paris, Cairo, Moscow, Mumbai, Beijing, Tokyo, Sydney
839
+
840
+ **Date Format:**
841
+ Choose how dates are displayed:
842
+
843
+ - MM/DD/YYYY (US format)
844
+ - DD/MM/YYYY (European format)
845
+ - YYYY-MM-DD (ISO format)
846
+
847
+ ### Updates Settings
848
+
849
+ **Current Version:**
850
+ Displays the installed version number.
851
+
852
+ **Check for Updates:**
853
+ Click the button to manually check for new versions:
854
+
855
+ - Shows "Checking..." while searching
856
+ - Displays "Update available" if a new version is found
857
+ - Shows "You are up to date" if you're current
858
+
859
+ **Download Update:**
860
+ When an update is available:
861
+
862
+ - Click to download (progress bar shows percentage)
863
+ - "Install & Restart" button appears when download completes
864
+ - Application closes, updates, and reopens automatically
865
+
866
+ **Auto-Update Settings:**
867
+
868
+ - **Auto-update on launch** - Automatically check when starting the app
869
+ - **Check for pre-releases** - Include beta versions in update checks
870
+
871
+ Toggle these on/off based on your preference.
872
+
873
+ ### API Connections Settings
874
+
875
+ Configure external service integrations.
876
+
877
+ **Hyperlink Processing:**
878
+
879
+ - **PowerAutomate Dictionary URL** - API endpoint for hyperlink metadata
880
+ - Paste your PowerAutomate workflow URL
881
+ - Real-time validation shows any issues
882
+ - Auto-sanitizes encoded characters
883
+ - Green checkmark = valid, red alert = invalid
884
+ - Detailed error messages guide you to fix problems
885
+
886
+ **Feedback & Reporting:**
887
+
888
+ - **Bug Report API URL** - Where bug reports are sent
889
+ - **Submit Idea API URL** - Where feature suggestions are sent
890
+
891
+ Leave as default to use email fallback.
892
+
893
+ ### Submit Idea Settings
894
+
895
+ Share your feature ideas with the development team:
896
+
897
+ 1. **Title for Idea** - Brief, descriptive title
898
+ 2. **Why is this needed / Who would this benefit?** - Detailed explanation
899
+ 3. Click **Submit Idea** to send
900
+
901
+ Your idea is sent via the configured API or email. Confirmation appears when successful.
902
+
903
+ ### Storage Settings
904
+
905
+ Manage your data and storage:
906
+
907
+ **Storage Used:**
908
+
909
+ - Visual progress bar shows usage (e.g., 2.4 GB of 10 GB = 24%)
910
+ - Percentage displayed prominently
911
+
912
+ **Data Management:**
913
+
914
+ - **Clear Cache** - Free up space by removing temporary files
915
+ - **Export Settings & Data** - Backup everything to a JSON file
916
+ - **Import Settings & Data** - Restore from a backup file
917
+ - **Delete Account** - Permanently remove all data (use with caution)
918
+
919
+ ---
920
+
921
+ ## Keyboard Shortcuts
922
+
923
+ ### Command Palette
924
+
925
+ The Command Palette is your productivity powerhouse, accessible from anywhere in the application.
926
+
927
+ **Opening the Command Palette:**
928
+
929
+ - Press **Ctrl+K** (or **Cmd+K** on Mac)
930
+ - Or click the lightning bolt icon in the header
931
+
932
+ **Using the Command Palette:**
933
+
934
+ 1. Type to search for any command
935
+ 2. Use ↑↓ arrow keys to navigate results
936
+ 3. Press Enter to execute selected command
937
+ 4. Press Escape to close without action
938
+
939
+ **Available Commands:**
940
+
941
+ **Navigation:**
942
+
943
+ - "Go to Dashboard" - Jump to the Dashboard
944
+ - "Open Projects" - Navigate to Projects page
945
+ - "Browse Documents" - Open Documents library
946
+ - "View Plugins" - Access Plugins marketplace
947
+ - "View Profile" - Go to your Profile
948
+ - "Open Settings" - Access Settings page
949
+
950
+ **Theme:**
951
+
952
+ - "Switch to Light Theme" - Enable light mode
953
+ - "Switch to Dark Theme" - Enable dark mode
954
+
955
+ **Smart Search:**
956
+
957
+ - The command palette understands keywords
958
+ - Try typing "dark", "home", "plugins", or "settings"
959
+ - Results are filtered in real-time as you type
960
+
961
+ **Why Use the Command Palette:**
962
+
963
+ - Faster than clicking through menus
964
+ - No need to remember exact locations
965
+ - Works from any page in the app
966
+ - Keyboard-first workflow for power users
967
+
968
+ ### Global Shortcuts
969
+
970
+ - **Ctrl+K** (Cmd+K on Mac) - Open Command Palette
971
+ - **Escape** - Close dialogs and modals
972
+
973
+ ### Search Page Shortcuts
974
+
975
+ - **↑ Arrow Up** - Move to previous result
976
+ - **↓ Arrow Down** - Move to next result
977
+ - **Enter** - Open selected result
978
+
979
+ ### Session Workspaces
980
+
981
+ - **Click logo 5 times quickly** - Open developer tools (easter egg)
982
+
983
+ ---
984
+
985
+ ## Tips & Best Practices
986
+
987
+ ### Session Management
988
+
989
+ 1. **Use Descriptive Names** - Name sessions by project, date, or topic for easy identification
990
+ 2. **One Topic Per Session** - Group related documents together for better organization
991
+ 3. **Save Frequently** - Click "Save and Close" regularly to preserve your work
992
+ 4. **Check Tracked Changes** - Always review the Tracked Changes tab before finalizing
993
+
994
+ ### Doc Processing
995
+
996
+ 1. **Test With One Document First** - Before batch processing, test settings on a single document
997
+ 2. **Enable Relevant Options Only** - Don't enable operations you don't need - faster processing
998
+ 3. **Use Replacements Wisely** - Be specific with find/replace rules to avoid unintended changes
999
+ 4. **Review Error Messages** - If processing fails, read the error carefully for guidance
1000
+ 5. **Keep Backups** - Original files are preserved, but export important sessions just in case
1001
+
1002
+ ### Performance Optimization
1003
+
1004
+ 1. **Use Compact/Minimal Density** - Reduces visual overhead on slower systems
1005
+ 2. **Disable Animations** - Turn off animations in Settings > Appearance for better performance
1006
+ 3. **Disable Visual Effects** - Turn off glass morphism if you experience lag
1007
+ 4. **Process in Smaller Batches** - Instead of 50 documents at once, do 10-15 at a time
1008
+
1009
+ ### Organization
1010
+
1011
+ 1. **Use Analytics** - Regularly check Analytics to understand your productivity patterns
1012
+ 2. **Use Search** - Don't manually browse - search is faster and more accurate
1013
+ 3. **Close Inactive Sessions** - Keep your sidebar clean by closing sessions you're not actively using
1014
+ 4. **Export Data Regularly** - Use Settings > Storage > Export to create backups
1015
+
1016
+ ### Customization
1017
+
1018
+ 1. **Start With Presets** - Use typography presets before manual adjustments
1019
+ 2. **Match Your Environment** - Light theme for bright rooms, Dark theme for low light
1020
+ 3. **Choose Comfortable Density** - Don't sacrifice comfort for compactness
1021
+ 4. **Test Custom Colors** - Make sure custom colors have good contrast (auto-detected for text)
1022
+
1023
+ ### Getting Help
1024
+
1025
+ 1. **Check Page Descriptions** - The gray text under each page title explains what it does
1026
+ 2. **Hover for Tooltips** - Many buttons show helpful tooltips on hover
1027
+ 3. **Use Submit Idea** - Share feedback and suggestions through Settings
1028
+ 4. **Check for Updates** - New versions include bug fixes and improvements
1029
+
1030
+ ---
1031
+
1032
+ ## Troubleshooting Common Issues
1033
+
1034
+ ### Documents Won't Upload
1035
+
1036
+ - Ensure files are .docx format (not .doc or other formats)
1037
+ - Check file permissions - you need read access
1038
+ - Try selecting files instead of drag-and-drop
1039
+
1040
+ ### Processing Fails
1041
+
1042
+ - Review the error message in the document list
1043
+ - Try processing with fewer operations enabled
1044
+ - Ensure you have write permissions to the output location
1045
+ - Check that the document isn't corrupted
1046
+
1047
+ ### Application Performance Issues
1048
+
1049
+ - Disable animations in Settings > Appearance
1050
+ - Disable glass morphism effects
1051
+ - Use Compact or Minimal density mode
1052
+ - Close unnecessary sessions
1053
+ - Clear cache in Settings > Storage
1054
+
1055
+ ### Can't Find a Document
1056
+
1057
+ - Use the Search page with filters
1058
+ - Check the correct session is selected
1059
+ - Verify the status filter isn't hiding it
1060
+ - Check Recent Sessions on the Dashboard
1061
+
1062
+ ### Theme/Colors Look Wrong
1063
+
1064
+ - Reset to defaults using typography presets
1065
+ - Disable custom colors in Appearance settings
1066
+ - Try switching between Light and Dark themes
1067
+ - Check your operating system's color settings
1068
+
1069
+ ### Updates Won't Install
1070
+
1071
+ - Check your internet connection
1072
+ - Try manual download if auto-update fails
1073
+ - Ensure you have write permissions to the app folder
1074
+ - Temporarily disable antivirus if it's blocking the installer
1075
+
1076
+ ---
1077
+
1078
+ ## Conclusion
1079
+
1080
+ Documentation Hub is designed to streamline your document processing workflow with powerful automation, intuitive organization, and extensive customization. This guide covers all major features, but don't hesitate to explore and experiment - the application is designed to be forgiving and all changes are reversible.
1081
+
1082
+ **Remember:**
1083
+
1084
+ - Sessions organize your work
1085
+ - Processing options give you control
1086
+ - Analytics show your impact
1087
+ - Customization makes it yours
1088
+
1089
+ Happy document processing!
1090
+
1091
+ ---
1092
+
1093
+ ## How Settings Link to Document Processing
1094
+
1095
+ Understanding how your UI settings flow to the document processing pipeline helps you achieve consistent, predictable results.
1096
+
1097
+ ### Style Settings → Document Formatting
1098
+
1099
+ The paragraph styles you configure in the **Styles Editor** tab directly control how your documents are formatted:
1100
+
1101
+ | Style Setting | Affects |
1102
+ |---------------|---------|
1103
+ | **Normal** style | Body text, table cell content, non-heading paragraphs |
1104
+ | **Heading 1-6** styles | Heading paragraphs matching each level |
1105
+ | Font family/size | Applied to matching paragraphs and table cells |
1106
+ | Bold/Italic/Underline | Applied to runs within matching paragraphs |
1107
+ | Alignment | Paragraph alignment (left, center, right, justify) |
1108
+ | Spacing Before/After | Space above and below paragraphs |
1109
+ | Line Spacing | Space between lines within paragraphs |
1110
+
1111
+ **Preserve Options**: The "Lock Bold", "Lock Italic", "Lock Underline", and "Lock Center" buttons in the Styles Editor prevent the processor from overriding existing formatting in your documents. For example, if "Lock Center" is enabled for Normal style, centered text stays centered instead of being changed to the Normal style's alignment.
1112
+
1113
+ ### Table Shading Settings → Table Formatting
1114
+
1115
+ The **Table & Image Settings** section controls how tables are formatted:
1116
+
1117
+ | Setting | Effect |
1118
+ |---------|--------|
1119
+ | **Header2 Shading Color** | Background color for cells in tables under Heading 2 sections |
1120
+ | **Other Shading Color** | Background color for shaded cells in other tables |
1121
+ | **Image Border Width** | Border thickness (in points) applied around large images |
1122
+
1123
+ **Important Table Behavior**:
1124
+ - Tables larger than 1x1: Shaded cells are always bold and centered, regardless of style settings
1125
+ - Table cell text formatting: Inherits font family/size from the **Normal** paragraph style
1126
+ - Table cell spacing: Uses spacing settings from the **Normal** paragraph style
1127
+ - Header rows (first row): Always bold and centered for emphasis
1128
+
1129
+ ### List Bullet Settings → List Formatting
1130
+
1131
+ The **List Bullets** section controls numbered and bulleted list formatting:
1132
+
1133
+ | Setting | Effect |
1134
+ |---------|--------|
1135
+ | **Enable List Formatting** | Master toggle for list processing |
1136
+ | **Indentation Levels (1-5)** | Symbol indent, text indent, and bullet character per level |
1137
+ | **Spacing Between Items** | Vertical space between list items |
1138
+
1139
+ ### Processing Options Flow
1140
+
1141
+ When you click "Process Document", the options flow through this pipeline:
1142
+
1143
+ ```
1144
+ Session Settings (UI)
1145
+
1146
+ SessionContext (state management)
1147
+
1148
+ IPC Call to Main Process
1149
+
1150
+ WordDocumentProcessor
1151
+
1152
+ Individual Processors:
1153
+ ├── StyleProcessor (paragraph styles)
1154
+ ├── TableProcessor (table formatting)
1155
+ ├── ListProcessor (list bullets)
1156
+ └── StructureProcessor (TOC, headers)
1157
+
1158
+ DocXMLater Document API
1159
+
1160
+ Processed .docx File
1161
+ ```
1162
+
1163
+ ### Tips for Consistent Results
1164
+
1165
+ 1. **Configure Normal style first** - Many other elements inherit from Normal style
1166
+ 2. **Test with one document** - Verify settings before batch processing
1167
+ 3. **Use Lock options sparingly** - Only enable when you need to preserve specific formatting
1168
+ 4. **Review Tracked Changes** - Check the Tracked Changes tab to see exactly what changed
1169
+
1170
+ ---
1171
+
1172
+ _Last Updated: January 2026_
1173
+ _Documentation Hub Version: 5.0.4_