Added help texts for new features

kaikramer · Oct 12, 2013 · 1ddedfe · 1ddedfe
1 parent 2840cc0
commit 1ddedfe
Show file tree

Hide file tree

Showing 12 changed files with 453 additions and 25 deletions.
diff --git a/kse/help/help.cfg b/kse/help/help.cfg
@@ -54,7 +54,13 @@ File copyPasteTrustedCertificate.html
 File deleteTrustedCertificate.html
 File renameTrustedCertificate.html
 File aboutKeys.html
+File unlockKey.html
+File setKeyPassword.html
+File viewKey.html
 File deleteKey.html
+File renameKey.html
+File cutPasteKey.html
+File copyPasteKey.html
 File signCsr.html
 File signJar.html
 File signMidlet.html

diff --git a/kse/src/net/sf/keystore_explorer/gui/help/aboutKeyPairs.html b/kse/src/net/sf/keystore_explorer/gui/help/aboutKeyPairs.html
@@ -26,55 +26,48 @@
     <body>
 
         <h1>About Key Pairs</h1>
-        <hr>
+        <hr/>
 
         A Key Pair contains a private key and its associated certificate
         chain.  Key Pairs can be used to digitally sign objects such as Java
         applications.  Key Pair entries are represented in KeyStore Explorer
         by the following icon:
 
         <p>
-
         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/keypair_entry.png">
-
+        </p>
         <p>
-
         As the private key part of the Key Pair should remain secret, Key Pair entries
         are normally protected by a password.  In KeyStore Explorer such entries
         are described as being <b>Locked</b> and have a closed padlock displayed
         against them:
-
+        </p>
         <p>
-
         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/locked_entry.png">
-
+        </p>
         <p>
-
         To access the private key the entry must be <a href="unlockKeyPair.html"><b>Unlocked</b></a>
         by supplying the correct password.  If an entry is successfully unlocked then an open
         padlock is displayed against it:
-
+        </p>
         <p>
-
         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/unlocked_entry.png">
-
+        </p>
         <p>
-
         If a Key Pair entry is unlocked once during a KeyStore Explorer
         session it does not need to be unlocked again.  A Key Pair entry may be
-        unlocked explicitly</a> or as part of an
+        unlocked explicitly or as part of an
         operation that requires the private key.
-
+        </p>
         <p>
-
         A Key Pair must be unlocked to utilize it for operations such as digital
         signing or to view or export the private key.  The exception is Key Pair's
         contained within a PKCS #12 KeyStore - these do not have passwords
         and therefore never require to be unlocked.
+        </p>
+        <br/><br/>
 
-        <br><br>
-
-        <hr>
+        <hr/>
 
         <center><small>Copyright 2004 - 2013 Wayne Grant, 2013 Kai Kramer</small></center>
 

diff --git a/kse/src/net/sf/keystore_explorer/gui/help/aboutKeys.html b/kse/src/net/sf/keystore_explorer/gui/help/aboutKeys.html
@@ -32,18 +32,33 @@ <h1>About Keys</h1>
         Key entries are represented in KeyStore Explorer by the following icon:
 
         <p>
-
         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/key_entry.png">
-
+        </p>
         <p>
-
-        Key entries can be displayed and <a href="deleteKey.html">deleted</a>.
-
+        Key entries are protected by a password.  In KeyStore Explorer such entries
+        are described as being <b>Locked</b> and have a closed padlock displayed
+        against them:
+        </p>
+        <p>
+        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/locked_entry.png">
+        </p>
+        <p>
+        To access the key the entry must be <a href="unlockKey.html"><b>Unlocked</b></a>
+        by supplying the correct password.  If an entry is successfully unlocked then an open
+        padlock is displayed against it:
+        </p>
+        <p>
+        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/unlocked_entry.png">
+        </p>
+        <p>
+        If a Key Pair entry is unlocked once during a KeyStore Explorer
+        session it does not need to be unlocked again.  A Key Pair entry may be
+        unlocked explicitly or as part of an operation that requires the private key.
+        </p>
         <p>
-
         As key entries do not contain any certificates no value is shown for them in the
         <b>Certificate Expiry</b> column of the KeyStore table.
-
+        </p>
         <br><br>
 
         <hr>

diff --git a/kse/src/net/sf/keystore_explorer/gui/help/contents b/kse/src/net/sf/keystore_explorer/gui/help/contents
@@ -84,7 +84,13 @@
 
     <tocitem text="Keys" expand="false">
         <tocitem text="About Keys" target="aboutKeys" />
+        <tocitem text="View a Key" target="viewKey" />
+        <tocitem text="Unlock a Key" target="unlockKey" />
+        <tocitem text="Set a Key's Password" target="setKeyPassword" />
         <tocitem text="Delete a Key" target="deleteKey" />
+        <tocitem text="Rename a Key" target="renameKey" />
+        <tocitem text="Cut and Paste  a Key" target="cutPasteKey" />
+        <tocitem text="Copy and Paste  a Key" target="copyPasteKey" />
     </tocitem>
 
     <tocitem text="Digital Signing" expand="false">

diff --git a/kse/src/net/sf/keystore_explorer/gui/help/copyPasteKey.html b/kse/src/net/sf/keystore_explorer/gui/help/copyPasteKey.html
@@ -0,0 +1,81 @@
+<!--
+Copyright 2004 - 2013 Wayne Grant
+          2013 Kai Kramer
+
+This file is part of KeyStore Explorer.
+
+KeyStore Explorer is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+KeyStore Explorer is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with KeyStore Explorer.  If not, see <http://www.gnu.org/licenses/>.
+-->
+<html>
+    <head>
+        <title>Copy and Paste a Key</title>
+        <link rel=stylesheet href="help.css" type="text/css">
+    </head>
+
+    <body>
+
+        <h1>Copy and Paste a Key</h1>
+        <hr>
+
+        To copy and paste a Key:
+
+        <ol>
+            <li>Click on the Key entry to select it.</li>
+
+            <br>
+
+            <li>From the <b>Edit</b> menu, choose <b>Copy</b>.
+                Alternatively click on the <b>Copy</b> tool bar
+                button:
+                <br><br>&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/copy.png"></li>
+
+            <br>
+
+            <li>If required the <b>Unlock Entry</b> dialog will be displayed.
+                Enter the Key entry's password and press the <b>OK</b> button.</li>
+
+            <br>
+
+            <li>If copying to a different KeyStore select it by clicking on its tab.</li>
+
+            <br>
+
+            <li>From the <b>Edit</b> menu, choose <b>Paste</b>.
+                Alternatively click on the <b>Paste</b> tool bar
+                button:
+                <br><br>&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/paste.png"></li>
+
+            <br>
+
+            <li>A copy of the Key entry will appear in the
+                target KeyStore Entries table.  The Key entry's password
+                will be the same as the original's.</li>
+
+        </ol>
+
+        <b>Notes:</b>
+
+        <ul>
+            <li>KeyStore Explorer has an internal clipboard for cut, copy and paste
+                operations called the <b>buffer</b>.
+                Therefore KeyStore entries cannot be cut or copied from KeyStore Explorer
+                to other applications and vice versa.</li>
+        </ul>
+
+        <hr>
+
+        <center><small>Copyright 2004 - 2013 Wayne Grant, 2013 Kai Kramer</small></center>
+
+    </body>
+</html>
diff --git a/kse/src/net/sf/keystore_explorer/gui/help/cutPasteKey.html b/kse/src/net/sf/keystore_explorer/gui/help/cutPasteKey.html
@@ -0,0 +1,82 @@
+<!--
+Copyright 2004 - 2013 Wayne Grant
+          2013 Kai Kramer
+
+This file is part of KeyStore Explorer.
+
+KeyStore Explorer is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+KeyStore Explorer is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with KeyStore Explorer.  If not, see <http://www.gnu.org/licenses/>.
+-->
+<html>
+    <head>
+        <title>Cut and Paste a Key</title>
+        <link rel=stylesheet href="help.css" type="text/css">
+    </head>
+
+    <body>
+
+        <h1>Cut and Paste a Key</h1>
+        <hr>
+
+        To cut and paste a Key:
+
+        <ol>
+            <li>Click on the Key entry to select it.</li>
+
+            <br>
+
+            <li>From the <b>Edit</b> menu, choose <b>Cut</b>.
+                Alternatively click on the <b>Cut</b> tool bar
+                button:
+                <br><br>&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/cut.png"></li>
+
+            <br>
+
+            <li>If required the <b>Unlock Entry</b> dialog will be displayed.
+                Enter the Key entry's password and press the <b>OK</b> button.</li>
+
+            <br>
+
+            <li>Select the target KeyStore by clicking on its tab.</li>
+
+            <br>
+
+            <li>From the <b>Edit</b> menu, choose <b>Paste</b>.
+                Alternatively click on the <b>Paste</b> tool bar
+                button:
+                <br><br>&nbsp;&nbsp;&nbsp;&nbsp;<img src="images/paste.png"></li>
+
+            <br>
+
+            <li>The Key entry will appear in the target KeyStore
+                Entries table.  The Key entry's password
+                will remain unchanged.</li>
+
+        </ol>
+
+        <b>Notes:</b>
+
+        <ul>
+            <li>KeyStore Explorer has an internal clipboard for cut, copy and paste
+                operations called the <b>buffer</b>.
+                Therefore KeyStore entries cannot be cut or copied from KeyStore Explorer
+                to other applications and vice versa.</li>
+
+        </ul>
+
+        <hr>
+
+        <center><small>Copyright 2004 - 2013 Wayne Grant, 2013 Kai Kramer</small></center>
+
+    </body>
+</html>
diff --git a/kse/src/net/sf/keystore_explorer/gui/help/keyboardShortcuts.html b/kse/src/net/sf/keystore_explorer/gui/help/keyboardShortcuts.html
@@ -151,6 +151,12 @@ <h1>Keyboard Shortcuts</h1>
                 <td>Set Password</td>
                 <td>Set the active KeyStore's password</td>
             </tr>
+            <tr>
+                <td nowrap>Enter</td>
+                <td nowrap>Enter</td>
+                <td>View KeyStore Entry Details</td>
+                <td>Display the details of the currently selected KeyStore entry</td>
+            </tr>
             <tr>
                 <td nowrap>Alt-Enter</td>
                 <td nowrap>Alt-Enter</td>
@@ -199,6 +205,12 @@ <h1>Keyboard Shortcuts</h1>
                 <td>Preferences</td>
                 <td>Display KeyStore Explorer's preferences dialog</td>
             </tr>
+            <tr>
+                <td nowrap>Esc</td>
+                <td nowrap>Esc</td>
+                <td>Close Dialog</td>
+                <td>Close currently opened dialog</td>
+            </tr>
             <tr>
                 <td nowrap>Alt-F4</td>
                 <td nowrap>N/A</td>

diff --git a/kse/src/net/sf/keystore_explorer/gui/help/kseMap.jhm b/kse/src/net/sf/keystore_explorer/gui/help/kseMap.jhm
@@ -98,7 +98,13 @@
     <mapID target="renameTrustedCertificate" url="renameTrustedCertificate.html" />
 
     <mapID target="aboutKeys" url="aboutKeys.html" />
+    <mapID target="viewKey" url="viewKey.html" />
+    <mapID target="unlockKey" url="unlockKey.html" />
+    <mapID target="setKeyPassword" url="setKeyPassword.html" />
     <mapID target="deleteKey" url="deleteKey.html" />
+    <mapID target="renameKey" url="renameKey.html" />
+    <mapID target="cutPasteKey" url="cutPasteKey.html" />
+    <mapID target="copyPasteKey" url="copyPasteKey.html" />
 
     <mapID target="signCsr" url="signCsr.html" />
     <mapID target="signJar" url="signJar.html" />