DocProject Wiki & Documentation Rss Feed

Updated Wiki: Documentation

davedev — Tue, 27 Oct 2009 17:02:24 GMT

About DocProject
Overview of DocProject as an open source project and a list of its features.
Latest Release Notes
Please read this document carefully before attempting to install DocProject.
Sandcastle Help
Provides important notes and links to various online resources for learning more about Microsoft's Sandcastle tools.
- Sandcastle and Proxy Servers
- Information about using proxy server configurations with Sandcastle.
Sandcastle Build Component Templates
Visual Studio Item Templates for creating custom Sandcastle build components that can take advantage of editor support in automation tools such as DocProject.
ResolveExternalLinksComponent
Provides documentation for ResolveExternalLinksComponent, which is a Sandcastle build component that extends <see> tags by allowing IDs to be specified instead of URLs.
DocProject External UI
Provides support for configuring and building DocProjects and DocSites outside of the Visual Studio IDE (useful for Visual Studio Express users).
DocProject Components
Overview of DocProject's two major components: Visual Studio Project Templates and a Visual Studio Add-In.
DocProject Templates
DocProject templates are used to create Visual Studio projects that build compiled help for their project references and external sources.
- DocSite Templates
- DocSite templates are DocProject templates that generate Visual Studio Web Application projects.
Build Process
Information regarding the build process, steps and build types of DocProjects and DocSites.
Sandcastle Deployment Plugin
The Sandcastle/Deployment plug-in extends the Sandcastle build engine in DocProject by adding deployment features.
How To...
Guidance for performing some common tasks associated with DocProject.
- Installation and Uninstallation
- Configuration
  - How To Configure Visual Studio 2005 for DocProject
  - How To Configure DocProject
- Using DocProject
- Sandcastle Features in DocProject
- Usage Tutorials
- Extensibility Tutorials

Updated Wiki: Documentation

davedev — Tue, 27 Oct 2009 17:02:13 GMT

Home Page

About DocProject
Overview of DocProject as an open source project and a list of its features.
Latest Release Notes
Please read this document carefully before attempting to install DocProject.
Sandcastle Help
Provides important notes and links to various online resources for learning more about Microsoft's Sandcastle tools.
- Sandcastle and Proxy Servers
- Information about using proxy server configurations with Sandcastle.
Sandcastle Build Component Templates
Visual Studio Item Templates for creating custom Sandcastle build components that can take advantage of editor support in automation tools such as DocProject.
ResolveExternalLinksComponent
Provides documentation for ResolveExternalLinksComponent, which is a Sandcastle build component that extends <see> tags by allowing IDs to be specified instead of URLs.
DocProject External UI
Provides support for configuring and building DocProjects and DocSites outside of the Visual Studio IDE (useful for Visual Studio Express users).
DocProject Components
Overview of DocProject's two major components: Visual Studio Project Templates and a Visual Studio Add-In.
DocProject Templates
DocProject templates are used to create Visual Studio projects that build compiled help for their project references and external sources.
- DocSite Templates
- DocSite templates are DocProject templates that generate Visual Studio Web Application projects.
Build Process
Information regarding the build process, steps and build types of DocProjects and DocSites.
Sandcastle Deployment Plugin
The Sandcastle/Deployment plug-in extends the Sandcastle build engine in DocProject by adding deployment features.
How To...
Guidance for performing some common tasks associated with DocProject.
- Installation and Uninstallation
- Configuration
  - How To Configure Visual Studio 2005 for DocProject
  - How To Configure DocProject
- Using DocProject
- Sandcastle Features in DocProject
- Usage Tutorials
- Extensibility Tutorials

Updated Wiki: Wikimap

davedev — Tue, 27 Oct 2009 17:01:28 GMT

Wikimap

Home Page

About DocProject
Overview of DocProject as an open source project and a list of its features.
Latest Release Notes
Please read this document carefully before attempting to install DocProject.
Sandcastle Help
Provides important notes and links to various online resources for learning more about Microsoft's Sandcastle tools.
- Sandcastle and Proxy Servers
- Information about using proxy server configurations with Sandcastle.
Sandcastle Build Component Templates
Visual Studio Item Templates for creating custom Sandcastle build components that can take advantage of editor support in automation tools such as DocProject.
ResolveExternalLinksComponent
Provides documentation for ResolveExternalLinksComponent, which is a Sandcastle build component that extends <see> tags by allowing IDs to be specified instead of URLs.
DocProject External UI
Provides support for configuring and building DocProjects and DocSites outside of the Visual Studio IDE (useful for Visual Studio Express users).
DocProject Components
Overview of DocProject's two major components: Visual Studio Project Templates and a Visual Studio Add-In.
DocProject Templates
DocProject templates are used to create Visual Studio projects that build compiled help for their project references and external sources.
- DocSite Templates
- DocSite templates are DocProject templates that generate Visual Studio Web Application projects.
Build Process
Information regarding the build process, steps and build types of DocProjects and DocSites.
Sandcastle Deployment Plugin
The Sandcastle/Deployment plug-in extends the Sandcastle build engine in DocProject by adding deployment features.
How To...
Guidance for performing some common tasks associated with DocProject.
- Installation and Uninstallation
- Configuration
  - How To Configure Visual Studio 2005 for DocProject
  - How To Configure DocProject
- Using DocProject
- Sandcastle Features in DocProject
- Usage Tutorials
- Extensibility Tutorials

Updated Wiki: Documentation

davedev — Tue, 27 Oct 2009 17:01:10 GMT

Documentation

New Comment on "How To Build Help For a Web Site Project"

davedev — Tue, 22 Sep 2009 05:35:15 GMT

I appreciate your attempt to report issues with DocProject and I'm sorry for your frustration with the uninstaller, but this is not the right way to go about getting my attention. I monitor the discussions regularly so if you have questions I'd appreciate it very much if you'd please post there (but search the Discussions area and the Issue Tracker first as you might find some useful information). Your comments, as well as my response, will be removed in a few days.

New Comment on "How To Build Help For a Web Site Project"

jfowler01 — Mon, 21 Sep 2009 23:15:42 GMT

Even the uninstall won't fix it. What did you guys do to my Visual Studio? All I wanted to do is document an almost complete project. All day wasted and the solution is messed up!!!!!!!!! Ok, what did you add that the uninstall won't remove?

New Comment on "How To Build Help For a Web Site Project"

jfowler01 — Mon, 21 Sep 2009 23:11:03 GMT

You don't care how bad you mess up a developer's world as long as you can put you name in the paper.....

New Comment on "How To Build Help For a Web Site Project"

jfowler01 — Mon, 21 Sep 2009 23:00:29 GMT

And I thought the Install messed it up....just wait till you uninstall....Danger Will Robinson...Danger!

New Comment on "How To Build Help For a Web Site Project"

jfowler01 — Mon, 21 Sep 2009 22:48:52 GMT

Beware, DocProject will mess up Visual Studio 2008 Team Systems BAD!

New Comment on "How To Build Help For a Web Site Project"

jfowler01 — Mon, 21 Sep 2009 18:42:58 GMT

Just once I would like to use something related to Micrisoft that I don't have to debug someone elses code and spend hours setting up over-engineered, bug-ridden software and search google for hours finding a workaround....and then finally realize it was never going to work until the 3rd or 4th release....The Microsoft Way! !!!!!!!!!!!!C:\Program Files\Sandcastle\ProductionTools\MRefBuilder" process failed with exit code: 1. !!!!!!!!!!!

New Comment on "How To Enable IntelliSense in Conceptual Topics"

davedev — Sat, 29 Aug 2009 19:59:00 GMT

Don't forget that DocProject copies the necessary files from Sandcastle, including the schemas, whenever a new project is created. This way installing Sandcastle updates doesn't break existing projects, although users have the option to create a new project and copy the settings from the old one if they want to upgrade. Forcing users to upgrade isn't such a good thing; e.g., what happens if you are working on a very important project and you don't have time or the desire to upgrade to the latest version of Sandcastle? What happens if you've already customized the XSLT and CSS, and maybe even the MAML schemas, to suit the needs of a particular product or client? I'll add a work item to offer your solution as an installer option, enabled by default. It does seem like when it comes to the MAML schemas, breaking changes are unlikely. http://docproject.codeplex.com/WorkItem/View.aspx?WorkItemId=24480

New Comment on "How To Enable IntelliSense in Conceptual Topics"

clugsta — Sat, 29 Aug 2009 13:42:57 GMT

That's a good point. Like you mention, it seems like a fairly low risk issue. Plus, I'm not sure it is a terrible thing to "force" users to use (or update) to the latest schema. In the long run it will make maintenance easier as Sandcastle is versioned. It also seems that it would be lower risk to the end user when updates to Sandcastle were made. They version Sandcastle, and *if* there were updates to the schema they would immediately see them. Versus the other approach of them copying a schema version from a certain point in time and it falling out of date (possibly to a great degree depending on their processes) when Sandcastle is updated. Either way, there are now a few approaches to consider. :)

New Comment on "How To Enable IntelliSense in Conceptual Topics"

davedev — Fri, 28 Aug 2009 15:16:28 GMT

Thanks, that's a nice tip. One side-effect though is that you're tying all of your MAML topics to the schemas in the Sandcastle installation folder, so they'll always be forced to use the latest Sandcastle schemas, even if topics are written against older schemas. (It seems unlikely that there will be any breaking changes made to the Sandcastle schemas, so I'll consider adding this solution to DocProject's installer in the next release.)

New Comment on "How To Enable IntelliSense in Conceptual Topics"

clugsta — Fri, 28 Aug 2009 12:40:50 GMT

I believe I have found a slightly easier way to accomplish this. I didn't want to start copying files all over the place, edit the OOTB VS2008 config files for fear they will be overwritten by an update someday, etc. So, I created a file named "authoringcatalog.xml" (name it whatever you wish) and added the following... <SchemaCatalog xmlns="http://schemas.microsoft.com/xsd/catalog"> <Association extension="aml" schema="file://C:/Program Files/Sandcastle/Schemas/Authoring/developer.xsd" /> </SchemaCatalog> Place this file in the "C:\Program Files\Microsoft Visual Studio 9.0\Xml\Schemas" directory. This directory is searched at VS start-up, and will find and associate the .aml extension with the proper schema. This allows VS to use the default schema data from the Sandcastle directory without having to copy it and modify any other VS files. This works perfectly with both 2008 and 2005.

New Comment on "TopicDesigner_Large"

davedev — Mon, 16 Feb 2009 21:02:58 GMT

I see all three images. Thanks for mentioning it but CodePlex hosts the images so there's not much I could do about it anyway.

New Comment on "TopicDesigner_Large"

davedev — Mon, 16 Feb 2009 21:02:13 GMT

I see all three images. Anyway, thanks for mentioning it but CodePlex hosts the images so there's not much I could do about it anyway.

New Comment on "TopicDesigner_Large"

davedev — Mon, 16 Feb 2009 21:01:09 GMT

I see all three images.

New Comment on "TopicDesigner_Large"

davedev — Mon, 16 Feb 2009 21:00:33 GMT

I see them fine :)

New Comment on "TopicDesigner_Large"

riggsdp — Mon, 16 Feb 2009 19:11:50 GMT

Unable to view images past Figure 2 as of 2/16/09.

Updated Wiki: Wikimap

davedev — Fri, 12 Dec 2008 17:15:59 GMT

Wikimap

Home Page

About DocProject
Overview of DocProject as an open source project and a list of its features.
Latest Release Notes
Please read this document carefully before attempting to install DocProject.
Sandcastle Help
Provides important notes and links to various online resources for learning more about Microsoft's Sandcastle tools.

Sandcastle and Proxy Servers
Information about using proxy server configurations with Sandcastle.

Sandcastle Build Component Templates
Visual Studio Item Templates for creating custom Sandcastle build components that can take advantage of editor support in automation tools such as DocProject.
ResolveExternalLinksComponent
Provides documentation for ResolveExternalLinksComponent, which is a Sandcastle build component that extends <see> tags by allowing IDs to be specified instead of URLs.
DocProject External UI
Provides support for configuring and building DocProjects and DocSites outside of the Visual Studio IDE (useful for Visual Studio Express users).
DocProject Components
Overview of DocProject's two major components: Visual Studio Project Templates and a Visual Studio Add-In.
DocProject Templates
DocProject templates are used to create Visual Studio projects that build compiled help for their project references and external sources.

DocSite Templates
DocSite templates are DocProject templates that generate Visual Studio Web Application projects.

Build Process
Information regarding the build process, steps and build types of DocProjects and DocSites.
Sandcastle Deployment Plugin
The Sandcastle/Deployment plug-in extends the Sandcastle build engine in DocProject by adding deployment features.
How To...
Guidance for performing some common tasks associated with DocProject.

Installation and Uninstallation

Configuration

Using DocProject

Sandcastle Features in DocProject

Usage Tutorials

Extensibility Tutorials