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

Update Help

Miguel Jacq 2025-11-02 01:10:11 -05:00
parent 0ce528fe40
commit dedbdef76c
1 changed files with 26 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Help.md

@ -7,6 +7,7 @@ Bouquin supports various keyboard shortcuts:
### Actions
- **Ctrl+S**: Save the notebook
- **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
@ -34,6 +35,30 @@ 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.
## Saving, History and version control
### History and version control
Bouquin supports versioning. Every time you save a page/date, it stores a new version of that page. The previous version remains in the database.
You can click on 'View History' from the toolbar, or via the **File -> History** navigation, or via `Ctrl+H`, to open the History dialog.
This will display a list of versions for the page, with the version number, timestamp and a 'note' about the change.
On the right will be a preview pane that shows that version of the page.
There is also a 'Diff vs current' tab which will show all the differences between the current version and the version you have selected in the left pane.
You can click on 'Revert to Selected' to revert to an older or newer version of the page. Your current version will still be in the database, so you can always revert 'back to the future' if you change your mind :)
### Autosave vs explicit save
Every 10 seconds, Bouquin will autosave the page if there were any unsaved changes. This will be given the note 'autosave' in the version history.
If you explicitly press `Ctrl+S` or via the **File -> Save** navigation, you will be prompted to optionally set a version note. You can either accept the default which has a reasonably meaningful message, or give it a meaningful note of your own.
## Searching for data
You can enter terms into the search bar in the left sidebar.
@ -44,6 +69,7 @@ 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.
**Note:** when searching for data, only the current version of the page is searched (not previous revisions/versions).
## Settings