altinoren.com - WiX http://altinoren.com/ Gokhan Altinoren's Blog and Projects en-us Gokhan Altinoren Mon, 29 Jan 2007 21:13:31 GMT newtelligence dasBlog 2.3.9074.18820 gokhan@altinoren.com gokhan@altinoren.com http://altinoren.com/Trackback.aspx?guid=4a6f9362-0752-413f-9b2d-08d96ee2a665 http://altinoren.com/pingback.aspx http://altinoren.com/PermaLink,guid,4a6f9362-0752-413f-9b2d-08d96ee2a665.aspx Gokhan Altinoren I was trying to solve the Custom Tool property issue with .actiw files in ActiveWriter, as suggested by Bogdan Pietroiu months ago, and spent a clear hour trying to figure how to inject my own registry keys into WiX setup project of DSL Tools. I modified the .vstemplate for .actiw files to include the following:

...

<CustomParameters>

  <CustomParameterName="$itemproperties$"Value="CustomTool" />

  <CustomParameterName="$CustomTool$"Value="ActiveWriterCodeGenerator" />

</CustomParameters>

...


and thought that the file, when added to the project, will have Custom Tool property already set. I was appearently wrong (documentation says it should work).

Bogdan's suggestion was to have a key named after the file extension under Generators\{Language}, and I manually confirmed that it works great. So, how to automate the process of adding this reg key through the setup? WiX Toolkit documentation shows the way, so I copied Registry.wxs to have my own key registered.

<?xmlversion="1.0"encoding="utf-8"?>

<Wixxmlns='http://schemas.microsoft.com/wix/2003/01/wi'>

  <FragmentId="CustomToolFragment">

    <FeatureRefId="DefaultFeature">

      <ComponentRefId="_ActiveWriterCTReg" />

    </FeatureRef>

    <DirectoryRefId="TARGETDIR">

      <ComponentId="_ActiveWriterCTReg"Guid="{some GUID}">

        <RegistryRoot='HKLM'Key='Software\Microsoft\VisualStudio\8.0\Generators\{164b10b9-b200-11d0-8c61-00a0c91e29d5}\.actiw'Id='{some GUID}'Type='string'Value='ActiveWriterCodeGenerator' />

        <RegistryRoot='HKLM'Key='Software\Microsoft\VisualStudio\8.0\Generators\{fae04ec1-301f-11d3-bf4b-00c04f79efbc}\.actiw'Id='{some GUID}'Type='string'Value='ActiveWriterCodeGenerator' />

      </Component>

    </DirectoryRef>

  </Fragment>

</Wix>


<Registry>elements define the key to be added, as you may have guessed. Anyway, although I changed the build action on the .wxs and although it seems that Candle and Light picked up the file, the installer didn't add the registry key. So? Orca to the rescue. You should check Component and Registry tables in .msi file to check if your key slipped in, and Orca shows them quite detailed. In my case, though, it shows the absence of my additions.

Long story (not so) short, it seems that I should examine Registry.tt as the first step, but didn't. To include your ComponentRef in DefaultFeature, you should have your Fragment as FragmentRef in Main.wxs . So, you should add each of your custom fragment in the list defined in customFragmentIds in InstallerDefinitions.dslsetup as shown below:

<installerDefinitionxmlns="http://schemas.microsoft.com/VisualStudio/2005/DslTools/InstallerDefinitionModel"

  ...

  customFragmentIds="CustomToolFragment">

I hope this info helps someone.

How To: Create additional registry keys with DSL Tools Setup Projects http://altinoren.com/PermaLink,guid,4a6f9362-0752-413f-9b2d-08d96ee2a665.aspx http://altinoren.com/PermaLink,guid,4a6f9362-0752-413f-9b2d-08d96ee2a665.aspx Mon, 29 Jan 2007 21:13:31 GMT I was trying to solve the Custom Tool property issue with .actiw files in ActiveWriter, as suggested by Bogdan Pietroiu months ago, and spent a clear hour trying to figure how to inject my own registry keys into WiX setup project of <a href="http://msdn2.microsoft.com/en-us/vstudio/aa718368.aspx">DSL Tools</a>. I modified the .vstemplate for .actiw files to include the following:<br> <br> <div style="background: white none repeat scroll 0% 50%; font-family: Lucida Console; font-size: 12pt; color: black; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> <p style="margin: 0px;"> <span style="color: blue;">...<br> </span> </p> <p style="margin: 0px;"> <span style="color: blue;">&lt;</span><span style="color: maroon;">CustomParameters</span><span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &lt;</span><span style="color: maroon;">CustomParameter</span><span style="color: blue;"> </span><span style="color: red;">Name</span><span style="color: blue;">=</span>"<span style="color: blue;">$itemproperties$</span>"<span style="color: blue;"> </span><span style="color: red;">Value</span><span style="color: blue;">=</span>"<span style="color: blue;">CustomTool</span>"<span style="color: blue;"> /&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &lt;</span><span style="color: maroon;">CustomParameter</span><span style="color: blue;"> </span><span style="color: red;">Name</span><span style="color: blue;">=</span>"<span style="color: blue;">$CustomTool$</span>"<span style="color: blue;"> </span><span style="color: red;">Value</span><span style="color: blue;">=</span>"<span style="color: blue;">ActiveWriterCodeGenerator</span>"<span style="color: blue;"> /&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&lt;/</span><span style="color: maroon;">CustomParameters</span><span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">...<br> </span> </p> </div> <br> and thought that the file, when added to the project, will have Custom Tool property already set. I was appearently wrong (documentation says it should work).<br> <br> Bogdan's suggestion was to have a key named after the file extension under <font face="Arial" size="2"><span style="font-size: 10pt; font-family: Arial;"><b>Generators\{Language}</b>, and I manually confirmed that it works great. So, how to automate the process of adding this reg key through the setup? </span></font>WiX<font face="Arial" size="2"><span style="font-size: 10pt; font-family: Arial;"> Toolkit <a href="http://wix.sourceforge.net/manual-wix2/wix_xsd_registry.htm">documentation</a> shows the way, so I copied Registry.wxs to have my own key registered.<br> <br> </span></font> <div style="background: white none repeat scroll 0% 50%; font-family: Lucida Console; font-size: 12pt; color: black; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> <p style="margin: 0px;"> <span style="color: blue;">&lt;?</span><span style="color: maroon;">xml</span><span style="color: blue;"> </span><span style="color: red;">version</span><span style="color: blue;">=</span>"<span style="color: blue;">1.0</span>"<span style="color: blue;"> </span><span style="color: red;">encoding</span><span style="color: blue;">=</span>"<span style="color: blue;">utf-8</span>"<span style="color: blue;">?&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&lt;</span><span style="color: maroon;">Wix</span><span style="color: blue;"> </span><span style="color: red;">xmlns</span><span style="color: blue;">=</span>'<span style="color: blue;">http://schemas.microsoft.com/wix/2003/01/wi</span>'<span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &lt;</span><span style="color: maroon;">Fragment</span><span style="color: blue;"> </span><span style="color: red;">Id</span><span style="color: blue;">=</span>"<span style="color: blue;">CustomToolFragment</span>"<span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &lt;</span><span style="color: maroon;">FeatureRef</span><span style="color: blue;"> </span><span style="color: red;">Id</span><span style="color: blue;">=</span>"<span style="color: blue;">DefaultFeature</span>"<span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &nbsp; &lt;</span><span style="color: maroon;">ComponentRef</span><span style="color: blue;"> </span><span style="color: red;">Id</span><span style="color: blue;">=</span>"<span style="color: blue;">_ActiveWriterCTReg</span>"<span style="color: blue;"> /&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &lt;/</span><span style="color: maroon;">FeatureRef</span><span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &lt;</span><span style="color: maroon;">DirectoryRef</span><span style="color: blue;"> </span><span style="color: red;">Id</span><span style="color: blue;">=</span>"<span style="color: blue;">TARGETDIR</span>"<span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &nbsp; &lt;</span><span style="color: maroon;">Component</span><span style="color: blue;"> </span><span style="color: red;">Id</span><span style="color: blue;">=</span>"<span style="color: blue;">_ActiveWriterCTReg</span>"<span style="color: blue;"> </span><span style="color: red;">Guid</span><span style="color: blue;">=</span>"{some GUID}<span style="color: blue;"></span>"<span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &nbsp; &nbsp; &lt;</span><span style="color: maroon;">Registry</span><span style="color: blue;"> </span><span style="color: red;">Root</span><span style="color: blue;">=</span>'<span style="color: blue;">HKLM</span>'<span style="color: blue;"> </span><span style="color: red;">Key</span><span style="color: blue;">=</span>'<span style="color: blue;">Software\Microsoft\VisualStudio\8.0\Generators\{164b10b9-b200-11d0-8c61-00a0c91e29d5}\.actiw</span>'<span style="color: blue;"> </span><span style="color: red;">Id</span><span style="color: blue;">=</span>'{some GUID}'<span style="color: blue;"> </span><span style="color: red;">Type</span><span style="color: blue;">=</span>'<span style="color: blue;">string</span>'<span style="color: blue;"> </span><span style="color: red;">Value</span><span style="color: blue;">=</span>'<span style="color: blue;">ActiveWriterCodeGenerator</span>'<span style="color: blue;"> /&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &nbsp; &nbsp; &lt;</span><span style="color: maroon;">Registry</span><span style="color: blue;"> </span><span style="color: red;">Root</span><span style="color: blue;">=</span>'<span style="color: blue;">HKLM</span>'<span style="color: blue;"> </span><span style="color: red;">Key</span><span style="color: blue;">=</span>'<span style="color: blue;">Software\Microsoft\VisualStudio\8.0\Generators\{fae04ec1-301f-11d3-bf4b-00c04f79efbc}\.actiw</span>'<span style="color: blue;"> </span><span style="color: red;">Id</span><span style="color: blue;">=</span>'{some GUID}'<span style="color: blue;"> </span><span style="color: red;">Type</span><span style="color: blue;">=</span>'<span style="color: blue;">string</span>'<span style="color: blue;"> </span><span style="color: red;">Value</span><span style="color: blue;">=</span>'<span style="color: blue;">ActiveWriterCodeGenerator</span>'<span style="color: blue;"> /&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &nbsp; &lt;/</span><span style="color: maroon;">Component</span><span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &nbsp; &lt;/</span><span style="color: maroon;">DirectoryRef</span><span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; &lt;/</span><span style="color: maroon;">Fragment</span><span style="color: blue;">&gt;</span> </p> <p style="margin: 0px;"> <span style="color: blue;">&lt;/</span><span style="color: maroon;">Wix</span><span style="color: blue;">&gt;</span> </p> </div> <br> <span style="color: blue;">&lt;</span><span style="color: maroon;">Registry</span><span style="color: blue;">&gt;</span><span style="color: maroon;"> </span>elements define the key to be added, as you may have guessed. Anyway, although I changed the build action on the .wxs and although it seems that Candle and Light picked up the file, the installer didn't add the registry key. So? <a href="http://blogs.msdn.com/astebner/archive/2004/07/12/180792.aspx">Orca</a> to the rescue. You should check Component and Registry tables in .msi file to check if your key slipped in, and Orca shows them quite detailed. In my case, though, it shows the absence of my additions.<br> <br> Long story (not so) short, it seems that I should examine <b>Registry.tt</b> as the first step, but didn't. To include your ComponentRef in DefaultFeature, you should have your Fragment as FragmentRef in Main.wxs . So, you should add each of your custom fragment in the list defined in <b>customFragmentIds</b> in InstallerDefinitions.dslsetup as shown below:<br> <br> <div style="background: white none repeat scroll 0% 50%; font-family: Lucida Console; font-size: 12pt; color: black; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> <p style="margin: 0px;"> <span style="color: blue;">&lt;</span><span style="color: maroon;">installerDefinition</span><span style="color: blue;"> </span><span style="color: red;">xmlns</span><span style="color: blue;">=</span>"<span style="color: blue;">http://schemas.microsoft.com/VisualStudio/2005/DslTools/InstallerDefinitionModel</span>"<span style="color: blue;"> </span> </p> <p style="margin: 0px;"> <span style="color: blue;">&nbsp; </span><span style="color: red;">...</span> </p> <span style="color: blue;">&nbsp; </span><span style="color: red;">customFragmentIds</span><span style="color: blue;">=</span>"<span style="color: blue;">CustomToolFragment</span>"<span style="color: blue;">&gt;</span> </div> <br> I hope this info helps someone.<br> <p> </p> <img width="0" height="0" src="http://altinoren.com/aggbug.ashx?id=4a6f9362-0752-413f-9b2d-08d96ee2a665" /> ActiveWriter WiX Setup DSL Tools