Bug 32562: (follow-up) Add markup comments

This patch adds comments to the template to highlight the markup
structure.

This patch should have no effect on the page's appearance or
functionality.

Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
(cherry picked from commit 61b1b12dda)
Signed-off-by: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
This commit is contained in:
Owen Leonard 2023-01-03 20:25:31 +00:00 committed by Matt Blenkinsop
parent 4084e94da6
commit 094871ffa2

View file

@ -129,7 +129,7 @@
<span class="bg-warning">not running</span> <span class="bg-warning">not running</span>
[% END %] [% END %]
</td> </td>
[% END %] [% END # /IF elasticsearch_fatal_config_error %]
</tr> </tr>
[% END %] [% END %]
<tr> <tr>
@ -230,7 +230,7 @@
</td> </td>
</tr> </tr>
</table> </table>
</div> </div> <!-- /#about -->
<div role="tabpanel" class="tab-pane" id="perl"> <div role="tabpanel" class="tab-pane" id="perl">
<table style="cursor:pointer"> <table style="cursor:pointer">
@ -258,7 +258,7 @@
[% ELSE %] [% ELSE %]
<th scope="row" style="background-color:#FF8A8A;font-weight:normal" title="Optional module missing"> <th scope="row" style="background-color:#FF8A8A;font-weight:normal" title="Optional module missing">
[% END %] [% END %]
[% END %] [% END # /IF ro.current %]
[% IF ( ro.name ) %] [% IF ( ro.name ) %]
[% ro.name | html %] [% ro.name | html %]
<span style="font-weight:normal; font-size:smaller"> <span style="font-weight:normal; font-size:smaller">
@ -276,11 +276,11 @@
<td style="font-weight:bold">Not Installed <td style="font-weight:bold">Not Installed
[% END %] [% END %]
</td> </td>
[% END %] [% END # /FOREACH ro %]
</tr> </tr>
[% END %] [% END # /FOREACH tabl %]
</table> </table>
</div> </div> <!-- /#perl -->
<div role="tabpanel" class="tab-pane" id="sysinfo"> <div role="tabpanel" class="tab-pane" id="sysinfo">
[% IF warnRequireChoosingExistingAuthority || warnPrefEasyAnalyticalRecords || warnPrefAnonymousPatronOPACPrivacy || warnPrefAnonymousPatronAnonSuggestions || warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist || warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist || warnPrefKohaAdminEmailAddress || warnPrefOpacHiddenItems || invalid_yesno.count || warnNoActiveCurrency || warnIsRootUser || xml_config_warnings.size || AutoSelfCheckPatronDoesNotHaveSelfCheckPerm || AutoSelfCheckPatronHasTooManyPerm || warnStatisticsFieldsError || warnNoTemplateCaching || warnILLConfiguration || has_ai_issues || oauth2_missing_deps || bad_yaml_prefs || warnRelationships || log4perl_errors || config_bcrypt_settings_no_set || warnHiddenBiblionumbers.size || warnConnectBroker || elasticsearch_has_missing %] [% IF warnRequireChoosingExistingAuthority || warnPrefEasyAnalyticalRecords || warnPrefAnonymousPatronOPACPrivacy || warnPrefAnonymousPatronAnonSuggestions || warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist || warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist || warnPrefKohaAdminEmailAddress || warnPrefOpacHiddenItems || invalid_yesno.count || warnNoActiveCurrency || warnIsRootUser || xml_config_warnings.size || AutoSelfCheckPatronDoesNotHaveSelfCheckPerm || AutoSelfCheckPatronHasTooManyPerm || warnStatisticsFieldsError || warnNoTemplateCaching || warnILLConfiguration || has_ai_issues || oauth2_missing_deps || bad_yaml_prefs || warnRelationships || log4perl_errors || config_bcrypt_settings_no_set || warnHiddenBiblionumbers.size || warnConnectBroker || elasticsearch_has_missing %]
@ -288,7 +288,7 @@
<h2>Warning regarding current user</h2> <h2>Warning regarding current user</h2>
<p>You are logged in as the database administrative user. This is not recommended because some parts of Koha will not function as expected when using this account.</p> <p>You are logged in as the database administrative user. This is not recommended because some parts of Koha will not function as expected when using this account.</p>
<p>Please log in instead with a regular staff account. To create a staff account, create a library, a patron category 'Staff' and add a new patron. Then give this patron permissions from 'More' in the toolbar.</p> <p>Please log in instead with a regular staff account. To create a staff account, create a library, a patron category 'Staff' and add a new patron. Then give this patron permissions from 'More' in the toolbar.</p>
[% END %] [% END # /IF warnIsRootUser %]
[% IF has_ai_issues %] [% IF has_ai_issues %]
<h2>Data problems</h2> <h2>Data problems</h2>
@ -357,13 +357,13 @@
</p> </p>
[% END %] [% END %]
<br/> <br/>
[% END %] [% END # /IF has_ai_issues %]
[% IF warnRelationships %] [% IF warnRelationships %]
<h2>Patron relationship problems</h2> <h2>Patron relationship problems</h2>
[% IF bad_relationships_count %] [% IF bad_relationships_count %]
<p>Your database contained guarantee/guarantor pairs with no defined relationship. They have been set the value '_bad_data' in the [% "borrowers.relationship" | $HtmlTags tag="strong" %] and/or [% "borrower_relationships.relationship" | $HtmlTags tag="strong" %] columns. Fix them manually by recreating those relationships, or have your system's administrator correct the values.</p> <p>Your database contained guarantee/guarantor pairs with no defined relationship. They have been set the value '_bad_data' in the [% "borrowers.relationship" | $HtmlTags tag="strong" %] and/or [% "borrower_relationships.relationship" | $HtmlTags tag="strong" %] columns. Fix them manually by recreating those relationships, or have your system's administrator correct the values.</p>
[% END %] [% END # /IF bad_relationships_count %]
[% IF wrong_relationships %] [% IF wrong_relationships %]
<p>The following values have been used for guarantee/guarantor relationships, but do not exist in the 'borrowerRelationship' system preference:</p> <p>The following values have been used for guarantee/guarantor relationships, but do not exist in the 'borrowerRelationship' system preference:</p>
@ -373,8 +373,8 @@
[% END %] [% END %]
</ul> </ul>
<p>If the relationship is one you want, please add it to the 'borrowerRelationship' system preference, otherwise have your system's administrator correct the values in [% "borrowers.relationship" | $HtmlTags tag="strong" %] and/or [% "borrower_relationships.relationship" | $HtmlTags tag="strong" %] in the database.</p> <p>If the relationship is one you want, please add it to the 'borrowerRelationship' system preference, otherwise have your system's administrator correct the values in [% "borrowers.relationship" | $HtmlTags tag="strong" %] and/or [% "borrower_relationships.relationship" | $HtmlTags tag="strong" %] in the database.</p>
[% END %] [% END # /IF wrong_relationships %]
[% END %] [% END # /IF warnRelationships %]
[% IF log4perl_errors %] [% IF log4perl_errors %]
<h2>Logging system does not behave correctly</h2> <h2>Logging system does not behave correctly</h2>
@ -386,8 +386,8 @@
[% CASE 'cannot_init_module' %]<span>The Koha::Logger module cannot be initiated correctly (check the log file).</span> [% CASE 'cannot_init_module' %]<span>The Koha::Logger module cannot be initiated correctly (check the log file).</span>
[% CASE %]<span>Unknown error '[% e | html %]'.</span> [% CASE %]<span>Unknown error '[% e | html %]'.</span>
[% END %] [% END %]
[% END %] [% END # /FOR e %]
[% END %] [% END # /IF log4perl_errors %]
[% IF warnConnectBroker %] [% IF warnConnectBroker %]
<h2>Impossible to connect to the message broker</h2> <h2>Impossible to connect to the message broker</h2>
@ -396,7 +396,7 @@
Maybe it is not installed and configured correctly? Maybe it is not installed and configured correctly?
<br/> <br/>
Contact your system administrator. Contact your system administrator.
[% END %] [% END # /IF warnConnectBroker %]
[% IF warnPrefRequireChoosingExistingAuthority || warnPrefEasyAnalyticalRecords || warnPrefAnonymousPatronOPACPrivacy || warnPrefAnonymousPatronAnonSuggestions || warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist || warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist || warnPrefKohaAdminEmailAddress || warnPrefOpacHiddenItems || invalid_yesno.count || warnNoActiveCurrency || AutoSelfCheckPatronDoesNotHaveSelfCheckPerm || AutoSelfCheckPatronHasTooManyPerm || warnStatisticsFieldsError || warnNoTemplateCaching || warnILLConfiguration || warnXSLT || oauth2_missing_deps || bad_yaml_prefs || warnIssuingRules || config_bcrypt_settings_no_set || warnHiddenBiblionumbers.size %] [% IF warnPrefRequireChoosingExistingAuthority || warnPrefEasyAnalyticalRecords || warnPrefAnonymousPatronOPACPrivacy || warnPrefAnonymousPatronAnonSuggestions || warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist || warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist || warnPrefKohaAdminEmailAddress || warnPrefOpacHiddenItems || invalid_yesno.count || warnNoActiveCurrency || AutoSelfCheckPatronDoesNotHaveSelfCheckPerm || AutoSelfCheckPatronHasTooManyPerm || warnStatisticsFieldsError || warnNoTemplateCaching || warnILLConfiguration || warnXSLT || oauth2_missing_deps || bad_yaml_prefs || warnIssuingRules || config_bcrypt_settings_no_set || warnHiddenBiblionumbers.size %]
<h2>Warnings regarding the system configuration</h2> <h2>Warnings regarding the system configuration</h2>
@ -579,7 +579,7 @@
</tr> </tr>
[% END %] [% END %]
</table> </table>
[% END %] [% END # /IF warnPrefRequireChoosingExistingAuthority %]
[% IF xml_config_warnings.size %] [% IF xml_config_warnings.size %]
<table> <table>
@ -669,10 +669,10 @@
Please generate a key. We recommend one of at least 32 bytes. (You might use 'pwgen 32' to do so.) Please generate a key. We recommend one of at least 32 bytes. (You might use 'pwgen 32' to do so.)
</td> </td>
</tr> </tr>
[% END %] [% END # /IF config_entry.error %]
[% END %] [% END # /FOREACH config_entry %]
</table> </table>
[% END %] [% END # /IF xml_config_warnings.size %]
[% IF warnIssuingRules %] [% IF warnIssuingRules %]
<table> <table>
@ -684,9 +684,9 @@
The [% unit.branchcode || 'branchcode=default' | html %], [% unit.categorycode || 'categorycode=default' | html %], [% unit.itemtype || 'itemtype=default' | html %]issuingrule will fallback to 'days' for 'lengthunit' as it is incorrectly defined as [% unit.rule_value | html %]. The [% unit.branchcode || 'branchcode=default' | html %], [% unit.categorycode || 'categorycode=default' | html %], [% unit.itemtype || 'itemtype=default' | html %]issuingrule will fallback to 'days' for 'lengthunit' as it is incorrectly defined as [% unit.rule_value | html %].
</td> </td>
</tr> </tr>
[% END %] [% END # /FOREACH unit %]
</table> </table>
[% END %] [% END # /IF warnIssuingRules %]
[% IF elasticsearch_has_missing %] [% IF elasticsearch_has_missing %]
<table> <table>
@ -702,12 +702,12 @@
[% END %] [% END %]
[% END %] [% END %]
</table> </table>
[% END %] [% END # /IF elasticsearch_has_missing %]
[% ELSE %] [% ELSE %]
<p>No warnings.</p> <p>No warnings.</p>
[% END %] [% END # /IF warnRequireChoosingExistingAuthority... %]
</div> </div> <!-- /#sysinfo -->
<div role="tabpanel" class="tab-pane" id="team"> <div role="tabpanel" class="tab-pane" id="team">
<h2>Special thanks to the following organizations</h2> <h2>Special thanks to the following organizations</h2>
@ -763,7 +763,7 @@
<div class="dialog alert"> <div class="dialog alert">
Could not read the teams.yaml file. Please make sure &lt;docdir&gt; is correctly defined in koha-conf.xml. Could not read the teams.yaml file. Please make sure &lt;docdir&gt; is correctly defined in koha-conf.xml.
</div> </div>
[% END %] [% END # /maintenance_team %]
<h2>Koha development team</h2> <h2>Koha development team</h2>
[% IF contributors.size %] [% IF contributors.size %]
@ -776,7 +776,7 @@
<div class="dialog alert"> <div class="dialog alert">
Could not read the contributors.yaml file. Please make sure &lt;docdir&gt; is correctly defined in koha-conf.xml. Could not read the contributors.yaml file. Please make sure &lt;docdir&gt; is correctly defined in koha-conf.xml.
</div> </div>
[% END %] [% END # /IF contributors.size %]
<hr> <hr>
<h2>Contributing companies and institutions</h2> <h2>Contributing companies and institutions</h2>
@ -894,7 +894,7 @@
<li>Nicholas Rosasco (Documentation Compiler)</li> <li>Nicholas Rosasco (Documentation Compiler)</li>
<li>Regula Sebastiao</li> <li>Regula Sebastiao</li>
</ul> </ul>
</div> </div> <!-- /#team -->
<div role="tabpanel" class="tab-pane" id="licenses"> <div role="tabpanel" class="tab-pane" id="licenses">
<h2>Koha</h2> <h2>Koha</h2>
@ -1107,7 +1107,7 @@
<a href="https://wicky.nillia.ms/enquire.js">Enquire.js</a> licensed under the <a href="https://github.com/WickyNilliams/enquire.js/blob/master/LICENSE">MIT license</a>. <a href="https://wicky.nillia.ms/enquire.js">Enquire.js</a> licensed under the <a href="https://github.com/WickyNilliams/enquire.js/blob/master/LICENSE">MIT license</a>.
</p> </p>
</div> </div> <!-- /#licenses -->
<div role="tabpanel" class="tab-pane" id="translations"> <div role="tabpanel" class="tab-pane" id="translations">
<h2>Translation</h2> <h2>Translation</h2>
@ -1159,7 +1159,7 @@
<li>&#1059;&#1082;&#1088;&#1072;&#1111;&#1085;&#1089;&#1100;&#1082;&#1072; (Ukrainian) Victor Titarchuk and Serhij Dubyk</li> <li>&#1059;&#1082;&#1088;&#1072;&#1111;&#1085;&#1089;&#1100;&#1082;&#1072; (Ukrainian) Victor Titarchuk and Serhij Dubyk</li>
</ul> </ul>
</div> </div> <!-- /#translations -->
<div role="tabpanel" class="tab-pane" id="history"> <div role="tabpanel" class="tab-pane" id="history">
<h2>Koha history timeline</h2> <h2>Koha history timeline</h2>
@ -1185,7 +1185,7 @@
Could not read the history.txt file. Please make sure &lt;docdir&gt; is correctly defined in koha-conf.xml. Could not read the history.txt file. Please make sure &lt;docdir&gt; is correctly defined in koha-conf.xml.
</div> </div>
[% END %] [% END %]
</div> </div> <!-- /#history -->
<div role="tabpanel" class="tab-pane" id="dedications"> <div role="tabpanel" class="tab-pane" id="dedications">
<h2>22.11</h2> <h2>22.11</h2>
@ -1202,11 +1202,11 @@
She was also a practicing Justice of the Peace, a stalwart of the Levin Pottery Club and much loved She was also a practicing Justice of the Peace, a stalwart of the Levin Pottery Club and much loved
mother of Simon and Jeremy, and grandmother of Ben, Toby, Anna, Charlotte and Billy. mother of Simon and Jeremy, and grandmother of Ben, Toby, Anna, Charlotte and Billy.
</p> </p>
</div> </div> <!-- /#dedications -->
</div> </div> <!-- /.tab-content -->
</div> </div> <!-- /#abouttabs -->
</div> </div> <!-- /.col-md-12 -->
</div> </div> <!-- /.row -->
[% MACRO jsinclude BLOCK %] [% MACRO jsinclude BLOCK %]
<script> <script>