Skip to content

Commit b21809d

Browse files
committed
Improve initial OPAC information
1 parent d718162 commit b21809d

7 files changed

Lines changed: 65 additions & 22 deletions

File tree

docs/abcd-modules/opac-abcd/opac-admin/general.md

Lines changed: 60 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,62 @@ sidebar_position: 2
66

77
# System Architecture & Global Configuration
88

9-
The ABCD OPAC is not just a search interface; it is a file-based CMS controlled by a hierarchy of configuration files. Understanding this architecture is crucial for troubleshooting and advanced customization.
9+
The ABCD OPAC is controlled by a hierarchy of configuration files. While advanced users can edit these files directly, the system provides a robust **Graphic Interface (GUI)** to manage global parameters, visual identity, and system cache.
1010

11-
## 1. The Bootloader: `config_opac.php`
12-
Located in the root of the OPAC (or linked from Central), this PHP file is the first to run. It dictates the environment variables.
11+
## 1. Global Parameters (GUI)
12+
**Access:** **General** > **Parameters** (`parametros.php`)
1313

14-
**Key Variables:**
14+
This interface is the primary way to configure the behavior and look of your portal. It saves changes directly to the `opac.def` file without requiring manual text editing.
15+
16+
![Parameters](../../../media/abcd-modules/opac-abcd/opac-admin/editor-opac-def.png)
17+
18+
### Visual Identity
19+
* **Logo:** You can upload an image file (PNG, JPG) directly through the interface to replace the site logo.
20+
* **Favicon (ShortIcon):** Upload the small icon displayed in the browser tab.
21+
* **Styles (CSS):** Select the color scheme (e.g., `styles.css`, `dark.css`) from the dropdown menu.
22+
* **Link Logo:** Define the URL where users are redirected when clicking the logo (usually the library homepage).
23+
24+
### Content & Text
25+
* **Page Title:** The text displayed in the browser's title bar (e.g., "Central Library Catalog").
26+
* **Footer Text:** A short text line for copyright or contact info appearing at the bottom of every page.
27+
28+
### Security & Technical
29+
* **CAPTCHA:** Enable Google reCAPTCHA integration to protect forms against bots.
30+
* **Charset:** Select the character encoding (UTF-8 or ISO-8859-1).
31+
* *Note:* This must match your database encoding to avoid character display errors (like `ã`).
32+
33+
---
34+
35+
## 2. Cache Management
36+
**Access:** **Global Parameters** > **Cache Management** (Bottom of the page)
37+
38+
To improve performance, the OPAC caches search results, facet calculations, and configuration arrays in the `opac/cache/` directory.
39+
40+
### When to Clear Cache?
41+
You should click the **"Clean Cache"** button if:
42+
1. You made changes to `opac.def` or `bases.dat` that are not appearing.
43+
2. You updated a PFT format, but records still show the old layout.
44+
3. The OPAC seems "stuck" on old search results.
45+
46+
![Clear Cache](../../../media/abcd-modules/opac-abcd/opac-admin/opac-clear-cache.png)
47+
48+
* **Action:** The system deletes temporary files (`*.cache` and temp text files) ensuring that the next user request generates fresh data.
49+
50+
---
51+
52+
## 3. The Backend: `config_opac.php` & `opac.def`
53+
Although the GUI handles most daily tasks, understanding the underlying files is crucial for troubleshooting and advanced architecture.
54+
55+
### The Bootloader: `config_opac.php`
56+
Located in the root of the OPAC, this script initializes the environment.
1557
* **`$db_path`**: The absolute path to the `bases` folder.
16-
* *Logic:* Unlike the Central module, the OPAC allows dynamic path switching via the [Multi-Context System](./advanced-access).
17-
* **`$opac_path`**: The web root of the OPAC.
18-
* **`$lang`**: The priority logic for language detection (Session > Get > Browser > Default).
19-
* **`$restricted_opac`**: Defines if the portal is public (`N`) or requires login (`Y`) to even view the home page.
58+
* **`$lang`**: The priority logic for language detection.
59+
* **`$restricted_opac`**: Defines if the portal requires login (`Y`) to view the home page.
2060

21-
## 2. Global Settings: `opac.def`
22-
Located in `bases/opac_conf/opac.def`, this INI file controls the global behavior and appearance.
61+
### The Configuration File: `opac.def`
62+
The GUI described above writes to this INI file located in `bases/opac_conf/opac.def`.
2363

24-
### Critical Parameters
64+
**Example Content:**
2565
```ini
2666
[OPAC]
2767
OpacHttp=http://localhost:9090/opac/
@@ -30,18 +70,21 @@ link_logo=[http://my-library.org](http://my-library.org)
3070
TituloPagina=My Library Catalog
3171
footer_text=© 2024 Library Systems
3272
styles=styles.css
73+
captcha=Y
3374

3475
```
3576

36-
* **`OpacHttp`**: Must match your server's URL exactly. If images break, check this first.
37-
* **`styles`**: Points to the CSS file in `assets/css/`.
38-
* **`charset`**: Usually `UTF-8` or `ISO-8859-1`. If special characters appear as `ã`, check this setting.
77+
:::warning URL Configuration
78+
The parameter **`OpacHttp`** is critical. It must match your server's public URL exactly. If images break or AJAX searches fail, check this value in the file manually.
79+
:::
80+
81+
---
3982

40-
## 3. The `opac_conf` Directory Structure
83+
## 4. The `opac_conf` Directory Structure
4184

42-
The `bases/opac_conf/` folder contains the "Global Configuration" that applies to all databases unless overridden.
85+
The `bases/opac_conf/` folder contains the "Global Configuration" assets that apply to all databases.
4386

4487
* **`bases.dat`**: The master list of databases available in the OPAC.
4588
* **`lang.tab`**: Maps language codes (en, es, pt) to human-readable names.
4689
* **`formatos.dat`**: Defines the output options (ISO, Word, Print) available in the toolbar.
47-
* **`record_toolbar.tab`**: Controls which icons appear above records (Print, Reserve, etc.).
90+
* **`record_toolbar.tab`**: Controls which icons appear above records (Print, Reserve, etc.).

docs/abcd-modules/opac-abcd/opac-admin/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ The OPAC is highly customizable. Almost every aspect—from the logo to the sear
1313

1414
**Access:**
1515
1. Log in to the **Central Module** as a Superuser.
16-
2. Go to **OPAC Configuration** (usually an icon in the main toolbar or a menu option).
1716

18-
<img width="1357" height="693" alt="image" src="https://github.com/user-attachments/assets/f30944ad-0325-40f3-b42f-ae908cf8f59b" />
17+
![Central Module](../../../media/abcd-modules/opac-abcd/opac-admin/opac-admin-001.png)
18+
19+
2. Go to **OPAC Configuration** (usually an icon in the main toolbar or a menu option).
1920

20-
<img width="1140" height="424" alt="image" src="https://github.com/user-attachments/assets/c7d77431-1132-4887-9309-eded6498930b" />
21+
![OPAC Configuration](../../../media/abcd-modules/opac-abcd/opac-admin/opac-admin-002.png)
2122

2223

2324
3. This opens the **OPAC Back-Office** (`conf_opac_menu.php`).
2425

25-
<img width="1363" height="765" alt="image" src="https://github.com/user-attachments/assets/79421aee-4aa4-4afe-9f62-63590042f3a6" />
26-
26+
![OPAC Back-Office](../../../media/abcd-modules/opac-abcd/opac-admin/opac-admin-panel.png)
2727

2828
## Key Configuration Areas
2929

54.4 KB
Loading
60.1 KB
Loading
28.2 KB
Loading
105 KB
Loading
8.84 KB
Loading

0 commit comments

Comments
 (0)