https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41541 Bug ID: 41541 Summary: System preference descriptions - model format for examples Initiative type: --- Sponsorship --- status: Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: System Administration Assignee: koha-bugs@lists.koha-community.org Reporter: david@davidnind.com QA Contact: testopia@bugs.koha-community.org CC: gmcharlt@gmail.com 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. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.