API
TeXfile
A class representing a BibTeX file
__init__()
Initialisation
Todo
Extract DB entries and set them up as Python definitions?
_splitHTMLaware(what)
Splits the given string at ';' and ',', assuring that a split is not done if the occured ';' belongs to a HTML-encoded special character
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
what |
str
|
The string to split |
required |
Returns:
| Type | Description |
|---|---|
List[str]
|
The split string |
read2string(file, skipComments=True, convertSpaces=True)
Reads the file optionally discarding comments and replacing tabs by spaces
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file |
str
|
The name of the file to read |
required |
skipComments |
bool
|
Whether comments shall be removed |
True
|
convertSpaces |
bool
|
Whether tabs shall be converted to spaces |
True
|
Returns:
| Type | Description |
|---|---|
str
|
The file contents, optionally stripped and without tabs |