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

Update Help

Miguel Jacq 2025-11-14 19:42:45 -06:00
parent 80d84e701e
commit 120830172e
1 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Help.md

@ -15,6 +15,8 @@ Bouquin supports various keyboard shortcuts:
- **Ctrl+Shift+P**: Go to previous day
- **Ctrl+Shift+N**: Go to next day
- **Ctrl+Shift+T**: Go to today
- **Ctrl+Shift+S**: Open Statistics
- **Ctrl+T**: Open Tag Browser
- **Ctrl+D**: Open this documentation page
- **Ctrl+R**: Report a bug via mig5's contact form
- **Ctrl+Q**: Quit the application
@ -91,12 +93,23 @@ If there are multiple dates with a match, these will be listed underneath each o
You can also search for text on the current page by pressing **Ctrl+F** or Navigate -> Find on page. This will open a search bar at the bottom of the page. You can set it to be case sensitive (it is case-insensitive by default) and scroll through matches. The matched word will be highlighted on the page.
## Tagging
You can add tags to a page via the collapsed 'Tags' widget in the left sidebar. If the tag already exists, it will auto-complete as you type. Each tag gets its own hex colour.
You can click on a tag to open the Tag Browser or go to the Tag Browser via the File -> menu (or press **Ctrl+T**). From there, you can:
* Add new tags (without assigning them to a page)
* Rename tags
* Change the colour of tags
* Expand a tag to see a list of dated pages which have that tag. Double-clicking on the date will open that page.
## Settings
In the File -> Settings dialog, it is possible to:
- Configure the **theme** (dark, light or system mode)
- Change the locale (currently English and French supported). You must restart the app to load in the new selected language
- Change the locale (currently English, French and Italian supported). You must restart the app to load in the new selected language
- **Change to a different notebook** (must exist on the disk somewhere)
- **Remember the encryption key**. Doing so means 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.
@ -108,7 +121,6 @@ In the File -> Settings dialog, it is possible to:
Currently, the following formats are supported for export (these are all *unencrypted* data exports!):
- TXT
- JSON
- CSV
- HTML