diff options
author | Joost Kremers <joostkremers@fastmail.fm> | 2017-03-11 02:00:20 +0100 |
---|---|---|
committer | Joost Kremers <joostkremers@fastmail.fm> | 2017-03-11 02:00:20 +0100 |
commit | db013e0bfb9994720f29db16afd1925eab2a9f09 (patch) | |
tree | 9896d40e79b381413d9fb0d90a97ee2d0451a0f8 /README.md | |
parent | 8c1eb99f32a0609ec5872a683f1f9369d435062e (diff) |
Cosmetic changes to the manual.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -14,7 +14,7 @@ Higher-level API The higher-level API consists of functions that read and return all items of a specific type in the current buffer. They do not move point. -`parsebib-collect-entries (&optional hash strings)` +## `parsebib-collect-entries (&optional hash strings)` ## Collect all entries in the current buffer and returns them as a hash table, where the keys correspond to the BibTeX keys and the values are alists consisting of `(<field> . <value>)` pairs of the relevant entries. In this alist, the BibTeX key and the entry type are stored under `=key=` and `=type=`, respectively. @@ -23,33 +23,33 @@ The variable `hash` can be used to pass a hash table in which the entries are st The variable `strings` is a hash table of `@string` definitions, where the keys are the `@string` abbreviations and the values their expansions. If the variable `strings` is present, abbreviations occurring in the field values of the entries being read are expanded. Furthermore, the (outer) braces or double quotes are removed from field values. -`parsebib-collect-strings (&optional hash expand-strings)` +## `parsebib-collect-strings (&optional hash expand-strings)`## Collect all `@string` definitions in the current buffer. Again, the variable `hash` can be used to provide a hash table to store the definitions in. If it is `nil`, a new hash table is created and returned. The argument `expand-strings` is a boolean value. If non-nil, any abbreviations found in the string expansions are expanded. You do not need to pass a hash table to the function for this to work. Every `@string` definition is added to the hash table as soon as it is read, which means that a `@string` definition can use an expansion defined earlier in the same file. -`parsebib-collect-preambles` +## `parsebib-collect-preambles` ## Collect all `@preamble` definitions in the current buffer and return them as a list. -`parsebib-collect-comments` +## `parsebib-collect-comments` ## Collect all `@comments` in the current buffer and return them as a list. -`parsebib-find-bibtex-dialect` +## `parsebib-find-bibtex-dialect` ## Find and return the BibTeX dialect for the current buffer. The BibTeX dialect is either `BibTeX` or `biblatex` and can be defined in a local-variable block at the end of the file. -`parsebib-parse-buffer (&optional entries-hash strings-hash expand-strings)` +## `parsebib-parse-buffer (&optional entries-hash strings-hash expand-strings)` ## Collect all BibTeX data in the current buffer. Return a five-element list: - (<entries> <strings> <preambles> <comments>, <BibTeX dialect>) + (<entries> <strings> <preambles> <comments> <BibTeX dialect>) The `<entries>` and `<strings>` are hash tables, `<preambles>` and `<comments>` are lists, `<BibTeX dialect>` is a symbol (either `BibTeX` or `biblatex`). |