Skip to content
Mark Lilback edited this page Nov 24, 2016 · 1 revision

Local help index

In the help directory, indexDocs.pl is a perl script to generate a json file with the help information necessary to make an index to search. These files are checked into git. The createHelpIndex target parses these files and creates an sqllite db that is embedded in the application for searching help.

The perl script requires Cpanel::JSON::XS and Statistics::R.

Remote help pages

Help pages are currently stored on a remote server. The URL for help documentation on the web is part of info.plist.

Generating remote help files

cd R-3.3.1
./configure --enable-prebuilt-html
make
tar zcf rdocs.tgz doc library/*/html/*
# cd destination-directory
tar xzf rdocs.tgz
Clone this wiki locally