Client.BibTeXItem Class Reference

A BibTeX bibliography item. More...

List of all members.

Public Member Functions
	BibTeXItem (LiteratureType theType, int id, string title)
	Constructs the initial bibliography item.
override string	ToString ()
	Returns a formatted string of the contents of the BibTeX item.
Public Attributes
LiteratureType	theType
	The type of literature we are dealing with. Since LiteratureType is a highest common denominator, we have to handle some of this rather specially, but that is all done in the overridden ToString() function bellow.
string	citeKey
	The key the user will call the citation by in LaTeX.
Dictionary< string, string >	fields = new Dictionary<string, string>()
	Each of the BibTeX entry fields, in the format name, value.

---

Detailed Description

A BibTeX bibliography item.

Definition at line 207 of file BibliographyExporter.cs.

---

Constructor & Destructor Documentation

Client.BibTeXItem.BibTeXItem	(	LiteratureType	theType,
		int	id,
		string	title
	)

Constructs the initial bibliography item.

Parameters:

	theType	The type of literature we are dealing with
	id	The ID of the literature, used to create the citeKey
	title	The title of the literature, required by all types of BibTeX items (bar Misc, but we're going to require it anyway)

Definition at line 227 of file BibliographyExporter.cs.

---

Member Function Documentation

override string Client.BibTeXItem.ToString

(

)

Returns a formatted string of the contents of the BibTeX item.

Returns:

A string containing the formatted BibTeX item, ready for inputting into a bibliography file

Definition at line 238 of file BibliographyExporter.cs.

References Client.BibTeXItem.citeKey, Client.BibTeXItem.fields, and Client.BibTeXItem.theType.

Referenced by Client.ExporterBibTeX.GetItem().

Here is the caller graph for this function:

---

Member Data Documentation

LiteratureType Client.BibTeXItem.theType

The type of literature we are dealing with. Since LiteratureType is a highest common denominator, we have to handle some of this rather specially, but that is all done in the overridden ToString() function bellow.

Definition at line 215 of file BibliographyExporter.cs.

Referenced by Client.BibTeXItem.ToString().

string Client.BibTeXItem.citeKey

The key the user will call the citation by in LaTeX.

Definition at line 217 of file BibliographyExporter.cs.

Referenced by Client.BibTeXItem.ToString().

Dictionary<string, string> Client.BibTeXItem.fields = new Dictionary<string, string>()

Each of the BibTeX entry fields, in the format name, value.

Definition at line 219 of file BibliographyExporter.cs.

Referenced by Client.ExporterBibTeX.GetItem(), and Client.BibTeXItem.ToString().

---

The documentation for this class was generated from the following file:

• Client/BibliographyExporter.cs

---