s/features.htm at main · HelpViewer/s · GitHub

1
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>⚙️Features</title><meta name="description" content="📚 HelpViewer 🔒 Your data stays with you - the application runs entirely in JavaScript in your browser, and no files are sent to any server. 📦 No installation"><link rel="icon" type="image/png" href="favicon.png"><meta property="og:title" content="⚙️Features"><meta property="og:description" content="📚 HelpViewer 🔒 Your data stays with you - the application runs entirely in JavaScript in your browser, and no files are sent to any server. 📦 No installation"><meta property="og:type" content="website"><meta property="og:image" content="favicon.png"><meta name="robots" content="index,follow"><link rel="stylesheet" href="src/i-formsupport-css.css" type="text/css"><link rel="stylesheet" href="src/mainCSS.css" type="text/css"><link rel="stylesheet" href="src/mainCSSPlus.css" type="text/css"><link rel="stylesheet" href="src/addition-puiWatermark-toc.css" type="text/css"><link rel="stylesheet" href="src/overridePlusMinusVars.css" type="text/css"><link rel="stylesheet" href="src/admonitions.css.css" type="text/css"><link rel="stylesheet" href="src/prism/prism.css.css" type="text/css"><link rel="stylesheet" href="src/prism/override.css.css" type="text/css"><link rel="stylesheet" href="src/TPL-HTML-fixes.css" type="text/css"><link rel="stylesheet" href="src/custom.css" type="text/css"><meta name="keywords" content="feature, multiplatform, offline, viewer"></head><body class="inStandard"><div class="container" id="container"><div class="main" id="main"><div class="header" id="header" role="banner"><h1 id="mtitle">⚙️Features</h1><div id="header-toolbar" class="toolbar" role="toolbar"><a id="printBtn" title="Print page" aria-label="Print page" href="javascript:window.print();">🖨️</a><a id="nav-left" title="Previous topic" aria-label="Previous topic" href="toc.htm">⬅</a><a id="nav-top" title="Parent topic" aria-label="Parent topic" href="README.htm">⬆</a><a id="nav-right" title="Next topic" aria-label="Next topic" href="ideas.htm">➡</a><a id="downP-TopicTree" title="Table of Contents" aria-label="Table of Contents" href="toc.htm">📖</a><a id="downP-Glossary" title="Glossary" aria-label="Glossary" href="keywordList/index.htm">📇</a><a id="downP-Fulltext" title="Fulltext search" aria-label="Fulltext search" href="fulltextList/index.htm">🔎</a><a id="downP-Home" title="Home" aria-label="Home" href="index.htm">🏡</a></div></div><div class="content" id="content" role="main" aria-live="polite"><h2 id="h-2-2">📚 HelpViewer<a href="#h-2-2" class="anchor-link"> #</a></h2><ul><li>🔒 Your data stays with you - the application runs entirely in JavaScript in your browser, and no files are sent to any server.</li><li>📦 No installation required - just unzip and run locally</li><li>💾 Lightweight - under 1.2 MiB, 12 files + 2 subfolders (most part of solution compressed)</li><li>🧩 Robust, easy-to-use plugin system and extensible architecture</li><li>📥 Easily configurable main functions in a clear tree view</li><li>🛡️ Protection against XSS attacks (integration of DOMPurify in its default settings; component can be optionally removed from installation)</li><li>⚖ MIT licensed</li></ul><h2 id="h-2-3">🟢 Works out of the box with a single Markdown file ...<a href="#h-2-3" class="anchor-link"> #</a></h2><ul><li>💻 Multiplatform - works on all major operating systems via web browsers</li><li>📴 Ready to work in offline mode without any backend or local server<ul><li>🟡 A browser with CORS policies disabled is recommended. Otherwise, functionality is partially limited and you must manually select the data file and help file at startup.</li></ul></li><li>🧭 Simple user interface</li><li>📱 Responsive (desktop and other devices supported)</li><li>🔲 Seamless full-screen expansion of topic content</li><li>🔖 Bookmarks for chapters supported</li><li>🔎 Full-text search dictionary for chapter contents</li><li>🎨 Five native color schemes: color (default), greyscale, white on black, and black on white, sepia</li><li>🌈 Choose the main style from 8 possible styles</li><li>♿ Accessibility rules WCAG 2.1 implemented (accessibilitychecker.org: 89 %, Lighthouse: 96%, <a href="https://wave.webaim.org/report#/https://helpviewer.github.io" title="WAVE WebAim report">Web Aim</a>)</li><li>🖨️ Print friendly version (prefers greyscale)</li><li>📚 Show all chapters as book</li><li>📥 Export the current chapter or all chapters to HTML, Markdown, LaTeX, ePub format, <ul><li>RTF (1.5 - Word 97+, basic format with limitations: no support for images, complex formatting and colors, tables converted to indented text, limited support for Unicode and diacritics (ANSI))</li></ul></li><li>📥 Export text to a static website without JavaScript or links to HelpViewer (the internal structure of CSS styles will remain the same)</li><li>💬 Tooltips in English, Czech (other languages planned)</li><li>🌐 Easily switch between different language versions of the viewer interface</li><li>📽 Presentation mode with chapter and slide navigation using arrow keys</li><li>✏️ Personal notes on chapter paragraphs</li></ul><h2 id="h-2-4">🚀 When help project is defined ...<a href="#h-2-4" class="anchor-link"> #</a></h2><ul><li>📂 Hierarchical view of topics (collapsible topic tree)</li><li>📇 Linking glossary terms to relevant topics and files</li><li>⏭ Integrated topic navigation buttons</li><li>🕘 Easily switch help file version (Internet connection required)</li><li>🌐 Easily switch between different language versions of the help file</li></ul><h2 id="h-2-5">🗄️ Additional features when deployed on a server ...<a href="#h-2-5" class="anchor-link"> #</a></h2><ul><li>🌐 Progressive Web Application (PWA), installable directly to your device for quick access</li><li>✅ For help files hosted on the same server as HelpViewer, CORS is no problem</li><li>🟡 For external resources, it depends on the correct CORS header settings on the server side</li></ul><p></p></div></div></div></body></html>