Add Help

Miguel Jacq 2025-11-01 21:05:47 -05:00
commit 26d5f2ccb6

63
Help.md Normal file

@ -0,0 +1,63 @@
# Bouquin Documentation
## Keyboard Shortcuts
Bouquin supports various keyboard shortcuts:
### Actions
- **Ctrl+S**: Save the notebook
- **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+N**: Go to today
### Styling
- **Ctrl+B**: Set selected text to bold
- **Ctrl+I**: Set selected text to italic
- **Ctrl+U**: Set selected text to underline
- **Ctrl+-**: Set selected text to strikethrough
- **Ctrl+1**: Set selected text to h1 (heading)
- **Ctrl+`**: Set selected text to be in a ```<code>``` block
- **Ctrl+2**: Set selected text to h2 (heading)
- **Ctrl+3**: Set selected text to h3 (heading)
- **Ctrl+N**: Set selected text to normal size (paragraph)
## Navigating by date
You can select any date in the calendar and it will jump to that date.
The act of jumping to a new date automatically saves whatever current date you were on, so there is no need to save first.
## Searching for data
You can enter terms into the search bar in the left sidebar.
If there is a matching entry for that term in the database, a preview box will appear underneath the search bar, showing a preview of that matching term, on the respective date. The matching term will be highlighted in bold to help you notice it.
Clicking on the previewed item will jump to that date.
If there are multiple dates with a match, these will be listed underneath each other, with the date shown at the start of each matching item.
## Settings
In the File -> Settings dialog, it is possible to:
- Change to a different notebook (must exist on the disk somewhere)
- Remember the encryption key, so that you aren't prompted for it at startup (**WARNING**: this means the encryption key is written to the application settings on the disk! It could be exfiltrated by various means if the filesystem is accessible to an attacker. Only check this option if you are not concerned with this risk.)
- Change the encryption key. This will prompt for a new passphrase and will re-encrypt the database with that passphrase.
## Export options
Currently, the following formats are supported for export:
- TXT
- JSON
- CSV
- HTML
For txt format, the HTML is stripped. All other options retain the underlying HTML.