diff --git a/modules/bibharvest/Makefile.am b/modules/bibharvest/Makefile.am index 7e62cbf12..2ad5ae1dd 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibharvest/Makefile.am @@ -1,22 +1,22 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +SUBDIRS = bin doc lib web CLEANFILES = *~ \ No newline at end of file diff --git a/modules/bibharvest/doc/.cvsignore b/modules/bibharvest/doc/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibharvest/doc/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibharvest/Makefile.am b/modules/bibharvest/doc/Makefile.am similarity index 95% copy from modules/bibharvest/Makefile.am copy to modules/bibharvest/doc/Makefile.am index 7e62cbf12..d1cb6a272 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibharvest/doc/Makefile.am @@ -1,22 +1,22 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +SUBDIRS = admin hacking -CLEANFILES = *~ \ No newline at end of file +CLEANFILES = *~ diff --git a/modules/bibharvest/doc/admin/.cvsignore b/modules/bibharvest/doc/admin/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibharvest/doc/admin/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibharvest/Makefile.am b/modules/bibharvest/doc/admin/Makefile.am similarity index 76% copy from modules/bibharvest/Makefile.am copy to modules/bibharvest/doc/admin/Makefile.am index 7e62cbf12..d94beda9d 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibharvest/doc/admin/Makefile.am @@ -1,22 +1,28 @@ ## $Id$ - ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +docdir = $(WEBDIR)/admin/bibharvest + +doc_DATA=index.html guide.html + +EXTRA_DIST = $(wildcard *.wml) + +CLEANFILES = $(doc_DATA) *~ *.tmp -CLEANFILES = *~ \ No newline at end of file +%.html: %.html.wml ../../../../config/config.wml ../../../../config/configbis.wml + $(WML) -o\(ALL-LANG_*\)+LANG_EN:$@ $< \ No newline at end of file diff --git a/modules/bibharvest/doc/admin/guide.html.wml b/modules/bibharvest/doc/admin/guide.html.wml new file mode 100644 index 000000000..2ee12d859 --- /dev/null +++ b/modules/bibharvest/doc/admin/guide.html.wml @@ -0,0 +1,84 @@ +## $Id$ + +## This file is part of the CERN Document Server Software (CDSware). +## Copyright (C) 2002 CERN. +## +## The CDSware 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. +## +## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., +## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + +#include "cdspage.wml" \ + title="BibHarvest Admin Guide" \ + navtrail_previous_links="/admin/> > /admin/bibharvest/>BibHarvest Admin" \ + navbar_name="admin" \ + navbar_select="bibharvest-admin-guide" + +

+ + + + + + + + + + +
+ WARNING: THIS ADMIN GUIDE IS NOT FULLY COMPLETED +
+ This Admin Guide is not yet completed. Moreover, some + admin-level functionality for this module exists only in the form of + manual recipes. We are in the process of developing both the + guide as well as the web admin interface. If you are interested + in seeing some specific things implemented with high priority, + please contact us at . Thanks for your interest! +
+ +

Contents

+1. Overview
+2. OAI Data Harvesting
+       2.1 BibHarvest command-line tool
+       2.2 Periodical harvesting
+3. OAI Data Providing
+ +

1. Overview

+ +FIXME. + +

2. OAI Data Harvesting

+ +

2.1. BibHarvest command-line tool

+ +

To harvest records from an OAI compliant repository, run the +bibharvest command-line tool. For example: + +

+
+$ bibharvest -vListRecords -f2004-04-01 -u2004-04-02 -pmarcxml -o/tmp/z.xml \\
+             http://cdsweb.cern.ch/oai2d.py
+
+
+ +

For further help with the command-line harvesting tool, run +bibharvest --help. + +

2.2. Periodical harvesting

+ +

It is not currently possible to set up periodical execution of +bibharvest. You would have to set up an external cron +job script to do that. + +

3. OAI Data Providing

+ +FIXME. (See config.wml for OAI tags.) diff --git a/modules/bibharvest/Makefile.am b/modules/bibharvest/doc/admin/index.html.wml similarity index 64% copy from modules/bibharvest/Makefile.am copy to modules/bibharvest/doc/admin/index.html.wml index 7e62cbf12..c07ad60bb 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibharvest/doc/admin/index.html.wml @@ -1,22 +1,29 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +#include "cdspage.wml" \ + title="BibHarvest Admin" \ + navtrail_previous_links="/admin/>" \ + navbar_name="admin" \ + navbar_select="bibharvest" -CLEANFILES = *~ \ No newline at end of file +
+
BibHarvest Admin Guide
+
Everything you want to know about configuring and running BibHarvest.
+
diff --git a/modules/bibharvest/doc/hacking/.cvsignore b/modules/bibharvest/doc/hacking/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibharvest/doc/hacking/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibharvest/doc/hacking/Makefile.am b/modules/bibharvest/doc/hacking/Makefile.am new file mode 100644 index 000000000..e69de29bb diff --git a/modules/bibindex/Makefile.am b/modules/bibindex/Makefile.am index 6e03e9d56..557377734 100644 --- a/modules/bibindex/Makefile.am +++ b/modules/bibindex/Makefile.am @@ -1,22 +1,22 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin +SUBDIRS = bin doc -CLEANFILES = *~ \ No newline at end of file +CLEANFILES = *~ diff --git a/modules/bibindex/doc/.cvsignore b/modules/bibindex/doc/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibindex/doc/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibharvest/Makefile.am b/modules/bibindex/doc/Makefile.am similarity index 95% copy from modules/bibharvest/Makefile.am copy to modules/bibindex/doc/Makefile.am index 7e62cbf12..d1cb6a272 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibindex/doc/Makefile.am @@ -1,22 +1,22 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +SUBDIRS = admin hacking -CLEANFILES = *~ \ No newline at end of file +CLEANFILES = *~ diff --git a/modules/bibindex/doc/admin/.cvsignore b/modules/bibindex/doc/admin/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibindex/doc/admin/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibharvest/Makefile.am b/modules/bibindex/doc/admin/Makefile.am similarity index 76% copy from modules/bibharvest/Makefile.am copy to modules/bibindex/doc/admin/Makefile.am index 7e62cbf12..61c98dd54 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibindex/doc/admin/Makefile.am @@ -1,22 +1,28 @@ ## $Id$ - ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +docdir = $(WEBDIR)/admin/bibindex + +doc_DATA=index.html guide.html + +EXTRA_DIST = $(wildcard *.wml) + +CLEANFILES = $(doc_DATA) *~ *.tmp -CLEANFILES = *~ \ No newline at end of file +%.html: %.html.wml ../../../../config/config.wml ../../../../config/configbis.wml + $(WML) -o\(ALL-LANG_*\)+LANG_EN:$@ $< \ No newline at end of file diff --git a/modules/bibindex/doc/admin/guide.html.wml b/modules/bibindex/doc/admin/guide.html.wml new file mode 100644 index 000000000..372a07a6d --- /dev/null +++ b/modules/bibindex/doc/admin/guide.html.wml @@ -0,0 +1,71 @@ +## $Id$ + +## This file is part of the CERN Document Server Software (CDSware). +## Copyright (C) 2002 CERN. +## +## The CDSware 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. +## +## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., +## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + +#include "cdspage.wml" \ + title="BibIndex Admin Guide" \ + navtrail_previous_links="/admin/> > /admin/bibindex/>BibIndex Admin" \ + navbar_name="admin" \ + navbar_select="bibindex-admin-guide" + +

+ + + + + + + + + + +
+ WARNING: BIBINDEX ADMIN GUIDE IS UNDER DEVELOPMENT +
+ + BibIndex Admin Guide is not yet completed. Most of admin-level + functionality for BibIndex exists only in commandline mode. We + are in the process of developing both the guide as well as the + web admin interface. If you are interested in seeing some + specific things implemented with high priority, please contact us + at . Thanks for your interest! + +
+ +

Contents

+1.Overview
+2. Configure Metadata Tags and Fields
+       2.1 Configure Physical MARC Tags
+       2.2 Configure Logical Fields
+3. Configure Word/Phrase Indexes
+       3.1 Define New Index
+       3.2 Configure Word-Breaking Procedure
+       3.3 Configure Stopwords List
+       3.4 Configure Accent Stripping
+4. Run BibIndex Daemon
+ +

1. Overview

+

2. Configure Metadata Tags and Fields

+

2.1 Configure Physical MARC Tags

+

2.2 Configure Logical Fields

+

3. Configure Word/Phrase Indexes

+

3.1 Define New Index

+

3.2 Configure Word-Breaking Procedure

+

3.3 Configure Stopwords List

+

3.4 Configure Accent Stripping

+

4. Run BibIndex Daemon

diff --git a/modules/bibharvest/Makefile.am b/modules/bibindex/doc/admin/index.html.wml similarity index 57% copy from modules/bibharvest/Makefile.am copy to modules/bibindex/doc/admin/index.html.wml index 7e62cbf12..197dd6a41 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibindex/doc/admin/index.html.wml @@ -1,22 +1,34 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +#include "cdspage.wml" \ + title="BibIndex Admin" \ + navtrail_previous_links="/admin/>" \ + navbar_name="admin" \ + navbar_select="bibindex" -CLEANFILES = *~ \ No newline at end of file +

+ This is the gate to the admin area for BibIndex. You need to + login to enter. +

+ +
+
BibIndex Admin Guide
+
Everything you want to know about BibIndex administration
+
diff --git a/modules/bibindex/doc/hacking/.cvsignore b/modules/bibindex/doc/hacking/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibindex/doc/hacking/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibindex/doc/hacking/Makefile.am b/modules/bibindex/doc/hacking/Makefile.am new file mode 100644 index 000000000..e69de29bb diff --git a/modules/bibsched/Makefile.am b/modules/bibsched/Makefile.am index 6e03e9d56..757cffb1a 100644 --- a/modules/bibsched/Makefile.am +++ b/modules/bibsched/Makefile.am @@ -1,22 +1,22 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin +SUBDIRS = bin doc CLEANFILES = *~ \ No newline at end of file diff --git a/modules/bibsched/doc/.cvsignore b/modules/bibsched/doc/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibsched/doc/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibharvest/Makefile.am b/modules/bibsched/doc/Makefile.am similarity index 95% copy from modules/bibharvest/Makefile.am copy to modules/bibsched/doc/Makefile.am index 7e62cbf12..d1cb6a272 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibsched/doc/Makefile.am @@ -1,22 +1,22 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +SUBDIRS = admin hacking -CLEANFILES = *~ \ No newline at end of file +CLEANFILES = *~ diff --git a/modules/bibsched/doc/admin/.cvsignore b/modules/bibsched/doc/admin/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibsched/doc/admin/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibharvest/Makefile.am b/modules/bibsched/doc/admin/Makefile.am similarity index 76% copy from modules/bibharvest/Makefile.am copy to modules/bibsched/doc/admin/Makefile.am index 7e62cbf12..66c5d40fd 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibsched/doc/admin/Makefile.am @@ -1,22 +1,28 @@ ## $Id$ - ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +docdir = $(WEBDIR)/admin/bibsched + +doc_DATA=index.html guide.html + +EXTRA_DIST = $(wildcard *.wml) + +CLEANFILES = $(doc_DATA) *~ *.tmp -CLEANFILES = *~ \ No newline at end of file +%.html: %.html.wml ../../../../config/config.wml ../../../../config/configbis.wml + $(WML) -o\(ALL-LANG_*\)+LANG_EN:$@ $< \ No newline at end of file diff --git a/modules/bibsched/doc/admin/guide.html.wml b/modules/bibsched/doc/admin/guide.html.wml new file mode 100644 index 000000000..c8d1fd319 --- /dev/null +++ b/modules/bibsched/doc/admin/guide.html.wml @@ -0,0 +1,65 @@ +## $Id$ + +## This file is part of the CERN Document Server Software (CDSware). +## Copyright (C) 2002 CERN. +## +## The CDSware 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. +## +## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., +## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + +#include "cdspage.wml" \ + title="BibSched Admin Guide" \ + navtrail_previous_links="/admin/> > /admin/bibsched/>BibSched Admin" \ + navbar_name="admin" \ + navbar_select="bibsched-admin-guide" + +

+ + + + + + + + + + +
+ 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! +
+ +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/bibharvest/Makefile.am b/modules/bibsched/doc/admin/index.html.wml similarity index 57% copy from modules/bibharvest/Makefile.am copy to modules/bibsched/doc/admin/index.html.wml index 7e62cbf12..af4cebe35 100644 --- a/modules/bibharvest/Makefile.am +++ b/modules/bibsched/doc/admin/index.html.wml @@ -1,22 +1,34 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware 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. ## ## The CDSware 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 CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. -SUBDIRS = bin lib web +#include "cdspage.wml" \ + title="BibSched Admin" \ + navtrail_previous_links="/admin/>" \ + navbar_name="admin" \ + navbar_select="bibsched" -CLEANFILES = *~ \ No newline at end of file +

+ This is the gate to the admin area for BibSched. You need to + login to enter. +

+ +
+
BibSched Admin Guide
+
Everything you want to know about BibSched administration
+
diff --git a/modules/bibsched/doc/hacking/.cvsignore b/modules/bibsched/doc/hacking/.cvsignore new file mode 100644 index 000000000..f0878fb91 --- /dev/null +++ b/modules/bibsched/doc/hacking/.cvsignore @@ -0,0 +1,8 @@ +Makefile +Makefile.in +z_* +*.O +*~ +*.py +*.shtml +*.html \ No newline at end of file diff --git a/modules/bibsched/doc/hacking/Makefile.am b/modules/bibsched/doc/hacking/Makefile.am new file mode 100644 index 000000000..e69de29bb