From 799ba6f72294167c34f458ba875e24ae9a6ed452 Mon Sep 17 00:00:00 2001 From: Joost Kremers Date: Thu, 15 Sep 2011 09:28:40 +0200 Subject: [PATCH] Manual change: autogeneration of keys --- manual/ebib.text | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/manual/ebib.text b/manual/ebib.text index 531b495..9195e3e 100644 --- a/manual/ebib.text +++ b/manual/ebib.text @@ -213,19 +213,18 @@ for an entry key, as every entry must be identified by a unique key. Just type a name for the new entry (say `jones1998`). Since the entry key must be unique, Ebib will complain if you enter a key that already exists. +You can also have Ebib automatically generate entry keys: if you set the +customisation option [Autogenerate Keys](#autogenerate-keys), Ebib does not ask +you for a key when you add a new entry. Instead, it creates a temporary key (of +the form ``). When you have finished entering the field values for +the new entry, Ebib automatically replaces the temporary key with a key that is +based on the contents of the `author` (or `editor`), `year` and `title` fields. + Note that if you should later decide that you want to change the key of an entry, you can do so with the command `E`. So if you have an entry with the key `jones1998` and you want to add another entry by Jones from 1998, you can call the -new one `jones1998b` and rename the existing one to `jones1998a`. - -Note that you can also have Ebib automatically generate a key for an entry: in -order to do this, you first have to give some temporary key when you add the -entry to the database, then when you have finished filling out the field values, -press `K` in the index buffer. Ebib will then update the key of the current -entry with one generated from the fields. Ebib uses the function -`bibtex-generate-autokey` for this, which is part of Emacs' `bibtex-mode`. This -function has a wide array of customisation options, see the documentation for -`bibtex-generate-autokey` for details. +new one `jones1998b` and rename the existing one to `jones1998a`. Similarly, it +is possible to let Ebib recreate an autogenerated key by pressing `K`. Deleting an entry is done with `d`. Be careful with this: you will be asked for confirmation, but once you've confirmed, the entry is gone, and it is not @@ -1576,6 +1575,20 @@ the key of each entry, but if this is too little information, you can use this option to display e.g. the title of each entry as well. +### Autogenerate Keys ### + +**Default value**: `nil`.\newline + +\noindent This option specifies whether Ebib should autogenerate keys or not. If +set, adding a new entry will not ask for a key. Instead, a temporary key +`` is used. When you leave the entry buffer, this key is replaced +with an autogenerated key. + +Ebib uses the function `bibtex-generate-autokey` to generate the key. This +function has a number of customisation options, which are described in its +documentation string. + + ### Insertion Commands ### **Default value**: `((cite 1 nil))`.\newline -- 2.11.4.GIT