菜单
Add a new Koha system preference. Generates the atomicupdate INSERT and edits the matching admin/preferences/*.pref YAML so the syspref appears in the staff UI. Arguments: bug number, preference name, and a hint about which preferences page (e.g. patrons, circulation, opac).
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | koha-syspref |
| description | Add a new Koha system preference. Generates the atomicupdate INSERT and edits the matching admin/preferences/*.pref YAML so the syspref appears in the staff UI. Arguments: bug number, preference name, and a hint about which preferences page (e.g. patrons, circulation, opac). |
Scaffold a new Koha system preference end-to-end.
Arguments: $ARGUMENTS — expected: <bug-number> <PrefName> <category-hint>
If the user supplied only a name and no category, ask which .pref file
the syspref belongs in. Common values:
| Category hint | File |
|---|---|
patrons | koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref |
circulation | .../admin/preferences/circulation.pref |
cataloguing | .../admin/preferences/cataloguing.pref |
opac | .../admin/preferences/opac.pref |
i18n / l10n | .../admin/preferences/i18n_l10n.pref |
acquisitions | .../admin/preferences/acquisitions.pref |
admin | .../admin/preferences/admin.pref |
If none of these fit, list the directory:
ls koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/
Also gather: type (YesNo, Choice, Integer, Textarea, free),
default value, and the option list if Choice.
If no atomicupdate file exists for this bug, create one (defer to the
atomicupdate skill or scaffold inline).
Add an INSERT to the atomicupdate's up sub:
$dbh->do(q{
INSERT IGNORE INTO systempreferences (variable, value, options, explanation, type)
VALUES (
'PrefName',
'defaultvalue',
'option1|option2',
'Explanation shown in admin UI.',
'Choice'
)
});
say_success($out, "Added system preference 'PrefName'");
Notes:
INSERT IGNORE makes the atomicupdate idempotent (re-running it does
nothing rather than failing on duplicate key).options is NULL (or omit) for non-Choice types.type is one of YesNo, Choice, Integer, Textarea, free,
Float, Upload, Lang, Date.Open the chosen .pref file and add an entry under an appropriate section.
The .pref files use Koha's bespoke YAML-ish format. A typical entry:
-
- "Display this label in the admin UI"
- pref: PrefName
choices:
"option1": "Human-readable option 1"
"option2": "Human-readable option 2"
- "trailing label text (optional)."
For YesNo:
-
- pref: PrefName
choices:
yes: Do
no: "Don't"
- "trailing context."
For Integer / free:
-
- "Set the limit to"
- pref: PrefName
class: integer
- "items."
Match indentation exactly — these files are whitespace-sensitive.
After both edits:
koha-schema-apply skill (or
perl installer/data/mysql/updatedatabase.pl directly).koha-qa — .pref files have their own QA checks.Report:
.pref file path + the entry added.koha-schema-apply and verify in the admin UI.File a Koha bug on bugs.koha-community.org and attach commits non-interactively via git bz. Use when the user wants to submit a patch, file a bug, or open a bz/Bugzilla ticket for Koha. Arguments (optional, free-form): summary or component hints. Without args, derive details from the current branch and HEAD commits.
Build Koha frontend assets (CSS, JS, OpenAPI spec) inside the KTD container. Use after editing SCSS, Vue components, or api/v1/swagger/*.yaml. After swagger changes you must also run restart_all to reload services — yarn build alone is not enough.
Run Koha Cypress end-to-end tests. Cypress runs from the HOST (not the KTD container) — KTD exposes the staff/OPAC interfaces on localhost and Cypress drives a real browser. Pass a spec path or directory under t/cypress/integration/.
Run Koha Perl tests inside the KTD container. Pass a test file or directory path (relative to the Koha repo root, or absolute). Handles both t/ and t/db_dependent/ automatically.
Run the Koha QA script (koha-qa.pl) inside KTD before submitting patches. Surfaces critic, POD, file_permissions, tinyint_has_boolean_flag, and other QA failures the community reviewers will check. Run after every commit; fix flagged issues before pushing.
Apply a Koha DB schema change end-to-end after editing kohastructure.sql and the atomicupdate file. Runs updatedatabase.pl in KTD, regenerates DBIC schema with dbic --force, and reminds about the manual is_boolean / relationship edits below the marker line. Use this after the atomicupdate skill has scaffolded the file and the SQL is filled in.