Output Templates

VSdocman uses special files called templates to generate its output. A template defines a format of the output. VSdocman comes with several predefined templates for generating:

  • MS Help Viewer - Microsoft help technology used in Visual Studio 2010 and higher and in MSDN; .mshc file. Suitable for integration with VS help or MSDN.
  • MS Help 2 - Microsoft help technology used in Visual Studio .NET and MSDN versions 2002 - 2008; .HxS file. Suitable for integration with VS help or MSDN.
  • CHM (HTML Help 1.x) - .CHM file suitable for general purpose help.
  • HTML - files with index, search and table of contents. Works even locally without a web server.
  • Docx - OOXML format used in MS Word. Suitable for printing and exporting to PDF.
  • PDF document suitable for printing.
  • XML which can be processed later by other tools

You can define your own template to customize the output. Simple macro language was developed to enable user to change output look.

Of course, you can customize the existing templates. Moreover, VSdocman uses special language files for output localization. There are several built-in languages including English, German, French, Spanish, Portuguese, Hebrew and others. You can easily add any other language just by editing a simple text file.

 

Start generating your .NET documentation now!
DOWNLOAD
Free, fully functional trial
VSdocman Tip
You can use regular expressions to include or exclude documented elements.
Customers

Universities
Medical institutions
Government institutions
Large financial institutions
Thousands of SW companies

Deloitte & Touche
PricewaterhouseCoopers
Bloomberg
Wells Fargo
QBE

Caterpillar
Lear
DuPont
Pfizer

Boeing
Airbus
Rolls-Royce Naval Marine
Toyota Motorsport

Bose
Mitsubishi Electric
Johnson Controls
Bentley Systems

Intel
Hewlett Packard
Bosch (Australia)
Schneider Electric

Intergraph
Volvo Information Technology
SOPRA GROUP
Agilent Technologies
Tesco SW

Syncfusion
T-Systems
Verizon
Fraunhofer Heinrich-Hertz-Institut

vs launch partner logo

VS Mag award VS Mag award

A few years ago, we gave a test to several products to document our source code. We finally chose VSdocman mostly because it was easy to use, from within the development environment, making training of programmers useless. It provides flexible features which enables producing complete documentation for people using our products and also for internal use. When technical support is required (we needed this when switching to VS 2015), Peter answered our emails very quickly. After more than 3 years with VSdocman, we strongly recommend the product which is amazingly easier to use than SandCastle.

Pierrick Combreau, Product Manager, Quotalys Ltd