
User's Guide
Technical overview
BibTex-like publication records (title, authors, year, journal, ...) are stored in a database, and web pages are automatically generated from the database usingphp
scripts. Publications
can be added, edited or deleted using an intranet-based
back-office interface. All local users have access to all
publications -- publications are not managed by their "owner" or by a dedicated administrator. This
policy can of course be changed, but this freedom ensures an up-to-date server and presents no
problems in pratice.
Each publication has its own associated directory, located in the public (web browseable) section of
the server. The directories are created automatically when publications are added and include an
index.php
file which is the publication associated web page. These directories are
organized by year, and have names generated from the initials of the authors' surnames, such as
ABC04
. The publication's authors have a write access to these directories and can place
there the documents associated with the publication. These will automatically be parsed and
referenced by the publication's associated web page. This is a key feature of the
Basilic
server : simply move files into the right directory to make them available on
the web !
Associated documents
The types of the documents are inferred from their file extensions. Compressed files (final extensions.gz, .zip, .Z, bz2, bz
) are also supported (if the original file extension
is supported). The following extensions and types are supported:
pdf
: acrobat pdf formatps
: postscriptppt,pps
: powerpointjpg, jpeg, png, tif, tiff, gif, bmp, ppm, xbm, xpm, psd
: imagesmpg, mpeg, avi, mov, wmv, qt, mp4
: movies
An abstract for the publication can also be provided in a file named abstract.html
(as
always, located in the publication's associated directory). If your site is multilingual, you can
provide additional abstract.lg.html
files, where lg corresponds to your
language code (en, fr, de, es...). Available languages depend on the Basilic configuration. Ask your
web administrator for details.
Similarly, if there is a file named info.html
(or info.lg.html
...)
in the publication's directory, its content will be included in the publication's dedicated web
page. Here is an example of such a file:
See also the page dedicated to this <a href="/Research/thisTopic.html">research topic</a>.These files are written in html format to allow text formatting, images, links..., but they are not valid self-contained html files -- their content is included in the middle of another web page, so for example the
<head>
section is not needed, as shown in the above example.
Members publications' lists
Creating a link to an author's complete list of publications is as simple as :See my <a href="http://artis.imag.fr/Publications/index.php?idAuthor=xx">complete publications list</a>replace xx by the appropriate
idAuthor
, which is displayed at the bottom of the
author edition page.
Display publication query results
The results of more complex queries can be included in any web page. Authors can for instance list their publications in 2006 (for instance in their home page) with a line like :<?php include("@@PublicationsPath@@/publiUtils.php"); displayPublications( array("author"=>"last name here", "year"=>2006) ); ?>Or, to include a bibTex reference to a specific publication, use a line like:
<?php include("@@PublicationsPath@@/publiUtils.php"); displayPublications( array("bibtex"=>"XYZ04", "display"=>"bibtex") ); ?>
You need to add CSS/listpubli.css
to the list of style sheets at the beginning
of your file for proper formatting (or create your own one). Note that depending on your php include
configuration, you may have to specify a relative path to publiUtils.php
.
displayPublications
function:
Parameter | Description |
---|---|
author | Exact last name of one of the authors. |
bibtex | BibTex key (as it appears in publication's associated directory). |
display | Possible values are list (default), gallery and
bibtex . Same as on the index page. |
full | When true , includes MasterThesis, Manual, Misc, Proceedings and Unpublished
entries in results. Default value is false . |
fullYear | When true , results of a given year are not cut,
even if nbPerPage limit is overpassed. Default value is false . |
idAuthor | id of one of the authors (visible when editing author's data in backoffice). |
nbPerPage | Maximum number of displayed results. Others are available using
pg with values greater than 1. Default value is 10. See also fullYear . |
pg | When more there are more than nbPerPage results, defines the
displayed page.A -1 value means display all results. Default value is 1. |
query | For gurus only : direct specification of the sql query. Requires a knowledge of the database structure. |
title | A part of the title or of keywords (case insensitive). |
year | Year of publication. |
array("author"=>"foo", "year"=>2006)
parameter means foo's publications in 2006
for instance.
For each year, the results are sorted alphabetically according to the title of the publication. A sorting according to the month is impossible since this field may be missing, or given as "jan--apr". Displaying the n last publications is hence impossible. However, one can use:
displayPublications( array("author"=>"last name here", "nbPerPage"=>5, "fullYear"=>true) );Which will display at least 5 publications, but will continue until the last publication of the last printed year is entirely displayed, since there is no reason to cut the display in the middle of this alphabetical listing.
Other documents
The publication's associated directory may also be the natural place to store other files associated with the publication, such a figures or tex files. Put these files in a subdirectory -- only files located at the root of the publication directory are automatically referenced. The subdirectory may be referenced byinfo.html
if you wish, and it can also be protected by a password. Add
a few links to the nicest images of this subdirectory to make them appear in the publication's
dedicated page.
BibTeX standards
The publication entry types and their optional and required fields are those used by the BibTeX standard styles. However, some optional fields have been made required:- year : which was optional for booklet, manual, misc, unpublished.
- title : which was optional for misc.
- author : which was optional for booklet, manual, misc.
- editor : which was optional for proceedings, and is provided by the author list.
Removed from book and inbook where author replaces it.
There is also a facility to initialize the publications database from an existing BibTeX file -- see
Import/bibtex2table
in the distribution.
Export
Export is available in bibTex as well as in XML formats. Current XML DTD corresponds to the PubliCNRS format, used by most french labs. Change the script or use an XSLT to change the format.See the PubliCNRS export guide (in french).
Basilic licence
Basilic Version 1.5.14, released on May 2, 2007.Copyright (C) 2004-2006 Gilles Debunne (
Gilles dot Debunne at imag dot fr
)
http://artis.imag.fr/Software/Basilic
Basilic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Basilic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.You should have received a copy of the GNU General Public License along with Basilic; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA