view contrib/wix/doc.wxs @ 25881:9de443515f1d stable

help: scripting help topic

There are a lot of non-human consumers of Mercurial. And the challenges
and considerations for machines consuming Mercurial is significantly
different from what humans face.

I think there are enough special considerations around how machines
consume Mercurial that a dedicated help topic is warranted. I concede
the audience for this topic is probably small compared to the general
audience. However, lots of normal Mercurial users do things like create
one-off shell scripts for common workflows that I think this is useful
enough to be in the install (as opposed to, say, a wiki page - which
most users will likely never find).

This text is by no means perfect. But you have to start somewhere. I
think I did cover the important parts, though.

<?xml version="1.0" encoding="utf-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">

  <?include guids.wxi ?>
  <?include defines.wxi ?>

  <Fragment>
    <ComponentGroup Id="docFolder">
      <ComponentRef Id="doc.hg.1.html" />
      <ComponentRef Id="doc.hgignore.5.html" />
      <ComponentRef Id="doc.hgrc.5.html" />
      <ComponentRef Id="doc.style.css" />
    </ComponentGroup>
  </Fragment>

  <Fragment>
    <DirectoryRef Id="INSTALLDIR">
      <Directory Id="docdir" Name="doc" FileSource="$(var.SourceDir)">
        <Component Id="doc.hg.1.html" Guid="$(var.doc.hg.1.html.guid)" Win64='$(var.IsX64)'>
          <File Name="hg.1.html" KeyPath="yes">
            <Shortcut Id="hg1StartMenu" Directory="ProgramMenuDir"
                      Name="Mercurial Command Reference"
                      Icon="hgIcon.ico" IconIndex="0" Advertise="yes"
            />
          </File>
        </Component>
        <Component Id="doc.hgignore.5.html" Guid="$(var.doc.hgignore.5.html.guid)" Win64='$(var.IsX64)'>
          <File Name="hgignore.5.html" KeyPath="yes">
            <Shortcut Id="hgignore5StartMenu" Directory="ProgramMenuDir"
                      Name="Mercurial Ignore Files"
                      Icon="hgIcon.ico" IconIndex="0" Advertise="yes"
            />
          </File>
        </Component>
        <Component Id="doc.hgrc.5.html" Guid="$(var.doc.hgrc.5.html)" Win64='$(var.IsX64)'>
          <File Name="hgrc.5.html" KeyPath="yes">
            <Shortcut Id="hgrc5StartMenu" Directory="ProgramMenuDir"
                      Name="Mercurial Configuration Files"
                      Icon="hgIcon.ico" IconIndex="0" Advertise="yes"
            />
          </File>
        </Component>
        <Component Id="doc.style.css" Guid="$(var.doc.style.css)" Win64='$(var.IsX64)'>
          <File Name="style.css" KeyPath="yes" />
        </Component>
      </Directory>
    </DirectoryRef>
  </Fragment>

</Wix>