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

Revision as of 01:43, 12 February 2007

Basic API Function needed to support word processor interaction with a Bibliographic Application (like Zotero)
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, description, Current (default) Collection name.
Request list of References from the selected or default collection. With option for selection criteria for large reference lists: i.e {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 - ref 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, ref id numbers in document order.	Returns formatted bibliography text.

Optional Extras actions to manage reference data
Word processor	Bibliographic Application
Request reference to be deleted, Collection name, ref id number.	Connection name, ref id number is deleted.
Connection name, new reference is added.	Request add new Collection: Collection name.
Collection name is added.	Returns list of Citation styles supported: Style Name, Description, & other Style Metadata: Author, version , date etc.
Request delete Collection: Collection name.	Named Collection is deleted.

@@ Line 25: / Line 25: @@
 style & variant names (i.e initial & subsequent forms), formatted text strings.
 |-
-| Word processor || Bibliographic Application
+| Request bibliography text.
+Send -  Selected Citation Style name, ref id numbers in document order.
+|| Returns formatted bibliography text.
+|}
+{| border="1"
+|+ Optional Extras actions to manage reference data
+! Word processor !! Bibliographic Application
+|-
+| Request reference to be deleted, Collection name, ref id number.
+||Connection name, ref id number is deleted.
+|
 |-
-| Word processor || Bibliographic Application
+| Connection name, new reference is added.
+|| Request add new Collection: Collection name.
 |-
-}
+| Collection name is added.
+|| Returns list of Citation styles supported:
+Style Name, Description, & other Style Metadata: Author, version , date etc.
+|-
+| Request delete Collection: Collection name.
+|| Named Collection is deleted.
+|-
+|}