Quantcast
Channel: Sandcastle Help File Builder
Viewing all 2184 articles
Browse latest View live
↧

Commented Unassigned: Add support for Markdown.md output [35255]

May 28, 2014, 3:58 pm
$
0
0
It would be amazing if, in addition to HTML, you could output github .md markdown files. This would enable you to upload the entire library reference directly to the github project's wiki.
Comments: ** Comment from web user: SharpGIS **

I've tried manually to do a little bit of the markdown doc here as an example:
https://github.com/dotMorten/SandcastleMarkupDocTest/wiki

Markdown files available here:
http://www.sharpgis.net/SandcastleMarkupDocTest.wiki.zip

↧
Search

New Post: Not building the website with the vs2013 presentation style

May 29, 2014, 1:36 pm
$
0
0
I just installed the latest build and followed all the directions I think. I am using the project from Visual Studio 2013. I have selected the outputs to be CHM and Html/Asp.net. When I build the chm and website are created but the website does not look like 2013 msdn, it looks like the older style site and is using an iframe. Is this correct? I expected the website documentation to look more like SHFB website documentation.

Thanks,

Frank
↧
↧

New Post: Not building the website with the vs2013 presentation style

May 29, 2014, 2:12 pm
$
0
0
I refreshed the online content using the new style this past week for final testing. The VS2013 style using the new lightweight style is in source control but has not been released yet. I plan on doing that this weekend.

Eric
↧

New Post: Not building the website with the vs2013 presentation style

May 29, 2014, 2:21 pm
$
0
0
I will get an update after you release. Thanks for the quick response!

Frank
↧

New Post: Visual Studio integration for SandCastle Help File Builder v2014.4.22.0

May 31, 2014, 10:43 am
$
0
0
Is there a Visual Studio integration for SandCastle Help File Builder v2014.4.22.0? Thank you.
↧
↧

New Post: Visual Studio integration for SandCastle Help File Builder v2014.4.22.0

May 31, 2014, 11:25 am
$
0
0
Yes, everything is there. The SHFB package is the option right after the Sandcastle Help File Builder and Tools page in the guided installer. It was getting redundant to spell it all out in the release title so now it's just "Help File Builder and Tools".

Eric
↧

Source code checked in, #106094

May 31, 2014, 3:37 pm
$
0
0
Changes made in this release: Documenation - Updated the documentation to reflect all recent changes. Sandcastle Help File Builder - Updated the topic previewer to use a VS2013-like presentation style. Presentation Styles - Made minor fixes and adjustments to the Open XML, VS2010, and VS2013 presentation styles.
↧

Released: Help File Builder and Tools v2014.5.31.0 (May 31, 2014)

May 31, 2014, 3:46 pm
$
0
0

General Information

IMPORTANT: On some systems, the content of the ZIP file is blocked and the installer may fail to run. Before extracting it, right click on the ZIP file, selectProperties, and click on the Unblock button if it is present in the lower right corner of theGeneral tab in the properties dialog.

This release completes removal of the branding transformations and implements the new VS2013 presentation style that utilizes the new lightweight website format. Several breaking changes had to be made in order to support it properly. You will need to rebuild any custom plug-ins, components, and presentation styles against the latest version of the Sandcastle and Help File Builder assemblies.

See the Sandcastle Tools 2014.5.31.0 Release Notes for details on all of the changes made to the underlying Sandcastle tools and presentation styles.

See the Sandcastle Help File Buider 2014.5.31.0 Release Notes for details on all of the changes made to the Sandcastle Help File Builder and the Visual Studio Package.

This release uses the Sandcastle Guided Installation package. Download and extract to a folder and then runSandcastleInstaller.exe to run the guided installation of the Sandcastle Help File Builder and Tools core components, the Visual Studio extension package, and extras.

What's Included
  • Help 1 compiler check and instructions on where to download it and how to install it if needed
  • Help 2 compiler check and instructions on where to download it and how to install it if needed
  • Sandcastle Help File Builder and Tools v2014.5.31.0
  • SHFB Visual Studio Extension Package
  • An option to install the MAML schemas in Visual Studio to provide IntelliSense for MAML topics
  • An option to install MAML snippets in Visual Studio to provide insertion of common MAML elements in topics while editing
↧
Search

Updated Release: Help File Builder and Tools v2014.5.31.0 (May 31, 2014)

May 31, 2014, 3:46 pm
$
0
0

General Information

IMPORTANT: On some systems, the content of the ZIP file is blocked and the installer may fail to run. Before extracting it, right click on the ZIP file, select Properties, and click on the Unblock button if it is present in the lower right corner of the General tab in the properties dialog.

This release completes removal of the branding transformations and implements the new VS2013 presentation style that utilizes the new lightweight website format. Several breaking changes had to be made in order to support it properly. You will need to rebuild any custom plug-ins, components, and presentation styles against the latest version of the Sandcastle and Help File Builder assemblies.

See the Sandcastle Tools 2014.5.31.0 Release Notes for details on all of the changes made to the underlying Sandcastle tools and presentation styles.

See the Sandcastle Help File Buider 2014.5.31.0 Release Notes for details on all of the changes made to the Sandcastle Help File Builder and the Visual Studio Package.

This release uses the Sandcastle Guided Installation package. Download and extract to a folder and then run SandcastleInstaller.exe to run the guided installation of the Sandcastle Help File Builder and Tools core components, the Visual Studio extension package, and extras.

What's Included
  • Help 1 compiler check and instructions on where to download it and how to install it if needed
  • Help 2 compiler check and instructions on where to download it and how to install it if needed
  • Sandcastle Help File Builder and Tools v2014.5.31.0
  • SHFB Visual Studio Extension Package
  • An option to install the MAML schemas in Visual Studio to provide IntelliSense for MAML topics
  • An option to install MAML snippets in Visual Studio to provide insertion of common MAML elements in topics while editing
↧
↧

New Post: Sandcastle Help File Builder and Tools v2014.5.31.0 Now Available for Download

May 31, 2014, 3:46 pm
$
0
0
The latest release of the Sandcastle Help File Builder and Tools is now available for download. This release completes removal of the branding transformations and implements the new VS2013 presentation style that utilizes the new lightweight website format. Several breaking changes had to be made in order to support it properly. You will need to rebuild any custom plug-ins, components, and presentation styles against the latest version of the Sandcastle and Help File Builder assemblies.

See the release notes for details on the changes made.
↧

New Post: Auto-map VS projects with XML documentation enabled into DocumentationSources

June 1, 2014, 1:50 pm
$
0
0
I have a complex Visual Studio 2013 solution containing on the order of 50 projects. Perhaps 25% of those are part of my public API, and have the "XML documentation file" specified on the project's properties/build page to create the appropriate documentation file. Is there a way for SHFB to dynamically recognize those projects and process only them (rather than me having to hard-code the list)? Failing that, is there perhaps a standard technique in an msbuild file to loop through all the csproj files to identify those so instrumented for documentation and generate a property to pass to my SHFB invocation?
↧

New Post: Auto-map VS projects with XML documentation enabled into DocumentationSources

June 1, 2014, 6:21 pm
$
0
0
SHFB won't make assumptions about whether or not to document a project based on the presence or absence of an XML comments file. Is it missing because you forgot to set the option? Perhaps its documented for internal use so it has an XML comments file but you don't want it in the end-user documentation. It's too broad of an assumption to make. Depending on how the namespaces are organized in the assemblies, the API filter is probably the best choice to remove entire namespaces and/or types from the documentation.

Eric
↧

Reviewed: Help File Builder and Tools v2014.5.31.0 (Jun 02, 2014)

June 2, 2014, 12:40 am
$
0
0
Rated 5 Stars (out of 5) - Super glad to see the HTML styling updates, great work as usual, thanks.
↧
↧

Created Unassigned: Disable custom IntelliSense extensions under Roslyn [35266]

June 2, 2014, 5:53 am
$
0
0
When the Roslyn End User Preview is installed, the custom IntelliSense support provided by SHFB does not work properly, resulting in exceptions and a poor user experience. The current release of Roslyn does not support extending the IntelliSense behavior (even through the replacement method currently employed by SHFB) due to the use of custom presentation layer. We can revisit the extension possibilities for a future release.

The following pull request shows an implementation of this feature.
https://github.com/tunnelvisionlabs/SHFB/pull/61
↧

Commented Unassigned: Project Target Framework Not Installed [35253]

June 2, 2014, 6:14 am
$
0
0
In the newest version of SHFB, I get the message "Project Target Framework Not Installed" while opening SHFB projects, details see in the attached print screen.

I can select each option, the message appears at each opening of the project.

Environment:
VS 2013 Update 2, WIndows 7
Comments: ** Comment from web user: knoxi **

Adding the property manually to the project file solves the problem of the migration dialog.

↧
Search

Commented Unassigned: Build warnings since migration to 2014.2.15.0 [35129]

June 2, 2014, 6:25 am
$
0
0
Since I have updated to the Version 2014.2.15.0, I receive a lot! of build warnings in my solution.

Release | x86
0 error(s), 14289 warning(s)
$/trunk/Source/Client.sln - 0 error(s), 923 warning(s), View Log File
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.FrameworkElement'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'M:System.Windows.FrameworkElement.ShouldSerializeTriggers'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'P:System.Windows.FrameworkElement.Triggers'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.FrameworkElement'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'M:System.Windows.Controls.Control.ToString'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.Controls.Control'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
...
$/trunk/Source/Server.sln - 0 error(s), 13366 warning(s), View Log File
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'M:System.Object.Finalize'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
...

In the previous Version 1.9.8.0 there wasn't warnings on the solution.
Comments: ** Comment from web user: knoxi **

Yes we are behind a proxy. I will try to enable the proxy or otherwise disable the online access as described in the FAQ.

↧

Commented Unassigned: Build warnings since migration to 2014.2.15.0 [35129]

June 2, 2014, 7:47 am
$
0
0
Since I have updated to the Version 2014.2.15.0, I receive a lot! of build warnings in my solution.

Release | x86
0 error(s), 14289 warning(s)
$/trunk/Source/Client.sln - 0 error(s), 923 warning(s), View Log File
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.FrameworkElement'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'M:System.Windows.FrameworkElement.ShouldSerializeTriggers'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'P:System.Windows.FrameworkElement.Triggers'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.FrameworkElement'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'M:System.Windows.Controls.Control.ToString'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.Controls.Control'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
...
$/trunk/Source/Server.sln - 0 error(s), 13366 warning(s), View Log File
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'M:System.Object.Finalize'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
...

In the previous Version 1.9.8.0 there wasn't warnings on the solution.
Comments: ** Comment from web user: knoxi **

I tried the suggestions in the FAQ (enabling the proxy, set the properties) but it takes no effect, the warning appears always.

↧
↧

Commented Unassigned: Build warnings since migration to 2014.2.15.0 [35129]

June 2, 2014, 9:43 am
$
0
0
Since I have updated to the Version 2014.2.15.0, I receive a lot! of build warnings in my solution.

Release | x86
0 error(s), 14289 warning(s)
$/trunk/Source/Client.sln - 0 error(s), 923 warning(s), View Log File
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.FrameworkElement'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'M:System.Windows.FrameworkElement.ShouldSerializeTriggers'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'P:System.Windows.FrameworkElement.Triggers'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.FrameworkElement'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'M:System.Windows.Controls.Control.ToString'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [T:DialogTestView] MSDN URL not found for target 'T:System.Windows.Controls.Control'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
...
$/trunk/Source/Server.sln - 0 error(s), 13366 warning(s), View Log File
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'M:System.Object.Finalize'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets (38): BuildAssembler : warning : ResolveReferenceLinksComponent: [Methods.T:Configuration] MSDN URL not found for target 'T:System.Object'. [C:\Builds\bin\Working\BuildReferenceTopics.proj]
...

In the previous Version 1.9.8.0 there wasn't warnings on the solution.
Comments: ** Comment from web user: EWoodruff **

Since it appears to be a proxy issue, there isn't anything I can do since it's not something I can troubleshoot. One of the set of BuildAssembler.exe.config settings usually allow it to pass through. The best I can suggest is you try to connect to the MTPS content service directly in a test project (not SHFB, something like a console app) and see if you can find the correct settings to communicate with it. You should then be able to apply them to the config file. If you find them, let me know and I can add them as another possible solution.

↧

Closed Unassigned: Project Target Framework Not Installed [35253]

June 2, 2014, 9:44 am
$
0
0
In the newest version of SHFB, I get the message "Project Target Framework Not Installed" while opening SHFB projects, details see in the attached print screen.

I can select each option, the message appears at each opening of the project.

Environment:
VS 2013 Update 2, WIndows 7
Comments: See comments.
↧

New Post: Visual Studio integration for SandCastle Help File Builder v2014.4.22.0

June 2, 2014, 10:06 am
$
0
0
Thanks Eric! I installed via the .msi since I haven't been able to run the .exe provided in the zip that I downloaded for v2014.4.22.0. The .msi doesn't provide the options. Would you know why I am not able to run the .exe? When I tried to run it nothing happens and I didn't see the process under the task manager.
↧
Viewing all 2184 articles
Browse latest View live
Search
<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>