Difference between revisions of "Bibliographic/Developer Page/API Enhancements"

Revision as of 02:41, 22 September 2006

Details of the current Bibliographic implementation and API reference documentation is available here.

service Bibliography

com :: sun :: star :: text :: FieldMaster ::

Description

specifies service of a Bibliography field master. See also

com::sun::star::text::TextField

This service needs to be totally rewritten. The current bibliography index generation uses the standard OpenOffice.org indexing method, used for table of contents etc. The new service bibliography will collect the list of citation keys and pass them to the Citeproc formatting engine which will return the formatted Bibliography text.

None of the current list of constants for this service

• boolean IsNumberEntries
• string BracketBefore
• string BracketAfter
• sequence< ::com::sun::star::beans::PropertyValues > SortKeys
•  ::com::sun::star::lang::Locale Locale
• string SortAlgorithm

needs to be kept Citeproc does not (at this stage) need any options passed to it.

constants group BibliographyDataField

com :: sun :: star :: text ::

Description

This constants group needs to be totally rewritten. The old definition was

“These values define parts of bibliographic data. They are used to create a
bibliography in a text document.”

The new definition is:

These values define the characteristics of an individual bibliographic entry. 
It no longer contains the bibliographic data but instead holds a key to the
bibliographic data stored in the bibliographic data file.

string Key

This field contains a key which acts as an index to the bibliographic data stored in the biblio-data.xml file in the save package. The key is defined in the XML like this-

 <cite:biblioref cite:key="urn:isbn:0814712827#154"> 

formattedText CitationString

The formatted citation text, generated by CiteProc, to be displayed. (describe selection process)

formattedText CitationPrefix

The formatted text which the user considers citation prefix.

formattedText CitationSuffix

The formatted text which the user considers citation suffix

formattedText CitationLocation

The formatted text which contains the location details (i.e. page number(s))

string LocationType

The type of location page, chapter, track number (on a CD) etc.

string Location

The number, name, description etc. of the location of the citation.

boolean IsInitial

Determines whether this citation is the first reference (ie first use of the hash key in the text) to the reference within the defined text range. Method: The current API of the Writer provides an interface XTextRangeCompare. With this interface two text ranges (citations are also text ranges) can be sorted. This interface is implemented at each text part (body text, header, footer, footnote areas, text frames, table cells, draw text).

boolean IsIbid

Determines whether this citation directly follows a citation to the same reference. (ie the the cite:key as the previous citation) so that a citation like 'Ibid, p 34.' may be displayed.

boolean IsIbidSameLocation

Determines whether this citation directly follows a citation to the same reference and location. (ie the same cite:key and the same location as the previous citation)so that a citation like 'Ibid' may be displayed.

string CitationAuthorName

The author name of the citation

string CitationDate

The date of the citation

booleen ExcludeAuthorName

Determines whether this citation excludes the author name. This option is needed when you have referred to the author's name in the text and do not want it included in the citation. i.e.

Gao Xingjian in his novel 'sole mountain' (1990) explores identity 
and myth in China.

booleen ExcludeDate

Determines whether this citation excludes the date. This option is needed when you have referred to the date in the text and do not want it included in the citation. i.e.

The 1990 novel 'sole mountain' (GaoXingjian) explores identity and 
myth in China.