Difference between revisions of "Bibliographic/Developer Page/Services API"
(→Option 2 Bibliographic Application handles the Selection of Citations) |
m (→Notes:) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
'''This page is very much under construction and we would appreciate assistance in making it better.''' [[User:Dnw|David Wilson]] | '''This page is very much under construction and we would appreciate assistance in making it better.''' [[User:Dnw|David Wilson]] | ||
| − | == | + | ==Option 1 Word Processor handles the Selection of Citations== |
| + | |||
| + | The Word Processor handles citation selection and optionally some the citation management functions. The reference list is requested from the Bibliographic Application, It is displayed on the WP using it own browser panel, and the user selects the citation(s) to be inserted from list.The WP then requests the formatted citation text from the Bibliographic Application for display. | ||
| − | |||
{| border="1" cellpadding="2" | {| border="1" cellpadding="2" | ||
| Line 22: | Line 21: | ||
{keyword=irish, keyword=sagas, PublishedDate > 1999}. | {keyword=irish, keyword=sagas, PublishedDate > 1999}. | ||
| − | ''User selects | + | ''User selects Citation(s) from the provided list.'' |
|| Returns list of References in the named selected or default Collection: | || Returns list of References in the named selected or default Collection: | ||
list of field names, then the fields: | list of field names, then the fields: | ||
| Line 34: | Line 33: | ||
Style Name, Description, & other Style Metadata: Author, version , date etc. | Style Name, Description, & other Style Metadata: Author, version , date etc. | ||
|- | |- | ||
| − | | Request citation text. Send: | + | | Request citation(s) text. Send: |
| − | Selected Citation Style name, ref id number. | + | Selected Citation Style name(s), ref id number(s). |
|| Returns formatted text: | || Returns formatted text: | ||
style & variant names (i.e initial & subsequent forms), formatted text strings. | style & variant names (i.e initial & subsequent forms), formatted text strings. | ||
| Line 47: | Line 46: | ||
| − | + | ===Diagram=== | |
[[Image:BibliographicAPI.png]] | [[Image:BibliographicAPI.png]] | ||
| Line 57: | Line 56: | ||
* [[Bibliographic_API_Enhancements#Service_BibliographicCitation | Service BibliographicCitation]] | * [[Bibliographic_API_Enhancements#Service_BibliographicCitation | Service BibliographicCitation]] | ||
| − | + | ==Option 2 Bibliographic Application handles the Selection of Citations== | |
The Bibliographic Application handles the Citation management and citation selection. Each citation is pushed into the word processor document at the current cursor location via a command on the Bibliographic Application. | The Bibliographic Application handles the Citation management and citation selection. Each citation is pushed into the word processor document at the current cursor location via a command on the Bibliographic Application. | ||
| Line 71: | Line 70: | ||
Bibliographic Application pushes citation to WP. Sending the formatted reference strings. | Bibliographic Application pushes citation to WP. Sending the formatted reference strings. | ||
| − | '''Question: DO we need to collect the reference data as well ???''' | + | '''Question: DO we need to collect the reference data as well ???[https://wiki.openoffice.org/wiki/Bibliographic_Services_API#Do_we_need_to_collect_the_reference_data_as_well_.3F]''' |
reference id number, Author, Title, Publisher, date, keywords, etc. | reference id number, Author, Title, Publisher, date, keywords, etc. | ||
| Line 97: | Line 96: | ||
The Diagram would be similar to the one above but the Service BrowseCitation would be on the Bibliographic Application side rather than with the Word Processor. | The Diagram would be similar to the one above but the Service BrowseCitation would be on the Bibliographic Application side rather than with the Word Processor. | ||
| − | + | ==Optional Extras== | |
{| border="1" width=100% cellpadding="2" | {| border="1" width=100% cellpadding="2" | ||
| Line 124: | Line 123: | ||
|- | |- | ||
|} | |} | ||
| − | |||
| − | |||
==Notes:== | ==Notes:== | ||
| Line 138: | Line 135: | ||
* year | * year | ||
| − | These could stored in the proposed new [ | + | These could stored in the proposed new [https://wiki.openoffice.org/wiki/Bibliographic_API_Enhancements#constants_group_BibliographyDataField 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 [ | + | 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 [https://wiki.openoffice.org/wiki/Bibliographic_API_Enhancements#constants_group_BibliographyDataField 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 | + | Author name and year are suggested to enable functions like - '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. | 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. | and you do not want the author's name repeated in the citation field. | ||
| + | |||
| + | ===Do we need to collect the reference data as well ?=== | ||
| + | |||
| + | Currently the only options for storing the reference data in the current form of Writer, is to store it in the document as bibliographic fields or the bibliographic database. Storing the data in the document is not practical because the current bibliographic fields do not allow the user, or I believe a program to override the bibliographic field re-formatting process. So that even if you overwrote the bibliographic citation field, a 'Update Fields' action would remove the custom citation string. I do not think placing the citation reference data in the database automatically as much use as there are other was of doing this. | ||
| + | |||
| + | When the new proposed ODF metadata enhancements are in place, it will be quite practical to store the reference data along with a citation string and/or bibliography generated by another application. | ||
==Related Links== | ==Related Links== | ||
| Line 152: | Line 155: | ||
| − | [[ | + | [[Bibliographic/Developer Page/API Enhancements#Service_BibliographicCitation | Bibliographic API Enhancements]] |
| − | [[Citeproc_Writer_Interaction | Citeproc Writer Interaction]] | + | [[Bibliographic/Citeproc_Writer_Interaction | Citeproc Writer Interaction]] |
[http://www.zotero.org/blog/feature-spotlight-zotero-microsoft-word-integration-alpha/ Feature Spotlight: Zotero Microsoft Word Integration Alpha] | [http://www.zotero.org/blog/feature-spotlight-zotero-microsoft-word-integration-alpha/ Feature Spotlight: Zotero Microsoft Word Integration Alpha] | ||
| Line 160: | Line 163: | ||
[http://bibliographic.openoffice.org/servlets/SearchList?list=dev&searchText=zotero&defaultField=subject&Search=Search OOo Bibliographic Projects's Dev mailing list Search='zotero'] | [http://bibliographic.openoffice.org/servlets/SearchList?list=dev&searchText=zotero&defaultField=subject&Search=Search OOo Bibliographic Projects's Dev mailing list Search='zotero'] | ||
| − | [[ | + | [[Bibliographic/Developer_Page | OOo Bibliographic Projects's Developers Page]] |
| − | [[Category:Bibliographic]] | + | [[Category:Bibliographic|API]] |
Latest revision as of 13:41, 15 May 2022
This page is very much under construction and we would appreciate assistance in making it better. David Wilson
Contents
Option 1 Word Processor handles the Selection of Citations
The Word Processor handles citation selection and optionally some the citation management functions. The reference list is requested from the Bibliographic Application, It is displayed on the WP using it own browser panel, and the user selects the citation(s) to be inserted from list.The WP then requests the formatted citation text from the Bibliographic Application for display.
| 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 Citation(s) 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(s) text. Send:
Selected Citation Style name(s), ref id number(s). |
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. |
Diagram
Links to service descriptions
Option 2 Bibliographic Application handles the Selection of Citations
The Bibliographic Application handles the Citation management and citation selection. Each citation is pushed into the word processor document at the current cursor location via a command on the Bibliographic Application.
| Word processor | Bibliographic Application |
|---|---|
| Citation is received and inserted in Text. | User selects Citation from the provided list.
Bibliographic Application pushes citation to WP. Sending the formatted reference strings. Question: DO we need to collect the reference data as well ???[1] 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 new citation formatting. Send:
Selected Citation Style name, reference id numbers. |
Returns full set of formatted citation strings:
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. |
Diagram
The Diagram would be similar to the one above but the Service BrowseCitation would be on the Bibliographic Application side rather than with the Word Processor.
Optional Extras
| 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. |
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 suggested to enable functions like - '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.
Do we need to collect the reference data as well ?
Currently the only options for storing the reference data in the current form of Writer, is to store it in the document as bibliographic fields or the bibliographic database. Storing the data in the document is not practical because the current bibliographic fields do not allow the user, or I believe a program to override the bibliographic field re-formatting process. So that even if you overwrote the bibliographic citation field, a 'Update Fields' action would remove the custom citation string. I do not think placing the citation reference data in the database automatically as much use as there are other was of doing this.
When the new proposed ODF metadata enhancements are in place, it will be quite practical to store the reference data along with a citation string and/or bibliography generated by another application.
Related Links
Bibliographic API Enhancements
Feature Spotlight: Zotero Microsoft Word Integration Alpha
OOo Bibliographic Projects's Dev mailing list Search='zotero'
