← Back to branch summary

~efargaspro/+junk/codeblocks-16.01-release

« back to all changes in this revision

Viewing changes to src/plugins/contrib/help_plugin/manifest.xml

  • Committer: damienlmoore at gmail
  • Date: 2016-02-02 02:43:22 UTC
  • Revision ID: damienlmoore@gmail.com-20160202024322-yql5qmtbwdyamdwd
Code::Blocks 16.01

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/plugins/contrib/help_plugin/manifest.xml
 
1
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
 
2
<CodeBlocks_plugin_manifest_file>
 
3
    <SdkVersion major="1" minor="10" release="0" />
 
4
    <Plugin name="HelpPlugin">
 
5
        <Value title="Help plugin" />
 
6
        <Value version="1.1" />
 
7
        <Value description="This plugin is used to add a list of help files to the Help menu so you can have them handy to launch.
 
8
 
 
9
You can also set one of the help files as the default help file, and that way it'll be launched when you press F1.
 
10
NOTE: you can add any file you want, and it'll be launched with the associated application.
 
11
 
 
12
It'll also integrate in the context menu of the editor (right click) enabling you to search the word under the cursor in any of the help files.
 
13
NOTE: it's meaningful under Windows for help files with extension hlp or chm, and for any platform when the help file is an URL, a man page or a line to be executed (read below).
 
14
 
 
15
To add an URL as a help file, add a new help file as usual BUT choose NO when prompted for browsing the help file. Be sure the new help file is selected and enter the URL in the text entry (the one followed by the ... button).
 
16
 
 
17
In addition you can also add a whole line to be executed just like you add URLs. Just be sure to check &quot;This line represents a full command to be executed&quot; for that help file.
 
18
 
 
19
It's also possible to add man pages to the help plugin. To do this, follow the same steps to add an URL, but use the following syntax:
 
20
  man:dir
 
21
where dir is the path to the directory that has all the man pages. If you want to add more directories you just need to separate them with a semicolon (;). Just be sure the man pages are in plain text, GZip or BZip2. On *nix systems you would most likely add this one:
 
22
  man:/usr/share/man
 
23
 
 
24
Have in mind that looking for man pages is done recursively, so use it carefully.
 
25
 
 
26
TIP: you can add $(keyword) in any place of the path to the help file, URL or line to execute, any number of times, and it'll get replaced by the word you selected to locate in that help file.
 
27
 
 
28
The configuration dialog for this plugin can be found clicking on Settings -> Environment (Help files)." />
 
29
        <Value author="Bourricot | Ceniza (maintainer)" />
 
30
        <Value authorEmail="ceniza666@gmail.com" />
 
31
        <Value authorWebsite="www.codeblocks.org" />
 
32
        <Value thanksTo="Codeblocks dev team!
 
33
Bourricot for the initial version
 
34
KDE dev team for the man2html code" />
 
35
        <Value license="GPL" />
 
36
    </Plugin>
 
37
</CodeBlocks_plugin_manifest_file>