windows-install-wix-doc-xml-20090521

LICENSE MIT

replace static html documentation with auto-generated
html help files from doc/xml/... when building en_US
locale.

diff --git a/src/WINNT/install/wix/feature.wxi b/src/WINNT/install/wix/feature.wxi
index 873fb97..d502ba5 100644 (file)
--- a/src/WINNT/install/wix/feature.wxi
+++ b/src/WINNT/install/wix/feature.wxi
@@ -10,10 +10,6 @@
            <ComponentRef Id="efl_uninstall_EXE" />
 
            <ComponentRef Id="cmp_Release_Notes_en_US" />
-           <ComponentRef Id="cmf_index2_HTM_en_US" />
-           <ComponentRef Id="cmp_index_files_en_US" />
-           <ComponentRef Id="cmp_logo_files_en_US" />
-           <ComponentRef Id="cmp_relnotes_files_en_US" />
   <?endif?>
 
   <?ifndef BinsOnly ?>
@@ -66,7 +62,6 @@
 
                <ComponentRef Id="cmp_CommonDir" />
 
-                <ComponentRef Id="efl_Readme_TXT_$(var.Language)" />
                 <ComponentRef Id="efl_CellServDB" />
                 <ComponentRef Id="cpf_CellServDB" />
                 <ComponentRef Id="cmf_afs_cpa_CPL" />
@@ -147,8 +142,6 @@
                 <ComponentRef Id="cmf_afs_nt_HLP_$(var.Language)" />
                 <ComponentRef Id="cmp_Lang_$(var.Language)" />
             
-                <ComponentRef Id="efl_Readme_TXT_$(var.Language)" />
-
                 <ComponentRef Id="cmf_vlserver_EXE" />
                 <ComponentRef Id="cmf_volinfo_EXE" />
                 <ComponentRef Id="cmf_volserver_EXE" />
@@ -229,8 +222,6 @@
                                </Feature>
             <?endif?>
             
-                <ComponentRef Id="efl_Readme_TXT_$(var.Language)" />
-                
                 <!-- Runtime -->
                 <?include runtime.wxi?>
             </Feature>
@@ -239,7 +230,6 @@
 
                                <ComponentRef Id="rcm_SDK" />
 
-                <ComponentRef Id="efl_Readme_TXT_$(var.Language)" />                
                                <ComponentRef Id="cmp_SDK_Sample" />
                                <ComponentRef Id="cmp_SDK_Include" />
                                <ComponentRef Id="cmp_SDK_Include_afs" />
@@ -266,14 +256,12 @@
                 Display="expand" InstallDefault="followParent" Level="130" Title="$(loc.StrAFSDocDesc)">
 
                <ComponentRef Id="rcm_Documentation" />
-                
-                <ComponentRef Id="efl_Readme_TXT_$(var.Language)" />                
-                <ComponentRef Id="efl_DocHtml_en_US" />
                 <ComponentRef Id="cmp_Cmd_Ref_en_US" />
                 <ComponentRef Id="cmp_Cmd_Ref_1_en_US" />
                 <ComponentRef Id="cmp_Cmd_Ref_5_en_US" />
                 <ComponentRef Id="cmp_Cmd_Ref_8_en_US" />
                 <ComponentRef Id="cmp_Sys_Admin_Guide_en_US" />
+                <ComponentRef Id="cmp_User_Guide_en_US" />
 
                 <ComponentRef Id="cmf_afs_nt_HLP_en_US" />
                 <ComponentRef Id="cmp_Lang_en_US" />

diff --git a/src/WINNT/install/wix/files.wxi b/src/WINNT/install/wix/files.wxi
index 2efbb46..e99dec7 100644 (file)
--- a/src/WINNT/install/wix/files.wxi
+++ b/src/WINNT/install/wix/files.wxi
@@ -313,86 +313,32 @@
   <?endif?>
 
   <?ifndef BinsOnly?>
-         <?if $(var.Language) = "en_US"?>
-            <Component Id="efl_Readme_TXT_en_US" Guid="959DC63A-6C67-4B51-9F7D-2CDEE91F0099">
-                <File Id="fileREADME_TXT_en_US" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\en_US\README.txt"/>
-            </Component>
-         <?endif?>
-                        
-         <?if $(var.Language) = "zh_TW"?>
-            <Component Id="efl_Readme_TXT_zh_TW" Guid="BF25CD95-7BCD-4B0C-9999-B246199236F6">
-                <File Id="fileREADME_TXT_zh_TW" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\zh_TW\README.txt"/>
-            </Component>
-         <?endif?>
-                        
-         <?if $(var.Language) = "de_DE"?>
-            <Component Id="efl_Readme_TXT_de_DE" Guid="5F1433F0-C57D-46C8-857B-4265B95CEF24">
-                <File Id="fileREADME_TXT_de_DE" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\de_DE\README.txt"/>
-            </Component>
-         <?endif?>
-                        
-         <?if $(var.Language) = "es_ES"?>
-            <Component Id="efl_Readme_TXT_es_ES" Guid="8B0C573E-B33E-4EC5-8B3B-C08347FFAB79">
-                <File Id="fileREADME_TXT_es_ES" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\es_ES\README.txt"/>
-            </Component>
-         <?endif?>
-                        
-         <?if $(var.Language) = "ja_JP"?>
-            <Component Id="efl_Readme_TXT_ja_JP" Guid="5A15925E-00EB-4B00-A5BE-7461EE7D6C95">
-                <File Id="fileREADME_TXT_ja_JP" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\ja_JP\README.txt"/>
-            </Component>
-         <?endif?>
-                        
-         <?if $(var.Language) = "ko_KR"?>
-            <Component Id="efl_Readme_TXT_ko_KR" Guid="715D4A97-6356-41E8-8660-76D74DC88495">
-                <File Id="fileREADME_TXT_ko_KR" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\ko_KR\README.txt"/>
-            </Component>
-         <?endif?>
-     
-         <?if $(var.Language) = "pt_BR"?>
-            <Component Id="efl_Readme_TXT_pt_BR" Guid="03682CAA-66D4-472F-86DE-C508F33AE50C">
-                <File Id="fileREADME_TXT_pt_BR" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\pt_BR\README.txt"/>
-            </Component>
-         <?endif?>
-                        
-         <?if $(var.Language) = "zh_CN"?>
-            <Component Id="efl_Readme_TXT_zh_CN" Guid="6D1DD8B0-0D61-4BC4-976B-F72E087F83D4">
-                <File Id="fileREADME_TXT_zh_CN" Name="README.txt" LongName="README.txt" DiskId="1" src="$(var.SrcDir)\WINNT\doc\install\Documentation\zh_CN\README.txt"/>
-            </Component>
-         <?endif?>
-  <?endif?>
-
-  <?ifndef BinsOnly?>
             <Directory Id="dirDocumentation" Name="Docum" LongName="Documentation" SourceName="Docs">
-                               <!-- The following directory and everything below it is language dependent. -->
-                    <Directory Id="dirHtml_$(var.Language)" Name="Html" src="$(var.SrcDir)\WINNT\doc\install\Documentation\$(var.Language)\html\">
-                        <Component Id="cmf_index2_HTM_$(var.Language)" Guid="$(var.DocHtmlIndexGuid)">
-                            <File Id="fileindex2_HTM_$(var.Language)" Name="index.htm" LongName="index.htm" KeyPath="yes" DiskId="1">
-                                                               <Shortcut Id="scDoc_$(var.Language)" Directory="dirShortCut" Name="Doc$(var.Language).lnk" LongName="Documentation ($(var.Language)).lnk" Description="$(loc.StrDocLnkDesc)" Icon="ico_Help" IconIndex="0" Show="normal" WorkingDirectory="dirCommon" />
-                            </File>
+                   <!-- The following directory and everything below it is language dependent. -->
+                    <?if $(var.Language) = "en_US"?>
+                        <Component Id="cmp_Sys_Admin_Guide_en_US" Guid="$(var.DocChmSysAdminGuid)">
+                        <File Id="file_admin_guide_CHM_$(var.Language)" Name="AdminGd.chm" LongName="AdminGuide.chm" KeyPath="yes" DiskId="1" src="$(var.DocDir)\xml\AdminGuide\htmlhelp.chm">
+                                 <Shortcut Id="scDocAdmin_en_US" Directory="dirShortCutDocs" Name="AdminGd.lnk" LongName="Administrator Guide.lnk" Description="$(loc.StrDocAdminGdLnkDesc)" Icon="ico_Help" IconIndex="0" Show="normal" WorkingDirectory="dirCommon" />
+                        </File>
                         </Component>
-                        <Component Id="efl_DocHtml_$(var.Language)" Guid="$(var.DocHtmlGuid)">
-                            <File Id="filebanner_GIF_$(var.Language)" Name="banner.gif" LongName="banner.gif" DiskId="1" />
-                            <File Id="filebooks_GIF_$(var.Language)" Name="books.gif" LongName="books.gif" DiskId="1" />
-                            <File Id="filebot_GIF_$(var.Language)" Name="bot.gif" LongName="bot.gif" DiskId="1" />
-                            <File Id="fileindex_GIF_$(var.Language)" Name="index.gif" LongName="index.gif" DiskId="1" />
-                            <File Id="filenext_GIF_$(var.Language)" Name="next.gif" LongName="next.gif" DiskId="1" />
-                            <File Id="fileprev_GIF_$(var.Language)" Name="prev.gif" LongName="prev.gif" DiskId="1" />
-                            <File Id="filetoc_GIF_$(var.Language)" Name="toc.gif" LongName="toc.gif" DiskId="1" />
-                            <File Id="filetop_GIF_$(var.Language)" Name="top.gif" LongName="top.gif" DiskId="1" />
-                            <File Id="file$(var.Language)_RTF" Name="$(var.Language).rtf" LongName="$(var.Language).rtf" KeyPath="yes" DiskId="1" src="$(var.SrcDir)\WINNT\license\lang\$(var.Language).rtf"/>
+                        <Component Id="cmp_User_Guide_en_US" Guid="$(var.DocChmUserGuid)">
+                        <File Id="file_user_guide_CHM_$(var.Language)" Name="UserGd.chm" LongName="UserGuide.chm" KeyPath="yes" DiskId="1"  src="$(var.DocDir)\xml\UserGuide\htmlhelp.chm">
+                                 <Shortcut Id="scDocUser_en_US" Directory="dirShortCutDocs" Name="UserGd.lnk" LongName="User Guide.lnk" Description="$(loc.StrDocUserGdLnkDesc)" Icon="ico_Help" IconIndex="0" Show="normal" WorkingDirectory="dirCommon" />
+                        </File>
                         </Component>
-                        <Directory Id="dirindex_files_$(var.Language)" Name="index" LongName="index_files" src="$(var.SrcDir)\WINNT\doc\install\Documentation\$(var.Language)\html\index_files\">
-                            <Component Id="cmp_index_files_$(var.Language)" Guid="$(var.DocHtmlIndexFilesGuid)">
-                                <File Id="filefilelist_XML_$(var.Language)" Name="filelist.xml" LongName="filelist.xml" DiskId="1" />
-                                <File Id="fileimage001_JPG_$(var.Language)" Name="image001.jpg" LongName="image001.jpg" DiskId="1" />
-                                <File Id="fileimage002_JPG_$(var.Language)" Name="image002.jpg" LongName="image002.jpg" DiskId="1" />
-                            </Component>
-                        </Directory>
+                        <Component Id="cmp_Release_Notes_en_US" Guid="$(var.DocChmRelNotesGuid)">
+                        <File Id="file_relnotes_CHM_$(var.Language)" Name="RelNotes.chm" LongName="ReleaseNotes.chm" KeyPath="yes" DiskId="1"  src="$(var.DocDir)\xml\ReleaseNotesWindows\htmlhelp.chm">
+                                 <Shortcut Id="scDocRelNotes_en_US" Directory="dirShortCutDocs" Name="RelNotes.lnk" LongName="Release Notes.lnk" Description="$(loc.StrDocRelNotesLnkDesc)" Icon="ico_Help" IconIndex="0" Show="normal" WorkingDirectory="dirCommon" />
+                        </File>
+                        </Component>
+                    <?endif?>                        
+                    <Directory Id="dirHtml_$(var.Language)" Name="Html" src="$(var.SrcDir)\WINNT\doc\install\Documentation\$(var.Language)\html\">
                     <?if $(var.Language) = "en_US"?>
                         <Directory Id="dirCmdRef_en_US" Name="CmdRef" src="$(var.DocDir)\man-pages\html\">
                             <Component Id="cmp_Cmd_Ref_en_US" Guid="$(var.DocHtmlCmdRefGuid)">
-                                <File Id="file_CmdRef_Index_HTM_en_US" Name="index.htm" LongName="index.html" KeyPath="yes" DiskId="1" />
+                                <File Id="file_CmdRef_Index_HTM_en_US" Name="index.htm" LongName="index.html" KeyPath="yes" DiskId="1">
+                                 <Shortcut Id="scDocRefMan_$(var.Language)" Directory="dirShortCutDocs" Name="RefMan.lnk" LongName="Reference Manual.lnk" Description="$(loc.StrDocRefManLnkDesc)" Icon="ico_Help" IconIndex="0" Show="normal" WorkingDirectory="dirCommon" />
+                                </File>
                                 <File Id="file_CmdRef_Style_CSS_en_US" Name="style.css" LongName="style.css" DiskId="1" />
                             </Component>
                         <Directory Id="dirCmdRef1_en_US" Name="1" src="$(var.DocDir)\man-pages\html\1\">
@@ -717,7 +663,9 @@
                     <?else?>
                         <Directory Id="dirCmdRef_$(var.Language)" Name="CmdRef" src="$(var.SrcDir)\WINNT\doc\install\Documentation\$(var.Language)\html\CmdRef\">
                             <Component Id="cmp_Cmd_Ref_$(var.Language)" Guid="$(var.DocHtmlCmdRefGuid)">
-                                <File Id="fileauarf000_HTM_$(var.Language)" Name="auarf000.htm" LongName="auarf000.htm" KeyPath="yes" DiskId="1" />
+                                <File Id="fileauarf000_HTM_$(var.Language)" Name="auarf000.htm" LongName="auarf000.htm" KeyPath="yes" DiskId="1">
+                                         <Shortcut Id="scDocRefMan_$(var.Language)" Directory="dirShortCutDocs" Name="RefMan.lnk" LongName="Reference Manual.lnk" Description="$(loc.StrDocRefManLnkDesc)" Icon="ico_Help" IconIndex="0" Show="normal" WorkingDirectory="dirCommon" />
+                                </File>
                                 <File Id="fileauarf002_HTM_$(var.Language)" Name="auarf002.htm" LongName="auarf002.htm" DiskId="1" />
                                 <File Id="fileauarf003_HTM_$(var.Language)" Name="auarf003.htm" LongName="auarf003.htm" DiskId="1" />
                                 <File Id="fileauarf004_HTM_$(var.Language)" Name="auarf004.htm" LongName="auarf004.htm" DiskId="1" />
@@ -1011,7 +959,6 @@
                                 <File Id="fileawqbg004_HTM_$(var.Language)" Name="awqbg004.htm" LongName="awqbg004.htm" DiskId="1" />
                             </Component>
                         </Directory> <!-- InstallGd -->
-                    <?endif?>
                         <Directory Id="dirSysAdminGd_$(var.Language)" Name="SysAd" LongName="SysAdminGd" SourceName="SysAdm" LongSource="SysAdminGd" src="$(var.SrcDir)\WINNT\doc\install\Documentation\$(var.Language)\html\SysAdminGd\">
                             <Component Id="cmp_Sys_Admin_Guide_$(var.Language)" Guid="$(var.DocHtmlSysAdminGuid)">
                                 <File Id="fileauagd000_HTM_$(var.Language)" Name="auagd.htm" LongName="auagd000.htm" KeyPath="yes" DiskId="1" />
@@ -1079,6 +1026,7 @@
                                 </Component>
                             </Directory>
                         </Directory> <!-- Release Notes -->
+                    <?endif?>
                     </Directory> <!-- Html -->
             </Directory> <!-- Documentation -->
   <?endif?>
@@ -1771,7 +1719,9 @@
   <?ifndef BinsOnly ?>
     <!-- References -->
     <Directory Id="ProgramMenuFolder" Name=".">
-        <Directory Id="dirShortCut" Name="OpenAFS"/>
+        <Directory Id="dirShortCut" Name="OpenAFS">
+            <Directory Id="dirShortCutDocs" Name="Docs" LongName="Documentation" />
+        </Directory>
     </Directory>
     <Directory Id="StartupFolder" Name="." />
     <Directory Id="WindowsVolume" Name="." />

diff --git a/src/WINNT/install/wix/lang/en_US/strings.wxl b/src/WINNT/install/wix/lang/en_US/strings.wxl
index 2efd1c2..370e7ca 100644 (file)
--- a/src/WINNT/install/wix/lang/en_US/strings.wxl
+++ b/src/WINNT/install/wix/lang/en_US/strings.wxl
@@ -38,7 +38,12 @@
     <String Id="StrHlpFileDesc">AFS Client Help</String>
     <String Id="StrSvrMgrDesc">Server Manager</String>
     <String Id="StrAcctMgrDesc">Account Manager</String>
-    <String Id="StrDocLnkDesc">AFS Documentation</String>
+    <String Id="StrDocLnkDesc">OpenAFS Documentation</String>
+    <String Id="StrDocRefManLnkDesc">OpenAFS Reference Manual</String>
+    <String Id="StrDocAdminGdLnkDesc">OpenAFS Administrator Guide</String>
+    <String Id="StrDocUserGdLnkDesc">OpenAFS User Guide</String>
+    <String Id="StrDocRelNotesLnkDesc">OpenAFS Release Notes</String>
+
     <String Id="StrCfgWzdDesc">Server Configuration Wizard</String>
 
     <String Id="StrLaunchCond">OpenAFS for Windows is currently only packaged for Windows 2000,XP and 2003</String>

diff --git a/src/WINNT/install/wix/language_config.wxi b/src/WINNT/install/wix/language_config.wxi
index 8ed9c03..de2cb9b 100644 (file)
--- a/src/WINNT/install/wix/language_config.wxi
+++ b/src/WINNT/install/wix/language_config.wxi
@@ -70,6 +70,10 @@
     <?define DocHtmlRelnotesFilesGuid="D39E1662-F475-4D33-A6B5-CBC7B77891D0"?>
     <?define DocHtmlLogoFilesGuid="24E7F4AF-5D41-4D7B-B9DF-FA5787BAC787"?>
     <?define DocHtmlIndexFilesGuid="EEEA73B6-36CD-4471-BF5C-9317B90CA3CC"?>
+
+    <?define DocChmSysAdminGuid="9D78A7CB-AD7A-4464-AAF6-0046512033E8"?>
+    <?define DocChmUserGuid="B2603B9D-DD21-4B3D-B6DB-0F8E7AC58D85"?>
+    <?define DocChmRelNotesGuid="9206FE77-95FA-41D6-A014-B5903E9B1FC2"?>
 <?endif?>
        <!-- other language specific strings are defined in the strings.wxl file -->