I decided to use DocBook to generate documentation for SalesWeb, but I was finding it difficult to remember which tags I could use. Since DocBook is XML-based, it has a schema that can be plugged into Visual Studio 2005/2008 to enable intellisense.
I’ve put together a tiny ZIP file that has everything you need to get started:
DocBook 4.5 Intellisense for Visual Studio
It contains a VS catalog file and the DocBook 4.5 schemas (which I hope are redistributable… if not, let me know and I’ll remove them). Simply extract the zip file to one of the following directories, depending on your version of Visual Studio:
Visual Studio 2005 (8.0)
C:\Program Files\Visual Studio 8\Xml\Schemas
Visual Studio 2008 (9.0)
C:\Program Files\Visual Studio 9.0\Xml\Schemas
DocBook intellisense will be enabled for files with the .docbook extension. If your solution contains DocBook files, you can simply right-click and choose “Open With…” then select “XML Editor”. In my case, however, my Documentation is outside of my solution, so I had to do the following:
- Click Tools –> Options
- Choose the Text Editor –> File Associations page
- Enter “docbook” as the extension
- Choose “XML Editor” as the editor
- Click Add
- Click Ok
Let me know if you run into any problems!