Attachment 80953 Details for Bug 21158 – Bug 21158: Add cronjob references to the system preference descriptions if a cronjob is required

[patch] Bug 21158: Add cronjob references to the system preference descriptions if a cronjob is required

Bug-21158-Add-cronjob-references-to-the-system-pre.patch (text/plain), 21.79 KB, created by Caroline Cyr La Rose on 2018-10-19 19:11:21 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Caroline Cyr La Rose

Created: 2018-10-19 19:11:21 UTC

Size: 21.79 KB

patch

obsolete

>From d2cad5629ca1c9c133e8e9ca7ccf47542d3faf6b Mon Sep 17 00:00:00 2001
>From: Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com>
>Date: Fri, 3 Aug 2018 16:03:10 -0400
>Subject: [PATCH] Bug 21158: Add cronjob references to the system preference
> descriptions if a cronjob is required
>
>This patch adds references to cronjobs in the description of some system preferences.
>
>The following system preference description were modified:
>- StaticHoldsQueueWeight
>- ExpireReservesMaxPickUpDelay
>- AutoResumeSuspendedHolds
>- finesMode
>- DefaultLongOverdueLostValue
>- DefaultLongOverdueChargeValue
>- PatronSelfRegistrationExpireTemporaryAccountsDelay
>- PatronSelfRegistrationVerifyByEmail
>- EnhancedMessagingPreferences
>- NewItemsDefaultLocation
>- InProcessingToShelvingCart
>- ReturnToShelvingCart
>- ReturnToShelvingCart
>- AuthorityMergeLimit
>- OpacBrowser
>- OpacCloud
>- UsageStats
>- PurgeSuggestionsOlderThan
>- MembershipExpiryDaysNotice
>
>To test, check the above mentioned system preferences to make sure the sentence is there and it is correct.
>---
> .../en/modules/admin/preferences/acquisitions.pref | 7 +++----
> .../prog/en/modules/admin/preferences/admin.pref | 16 +++++++++-------
> .../en/modules/admin/preferences/authorities.pref | 1 +
> .../en/modules/admin/preferences/cataloguing.pref | 1 +
> .../en/modules/admin/preferences/circulation.pref | 19 +++++++++++++------
> .../prog/en/modules/admin/preferences/opac.pref | 11 ++++++++---
> .../prog/en/modules/admin/preferences/patrons.pref | 16 +++++++++++-----
> 7 files changed, 46 insertions(+), 25 deletions(-)
>
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/acquisitions.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/acquisitions.pref
>index bf5d4bb..cf9209d 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/acquisitions.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/acquisitions.pref
>@@ -80,10 +80,9 @@ Acquisitions:
> - Keep accepted or rejected purchase suggestions for a period of
> - pref: PurgeSuggestionsOlderThan
> class: integer
>- - days.
>- - WARNING - Leave this field empty if you don't want to activate this automatic feature.
>- - " Example: [30] Sets purgation of suggestions for those older than 30 days."
>- - (Used when the cronjob purge_suggestions.pl is active and called without a specific number of days)
>+ - "days. Example: [30] Sets purgation of suggestions for those older than 30 days."
>+ - " WARNING: Leave this field empty if you don't want to activate this automatic feature."
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/purge_suggestions.pl</code> cronjob. Ask you system administrator to schedule it."
> 
> -
> - pref: UseACQFrameworkForBiblioRecords
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref
>index 2e8dce7..da2a1f8 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref
>@@ -176,12 +176,14 @@ Administration:
> choices:
> yes: "Yes"
> no: "No"
>- - "You have to run misc/cronjobs/share_usage_with_koha_community.pl in a cronjob. Note that the other \"UsageStats\" preferences have no effect if this preference is set to \"No\". Website where usage statistics are published: <a href=\"http://hea.koha-community.org\">Hea Koha community website</a>."
>+ - ". Website where usage statistics are published: <a href=\"http://hea.koha-community.org\">Hea Koha community website</a>."
>+ - " NOTE: The other \"UsageStats\" preferences have no effect if this preference is set to \"No\"."
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/share_usage_with_koha_community.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - "Use the following library name to be shown on the Hea Community website: "
> - pref: UsageStatsLibraryName
> - If this field is empty data will be sent anonymously.
>- - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
>+ - " NOTE: This value has no effect if the UsageStats system preference is set to \"Don't share\"."
> -
> - "The country where your library is located to be shown on the Hea Community website: "
> - pref: UsageStatsCountry
>@@ -384,11 +386,11 @@ Administration:
> Zimbabwe : "Zimbabwe"
> 
> - This will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.
>- - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
>+ - " NOTE: This value has no effect if the UsageStats system preference is set to \"Don't share\"."
> -
> - "The library URL to be shown on the Hea Community website: "
> - pref: UsageStatsLibraryUrl
>- - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
>+ - " NOTE: This value has no effect if the UsageStats system preference is set to \"Don't share\"."
> -
> - "The library type to be shown on the Hea Community website: "
> - pref: UsageStatsLibraryType
>@@ -405,18 +407,18 @@ Administration:
> government : "government"
> religiousOrg: "religious organization"
> subscription: "subscription"
>- - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
>+ - " NOTE: This value has no effect if the UsageStats system preference is set to \"Don't share\"."
> -
> - pref: UsageStatsLibrariesInfo
> choices:
> yes: "Share"
> no: "Do not Share"
> - "libraries information (name, url, country)"
>- - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
>+ - " NOTE: This value has no effect if the UsageStats system preference is set to \"Don't share\"."
> -
> - "Geolocation of the main library: "
> - pref: UsageStatsGeolocation
>- - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
>+ - " NOTE: This value has no effect if the UsageStats system preference is set to \"Don't share\"."
> Search Engine:
> -
> - "Use following search engine: "
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/authorities.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/authorities.pref
>index d9091f2..a6897e5 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/authorities.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/authorities.pref
>@@ -35,6 +35,7 @@ Authorities:
> - pref: AuthorityMergeLimit
> default: 50
> - records. (Above this limit, the merge_authority cron job will merge them.)
>+ - " NOTE: This system preference requires the <code>misc/migration_tools/merge_authority.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - Use the following text for the contents of MARC21 authority control field 008 position 06-39 (fixed length data elements). Do NOT include the date (position 00-05).
> - pref: MARCAuthorityControlField008
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref
>index d730530..3faab1f 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref
>@@ -90,6 +90,7 @@ Cataloging:
> - pref: NewItemsDefaultLocation
> class: short
> - (should be a location code, or blank to disable).
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/cart_to_shelf.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - pref: z3950NormalizeAuthor
> choices:
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>index 2407b6c..814b830 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>@@ -144,7 +144,7 @@ Circulation:
> choices:
> yes: Enable
> no: "Do not enable"
>- - "offline circulation on regular circulation computers. (NOTE: This system preference does not affect the Firefox plugin or the desktop application)"
>+ - "offline circulation on regular circulation computers. (NOTE: This system preference does not affect the Firefox plugin or the desktop application)"
> -
> - pref: ShowAllCheckins
> choices:
>@@ -213,12 +213,14 @@ Circulation:
> yes: Move
> no: "Don't move"
> - items that have the location PROC to the location CART when they are checked in.
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/cart_to_shelf.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - pref: ReturnToShelvingCart
> choices:
> yes: Move
> no: "Don't move"
> - all items to the location CART when they are checked in.
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/cart_to_shelf.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - pref: AutomaticItemReturn
> choices:
>@@ -398,12 +400,14 @@ Circulation:
> - WARNING â These preferences will activate the automatic item loss process. Leave these fields empty if you don't want to activate this feature.
> - " Example: [1] [30] Sets an item to the LOST value 1 when it has been overdue for more than 30 days."
> - (Used when the longoverdue.pl script is called without the --lost parameter)
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - "Charge a lost item to the borrower's account when the LOST value of the item changes to :"
> - pref: DefaultLongOverdueChargeValue
> class: integer
> - Leave this field empty if you don't want to charge the user for lost items.
> - (Used when the longoverdue.pl script is called without the --charge parameter)
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - "When issuing an item that has been marked as lost, "
> - pref: IssueLostItem
>@@ -427,7 +431,7 @@ Circulation:
> choices:
> yes: Allow
> no: "Don't allow"
>- - "patrons to check out multiple items from the same record. (NOTE: This will only affect records without a subscription attached.)"
>+ - "patrons to check out multiple items from the same record. (NOTE: This will only affect records without a subscription attached.)"
> -
> - pref: OnSiteCheckouts
> choices:
>@@ -507,7 +511,7 @@ Circulation:
> yes: Do
> no: "Don't"
> - calculate and update overdue charges when an item is returned.
>- - NOTE If you are doing hourly loans then you should have this on.
>+ - " NOTE: If you are doing hourly loans then you should have this on."
> -
> - pref: UpdateNotForLoanStatusOnCheckin
> type: textarea
>@@ -600,7 +604,7 @@ Circulation:
> choices:
> yes: Allow
> no: "Don't allow"
>- - "holds to expire automatically if they have not been picked by within the time period specified in ReservesMaxPickUpDelay"
>+ - "holds to expire automatically if they have not been picked by within the time period specified in ReservesMaxPickUpDelay. NOTE: This system preference requires the <code>misc/cronjobs/holds/cancel_expired_holds.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - If using ExpireReservesMaxPickUpDelay, charge a borrower who allows his or her waiting hold to expire a fee of
> - pref: ExpireReservesMaxPickUpDelayCharge
>@@ -619,6 +623,7 @@ Circulation:
> choices:
> yes: in random order.
> no: in that order.
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/holds/build_holds_queue.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> -
> - pref: canreservefromotherbranches
>@@ -666,7 +671,8 @@ Circulation:
> choices:
> yes: Allow
> no: "Don't allow"
>- - suspended holds to be automatically resumed by a set date.
>+ - "suspended holds to be automatically resumed by a set date."
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/holds/auto_unsuspend_holds.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - pref: SuspendHoldsIntranet
> choices:
>@@ -788,7 +794,8 @@ Circulation:
> test: Calculate (but only for mailing to the admin)
> production: Calculate and charge
> - fines (when <code>misc/cronjobs/fines.pl</code> is being run).
>- - Note: Fines can also be charged by the CalculateFinesOnReturn system preference.
>+ - " NOTE: Fines can also be charged by the CalculateFinesOnReturn system preference."
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/fines.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - If a lost item is returned, apply the refunding rules defined in the
> - pref: RefundLostOnReturnControl
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref
>index a974f0c..c92a753 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref
>@@ -396,13 +396,15 @@ OPAC:
> choices:
> yes: Allow
> no: "Don't allow"
>- - patrons to browse subject authorities on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to create the browser list)
>+ - patrons to browse subject authorities on OPAC
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/build_browser_and_cloud.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - pref: OpacCloud
> choices:
> yes: Show
> no: "Don't show"
>- - a subject cloud on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to build)
>+ - a subject cloud on OPAC
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/build_browser_and_cloud.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - pref: OpacAuthorities
> choices:
>@@ -718,13 +720,15 @@ OPAC:
> choices:
> yes: Allow
> no: "Don't allow"
>- - "library patrons to register or modify their account via the OPAC. Note: This needs PatronSelfRegistrationDefaultCategory to be set to a valid patron category code."
>+ - "library patrons to register or modify their account via the OPAC."
>+ - " NOTE: This needs PatronSelfRegistrationDefaultCategory to be set to a valid patron category code."
> -
> - pref: PatronSelfRegistrationVerifyByEmail
> choices:
> yes: Require
> no: "Don't require"
> - "that a self-registering patron verify his or herself via email."
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/delete_unverified_opac_registrations.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - "Use the patron category code"
> - pref: PatronSelfRegistrationDefaultCategory
>@@ -735,6 +739,7 @@ OPAC:
> - pref: PatronSelfRegistrationExpireTemporaryAccountsDelay
> class: integer
> - "days."
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/delete_expired_opac_registrations.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> must be filled in on the patron entry screen:"
> - pref: PatronSelfRegistrationBorrowerMandatoryField
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
>index 8c8227d4..711d426 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
>@@ -29,13 +29,13 @@ Patrons:
> yes: Do
> no: "Don't"
> - default the card number field on the patron addition screen to the next available card number (for example, if the largest currently used card number is 26345000012941, then this field will default to 26345000012942).
>- - "NOTE: If autoMemberNum is enabled, the system preference BorrowerMandatoryField must not contain the field cardnumber."
>+ - "NOTE: If autoMemberNum is enabled, the system preference BorrowerMandatoryField must not contain the field cardnumber."
> -
> - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> must be filled in on the patron entry screen:"
> - pref: BorrowerMandatoryField
> class: multi
> - (separate columns with |)
>- - "NOTE: If autoMemberNum is enabled, the system preference BorrowerMandatoryField must not contain the field cardnumber."
>+ - "NOTE: If autoMemberNum is enabled, the system preference BorrowerMandatoryField must not contain the field cardnumber."
> -
> - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> will not appear on the patron entry screen:"
> - pref: BorrowerUnwantedField
>@@ -65,7 +65,9 @@ Patrons:
> choices:
> yes: Allow
> no: "Don't allow"
>- - "Staff to manage which notices patrons will receive and when they will receive them. Note: this only applies to courtesy notices. To manage if patrons have also access to these settings, use EnhancedMessagingPreferencesOPAC."
>+ - "Staff to manage which notices patrons will receive and when they will receive them."
>+ - " NOTE: This only applies to courtesy notices. To manage if patrons have also access to these settings, use EnhancedMessagingPreferencesOPAC."
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/process_message_queue.pl</code> and the <code>misc/cronjobs/advance_notices.pl</code> cronjob. Ask you system administrator to schedule them."
> -
> - pref: ExtendedPatronAttributes
> choices:
>@@ -106,6 +108,7 @@ Patrons:
> - pref: MembershipExpiryDaysNotice
> class: integer
> - days.
>+ - " NOTE: This system preference requires the <code>misc/cronjobs/membership_expiry.pl</code> cronjob. Ask you system administrator to schedule it."
> -
> - pref: patronimages
> choices:
>@@ -194,7 +197,8 @@ Patrons:
> choices:
> yes: Show
> no: "Don't show"
>- - "patron messaging setting on the OPAC (note: EnhancedMessagingPreferences must be enabled)."
>+ - "patron messaging setting on the OPAC."
>+ - " NOTE: EnhancedMessagingPreferences must be enabled."
> -
> - pref: TrackLastPatronActivity
> choices:
>@@ -212,7 +216,9 @@ Patrons:
> choices:
> yes: Allow only superlibrarians
> no: Allow all permitted users
>- - "to access/change superlibrarian privileges. Note: A permitted user needs to have the 'permissions' flag (if no superlibrarian)."
>+ - "to access/change superlibrarian privileges."
>+ - " NOTE: A permitted user needs to have the 'permissions' flag (if no superlibrarian)."
>+
> Privacy:
> -
> - Use the following URL
>-- 
>2.7.4

Actions: View | Diff | Splinter Review

Attachments on bug 21158: 77484 | 80953 | 81608 | 81795 | 81796