Greek letters in documentation?

Jan 11, 2010 at 4:32 PM

Hi!

I've got some enum values in my C# project that contain greek letters. like the Omega and the mu as in micrometre.

Unfortunately sandcastle fails. Is there a way around it? Here's the log:

--------------

------ Rebuild All started: Project: CES_Excel_Reader, Configuration: Release Any CPU ------
c:\WINDOWS\Microsoft.NET\Framework\v3.5\Csc.exe /noconfig /nowarn:1701,1702 /errorreport:prompt /warn:4 /doc:bin\Release\CES_Excel_Reader.XML /define:TRACE /reference:C:\Mentor\PIAS.2007.5\MGCPCBEngines.dll /reference:"c:\Programme\Microsoft Visual Studio 9.0\Visual Studio Tools for Office\PIA\Office12\Microsoft.Office.Interop.Excel.dll" /reference:"c:\Programme\Reference Assemblies\Microsoft\Microsoft VSTO Power Tools 1.0\Office Interop Extensions\Office 12\Microsoft.Office.Interop.Excel.Extensions.dll" /reference:"C:\Programme\Reference Assemblies\Microsoft\Framework\v3.5\System.Core.dll" /reference:"C:\Programme\Reference Assemblies\Microsoft\Framework\v3.5\System.Data.DataSetExtensions.dll" /reference:c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\System.Data.dll /reference:c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\System.dll /reference:c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\System.Xml.dll /reference:"C:\Programme\Reference Assemblies\Microsoft\Framework\v3.5\System.Xml.Linq.dll" /debug:pdbonly /filealign:512 /keyfile:CES_Excel_Reader.snk /optimize+ /out:obj\Release\CES_Excel_Reader.dll /target:library CERException.cs CES_Excel_Reader.cs Enums\Enums.cs Enums\LayerType\COMImplementation.cs Enums\LayerType\COMInterface.cs Enums\LayerType\Enum.cs Enums\SpacingField\COMImplementation.cs Enums\SpacingField\Enum.cs Enums\SpacingField\COMInterface.cs Enums\Unit\ComImplementation.cs Enums\Unit\COMInterface.cs Enums\Unit\Enum.cs Functions.cs ICERException.cs LayerInfo.cs Properties\AssemblyInfo.cs R.cs RangeExtensions.cs SpacingArea.cs SpacingTable.cs Value.cs

Compile complete -- 0 errors, 0 warnings
CES_Excel_Reader -> C:\VS_PROJECTS\CES_Technologievergleich\CES_Excel_Reader\bin\Release\CES_Excel_Reader.dll
------ Rebuild All started: Project: DocProject1, Configuration: Release Any CPU ------
c:\WINDOWS\Microsoft.NET\Framework\v3.5\Csc.exe /noconfig /nowarn:1701,1702 /errorreport:prompt /warn:4 /define:TRACE /reference:C:\VS_PROJECTS\CES_Technologievergleich\CES_Excel_Reader\bin\Release\CES_Excel_Reader.dll /reference:C:\WINDOWS\assembly\GAC_MSIL\DaveSexton.DocProject\1.11.0.0__af1a4bab65cc4ece\DaveSexton.DocProject.dll /reference:"C:\Programme\Reference Assemblies\Microsoft\Framework\v3.5\System.Core.dll" /reference:"C:\Programme\Reference Assemblies\Microsoft\Framework\v3.5\System.Data.DataSetExtensions.dll" /reference:c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\System.dll /reference:"C:\Programme\Reference Assemblies\Microsoft\Framework\v3.5\System.Xml.Linq.dll" /debug:pdbonly /optimize+ /out:obj\Release\DocProject1.dll /target:library BuildProcess.cs Properties\AssemblyInfo.cs

Compile complete -- 0 errors, 0 warnings
DocProject1 -> C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\bin\Release\DocProject1.dll

Starting help build for DocProject1...
Preparing target directory...
Merging XML documentation for CES_Excel_Reader.dll...
Building documentation for DocProject1...

Step 1 of 12: Change Directory

Changing current directory from "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\Help\" to "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp"

Step 1 Time Elapsed: 00:00:00

Step 2 of 12: Execute MRefBuilder

C:\Programme\Sandcastle\ProductionTools\MRefBuilder /config:"C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\Help\Presentation\Style\Configuration\MRefBuilder.config" /out:reflection.org /internal- /dep:"c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\mscorlib.dll","C:\WINDOWS\assembly\GAC\Microsoft.Office.Interop.Excel\12.0.0.0__71e9bce111e9429c\Microsoft.Office.Interop.Excel.dll","c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\mscorlib.dll","C:\WINDOWS\assembly\GAC\office\12.0.0.0__71e9bce111e9429c\office.dll","C:\WINDOWS\assembly\GAC\stdole\7.0.3300.0__b03f5f7f11d50a3a\stdole.dll","c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\mscorlib.dll","C:\WINDOWS\assembly\GAC\Microsoft.Vbe.Interop\12.0.0.0__71e9bce111e9429c\Microsoft.Vbe.Interop.dll","C:\WINDOWS\assembly\GAC_MSIL\System.Core\3.5.0.0__b77a5c561934e089\System.Core.dll","C:\WINDOWS\assembly\GAC_MSIL\System\2.0.0.0__b77a5c561934e089\System.dll","C:\WINDOWS\assembly\GAC_MSIL\System.Configuration\2.0.0.0__b03f5f7f11d50a3a\System.Configuration.dll","C:\WINDOWS\assembly\GAC_MSIL\System.Xml\2.0.0.0__b77a5c561934e089\System.Xml.dll","C:\WINDOWS\assembly\GAC_MSIL\System.Data.SqlXml\2.0.0.0__b77a5c561934e089\System.Data.SqlXml.dll","C:\WINDOWS\assembly\GAC_MSIL\System.Security\2.0.0.0__b03f5f7f11d50a3a\System.Security.dll" "C:\VS_PROJECTS\CES_Technologievergleich\CES_Excel_Reader\bin\Release\CES_Excel_Reader.dll"

MrefBuilder (v2.4.10520.1)
Copyright ¸ Microsoft 2006
Info: Loaded 1 assemblies for reflection and 13 dependency assemblies.
Info: Wrote information on 1 namespaces, 16 types, and 75 members

Step 2 Time Elapsed: 00:00:00.8905338

Step 3 of 12: Execute XslTransform

C:\Programme\Sandcastle\ProductionTools\XslTransform /xsl:"C:\Programme\Sandcastle\ProductionTransforms\ApplyVSDocModel.xsl" "reflection.org" /arg:project="Project" /xsl:"C:\Programme\Sandcastle\ProductionTransforms\AddFriendlyFilenames.xsl" /out:"reflection.xml" /arg:IncludeAllMembersTopic=true /arg:IncludeInheritedOverloadTopics=true

XslTransform (v2.4.10520.1)
Copyright ¸ Microsoft 2005-2006
Info: Applying XSL transformation 'C:\Programme\Sandcastle\ProductionTransforms\ApplyVSDocModel.xsl'.
Info: Applying XSL transformation 'C:\Programme\Sandcastle\ProductionTransforms\AddFriendlyFilenames.xsl'.

Step 3 Time Elapsed: 00:00:01.2342486

Step 4 of 12: Copy File

Copy "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp\reflection.xml" to "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp\assembler\reflection.xml" and overwrite.

Step 4 Time Elapsed: 00:00:00

Step 5 of 12: Execute XslTransform

C:\Programme\Sandcastle\ProductionTools\XslTransform /xsl:"C:\Programme\Sandcastle\ProductionTransforms\ReflectionToManifest.xsl" "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp\assembler\reflection.xml" /out:"manifest.xml"

XslTransform (v2.4.10520.1)
Copyright ¸ Microsoft 2005-2006
Info: Applying XSL transformation 'C:\Programme\Sandcastle\ProductionTransforms\ReflectionToManifest.xsl'.

Step 5 Time Elapsed: 00:00:00.6093126

Step 6 of 12: Execute XslTransform

C:\Programme\Sandcastle\ProductionTools\XslTransform /xsl:"C:\Programme\Sandcastle\ProductionTransforms\CreateVSToc.xsl" "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp\assembler\reflection.xml" /out:"toc.xml"

XslTransform (v2.4.10520.1)
Copyright ¸ Microsoft 2005-2006
Info: Applying XSL transformation 'C:\Programme\Sandcastle\ProductionTransforms\CreateVSToc.xsl'.

Step 6 Time Elapsed: 00:00:00.6561828

Step 7 of 12: Build Assembler {sandcastle.help1x.config}

Preparing...
Executing...

Topics processed: 113

Step 7 Time Elapsed: 00:00:43.2768180

Step 8 of 12: Copy Directory

Deep copy *.htm in "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\Help\Topics\Html" to "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp\assembler\Output\html".

Step 8 Time Elapsed: 00:00:00

Step 9 of 12: Change Directory

Changing current directory from "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp" to "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\"

Step 9 Time Elapsed: 00:00:00

Step 10 of 12: Execute ChmBuilder

C:\Programme\Sandcastle\ProductionTools\ChmBuilder /html:"C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp\assembler\Output\html" /toc:"C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\buildhelp\toc.xml" /project:"CES_Excel_Reader" /lcid:1033 /metadata- /out:Help\ /config:"C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\Help\Settings\Projects\help1x.config"

ChmBuilder (v2.4.10520.1)
Copyright ¸ MS 2007
Processed 113 files.

Step 10 Time Elapsed: 00:00:01.3123656

Step 11 of 12: Execute DBCSFix

C:\Programme\Sandcastle\ProductionTools\DBCSFix /d:"Help\Html" /l:1033

DBCSFix (v2.4.10520.1)
Copyright ¸  2007
Converting unsupported high-order characters to 7-bit ASCII equivalents.
EncodingName: Windows-1252

Step 11 Time Elapsed: 00:00:00.5780658

Step 12 of 12: Compile Help 1.x

C:\Programme\Html Help Workshop\hhc.exe "C:\VS_PROJECTS\CES_Technologievergleich\DocProject1\Help\CES_Excel_Reader.hhp"

Microsoft HTML Help Compiler 4.74.8702
Compiling c:\VS_PROJECTS\CES_Technologievergleich\DocProject1\Help\CES_Excel_Reader.chm
HHC4003: Warning: The following option line does not contain an '=' character separating the option and its value: [OPTIONS].
HHC5013: Error: URL reference in the TOC cannot be resolved: "html\P_CES_Excel_Reader_UnitComImplementation_µm.htm".
The following files were not compiled:

Step 12 DaveSexton.DocProject.Engine.ExternalProcessException: Compile Help 1.x:
The "C:\Programme\Html Help Workshop\hhc.exe" process failed with exit code: 1.
 
Successful Steps: 11 of 12
Failed Steps: 1

DocProject1 help build failed.

========== Rebuild All: 1 succeeded, 1 failed, 0 skipped ==========
Non-zero exit code: 1

Total Time Elapsed: 00:00:53.5882620

 

 

--------

Lots of Greetings!

Volker

Editor
Jan 11, 2010 at 8:24 PM

It's actually the Help 1 compiler that's failing.  It doesn't know how to handle the Unicode characters in the filenames in its project files.  Switch your help project's naming method option to use GUID naming rather than friendly names to work around the issue.

Eric

 

Jan 12, 2010 at 11:57 AM

It worked!

Thanks a whole lot!

Volker