|
ObiTopics.ini
Configuration File
Contents
Introduction
The ObiTopics.ini
file defines the topics that are available in the WebZ Out-of-the-Box
Interface (OBI). In addition, the file also defines a special Default
topic that is used with custom topics (created by the user) and with Quick
Search Topics. The sections and variables appearing in the ObiTopics.ini
file are defined in the tables below. An ObiTopics.ini
file example appears after the tables.
Document
Conventions
- <WebZ_root>
is the location of your WebZ environment.
File
Location
The ObiTopics.ini
file is located in the <WebZ_root>/ini/interface directory
of your WebZ installation.
Sections and Variables in ObiTopics.ini
[Topics] Section
Variable
|
Description
|
topic<n>
OR, beginning
with version 4.0.2:
topic*
|
Defines
the name of a topic to include in the WebZ interface. Multiple topics
are defined as topic1, topic2, topic3, and so on, or beginning with
version 4.0.2, as topic*, topic*, topic*, and so on.
This variable
is required for each topic you wish to display in the WebZ interface.
Note: |
(1)
For each topic listed in the [Topics] section, there must
be a separate [topic definition]
section in the ObiTopics.ini file.
(2) Do not include the Default
topic in the [Topics] section.
(3) Beginning with version 4.0.2, you can use either numerals
or asterisks to list topics, but do not mix the two; use either
all numerals or all asterisks. For versions prior to 4.0.2,
use numerals only.
|
|
[Topic Definition] Section
The name of a
topic definition section can be any combination of alphanumeric characters,
but cannot contain spaces. Examples: [Articles], [Books], [HumanAffairs],
etc. The name "Default" is reserved for use by the Default
topic.
Variable
|
Description
|
longname
|
The name
of the topic as you want it to appear in the WebZ interface.
This is
an optional variable. If not specified, the name of the [Topic Definition]
section itself is displayed in the interface.
|
dbgroup
|
Specifies
the name of the group database used to provide cross-database search
capability across the databases in the topic.
This is
an optional variable. If not specified, the dbgroup defined for
the Default topic is used.
Note: |
(1)
The value of this variable must match the value of the dbname
variable in the group database configuration file.
(2) Typically, this variable is not included in the definition
section for a Quick Search topic. Quick Search topics use
the dbgroup defined in the Default
topic.
|
|
dbname<n>
OR, beginning
with version 4.0.2:
dbname*
|
Specifies
the name of a database to include in the topic. Multiple databases
are listed as dbname1, dbname2, dbname3, and so on, or beginning
with version 4.0.2, as dbname*, dbname*, dbname*, and so on.
This is
an optional variable, though you should include at least one database
per topic.
Note: |
(1)
The value of this variable must match the value of the dbname
variable in the database configuration file.
(2) There is no physical limit to the number of databases
that can belong to a topic, but OCLC recommends that topics
include a manageable (and relevant) set of databases.
(3) Beginning with version 4.0.2, you can use either numerals
or asterisks to list databases, but do not mix the two; use
either all numerals or all asterisks. For versions prior to
4.0.2, use numerals only.
|
|
disallowed<n>
OR, beginning
with version 4.0.2:
disallowed*
|
Specifies
the name of a database to exclude from the topic. Multiple databases
are listed as disallowed1, disallowed2, disallowed3, and so on,
or beginning with version 4.0.2, or as disallowed*, disallowed*,
disallowed*, and so on.
This is
an optional variable.
Use this
variable when you want to prevent one or more specific databases
from being added to the topic by the user (through topic customization
in the WebZ interface). Typically, you should disallow a database
if its index structure does not match (or is not supported by) the
structure of the topic's group database (see dbgroup).
Note: |
Beginning
with version 4.0.2, you can use either numerals or asterisks
to list disallowed databases, but do not mix the two; use
either all numerals or all asterisks. For versions prior to
4.0.2, use numerals only.
|
|
[Default] Section
The Default topic
is a special topic in the ObiTopics.ini file that WebZ uses in cases when
no dbgroup is defined for a topic, such as when
a user creates a new, custom topic in the WebZ interface, or when the
user searches a Quick Search Topic. The Default topic uses the same variables
as a standard topic definition. There can
be only one Default topic defined in the ObiTopics.ini file.
ObiTopics.ini
File Example
# ObiTopics.ini
[Topics] topic1=Articles topic2=Books topic3=Web topic4=General topic5=HumanAffairs topic6=Culture topic7=SciTech topic8=Medicine topic9=PhoneBooks topic10=VirtualCatalog
# The description that is used to define a NEW TopicEntry # or to combine history entries for a HistoryQuery. # This is the info used if a topic is required # but no user supplied name can be located.
[Default] dbgroup = BaseGroup
[Books] dbgroup = BaseGroup dbname1 = WorldCat dbname2 = Notis
[Web] dbgroup = BaseGroup dbname1 = NetFirst
[Articles]
dbgroup = BaseGroup dbname1 = ArtFirst dbname2 = PapersFirst
[General]
longname = General dbgroup = BaseGroup dbname1 = WorldCat dbname2 = ArtFirst dbname3 = NetFirst dbname4 = AcadIndx disallowed1 = ProCDBiz disallowed2 = ProCDHome
[HumanAffairs]
longname = Human Affairs dbgroup = BaseGroup dbname1 = ABII dbname2 = Psyc dbname3 = ERIC disallowed1 = ProCDBiz disallowed2 = ProCDHome
[Culture]
longname = Culture dbgroup = BaseGroup dbname1 = ArtsHum dbname2 = RILM disallowed1 = ProCDBiz disallowed2 = ProCDHome
[SciTech]
longname = Science & Technology dbgroup = BaseGroup dbname1 = AppliSci dbname2 = Inspec dbname3 = Medline dbname4 = Psyc disallowed1 = ProCDBiz disallowed2 = ProCDHome
[PhoneBooks]
longname = Phone Books dbgroup = PhoneGroup dbname1 = ProCDBiz dbname2 = ProCDHome disallowed1 = WorldCat disallowed2 = ABII disallowed3 = AppliSci disallowed4 = ArtFirst disallowed5 = ArtsHum disallowed6 = ContentsFirst disallowed7 = ERIC disallowed8 = FactSearch disallowed9 = Inspec disallowed10 = Medline disallowed11 = FastDoc disallowed12 = NetFirst disallowed13 = PapersFirst disallowed14 = Psyc disallowed15 = RILM disallowed16 = SocSciIndx disallowed17 = Notis disallowed18 = MultiLIS disallowed19 = III disallowed20 = GenBusIAC disallowed21 = Ulist disallowed22 = MedlineOvid disallowed23 = GEAC_Advance disallowed24 = Horizon disallowed25 = DRA disallowed26 = Sirsi
[Medicine] longname = Medicine dbgroup = BaseGroup dbname1 = Medline disallowed1 = ProCDBiz disallowed2 = ProCDHome
[VirtualCatalog] longname = Virtual Catalog dbgroup = OPACGroup dbname1 = DRA dbname2 = Endeavor dbname3 = III dbname4 = GEAC_Advance dbname5 = Horizon dbname6 = Notis dbname7 = Sirsi disallowed1 = ProCDBiz disallowed2 = ProCDHome
|