many enhancements in docs - fixes #38, fixes #51, fixes #52

Clipjump.ahk

@@ -1189,7 +1189,7 @@ actionmode:
 init_actionmode() {
 	ACTIONMODE := {H: "history", S: "channelGUI", O: "channelOrganizer", C: "copyfile", X: "copyfolder", F: "CopyFileData", D: "disable_clipjump"
 		, P: "pitswap", T: "onetime", E: "settings", F1: "hlp", Esc: "Exit_actmd", M: "pluginManager_GUI()", F2: "OpenShortcutsHelp", L: "classTool"
-		, H_caption: TXT.HST__name, S_caption: TXT.SET_chnl, O_caption: TXT.ORG__name, C_caption: TXT._cfilep, X_caption: TXT._cfolderp, F_caption: TXT._cfiled 
+		, H_caption: TXT.HST__name, S_caption: TXT.SET_chnl, O_caption: TXT.SET_org, C_caption: TXT._cfilep, X_caption: TXT._cfolderp, F_caption: TXT._cfiled 
 		, D_caption: TXT.ACT_disable " " PROGNAME, P_caption: TXT._pitswp, T_caption: TXT._ot, E_caption: TXT.SET__name
 		, F1_caption: TXT.TRY_help, Esc_caption: TXT.ACT_exit, M_caption: TXT.PLG__name, F2_caption: TXT.try_pstmdshorts, L_caption: TXT.IGN__name}
 }

chm_files/Contents.hhc

@@ -33,10 +33,6 @@
 			<param name="Name" value="Pasting Formats">
 			<param name="Local" value="docs/basic_help.html#pformat">
 			</OBJECT>
-		<LI> <OBJECT type="text/sitemap">
-			<param name="Name" value="Channel Organizer">
-			<param name="Local" value="docs/organizer.html">
-			</OBJECT>
 	</UL>
 	<LI> <OBJECT type="text/sitemap">
 		<param name="Name" value="Clipjump Channels">
@@ -47,21 +43,29 @@
 			<param name="Local" value="docs/channels.html">
 			</OBJECT>
 		<LI> <OBJECT type="text/sitemap">
-			<param name="Name" value="Changing Channels in Paste Mode">
-			<param name="Local" value="docs/channels.html#chnljumps">
+			<param name="Name" value="Using Channels">
+			<param name="Local" value="docs/channels.html#using">
 			</OBJECT>
 		<LI> <OBJECT type="text/sitemap">
-			<param name="Name" value="The Pit channel">
-			<param name="Local" value="docs/channels.html#pit">
+			<param name="Name" value="Changing Channels in Paste Mode">
+			<param name="Local" value="docs/channels.html#chnljumps">
 			</OBJECT>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="Protected Channels">
 			<param name="Local" value="docs/channels.html#protected">
 			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="The Pit channel">
+			<param name="Local" value="docs/channels.html#pit">
+			</OBJECT>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="PitSwap">
 			<param name="Local" value="docs/channels.html#pitswap">
 			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="Channel Organizer">
+			<param name="Local" value="docs/organizer.html">
+			</OBJECT>
 	</UL>
 	<LI> <OBJECT type="text/sitemap">
 		<param name="Name" value="Clipjump History Tool">
@@ -91,13 +95,17 @@
 			<param name="Name" value="Edit Clip">
 			<param name="Local" value="docs/history.html#editclip">
 			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="Disable History keeping">
+			<param name="Local" value="docs/history.html#dis_his">
+			</OBJECT>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="Modify/Disable History tool shortcut">
 			<param name="Local" value="docs/history.html#his_short">
 			</OBJECT>
 		<LI> <OBJECT type="text/sitemap">
-			<param name="Name" value="Disable History keeping">
-			<param name="Local" value="docs/history.html#dis_his">
+			<param name="Name" value="Global Window Shortcuts">
+			<param name="Local" value="docs/history.html#shorts">
 			</OBJECT>
 	</UL>
 	<LI> <OBJECT type="text/sitemap">
@@ -247,6 +255,16 @@
 			<param name="Name" value="Official Plugins">
 			<param name="Local" value="docs/plugins/index.html#def">
 			</OBJECT>
+		<UL>
+			<LI> <OBJECT type="text/sitemap">
+				<param name="Name" value="Common Formats">
+				<param name="Local" value="docs/plugins/plugin_commonformats.html">
+				</OBJECT>
+			<LI> <OBJECT type="text/sitemap">
+				<param name="Name" value="HotPaste">
+				<param name="Local" value="docs/plugins/plugin_hotpaste.html">
+				</OBJECT>
+		</UL>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="Creating your own plugin">
 			<param name="Local" value="docs/plugins/basics.html">

chm_files/Index.hhk

@@ -95,6 +95,14 @@
 			<param name="Name" value="Creating your own plugin">
 			<param name="Local" value="docs/plugins/basics.html">
 			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="Common Formats">
+			<param name="Local" value="docs/plugins/plugin_commonformats.html">
+			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="HotPaste">
+			<param name="Local" value="docs/plugins/plugin_hotpaste.html">
+			</OBJECT>
 	</UL>
 	<LI> <OBJECT type="text/sitemap">
 		<param name="Name" value="Settings Editor">

chm_files/changelog.html

@@ -9,6 +9,19 @@
 
 <body>
 
+<h2>11.6</h2>
+<h4>06/08/2014</h4>
+<ul>
+<li>Added new formats, <em>TrimWhiteSpace</em> and <em>DeHTML</em> in <a href="docs/plugins/plugin_commonformats.html">Common Formats</a>
+<li>Added <a href="docs/history.html#holdclip">HoldClip</a> in History Tool
+<li>Added option to change channel in <a href="docs/organizer.html">channel organizer</a>
+<li>Added option in <a href="docs/channels.html#protected">Protected channel</a> popup to transfer to default channel
+<li>Added option to open clip in Common Format plugin via HoldClip
+<li>History tool can now be kept active after <a href="docs/history.html#ipaste">Insta Pasting</a>
+<li>Fixed bug where some icons were not displayed in channel organizer
+<li>More minor bug fixes, doc and program improvements
+</ul>
+
 <h2>11.5</h2>
 <h4>04/07/2014</h4>
 <ul>

chm_files/clipjump.html

@@ -13,7 +13,7 @@
 
 <body>
 <h1>Clipjump</h1>
-v 11.5
+v 11.6
 <br><br>
 
 <b>Clipjump</b> is a Multiple-Clipboard management utility for Windows.

chm_files/docs/channels.html

@@ -32,9 +32,8 @@ <h2><a name=about>About</a></h2>
 Selecting the channel to be pasted from can be done using the <a name=chnlsel>Channel Selector</a>. This feature is accessible from the <a href=basic_help.html#actmd>Action Mode</a> with easy key <kbd>S</kbd> as well as the Tray Menu. <br />
 Another method of selecting the channel is described in <a href=#chnljumps>Changing Channels in Paste Mode</a>.<br>
 <br />
-Channels are different series or groups in which clips are stored. <br /> 
-You can create unlimited <strong>distinctly named</strong> channels to store Clipboard data and store related clips in them. <br />
-The default channel is 0 and is named as <i>Default</i>.<br />
+Channels are different series or groups in which clips are stored. You can create unlimited distinctly named channels to store Clipboard data and store related clips in them. <br />
+The default channel is 0 and is named <span class="str">Default</span>.<br />
 <br />
 
 <h2><a name=using>How to Use</a></h2>
@@ -47,7 +46,7 @@ <h2><a name=using>How to Use</a></h2>
 Now try copying some data to Clipboard and you will see that the confirmation tip <span class="str">Transferred to Clipjump</span> is now preceeded by the string 
 <var>{name}</var> which will mean the item is now captured to Clipjump channel 1. <br />
 
-Now press <kbd>Ctrl</kbd> + <kbd>V</kbd> and release <kbda>V</kbda> to enter <a href="basic_help.html#pastemd">[Paste Mode]</a> . You will see a <var>{name}</var> also preceeding the Clip number message <span class="str">Clip x of y</span> . As you have already guessed , this means that the clip is contained in the Channel <var>name</var> .<br>
+Now press <kbd>Ctrl</kbd> + <kbd>V</kbd> and release <kbda>V</kbda> to enter <a href="basic_help.html#pastemd">[Paste Mode]</a> . You will see a <var>{name}</var> also preceeding the Clip number message <span class="str">Clip x of y</span> . As you have already guessed , this means that the clip is contained in the channel <var>name</var> .<br>
 <img src="../images/channelpaste.png" border="0">
 <br /><br>
 Now as you are using Channel 1, you can open the Channel window and use the next available Channel (Channel 2) . <strong class=mild> You can use as many as channels you want </strong> and give them any name you like.<br />

chm_files/docs/custom.html

@@ -102,7 +102,8 @@ <h3><a name=ex1>Example 1 (Shortcut to toggle Incognito Mode)</a></h3>
 <ol>
 	<li><span class="key"><a href=#bind>Bind</a></span> creates a shortcut for the section meaning that the section will not <b>auto-execute at Clipjump start</b>.
 	Here that shortcut is <kbd>Win</kbd> + <kbd>Alt</kbd> + <kbd>I</kbd>.
-	<li><span class="key"><a href=#run>run</a></span> runs the label 'incognito' inside Clipjump which is responsible for toggling incognito mode.
+	<li><span class="key"><a href=#run>run</a></span> runs the label 'incognito' inside Clipjump which is responsible for toggling incognito mode. More labels are 
+		<a href="devList.html#labels">here</a>
 	<li><span class="key"><a href=#tip>tip</a></span> shows a tooltip when this custom function is run. Here the tip shown will contain the text 
 		<span class="str">Incognito Mode toggled</span>.
 </ol>
@@ -200,7 +201,7 @@ <h3>Example 7 (Paste Signature)</h3>
 run=API.paste(2,1)
 </pre>
 <code class="Syntax">API.Paste(channel_number, clip_number)</code> is a function that pastes <var>clip_number</var> from <var>channel_number</var> in Clipjump. 
-Pressing <kbd>>Ctrl</kbd> + <kbd>F8</kbd> will automatically paste your signature now.
+Pressing <kbd>Ctrl</kbd> + <kbd>F8</kbd> will automatically paste your signature now.
 <br><br><br>
 
 <h3><a name=inputbox>Example 7.5 (Getting the clip to paste)</a></h3>

chm_files/docs/devList.html

@@ -25,7 +25,7 @@ <h2><a name=api>API functions</a></h2>
 All the functions under the file API.ahk<br>
 They should be accessed as <code class="Syntax">API.function_name()</code> . For example <code>API.paste()</code>
 <ol>
-	<li><code>paste(channel="", clipno="")</code><br>
+	<li><a name="api-paste"></a><code>paste(channel="", clipno="")</code><br>
 	- Pastes clips from a certain postion in a certain channel. If both are blank, paste 1st clip from currently active channel.<br>
 	Example - <code>API.paste(1, 14)</code> pastes clip 14 of channel 1
 	<br>
@@ -129,7 +129,7 @@ <h2><a name=api>API functions</a></h2>
 	<br>
 	<br>
 
-	<li><code>pasteText(Text)</code><br>
+	<li><a name="api-pastetext"></a><code>pasteText(Text)</code><br>
 	- pastes the 'Text' that is passed to the function.<br>
 	Text - the text/string you want to paste
 	<br>
@@ -233,7 +233,7 @@ <h2><a name=labels>Labels/Routines</a></h2>
 	<br>
 	<br>
 	<li><em>endPasteMode</em><br>
-	- Ends <a href=shorcuts.html#pstmd>[Paste-Mode]</a> forcibly. 
+	- Ends <a href="shortcuts.html#pstmd">[Paste-Mode]</a> forcibly. 
 	<br>
 	<br>
 	<li><em>simplePaste</em><br>
@@ -292,12 +292,23 @@ <h2><a name=pubapi>Public API</a></h2>
 Once publicAPI is included in the script, you will have to initialize it.<br>
 <pre>cj := new Clipjump()     <span class="green">; The name 'cj' doesnt matter</span></pre>
 Then you can call API methods, set variables, get variables and so on using the 'cj' object. Here are few examples -<br>
-<pre>msgbox % cj.version
+
+<pre>
+<span class="green">; getting value of internal variable VERSION</span>
+msgbox % cj.version
+<span class="green">; getting value of internal variable CN.NG</span>
+msgbox % cj["CN.NG"]
+<span class="green">; setting internal variable PASTEMODEKEY.Z to ^Y</span>
 cj["pastemodekey.z"] := "^y"
+<span class="green">; running a <a href=#api>API</a> function GETCLIPLOC</span>
 msgbox % cj.getClipLoc(1, 5)
+<span class="green">; running a normal function SET_PFORMAT that is not part of API</span>
 cj.runFunction("set_pformat(NO-FORMATTING)")
-cj.runLabel("exit") 		<span class="green">; closes Clipjump</span></pre>
+<span class="green">; running the label EXIT</span>
+cj.runLabel("exit") 		<span class="green">; closes Clipjump</span>
+</pre>
 
+The plugin <span class="str">Ignored Windows Manager</span> uses the publicAPI. It will be a good idea to read its code ( <em>external.ignoreWManager.ahk</em> ).
 <br><br>
 
 <hr noshade=noshade size=5 color=yellow>

chm_files/docs/history.html

@@ -17,7 +17,9 @@ <h1><a name=his>History Tool</a></h1>
 <li><a href=#export>Export Clip</a></li>
 <li><a href=#holdclip>Hold Clip</a></li></ul>
 <li><a href=#dis_his>Disable History keeping</a>
-<li><a href=#his_short>Change/disable History Tool shortcut(Win+C)</a></ul>
+<li><a href=#his_short>Change/disable History Tool shortcut(Win+C)</a></li>
+<br>
+<li><a href=#shorts>Global Window Shortcuts</a></li></ul>
 <br>
 
 <h2>Introduction</h2>
@@ -87,6 +89,14 @@ <h4><a name=holdclip>Hold Clip</a></h4> <span class="ver">[v11.6+]</span> Hold C
 F9</pre>
 The 3rd value is kept blank to demonstrate the NULL value which disables the History Tool shortcut.
 
+<br><br><br>
+
+<a name=shorts></a><h2>Global Window Shortcuts</h2>
+<pre>
+<kbd>F5</kbd> - Refresh
+<kbd>Ctrl</kbd>+<kbd>F</kbd> - Focus on Search box
+</pre>
+
 <br><br>
 
 <hr noshade=noshade size=5 color=yellow>

chm_files/docs/organizer.html

@@ -30,13 +30,24 @@ <h1>Channel Organizer</h1>
 
 <b>The Delete option</b> currently doesn't support multi-selection so you will be available to delete only one item at a time.<br><br>
 
-<h3>Preferences</h3>
+<h2>Preferences</h2>
 <ul>
 <li>To make Channel Organizer show all clips i.e. choose no channel by default on startup, make the variable <var>ini_OpenAllChByDef</var> equal to 1.<br>
 	You will have to use <a href=custom.html>ClipjumpCustom.ini</a> for the purpose. Just add the line <code>ini_OpenAllChByDef = 1</code> in a 
 	<a href=custom.html#noautorun>non-auto-executing</a> section. </li>
 </ul>
 
+<br>
+
+<a name=shorts></a><h2>Global Window Shortcuts</h2>
+<pre>
+<kbd>F5</kbd> - Refresh
+<kbd>Ctrl</kbd>+<kbd>N</kbd> - Create new clip
+<kbd>Ctrl</kbd>+<kbd>G</kbd> - Set focus to Active Channel selector list
+<kbd>Ctrl</kbd>+<kbd>F</kbd> - Set focus to search box
+</pre>
+
+
 <br><br>
 <hr noshade=noshade size=5 color=yellow>
 <br>

chm_files/docs/plugins/index.html

@@ -43,7 +43,7 @@ <h2>Creating your own plugins</h2>
 <h2><a name=def>Officially Distributed Plugins</a></h2>
 <ol>
 	<li>General
-	<ol><li>Hotstring-Paste - A very raw sample plugin that helps you to create Hotstrings to paste, i.e. you type a text and a clip stored by Clipjump is pasted.
+	<ol><li><a href="plugin_hotpaste.html">Hotstring-Paste</a> - A very raw sample plugin that helps you to create Hotstrings to paste, i.e. you type a text and a clip stored by Clipjump is pasted.
 		<li>NoFormatting paste - Pastes current clipboard trimming off any formatting (like HTML).
 		<li>Delete [File/Folder] - Deletes clips of data type <code>[File/Folder]</code> from selected or all channels.
 	</ol>

chm_files/docs/plugins/plugin_commonformats.html

@@ -8,41 +8,46 @@
 
 <body>
 <h1>Common Formats Paste Format</h1>
-<b>version 0.4</b><br>
-<a href=https://raw.github.com/aviaryan/Clipjump/master/plugins/pformat.commonformats.ahk>Github</a> (This plugin is included in Clipjump download)
-<br><br>
+<b>version 0.5</b>
+<br>
 
 <h2>Introduction</h2>
-'Common Formats' is a pformat plugin that lets you paste the clip with various inbuilt paste formatting. 
-Users can add more formats in the 'pformat.commonformats.lib/<b>user</b>.ahk' file. <br>
+<strong>Common Formats</strong> is a pformat plugin that lets you paste the clip with various inbuilt paste formatting. 
+Users can add more formats in the <em>pformat.commonformats.lib/<b>user</b>.ahk</em> file. <br>
 <span class="red">Note</span> - This file is not present by default. It is created when the Common Formats plugin runs for the first time ( either from the plugin manager or paste mode ).<br><br>
 
  <h2>Using</h2>
- Once you have selected the common format <a href="../basic_help.html#pformat">paste-format</a>, releasing Ctrl to paste will bring up the GUI. Use Up/Down keys or mouse to select 
- your needed format and press 'Enter' or OK button to paste.<br>
- You can press 'Esc' or simply close the GUI to cancel the paste operation.<br>
- Selecting the paste-format <b>'None'</b> will paste the original clip without making any changes.
+ Once you have selected the <strong>Common Formats</strong> <a href="../basic_help.html#pformat">paste-format</a>, releasing <kbd class="inverse">Ctrl</kbd> to paste will bring up the GUI.
+ <br>Use <kbd>Up</kbd> or <kbd>Down</kbd> keys or mouse to select your needed format and press <kbd>Enter</kbd> or <span class="str">OK</span> button to paste.<br>
+ You can press <kbd>Esc</kbd> or simply close the GUI to cancel the paste operation.
+ Selecting the paste-format <b><span class="str">None</span></b> will paste the original clip without making any changes.
  <br><br>
 
- <b>The Apply button</b> (Alt+A) applies the current changes made the the formatting to the clip to be pasted. Thus it helps you in applying multiple formats to a clip in 
- the needed order. Note that the 'None' paste format will still paste the real original clip and the 'apply' won't be undertaken.
+ <b>The Apply button</b> applies the current changes made the the formatting to the clip to be pasted. Thus it helps you in applying multiple formats to a clip in 
+ the needed order. Note that the <span class="str">None</span> paste format will still paste the real original clip and the 'apply' won't be undertaken.
  <br><br>
 
-<b>Input Field</b> is used by formats that have parameters in addition to the input text. <b>RegExReplace</b> for example uses input field to get the other 2 parameters, 
-the match needle and the replacement text AND the users are supposed to enter them line by line.
+<b>Input Field</b> is used by formats that have parameters in addition to the input text. <span class="str">RegExReplace</span> for example uses input field to get the other 2 parameters, 
+the match needle and the replacement text and the users are supposed to enter these two paramters one in a line (line by line).
 <br><br>
 
 <h2>Porting an existing pformat to under Common Formats</h2>
- To make any independent pformat a part of the common format, you can simply copy its code to the pformat.commonformats.lib/user.ahk file. <br>
- Then replace the main function name <code>plugin_pformat_name</code> by <code>plugin_pformat_commonformats_name</code> where 'name' is the name of that independent 
- pformat. It is recommend to study the code of <code>pformat.commonformats.ahk</code> first.
- <br><br>
+To make any independent pformat a part of the <strong>Common Formats</strong>, you can simply copy its code to the <em>pformat.commonformats.lib/user.ahk</em> file. <br>
+Then replace the main function name <code>plugin_pformat_<var>name</var></code> by <code>plugin_pformat_commonformats_<var>name</var></code> where <var>name</var> is the name of that independent pformat. Also it will be a good idea to study the code of <em>pformat.commonformats.ahk</em> first.
+<br><br>
 
-OR you can create a new format under the 'Common Formats' plugin. It should be easy provided you know <a href=http://www.ahkscript.org>AutoHotkey</a>. Just make sure
- you name the new format function as <code>plugin_pformat_commonformats_MYNAME</code> where 'MYNAME' is the unique name of your format and this is what that will 
- appear in the GUI. (Related: <a href=basics.html#class_pformat>pformat</a>)
+You can also create a new format under the <strong>Common Formats</strong> user file. It should be easy provided you know <a href=http://www.ahkscript.org>AutoHotkey</a>. 
+Just make sure you name the new format function as <code>plugin_pformat_commonformats_<var>MYNAME</var></code> where <var>MYNAME</var> is the unique name of your format and this is what that will appear in the GUI. (Related: <a href=basics.html#class_pformat>pformat</a>)
 
 <br><br>
 <b>Info Data</b> for the format shown in the respective field is nothing but data stored in <code>STORE</code> object as <code>STORE["commonformats_" formatName]</code> 
-where formatName is the name of the format such as 'RegexReplace'.
-<br>
+where formatName is the name of the format such as <span class="str">RegexReplace</span>.
+<br><br>
+
+<hr noshade=noshade size=5 color=yellow>
+<br>
+<a href="http://translate.google.com/translate?hl=en&sl=en&u=clipjump.sourceforge.net/docs/plugins/plugin_commonformats.html" id="translate">Translate</a>
+<br><br>
+</body>
+
+</html>