Bug 14234 - Include the user manual with Koha package
Summary: Include the user manual with Koha package
Status: NEW
Alias: None
Product: Koha
Classification: Unclassified
Component: Packaging (show other bugs)
Version: master
Hardware: All All
: P5 - low new feature (vote)
Assignee: Indranil Das Gupta
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-05-20 08:13 UTC by Indranil Das Gupta
Modified: 2020-01-07 21:47 UTC (History)
4 users (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Indranil Das Gupta 2015-05-20 08:13:36 UTC
At present, Koha's online help documentation includes a link to the topics as presented on the Koha manual hosted at http://manual.koha-community.org/.

This presents a major problem for users who run Koha with intermittent / low bandwidth Internet access, as they are largely unable to access the manual pages. The usual workaround is to locally downloading the Koha manual, which does not solve the issue as the online help topics do not link to a downloaded copy.

Can we consider shipping the manual along with the koha package?
Comment 1 Marc Véron 2015-05-20 08:35:12 UTC
I like the idea.
The help pages then could have two links:
#1 to the local copy
#2 to the online help
Comment 2 Bernardo Gonzalez Kriegel 2015-05-20 12:17:24 UTC
(In reply to Marc Véron from comment #1)
> The help pages then could have two links:
> #1 to the local copy
> #2 to the online help

Perhaps (another) syspref to show local/remote/both links.
3.18 Manual use ~76 MB ( 3 html + 73 images)

If you put it inside intranet DocumentRoot then you could access it 
by http(s)://staff_url/manual/ for example.
We can use also version and/or language

A downloadable version here: http://translate.koha-community.org/manual/3.18/manual-3.18-en.tgz
Comment 3 Indranil Das Gupta 2015-05-20 12:47:46 UTC
(In reply to Bernardo Gonzalez Kriegel from comment #2)
> (In reply to Marc Véron from comment #1)
> > The help pages then could have two links:
> > #1 to the local copy
> > #2 to the online help
> 
> Perhaps (another) syspref to show local/remote/both links.
> 3.18 Manual use ~76 MB ( 3 html + 73 images)
> 
> If you put it inside intranet DocumentRoot then you could access it 
> by http(s)://staff_url/manual/ for example.
> We can use also version and/or language
> 
> A downloadable version here:
> http://translate.koha-community.org/manual/3.18/manual-3.18-en.tgz

We also need to consider the requirement for the l10n-ised manual in languages other than English.
Comment 4 Katrin Fischer 2015-05-21 20:39:56 UTC
Hi Indranil,

this sounds like a nice idea. Could we keep the manual in a separate 'dependency'? So you could choose to install it or not? 
Not sure what would work best for providing different translations.
Comment 5 Katrin Fischer 2017-09-12 13:40:40 UTC
Moving this to packaging as we are using the "documentation" component for bugs that need to go into the manual at the moment.
Comment 6 Katrin Fischer 2020-01-07 21:47:20 UTC
Note: we have no replaced the former help page with links to the manual, but at the same time, we allow to host the manual locally. System preference: KohaManualBaseURL. While you still would have to download it separately, that solves some of the initially reported problem I think.