Merge branch 'feature/166-improve-TSaveSourceDlg-usage+appearance' into develop

Fixes #166

Author: delphidabbler

Docs/Design/FileFormats/saved.html

@@ -51,13 +51,13 @@ <h2>
 
 <ol>
   <li>
-    By saving snippet information to file from the <em>File | Save Snippet Information</em> menu option.
+    By saving snippet information using the <em>File | Save Snippet Information</em> menu option.
   </li>
   <li>
-    By saving snippets to file from the <em>File | Save Snippet</em> menu option.
+    By saving snippets using the <em>File | Save Snippet</em> menu option.
   </li>
   <li>
-    By saving units to file from the <em>File | Save Unit</em> menu option.
+    By saving units using the <em>File | Save Unit</em> menu option.
   </li>
 </ol>
 
@@ -115,7 +115,7 @@ <h2>
 </h2>
 
 <p>
-  The available encodings used depend on the file type and user choice. Different file
+  The available encodings depend on the file type and user choice. Different file
   types have different encoding choices, as follows:
 </p>
 
@@ -132,10 +132,10 @@ <h2>
         UTF-8
       </li>
       <li>
-        Unicode little endian (UTF16-LE)
+        UTF-16LE
       </li>
       <li>
-        Unicode big endian (UTF16-BE)
+        UTF-16BE
       </li>
     </ul>
   </dd>
@@ -178,7 +178,26 @@ <h2>
   <dd>
     <ul class="squashed">
       <li>
-        ASCII [for Snippet Information] or ANSI [otherwise]. Regardless of naming, ASCII format is always used.
+        ASCII
+      </li>
+    </ul>
+  </dd>
+  <dt>
+    Markdown
+  </dt>
+  <dd>
+    <ul class="squashed">
+      <li>
+        ANSI (system default code page)
+      </li>
+      <li>
+        UTF-8
+      </li>
+      <li>
+        UTF-16LE
+      </li>
+      <li>
+        UTF-16BE
       </li>
     </ul>
   </dd>

Src/Help/HTML/dlg_saveinfo.htm

@@ -68,7 +68,8 @@ <h1>
     </p>
     <ul>
         <li>
-            <em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
+            <em>ANSI Code Page <code>nnn</code></em> &ndash; ANSI encoding for the system default code page,
+            where <code>nnn</code> is the code page for the user's locale.
             Available as an option for plain text and Markdown file formats.
         </li>
         <li>
@@ -77,14 +78,12 @@ <h1>
             as the only encoding available for HTML 5 and XHTML file formats.
         </li>
         <li>
-            <em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
-            BOM<sup>&dagger;</sup>. Available as an option for plain text files and Markdown
-            file formats.
+            <em>UTF-16 Little Endian</em> &ndash; UTF-16 LE encoding, with
+            BOM<sup>&dagger;</sup>. Available as an option for plain text and Markdown file formats.
         </li>
         <li>
-            <em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
-            BOM<sup>&dagger;</sup>. Available as an option for plain text files and Markdown
-            file formats.
+            <em>UTF-18 Big Endian</em> &ndash; UTF-16 BE encoding, with
+            BOM<sup>&dagger;</sup>. Available as an option for plain text and Markdown file formats.
         </li>
         <li>
             <em>ASCII</em> &ndash; The only encoding available for the rich text file.

Src/Help/HTML/dlg_savesnippet.htm

@@ -104,29 +104,34 @@ <h1>
     <p>
       The output file encoding can be be specified in the <em>File Encoding</em>
       drop down list. Options vary depending on the file type. Some file types
-      support only a single encoding. The encodings are:
+      support only a single encoding, in which case the drop down list will be
+      disabled. The encodings are:
     </p>
     <ul>
       <li>
-        <em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
-        Available for both plain text and Pascal include files and as the only
-        option for rich text files.
+        <em>ANSI Code Page <code>nnn</code></em> &ndash; ANSI encoding for the system default code page,
+        where <code>nnn</code> is the code page for the user's locale.
+        Available for both plain text and Pascal include files.
       </li>
       <li>
         <em>UTF-8</em> &ndash; UTF-8 encoding, with BOM<sup>&dagger;</sup>.
         Available for both plain text and Pascal include files and as the only
-        option for XHTML files. If used for Pascal include files be warned that
+        option for HTML5 and XHTML files. If used for Pascal include files be warned that
         the files will only compile with compilers that support Unicode source
         files.
       </li>
       <li>
-        <em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
+        <em>UTF-16 Little Endian</em> &ndash; UTF-16 LE encoding, with
         BOM<sup>&dagger;</sup>. Available for plain text files only.
       </li>
       <li>
-        <em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
+        <em>UTF-18 Big Endian</em> &ndash; UTF-16 BE encoding, with
         BOM<sup>&dagger;</sup>. Available for plain text files only.
       </li>
+      <li>
+        <em>ASCII</em> &ndash; ASCII encoding. Available as the only option for
+        rich text files.
+      </li>
     </ul>
     <p>
       The output can be previewed by clicking the <em>Preview</em> button. This

Src/Help/HTML/dlg_saveunit.htm

@@ -89,29 +89,34 @@ <h1>
     <p>
       The output file encoding can be be specified in the <em>File Encoding</em>
       drop down list. Options vary depending on the file type. Some file types
-      support only a single encoding. The encodings are:
+      support only a single encoding, in which case the drop down list will be
+      disabled. The encodings are:
     </p>
     <ul>
       <li>
-        <em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
-        Available for both plain text and Pascal unit files and as the only
-        option for rich text files.
+        <em>ANSI Code Page <code>nnn</code></em> &ndash; ANSI encoding for the system default code page,
+        where <code>nnn</code> is the code page for the user's locale.
+        Available for both plain text and Pascal unit files.
       </li>
       <li>
         <em>UTF-8</em> &ndash; UTF-8 encoding, with BOM<sup>&dagger;</sup>.
         Available for both plain text and Pascal unit files and as the only
-        option for XHTML files. If used for Pascal units be warned that the
+        option for HTML 5 and XHTML files. If used for Pascal units be warned that the
         unit will only compile with compilers that support Unicode source
         files.
       </li>
       <li>
-        <em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
+        <em>UTF-16 Little Endian</em> &ndash; UTF-16 LE encoding, with
         BOM<sup>&dagger;</sup>. Available for plain text files only.
       </li>
       <li>
-        <em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
+        <em>UTF-18 Big Endian</em> &ndash; UTF-16 BE encoding, with
         BOM<sup>&dagger;</sup>. Available for plain text files only.
       </li>
+      <li>
+        <em>ASCII</em> &ndash; ASCII encoding. Available as the only option for
+        rich text files.
+      </li>
     </ul>
     <p>
       The output can be previewed by clicking the <em>Preview</em> button. This

Src/USaveInfoMgr.pas

@@ -151,6 +151,8 @@ destructor TSaveInfoMgr.Destroy;
 end;
 
 procedure TSaveInfoMgr.DoExecute;
+resourcestring
+  sDlgCaption = 'Save Snippet Information for %s';
 var
   Encoding: TEncoding;        // encoding to use for output file
   FileContent: string;        // output file content before encoding
@@ -164,6 +166,9 @@ procedure TSaveInfoMgr.DoExecute;
     1
   );
   fSaveDlg.FileName := fSourceFileInfo.DefaultFileName;
+  fSaveDlg.Title := Format(sDlgCaption, [
+    (fView as ISnippetView).Snippet.DisplayName]
+  );
   // Display dialog box and save file if user OKs
   if fSaveDlg.Execute then
   begin
@@ -268,20 +273,13 @@ constructor TSaveInfoMgr.InternalCreate(AView: IView);
 const
   DlgHelpKeyword = 'SnippetInfoFileDlg';
 resourcestring
-  sDefFileName = 'SnippetInfo';
-  sDlgCaption = 'Save Snippet Information';
-  // descriptions of supported encodings
-  sASCIIEncoding = 'ASCII';
-  sANSIDefaultEncoding = 'ANSI (Default)';
-  sUTF8Encoding = 'UTF-8';
-  sUTF16LEEncoding = 'Unicode (Little Endian)';
-  sUTF16BEEncoding = 'Unicode (Big Endian)';
   // descriptions of supported file filter strings
   sRTFDesc = 'Rich text file';
   sTextDesc = 'Plain text file';
   sHTML5Desc = 'HTML 5 file';
   sXHTMLDesc = 'XHTML file';
   sMarkdownDesc = 'Markdown file';
+
 begin
   inherited InternalCreate;
   fView := AView;
@@ -290,50 +288,34 @@ constructor TSaveInfoMgr.InternalCreate(AView: IView);
   fSourceFileInfo.FileTypeInfo[sfRTF] := TSourceFileTypeInfo.Create(
     '.rtf',
     sRTFDesc,
-    [
-      TSourceFileEncoding.Create(etASCII, sASCIIEncoding)
-    ]
+    [etASCII]
   );
   fSourceFileInfo.FileTypeInfo[sfText] := TSourceFileTypeInfo.Create(
     '.txt',
     sTextDesc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding),
-      TSourceFileEncoding.Create(etUTF16LE, sUTF16LEEncoding),
-      TSourceFileEncoding.Create(etUTF16BE, sUTF16BEEncoding),
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding)
-    ]
+    [etUTF8, etUTF16LE, etUTF16BE, etSysDefault]
   );
   fSourceFileInfo.FileTypeInfo[sfHTML5] := TSourceFileTypeInfo.Create(
     '.html',
     sHTML5Desc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
-  fSourceFileInfo.DefaultFileName := sDefFileName;
   fSourceFileInfo.FileTypeInfo[sfXHTML] := TSourceFileTypeInfo.Create(
     '.html',
     sXHTMLDesc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
-  fSourceFileInfo.DefaultFileName := sDefFileName;
   fSourceFileInfo.FileTypeInfo[sfMarkdown] := TSourceFileTypeInfo.Create(
     '.md',
     sMarkdownDesc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding),
-      TSourceFileEncoding.Create(etUTF16LE, sUTF16LEEncoding),
-      TSourceFileEncoding.Create(etUTF16BE, sUTF16BEEncoding),
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding)
-    ]
+    [etUTF8, etUTF16LE, etUTF16BE, etSysDefault]
   );
-  fSourceFileInfo.DefaultFileName := sDefFileName;
+
+  // set default file name without converting to valid Pascal identifier
+  fSourceFileInfo.RequirePascalDefFileName := False;
+  fSourceFileInfo.DefaultFileName := fView.Description;
 
   fSaveDlg := TSaveSourceDlg.Create(nil);
-  fSaveDlg.Title := sDlgCaption;
   fSaveDlg.HelpKeyword := DlgHelpKeyword;
   fSaveDlg.CommentStyle := TCommentStyle.csNone;
   fSaveDlg.EnableCommentStyles := False;

Src/USaveSnippetMgr.pas

@@ -92,8 +92,8 @@ implementation
 
 resourcestring
   // Dialog box title
-  sSaveSnippetDlgTitle = 'Save %0:s Snippet';
-  sSaveCategoryDlgTitle = 'Save %0:s Category';
+  sSaveSnippetDlgTitle = 'Save Annotated Source of %0:s';
+  sSaveCategoryDlgTitle = 'Save Annotated Source of %0:s Category';
   // Output document title for snippets and categories
   sDocTitle = '"%0:s" %1:s';
   sCategory = 'category';

Src/USaveSourceDlg.pas

@@ -228,8 +228,6 @@ implementation
   sChkTruncateComment = 'Truncate comments to 1st paragraph';
   sBtnPreview = '&Preview...';
   sBtnHelp = '&Help';
-  // Default encoding name
-  sANSIEncoding = 'ANSI (Default)';
 
 
 const
@@ -483,7 +481,7 @@ procedure TSaveSourceDlg.DoTypeChange;
     fOnEncodingQuery(Self, Encodings);
   if Length(Encodings) = 0 then
     Encodings := TSourceFileEncodings.Create(
-      TSourceFileEncoding.Create(etSysDefault, sANSIEncoding)
+      TSourceFileEncoding.Create(etSysDefault)
     );
   fCmbEncoding.Clear;
   for Encoding in Encodings do
@@ -495,6 +493,8 @@ procedure TSaveSourceDlg.DoTypeChange;
   fCmbEncoding.ItemIndex := IndexOfEncodingType(fSelectedEncoding);
   if fCmbEncoding.ItemIndex = -1 then
     fCmbEncoding.ItemIndex := 0;
+  fCmbEncoding.Enabled := fCmbEncoding.Items.Count > 1;
+  fLblEncoding.Enabled := fCmbEncoding.Enabled;
   DoEncodingChange;
 
   inherited;

Src/USaveSourceMgr.pas

@@ -134,8 +134,8 @@ implementation
   // Delphi
   SysUtils,
   // Project
-  FmPreviewDlg, Hiliter.UFileHiliter, UIOUtils, UMessageBox, UOpenDialogHelper,
-  UPreferences;
+  FmPreviewDlg, Hiliter.UFileHiliter, UIOUtils, UMessageBox,
+  UOpenDialogHelper, UPreferences;
 
 
 { TSaveSourceMgr }
@@ -244,53 +244,33 @@ procedure TSaveSourceMgr.HiliteQueryHandler(Sender: TObject;
 end;
 
 constructor TSaveSourceMgr.InternalCreate;
-resourcestring
-  // descriptions of supported encodings
-  sANSIDefaultEncoding = 'ANSI (Default)';
-  sUTF8Encoding = 'UTF-8';
-  sUTF16LEEncoding = 'Unicode (Little Endian)';
-  sUTF16BEEncoding = 'Unicode (Big Endian)';
 begin
   inherited InternalCreate;
   fSourceFileInfo := TSourceFileInfo.Create;
   fSourceFileInfo.FileTypeInfo[sfText] := TSourceFileTypeInfo.Create(
     '.txt',
     GetFileTypeDesc(sfText),
-    [
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding),
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding),
-      TSourceFileEncoding.Create(etUTF16LE, sUTF16LEEncoding),
-      TSourceFileEncoding.Create(etUTF16BE, sUTF16BEEncoding)
-    ]
+    [etSysDefault, etUTF8, etUTF16LE, etUTF16BE]
   );
   fSourceFileInfo.FileTypeInfo[sfPascal] := TSourceFileTypeInfo.Create(
     '.pas',
     GetFileTypeDesc(sfPascal),
-    [
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding),
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etSysDefault, etUTF8]
   );
   fSourceFileInfo.FileTypeInfo[sfHTML5] := TSourceFileTypeInfo.Create(
     '.html',
     GetFileTypeDesc(sfHTML5),
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
   fSourceFileInfo.FileTypeInfo[sfXHTML] := TSourceFileTypeInfo.Create(
     '.html',
     GetFileTypeDesc(sfXHTML),
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
   fSourceFileInfo.FileTypeInfo[sfRTF] := TSourceFileTypeInfo.Create(
     '.rtf',
     GetFileTypeDesc(sfRTF),
-    [
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding)
-    ]
+    [etASCII]
  );
   fSourceFileInfo.DefaultFileName := GetDefaultFileName;