<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>usingOOo</title>
</head>
<body>
<ol id="mozToc">
<!--mozToc h1 1 h2 2 h3 3 h4 4 h5 5 h6 6--><li><a href="#mozTocId427546">Interacting
with
OpenOffice.org</a>
<ol>
<li><a href="#mozTocId871262">Using
the
regular OpenOffice.org interface </a></li>
<li><a href="#mozTocId714457">Using
Bibus
OpenOffice.org menu</a>
<ol>
<li><a href="#mozTocId40231">Make
OpenOffice.org Writer listen using TCP/IP</a></li>
<li><a href="#mozTocId241674">Inserting a citation</a></li>
<li><a href="#mozTocId650609">Formating the
bibliography</a></li>
<li><a href="#mozTocId283248">Styles</a>
<ol>
<li><a href="#mozTocId692072">Using styles</a></li>
<li><a href="#mozTocId645057">Creating a style</a></li>
</ol>
</li>
<li><a href="#mozTocId80946">Bibliographic index</a>
<ol>
<li><a href="#mozTocId961357">Fieds formatting</a></li>
<li><a href="#mozTocId515632">Fields ordering</a></li>
</ol>
</li>
<li><a href="#mozTocId673996">Citation</a></li>
<li><a href="#mozTocId441578">Further formatting</a>
<ol>
<li><a href="#mozTocId417025">Citation</a></li>
<li><a href="#mozTocId902020">Bibliography</a></li>
</ol>
</li>
</ol>
</li>
</ol>
</li>
</ol>
<h1><a class="mozTocH1" name="mozTocId427546"></a>Interacting
with
OpenOffice.org<br>
</h1>
<p>There are two ways to interact with OpenOffice.org, either through
the <a href="#OOo_regular">regular
interface</a> integrated in the
writer or through <a href="#OOo_menu">Bibus
OpenOffice.org menu</a>.
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
SQLite).<br>
<br>
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:</p>
<ul>
<li>
<p style="margin-bottom: 0cm;"><i>OpenOffice.org features used by
Bibus.</i> 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. </p>
</li>
<li>
<p><i>OpenOffice.org features not used by Bibus. </i>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 <a href="#OOo_regular">first</a>
how you can substitute the OpenOffice.org database with the Bibus one
then we will describe the <a href="#OOo_menu">OpenOffice.org
interface</a> integrated in Bibus.</p>
</li>
</ul>
<h2><a class="mozTocH2" name="mozTocId871262"></a><a name="OOo_regular"></a>Using
the
regular OpenOffice.org interface </h2>
<span style="font-weight: bold;"></span>
<p>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
<a href="../../installation.txt">installation.txt</a>. If you speak
French you can find many nice documents that explain everything at <<a
href="http://fr.openoffice.org/Documentation/How-to/indexht.html">http://fr.openoffice.org/Documentation/How-to/indexht.html</a>>.
There are other links available on the <a
href="http://www.openoffice.org/">OpenOffice.org</a>
site.</p>
<p>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:<br>
</p>
<ul>
<li>/etc/odbcinst.ini</li>
<li>~/.odbc.ini</li>
</ul>
You can have a look at the end of <a href="../../installation.txt">installation.txt</a>
to see how they look on my debian system. You can use a GUI like
gODBCConfig to easily configure ODBC.<br>
<p>Now, in OpenOffice.org:</p>
<ul>
<li>
<p style="margin-bottom: 0cm;">Menu : Tools/Data Sources ... </p>
</li>
<li>
<p style="margin-bottom: 0cm;">On the left, click in "New Data
Source" </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Give a name (Biblio for instance) </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Select ODBC in Database Type (You
can also select MySQL if you use this database)</p>
</li>
<li>
<p style="margin-bottom: 0cm;">Click on ... for 'Data source URL'
and select the database which should appear in the list if you
correctly configured ODBC </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Click in the ODBC Tab </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Enter User Name, password required
if necessary, Unicode (UTF-8) </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Click on Tables Tab </p>
</li>
<li>
<p style="margin-bottom: 0cm;">A pop up dialog should ask you about
your password. Give it. The tables should be displayed. </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Close the window </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Menu Tools/Bibliography Database </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Menu Edit/Choose Data Source </p>
</li>
<li>
<p style="margin-bottom: 0cm;">In the listBox, choose your database
(Biblio) </p>
</li>
<li>
<p style="margin-bottom: 0cm;">OpenOffice.org may complain about
some column names. Click No for the moment. </p>
</li>
<li>
<p style="margin-bottom: 0cm;">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 </p>
</li>
<li>
<p style="margin-bottom: 0cm;">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.
</p>
</li>
<li>
<p style="margin-bottom: 0cm;">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. </p>
</li>
<li>
<p style="margin-bottom: 0cm;">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. </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Now you can insert citations in
OpenOffice.org using the normal menu and you don't need to have Bibus
running. </p>
</li>
<li>
<p>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. </p>
</li>
</ul>
<p align="center"><img src="../ScreenShots/OOoFields.png"
name="Graphic3" alt="OpenOffice.org fields" align="bottom" border="0"
height="364" width="898"></p>
<h2><a class="mozTocH2" name="mozTocId714457"></a><a name="OOo_menu"></a>Using
Bibus
OpenOffice.org menu</h2>
<p><a name="fig_OOo"></a>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.<br>
In
order for Bibus to communicate with OpenOffice.org, OpenOffice.org
must be <a href="#OOo_listen">listening</a>
for TCP/IP
connection.<br>
Since Bibus 0.8.1 you can either use TCP/IP connection
or <a href="#OOo_pipe">named
pipe</a> to communicate with
OpenOffice.org.<br>
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.<br>
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).<br>
<img src="../ScreenShots/OOoConnection.png" name="Graphic4"
alt="OOo menu" align="bottom" border="0" height="734" width="1006"></p>
<h3><a class="mozTocH3" name="mozTocId40231"></a><a name="OOo_listen"></a>Make
OpenOffice.org Writer listen using TCP/IP</h3>
<p>There are several ways to accomplish that.<br>
You can read "Make
the office listen" at
<<a
href="http://api.openoffice.org/docs/DevelopersGuide/FirstSteps/FirstSteps.htm">http://api.openoffice.org/docs/DevelopersGuide/FirstSteps/FirstSteps.htm</a>><br>
By
default, Bibus use the port 8100. You can change this by choosing the
menu OpenOffice.org/Settings...<br>
<i><font color="#ff0000">For
security reasons, don't forget to use a firewall and to block any
connection to this port coming from the outside world.</font></i></p>
<p>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.odg" located in $BIBUS/Setup/ in OOo. The
document will look like:</p>
<p><img alt="UNO connection"
src="../ScreenShots/UnoConnectionListener.png"
style="width: 580px; height: 310px;"><br>
</p>
<p>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.<br>
</p>
<h3><a class="mozTocH3" name="mozTocId241674"></a>Inserting a citation</h3>
<p>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.<br>
The only important point is that
before insertion, the reference goes through the <a href="#OOo_styles">style
filter</a>. 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.</p>
<h3><a class="mozTocH3" name="mozTocId650609"></a>Formating the
bibliography</h3>
<p>When you choose this menu Bibus makes two things:</p>
<ul>
<li>
<p style="margin-bottom: 0cm;">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:</p>
<ul>
<li>
<p style="margin-bottom: 0cm;">If you changed a reference in
the database, the change will be automatically inserted in your
document. </p>
</li>
<li>
<p style="margin-bottom: 0cm;">You can reformat the
bibliography by selecting a new style in the 'Format Bibliography'
menu. </p>
</li>
</ul>
</li>
<li>
<p>It updates the bibliographic index according to the settings
defined in OpenOffice.org 'Insertion/Index/Index' menu. </p>
</li>
</ul>
<p>How does Bibus recognizes a citation? For instance in the
displayed <a href="../ScreenShots/OOoConnection.png">ScreenShot,</a>
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). </p>
<h3><a class="mozTocH3" name="mozTocId283248"></a><a name="OOo_styles"></a>Styles</h3>
<p>The styles functionality is still not complete but have been
strongly improved in Bibus 0.9.<br>
You can now:</p>
<ul>
<li>
<p style="margin-bottom: 0cm;">Format all the fields </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Choose how the index is displayed
(sorting, etc...) </p>
</li>
<li>
<p style="margin-bottom: 0cm;">Define how each reference must look
in the index. </p>
</li>
<li>
<p>Save all these settings for later use.</p>
</li>
</ul>
<p>All this is easily accomplished with Bibus styles.</p>
<h4><a class="mozTocH4" name="mozTocId692072"></a>Using styles</h4>
<p>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 <a href="../ScreenShots/main.png">Main
Window</a>.<br>
The list of styles is divided in two parts. </p>
<ul>
<li>
<p style="margin-bottom: 0cm;">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.</p>
</li>
<li>
<p>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.</p>
</li>
</ul>
<h4><a class="mozTocH4" name="mozTocId645057"></a>Creating a style</h4>
<p>Creating or editing a new style is very easy. When you select New
the following 'Style editor' will pop up.<br>
<img src="../ScreenShots/style1.png" name="Graphic6" alt="style editor"
align="bottom" border="0" height="605" width="944"><br>
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.<br>
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.</p>
<h3><a class="mozTocH3" name="mozTocId80946"></a>Bibliographic index</h3>
<p>The second Tab controls how the index is formated. The choices are
easy to understand and correspond to the available choices in
OpenOffice.org.<br>
<img src="../ScreenShots/style2.png" name="Graphic7" alt="style_index"
align="bottom" border="0" height="688" width="1010"></p>
<h4><a class="mozTocH4" name="mozTocId961357"></a>Fieds formatting</h4>
<p>This Tab controls the filters that are applied to the record
fields before insertion in OpenOffice.org.<br>
For instance, if you
have a record with the corresponding authors:</p>
<pre style="margin-left: 1.06cm; margin-bottom: 0.5cm;">Marx, Groucho; Marx, Harpo; Marx, Zippo; Marx, Zeppo; Marx, Gummo</pre>
<p>you may want to format them as :</p>
<pre style="margin-left: 1.06cm; margin-bottom: 0.5cm;">Marx G., Marx H., Marx Z., Marx Z., Marx G.</pre>
<p>or</p>
<pre style="margin-left: 1.06cm; margin-bottom: 0.5cm;">Marx G., Marx H., Marx Z., Marx Z. and Marx G.</pre>
<p><img src="../ScreenShots/style3.png" name="Graphic8"
alt="style_fields" align="bottom" border="0" height="688" width="1010"><br>
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'.<br>
When you want to define a new style:</p>
<ul>
<li>
<p style="margin-bottom: 0cm;">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. </p>
<ul>
<li>
<p style="margin-bottom: 0cm;">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. </p>
</li>
<li>
<p style="margin-bottom: 0cm;">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. <i><font color="#ff0000">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 <font color="#ff0000">the Python
locale.py module included in Debian Python-2.3.3. It works well on my
machine. </font>Please let me know if it does not work with your
system. <font color="#ff0000">(on Windows and MacOS, you can
eventually try to remove locale.py from the Bibus directory in order to
use the normal locale module).</font></font></i> </p>
</li>
</ul>
</li>
<li>
<p style="margin-bottom: 0cm;">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. </p>
</li>
<li>
<p style="margin-bottom: 0cm;">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. </p>
</li>
<li>
<p>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). </p>
</li>
</ul>
<h4><a class="mozTocH4" name="mozTocId515632"></a>Fields ordering</h4>
<p>The last Tab controls how the fields are ordered and formatted.
For instance you may want to format references as:</p>
<pre style="margin-bottom: 0.5cm;">Authors. <i>Title.</i> Journal (Year) <b>Volume:</b> pages.</pre>
<p>This can be done in this Tab.<br>
<img src="../ScreenShots/style4.png" name="Graphic9"
alt="style_ordering" align="bottom" border="0" height="688"
width="1010"></p>
<h3><a class="mozTocH3" name="mozTocId673996"></a>Citation</h3>
<p>Starting with Bibus pre1.0.0, there is a new tab called
citation.<br>
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.<br>
<img src="../ScreenShots/style5.png" name="Graphic10"
alt="citation_formatting" align="bottom" border="0" height="688"
width="1009"><br>
Here
is a short description:<br>
<br>
Top: You can define here, the style of
the citation. Bold, italic, subscript, etc...<br>
<br>
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:<br>
<br>
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:<br>
- Bibus can add a
letter after the year. This method will always generate unique
citation markers.<br>
- 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.<br>
- 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.<br>
</p>
<h3><a class="mozTocH3" name="mozTocId441578"></a>Further formatting</h3>
<p>Read the OpenOffice.org help to understand how styles works in
OpenOffice.org.<br>
Bibus uses paragraph and character styles to
format the bibliography and the citations. <br>
You can thus re-format
easily the citations and/or the Bibliography.</p>
<h4><a class="mozTocH4" name="mozTocId417025"></a>Citation</h4>
<p>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.</p>
<h4><a class="mozTocH4" name="mozTocId902020"></a>Bibliography</h4>
<p>The Bibliography title uses the paragraph style "Bibliography
title"<br>
The Bibliography uses the paragraph style
"Bibliography 1"<br>
The References use the character style
"bibus_base"<br>
<br>
</p>
</body>
</html>
