africanmathsinitiative / R-Instat-Help

The latest uncompiled (.hnd) and compiled (.cmd) versions of the help file for the statistics software package R-Instat
https://chuffed.org/project/africandatainitiative
GNU General Public License v3.0
2 stars 5 forks source link

Linking to resource files installed with R-Instat #26

Open rdstern opened 5 years ago

rdstern commented 5 years ago

In the help menu in R-Instat I assume we will soon be adding to the resources. In particular, as we prepare guides they should all be included, presumably as pdf files?

We have started, with Help > Guides > Case Study Guide and also Glossary. Could we add the tutorial guides - made into pdf from the github versions? Also the installation guide perhaps? Then I will complete the two current climatic guides and also the tweaking guide!

We will soon also have the R-packages guide as a separate entry.

I suggest it is important to have these guides within the software, so users without internet access, still have them all.

The next step is what I am working on now, namely the online help system. Now, here I would like to hyperlink to these guides. This seems possible in the help system. You can give relative, or absolte paths. We don't want absolute paths, but I assume we can give a relative path. He is the information from helpNdoc:

"For a relative part the file must be in a path relative to the main documentation folder. For example setting the relative path to "resources\myfile.txt", so the file must be in the resources sub-folder of the main document file".

Could we start trying this with the next update?

maxwellfundi commented 5 years ago

@rdstern Thats a good idea to have these guides. However am not sure if we need to have the installation guide here because they would need to read this before doing actual installation. What I suggest is to, say have a zipped folder containing R-Instat Installer and Installation instructions that people read before installing.

@ZIRANA11 how easy is it to get a PDF from the wiki? if we get these pdfs then for our next release we can easily put that up and could be a good job for the new programmers.

Its great that you are working on the help now and more documentation and am sure @ZIRANA11 @MainaJohnO would gladly help too with this.