Bug 30304 - Reindent lists template in the staff interface
Summary: Reindent lists template in the staff interface
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Templates (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Owen Leonard
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks: 30309
  Show dependency treegraph
 
Reported: 2022-03-16 14:02 UTC by Owen Leonard
Modified: 2023-12-28 20:42 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
22.11.00


Attachments
Bug 30304: Reindent lists template in the staff interface (50.31 KB, patch)
2022-09-08 15:58 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 30304: (follow-up) Add markup comments (12.47 KB, patch)
2022-09-08 15:58 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 30304: Reindent lists template in the staff interface (50.36 KB, patch)
2022-09-11 13:12 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 30304: (follow-up) Add markup comments (12.53 KB, patch)
2022-09-11 13:12 UTC, Katrin Fischer
Details | Diff | Splinter Review
k (50.42 KB, patch)
2022-10-01 19:29 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 30304: Reindent lists template in the staff interface (50.42 KB, patch)
2022-10-03 14:59 UTC, Lucas Gass
Details | Diff | Splinter Review
Bug 30304: (follow-up) Add markup comments (12.58 KB, patch)
2022-10-03 14:59 UTC, Lucas Gass
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Owen Leonard 2022-03-16 14:02:46 UTC
I propose to reformat the lists template in the staff interface (shelves.tt) so that it has consistent spacing and indentation.
Comment 1 Owen Leonard 2022-09-08 15:58:44 UTC
Created attachment 140348 [details] [review]
Bug 30304: Reindent lists template in the staff interface

This patch performs general template cleanup to the lists template:
Make indentation consistent, replace tabs with spaces, and trim trailing
whitespace.

To test, apply the patch and test all aspects of the lists pages,
including:

- Viewing the list of public and private lists.
- List of lists DataTable controls: Paging, filtering, sorting.
- Add, edit and delete lists.
- View list contents.
- Remove titles from a list.
- Place hold from a list.
- Add items to a list.

Use your preferred method for checking the differences between files
while ignoring whitespace. I use diff with the  "-w" flag. The only
changes you see should be split lines.
Comment 2 Owen Leonard 2022-09-08 15:58:48 UTC
Created attachment 140349 [details] [review]
Bug 30304: (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.
Comment 3 Katrin Fischer 2022-09-11 13:12:02 UTC
Created attachment 140395 [details] [review]
Bug 30304: Reindent lists template in the staff interface

This patch performs general template cleanup to the lists template:
Make indentation consistent, replace tabs with spaces, and trim trailing
whitespace.

To test, apply the patch and test all aspects of the lists pages,
including:

- Viewing the list of public and private lists.
- List of lists DataTable controls: Paging, filtering, sorting.
- Add, edit and delete lists.
- View list contents.
- Remove titles from a list.
- Place hold from a list.
- Add items to a list.

Use your preferred method for checking the differences between files
while ignoring whitespace. I use diff with the  "-w" flag. The only
changes you see should be split lines.

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 4 Katrin Fischer 2022-09-11 13:12:07 UTC
Created attachment 140396 [details] [review]
Bug 30304: (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: Katrin Fischer <katrin.fischer.83@web.de>
Comment 5 Katrin Fischer 2022-10-01 19:29:28 UTC
Created attachment 141181 [details] [review]
k
Comment 6 Katrin Fischer 2022-10-01 19:30:56 UTC
I didn't realize that I had already signed off...
Comment 7 Lucas Gass 2022-10-03 14:57:08 UTC
These changes look good. The diff is is good. 

I also checked this through the W3 HTML validator. There is some warnings that are new to me:

"Self-closing tag syntax in text/html documents is widely discouraged; it’s unnecessary and interacts badly with other HTML features"

If we need to change the self ending tags I think we should do so in a separate bug report. Or maybe, since it is a warning, it is not necessary to address?

Either way, I am passing QA on this one.
Comment 8 Lucas Gass 2022-10-03 14:59:00 UTC
Created attachment 141271 [details] [review]
Bug 30304: Reindent lists template in the staff interface

This patch performs general template cleanup to the lists template:
Make indentation consistent, replace tabs with spaces, and trim trailing
whitespace.

To test, apply the patch and test all aspects of the lists pages,
including:

- Viewing the list of public and private lists.
- List of lists DataTable controls: Paging, filtering, sorting.
- Add, edit and delete lists.
- View list contents.
- Remove titles from a list.
- Place hold from a list.
- Add items to a list.

Use your preferred method for checking the differences between files
while ignoring whitespace. I use diff with the  "-w" flag. The only
changes you see should be split lines.

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>

Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
Comment 9 Lucas Gass 2022-10-03 14:59:05 UTC
Created attachment 141272 [details] [review]
Bug 30304: (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: Katrin Fischer <katrin.fischer.83@web.de>

Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
Comment 10 Tomás Cohen Arazi 2022-10-03 15:41:54 UTC
Pushed to master for 22.11.

Nice work everyone, thanks!