Bug 41541 - System preference descriptions - model format for examples
Summary: System preference descriptions - model format for examples
Status: NEW
Alias: None
Product: Koha
Classification: Unclassified
Component: System Administration (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords: Academy
Depends on:
Blocks:
 
Reported: 2026-01-07 23:17 UTC by David Nind
Modified: 2026-01-07 23:17 UTC (History)
1 user (show)

See Also:
GIT URL:
Initiative type: ---
Sponsorship status: ---
Comma delimited list of Sponsors:
Crowdfunding goal: 0
Patch complexity: String patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David Nind 2026-01-07 23:17:32 UTC
Examples in system preferences are presented several different ways, and inconsistently.

Search the system preferences for "example" and note the different ways examples are presented.

This includes:
1. Short examples on one line
2. Longer examples that use multiple lines
3. Multiple examples
4. Introductory sentence: example, for example, examples, example with bulleted items, example followed by a colon or comma
5. Included in the description
6. Shown below the description

Better examples of examples:
- PurgeListShareInvitesOlderThan: a single example
- MarcFieldDocURL: multiple examples
- UpdateItemLocationOnCheckin and UpdateItemLocationOnCheckout: multiple line example
- ILLRequestsTabs: multiple examples

Ideally, we should have a model format to use for adding examples to system preference descriptions, or highlight some exemplar system preferences that developers can copy.

This would improve consistency, make them easier to quickly scan, and make it easy for those configuring Koha.