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

Update Help

Miguel Jacq 2025-11-20 19:13:45 -06:00
parent 61045ff663
commit 145fb00e77
1 changed files with 47 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

50
Help.md

@ -31,10 +31,13 @@ Bouquin supports various keyboard shortcuts:
- **Ctrl+1**: Set selected text to h1 (heading) - **Ctrl+1**: Set selected text to h1 (heading)
- **Ctrl+2**: Set selected text to h2 (heading) - **Ctrl+2**: Set selected text to h2 (heading)
- **Ctrl+3**: Set selected text to h3 (heading) - **Ctrl+3**: Set selected text to h3 (heading)
- **Ctrl+N**: Set selected text to normal size (paragraph) - **Ctrl+.**: Set selected text to normal size (paragraph)
- **Ctrl+Shift+-**: Decrease size of normal text
- **Ctrl+Shift++**: Increase size of normal text
- **Ctrl+`**: Set selected text to be in a ```<code>``` block - **Ctrl+`**: Set selected text to be in a ```<code>``` block
#### Checkboxes #### Checkboxes
It's possible to add checkboxes into the editor. It's possible to add checkboxes into the editor.
@ -100,20 +103,61 @@ You can also search for text on the current page by pressing **Ctrl+F** or Navig
## Tagging ## Tagging
### Tag widget in the sidebar
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 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: When a page is tagged, searching in the Search sidebar tool for that tag will also return the page that has that tag.
* Add new tags (without assigning them to a page) ### Tag Browser
You can click on a tag to open the Tag Browser (or press **Ctrl+T**). From there, you can:
* Add new tags (without yet assigning them to a page)
* Rename tags * Rename tags
* Change the colour of 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. * Expand a tag to see a list of dated pages which have that tag. Double-clicking on the date will open that page.
### Disabling Tag feature
If you have no need for the Tagging feature and find it a distraction on the screen, you can disable the feature in the Settings.
## Time Log
### Projects and Activities
It is possible to record time for each day. The Time Log Manager lets you define 'Projects' and 'Activities'. An activity can be associated with any project.
Once you have projects and activities, you can record time against them. Typing in an activity will auto-complete from the known list. You can rename activities and projects.
### Editing time entries
You can click on a cell in the time table to modify its value as well. If you modify the name of the project or activity to something that didn't previously exist, that will implicitly add that as a new project or activity.
Use decimals for time entries, where '1' represents one hour. E.G, 0.25 is 15 minutes, 0.33 is 20, 0.42 is 25, 0.58 is 35, 0.83 is 50, and so on.
Once you close the time dialog, the summary of the time spent will update automatically in the sidebar with a breakdown of time per project, and a total.
### Notes
You can also leave a note when recording the time for that activity. For example, if you had an activity called 'Meetings', you could record 1 hour with a note 'Meeting with Marco'.
### Reporting and exporting timesheets
You are able to run a report of time across a date range for a specific project. It is possible to set the granularity of the report to day, week or month.
Once you have generated a report, you can export it to either CSV or PDF. The PDF export shows a graph but it is less detailed than the CSV, the latter of which also contains the notes associated with the time entries.
### Disabling Time Log feature
If you have no need for the Time Log feature and find it a distraction on the screen, you can disable the feature in the Settings.
## Settings ## Settings
In the File -> Settings dialog, it is possible to: In the File -> Settings dialog, it is possible to:
- Configure the **theme** (dark, light or system mode) - Configure the **theme** (dark, light or system mode)
- Configure the font size (this applies to all pages)
- Change the locale (currently English, French and Italian 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
- **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.) - **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. - **Change the encryption key**. This will prompt for a new passphrase and will re-encrypt the database with that passphrase.