Skip to content

Commit

Permalink
Add note about history and registers to the manual.
Browse files Browse the repository at this point in the history
  • Loading branch information
Joost Kremers committed Jun 13, 2024
1 parent f03befb commit fc20848
Show file tree
Hide file tree
Showing 3 changed files with 142 additions and 126 deletions.
8 changes: 8 additions & 0 deletions docs/ebib-manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,14 @@ <h2 id="navigating-the-database">Navigating the Database</h2>
you want to jump to. You can also see the bibliography file to which the
entry belongs. This is a good way to search for a particular entry if
you’re not sure of the entry key.</p>
<p>Ebib keeps a history of the entries that you’ve visited. You can move
through this history with <span class="key"><code>C-b</code></span> and
<span class="key"><code>C-f</code></span>. Furthermore, using the
default commands <code>point-to-register</code> and
<code>jump-to-register</code> (which are rebound in the index buffer to
<code>ebib-current-entry-to-register</code> and
<code>ebib-jump-to-register</code>, respectively), you can store an
entry in a register and jump back to it at a later point.</p>
<h2 id="displaying-and-sorting-the-entries-list">Displaying and Sorting
the Entries List</h2>
<p>By default, the index buffer displays the list of entries in the
Expand Down
259 changes: 133 additions & 126 deletions ebib.info
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,13 @@ year of the entry you want to jump to. You can also see the
bibliography file to which the entry belongs. This is a good way to
search for a particular entry if you're not sure of the entry key.

Ebib keeps a history of the entries that you've visited. You can move
through this history with ‘C-b’ and ‘C-f’. Furthermore, using the
default commands ‘point-to-register’ and ‘jump-to-register’ (which are
rebound in the index buffer to ‘ebib-current-entry-to-register’ and
‘ebib-jump-to-register’, respectively), you can store an entry in a
register and jump back to it at a later point.


File: ebib.info, Node: Displaying and Sorting the Entries List, Next: Biblatex vs BibTeX, Prev: Navigating the Database, Up: Getting Started

Expand Down Expand Up @@ -3160,132 +3167,132 @@ Node: The Database View8246
Ref: #the-database-view8417
Node: Navigating the Database10415
Ref: #navigating-the-database10619
Node: Displaying and Sorting the Entries List12566
Ref: #displaying-and-sorting-the-entries-list12803
Node: Biblatex vs BibTeX17559
Ref: #biblatex-vs-bibtex17724
Node: Setting the BibTeX Dialect18560
Ref: #setting-the-bibtex-dialect18737
Node: Alias Types and Fields20756
Ref: #alias-types-and-fields20925
Node: Editing the Database22982
Ref: #editing-the-database23148
Node: Adding and Deleting Entries23760
Ref: #adding-and-deleting-entries23931
Node: Marking Entries25628
Ref: #marking-entries25804
Node: Editing Field Values26304
Ref: #editing-field-values26500
Node: @String abbreviations in field values29711
Ref: #string-abbreviations-in-field-values29958
Node: Editing Multiline Values32560
Ref: #editing-multiline-values32788
Node: Copy Cut Kill Paste Yank and Delete34691
Ref: #copy-cut-kill-paste-yank-and-delete34934
Node: Undefined Fields35905
Ref: #undefined-fields36085
Node: Hidden Fields36974
Ref: #hidden-fields37123
Node: Timestamps38181
Ref: #timestamps38325
Node: Saving a Database40232
Ref: #saving-a-database40396
Node: Exporting Entries41958
Ref: #exporting-entries42078
Node: Cross-referencing43450
Ref: #cross-referencing43624
Node: Sorting the bib File46052
Ref: #sorting-the-bib-file46245
Node: @Preamble Definition48493
Ref: #preamble-definition48678
Node: @String Definitions50641
Ref: #string-definitions50813
Node: @Comments53163
Ref: #comments53315
Node: Creating Entry Stubs53806
Ref: #creating-entry-stubs53983
Node: Multiline Edit Buffers54711
Ref: #multiline-edit-buffers54874
Node: Main and Dependent Databases59185
Ref: #main-and-dependent-databases59390
Node: Inserting Citations into a Text Buffer62276
Ref: #inserting-citations-into-a-text-buffer62490
Node: Single Citations62687
Ref: #single-citations62856
Node: Citations with multiple keys65221
Ref: #citations-with-multiple-keys65435
Node: Key Bindings67194
Ref: #key-bindings67386
Node: Defining Citation Commands68142
Ref: #defining-citation-commands68375
Node: Associating a Database with a Text Buffer74261
Ref: #associating-a-database-with-a-text-buffer74546
Node: Links and Citations in Org buffers75921
Ref: #links-and-citations-in-org-buffers76157
Node: Searching77586
Ref: #searching77721
Node: Filters81169
Ref: #filters81286
Node: Simple Selection82341
Ref: #simple-selection82466
Node: Complex Filters84169
Ref: #complex-filters84327
Node: Storing and Saving Filters88965
Ref: #storing-and-saving-filters89144
Node: Special Filters91995
Ref: #special-filters92172
Node: An Example Listing Recent Additions93555
Ref: #an-example-listing-recent-additions93780
Node: Properties of Filtered Databases96144
Ref: #properties-of-filtered-databases96337
Node: Importing BibTeX entries97984
Ref: #importing-bibtex-entries98155
Node: Merging bib files98469
Ref: #merging-bib-files98640
Node: Importing entries from a buffer99229
Ref: #importing-entries-from-a-buffer99462
Node: Integration with the Biblio package100491
Ref: #integration-with-the-biblio-package100740
Node: Multiple Identical Fields102525
Ref: #multiple-identical-fields102714
Node: Linking to external resources104628
Ref: #linking-to-external-resources104813
Node: Viewing and Importing Files105015
Ref: #viewing-and-importing-files105215
Node: Editing the file field110728
Ref: #editing-the-file-field110879
Node: Calling a Browser for URLs and DOIs112232
Ref: #calling-a-browser-for-urls-and-dois112448
Node: Notes files114748
Ref: #notes-files114898
Node: Configuring files for storing notes116386
Ref: #configuring-files-for-storing-notes116564
Node: Hooks119533
Ref: #hooks119696
Node: Upgrading from earlier Ebib versions121093
Ref: #upgrading-from-earlier-ebib-versions121316
Node: Customising the notes file format122226
Ref: #customising-the-notes-file-format122454
Node: Displaying notes126560
Ref: #displaying-notes126751
Node: Using org-capture to record notes128096
Ref: #using-org-capture-to-record-notes128287
Node: Managing a reading list134283
Ref: #managing-a-reading-list134445
Node: Managing Keywords137460
Ref: #managing-keywords137616
Node: Using a Canonical Keywords List139223
Ref: #using-a-canonical-keywords-list139381
Node: Window Management141519
Ref: #window-management141684
Node: Copying Entries to the Kill Ring144819
Ref: #copying-entries-to-the-kill-ring145018
Node: Printing the Database147741
Ref: #printing-the-database147914
Node: Customisation151357
Ref: #customisation151473
Node: Modifying Key Bindings152687
Ref: #modifying-key-bindings152814
Node: Displaying and Sorting the Entries List12983
Ref: #displaying-and-sorting-the-entries-list13220
Node: Biblatex vs BibTeX17976
Ref: #biblatex-vs-bibtex18141
Node: Setting the BibTeX Dialect18977
Ref: #setting-the-bibtex-dialect19154
Node: Alias Types and Fields21173
Ref: #alias-types-and-fields21342
Node: Editing the Database23399
Ref: #editing-the-database23565
Node: Adding and Deleting Entries24177
Ref: #adding-and-deleting-entries24348
Node: Marking Entries26045
Ref: #marking-entries26221
Node: Editing Field Values26721
Ref: #editing-field-values26917
Node: @String abbreviations in field values30128
Ref: #string-abbreviations-in-field-values30375
Node: Editing Multiline Values32977
Ref: #editing-multiline-values33205
Node: Copy Cut Kill Paste Yank and Delete35108
Ref: #copy-cut-kill-paste-yank-and-delete35351
Node: Undefined Fields36322
Ref: #undefined-fields36502
Node: Hidden Fields37391
Ref: #hidden-fields37540
Node: Timestamps38598
Ref: #timestamps38742
Node: Saving a Database40649
Ref: #saving-a-database40813
Node: Exporting Entries42375
Ref: #exporting-entries42495
Node: Cross-referencing43867
Ref: #cross-referencing44041
Node: Sorting the bib File46469
Ref: #sorting-the-bib-file46662
Node: @Preamble Definition48910
Ref: #preamble-definition49095
Node: @String Definitions51058
Ref: #string-definitions51230
Node: @Comments53580
Ref: #comments53732
Node: Creating Entry Stubs54223
Ref: #creating-entry-stubs54400
Node: Multiline Edit Buffers55128
Ref: #multiline-edit-buffers55291
Node: Main and Dependent Databases59602
Ref: #main-and-dependent-databases59807
Node: Inserting Citations into a Text Buffer62693
Ref: #inserting-citations-into-a-text-buffer62907
Node: Single Citations63104
Ref: #single-citations63273
Node: Citations with multiple keys65638
Ref: #citations-with-multiple-keys65852
Node: Key Bindings67611
Ref: #key-bindings67803
Node: Defining Citation Commands68559
Ref: #defining-citation-commands68792
Node: Associating a Database with a Text Buffer74678
Ref: #associating-a-database-with-a-text-buffer74963
Node: Links and Citations in Org buffers76338
Ref: #links-and-citations-in-org-buffers76574
Node: Searching78003
Ref: #searching78138
Node: Filters81586
Ref: #filters81703
Node: Simple Selection82758
Ref: #simple-selection82883
Node: Complex Filters84586
Ref: #complex-filters84744
Node: Storing and Saving Filters89382
Ref: #storing-and-saving-filters89561
Node: Special Filters92412
Ref: #special-filters92589
Node: An Example Listing Recent Additions93972
Ref: #an-example-listing-recent-additions94197
Node: Properties of Filtered Databases96561
Ref: #properties-of-filtered-databases96754
Node: Importing BibTeX entries98401
Ref: #importing-bibtex-entries98572
Node: Merging bib files98886
Ref: #merging-bib-files99057
Node: Importing entries from a buffer99646
Ref: #importing-entries-from-a-buffer99879
Node: Integration with the Biblio package100908
Ref: #integration-with-the-biblio-package101157
Node: Multiple Identical Fields102942
Ref: #multiple-identical-fields103131
Node: Linking to external resources105045
Ref: #linking-to-external-resources105230
Node: Viewing and Importing Files105432
Ref: #viewing-and-importing-files105632
Node: Editing the file field111145
Ref: #editing-the-file-field111296
Node: Calling a Browser for URLs and DOIs112649
Ref: #calling-a-browser-for-urls-and-dois112865
Node: Notes files115165
Ref: #notes-files115315
Node: Configuring files for storing notes116803
Ref: #configuring-files-for-storing-notes116981
Node: Hooks119950
Ref: #hooks120113
Node: Upgrading from earlier Ebib versions121510
Ref: #upgrading-from-earlier-ebib-versions121733
Node: Customising the notes file format122643
Ref: #customising-the-notes-file-format122871
Node: Displaying notes126977
Ref: #displaying-notes127168
Node: Using org-capture to record notes128513
Ref: #using-org-capture-to-record-notes128704
Node: Managing a reading list134700
Ref: #managing-a-reading-list134862
Node: Managing Keywords137877
Ref: #managing-keywords138033
Node: Using a Canonical Keywords List139640
Ref: #using-a-canonical-keywords-list139798
Node: Window Management141936
Ref: #window-management142101
Node: Copying Entries to the Kill Ring145236
Ref: #copying-entries-to-the-kill-ring145435
Node: Printing the Database148158
Ref: #printing-the-database148331
Node: Customisation151774
Ref: #customisation151890
Node: Modifying Key Bindings153104
Ref: #modifying-key-bindings153231

End Tag Table

Expand Down
1 change: 1 addition & 0 deletions manual/ebib.text
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ You can quickly jump to any entry in a database with the key [`j`]{.key}. This a

If you use [selectrum](https://github.com/raxod502/selectrum), [ivy](https://github.com/abo-abo/swiper) or [helm](https://github.com/emacs-helm/helm) or the built-in package ido, using [`j`]{.key} becomes even more convenient: instead of completing the entry key, you can type any part of the author/editor names, of the title and the year of the entry you want to jump to. You can also see the bibliography file to which the entry belongs. This is a good way to search for a particular entry if you're not sure of the entry key.

Ebib keeps a history of the entries that you've visited. You can move through this history with [`C-b`]{.key} and [`C-f`]{.key}. Furthermore, using the default commands `point-to-register` and `jump-to-register` (which are rebound in the index buffer to `ebib-current-entry-to-register` and `ebib-jump-to-register`, respectively), you can store an entry in a register and jump back to it at a later point.

## Displaying and Sorting the Entries List ##

Expand Down

0 comments on commit fc20848

Please sign in to comment.