Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

Write Templates for Visual Studio 2010

0.00/5 (No votes)
21 Jun 2010 1  
A presentation about Visual Studio item and project templates - how they make you more productive, how to create and deploy them.

Title Slide

Introduction

This article is part of my series on Visual Studio Extensions. Before you read it, please read the Introduction. It tells you the purpose of the series and gives you some tips on presenting my material. This article is designed to give you what you need to deliver a successful presentation. The speaker notes and demo script, along with the videos, are part of the package, and you won't learn everything from just the text of the article. My goal is to increase developer awareness of Visual Studio Extensions by making it easy for anyone to deliver a presentation on them at a user group, code camp, or the like.

Developers use project and item templates almost every day - creating new projects and adding items to existing projects. If they think about how those templates came to be, they probably assume it's a very difficult task suitable only for experienced developers, perhaps those on the Visual Studio team. This presentation aims to show that the very opposite is true. Anyone can create a project or item template. Whether it's to use yourself, to share with the team, or to share with the wider community, template creation is so quick and easy that you will save back the creation time the very first time you use it.

Presenting this session

This is a 300 level session for people who are comfortable with Visual Studio and have created plenty of projects. There are three demos, and because they have strong similarities, you need to work to keep it all straight for your attendees. I've recorded the demos and included links to them here so that you can see how it's all done. Once you know how to do these demos, you'll find the slides very easy to talk to since many of them just recap information from the demos. I do have speaker notes indicating what you can say to each slide. The demos take about half of a 75 minute slot, so you will have some time to talk to the slides.

Demo 1 - Item Template

This demo has a simple text file with boilerplate text in it that you might want to add as a new item to a variety of projects. You don't have to write any code, but you do have to drag things in and out of zip files and not get lost in a set of folders with very similar names. It's 9 minutes long.

Demo 2 - Project Template

Here, we make a project template from a project that has had a little customization applied. Like the item template, it's deployed by copying the zip to a magic folder, but towards the end, you can see that this approach is really a little fragile. This sets us up for the final demo. It's 13 minutes long, so I had to split it into two parts to upload.

Demo 3 - Deploying the Template

This demo continues from the previous one by showing how to deploy that template in a much safer and more robust way. It relies on an extension from Microsoft that simplifies building a VSIX dramatically. In fact, creating and using the VSIX is so simple you might miss it. This demo starts with showing you the gallery, then installs the extension right from inside Visual Studio. In no time, we re-export the template as a VSIX this time, and use it. Then, to round out the package, we put an icon, preview, and welcome page into the VSIX too. This is something everyone should do when they make a template. It's almost 16 minutes long, so I had to split it into two parts to upload.

Speaker Tips

Your goal for people leaving this session is that they see how simple it is to export a template and will create some of their own item and project templates to use in the immediate future. Some of them should also be planning to share those templates with team members. As well, if the Visual Studio Gallery is new to any attendees, they should be impressed by how easy it is to install useful extensions, and ready to take a look around and find some that they might like.

The Notes

Remember, you don't have to learn these just from the videos. There are detailed speaker notes and a demo script for you in the downloads for this article.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here