 |
 |
Utilities Reference
The AutoDoc viewer can be run as a standalone program, but it is also globally integrated within CodeBench.
When run, the viewer will put a button on the IconBar of each running instance of CodeBench so that it can be easily accessed from anywhere. It does this because only one viewer is run at any time, and all CodeBench instances will use that single version. This makes it very easy to keep all open documents in one accessible place.
The left hand list serves two purposes. When first run, without any open docs, the list will show all AutoDocs it finds in the SDK:Documentation/AutoDocs drawer. You may select any of these for viewing by simply clicking the item of interest, and that doc will be opened in the viewer panel. Just like CodeBench itself, a ClickTab will be created for this doc. Once an AutoDoc is being viewed, the left hand list switches to show the pages within it so that you can navigate around the various sections of the current doc. You will notice that the AutoDoc pages list is also updated in real-time to show you whereabouts in the document you are, and the current page item will be highlighted, just like in the Quick-Link window.
The "Chooser" gadget at the top of the left hand list can be used to switch between the pages or AutoDocs as you see fit. To open more AutoDocs, switch the view in the left hand list with the chooser, and select an doc to view.
You may also open AutoDocs by using the popup menu from the Project list whilst over an AutoDoc.
This will either start a new AutoDoc viewer if one is not running, or it will open the selected AutoDoc in the instance that is detected.
Because the viewer is available to ALL CodeBench versions, simply click the "ADView" button from the IconBar, and the viewer will be be shown. If it is not currently on your screen, then it will jump to the screen that requested it.
When quitting CodeBench, it is not necessary to close or iconify the AutoDoc viewer if it may still be required. It will move off of the CodeBench screen automatically, and return to the Workbench screen.
If you want to move the viewer to a different screen manually, you may use the popup menu option to make it jump to the screen you want. The popup menu is accessed by clicking the "popup" gadget in the window title bar of the viewer.
When iconifying the viewer, an icon will always be placed on the Workbench screen, and this icon can be used to open the viewer again, and also as an drop-point. You may drop AutoDocs on this icon, and they will be opened in the viewer.
The CBShell utility is a small tool that simply sends out a global communication message to all open instances of CodeBench. This in turn will open a new shell on the instance which is currently at the front of the display.
While this tool may have some use elsewhere, it has been primarily supplied to allow a "Shell" shortcut within the IconBar App-Link panel .
While having the ability to visually manipulate the project files which are stored in a remote SVN repository, sometimes checking and viewing files in another repository is required. For this reason, we have included this small browser tool.
When run, you will be presented with a directory requester that will prompt you for a local directory that is either in, or part of, a SVN working copy. Confirming this requester will then use the svntool plugin to browse and manipulate the files in the selected working copy. You may also supply the name of the working copy directory you wish to browse on the command line as the first (and only) argument. "SVNBrowser myapps/myproject" entered as the parameter will skip the directory requester and use the target directory specified, provided it exists. If you make a mistake and enter a directory that doesn't exist, the requester will be shown and you may enter the target from there.
As an added bonus, when running the plugin from the browser, you will also have the option to be able to view any text based files part of that working copy.
The SVNBrowser utility can be added to the App-Links of the IconBar for a quick and easy way to access this functionality.