[Bug 41532] New: Standarise the website placeholder used in the manual to refer to the OPAC and staff interface
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 Bug ID: 41532 Summary: Standarise the website placeholder used in the manual to refer to the OPAC and staff interface Initiative type: --- Sponsorship --- status: Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: normal Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: david@davidnind.com QA Contact: testopia@bugs.koha-community.org CC: aude.charillon@openfifth.co.uk, david@davidnind.com, philip.orr@lmscloud.de The manual use **17** different website placeholders when referring to the OPAC and staff interface URL. These are the current variations: - YOUR_KOHA_OPAC_URL - YOURKOHACATALOG - YOURSITE - reference to OPAC URL - YOUROPAC - your-koha-staff-interface - your_koha_address - your-koha-staff-client-url - YOUR.OPAC.URL - default.tld - www.mylib.com - koha-pro.tld - www.mylibrarysite.com - YOURCATLOG - mykohaopac.org - yourlibraryurl (I added another one!) - staff.mylibrary.example.com - myserver.com For consistency, we should decide on a single placeholder to use. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs documenting -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|Standarise the website |Standardize the website URL |placeholder used in the |placeholder used in the |manual to refer to the OPAC |manual to refer to the OPAC |and staff interface |and staff interface -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |Academy CC| |caroline.cyr-la-rose@inlibr | |o.com --- Comment #1 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- I searched in our MM conversations and it seems that this was what was chosen : opac.library.org staff-interface.library.org Make sure the link is not clickable. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 Aude Charillon <aude.charillon@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- CC|aude.charillon@openfifth.co | |.uk | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #2 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- To make them non clickable, we will use the inline code format :code:`https://opac.library.org` -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #3 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- Added the placeholders and formatting in the wiki https://wiki.koha-community.org/wiki/ReStructuredText_-_Tips_and_Tricks#Exam... -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 David Liddle <david_liddle@sil.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david_liddle@sil.org --- Comment #4 from David Liddle <david_liddle@sil.org> --- (In reply to Caroline Cyr La Rose from comment #1)
I searched in our MM conversations and it seems that this was what was chosen :
opac.library.org
staff-interface.library.org
Make sure the link is not clickable.
After the KohaCon session in which this bug was used to help people get acquainted with the process of editing the manual, I put more thought into the URLs that were chosen. The TLD library.org is a domain that is available for purchase. If a malicious party was to acquire it, they could use redirects to send anyone to sites of their choosing. I know of an organization that retired a TLD that had been widely used for some core systems. It gave up the domain and, sure enough, it is now being used in malicious redirects. The old URLs still can be found in documents and on sites, and people who click them are sent to sites full of harmful stuff. Despite the fact that the links in the Koha manual are supposed to be not clickable, the safest way to proceed would be to use a TLD officially reserved for this purpose, such as example.org. See https://www.iana.org/domains/reserved for more information. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #5 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- (In reply to David Liddle from comment #4)
(In reply to Caroline Cyr La Rose from comment #1)
I searched in our MM conversations and it seems that this was what was chosen :
opac.library.org
staff-interface.library.org
Make sure the link is not clickable.
After the KohaCon session in which this bug was used to help people get acquainted with the process of editing the manual, I put more thought into the URLs that were chosen. The TLD library.org is a domain that is available for purchase. If a malicious party was to acquire it, they could use redirects to send anyone to sites of their choosing.
I know of an organization that retired a TLD that had been widely used for some core systems. It gave up the domain and, sure enough, it is now being used in malicious redirects. The old URLs still can be found in documents and on sites, and people who click them are sent to sites full of harmful stuff.
Despite the fact that the links in the Koha manual are supposed to be not clickable, the safest way to proceed would be to use a TLD officially reserved for this purpose, such as example.org. See https://www.iana.org/domains/reserved for more information.
Thanks David, I added the point to the next docs team meeting agenda for discussion -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #6 from David Liddle <david_liddle@sil.org> --- While addressing Bug 43186, I also noticed one of the oddball URLs in the preceding paragraph and cleaned it up. Merge request: https://gitlab.com/koha-community/koha-manual/-/merge_requests/1270 -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #7 from David Liddle <david_liddle@sil.org> --- NOTE on the entry: - myserver.com While working on Bug 43186 in the section "OAI-PMH", I noticed instances of "myserver.com" in the section "SRU server". In this case, "myserver.com" refers to an generic external server, not the reader's Koha server. A domain such as "sru-server.example.com" may be more appropriate here. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #8 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- Discussed at the october 2026 documentation meeting. We decided to use opac.example.org and staff-interface.example.org Because example.com and example.org are both reserved for specifically this purpose. We chose .org over .com because of the general non-commercial purpose of libraries. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 David Liddle <david_liddle@sil.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Documentation| |David Liddle contact| | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #9 from David Liddle <david_liddle@sil.org> --- In the course of tracking down stray URLs, I found another one: - YOUR\_KOHA\_OPAC\_URL I purposely did NOT replace the following, since they are copied directly from a Perl script, https://perldoc.koha-community.org/misc/cronjobs/check-url-quick.html: - default.tld - www.mylib.com - koha-pro.tld However, I did ensure that they're not clickable. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 --- Comment #10 from David Liddle <david_liddle@sil.org> --- And, for the record, another: - your\_koha\_address -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41532 David Liddle <david_liddle@sil.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Documentation| |https://gitlab.com/koha-com submission| |munity/koha-manual/-/merge_ | |requests/1275 -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org