1.10.7 Including external help files

CodeBlocks

previous page next page

[Contents] CodeBlocks Manual [Search] Search

1.10.7 Including external help files

The CodeBlocks development environment supports the inclusion of external help files via the menu ’Settings’ /’Environment’ . Include the manual of your choice in the chm format in ’Help Files’ select ’this is the default help file’ (see Figure 1.9). The entry $(keyword) is a placeholder for a select item in your editor. Now you can select a function in an opened source file in CodeBlocks by mouse-click, and the corresponding documentation will appear while pressing F1.

If you have included multiple help files, you can select a term in the editor and choose a help file from the context menu ’Locate in’ for CodeBlocks to search in.

Figure 1.9: Settings for help files

In CodeBlocks you can add even support for man pages. Just add a entry ’man’ and specify the path as follows.

man:/usr/share/man

CodeBlocks provides an ’Embedded HTML Viewer’, which can be used to display simple html file and find keywords within this file. Just configure the path to the html file, which should be parsed and enable the checkbox ’Open this file with embedded help viewer’ via the menu ’Settings’ /’Environment’ /’Help Files’ .

Figure 1.10: Embedded HTML Viewer

Note:
If you select a html file with a double-click within the file explorer (see section 2.7) then the embedded html viewer will be started, as long as no association for html files is made in file extensions handler.

[Previous] 1.10.6 Symbol view
[Next] 1.10.8 Including external tools

previous page start next page