mig5/bouquin
1
0
Fork 0
Code Issues Pull requests Releases 54 Wiki Activity Actions

Update Help

Miguel Jacq 2025-11-03 22:03:31 -06:00
parent df6434eadb
commit 4d0fcc0e44
1 changed files with 17 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Help.md

@ -10,11 +10,14 @@ Bouquin supports various keyboard shortcuts:
- **Ctrl+H**: Open the History dialog for a given date to view versions and diff/revert
- **Ctrl+G**: Open settings
- **Ctrl+E**: Export the notebook to different formats
- **Ctrl+P**: Go to previous day
- **Ctrl+N**: Go to next day
- **Ctrl+T**: Go to today
- **Ctrl+Shift+B**: Backup the notebook to an encrypted database (that can be loaded by Bouquin again directly)
- **Ctrl+Shift+P**: Go to previous day
- **Ctrl+Shift+N**: Go to next day
- **Ctrl+Shift+T**: Go to today
- **Ctrl+D**: Open this documentation page
- **Ctrl+R**: Report a bug via mig5's contact form
- **Ctrl+Q**: Quit the application
### Styling
@ -25,7 +28,7 @@ Bouquin supports various keyboard shortcuts:
- **Ctrl+1**: Set selected text to h1 (heading)
- **Ctrl+2**: Set selected text to h2 (heading)
- **Ctrl+3**: Set selected text to h3 (heading)
- **Ctrl+O**: Set selected text to normal size (paragraph)
- **Ctrl+N**: Set selected text to normal size (paragraph)
- **Ctrl+`**: Set selected text to be in a ```<code>``` block
@ -88,11 +91,21 @@ Currently, the following formats are supported for export:
- JSON
- CSV
- HTML
- SQL (plaintext format suitable for loading with SQLite3)
Set the appropriate extension when prompted to save the exported file.
For txt format, the HTML is stripped. All other options retain the underlying HTML.
Note: only the SQL option exports the full version history. The other formats export just the current version of pages.
## Backup and Restore
If you choose the **Backup** option, this will export the Bouquin database in its encrypted format. _This database cannot be read by native SQLite3_, only by the SQLCipher variant (which you can install on some distributions, such as Debian).
Because it is encrypted with SQLCipher, this means you can also load such a backup into Bouquin as a way of 'importing' the database. To do this, choose the backup file from Settings as the path to the database or edit the path to the database in the configuration file directly (see below).
## Location of data
### Config file