Difference between revisions of "Bibliographic/OOoBib Functional Requirements"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Formatting: intext, footnote and endnote style citations)
(Requirements)
Line 8: Line 8:
 
'''You are invited to add to and improve this document.''' Editorial control will by [mailto:dnw@openoffice.org David Wilson] and [mailto:bdarcus@openoffice.org Bruce D'Arcus].
 
'''You are invited to add to and improve this document.''' Editorial control will by [mailto:dnw@openoffice.org David Wilson] and [mailto:bdarcus@openoffice.org Bruce D'Arcus].
  
= Requirements =
+
= Requirements List=
  
 
== Citations ==
 
== Citations ==
Line 40: Line 40:
 
* provide a reference management GUI for use with enhanced data model, which includes:
 
* provide a reference management GUI for use with enhanced data model, which includes:
 
** auto-completion of contributors and related items (periodicals, etc.)
 
** auto-completion of contributors and related items (periodicals, etc.)
 +
* provide simple and easy to use GUI data entry panels for common reference types, such as books journal and articles.
 +
* provide 'advanced' GUI data entry panels to provide full access to all the relationships supported by the data model.

Revision as of 01:39, 6 April 2006

Back to Bibliographic Project Index

Note this page documents the user functional requirements for the enhanced bibliographic module. That is, we focus on what the user needs, rather than on technical issues.

We also have a separate page devoted to the Enhancements needed in Writer to support an improved Bibliographic module

Please Contribute

You are invited to add to and improve this document. Editorial control will by David Wilson and Bruce D'Arcus.

Requirements List

Citations

Note: these requirements are reflected in the design of the new citation coding.

  • individual citations must allow more than one reference
  • citation references must be able to include additional information such as page numbers and captions
  • citation references must be linked to metadata objects, and be separate from their formatted representation (separation of semantic structure from presentation)

Formatting

  • must be dynamic:
  • as new citations are added, the formatted citations and references are regenerated
  • changing styles should not require user editing
  • must support common features such as:
    • distinction between first/subsequent citation formatting
    • other conditional exceptions such as ibid., et al, etc.
    • in-text, footnote and endnote style citations.

Data Model

  • the model shall be relational
  • primary entities shall be reference items, collections, events, and agents/contributors

API

  • OOo shall expose a standard API for remote and third-party access, based on ZOOM (use Index Data's code here; we need to talk to the ID guys about this)

Import/Export

  • support import/export of standard formats (RIS, Refer/Endnote, BibTeX, MODS)

GUI

  • provide a citation insertion and management GUI suitable for use with both local and remote databases
  •  provide a reference management GUI for use with enhanced data model, which includes:
    • auto-completion of contributors and related items (periodicals, etc.)
  • provide simple and easy to use GUI data entry panels for common reference types, such as books journal and articles.
  • provide 'advanced' GUI data entry panels to provide full access to all the relationships supported by the data model.
Personal tools