diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 24 insertions, 6 deletions
@@ -30,6 +30,7 @@ - [Search](#search) - [Edit bib entry](#edit-bib-entry) - [Open connected files or links](#open-connected-files-or-links) + - [Note file creation](#note-file-creation) - [Issues and code improvement](#issues-and-code-improvement) - [Alternatives](#alternatives) - [Comparison](#comparison) @@ -45,7 +46,7 @@ Here's a small impression how it looks and works: [](https://postimg.cc/ct0W0mK4) - + ## Installation<a name="installation"></a> @@ -291,6 +292,7 @@ info_color = "99" confirm_color = "47" warn_color = "124" bar_bg_color = "234" +popup_fg_color = "43" popup_bg_color = "234" selected_row_bg_color = "237" note_color = "123" @@ -337,6 +339,7 @@ These are the current features, the list will be updated: - [x] **Implement config file** for setting some default values like main bibfile, PDF-opener, or editor - [x] **Open related notes file** for specific entry. +- [x] **Create note file** for bib entries. - [ ] **Support Hayagriva(`.yaml`)** format as input (_on hold for now_, because the Hayagriva Yaml style doesn't offer keywords; s. issue in [Hayagriva repo](https://github.com/typst/hayagriva/issues/240)). @@ -362,6 +365,7 @@ Use the following keybindings to manage the TUI: | `e` | Open editor at selected entry | | `a` | Add entry through DOI | | `o` | Open related PDF or URL/DOI | +| `n` | Create new note file for selected entry | | `TAB` | Switch between entries and keywords | | `/`, `Ctrl-f` | Enter search mode | | `Enter` | Filter by selected keyword / Confirm search or selection | @@ -373,7 +377,8 @@ Use the following keybindings to manage the TUI: There are some shortcuts to select an item from the opening/yanking popup without navigating the list: -- `o-o`|`o-l`|`o-n`: directly opens the first file|link|note for the selected entry. +- `o-o`|`o-l`|`o-n`: directly opens the first file|link|note for the selected + entry. - `y-y`: directly yanks the citekey of the selected entry to the clipboard. ## Search<a name="search"></a> @@ -411,12 +416,12 @@ thus, there might be unexpected errors with it. ## Open connected files or links<a name="open-connected-files-or-links"></a> -`bibiman` also provides the possibility to open PDFs (as value of the `file` -BibLaTeX field), as well as DOIs and URLs. +`bibiman` also provides the possibility to open PDFs , note files, as well as +DOIs and URLs connected with the different entries of the bibfile. For selecting the right program, it uses `xdg-open` on Linux, `open` on MacOS, -and `start` on Windows. Thanks to the report from @bastislack in #2 MacOS seems -to work. +and `start` on Windows by default. Thanks to the report from @bastislack in #2 +MacOS seems to work. _However, Windows does not work. Have to figure this out. Reports from some Windows users are very welcome._ @@ -425,6 +430,19 @@ Furthermore, DOIs have to begin with either `https://doi...` as full URL or `10.(...)` as regular DOI style. URLs work if they begin with either `http...` or with `www...`. +## Note file creation<a name="note-file-creation"></a> + +It is possible to create notes for an entry missing such a file. The `note_path` +and `note_extensions` values need to be set in the config file or it will fail. + +The notes basename is *always* the citekey of the selected entry and the +directory is set to the value of the `note_path` variable. The extension can be +choosen from one of the file format extension set in the `note_extensions` +array. + +The bibfile itself will *not be edited*. Therefore, you can't break anything in +your bibfile with this operation! + ## Issues and code improvement<a name="issues-and-code-improvement"></a> This is my first Rust project and, thus, also a learning process. If you find |