Difference between revisions of "Bibliographic/Developer Page/Services API"
(→API List) |
(→API List) |
||
| Line 9: | Line 9: | ||
!width="50%" | Word processor !! Bibliographic Application | !width="50%" | Word processor !! Bibliographic Application | ||
|- | |- | ||
| − | | Request list of Reference Data Collections (libraries / folders) available.''User selects Collection. It is made current.'' | + | | Request list of Reference Data Collections (libraries / folders) available. |
| + | |||
| + | ''User selects Collection. It is made current.'' | ||
|| Returns list of available Reference Data Collections : | || Returns list of available Reference Data Collections : | ||
Collection names, Descriptions, Current (default) Collection name. | Collection names, Descriptions, Current (default) Collection name. | ||
|- | |- | ||
| − | | Request list of References from the selected or default collection. Includes an option for selection criteria for large reference lists: i.e {keyword=irish, keyword=sagas, PublishedDate > 1999}. | + | | Request list of References from the selected or default collection. Includes an option for selection criteria for large reference lists: i.e send: |
| + | |||
| + | {keyword=irish, keyword=sagas, PublishedDate > 1999}. | ||
''User selects Citations from the provided list.'' | ''User selects Citations from the provided list.'' | ||
| Line 23: | Line 27: | ||
|- | |- | ||
| Request List of Bibliographic Styles, and style variants. | | Request List of Bibliographic Styles, and style variants. | ||
| − | User selects the Citation Style, It is made current. | + | |
| + | ''User selects the Citation Style, It is made current.'' | ||
|| Returns list of Citation styles supported: | || Returns list of Citation styles supported: | ||
Style Name, Description, & other Style Metadata: Author, version , date etc. | Style Name, Description, & other Style Metadata: Author, version , date etc. | ||
| Line 35: | Line 40: | ||
| Request bibliography text. Send: | | Request bibliography text. Send: | ||
| − | Selected Citation Style name, reference id numbers in document order. | + | Selected Citation Style name, reference id numbers in document order, any bibliography formatting options. |
|| Returns formatted bibliography text. | || Returns formatted bibliography text. | ||
|} | |} | ||
| Line 70: | Line 75: | ||
[[Image:BibliographicAPI.png]] | [[Image:BibliographicAPI.png]] | ||
| + | |||
| + | ====Links to service descriptions==== | ||
| + | |||
| + | * [[Bibliographic_API_Enhancements#service_Bibliography | service Bibliography]] | ||
| + | * [[Bibliographic_API_Enhancements#service_Metadata_and_User_Defined_Data_Access | service Metadata]] | ||
| + | * [[Bibliographic_API_Enhancements#Service_BibliographicCitation | Service BibliographicCitation]] | ||
==Notes:== | ==Notes:== | ||
Revision as of 22:50, 12 February 2007
Back to Bibliographic Project index
This page is very much under construction and we would appreciate assistance in making it better. David Wilson
API List
| Word processor | Bibliographic Application |
|---|---|
| Request list of Reference Data Collections (libraries / folders) available.
User selects Collection. It is made current. |
Returns list of available Reference Data Collections :
Collection names, Descriptions, Current (default) Collection name. |
| Request list of References from the selected or default collection. Includes an option for selection criteria for large reference lists: i.e send:
{keyword=irish, keyword=sagas, PublishedDate > 1999}. User selects Citations from the provided list. |
Returns list of References in the named selected or default Collection:
list of field names, then the fields: reference id number, Author, Title, Publisher, date, keywords, etc. |
| Request List of Bibliographic Styles, and style variants.
User selects the Citation Style, It is made current. |
Returns list of Citation styles supported:
Style Name, Description, & other Style Metadata: Author, version , date etc. |
| Request citation text. Send:
Selected Citation Style name, ref id number. |
Returns formatted text:
style & variant names (i.e initial & subsequent forms), formatted text strings. |
| Request bibliography text. Send:
Selected Citation Style name, reference id numbers in document order, any bibliography formatting options. |
Returns formatted bibliography text. |
| Word processor | Bibliographic Application |
|---|---|
| Request reference to be deleted. Send:
Collection name, reference id number. |
Collection name, reference with id number is deleted. |
| Request reference to be added (or replaced). Send:
Collection name, list of field names, then the fields - Author, Title, Publisher, date, keywords, etc. |
In the named Collection name, the new reference is added (or replaced). |
| Request creation of new Collection. Send:
Collection name. |
Collection name is added. |
| Request delete Collection.Send:
Collection name. |
Named Collection is deleted. |
Diagram
Links to service descriptions
Notes:
I suggest that the Bibliographic Application provide the full set of citation variants, when a citation formatting request is made for a given style and language-
- initial full citation (in-text or footnote depending upon the style selected)
- subsequent shortened citation
- Ibid text
- Ibid & location text
- author name
- year
These could stored in the proposed new constants group BibliographyDataField.
The advantage of this is that when a user moves, adds or deletes a citation, Writer only needs to pick the appropriate stored citation string (initial, subsequent or Ibid) from the constants group BibliographyDataField to display the appropriate ciation text, and not calling Bibliographic Application again. When the user changes the document style, Bibliographic Application would be called to regenerate all the BibliographyDataField citation strings in one pass.
Author name and year are included as part of the mechanism to implement the 'Exclude Author's Name' and 'Exclude Year' options in the Insert Citation dialogue. These options are needed when you have referred to the author's name in the text, as in
Gao Xingjian in his novel 'sole mountain' (1990) explores identity and myth in China.
and you do not want the author's name repeated in the citation field.
Related Links
Bibliographic API Enhancements
Feature Spotlight: Zotero Microsoft Word Integration Alpha
OOo Bibliographic Projects's Dev mailing list Search='zotero'
