[Bug 10327] New: Rename poorly named system preferences
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Bug ID: 10327 Summary: Rename poorly named system preferences Classification: Unclassified Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: trivial Priority: P5 - low Component: Architecture, internals, and plumbing Assignee: gmcharlt@gmail.com Reporter: kyle.m.hall@gmail.com Over time Koha's system preference names have become de facto standardized using upper camel case. It would be nice to go through our system preferences and rename those prefs that do not follow this standard. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Kyle M Hall <kyle.m.hall@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|gmcharlt@gmail.com |kyle.m.hall@gmail.com -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Kyle M Hall <kyle.m.hall@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |10328 -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Kyle M Hall <kyle.m.hall@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |10329 -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Kyle M Hall <kyle.m.hall@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |10328 Depends on|10328 | -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Kyle M Hall <kyle.m.hall@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks|10328, 10329 | Depends on| |10328, 10329 -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Kyle M Hall <kyle.m.hall@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |10330 -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |gmcharlt@gmail.com --- Comment #1 from Galen Charlton <gmcharlt@gmail.com> --- We should probably decide on some ground rules for this. I'm not opposed to the idea in general terms, as choosing better names for some system preferences can improve Koha's polish. However, I think it safe to assume that there are no system preferences so poorly named that it's worth risking functionality breakage. Here are my preferences regarding system preference names: - They should make positive assertions. Consequently, "noItemTypeImages" and "noissuescharge" should be considered for renaming. - They should be fully spelled out except for very well-known acronyms (e.g., "MARC" is OK in a syspref name) - They should describe their current purpose. And some caveats: - If a system preference name is also used for other purposes, particularly database column names, the bar is going to be higher for accepting the patch. I'm thinking of 'marcflavour' in particular. I value consistency in the code base pretty highly; I would rather have a non-optimal name be used throughout than mixing old and new names for the same concept. - Patches that just rename system preferences are much more likely to be accepted at the beginning of a release than at the end. - It is OK for Koha to have a few idiosyncrasies. Unless there's evidence that a given name is *actually* confusing to users, these patches are never going to be high priority. One thing for folks to keep in mind is that system preference lookup (as with everything else in MySQL) is case-INsensitive. Consequently, if you're grepping for a system preference name, remember to use -i By the way, thanks, Kyle, for creating the omnibus bug. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 --- Comment #2 from Galen Charlton <gmcharlt@gmail.com> --- I would also urge folks to write test cases exercising each syspref that get srenamed, as that would make the benefit not just cosmetic. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 mathieu saby <mathieu.saby@univ-rennes2.fr> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |mathieu.saby@univ-rennes2.f | |r --- Comment #3 from mathieu saby <mathieu.saby@univ-rennes2.fr> --- I don't know if you agree, but here are some sysprefs that I always found poorly named : - dontmerge (Don't merge what? when?) - insecure (What is insecure? when?) - authoritysep (=> AuthoritySeparator ?) - delimiter (=> CSVDelimiter ?) - reviewson (=>OPACAllowComments ?) - suggestion (=>OPACAllowSuggestions ?) - AnonSuggestions (=>OPACAllowAnonymousSuggestions ?) - language (=> StaffLanguage ?) - useDaysMode (don't know how to rename it, b Maybe because I don't speak english fluently, I don't understand the group of sysprefs "Local use". What is the meaning of this phrase? I don't understant the group of sysprefs "Creators" either. What does it mean for you? We could also improve the description (or the name?) of some MARC21 specific features, as MARCOrgCode : it only applies to MARC21, and not to UNIMARC, but it is said nowhere. And we should remove the following sysprefs : -NoZebraIndexes - hidelostitems (an other pref can make the same job. I forget its name...) M. Saby -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 --- Comment #4 from Galen Charlton <gmcharlt@gmail.com> --- (In reply to comment #3)
Maybe because I don't speak english fluently, I don't understand the group of sysprefs "Local use". What is the meaning of this phrase?
In this context, "Local use" means "locally-defined", i.e., system preferences that aren't in stock Koha and are strictly for the use of that particularly installation. One of example of such system preferences would be for Koha-as-a-CMS.
I don't understant the group of sysprefs "Creators" either. What does it mean for you?
I don't think "Creators" is a good name -- that section refers to sysprefs related to item labels and patron card priting. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Nicole C. Engard <nengard@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |nengard@gmail.com -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 --- Comment #5 from mathieu saby <mathsabypro@gmail.com> --- What about renaming "gist" preference? For a french speaking person, it means nothing at all. "AcceptedTaxRates" would be easier to understand Mathieu -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Bug 10327 depends on bug 10329, which changed state. Bug 10329 Summary: Rename system preference marcflavour to MarcFormat http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10329 What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |RESOLVED Resolution|--- |WONTFIX -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10327 Jonathan Druart <jonathan.druart@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |12160 CC| |jonathan.druart@biblibre.co | |m -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org