Online Documentation
This documentation is built with Docusaurus and lives in the ooregedit-help submodule of the O&O RegEditor repository, in the src folder.
Structure
| Folder | Purpose |
|---|---|
docs/getting-started | System requirements, quick start, and the user interface. |
docs/core-concepts | Registry structure and value types. |
docs/keys-values | Creating, editing, renaming, deleting, copying, and moving keys and values. |
docs/navigation | Browsing, the address bar, and favourites. |
docs/search | Finding data, regular expressions, and search results. |
docs/import-export | Importing and exporting .reg files. |
docs/permissions | Permissions and advanced security settings. |
docs/settings | Appearance, language, and the settings reference. |
docs/examples | Complete worked examples. |
docs/troubleshooting | Common issues and their solutions. |
docs/support | Technical support and contact. |
Terminology
Use the same terms as the application:
- Key for a container in the tree (like a folder).
- Value for a named data entry inside a key.
- Default value for the unnamed value of a key, shown as
(Default). - Main key (or root key / hive) for one of the five top-level keys.
- Path for the backslash-separated chain of keys.
- Result list for the list of search matches.
Screenshots
Screenshots referenced by the documentation live in static/img/screenshots/. Any image that has not yet been captured is shown as a labelled placeholder. The list of screenshots still to be produced, with the exact window or dialog to capture, is maintained in SCREENSHOTS.md at the root of the ooregedit-help submodule.
Local Development
From the src folder of the ooregedit-help submodule:
npm install
npm start
Build the static site with:
npm run build
Generate the PDF manual with:
npm run build:pdf