diff --git a/modules/bibsched/doc/admin/Makefile.am b/modules/bibsched/doc/admin/Makefile.am index 63f34b87e..ff6cb2549 100644 --- a/modules/bibsched/doc/admin/Makefile.am +++ b/modules/bibsched/doc/admin/Makefile.am @@ -1,30 +1,36 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 CERN. ## ## CDS Invenio 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. ## ## CDS Invenio 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. docdir = $(localstatedir)/www/admin/bibsched doc_DATA=index.html guide.html +webdoclibdir = $(libdir)/webdoc/admin + +webdoclib_DATA = \ + bibsched-admin.webdoc \ + bibsched-admin-guide.webdoc + FILESWML = $(wildcard $(srcdir)/*.wml) -EXTRA_DIST = $(FILESWML:$(srcdir)/%=%) +EXTRA_DIST = $(webdoclib_DATA) -CLEANFILES = $(doc_DATA) *~ *.tmp +CLEANFILES = *~ *.tmp %.html: %.html.wml $(top_srcdir)/config/config.wml $(top_builddir)/config/configbis.wml $(top_srcdir)/config/cdsnavbar.wml $(WML) -o\(ALL-LANG_*\)+LANG_EN:$@ $< $(PYTHON) $(top_srcdir)/po/i18n_update_wml_target.py en $@ \ No newline at end of file diff --git a/modules/bibsched/doc/admin/bibsched-admin-guide.webdoc b/modules/bibsched/doc/admin/bibsched-admin-guide.webdoc new file mode 100644 index 000000000..9ef072d42 --- /dev/null +++ b/modules/bibsched/doc/admin/bibsched-admin-guide.webdoc @@ -0,0 +1,67 @@ +## $Id$ + +## This file is part of CDS Invenio. +## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 CERN. +## +## CDS Invenio 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. +## +## CDS Invenio 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., +## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + + + + + + + +

+ + + + + + + + + + +
+ WARNING: THIS ADMIN GUIDE IS NOT FULLY COMPLETED +
+ This Admin Guide is not yet completed. If you are interested + in seeing some specific things implemented with high priority, + please contact us at . Thanks for your interest! +
+ +

Overview

+ +

BibSched -- the bibliographic task scheduler -- is central unit of the +system that allows all other modules to access the bibliographic +database in a controlled manner, preventing sharing violation threats +and assuring the coherent execution of the database update tasks. The +module comes with an administrative interface that allows to monitor +the task queue including various possibilities of a manual +intervention, for example to re-schedule queued tasks, change the task +order, etc.

+ +

You can run the administrative interface by doing:

+ +
+
+$ bibsched
+
+
+ +

The bibsched can run in two modes: auto and manual. In +the auto mode, it will execute tasks automatically as they arrive in +the waiting queue. In the manual mode, the administrator has to +launch the tasks manually.

diff --git a/modules/bibsched/doc/admin/Makefile.am b/modules/bibsched/doc/admin/bibsched-admin.webdoc similarity index 62% copy from modules/bibsched/doc/admin/Makefile.am copy to modules/bibsched/doc/admin/bibsched-admin.webdoc index 63f34b87e..15c82f722 100644 --- a/modules/bibsched/doc/admin/Makefile.am +++ b/modules/bibsched/doc/admin/bibsched-admin.webdoc @@ -1,30 +1,28 @@ ## $Id$ + ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 CERN. ## ## CDS Invenio 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. ## ## CDS Invenio 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. +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -docdir = $(localstatedir)/www/admin/bibsched - -doc_DATA=index.html guide.html - -FILESWML = $(wildcard $(srcdir)/*.wml) -EXTRA_DIST = $(FILESWML:$(srcdir)/%=%) - -CLEANFILES = $(doc_DATA) *~ *.tmp + + + + -%.html: %.html.wml $(top_srcdir)/config/config.wml $(top_builddir)/config/configbis.wml $(top_srcdir)/config/cdsnavbar.wml - $(WML) -o\(ALL-LANG_*\)+LANG_EN:$@ $< - $(PYTHON) $(top_srcdir)/po/i18n_update_wml_target.py en $@ \ No newline at end of file +
+
BibSched Admin Guide
+
Everything you want to know about BibSched administration
+