Bug 37149 - Add pointer to Wiki for SIP2config.xml
Summary: Add pointer to Wiki for SIP2config.xml
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low enhancement
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-06-21 12:27 UTC by Alexander Wagner
Modified: 2025-06-02 20:45 UTC (History)
3 users (show)

See Also:
GIT URL:
Initiative type: ---
Sponsorship status: ---
Comma delimited list of Sponsors:
Crowdfunding goal: 0
Crowdfunding committed: 0
Crowdfunding contact:
Patch complexity: ---
Documentation contact: Emmanuel Bétemps
Documentation submission: https://gitlab.com/koha-community/koha-manual/-/merge_requests/892
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Alexander Wagner 2024-06-21 12:27:29 UTC
The Koha Wiki holds a quite extensive description of all possible parameters for the `SIP2config.xml` that dives into a lot more details than the current manual at https://koha-community.org/manual/latest/en/html/apis_protocols.html#sip2

Most likely, the wiki is too detailed for the general use and the current documentation is fine in this regard. (I even need only a subset of those from the manual.)

However, as the screenshot in the manual

https://koha-community.org/manual/latest/en/html/_images/accounts.png

displays quite a bunch of parameters a pointer to the Wiki would probably be a good idea, especially as some parameters seem to address and solve quite some specific needs. Probably some "further technical reading"-link?
Comment 1 Aude Charillon 2024-06-21 13:07:41 UTC
Thank you for pointing this out, Alexander! I totally agree with the suggestion of adding a link to the Wiki from the Manual; we try to do that in the Manual wherever we can.

Just to confirm: was it https://wiki.koha-community.org/wiki/SIP2_configuration you were thinking about on the Koha Wiki?

Do you remember on which page of the manual that screenshot appears, by any chance? (If not, don't worry, we'll find it.)

We (the Documentation team) might keep this suggestion on file for beginner Documenters; it's a nice easy one to start with. Or if you fancy doing it yourself... instructions are at https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual and our next online workshop is on 30 July 2024 https://wiki.koha-community.org/wiki/Documentation_Team_-_Drop-in_sessions ;-)
Comment 2 Alexander Wagner 2024-06-21 13:21:30 UTC
> Just to confirm: was it https://wiki.koha-community.org/wiki/SIP2_configuration you were thinking about on the Koha Wiki?

Yes. Sorry, I missed to add that link in the first place.

There are also some quite helpful hints at

https://wiki.koha-community.org/wiki/Koha_SIP2_server_setup

especially wrt. the pointer to the `sip_cli_emulator` that really comes in handy if you're not that happy to key in lengthy SIP-lines as suggested in the manual in the section on SIP command syntax. (Wished I had that years ago when I _had to_ use telnet and the PDF from this other company...)

However, beyond the hint to the cli emulator

https://wiki.koha-community.org/wiki/Koha_SIP2_server_setup

seems a bit date. (But _very well_ indexed, as I found the wiki before I found the manual ;)


> Or if you fancy doing it yourself... instructions are at https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual and our next online workshop is on 30 July 2024 https://wiki.koha-community.org/wiki/Documentation_Team_-_Drop-in_sessions

In principle I'm pretty open to that as well, but I'll need a thorough read on your conventions first to avoid screwing things up. (And I admit that currently I am a bit on a schedule due to our migration, so I can't promise much at the moment. But already created a bug for j2k.)
Comment 3 Aude Charillon 2024-06-21 13:24:13 UTC
Thanks a lot! And all the best with the migration :)
Comment 4 Emmanuel Bétemps 2024-07-10 13:59:52 UTC
Added to main manual