There are two ways to interact with OpenOffice.org, either through
interface integrated in the
writer or through Bibus
You can use both depending on your needs and the two methods are
perfectly compatible. For instance you can use the classical
interface if you are working on a computer on which Bibus is not
installed and continue on another computer with Bibus. You must
however always use the same bibliographic database (MySQL or
OpenOffice.org writer has an integrated bibliographic database and index. In order to be compatible, Bibus use this infrastructure but try to improve it when possible:
OpenOffice.org features used by Bibus. The bibliographic index is generated by OpenOffice.org. For the moment, the look of the index has to be defined using the OpenOffice.org 'Insertion/Index/Index' menu. Here you can define whether the bibliography should use numbering or citation keys and how the references should be formated. One missing feature is how to format the Fields themself. For instance, authors in the database are entered as a ';' separated list of authors but this is not the format required by most journal. Bibus allows you to reformat all the fields in order to suit your needs.
OpenOffice.org features not used by Bibus. The bibliographic database used OpenOffice.org is simply a dBase database. This is not well suited for multi-user support. In addition this is a flat file and you cannot associate references with keys as in Bibus. For large bibliographic databases it can be difficult to find the correct reference. In addition, there is no 'Abstract' field. This has been added in Bibus. In Bibus, the Fields are 255 character long (except the Abstract which may contain 65535 characters since it is a MySQL TEXT type. If you need it, you can change it to MEDIUMTEXT or LONGTEXT) in MySQL and not limited (in theory) in SQLite. We will describe first how you can substitute the OpenOffice.org database with the Bibus one then we will describe the OpenOffice.org interface integrated in Bibus.
In order to make OpenOffice.org able to talk with MySQL and SQLite you must either use ODBC or JDBC. I will quickly describe how to use ODBC since I never tried with JDBC. You can have a look at installation.txt. If you speak French you can find many nice documents that explain everything at <http://fr.openoffice.org/Documentation/How-to/indexht.html>. There are other links available on the OpenOffice.org site.
You must first declare your ODBC source. I don't know how to do that
under Windows, but I suppose there is a GUI tool. Under linux you must
edit 2 files:
Now, in OpenOffice.org:
Menu : Tools/Data Sources ...
On the left, click in "New Data Source"
Give a name (Biblio for instance)
Select ODBC in Database Type (You can also select MySQL if you use this database)
Click on ... for 'Data source URL' and select the database which should appear in the list if you correctly configured ODBC
Click in the ODBC Tab
Enter User Name, password required if necessary, Unicode (UTF-8)
Click on Tables Tab
A pop up dialog should ask you about your password. Give it. The tables should be displayed.
Close the window
Menu Tools/Bibliography Database
Menu Edit/Choose Data Source
In the listBox, choose your database (Biblio)
OpenOffice.org may complain about some column names. Click No for the moment.
Select the correct table in the Table menu in the tool bar. If you use the database supplied with Bibus, it should be Biblio.bibref
OpenOffice.org may complain again about some column names. Note carefully the name of the fields that was not recognized (usually, 'Type' and 'Type of Report') and click in Yes.
Choose the correct fields. With some OpenOffice.org version, if you choose other fields that the ones asked at the previous step, the program will crash. However it seems not to be the case anymore with 1.1.1.
The name of the fields in Bibus are easy to understand. There is a ScreenShot below that shows the dialog with all the fields name filled.
Now you can insert citations in OpenOffice.org using the normal menu and you don't need to have Bibus running.
Menu : Insert/Indexes and Tables/Bibliography Entry ... Have a look at the OpenOffice.org Help for how to insert citation and generate a bibliographic index.
On the screenshot below you can see
OpenOffice.org running side by side with Bibus. The Bibus
OpenOffice.org menu is also displayed. The citation key used is the
Identifier that appears in Bibus. It is very readable since it
contains the name of the first author followed by the year.
In order for Bibus to communicate with OpenOffice.org, OpenOffice.org must be listening for TCP/IP connection.
Since Bibus 0.8.1 you can either use TCP/IP connection or named pipe to communicate with OpenOffice.org.
If the OpenOffice.org and Bibus are on the same machine I would recommend to use a named pipe since it is much faster and more secure. The advantage of the TCP/IP connection is that it is network transparent and should work if Bibus and OpenOffice.org are run from different machines.
Under Windows98 it is highly recommended to use a named pipe since TCP/IP connection is very slow (to establish the connection takes about 20 s, but after that it will be faster and may be usable if you really need TCP/IP).
There are several ways to accomplish that.
You can read "Make the office listen" at <http://api.openoffice.org/docs/DevelopersGuide/FirstSteps/FirstSteps.htm>
By default, Bibus use the port 8100. You can change this by choosing the menu OpenOffice.org/Settings...
For security reasons, don't forget to use a firewall and to block any connection to this port coming from the outside world.
Since Bibus 1.1.0, there is a OOo macro that help you to activate this connection. In the FirstStart Wizard, there is a button to activate the connection. You can also directly open the document "UnoConnectionListener.sxd" located in $BIBUS/Setup/ in OOo. The document will look like:
Just click the "Accept UNO connections" button, quit OOo (including
the quickstarted) and reload it. Normally bibus should now be able to
insert citations in OOo. If in the OOo macro, you change the pipe name
or if you select Socket, you will need to go to the bibus
OpenOffice.org menu, choose "Settings..." and put the correct values.
Using the Bibus interface to insert citation is much easier than
using OpenOffice.org interface. Indeed when using OpenOffice.org, you
must find your citation in a flat list which may be very long. By
Using Bibus, you just have to select your citation(s) and insert them
directly at the cursor location. Further explanation shouldnt be
necessary: just give it a try.
The only important point is that before insertion, the reference goes through the style filter. This means that the fields won't appear as in the database but will be reformatted. This is an important feature of Bibus and a strong improvement over OpenOffice.org.
When you choose this menu Bibus makes two things:
First, it goes through the document looking for bibliographic citations. When it finds a citation, it looks it up in the database. If it is not in the database it does nothing. If it is in the database, it reformats the citation according to the current style. This is very important to understand this because it means that:
If you changed a reference in the database, the change will be automatically inserted in your document.
You can reformat the bibliography by selecting a new style in the 'Format Bibliography' menu.
It updates the bibliographic index according to the settings defined in OpenOffice.org 'Insertion/Index/Index' menu.
How does Bibus recognizes a citation? For instance in the displayed ScreenShot, the Identifier of the inserted citation is Martineau1999#12. Bibus simply looks in the database for the record with Identifier=Martineau1999#12 and inserts it. Of course, this means that you must not change the database or Bibus will get confused and you will get the wrong reference inserted. Now if you want Bibus to not reformat a citation in your text, simply remove, for instance, the # character and Bibus will ignore the citation (But of course OpenOffice.org will still include it in the bibliographic index).
The styles functionality is still not complete but have been
strongly improved in Bibus 0.9.
You can now:
Format all the fields
Choose how the index is displayed (sorting, etc...)
Define how each reference must look in the index.
Save all these settings for later use.
All this is easily accomplished with Bibus styles.
In the OpenOffice.org/Formating sub menu, there is a list of
available styles. There are also options for creating, editing or
loading styles from disk. The currently active style is displayed at
the right of the status bar of the Main
The list of styles is divided in two parts.
The first displayed styles are the default styles seen by all the users of Bibus. Those styles are located in the Format/Styles/ directory in the Bibus installation directory. If you create a style and want to make it available to all the users, just drop it in this directory (if you have write permission) and it will appear in the menu of Bibus (after restart). You cannot edit those styles. If you choose Edit, Bibus will do a copy of it in order to allow editing.
The second part of the list, after the separator under linux or just the end of the list under Windows, contains your personal styles. You are the only user with those styles in your menu (actually another user can share them if he has read access to them and load them using the load item). You can freely Edit those styles.
Creating or editing a new style is very easy. When you select New
the following 'Style editor' will pop up.
You start with a style corresponding to the 'default' style of the style menu. This is a fairly reasonable style and most of the time you just have to modify few settings.
In this first Tab "Style information", You can put any relevant informations concerning this style. It is a good idea to give an e-mail address where users can contact you and of course for which journal the style is intended.
The second Tab controls how the index is formated. The choices are
easy to understand and correspond to the available choices in
This Tab controls the filters that are applied to the record
fields before insertion in OpenOffice.org.
For instance, if you have a record with the corresponding authors:
Marx, Groucho; Marx, Harpo; Marx, Zippo; Marx, Zeppo; Marx, Gummo
you may want to format them as :
Marx G., Marx H., Marx Z., Marx Z., Marx G.
Marx G., Marx H., Marx Z., Marx Z. and Marx G.
On the left, there is a list of all the available reference types that OpenOffice.org knows about. The main type is of course ARTICLE and it is why we use it as the default type. If you click on any other type, for instance BOOK, you will see that all the choices are dimmed and that the first RadioBox says that for BOOK you must 'Format fields as in ARTICLE'.
When you want to define a new style:
format ARTICLE. In ARTICLE you can even format the fields which are not relevant for an ARTICLE like 'Booktitle' or 'Editors'. The most important part of this dialog is how authors and editors must be formated. To help you, there is a preview that shows the result of your choices as you type.
Choosing 'As in database' means that you don't want Bibus to format this field. The field will be directly copied from the database to OpenOffice.org.
At the top there is a checkbox 'use current language for month'. If you check it, month will use your current language, otherwise it will be in English. The month in the database must be either in you current language or in English in order for Bibus to recognize it. This feature is broken under linux when using the Python locale.py module included in OpenOffice.org (Python-2.2.2). In order to make it work, I included in the Bibus directory a copy of the Python locale.py module included in Debian Python-2.3.3. It works well on my machine. Please let me know if it does not work with your system. (on Windows and MacOS, you can eventually try to remove locale.py from the Bibus directory in order to use the normal locale module).
Select the types which are not correctly formated with the ARTICLE style and select at the top 'Format fields as below', then define the style as for ARTICLE.
You can use 'singular | plural' forms. In the displayed example, you can see that Bibus will add, after the editor list, either (Editor) or (Editors) depending on the number of editors.
You can abbreviate the author list, if needed (For instance PNAS requires the listing of only the first 10 authors). If you choose 6 for instance, authors 1 to 6 will be listed and the 7th and followings will be replaced by 'et al.' (or something else).
The last Tab controls how the fields are ordered and formatted. For instance you may want to format references as:
Authors. Title. Journal (Year) Volume: pages.
This can be done in this Tab.
Starting with Bibus pre1.0.0, there is a new tab called
In this tab, you can define the formatting of the citations in the text. This tab is a bit special because it contains features not supported by OpenOffice.org. The configuration option in this tab are used by the 'OpenOffice.org/Finalize' menu. Because it is a one-way formatting and because it is not possible to go back to the cancel these formatting, Bibus will use these setting on a copy of your current document.
Here is a short description:
Top: You can define here, the style of the citation. Bold, italic, subscript, etc...
Depending on the settings in the 'Bibliographic Index' tab, you will be also able to define either the formatting of the numbering or author-date:
For author-date, you must first define the template (for instance 'Author', 'Year'), then how Bibus should try to solve the duplicates. There are 3 possibilities:
- Bibus can add a letter after the year. This method will always generate unique citation markers.
- You can choose to add authors or to add their firstname. In some case this may not be possible to solve all the duplicates. Bibus will warn you if there are still some duplicates and you will have to edit them by hand.
- You can add a field. For instance, in APA style, you usually add the 'title' of the book after the author. Again, in some rare cases, it may not be enough to solve some duplicates. Again, Bibus will warn you if it is the case.
Read the OpenOffice.org help to understand how styles works in
Bibus uses paragraph and character styles to format the bibliography and the citations.
You can thus re-format easily the citations and/or the Bibliography.
After using the Finalize function, the citations uses the character style 'bibus_citation_base'. For instance, you can choose a yellow background for this style and all the text citations will be easy to localize in you text.
The Bibliography title uses the paragraph style "Bibliography
The Bibliography uses the paragraph style "Bibliography 1"
The References use the character style "bibus_base"