Bug 33393 - Modify sentence above the order table in English 1-page order PDF
Summary: Modify sentence above the order table in English 1-page order PDF
Status: Signed Off
Alias: None
Product: Koha
Classification: Unclassified
Component: Acquisitions (show other bugs)
Version: master
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Alex Buckley
QA Contact: Testopia
URL:
Keywords:
Depends on: 33340
Blocks:
  Show dependency treegraph
 
Reported: 2023-04-03 00:59 UTC by Alex Buckley
Modified: 2023-05-02 21:55 UTC (History)
1 user (show)

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


Attachments
Bug 33393: Add system preference (3.38 KB, patch)
2023-04-03 03:37 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF (59.22 KB, patch)
2023-04-03 03:38 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF (59.51 KB, patch)
2023-04-03 04:37 UTC, Alex Buckley
Details | Diff | Splinter Review
Custom text (highlighted yellow) that can be set in the 1PageOrderPDFText syspref with bug 33393 applied (133.48 KB, image/png)
2023-04-03 04:39 UTC, Alex Buckley
Details
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF (59.56 KB, patch)
2023-04-03 20:52 UTC, David Nind
Details | Diff | Splinter Review
Bug 33393: Add note to system preference explaining text length (1.25 KB, patch)
2023-05-02 05:58 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 33393: Add system preference (3.42 KB, patch)
2023-05-02 17:01 UTC, David Nind
Details | Diff | Splinter Review
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF (59.56 KB, patch)
2023-05-02 17:01 UTC, David Nind
Details | Diff | Splinter Review
Bug 33393: Add note to system preference explaining text length (1.29 KB, patch)
2023-05-02 17:01 UTC, David Nind
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Alex Buckley 2023-04-03 00:59:02 UTC
It would nice if libraries could edit the 'Order number must appear on all related correspondence, shipping papers and invoices. Notify us immediately if
you are unable to supply item(s).' line in the English 1-page order PDF to wording relevant to their library.
Comment 1 Alex Buckley 2023-04-03 03:37:52 UTC
Created attachment 149076 [details] [review]
Bug 33393: Add system preference

Sponsored-by: Pymble Ladies' College
Comment 2 Alex Buckley 2023-04-03 03:38:09 UTC
Created attachment 149077 [details] [review]
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF

Test plan:
1) Apply patches and restart services
2) Upgrade Koha schema:
sudo koha-upgrade-schema <instance>
3) Go to Koha Administration -> Libraries. Ensure Library A has an
address, phone and fax.
4) Go to Koha Administration -> System preferences. Search for
OrderPdfFormat. Set this to English 1-page layout option.
5) Go to Acquisitions. Use an existing vendor or create a new one.
Ensure the vendor has a postal address, phone, fax and accout number.
6) Create a basket for this vendor. Add many orders to this basket, for
example 25 items (this is to make the Order PDF cover multiple pages).
7) Close the basket and add it to a basket group of the same name.
8) Edit the basket group. Add an address in the delivery place, and a
delivery comment. Check the box to close the basket group and Save.
9) Click the button to Export as PDF.
10) View the exported PDF. Confirm the PDF is multiple pages long. If it
is not then re-open the basketgroup and add more orders to the basket
and repeat steps 7, 8, and 9
11) If the PDF is multiple pages long then confirm:
- The text "Order number must appear on all related correspondence, shipping papers and invoices. Notify us immediately if you are unable to supply item(s)." appears above the order table.
- The page numbers at the bottom of the first page are not obscured by
the order table.
- That the order table starts near the top of the second page, and not
half way down.
12) Change content in the '1PageOrderPDFText' syspref (use the Enter key
    to split text over multiple lines) and save
13) Back in the Acquisitions module click the button to Export as PDF
14) View the exported PDF. Confirm the following:
- Text text above the order table has changed.
- The page numbers at the bottom of the first page are not obscrued by
the order table.
- That the order table starts near the top of the second page and not
halfway down.

Sponsored-by: Pymble Ladies' College
Comment 3 Alex Buckley 2023-04-03 04:37:12 UTC
Created attachment 149078 [details] [review]
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF

Test plan:
1) Apply patches and restart services
2) Upgrade Koha schema:
sudo koha-upgrade-schema <instance>
3) Go to Koha Administration -> Libraries. Ensure Library A has an
address, phone and fax.
4) Go to Koha Administration -> System preferences. Search for
OrderPdfFormat. Set this to English 1-page layout option.
5) Go to Acquisitions. Use an existing vendor or create a new one.
Ensure the vendor has a postal address, phone, fax and accout number.
6) Create a basket for this vendor. Add many orders to this basket, for
example 25 items (this is to make the Order PDF cover multiple pages).
7) Close the basket and add it to a basket group of the same name.
8) Edit the basket group. Add an address in the delivery place, and a
delivery comment. Check the box to close the basket group and Save.
9) Click the button to Export as PDF.
10) View the exported PDF. Confirm the PDF is multiple pages long. If it
is not then re-open the basketgroup and add more orders to the basket
and repeat steps 7, 8, and 9
11) If the PDF is multiple pages long then confirm:
- The text "Order number must appear on all related correspondence, shipping papers and invoices. Notify us immediately if you are unable to supply item(s)." appears above the order table.
- The page numbers at the bottom of the first page are not obscured by
the order table.
- That the order table starts near the top of the second page, and not
half way down.
12) Change content in the '1PageOrderPDFText' syspref (use the Enter key
    to split text over multiple lines) and save
13) Back in the Acquisitions module click the button to Export as PDF
14) View the exported PDF. Confirm the following:
- The text above the order table is what you saved in the
1PageOrderPDFText system preference
- The page numbers at the bottom of the first page are not obscrued by
the order table.
- That the order table starts near the top of the second page and not
halfway down.
15) Empty the 1PageOrderPDFText system preference and save
16) Back in the Acquisitions module click te button to Export as PDF
17) View the exported PDF and confirm the line of text between the
Tel/Fax line and the order table has been removed.

Sponsored-by: Pymble Ladies' College
Comment 4 Alex Buckley 2023-04-03 04:39:15 UTC
Created attachment 149079 [details]
Custom text (highlighted yellow) that can be set in the 1PageOrderPDFText syspref with bug 33393 applied
Comment 5 David Nind 2023-04-03 20:52:14 UTC
Created attachment 149106 [details] [review]
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF

Test plan:
1) Apply patches and restart services
2) Upgrade Koha schema:
sudo koha-upgrade-schema <instance>
3) Go to Koha Administration -> Libraries. Ensure Library A has an
address, phone and fax.
4) Go to Koha Administration -> System preferences. Search for
OrderPdfFormat. Set this to English 1-page layout option.
5) Go to Acquisitions. Use an existing vendor or create a new one.
Ensure the vendor has a postal address, phone, fax and accout number.
6) Create a basket for this vendor. Add many orders to this basket, for
example 25 items (this is to make the Order PDF cover multiple pages).
7) Close the basket and add it to a basket group of the same name.
8) Edit the basket group. Add an address in the delivery place, and a
delivery comment. Check the box to close the basket group and Save.
9) Click the button to Export as PDF.
10) View the exported PDF. Confirm the PDF is multiple pages long. If it
is not then re-open the basketgroup and add more orders to the basket
and repeat steps 7, 8, and 9
11) If the PDF is multiple pages long then confirm:
- The text "Order number must appear on all related correspondence, shipping papers and invoices. Notify us immediately if you are unable to supply item(s)." appears above the order table.
- The page numbers at the bottom of the first page are not obscured by
the order table.
- That the order table starts near the top of the second page, and not
half way down.
12) Change content in the '1PageOrderPDFText' syspref (use the Enter key
    to split text over multiple lines) and save
13) Back in the Acquisitions module click the button to Export as PDF
14) View the exported PDF. Confirm the following:
- The text above the order table is what you saved in the
1PageOrderPDFText system preference
- The page numbers at the bottom of the first page are not obscrued by
the order table.
- That the order table starts near the top of the second page and not
halfway down.
15) Empty the 1PageOrderPDFText system preference and save
16) Back in the Acquisitions module click te button to Export as PDF
17) View the exported PDF and confirm the line of text between the
Tel/Fax line and the order table has been removed.

Sponsored-by: Pymble Ladies' College
Signed-off-by: David Nind <david@davidnind.com>
Comment 6 David Nind 2023-04-03 20:55:38 UTC
Hi Alex.

This works well.

My only comment would be to add a hint or note to the 1PageOrderPDFText system preference about the length of the text.

I added multiple long paragraphs and the text was cut off where the order table starts, and does not display the delivery comment.

David
Comment 7 Alex Buckley 2023-04-13 04:49:24 UTC
(In reply to David Nind from comment #6)
> Hi Alex.
> 
> This works well.
> 
> My only comment would be to add a hint or note to the 1PageOrderPDFText
> system preference about the length of the text.
> 
> I added multiple long paragraphs and the text was cut off where the order
> table starts, and does not display the delivery comment.
> 
> David

Hi David, 

That is a great idea. Thanks for that. I will add a follow-up patch with that addition.

Alex
Comment 8 Alex Buckley 2023-05-02 05:58:12 UTC
Created attachment 150497 [details] [review]
Bug 33393: Add note to system preference explaining text length

Sponsored-by: Pymble Ladies' College
Comment 9 Alex Buckley 2023-05-02 06:01:04 UTC
Hi David, 

I have attached a patchset adding a note to the system preference description noting to keep the text length to 3 lines. 

Is that what you had in mind?

Thanks,
Alex
Comment 10 David Nind 2023-05-02 17:01:45 UTC
Created attachment 150524 [details] [review]
Bug 33393: Add system preference

Sponsored-by: Pymble Ladies' College
Signed-off-by: David Nind <david@davidnind.com>
Comment 11 David Nind 2023-05-02 17:01:48 UTC
Created attachment 150525 [details] [review]
Bug 33393: Enable libraries to configure their own text in the 1-Page order PDF

Test plan:
1) Apply patches and restart services
2) Upgrade Koha schema:
sudo koha-upgrade-schema <instance>
3) Go to Koha Administration -> Libraries. Ensure Library A has an
address, phone and fax.
4) Go to Koha Administration -> System preferences. Search for
OrderPdfFormat. Set this to English 1-page layout option.
5) Go to Acquisitions. Use an existing vendor or create a new one.
Ensure the vendor has a postal address, phone, fax and accout number.
6) Create a basket for this vendor. Add many orders to this basket, for
example 25 items (this is to make the Order PDF cover multiple pages).
7) Close the basket and add it to a basket group of the same name.
8) Edit the basket group. Add an address in the delivery place, and a
delivery comment. Check the box to close the basket group and Save.
9) Click the button to Export as PDF.
10) View the exported PDF. Confirm the PDF is multiple pages long. If it
is not then re-open the basketgroup and add more orders to the basket
and repeat steps 7, 8, and 9
11) If the PDF is multiple pages long then confirm:
- The text "Order number must appear on all related correspondence, shipping papers and invoices. Notify us immediately if you are unable to supply item(s)." appears above the order table.
- The page numbers at the bottom of the first page are not obscured by
the order table.
- That the order table starts near the top of the second page, and not
half way down.
12) Change content in the '1PageOrderPDFText' syspref (use the Enter key
    to split text over multiple lines) and save
13) Back in the Acquisitions module click the button to Export as PDF
14) View the exported PDF. Confirm the following:
- The text above the order table is what you saved in the
1PageOrderPDFText system preference
- The page numbers at the bottom of the first page are not obscrued by
the order table.
- That the order table starts near the top of the second page and not
halfway down.
15) Empty the 1PageOrderPDFText system preference and save
16) Back in the Acquisitions module click te button to Export as PDF
17) View the exported PDF and confirm the line of text between the
Tel/Fax line and the order table has been removed.

Sponsored-by: Pymble Ladies' College
Signed-off-by: David Nind <david@davidnind.com>
Comment 12 David Nind 2023-05-02 17:01:51 UTC
Created attachment 150526 [details] [review]
Bug 33393: Add note to system preference explaining text length

Sponsored-by: Pymble Ladies' College
Signed-off-by: David Nind <david@davidnind.com>
Comment 13 David Nind 2023-05-02 17:02:33 UTC
(In reply to Alex Buckley from comment #9)
> Hi David, 
> 
> I have attached a patchset adding a note to the system preference
> description noting to keep the text length to 3 lines. 
> 
> Is that what you had in mind?
> 
> Thanks,
> Alex

That looks fine to me. Thanks Alex!
Comment 14 Alex Buckley 2023-05-02 21:55:16 UTC
(In reply to David Nind from comment #13)
> (In reply to Alex Buckley from comment #9)
> > Hi David, 
> > 
> > I have attached a patchset adding a note to the system preference
> > description noting to keep the text length to 3 lines. 
> > 
> > Is that what you had in mind?
> > 
> > Thanks,
> > Alex
> 
> That looks fine to me. Thanks Alex!

Thanks so much David!