This is a guide to getting up and running quickly with CodeSnip.
If you have not already done so, you need to get an up to date copy of the CodeSnip database. You will know if this is the case because the program will display a message to that effect when it first starts. Use the Update From Web dialog box, reached from the Database | Update From Web menu option.
If you need CodeSnip to access the internet via a Proxy Server you should use the Tools | Proxy Server menu option and enter information and the proxy in the resulting Proxy Server Configuration dialog box.
You can add your own snippets to the database. These snippets are held separately to the main database and are not affected by database updates. If you wish you can submit user defined code to be considered for inclusion in the main database.
Add, edit and delete snippets using the appropriate menu items on the Database menu. You can also save, backup and restore the user database from this menu.
Snippets can be categorised using any of the available categories or you can defined your own.
Make sure you have the Information tab of the Detail Pane selected.
All the snippets in the database are displayed in the Overview Pane, grouped in different ways depending on which tab is selected. Select the name of a snippet in the Overview Pane to display its source code, description and other information in the Detail Pane. Any snippets required to compile the displayed snippet are listed in the "Required snippets" section. Clicking a snippet's name displays its details. Similar snippets are accessible in the "See also" section. The compilers the snippet is known to compile with are inidacted at the bottom of the display.
Clicking a section heading in the Overview Pane displays a table listing all the snippets in that section in the Detail Pane. Clicking any snippet name will display the snippet's details.
You can search the database for specific words, for snippets that compile (or don't compile) under certain compilers or for cross-referenced snippets. Use the Find Text, Find Compiler or File Cross References dialog boxes to perform a search. These dialogs are accessed via the Search menu.
When a search has been performed only those snippets that are found are listed in the Overview Pane. When a text search is performed the found words are highlighted in the detail pane.
To cancel a search and view all the database again, select the Search | Show All menu item.
When any snippet is selected you can test it with any supported compilers currently installed on your computer, provided it is not a freeform snippet. To do this you must first have configured CodeSnip to work with your compilers by providing the required information in the Configure Compilers dialog box.
To perform a test compilation select the required snippet in the Overview pane. Then select the Compiler Checks tab in the Detail Pane. The program will display a list of all supported compilers along with "LEDs" that indicate which compilers should compile the snippet.
Click the Test Compile Snippet link to perform the compilation. This may take a few seconds. Once the last compilation has completed the display will change to show the results. If the compilation failed, or resulted in warnings, a link will appear that will report the errors or warnings generated by the compiler.
CodeSnip can export snippets or complete units, as follows: