** Welcome to the Borges extensible Documents Management System **

Borges is an Open Source project aimed at XML aware documentation
projects caring about internationalisation, reusable content,
teamwork, etc.

More information at http://linux-mandrake.com/en/doc/project/Borges/

INSTALLATION

If you have not already installed the system from RPMs, you can try by
running "make install" as root from a local copy of the CVS or from
the extracted archive.


CHECK EVERYTHING WORKS

# Create a new Borges project in say, ~/my_doc/
/usr/share/Borges/bin/configure ~/my_doc/
# Initialize the system with the provided sample document
cd ~/my_doc/
make adddoc doc=My_Book master=/usr/share/Borges/Sample/master.top.xml
# Create your personal profile by editing conf/author.xml
# with your prefered text editor
emacs conf/author.xml
# Then compile the English sample doc provided to PDF
make -C manuals/My_Book My_Book.pdf LANG=en
# Check the result
xpdf manuals/My_Book/My_Book.pdf
# Then generate the revision checking reports
make -C reports all
# And browse the results by pointing your browser to 
#	~/my_doc/reports/index.html

Note: In the above examples, the LANG=en parameter is required if you
defined a preferred language other than English (en) in the
conf/author.xml file.

STARTING A NEW PROJECT

# Create a new Borges project in say, ~/my_new_doc/
# with French as default language and 2.1 as initial release
/usr/share/Borges/bin/configure ~/my_new_doc/ fr 2.1
# Change to the project directory
cd ~/my_new_doc/
# Copy the sample manual master to any place,
# for example the current dir
cp /usr/share/Borges/Sample/master.top.xml .
# edit this master to fit your needs with your text editor,
# read the comments in it, and use them as a guide.
emacs master.top.xml
# Create a document based on this master file
make adddoc doc=My_Manual master=~/my_new_doc/master.top.xml
# define the entities used in your master file in
# manuals/My_Manual/en/strings.ent
# Generate the Writers guidelines and check it
make -C manuals/My_Manual master.top.pdf
# Fill the module templates in modules/fr/*.xml
# check the results
make -C manuals/My_Manual My_Manual.pdf
# Read the documentation in /usr/share/doc/Borges-*

ENJOY!
