pull up r18864 from trunk

 r18864@cathode-dark-space:  jaltman | 2006-11-27 13:59:21 -0500
 ticket: new
 subject: documentation updates for KFW 3.1
 tags: pullup
 
   Documentation updates including new screen shots for KFW 3.1
 
 

ticket: 4921
version_fixed: 1.4.5

git-svn-id: svn://anonsvn.mit.edu/krb5/branches/krb5-1-4@18868 dc483132-0cff-0310-8789-dd5450dbe970

16 files changed, 152 insertions, 28 deletions

diff --git a/src/windows/identity/doc/netidmgr.doc b/src/windows/identity/doc/netidmgr.doc
index 8e9c1e0..41a0cda 100755
--- a/src/windows/identity/doc/netidmgr.doc
+++ b/src/windows/identity/doc/netidmgr.doc
diff --git a/src/windows/identity/doc/netidmgr.pdf b/src/windows/identity/doc/netidmgr.pdf
index 8ec23bd..f28e577 100755
--- a/src/windows/identity/doc/netidmgr.pdf
+++ b/src/windows/identity/doc/netidmgr.pdf
diff --git a/src/windows/identity/help/html/concept_identity.htm b/src/windows/identity/help/html/concept_identity.htm
index bb11746..ae2dda0 100644
--- a/src/windows/identity/help/html/concept_identity.htm
+++ b/src/windows/identity/help/html/concept_identity.htm
@@ -20,10 +20,17 @@ considered to belong to that identity.
 <p>

 </p>

 

-

 <a name="default_identity" />

 <h3>Default Identity</h3>

 

+<p>The default identity is the identity that will be picked up by

+other applications as being the default.  For example, an application

+that uses Kerberos 5 can use the credentials found in the default

+Kerberos 5 credentials cache.  Therefore, the Kerberos 5 plug-in

+considers the principal that corresponds to the default credentials

+cache as being the default identity.

+</p>

+

 <p>

 </p>

 

diff --git a/src/windows/identity/help/html/images/screen_app_icon.bmp b/src/windows/identity/help/html/images/screen_app_icon.bmp
index 78fd535..49e2fb0 100644
--- a/src/windows/identity/help/html/images/screen_app_icon.bmp
+++ b/src/windows/identity/help/html/images/screen_app_icon.bmp
diff --git a/src/windows/identity/help/html/images/screen_config_general.bmp b/src/windows/identity/help/html/images/screen_config_general.bmp
new file mode 100644
index 0000000..6c6e57e
--- /dev/null
+++ b/src/windows/identity/help/html/images/screen_config_general.bmp
diff --git a/src/windows/identity/help/html/images/screen_config_ident.bmp b/src/windows/identity/help/html/images/screen_config_ident.bmp
new file mode 100644
index 0000000..2ac15fe
--- /dev/null
+++ b/src/windows/identity/help/html/images/screen_config_ident.bmp
diff --git a/src/windows/identity/help/html/images/screen_config_idents.bmp b/src/windows/identity/help/html/images/screen_config_idents.bmp
new file mode 100644
index 0000000..8f55a05
--- /dev/null
+++ b/src/windows/identity/help/html/images/screen_config_idents.bmp
diff --git a/src/windows/identity/help/html/images/screen_main_wnd.bmp b/src/windows/identity/help/html/images/screen_main_wnd.bmp
index 77ab8be..0763318 100644
--- a/src/windows/identity/help/html/images/screen_main_wnd.bmp
+++ b/src/windows/identity/help/html/images/screen_main_wnd.bmp
diff --git a/src/windows/identity/help/html/images/screen_menu_view_cols.bmp b/src/windows/identity/help/html/images/screen_menu_view_cols.bmp
index 75775e2..25779bf 100644
--- a/src/windows/identity/help/html/images/screen_menu_view_cols.bmp
+++ b/src/windows/identity/help/html/images/screen_menu_view_cols.bmp
diff --git a/src/windows/identity/help/html/images/screen_new_creds.bmp b/src/windows/identity/help/html/images/screen_new_creds.bmp
index 7d7335a..bf5be31 100755
--- a/src/windows/identity/help/html/images/screen_new_creds.bmp
+++ b/src/windows/identity/help/html/images/screen_new_creds.bmp
diff --git a/src/windows/identity/help/html/images/screen_new_creds_exp.bmp b/src/windows/identity/help/html/images/screen_new_creds_exp.bmp
index b1711a7..5caa632 100755
--- a/src/windows/identity/help/html/images/screen_new_creds_exp.bmp
+++ b/src/windows/identity/help/html/images/screen_new_creds_exp.bmp
diff --git a/src/windows/identity/help/html/use_config.htm b/src/windows/identity/help/html/use_config.htm
new file mode 100644
index 0000000..6d4cbeb
--- /dev/null
+++ b/src/windows/identity/help/html/use_config.htm
@@ -0,0 +1,132 @@
+<html>

+<head>

+  <title>Configuring NetIDMgr and identities</title>

+  <meta name="description" content="">

+  <meta name="keywords" content="configuration">

+  <link rel="stylesheet" type="text/css" href="nidmgr.css">

+</head>

+<body>

+

+<h1>Configuring NetIDMgr and identities</h1>

+

+<p>All NetIDMgr configuration options can be accessed via the <span

+class="pre">Options</span> menu.  The available configuration panels

+are:

+</p>

+

+<p>

+<ul>

+  <li><p><span class="title">General</span>: General application options

+  for NetIDMgr.</p>

+

+  <ul>

+

+    <li><p><span class="title">Obtain new credentials at

+    startup</span>: If checked, NetIDMgr will check there are initial

+    credentials for the default identity.  If no such credentials are

+    found, NetIDMgr will display a new credentials dialog.</p> </li>

+

+    <li><p><span class="title">Run NetIDMgr in system tray after

+    window close</span>: If checked, NetIDMgr will continue running in

+    the system notification area (sometimes referred to as the system

+    tray) after you close the NetIDMgr window.</p> </li>

+

+    <li><p><span class="title">Monitor network connectivity</span>: When

+    changes to network connectivity are detected, NetIDMgr can notify

+    individual plug-ins about these changes.  Doing so allows each

+    plug-in to respond to the change by obtaining new credentials etc.

+    If this option is cleared, no such notifications are sent and the

+    application would not respond to network changes.</p></li>

+

+    <li><p><span class="title">Log trace events</span>: NetIDMgr can

+    generate debugging information during the course of performing

+    certain actions.  This information aids the developers in fixing

+    problems that you may encounter while using NetIDMgr.</p> </li>

+

+  </ul>

+

+  </li>

+

+  <li><p><span class="title">Appearance</span>: Allows you to set the

+  font used by NetIDMgr.</p></li>

+

+  <li><p><span class="title">Identities</span>: Default settings for all

+  identities and settings for each identity.  Details <a

+  href="#cfg_idents">below</a>.</p></li>

+

+  <li><p><span class="title">Notifications</span>: Notification and timer

+  options.  NetIDMgr can issue warnings when credentials are about to

+  expire. This configuration panel allows you to set the thresholds at

+  which these warnings are issued.  For example, if the warning

+  timeout is set for 10 minutes, NetIDMgr will issue a warning 10

+  minutes before a credential expires.</p>

+

+  <p>The panel also allows you to control the credentials renew timer.

+  If the timer is disabled, NetIDMgr will not automatically attempt to

+  renew credentials.  If the <span class="pre">Renew at half life

+  intervals when possible</span> option is set, then the timer will

+  expire after the credential has less than half its lifetime left.

+  If the renewal operation fails, it will attempt another renwal after

+  half of the remaining liftime is over (i.e. when the credential has

+  less than 1/4 of its original lifetime left) and so on.

+  </p>

+

+  </li>

+

+  <li><p><span class="title">Plugins</span>: Enable/disable and check

+  the status of registered plug-ins.  Enabling or disabling a plug-in

+  only takes effect after a restart of NetIDMgr.</p></li>

+

+</ul>

+</p>

+

+<p><img src="images/screen_config_general.bmp" />

+</p>

+

+<a name="cfg_idents" />

+<h3>Configuration of default settings for all identities</h3>

+

+<p>The <span class="pre">Identities</span> configuration panel allows

+you to set the defaults that will be used for all identities.

+However, most of the settings displayed here can be overridden with

+specific per-identity settings.

+</p>

+

+<p>The panel will have a number of sub panels (or tabs) corresponding

+to each plug-in that maintains per-identity configuration.

+</p>

+

+<p>A list of identities for which configuration information is

+maintained will be shown under the main <span

+class="pre">Identities</span> configuration panel name.  Each of these

+correspond to a <a href="#cfg_ident">per identity</a> configuration

+panel.

+</p>

+

+<p>Note that adding or removing an identity in the configuration panel

+only has the effect of adding or removing the identity to or from the

+list of identities for which configuration information is maintained.

+</p>

+

+<p><img src="images/screen_config_idents.bmp" />

+</p>

+

+<a name="cfg_ident" />

+<h3>Per identity configuration</h3>

+

+<p>You can access the per-identity configuration panel for a specific

+identity by selecting the identity name from the list of configuration

+panels in the configuration dialog.

+</p>

+

+<p>These panels are similar to the <span class="pre">Identities</span>

+configuration panel, but they change per-identity settings.  Changes

+you make in these panels will override the defaults set in the <span

+class="pre">Identities</span> panel.

+</p>

+

+<p><img src="images/screen_config_ident.bmp" />

+</p>

+

+</body>

+</html>

diff --git a/src/windows/identity/help/html/use_layout.htm b/src/windows/identity/help/html/use_layout.htm
index 2d87bc9..7a0d070 100644
--- a/src/windows/identity/help/html/use_layout.htm
+++ b/src/windows/identity/help/html/use_layout.htm
@@ -18,7 +18,7 @@ sorting the list of credentials can be customized. </p>
 customizations that can be performed:</p>

 

 <ul>

-  <li><a href="#predef">Predefined layouts</a><li>

+  <li><a href="#predef">Predefined layouts</a></li>

   <li><a href="#addcol">Adding and removing columns.</a></li>

   <li><a href="#sort">Sorting by a column.</a></li>

   <li><a href="#group">Grouping by a column.</a></li>

@@ -27,13 +27,13 @@ customizations that can be performed:</p>
 <a name="predef" />

 <h3>Predefined layouts</h3>

 

-<p>The predefined layouts in NetIDMgr are: </p>

+<p>The predefined layouts in NetIDMgr are:</p>

 

 <ul>

 

   <li><span class="title">By Identity</span>: Credentials grouped by

-  identity and credentials type, and finally sorted by credential

-  name.</li>

+  identity, credentials type and location, and finally sorted by

+  credential name.</li>

 

   <li><span class="title">By Type</span>: Credentials grouped by

   credentials type and then by identity.</li>

@@ -68,7 +68,7 @@ is shown below.</p>
 <p>Clicking on a column header will change the sort order of the

 column if it is already being used as a sort key.  If the colunm is

 not currently being used as a sort key, clicking on the column header

-will start sorting in increasing order by that column. </p>

+will start sorting in increasing order by that column.</p>

 

 <p>Double-clicking a column that is not used for grouping will stop

 sorting by that column.</p>

diff --git a/src/windows/identity/help/html/using.htm b/src/windows/identity/help/html/using.htm
index c09558e..96c132c 100644
--- a/src/windows/identity/help/html/using.htm
+++ b/src/windows/identity/help/html/using.htm
@@ -37,6 +37,7 @@ Brief overviews of how to perform common tasks are linked below:
   <li><a href="act_renew_creds.htm">Renew credentials</a></li>

   <li><a href="act_chpw.htm">Change password</a></li>

   <li><a href="use_layout.htm">Managing the credentials view layout</a></li>

+  <li><a href="use_config.htm">Configuring NetIDMgr and identities</a></li>

 </ul>

 

 <p>

diff --git a/src/windows/identity/help/html/wnd_main.htm b/src/windows/identity/help/html/wnd_main.htm
index 575e7ba..c4de155 100644
--- a/src/windows/identity/help/html/wnd_main.htm
+++ b/src/windows/identity/help/html/wnd_main.htm
@@ -11,33 +11,12 @@
 

 <p>The main window of Network Identity Manager is structured as follows</p>

 

-<map id="main_wnd_map">

-  <area shape = "rect" coords = "7,34,243,56" href = "menu_all.htm" />

-  <area shape = "rect" coords = "6,56,364,90" href = "tb_standard.htm" />

-  <area shape = "rect" coords = "6,112,613,164" href = "#cred1" />

-  <area shape = "rect" coords = "246,162,288,197" href = "#cred2" />

-  <area shape = "rect" coords = "72,196,107,245" href = "#credtype1" />

-  <area shape = "rect" coords = "69,278,107,315" href = "#credtype2" />

-  <area shape = "rect" coords = "236,332,294,367" href = "#cred3" />

-</map>

-

 <img src="images/screen_main_wnd.bmp" usemap="#main_wnd_map"/>

 

 <ol>

   <li>Menu bar</li>

   <li>Tool bar</li>

-

-  <li><a name="cred1" /> An identity with a valid Kerberos 5 initial

-  ticket</li>

-

-  <li><a name="cred2" /> An identity with valid Kerberos 5 tickets and

-  AFS tokens</li> 

-

-  <li><a name="credtype1" /> A set of Kerberos 5 tickets</li>

-

-  <li><a name="credtype2" /> A set of AFS tokens</li>

-

-  <li>An identity with expired Kerberos 5 tickets</li>

+  <li>Credentials list</li>

 

 </ol>

 

diff --git a/src/windows/identity/help/toc.hhc b/src/windows/identity/help/toc.hhc
index c2239b8..6c3876e 100644
--- a/src/windows/identity/help/toc.hhc
+++ b/src/windows/identity/help/toc.hhc
@@ -70,6 +70,11 @@
                         <param name="Name" value="Managing the credentials view layout">

                         <param name="Local" value="html\use_layout.htm">

                         </OBJECT>

+

+                <LI> <OBJECT type="text/sitemap">

+                        <param name="Name" value="Configuring NetIDMgr and identities">

+                        <param name="Local" value="html\use_config.htm">

+                        </OBJECT>

 	</UL>

 	<LI> <OBJECT type="text/sitemap">

 		<param name="Name" value="Menus and Toolbars">