Application-Based Help Files

 

Installing xTuple Desktop Client Help Files

The xTuple Desktop client features a Help menu on the main menu bar. From this Help menu, users may access on-line documentation—that is, assuming the required help files have also been installed. The process for installing help files differs depending on the platform (Windows, Mac or Linux) of the client you are using. See below for instructions on how to install help files for the various platforms supported by xTuple.

Windows Client

You must first locate the directory where you installed your 'xtuple.exe' file. xtuple.exe is the main xTuple application file. Among the various other files in this directory, you should see two files called XTupleGUIClient.qch and XTupleGUIClient.qhc. These files are the default documentation place holders. You need to replace these two files with two new files having the same names. To get the new, replacement help content files, you should download the 'helpXTupleGUIClient.zip' file from the xTuple website. This .zip file contains the two new help content files. Replace the old XTupleGUIClient.qhc and XTupleGUIClient.qch files with the new ones at the same level as the xtuple.exe file. This may require closing any open xTuple sessions before you can replace the files.

Mac Client

The xTuple application for Mac is distributed as a package. To view the contents of the xTuple package, hold down the CTRL key on your keyboard and then click on the package file. From the pop-up menu, select the 'Show Package Contents' option. Inside the Contents\Resources directory, you should see two files called XTupleGUIClient.qch and XTupleGUIClient.qhc. These files are the default documentation place holders. You need to replace these two files with two new files having the same names. To get the new, replacement help content files, you should download the 'helpXTupleGUIClient.zip' file from the xTuple website. This .zip file contains the two new help content files. Replace the old XTupleGUIClient.qhc and XTupleGUIClient.qch files with the new ones in the Contents\ Resources directory. This may require closing any open xTuple sessions before you can replace the files.

Linux Client

Follow the same process as for the Client for Windows. The only difference is the main xTuple application will not have the '.exe' extension.

 
rayeverett's picture
Offline
Joined: 07/18/2011
hyperlinks?

"you should download the 'helpXTupleGUIClient.zip' file from the xTuple website" A hyperlink please? That's how this whole thing works...

 
ossph's picture
Offline
Joined: 05/21/2009
Still can't view help files

Hi:

I have installed 3.7 and downloaded the help files, and pasted the two files it in the folder 'Client' where xtuple.exe resides.
Still, I'm not lucky to view help files.

Please help

 
karlsalt's picture
Offline
Joined: 08/04/2011
hyperlinks

rayeverett, I fell your pain. I found what looks like the correct file at

http://sourceforge.net/projects/postbooks/files/04%20PostBooks-docs/3.7....

Let's see how it works...

 
gsalazar's picture
Offline
Joined: 06/29/2011
Still can't view help files 2

Hi, I did the same like Jeff, following the karlasalt link, but is still not working. Any Idea?

 
ptyler's picture
Offline
Joined: 12/10/2008
Help files on website

All:

You can always read the help files on our website here:

http://www.xtuple.org/docs/reference-guide

Regards,
Pierce

 
Holly's picture
Offline
Joined: 07/13/2011
Windows issue

On Windows, I had to rename the place holder files (added OLD to the end of the existing file names) to get the downloaded files to paste in the folder. I found it cumbersome to use since you can't resize the pane to accommodate the detail. The left pane (TOC) expands, but the right one (detail) does not. (Click on the icon to the left of the X to expand the Help window.)

I ended up changing the metric to load the Ref Guide instead of the 'Welcome' page, so now it's much easier to read.

H

 
rosengardenj's picture
Offline
Joined: 01/29/2014
Loading Help Files - No Joy!

Help;

 

I've read, and followed, the Help File documentation.  I've downloaded the two help files.  I've placed them inside the RESOURCES folder (Mac) replacing the 'place holder' files that were there.

Still no luck.  Even after shutting down the desktop client and restarting any time I select the HELP/Table Of Contents menu choice I get the screen that says they aren't there.

 

Anybody????

 

Thanks much!

 
ptyler's picture
Offline
Joined: 12/10/2008
Help file issue

Hi,

There's a known issue with the app-based help files not working on Mac and Windows (see #20210). We plan to get that fixed soon. Meanwhile, the help files available on our website are current and contain the same content as the app-based help. Here's a link you can use:

http://www.xtuple.org/sites/default/files/refguide/current/index.html

For anyone who prefers .PDF, you can also purchase the help files in the xTuple store:

https://www.xtuple.com/xchange/product/refguide

Best regards,

Pierce

 

mead