If you have used the AccuRev Java client on-line help in releases previous to 5.2, you will notice a number of differences. If you have used recent versions of the AccuRev Web UI, or the “manuals” help that was introduced AccuRev Releases 4.9 and 5.1, you might recognize some of the features, and notice that all AccuRev help has now been standardized on a single platform.
• We have brought back a PDF version of the GUI Help documentation, which was removed from the doc set several releases ago. This PDF, named the AccuRev On-Line Help Guide, is now a standard part of the AccuRev documentation set, just like the Administrator’s Guide or the CLI User’s Guide.
• The entire document set (except for AccuBridge, WebUI Help, and Release Note documents) are now packaged together with the on-line help, and can be searched and viewed with a single mechanism. The Contents and Index from all documents are now available from tabs displayed in the help window navigation pane. If you want to find all references to “Change Packages”, you can enter this query in the Search tab, and find all references to this term across all six of the books in the documentation set. (And the results are weighted with a “relevance score”, so you avoid wasting time looking at relatively minor references). If you use a browser that accepts cookies from a local file system, you will also see a Favorites tab in the navigation page, which allows you to store links to frequently-accessed topics.
• We can now provide cross-links between the on-line help and the doc set, so if a help discussion refers to a chapter in the Administrator’s Guide, you can click on a link and be taken directly to that discussion.Since the new Help system is now based on the same document source as the rest of the documentation set, it is easier for us to share content between documents, and to consolidate rendundant sections. Expect the documentation to undergo constant reorganization and improvement in future releases.The new help system provides both HTML and PDF versions of all documents. Whenever you have an AccuRev help window open, you can access the PDF for the currently displayed document by clicking the PDF buttonin the upper-right of the Help window.
To achieve this integration, the help system installs its PDFs in document-specific subfolders on the client machine, such as <accurev_install>/doc/WebHelp/AccuRev_Admin/AccuRev_Admin.pdf, <accurev_install>/doc/manual_help/AccuRev_User_CLI/AccuRev_User_CLI.pdf, etc.However, long time users of AccuRev are accustomed to finding all AccuRev documentation PDFs at <accurev_install>/doc. We heard from Release 4.9 users that the new, nested folders were too hard to access, so we now also provide a copy of the PDFs (including the new On-Line Help Guide) in the traditional <accurev_install>/doc directory.Also, Windows users who are acccustomed to having direct access to the PDFs through the Start -> AccuRev menu will find that this avenue is still available.
AccuRev, Inc. |
Phone: 781-861-8700 |
Fax: 781-861-8704 |
support@accurev.com |