Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation incorrect #4612

Open
wixbot opened this issue Dec 1, 2014 · 4 comments
Open

Documentation incorrect #4612

wixbot opened this issue Dec 1, 2014 · 4 comments
Labels
bug website Issues related to updating the WiX Toolset's website
Milestone

Comments

@wixbot
Copy link

wixbot commented Dec 1, 2014

The instructions for "Creating a Simple Setup" are wrong. http://wixtoolset.org/documentation/manual/v3/votive/authoring_first_votive_project.html

Step 2:

  1. Click File, then click New, then click Project.

Don't do this. Should read.

  1. Right click the Solution, Select Add then select New Project

Instruction 6 should also point people to the comment on line 24 in the code:

"TODO: Remove the comments around this Component element and the ComponentRef below in order to add resources to this installer."

as a newbie will not see it because they are following the instructions.

Originally opened by richard210363

@wixbot
Copy link
Author

wixbot commented Dec 4, 2014

Area changed from settings to wixtoolset.org
Release changed from v3.9 to v3.x

@aplocher
Copy link

aplocher commented May 30, 2017

I ran into this again today. Of course it's easy enough to fix, but is there a reason the documentation doesn't just get fixed to accurately reflect a basic "getting started" scenario in VS - from beginning to end? It has been wrong for 3+ years now.

I'm sure this is the go-to tutorial for any new WiX / VS user. Any ambiguity should be addressed IMO.

If you follow the documentation word-for-word, you will end up with a build error

Error The ComponentGroup element contains an unexpected child element 'File'. MySetup

Here's my recommendation for step 6 (I'm sure it could be written much better, but I think it's an improvement over what is there currently):

  1. Find the comments for the Component and uncomment them (also remove the first "TODO"), so it will look like:

    ...
    <ComponentGroup Id="ProductComponents" Directory="INSTALLFOLDER">
    <Component Id="ProductComponent">
    <!-- TODO: Insert files, registry keys, and other resources here. -->
    </Component>
    </ComponentGroup>
    ...
    
    

    Then replace the remaining TODO in between the Component tags, with:

    <File Source="$(var.MyApplication.TargetPath)" />

@aplocher
Copy link

Also, might be good to mention something about providing a value for the Manufacturer attribute, because the next build error the user will receive is:

Error The Product/@Manufacturer attribute's value cannot be an empty string. If a value is not required, simply remove the entire attribute.

@barnson
Copy link
Member

barnson commented May 30, 2017

The bug is open for anyone to fix. Would you submit a pull request?

lachlantownshend added a commit to lachlantownshend/web that referenced this issue Oct 14, 2020
authoring_first_votive_project.html.md
As per wixtoolset/issues#4612
lachlantownshend added a commit to lachlantownshend/wix3 that referenced this issue Oct 14, 2020
authoring_first_votive_project.html.md
As per wixtoolset/issues#4612
@robmen robmen added website Issues related to updating the WiX Toolset's website and removed wixtoolset.org labels Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug website Issues related to updating the WiX Toolset's website
Projects
None yet
Development

No branches or pull requests

4 participants