Added: incubator/ooo/ooo-site/trunk/content/bibliographic/detailed enhacement proposals.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/detailed%20enhacement%20proposals.html?rev=1175536&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/bibliographic/detailed enhacement proposals.html (added) +++ incubator/ooo/ooo-site/trunk/content/bibliographic/detailed enhacement proposals.html Sun Sep 25 19:38:58 2011 @@ -0,0 +1,478 @@ + + + + + + + +

OpenOffice Bibliographic Project Discussion and +Issues

+ +

2005-December-4

+ +

Contents

+
    +
  1. Document Style Options
  2. +
  3. Revert to declared style
  4. +
  5. And symbols to the automatic footnote numbering + scheme.
  6. +
  7. Provide Support for Footnote Citation Styles by Adapting + the Field Editor for the Bibliography Tables.
  8. +
  9. Modify the ‘Bibliographic Entry>Edit’ + Panel to support appropriate field entry options for the citation type + selected.
  10. +
  11. Defining citations and references different treatment may + be needed for first and subsequent use of the citation.
  12. +
  13. There needs to be a mechanism for transferring the + internal Document Bibliographic entries to and from the database to allow + import and export from OpenOffice.
  14. +
  15. Some of the Bibliographic Databasefields need to be + increased in length.
  16. +
  17. Should we persist with the DBASE Bibliographic Database + ?
  18. +
  19. It would be nice to have search capability to Internet + Bibliographic Databases
  20. +
+
+ +

A printer friendly PDF version of this page is available +detailed.pdf (63Kb)

+ +

1. Add a selection option for 'Document Style' to cover whole +document.

+ +

We need to add user selection for a 'Document Style' to apply to a whole +document. I see two options for doing this -

+
    +
  1. Adding a new tab-panel 'Document Styles' to File>Properties.

    +

    or

    +
  2. +
  3. Adding a new tab-panel 'Document Styles' to Format>Page. (Does + Page format only apply to the current section or the whole document ?)

    +
  4. +
+ +

This tab-panel would contain a 'Document Style' selection list which +include the supported styles eg APA, ASA, Chicago, MLA, German DIN, French +ISO, etc. {need to collect full list.}. Also we need provision for the users +to create their own styles. (See the list of BibTeX supported styles BibTeX supported styles.)

+ +

1.1. Document Style Options

+ +

Other options in the tab panel could be such things as -

+ + +

There would also need to be provision for options which are provided by +the selected style that the user can choose. Eg. The Chicago Style allows +selection of either in-text, footnote or endnotes, or a dual footnote +comments endnote citation scheme. Perhaps a 'Style Option' tab would handle +this.

+ +

The information associated with Document Style would include the following +methods for Bibliographic citation -

+ + +
+ Charles Dickens, A Tale of Two Cities. London: Penguin Books, + 2000.
+ ———. + Nicholas Nickelby. London: Penguin Classics, 1956.
+ ———. + Oliver Twist. New York, Random House,1965.

+
+ +

1.2. Other Style considerations

+ +

Page formating constraints (the MLA Manual specifies page margins (need to +check details)
+There may be particular requirements for Section, Chapter and Heading +styles.

+ +
+Top of Page
+ +

1.3. Conversion code

+ +

When a new 'Document Style' was selected there would need to be some +format conversion process that would be applied to an existing document. This +would change the citation style from the current to the new, the trickiest +ones to do would be 'author-date in-text' to footnote or endnote or visa +versa.

+ +

An Issue: In order to allow a user change citation methods it will be +necessary to consider how we treat the footnote entry. It seems to me there +are two options. Utilise the standard footnote entry code, or to have a +special citation footnote.

+ +

2. Revert to declared style

+ +

Is there a 'revert to declared style' function in OpenOffice ? In MS Word +there is a function that resets text to the declared format. It removes all +user made minor adjustments with fonts, margins etc. This facility is +probably required to make the above work and very useful in it own right.

+ +

3. And symbols to the automatic footnote numbering +scheme.

+ +

The Chicago Manual of Style stipulates that when Endnotes and Footnotes +are both used the Endnotes are consecutively numbered (1,2,3 ...) and for the +Footnotes symbols are to be used. The series they suggest are -

+ + + + + + + + + + + + + +
a list of symbols like # * ect.
As more symbols are needed they are doubled and trebled -
a list of symbols like ## ** ### *** ect.
+
+The proposal is to add this set of symbols to the automatic numbering options +for footnotes. + +

The processing of the footnotes will need to be adjusted for symbols, as +the symbol sequence is restarted at the initial symbol ( * ), for each new +page they are use on.

+ +

4. Provide Support for Footnote Citation Styles by +Adapting the Field Editor for the Bibliography Tables.

+The current Insert>Indexes and Tables>'Bibliographic Entry' mechanism +[screen image] which is use to select +fields and format Tables [including the bibliographic table] should be +extended to enable defining footnote citation fields. Currently Bibliographic +Entry has only two options available - selection from bibliographic database +or document content. Then there is the selection box for the 'short name'; +which is the reference string to be inserted with the text, eg. +[CharlesE1978]. This mechanism needs to be extended to the footnote or +endnote method. These methods require this information in a more complex +format in a footnote or endnote; for example34,
+ + +
+ 34. T.M. Charles-Edwards,"Honour and status in Some Irish and Welsh + Prose Tales.",Eriu, xxxvi, 1978.
+ +

The Bibliographic Entry selection box should be changed from 'short name' +to 'citation type' - Book, Article, Journal Article, Collection etc. A new +button 'Customise Citation Styles' would bring up a new field selection and +formating panel very similar (maybe identical) to the table format editor. +Note that the Citation Style and style options will have been set in the new +File>Properties tab-panel 'Document Styles' mentioned above at section 1. +Also the 'Customise Citation Styles' button would be inoperative and greyed +out if 'Strictly Enforce Style' is set to 'Yes', so as not mess up the style +settings.

+ +

Note: when the citation formats are defined and provided for the various +Document Style Conventions the average user will not have to use this. All +the fields will be predefined.

+ +
+Top of Page
+ +

5. Modify the ‘Bibliographic Entry>Edit’ +Panel to support appropriate field entry options for the citation type +selected.

+ +

Currently the Insert>Indexes and Tables>Bibliographic +Entry>Edit>New Panel [screen +image] offers a selection box that allows the user to selection citation +type from a pick list eg Book, Article, Manual, Incollection etc. And is +presented with a selection of 29 fields in which to place their data. The +preferred action would be that the selection of a citation type would +indicate which fields are Required, Optional, or Ignored for that citation +type. See a screen-print of sixpack as an example of such an editor .

+ +

The list of citation types and fields that are used in BibTeX are given +below and should be considered as a minimum requirement.

+
+
article - An article from a journal or magazine. + Required fields: author, title, journal, + year. Optional fields: volume, number, + pages , month, note.
+
Book - A book with an explicit publisher. Required + fields: author or editor, title, + publisher , year. Optional fields: volume or + number , series, address, edition, + month , note .
+
Booklet - A work that is printed and bound, but + without a named publisher or sponsoring institution. Required field: + title. Optional fields: author, howpublished + , address, month, year, note.
+
Conference - The same as INPROCEEDINGS , + included for Scribe compatibility.
+
Inbook - A part of a book, which may be a chapter + (or section or whatever) and/or a range of pages. Required fields: + author or editor, title, chapter + and/or pages, publisher, year . Optional + fields: volume or number, series, + type , address, edition, month, + note.
+ Incollection - A part of a book having its own title. + Required fields: author, title, booktitle, + publisher, year. Optional fields: editor, + volume or number, series, type, + chapter , pages, address, edition, + month , note.
+ Inproceedings - An article in a conference + proceedings. Required fields: author, title, + booktitle, year. Optional fields: editor, + volume or number, series, + pages,address, month , + organization, publisher, note .
+ Manual - Technical documentation. Required field: + title. Optional fields: author, + organization, address, edition, + month, year, note.
+ Mastersthesis - A Master's thesis. Required fields: + author, title, school, year . + Optional fields: type, address, month, + note .
+ Misc - Use this type when nothing else fits. Required + fields: none. Optional fields: author, title, + howpublished, month, year, note.
+ Phdthesis - A PhD thesis. Required fields: + author, title, school, year . + Optional fields: type, address, month, + note.
+ Proceedings - The proceedings of a conference. + Required fields: title, year. Optional fields: + editor, volume or number, series, + address , month, organization, + publisher, note.
+ Techreport - A report published by a school or other + institution, usually numbered within a series. Required fields: + author, title, institution, year. + Optional fields: type, number, address , + month, note.
+ Unpublished - A document having an author and title, + but not formally published. Required fields: author, + title, note. Optional fields: month, + year.
+
+ +

The full text with field definitions and usage +hints.

+ +
+Top of Page
+ +

6. Defining citations and references different treatment +maybe needed for first and subsequent use of the citation.

+ +

There is a tedious and fault prone aspects of the footnote / endnote +citation method - the maintenance the Initial and Subsequent citations in the +correct order as one edits the text. In the mad rush to complete the paper as +the deadline approaches, a piece of text is moved and the Initial Citation +reference now comes after the Subsequent reference, and the examiner gives +you a red mark.

+ +

I do not know enough about the internals of OpenOffice to suggest how this +would be implemented. Two options would be to include a check after +bibliographic entry or to check and adjust when the update fields function is +activated. This would require the citation field to have an identifier which +signified that a citation's initial and subsequent appearances were related +to the same reference in order to check if the current Initial citation is +still the initial one after some text editing. That is not using string +matching but reference identifiers.

+ +

This also requires that with style that require it all of the citation +formats will have two versions; the full initial one and the shorter +subsequent one.

+ +

Example. An Initial Reference -

+ +
+ 'Oisin and Patrick' in Irish Myths and Legends, Lady Gregory. + (London: Running Press, 1989), 412-421.
+ +

A Subsequent Reference -

+ +
+ 'Oisin and Patrick' in Irish Myths and Legends, +450.
+or just - + +
+ 'Oisin and Patrick', 25.
+ +

6.1. Some Implementation Issues

+ +

In order to allow a user change citation methods it will be necessary to +consider how we treat the footnote / endnote entry. It seems to me there are +two options. Utilise the standard footnote / endnote entry code, or to have a +special citation footnote.

+ +

I will give some examples. A document has in-text author-date citations. +This is what is currently implemented. eg.

+ +
+ The story of Finn (Gregory1989) is central to our +argument./
+ +

We now change the citation setting to footnote method and it deletes the +In-text field, creates a footnote and places the citation field into the +footnote.

+ +
+ The story of Finn1 is central to our argument.
+
-----
+ 1. Lady Gregory,Irish Myths and Legends ,. (London: Running + Press, 1989)
+ +

This seems simple enough. But what happens if we are starting with the +footnote / endnote style, and change to the in-text style. Will it be just as +simple a matter to find all the bibliographic entries, go to the footnote / +endnote reference, delete the footnote / endnote and insert a new in-text +author-date citations? What do we do if the user has added extra text into +citation footnote / endnote ? -

+ +
+ 1. Lady Gregory ,Irish Myths and Legends,. (London: Running + Press, 1989) Note that this was originally published in +1903.
+ +

Do we than leave the footnote / endnote with just the added text? And +deleted if there was no added text ?

+ +
+ The story of Finn (Gregory1989) 1 is central to our + argument. eg.
+ -----

+ 1. Note that this was originally published in +1903.
+As more symbols are needed they are doubled and trebled - The proposal is to +add this set of symbols to the automatic numbering options for footnotes. + +

Would it help to have a special field for footnote / endnote or citations, +and if we did how do we deal with added comments? A user writable text area +with the citation field ?

+ +
+Top of Page
+ +

6.2 The inset citation dialog will need to support types of citations +within a citation style.

+ +

This will be required in order to support the following type of citation +system -

+ +

If I quote a document(book/journal/article etc.) without a page it looks +like

+ +

"This method is very reliable (AUTHOR YEAR)"
+f.e. "This method is very reliable (BASLER 2003)
+or
+"But AUTHOR (YEAR) showed that..."
+f.e. "But WILSON(2002) showed that this method is not very reliable."
+If a page or some pages are quoted (direct or indirect) it must look like
+"'This method is very reliable' (AUTHOR YEAR:12)"
+f.e. "'This method is very reliable' (BASLER 2003:12)"
+or
+"'This method is very reliable' (BASLER 2003:12 ff.)"
+or
+"AUTHOR (YEAR:12) stated 'This method is very reliable.'"
+f.e. "BASLER (2003:12) stated 'This method is very reliable.'"
+or
+"BASLER (2003:12 f.) concludes that this method is very reliable.'"

+ +


+Some comments on that:
+1. The AUTHOR(s) must be in small capitals (as every person everywhere in the +text).
+2. One author: "AUTHOR 2003" Two authors: "AUTHOR1 & AUTHOR2 2003" Three +or more: "AUTHOR1 ET AL. 2003"

+ +

If there are more than one publication of an author in the same year it +must look like:
+"BASLER 2003a" and "BASLER 2003b" a.s.o.
+In the bibliography the above example would look like
+BASLER, M. (YEAR): Book title. City1 et al.
+or
+BASLER, M. & D. WILSON (YEAR): Book title. City1 et al. or BASLER, M. D., +WILSON, A. NONAME & B. NONAME (YEAR): Book title. City1 et al.

+ +

Note that in the bibliography index ALL authors including their initials +must be stated, in the text citations only the first, followed by "ET AL."

+ +
+Top of Page
+ +

7. There needs to be a mechanism for transferring the +internal Document Bibliographic entries to and from the database to allow +import and export from OpenOffice.

+ +

Currently if a users creates Bibliographic entries with the +Insert>Indexes and tables>Bibliographic Entry>New function, these +entries can not be easily exported from the document.

+ +

As the first priority there needs to be an export and import of +bibliographic data in the BibTeX format. As this is the most common format +and the one most other bibliographic tools will utilise.

+ +

8. Some of the Bibliographic Database fields need to be +increased in length.

+ +

Some users have run into the field length limit of the varchar datatype +(or of the Input form). At least Title and Authors, and possibly some others +should be made longvarchar. Currently if the user changes the field +definitions in the database the bibliographic functions - Bibliographic +Entry, and Bibliographic Table cease to work on the altered table. Some +journal articles have hundreds of authors !

+ +

9. Should we persist with the DBASE Bibliographic +Database?

+ +

Or, to replace it with storage in BibTeX format and utilise other +OpenSource (eg. sixpack or pybliographer) work (code or design) for a BibTeX +editor and browser. We should also check the OpenOffice Database project for +their view and plans.

+ +

10. It would be nice to have search capability to +Internet Bibliographic Database

+ +

P.S from an Institute of Biochemistry requested the ability to connect and +query on-line databases (like Medline), or at least import records from saved +queries. He wrote - "PubMed for example would allow your browser to save the +queries in several formats that are easy to import."

+ +
+

Top of Page

+
+
+ +

By David N. Wilson

+ + Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/detailed enhacement proposals.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/bibliographic/detailed.pdf URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/detailed.pdf?rev=1175536&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/detailed.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf Added: incubator/ooo/ooo-site/trunk/content/bibliographic/developer.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/developer.html?rev=1175536&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/bibliographic/developer.html (added) +++ incubator/ooo/ooo-site/trunk/content/bibliographic/developer.html Sun Sep 25 19:38:58 2011 @@ -0,0 +1,30 @@ + + + + + + + + + + +

Bibliographic Project's Developer +Page

+ + + + + + + + +
This page has been rolcated to a wiki page wiki.services.openoffice.org/wiki/Bibliographic_Project's_Developer_Page + +

+
+
+
+
+ + Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/developer.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/bibliographic/developer.pdf URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/developer.pdf?rev=1175536&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/developer.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf Added: incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.html?rev=1175536&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.html (added) +++ incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.html Sun Sep 25 19:38:58 2011 @@ -0,0 +1,468 @@ + + + + + + + + + + +

Bibliographic Project's Developer Page

+ + + + + + + + +
Last Modified 2005-December-9A printer friendly PDF version of + this page is available developer1.pdf + (36Kb)
+ +

Contents

+ + + +
+ +

Project Overview

+The Bibliographic Project (OOoBib) plans to enhance the bibliographic +functions of the OpenOffice.org Writer (wordprocessing) application to +achieve: +
    +
  1. Enhance bibliographic formatting to support: +

    a. complex features required of commonly used citation styles like APA + and Chicago.

    +

    b. automatically switching between potentially radically different + citation styles (ie. footnote to in-text).

    +
  2. +
  3. Enhance data model to support a broader range of reference types.
  4. +
  5. Add support for connection to remote database.
  6. +
+ +

Our current objective is to design and build OOoBib version 0.1, which +will contain the most basic functions for an usable bibligraphic facility +with the above features.

+ + + + + + + + +

1st Stage, Bibliographic + Facility Redevelopment

+

top of page

+
+ +

Summary

+ +

As our first step, we will implement the most simple changes to the OOo +core code (the API basic code, and UNO mappings, but not yet the user +interface code) necessary to implement basic support for:

+
    +
  1. Support saving and reading enhanced citation support in + OpenDocument
  2. +
  3. Ability to insert and display citations in OpenOffice Writer using the + new format. (Note this task does not include the GUI interface to insert + the citation in the new format, only the UNO interface to provide the + basic function.
  4. +
  5. Storage of document bibliographic data in the OOo document save package + and the code changes necessary to read and save that bibliographic + data.
  6. +
+ +

When these basic functions are built into OOo and are made assessable via +the UNO, we can then use rapid prototyping development methods to design and +build prototype GUI interfaces and bibliographic formatting engines. We will +be able to use any of the programming languages which have OpenOffice +bindings: C++, Java, Python and, of course, OpenOffice Basic. We believe that +we will find more developers who can work in these languages than by +insisting on C++ code from the start. Also it is much easier to build +prototypes using Java, Python and OpenOffice Basic than in C++.

+ +

NB. When we have designed, built and tested the +prototypes and they have been accepted by the OOo community we intend to +rebuild them in C++ and to have them made part of the core OpenOffice +application.

+
+ +

Skills required - good C++ programming and some XML +skills with knowledge of, or willingness to learn, the OpenOffice UNO (see +the Openoffice +Developer's Guide)

+
+ +

1. Modify the Writer document-read and document-save modules to support +the new OpenDocument enhanced citation format.

+ +

Implement the citation and bibliography changes to the OOo Writer save +file (in Open Document format) accepted by the OpenDocument +Technical Committee. The changes to the document schema are detailed in +our OpenDocument +XML Citation Proposal.pdf

+ +

Here are two examples of the new citation format. The first is a standard +author-year style, with additional page number details:

+ +

<cite:citation +xmlns:cite="http://purl.org/NET/xbiblio/cite/1.0"
+ +xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0">
+ <cite:citation-source>
+ <cite:biblioref cite:key="Veer1996a">
+ <cite:detail cite:units="pages" cite:begin="23" +cite:end="24"/>
+</cite:biblioref>
+</cite:citation-source>
+<cite:citation-body>
+ <text:span text:style-name="Citation">(Veer, +1996:23-24)</text:span>
+</cite:citation-body>
+</cite:citation>

+ +

The second is a footnoted example.

+ +

<cite:citation +xmlns:cite="http://purl.org/NET/xbiblio/cite/1.0"
+ +xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0">
+ <cite:citation-source>
+ <cite:biblioref cite:key="Veer1996a"/>
+ </cite:citation-source>
+ <cite:citation-body>
+ <text:note text:id="ftn0" text:note-class="footnote">
+ <text:note-citation>1</text:note-citation>
+ <text:note-body>
+ <text:p text:style-name="Footnote">Peter van der Veer +(1996)
+Riots and Rituals: The Construction of Violence and Public +Space in HindUNationalism, In Paul Brass Ed., Riots +and Pogroms (New York:NYU Press) 154–76.</text:p>
+ </text:note-body>
+ </text:note>
+ </cite:citation-body>
+</cite:citation>

+ +

To compare this to the current format see implementation. The changes to the document +schema need to be supported by the document save and load modules. These are +detailed into the Further References below.

+ +

2. Modify the writer code to insert and display the new format +citations

+ +

The bibliographic modules in OOo Writer need to modified to support the +new schema. The modules that need to be modified are

+ + +

3. Add support in the OOo save file package for storage of document +bibliographic data.

+ +

Currently the Writer saves a complete copy of the bibliographic data +associated with a citation, with each ciation. We propose to separate the +citation and the bibliographic data, by leaving just the citation details in +the document save file and place the detailed bibliographic data in a +seperate bibliographic data file the OOo save file package.

+ +

The task is to complete the design of the bibliographic data file and add +support for it in the OOo save file package.

+ +

4. Modify the Writer save-file read and save modules to support +the new the bibliographic data file in the document save +package.

+ +

The relevant component is "interface +XComponentLoader" which supports loadComponentFromURL and +storeAsURL.

+ +

5. Refine and Improve the CITEPROC bibliographic formating engine.

+ +

Experience XSLT programers are needed to work on this core component of +the Bibliographic facility. It is functioning and a book has been published +which used it to format the bibliographic table and citations.

+ +

We propose to build Bibliographic table and citation formating using XSLT +style-sheets with a process called CiteProc. +Also see BiblioX +for technical discusion of this approach.

+
+ + + + + + + + +

2nd Stage, Bibliographic + Facility Redevelopment

+

top of page

+
+ +

1. Add Backwards and Forwards Compatability Logic to Writer

+ +

An important object of Bibliographic Enhancement project is to maintain +document file backwards compatibility with older versions of OpenOffice. To +achieve this when Bibliographic Entries are inserted into a Document they are +stored with the same format as is currently the case. A new bibliographic +entry tag will be will be added with the enhanced citation functions, each +citation will contain a key that will point to the bibliographic data which +will be saved in the document save package. To preserve backwards +compatability we will need to also maintain the old bibliographic ciation and +dtat storage in the document. Older version of OpenOffice, without the +bibliographic enhacments, in the OOo 2.X .ods format, will read the old +format of the bibliographic citations and ignore the bibliographic data file +in the save package. A suggested approach is illustrated in this flowchart.

+ +

When a major revision of the save package format is introduced the support +of the older bibliographic representations can be dropped form the document +save file.

+ +

2. Add Z39.50 and SRU/W support for the Bibliographic modules.

+ +

Build Z39.50 and SRU/W based internet searching facility using +the YAZ toolkit. This would enable +searching for and retrieving bibliographic data from internet sources and +storing them in a document or bibliographic database.

+ +

Also build Z39.50 and SRU/W server capability into OOo to enable users to +share their bibliographic (and other) databases over the internet. One of the +Indexdata toolkits could probably used +as a basis.

+ +

The modules that may need to be modified are:

+ + +

NB: We are considering using SWU/W as the standard method +for OOo retrieving bibliographic data from any source. So that even a local +Bibliographic database would also be accessed through SWU/W methods. The user +would just select a local or remote source and the same access mechanism +would be used.

+ +

3. Design and Build a basic Graphical User Interface (GUI). To provide +-

+ + + + + + + + + +

+ +

Further References

+ +

For an overview of the Bibliographic project's major components + and a context diagram see components.html. There is information + about the current OpenOffice Bibliographic implementation.

+ +

A start has been made to the Specification for this work (see the + + Projects Specifications folder on the Documents and Files page). + Also see a attempt at an analysis of the proposed + Bibliographic enhancement components and their relationships.

+ +

The best place to start for finding out about development in + OpenOffice is the OpenOffice.org + For Developers page. An important resource is the Developer's + guide which is part of the SDK (software development kit) or + available online on at http://api.openoffice.org/DevelopersGuide/DevelopersGuide.html

+ +

The OOo API is based on UNO (Universal Network Objects) + is the interface-based component model of OpenOffice.org. UNO offers + interpretability between different programming languages, different + object models, different machine architectures and different + processes; either in a local network or even via the Internet. UNO + components can be implemented in and accessed from any programming + language for which a UNO language binding exists. We currently + provide several language bindings for UNO which allows to use the API + from Java, C++, OpenOffice.org Basic, Python and Common Language + Infrastructure (CLI).

+ +

Implementing the new citation element in xmloff (the + XmlOffice module) is a routine task. The Sun developers want to do it + together with our programmer, so that he/she can learn how + xmloff works.

+ +

To modify the Writer save-file read and save modules to support + the new the bibliographic data file in the document save package, and + to support backwards and forwards + compatability logic to Writer the "interface + XComponentLoader", which supports loadComponentFromURL + and storeAsURL, needs to be enhanced. See the Development Guide + explanation for - 6.1.5 + Handling Documents.

+ +

There is also a demonstration client program for the YAZ toolkit (C & C++). - + IRTCL that can perform + the reference searches. (Requires YAZ and Tcl/Tk libraries be + installed). It does everything but save or export the results ! + However it is good model of how to use the toolkit and could be used + as the basis for or model of a prototype internet searching facility. + Screen + pic, screen pic2.

+ +

A demonstration internet searching facility that writes selected + bibliographic records back to the OOo bibliographic database has been + written in Python - PyOOBib, + instructions + are available. Various problems with OOo Python have lead to us + concluding that YAZ in C++ would be a better foundation than the + Python code.

+ +

There is description of the + OOo save-file XML Package, and is a FAQ about it.

+
top of page
+
+ + + + + + + + +

How to get started

+

top of page

+
+ +

Access to the source code for this project is available for download via +CVS. A child work space has been created for us called "metabib" which +contains a copy of the xmloff +(OpenOffice.org XML File Format Definition) and sw (the word processor +application component and the WYSIWYG HTML editor component) code.

+ +

The down load size will be about 1GB(?). And you will need about 2GB of +disk space to compile the metabib CWS (Child-Work-Space). ( Web +access to CWS ). If you can not handle that size download then ask us +about sending it to you on cdroms.

+ +

Administration process - you first need to sign the JCA and then obtain +the ssh key. After that we will show you how you can access the 'CWS'. It's +basically a CVS branch. The most complicated thing is the setup of your +tools, such that you can participate in the OOo development --- but, when you +have got the ssh key we will show you.

+ +

See OpenOffice.org +For Developers for general development information.

+
+ + + + + + + + +

Sample Code

+
top of page
+ + +

Contacts

+ +

Question or comments can be put to the Bibliographic Project development +list dev@bibliographic.openoffice.org +or to the project co-leader David +Wilson.

+
+ + Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.pdf URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.pdf?rev=1175536&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/developer1.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf Added: incubator/ooo/ooo-site/trunk/content/bibliographic/enhanced-save-package-description.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/enhanced-save-package-description.html?rev=1175536&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/bibliographic/enhanced-save-package-description.html (added) +++ incubator/ooo/ooo-site/trunk/content/bibliographic/enhanced-save-package-description.html Sun Sep 25 19:38:58 2011 @@ -0,0 +1,486 @@ + + + + + + + + + + + + + +

Current and +Proposed Bibliographic enhancements to the contents of the writer save +package

+ + + + + + + + + + + + + + + + + + + + + + + + +

Current Writer save file contents.xml example

+

Proposed Writer save file contents.xml example

+
Document Header Stuff
+
+<?xml version="1.0" encoding="UTF-8"?>
+<office:document-content xmlns:office=
+"urn:oasis:names:tc:opendocument:xmlns:office:1.0
+" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0
+" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0
+" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0
+" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0
+" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0
+" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc=
+"http://purl.org/dc/elements/1.1/" 
+xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" 
+
+xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0
+" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0
+" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0
+" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0
+" xmlns:math="http://www.w3.org/1998/Math/MathML
+" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0
+" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0
+" xmlns:ooo="http://openoffice.org/2004/office" xmlns:ooow=
+"http://openoffice.org/2004/writer" xmlns:oooc=
+"http://openoffice.org/2004/calc" xmlns:dom=
+"http://www.w3.org/2001/xml-events" xmlns:xforms=
+"http://www.w3.org/2002/xforms" xmlns:xsd=
+"http://www.w3.org/2001/XMLSchema" xmlns:xsi=
+
+"http://www.w3.org/2001/XMLSchema-instance" office:version="1.0">
+<office:scripts/>
+<office:font-face-decls>
+<style:font-face style:name="Tahoma1" svg:font-family="Tahoma"/>
+<style:font-face style:name=
+"Gothic" svg:font-family="Gothic" style:font-pitch="variable"/>
+<style:font-face style:name=
+"Mincho" svg:font-family="Mincho" style:font-pitch="variable"/>
+<style:font-face style:name=
+"Tahoma" svg:font-family="Tahoma" style:font-pitch="variable"/>
+<style:font-face style:name=
+"Times New Roman" svg:font-family=
+"&apos;Times New Roman&apos;" style:font-family-generic="roman" 
+style:font-pitch="variable"/>
+<style:font-face style:name="Arial" svg:font-family="Arial"
+ style:font-family-generic="swiss" style:font-pitch="variable"/>
+</office:font-face-decls>
+<office:automatic-styles>
+<style:style style:name="P1" style:family="paragraph" 
+style:parent-style-name="Bibliography_20_1">
+<style:paragraph-properties>
+<style:tab-stops/>
+</style:paragraph-properties>
+</style:style>
+<style:style style:name="Sect1" style:family="section">
+<style:section-properties style:editable="false">
+<style:columns fo:column-count="0" fo:column-gap="0cm"/>
+</style:section-properties>
+</style:style>
+</office:automatic-styles>
+<office:body>
+<office:text>
+<text:sequence-decls>
+<text:sequence-decl text:display-outline-level="0" text:name="Illustration"/>
+<text:sequence-decl text:display-outline-level="0" text:name="Table"/>
+<text:sequence-decl text:display-outline-level="0" text:name="Text"/>
+<text:sequence-decl text:display-outline-level="0" text:name="Drawing"/>
+</text:sequence-decls>
+
Document Header Stuff
+ +


+
+

+ +

The same with added-

+ +


+
+

+ +


+
+

+
<style:Biblio biblio-style:name=
+"APA-en" 
+biblio-style-type=”intext-author-date”/>
+ +

The document style, selected by the user to determine the + style
+ sheet used to format the citations and bibliographic + table.

+ +

Biblio-style-types could be

+
    +
  • intext-author-date

    +
  • +
  • number

    +
  • +
  • footnote

    +
  • +
+
Document Text Contents 
+
+<text:p text:style-name="Standard">
+
+Sample document with a citation 
+
+<text:bibliography-mark text:identifier="Veer1996a" 
+text:bibliography-type="book" text:address="New York" 
+text:author="Peter van der Veer" text:booktitle="Riots and Pogroms" 
+text:editor="Paul Brass" 
+text:pages="154-76" 
+text:publisher="NYU Press" 
+text:title="The Construction of Violence and Public Space in 
+Hindu Nationalism" 
+text:year="1996" 
+text:isbn="1223213123">
+
+[Veer1996a]
+
+</text:bibliography-mark> 
+
+and a bibliographic table.
+
+</text:p>
+ +


+

+
<text:p text:style-name="Standard"/>
+        
+ +

Note: that the bibliographic reference data is copied in for + each citation. The only way to to change or correct this data is to + fix the data in the database and delete and re-insert the + citation.

+
Document Text Contents 
+
+<text:p text:style-name="Standard">
+
+Sample document with a citation 
+
+<text:bibliography-mark text:id="bib3">
+        
+<cite:citation> 
+<cite:citation-source>
+<cite:biblioref cite:key="Veer1996a">
+<cite:detail cite:units="pages" cite:begin="23" cite:end="24"/>
+</cite:biblioref> 
+</cite:citation-source>
+<text:citation-body text:style-name="citation">
+(Veer, 1996:23-24)
+</text:citation-body>
+
+</cite:citation>
+</text:bibliography-mark>
+
+and a bibliographic table.
+
+</text:p>
+ +


+

+
<text:p text:style-name="Standard"/>
+ +

Note: The bibliographic reference data is not included with + the citation.
+ It is contained a bibliographic data file, and access by the key + “Veer1996a”
+ See bottom of document for an example.

+ +


+

+
Bibliographic Table 
+
+<text:bibliography text:style-name="Sect1" 
+text:protected="true" 
+text:name="Bibliography1">
+<text:bibliography-source>
+
+Format description for each document type supported in the table.
+Only “book” has been changed from the default.
+
+<text:index-title-template text:style-name=
+"Bibliography_20_Heading">Bibliography</text:index-title-template>
+
+<text:bibliography-entry-template text:bibliography-type="article" 
+text:style-name="Bibliography_20_1">
+<text:index-entry-bibliography text:bibliography-data-field="author"/>
+<text:index-entry-bibliography text:bibliography-data-field="title"/>
+<text:index-entry-bibliography text:bibliography-data-field="year"/>
+</text:bibliography-entry-template>
+
+<text:bibliography-entry-template text:bibliography-type="book" 
+text:style-name="Bibliography_20_1">
+<text:index-entry-bibliography text:bibliography-data-field="author"/>
+<text:index-entry-span> (</text:index-entry-span>
+<text:index-entry-bibliography text:bibliography-data-field="year"/>
+<text:index-entry-span>)</text:index-entry-span>
+<text:index-entry-bibliography text:bibliography-data-field="title"/>
+<text:index-entry-span>, In</text:index-entry-span>
+<text:index-entry-bibliography text:bibliography-data-field="editor"/>
+<text:index-entry-span> Ed.,</text:index-entry-span>
+<text:index-entry-bibliography text:bibliography-data-field="booktitle"/>
+<text:index-entry-span> (</text:index-entry-span>
+<text:index-entry-bibliography text:bibliography-data-field="address"/>
+<text:index-entry-span>:</text:index-entry-span>
+<text:index-entry-bibliography text:bibliography-data-field="publisher"/>
+<text:index-entry-span>)</text:index-entry-span>
+<text:index-entry-bibliography text:bibliography-data-field="pages"/>
+</text:bibliography-entry-template>
+
+<text:bibliography-entry-template text:bibliography-type="booklet" 
+text:style-name="Bibliography_20_1">
+<text:index-entry-bibliography text:bibliography-data-field="author"/>
+<text:index-entry-bibliography text:bibliography-data-field="title"/>
+<text:index-entry-bibliography text:bibliography-data-field="year"/>
+</text:bibliography-entry-template>
+
+<text:bibliography-entry-template text:bibliography-type="conference"
+ text:style-name="Bibliography_20_1">
+<text:index-entry-bibliography text:bibliography-data-field="author"/>
+<text:index-entry-bibliography text:bibliography-data-field="title"/>
+<text:index-entry-bibliography text:bibliography-data-field="year"/>
+</text:bibliography-entry-template>
+ +


+
+

+ +


+
+

+ +

To save space I have deleted + the repetitive definitions for:

+
 
+custom1, custom2, custom3, custom4, custom5, email, inbook, incollection,
+ inproceedings, journal, manual, mastersthesis, misc, phdthesis,
+ proceedings,techreport, unpublished, www
+
+</text:bibliography-source>
+<text:index-body>
+<text:index-title text:style-name="Sect1" 
+text:name="Bibliography1_Head">
+<text:p text:style-name=
+"Bibliography_20_Heading">Bibliography
+</text:p>
+
+The Actual generated text of the bibliographic table
+
+</text:index-title>
+<text:p text:style-name="P1">
+Peter van der Veer (1996) The Construction of Violence and Public 
+Space in Hindu Nationalism, In Paul Brass Ed., Riots and Pogroms 
+(New York: NYU Press) 154-76
+</text:p>
+
+</text:index-body>
+</text:bibliography>
+
<text:bibliography 
+
+text:style-name="Sect1" 
+text:protected="true" 
+text:name="Bibliography1"
+
+>
+<text:bibliography-source>
+
+</text:index-title>
+<text:p text:style-name="P1">
+Peter van der Veer (1996) The Construction of Violence and Public Space 
in Hindu Nationalism, In Paul Brass Ed., Riots and Pogroms (New York: NYU Press) 154-76
+</text:p> + +</text:index-body> +</text:bibliography>
+ +

Note: the text is generated using the Citproc formatter,
+ using the csl style sheet selected by user in a document style
+ selection GUI and stored in the save package.

+
End Stuff 
+
+<text:p text:style-name="Standard"/>
+</office:text>
+</office:body>
+</office:document-content>
+

Same

+
+ +

+
+ + + + + + + + + + + + +

No current equivalent

+

Sample proposed bibliographic reference-data file + biblio-data.xml.

+


+
+

+ +


+

+

Note the Format of this file is not fixed yet.
+ This is just an example of a possible format.

+
<?xml version="1.0" encoding="utf-8"?>
+<?oxygen RNGSchema="file:/Users/darcusb/Projects/citeproc/schemas/
+mods-tight.rnc" type="compact"?>
+<modsCollection xmlns="http://www.loc.gov/mods/v3" 
+xmlns:xlink="http://www.w3.org/1999/xlink">
+
+<!-- mods sample data -->
+
+<mods ID="Veer1996a">
+<name type="personal">
+<namePart type="given">Peter</namePart>
+<namePart type="family">van der Veer</namePart>
+<role>
+<roleTerm authority="marcrelator" type="text">author</roleTerm>
+</role>
+</name>
+<titleInfo>
+<title>Riots and Rituals</title>
+<subTitle>The Construction of Violence and Public Space in Hindu
+ Nationalism</subTitle>
+</titleInfo>
+<genre>chapter</genre>
+<subject>
+<topic>riots</topic>
+<topic>public space</topic>
+<geographic>India</geographic>
+</subject>
+<relatedItem type="host" xlink:type="simple" xlink:href="BrassP1996a">
+<name type="personal">
+<namePart type="given">Paul</namePart>
+<namePart type="family">Brass</namePart>
+<role>
+<roleTerm type="text">editor</roleTerm>
+</role>
+</name>
+<titleInfo>
+<title>Riots and Pogroms</title>
+</titleInfo>
+<originInfo>
+<dateIssued encoding="w3cdtf">1996</dateIssued>
+<issuance>monographic</issuance>
+<publisher>NYU Press</publisher>
+<place>
+<placeTerm>New York</placeTerm>
+</place>
+</originInfo>
+<typeOfResource>text</typeOfResource>
+<genre>book</genre>
+<part>
+<extent unit="page">
+<start>154</start>
+<end>176</end>
+</extent>
+</part>
+</relatedItem>
+<recordInfo>
+<recordCreationDate encoding="w3cdtf">2004-01-24</recordCreationDate>
+<recordIdentifier source="citekey">Veer199a</recordIdentifier>
+</recordInfo>
+</mods>
+
+
+ + + + + + + + + + + + + + +

Current Manifest.xml

+

Proposed Manifest.xml

+
<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE manifest:manifest PUBLIC "-//OpenOffice.org
+//DTD Manifest 1.0//EN" "Manifest.dtd">
+<manifest:manifest xmlns:manifest=
+"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">
+ <manifest:file-entry manifest:media-type=
+"application/vnd.oasis.opendocument.text
+" manifest:full-path="/"/>
+ <manifest:file-entry manifest:media-type=
+"application/vnd.sun.xml.ui.configuration" 
+manifest:full-path="Configurations2/"/>
+ <manifest:file-entry manifest:media-type="" 
+manifest:full-path="Pictures/"/>
+ <manifest:file-entry manifest:media-type=
+"text/xml" manifest:full-path="content.xml"/>
+ <manifest:file-entry manifest:media-type=
+"text/xml" manifest:full-path="styles.xml"/>
+ <manifest:file-entry manifest:media-type=
+"text/xml" manifest:full-path="meta.xml"/>
+ <manifest:file-entry manifest:media-type="" 
+manifest:full-path="Thumbnails/thumbnail.png"/>
+ <manifest:file-entry manifest:media-type="" 
+manifest:full-path="Thumbnails/"/>
+ <manifest:file-entry manifest:media-type=
+"text/xml" manifest:full-path="settings.xml"/>
+</manifest:manifest>
+

The same with the bibliographic reference data + locator

+ +


+
+

+
<manifest:file-entry manifest:full-path=
"bibliographic/data/biblio-data.xml"/>
+ +

and the style sheet locator

+
<manifest:file-entry manifest:full-path=
"bibliographic/styles/APA-en.csl"/>
+
+ +


+
+

+ + Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/enhanced-save-package-description.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/bibliographic/equation.png URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/equation.png?rev=1175536&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/equation.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/ooo/ooo-site/trunk/content/bibliographic/er-relationships.gif URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/er-relationships.gif?rev=1175536&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/er-relationships.gif ------------------------------------------------------------------------------ svn:mime-type = image/gif Added: incubator/ooo/ooo-site/trunk/content/bibliographic/frfbs-er1.png URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/frfbs-er1.png?rev=1175536&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/frfbs-er1.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/ooo/ooo-site/trunk/content/bibliographic/frfbs-er2.png URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/bibliographic/frfbs-er2.png?rev=1175536&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/ooo/ooo-site/trunk/content/bibliographic/frfbs-er2.png ------------------------------------------------------------------------------ svn:mime-type = image/png