Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/koha-tmpl/intranet-tmpl/prog/en/modules/tools/tools-home.tt
Jonathan Druart 89ade834d6 Bug 24387: Rename "News" with "Additional contents" 
One big patch for one big move.

The "News" feature (opac_news) has been hijacked to handle some system
preferences (bug 26050). The goal was to take profit of the UI (editor)
and the ability to translate the value.

Disclaimer: This patch is NOT offering the best implementation but, as
we still don't have bug 24975, it cannot be done now. And no, we don't
want to wait for it to move forward here. This patch is going into the
right direction anyway.

This enhancement is going to rename the "News" with a more genertic
"Additional contents". We have two different "categories" of content:
"news" and "html customizations".

What does it bring?
- A split on the UI for disambigate the two types of content (news and
syspref/html customizations)
- A simplification of the edit form: all languages will be translatable
on the same view (like the "notice templates")
- Ground will be prepared for different types of content (if needed later)
- Staff news can be translated

How was the "News" area working before this patch?
The opac_news DB table contained a (very inconsistent) 'lang' column.
The different values were:
- '' => news to display at the OPAC and staff interfaces
- 'koha' => news for staff only
- 'slip' => news for slip notices
- $lang => news for OPAC only, translated in $lang ('en', 'es-ES', etc.)
- "$location_$lang" => A syspref moved to this "news" area. The syspref
is $location, and is translated in $lang. Eg. OpacLoginInstructions_en,
OpacLoginInstructions_fr-FR, opacheader_es-ES

This patch is improving the DB structure with the following changes:
- renaming 'opac_news' with 'additional_contents'
- new 'category' column
 => 'news' or 'html_customizations'
- new 'location' column
 => For 'news': 'staff_and_opac', 'staff_only', 'slip'
 => For 'html_customizations': the old syspref name (eg. 'OpacLoginInstructions').
- new 'code' column (see later for more info)
- the 'lang' column will only contain the language code ('en', 'es-ES',
etc.). BUT a 'default' entry will ALWAYS exist for fallback behaviour.

We are getting closer to the 'notice template' table structure because
we want to match its UI. The 'code' column will bring us the ability to
group the different 'additional_contents' rows. The code for a given
news will be the same, but the (lang, title, content) will differ.
Examples:
  News 1 will have, for each of the translated versions
  (category, code,    location, branchcode)
  ('news',   'News1', $location, $branchcode||undef)
  And the 3 following columns will differ:
  (title,              content,               lang)
  ('title for news 1', 'content for news 1', 'default')
  ('titulo para 1',    'contenido para 1',   'es-ES')

Note that the "category" is not strictely necessary, but it seems better
to have the ability to split the different content by category/type
easily.

Additional changes:
- Syspref 'NewsToolEditor' is renamed 'AdditionalContentsEditor'
- Koha::NewItem => Koha::AdditionalContent
- Koha::News => Koha::AdditionalContents
- Script and template renamed from koha-news to additional-contents
- Foreign keys have been renamed
- Subpermission edit_news has been renamed edit_additional_contents
- The UI can now be accessed via a "News" or "HTML customizations" link
from the tools module. The related contents will then be displayed (both
categories are now split)

Changes not done here:
- Primary key 'idnew' could be renamed 'id'

Limitations of the upgrade:
News cannot be grouped by a unique code for existing translations.
=> A given news will be now displayed several times on the translated
interface
Any ideas to improve the upgrade behaviour?
We will have to add a warning in the release notes to tell libraries to
review their news.

Test plan:
0. Don't apply the patches
1. Translate the interfaces in some languages
. Create some news for staff and OPAC
. Create some content for different entry of HTML customizations
Note that you are forced to define a 'default'.
Also note that you are only forced to fill the title (not the content).
This is certainly problematic (see FIXME in the code) as sometime only
the content is displayed.
. Play with the interface (edit, delete, filter)
. Go to the different places the news are displayed, and confirm they
are displayed correctly (staff home, opac home, opac rss)
. Create 1+ news for 'slip', check an item out and 'print slip' (from
the circulation page). You must see the news.
. Go to the different places you are expecting the HTML customizations
to be present and confirm that you see them.
. Switch the lang of the interface and confirm that you now see the
content in the translated version
. Generate the templates in another language, don't translate the
content
. Use this language for the interface and confirm that the 'default'
version is displauyed.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-08-16 11:55:55 +02:00

268 lines
11 KiB
Text
Raw Blame History

[% USE Koha %]
[% USE Branches %]
[% USE Registers %]
[% INCLUDE 'doc-head-open.inc' %]
<title>Tools &rsaquo; Koha</title>
[% INCLUDE 'doc-head-close.inc' %]
</head>
<body id="tools_tools-home" class="tools">
[% INCLUDE 'header.inc' %]
[% INCLUDE 'cat-search.inc' %]
<nav id="breadcrumbs" aria-label="Breadcrumb" class="breadcrumb">
<ol>
<li>
<a href="/cgi-bin/koha/mainpage.pl">Home</a>
</li>
<li>
<a href="#" aria-current="page">
Tools
</a>
</li>
</ol>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-4">
[% IF ( CAN_user_tools_manage_patron_lists || CAN_user_clubs || CAN_user_tools_moderate_comments || CAN_user_tools_import_patrons || CAN_user_tools_edit_notices || CAN_user_tools_edit_notice_status_triggers || CAN_user_tools_label_creator || CAN_user_tools_delete_anonymize_patrons || CAN_user_tools_edit_patrons || CAN_user_tools_batch_extend_due_dates || CAN_user_tools_moderate_tags || ( CAN_user_tools_batch_upload_patron_images && Koha.Preference('patronimages') ) ) %]
<h3>Patrons and circulation</h3>
[% END %]
<dl>
[% IF (CAN_user_tools_manage_patron_lists) %]
<dt><a href="/cgi-bin/koha/patron_lists/lists.pl">Patron lists</a>
<dd>Manage lists of patrons</dd>
[% END %]
[% IF (CAN_user_clubs) %]
<dt><a href="/cgi-bin/koha/clubs/clubs.pl">Patron clubs</a>
<dd>Manage patron clubs</dd>
[% END %]
[% IF ( CAN_user_tools_moderate_comments ) %]
<dt><a href="/cgi-bin/koha/reviews/reviewswaiting.pl">Comments</a> [% IF ( pendingcomments ) %]<span class="number_box"><a href="/cgi-bin/koha/reviews/reviewswaiting.pl">[% pendingcomments | html %]</a></span>[% END %]</dt>
<dd>Moderate patron comments</dd>
[% END %]
[% IF ( CAN_user_tools_import_patrons ) %]
<dt><a href="/cgi-bin/koha/tools/import_borrowers.pl">Import patrons</a></dt>
<dd>Import patron data</dd>
[% END %]
[% IF ( CAN_user_tools_edit_notices ) %]
<dt><a href="/cgi-bin/koha/tools/letter.pl">Notices &amp; slips</a></dt>
<dd>Define notices (print and email notification messages for overdues, etc.)</dd>
[% END %]
[% IF ( CAN_user_tools_edit_notice_status_triggers ) %]
<dt><a href="/cgi-bin/koha/tools/overduerules.pl">Overdue notice/status triggers</a></dt>
<dd>Set notice/status triggers for overdue items</dd>
[% END %]
[% IF ( CAN_user_tools_label_creator ) %]
<dt><a href="/cgi-bin/koha/patroncards/home.pl">Patron card creator</a></dt>
<dd>Create printable patron cards</dd>
[% END %]
[% IF ( CAN_user_tools_delete_anonymize_patrons ) %]
<dt><a href="/cgi-bin/koha/tools/cleanborrowers.pl">Batch patron deletion and anonymization</a></dt>
<dd>Batch delete patrons and delete patron circulation history</dd>
[% END %]
[% IF ( CAN_user_tools_edit_patrons ) %]
<dt><a href="/cgi-bin/koha/tools/modborrowers.pl">Batch patron modification</a></dt>
<dd>Modify patrons in batch</dd>
[% END %]
[% IF ( CAN_user_tools_batch_extend_due_dates ) %]
<dt><a href="/cgi-bin/koha/tools/batch_extend_due_dates.pl">Batch extend due dates</a></dt>
<dd>Modify the due date checkouts in batch</dd>
[% END %]
[% IF ( CAN_user_tools_moderate_tags ) %]
<dt><a href="/cgi-bin/koha/tags/review.pl">Tags</a> [% IF ( pendingtags ) %]<span class="number_box"><a href="/cgi-bin/koha/tags/review.pl">[% pendingtags | html %]</a></span>[% END %]</dt>
<dd>Moderate patron tags</dd>
[% END %]
[% IF ( CAN_user_tools_batch_upload_patron_images && Koha.Preference('patronimages') ) %]
<dt><a href="/cgi-bin/koha/tools/picture-upload.pl">Upload patron images</a></dt>
<dd>Upload patron images in a batch or one at a time</dd>
[% END %]
</dl>
</div>
<div class="col-sm-4 col-sm-push-4">
[% IF ( CAN_user_tools_edit_calendar || CAN_user_tools_manage_csv_profiles || CAN_user_tools_view_system_logs || CAN_user_tools_edit_additional_contents || CAN_user_tools_schedule_tasks || CAN_user_tools_edit_quotes || ( Koha.ArePluginsEnabled() && CAN_user_plugins_tool ) || CAN_user_tools_upload_general_files || CAN_user_tools_access_files ) %]
<h3>Additional tools</h3>
[% END %]
<dl>
[% IF ( CAN_user_tools_edit_calendar ) %]
<dt><a href="/cgi-bin/koha/tools/holidays.pl">Calendar</a></dt>
<dd>Define days when the library is closed</dd>
[% END %]
[% IF ( CAN_user_tools_manage_csv_profiles ) %]
<dt><a href="/cgi-bin/koha/tools/csv-profiles.pl">CSV profiles</a></dt>
<dd>Manage CSV export profiles</dd>
[% END %]
[% IF ( CAN_user_tools_view_system_logs ) %]
<dt><a href="/cgi-bin/koha/tools/viewlog.pl">Log viewer</a></dt>
<dd>Browse the system logs</dd>
[% END %]
[% IF ( CAN_user_tools_edit_additional_contents ) %]
<dt><a href="/cgi-bin/koha/tools/additional-contents.pl?category=news">News</a></dt>
<dd>Write news for the OPAC and staff interfaces</dd>
<dt><a href="/cgi-bin/koha/tools/additional-contents.pl?category=html_customizations">HTML customizations</a></dt>
<dd>Write HTML customizations</dd>
[% END %]
[% IF ( CAN_user_tools_schedule_tasks ) %]
<dt><a href="/cgi-bin/koha/tools/scheduler.pl">Task scheduler</a></dt>
<dd>Schedule tasks to run</dd>
[% END %]
[% IF ( CAN_user_tools_edit_quotes ) %]
<dt><a href="/cgi-bin/koha/tools/quotes.pl">Edit quotes for QOTD feature</a></dt>
<dd>Quote editor for Quote-of-the-day feature in OPAC</dd>
[% END %]
[% IF ( Koha.ArePluginsEnabled() && CAN_user_plugins_tool && tool_plugins ) %]
<dt><a href="/cgi-bin/koha/plugins/plugins-home.pl?method=tool">Tool plugins</a></dt>
<dd>
Use tool plugins
<ul>
[% FOREACH plugin IN tool_plugins %]
<li class="plugin_link">
<a href="/cgi-bin/koha/plugins/run.pl?class=[% plugin.class | uri %]&method=tool">
<span class="plugin_name">[% plugin.metadata.name | html %]</span>
</a>
</li>
[% END %]
</ul>
</dd>
[% END %]
[% IF ( CAN_user_tools_upload_general_files ) %]
<dt><a href="/cgi-bin/koha/tools/upload.pl">Upload</a></dt>
<dd>Upload any type of file, manage uploads</dd>
[% END %]
[% IF CAN_user_tools_access_files %]
<dt><a href="/cgi-bin/koha/tools/access_files.pl">Access files</a></dt>
<dd>Access files stored on the server, like log files or reports</dd>
[% END %]
[% IF ( Koha.Preference('OPACReportProblem') && CAN_user_problem_reports ) %]
<dt><a href="/cgi-bin/koha/tools/problem-reports.pl">OPAC problem reports</a></dt>
<dd>Manage OPAC problem reports submitted by patrons</dd>
[% END %]
</dl>
[% IF ( Koha.Preference('UseCashRegisters') && ( CAN_user_cash_management_cashup || CAN_user_cash_management_anonymous_refund ) ) %]
<h3>Cash management</h3>
<dl>
<dt><a href="/cgi-bin/koha/pos/registers.pl">Cash summary for [% Branches.GetLoggedInBranchname | html %]</a></dt>
<dd>View cash takings for the current library</dd>
<dt><a href="/cgi-bin/koha/pos/register.pl">Transaction history for [% Registers.session_register_name | html %]</a></dt>
<dd>View transaction history for the current cash register</dd>
</dl>
[% END %]
</div>
<div class="col-sm-4 col-sm-pull-4">
[% IF ( CAN_user_tools_items_batchdel || CAN_user_tools_items_batchmod || CAN_user_tools_records_batchdel || CAN_user_tools_records_batchmod || CAN_user_tools_export_catalog || CAN_user_tools_inventory || CAN_user_tools_label_creator || CAN_user_tools_rotating_collections || ( CAN_user_stockrotation_manage_rotas && Koha.Preference('StockRotation') ) || CAN_user_tools_marc_modification_templates || CAN_user_tools_stage_marc_import || CAN_user_tools_manage_staged_marc || CAN_user_tools_upload_local_cover_images ) %]
<h3>Catalog</h3>
[% END %]
<dl>
[% IF ( CAN_user_tools_items_batchdel ) %]
<dt><a href="/cgi-bin/koha/tools/batchMod.pl?del=1">Batch item deletion</a></dt>
<dd>Delete a batch of items</dd>
[% END %]
[% IF ( CAN_user_tools_items_batchmod ) %]
<dt><a href="/cgi-bin/koha/tools/batchMod.pl">Batch item modification</a></dt>
<dd>Modify items in a batch</dd>
[% END %]
[% IF CAN_user_tools_records_batchdel %]
<dt><a href="/cgi-bin/koha/tools/batch_delete_records.pl">Batch record deletion</a></dt>
<dd>Delete a batch of bibliographic or authority records</dd>
[% END %]
[% IF CAN_user_tools_records_batchmod %]
<dt><a href="/cgi-bin/koha/tools/batch_record_modification.pl">Batch record modification</a></dt>
<dd>Modify a batch of bibliographic or authority records</dd>
[% END %]
[% IF ( CAN_user_tools_items_batchmod ) %]
<dt><a href="/cgi-bin/koha/tools/automatic_item_modification_by_age.pl">Automatic item modifications by age</a></dt>
<dd>Define rules to modify items by age</dd>
[% END %]
[% IF ( CAN_user_tools_export_catalog ) %]
<dt><a href="/cgi-bin/koha/tools/export.pl">Export data</a></dt>
<dd>Export bibliographic, holdings, and authority records</dd>
[% END %]
[% IF ( CAN_user_tools_inventory ) %]
<dt><a href="/cgi-bin/koha/tools/inventory.pl">Inventory</a></dt>
<dd>Perform inventory of your catalog</dd>
[% END %]
[% IF ( CAN_user_tools_label_creator ) %]
<dt><a href="/cgi-bin/koha/labels/label-home.pl">Label creator</a></dt>
<dd>Create printable labels and barcodes from catalog data</dd>
[% END %]
[% IF ( CAN_user_tools_label_creator ) %]
<dt><a href="/cgi-bin/koha/labels/spinelabel-home.pl">Quick spine label creator</a></dt>
<dd>Enter a barcode to generate a printable spine label. For use with dedicated label printers</dd>
[% END %]
[% IF ( CAN_user_tools_rotating_collections ) %]
<dt><a href="/cgi-bin/koha/rotating_collections/rotatingCollections.pl">Rotating collections</a></dt>
<dd>Manage rotating collections</dd>
[% END %]
[% IF ( CAN_user_stockrotation_manage_rotas && Koha.Preference('StockRotation') ) %]
<dt><a href="/cgi-bin/koha/tools/stockrotation.pl">Stock rotation</a></dt>
<dd>Manage Stock rotation rotas, rota stages and rota items</dd>
[% END %]
[% IF ( CAN_user_tools_marc_modification_templates ) %]
<dt><a href="/cgi-bin/koha/tools/marc_modification_templates.pl">MARC modification templates</a></dt>
<dd>Manage templates for modifying MARC records during import</dd>
[% END %]
[% IF ( CAN_user_tools_stage_marc_import ) %]
<dt><a href="/cgi-bin/koha/tools/stage-marc-import.pl">Stage MARC records for import</a></dt>
<dd>Stage MARC records into the reservoir</dd>
[% END %]
[% IF ( CAN_user_tools_manage_staged_marc ) %]
<dt><a href="/cgi-bin/koha/tools/manage-marc-import.pl">Staged MARC record management</a></dt>
<dd>Managed staged MARC records, including completing and reversing imports</dd>
[% END %]
[% IF ( CAN_user_tools_upload_local_cover_images ) %]
<dt><a href="/cgi-bin/koha/tools/upload-cover-image.pl">Upload local cover image</a></dt>
<dd>Utility to upload scanned cover images for display in OPAC</dd>
[% END %]
</dl>
</div>
</div>
[% INCLUDE 'intranet-bottom.inc' %]
View git blame Copy permalink