Hi,

to be usable offline is one of the main targets of QMapShack. Therfore 
providing an offline documentation would fit in.

I just want to give some aspects to consider:

* The documentation is maintained online in the wiki exclusively. It shouldn't 
be a problem to add the wiki repo as a subrepo of the source repo. By that a 
pull will update the local version of the wiki, too.

* The conversion from markdown to html should be done as part of the make 
process. It is up to investigation how to tweak cmake.

* The conversion from markdown to html should also work for the two actively 
supported ports OS X and Windows.

* The offline documentation should be installed where ever it is appropiate 
(Probably a package maintainer can give you a clue). This has to be aligned 
with the package maintainers of the OS X and Windows port, too.

I can't tell if it is worth the work. I have the impression that the 
documentation is hardly read by users. Most things can be explored quite 
intuitively. Others, like installing maps, need documentation. But most likely 
this is at a very early stage of using QMapShack and therefore the online 
version is ok.

just my 2 cents

Oliver


Am Samstag, 12. März 2016, 16:21:30 schrieb Dr Rainer Woitok:
> Greetings,
> 
> currently QMapShack only provides online documentation via
> 
>    https://bitbucket.org/maproom/qmapshack/wiki/
> 
> Being a fan of not depending on an internet connection when reading doc-
> umentation I recently cloned  the documentation wiki repository.  But to
> use this repository as offline documentation  requires considerably more
> work than just to convert the "*.md" files to "*.html" files.
> 
> Meanwhile I have a set of patches  for this repository  which locally do
> what's necessary,  but it would not make much sense to simply push these
> patches upstream.
> 
> And before I invest more time  into this little project  I would like to
> make sure there's sufficient public interest  in using offline document-
> ation at all.
> 
> So what are other users' opinions?
> 
> Sincerely,
>   Rainer
> 
> ----------------------------------------------------------------------------
> -- Transform Data into Opportunity.
> Accelerate data analysis in your applications with
> Intel Data Analytics Acceleration Library.
> Click to learn more.
> http://pubads.g.doubleclick.net/gampad/clk?id=278785111&iu=/4140
> _______________________________________________
> Qlandkartegt-users mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users


------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785111&iu=/4140
_______________________________________________
Qlandkartegt-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users

Reply via email to