Documentation Suite Installation Guide
Provides instructions for the installation and customization of the LeasePak Documentation Suite.
Important Note
Read and follow the instructions in Document Load Troubleshooting (document opens in a new window). These instructions will resolve most issues where Web pages in the Documentation Suite are not loading properly, either due to installation problems or to incorrect abridgement or restriction of the Documentation Suite.
The instructions in
Document Load Troubleshooting
are particularly critical if you are installing the Documentation Suite for use with the LeasePak client software (accessing
documentation by pressing F1 from within LeasePak).
Both the printed Release Notes documents and the ReadMe folder include a copy of Document Load Troubleshooting.
Overview
Documentation .zip File and CD
NetSol delivers documentation in one of several ways:
- A .zip file included on the LeasePak software CD. The file name format for the .zip file is
NNa_DocSuite_YYMMDD.zip, where NNa is the version number (for example,62a). - A .zip file sent separately via ftp or possibly e-mail.
- A separate documentation CD containing both the .zip file and the uncompressed docsuite and ReadMe folders.
Contact your NetSol representative if you would like one or more copies of the documentation on CD.
ReadMe Folder
Your CD or .zip file includes a folder called ReadMe. This folder includes all the Release Notes documents in PDF format. You can either print these documents or view them with Adobe Reader, version 6.0 or later (usually included with the supported browsers; also available free from Adobe Systems Incorporated).
Build Sequence Numbers on Release Notes and Addendums
The build sequence numbers published on the Release Notes and addendums correspond to the software build at the time of publication of the Documentation Suite and may reflect an earlier build than the build sequence number indicated on the software CD. The build sequence number on the software CD, however, will always correspond the actual build of the software.
docsuite Parent Folder
The folders for the various Documentation Suite publications, as well as the shared folder, all reside within the parent docsuite folder. Many of the relative URLs within the Documentation Suite refer to this parent directory by position, although not by name. You can rename this directory to indicate a customized (abridged) version or for other reasons as needed, but you must leave the parent folder in place and ensure that users have access to it or documents within the suite (or your abridged version of it) will not load properly.
Publications
The parent docsuite folder includes the following publications:
- LeasePak Reference Guide, refguide folder
- System Administration Guide, sag folder
- LeasePak Database Reference, dbref folder
- mPower Documentation, mpower folder
- Appendices (including the Glossary and LeasePak Man Pages, appendices folder
- Cross-Publication Documents, crosspub folder
shared and systems Folders
The docsuite folder also contains common shared and systems folders. Any customization of the Documentation Suite must leave these folders in place.
Installation
With the exception of a few Microsoft Word documents that NetSol supplies as Document Generation (DocGen) template samples, all the files within the Documentation Suite are text files (HTML, XML, XLS, CSS, JS, or plain text), GIF graphics files, or Adobe PDF documents. You can install the docsuite parent folder, along with its subfolders and files, anywhere that allows a user to access the files using one of the supported Web browsers. This includes:
- Using the Documentation Suite directly from the CD
- Copying the files to:
- an individual user's computer
- a Microsoft Windows network server
- any network server where the user can access the docsuite parent directory and its contents through NFS, Samba, etc.
- Installing the Documentation Suite on your Web server
For instructions on installing the Documentation Suite for use with the LeasePak client software (accessing documentation by pressing F1 from within LeasePak), refer to Mapping a Network Drive for the Documentation Suite in Documentation Load Troubleshooting (document opens in a new window).
Once you've copied the Documentation Suite to your desired location, you can simplify access to it by providing your users with a shortcut to the table of contents. For the Documentation Suite as a whole, this is the docsuite/index.html file. For individual publications within the suite, this is the index.html file under the specific publication's main folder. For example:
- For the Reference Guide, docsuite/refguide/index.html
- For the System Administration Guide, docsuite/sag/index.html
Customization
Abridging or Restricting the Documentation Suite
You can create abridged or restricted versions of the Documentation Suite by removing publication folders under the parent docsuite directory, and you can identify these customized versions by changing the name of the parent docsuite directory.
You can also remove individual document folders from the crosspub directory. NetSol recommends leaving the crosspub directory itself in place.
Do not remove the parent docsuite directory, the shared directory, or the main table of contents (docsuite/index.html). If needed, you can edit docsuite/index.html to delete references to removed publications.
You can install different abridged versions of the Documentation Suite on different locations of your network as needed, allowing you to provide different levels of access to different users. NetSol does not limit the number of copies you can make of the Documentation Suite as long as only authorized LeasePak users and administrators have access to the information.
Suggested Publications for Users
For the following types of users, NetSol recommends providing access to these publications:
- System administrator, mPower administrator,
msiadmin,msidba,lpadmin--all publications (you may wish to remove mPower Documentation if you are not using mPower applications) - LeasePak client user--LeasePak Reference Guide, Cross-Publications Documents (or abridged version)
All users must have access to the shared folder.
Removing Individual Documents
Particularly in the case of the crosspub folder, you may need to remove individual documents. As an alternative to simply deleting the document folder, you may want to create a placeholder document by deleting the contents of the <body></body> tag and replacing them with a message indicating why the document is not available. In this way, users clicking a link to the document will reach a document with an explanation (and standard Documentation Suite navigation) rather than receiving an "HTTP 404 - File not found" message (or worse, a spyware bounce to an unauthorized site).
Search Function
Most documents within the Documentation Suite include a Search button (the exceptions are the Java Call Reference and one or two other documents with the Developer Documentation). Clicking this button goes to docsuite/shared/search/search.htm. This document redirects the user to the search page location, by default the NetSol hosted search. If you are not using the NetSol hosted search, you must edit this document to point to the appropriate location:
<?xml version="1.0" encoding="iso-8859-1"?> <?msi-indexer include="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Link to Search Feature</title> <meta http-equiv="Refresh" content="0;URL=http://mpower.mccue.com/search/v53a" /> <link href="../styles/docsuite.css" rel="stylesheet" type="text/css" /> <script language="JavaScript" type="text/javascript" src="../styles/docsuite.js"></script> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> </head> <body class="nonav"> <h1>Loading search page...</h1> <p><em>If page does not load within 5 seconds, click <a href="http://mpower.mccue.com/search/v53a">here</a>.</em></p> </body> </html>
Edit the link in the <meta> tag and the one in the body of the document (shown in bold). You can use version to
include the LeasePak version number (for example, v52a) for multiple version installations.
Do not change the links if you are using the NetSol hosted search.
NetSol-Hosted Search
NetSol hosts a copy of the Documentation Suite using Apache/Lucene. The htdig software is an open source (C language) program in use at many Web sites. For more information about the software and the organization that supports it, visit www.htdig.org.
Self-Hosted Search
If you wish to set up a Web server with the htdig engine at your site, contact your NetSol representative for system requirements and copies of htdig files configured for use with the Documentation Suite.
Other Search
If you wish to employ a different search engine, you can use it with the Documentation Suite. Edit the links in the file search.htm to point to the correct location and include the parent directory docsuite and its contents in your search program's crawl or indexing function.
LeasePak Documentation Suite
©
by NetSol Technologies Inc. All rights reserved.
The information contained in this document is the property of NetSol Technologies Inc. Use of the information contained herein is restricted. Conditions of use are subject to change without notice. NetSol Technologies Inc. assumes no liability for any inaccuracy that may appear in this document; the contents of this document do not constitute a promise or warranty. The software described in this document is furnished under license and may be used or copied only in accordance with the terms of said license. Unauthorized use, alteration, or reproduction of this document without the written consent of NetSol Technologies Inc. is prohibited.