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

Closed Feature: Investigate Supporting VS 2013 Express Editions [35188]

May 6, 2014, 12:11 pm
$
0
0
I've had several requests in the past about supporting Visual Studio Express editions. The response has always been that Microsoft doesn't allow express editions to use extensions which was true. However, that appears to have changed recently and the newer Express editions do appear to support extensions (i.e NuGet and NodeJS). As such, Investigate to see how its done and if the SHFB extension will work properly in the various VS 2013 Express editions.
Comments: As it turns out the NuGet and NodeJS packages were developed by Microsoft and they made changes to the Express editions to allow them to run. So, the bottom line remains the same. Third-party packages cannot be used in Visual Studio Express editions. Attempts to use the product IDs from the packages noted above will allow them to get installed but they will be denied access to run.
↧
Search

Reviewed: Help File Builder and Tools v2014.4.22.0 (May 06, 2014)

May 6, 2014, 2:11 pm
$
0
0
Rated 5 Stars (out of 5) - Heard of it for years, never got around to actually using it. Used other means of documenting (e.g. markdown, pdf, etc.), and wanted to tinker a bit. Voila! This *IS* the tool! Remarkably simple to use (I'm a n00b!) - from incredible guided install (I think there's a lesson in there for all developers), to documentation and actual usage. Not only did I get an excellent tool for documenting code, I actually *learned* more about code commenting for documentation in Visual Studio using this tool (than any other reference)! Simply AWESOME! A must have for any serious dev and/or team pushing code out there!!!
↧
↧

New Post: BE0040 although library exists

May 7, 2014, 5:33 am
$
0
0
Hi,

In my scenario I have two SHFB projects, one is referenced by the other using the Version Builder plugin. When building from Visual Studio 2013 everything works fine and the documentation looks as expected.

When building from TFS however the build fails providing the following error code:
Error BE0029: Unexpected error while executing plug-in 'Version Builder': SandcastleBuilder.Utils.BuilderException: Unable to build prior version project: C:\Shares\Builds\3\Practices#####\src\Practices\Main\Source.documentation\NET\61b94d6d-b8fc-49d2-8639-378dd0fdb61c.shfbproj
I dug a bit deeper and evaluated the log file of the nested build. And that log file contained:
SHFB: Error BE0040: Project assembly does not exist: C:\Shares\Builds\3\Practices#####\bin#####.Toolkit.IO.dll
I opened the path mentioned and found out that the file is actually there. Any hint what I can do to fix the problem?

(On a sidenote: Accessing the logfile of the nested build was quite a task - as the $(OutDir) variable won't get propagated to the nested shfbproj file...)
↧

New Post: BE0040 although library exists

May 7, 2014, 12:11 pm
$
0
0
It could be that TFS is building the projects out of order. If you are using the latest release of SHFB, add the projects it is using as documentation sources to the References node as project references. In each reference, set the ReferenceOutputAssembly property to false. That will allow MSBuild to use the project reference to determine build order but won't include the output as a duplicate reference assembly in the documentation build.

Eric
↧

Created Unassigned: could not find a part of the path c:\...\fti\FTI_Files.json [35203]

May 7, 2014, 2:09 pm
$
0
0
could not find a part of the path c:\...\fti\FTI_Files.json

I get the above error when I use the search feature.
What info can I send to help get this resolved?
↧
↧

Commented Unassigned: could not find a part of the path c:\...\fti\FTI_Files.json [35203]

May 7, 2014, 3:14 pm
$
0
0
could not find a part of the path c:\...\fti\FTI_Files.json

I get the above error when I use the search feature.
What info can I send to help get this resolved?
Comments: ** Comment from web user: EWoodruff **

Check to be sure that you uploaded the .\fti folder along with all the other web content.

↧

Closed Feature: Support the "No code sample" message [34889]

May 7, 2014, 6:59 pm
$
0
0
For an example, view the following page:
http://msdn.microsoft.com/en-us/library/vstudio/b0axc2h2.aspx

When you click the "F#" syntax tab at the top, the following changes are applied to the viewer on the bottom:

1. All tabs are set to the inactive state.
2. The message displayed in place of code reads:

> No code example is currently available or this language may not be supported.

Update, 04/13/2014 - I'm going to look into this when reworking the syntax and code sections when moving the processing from the branding transformations back into the presentation styles.

Update 05/04/2014 - The first step in supporting this is in place in the form of an updated SyntaxComponent and updated presentation style templates to handle the grouped snippets. The code to actually implement it will be added soon.
Comments: Implemented in both the VS2010 and VS2013 presentation styles.
↧

New Post: BE0040 although library exists

May 8, 2014, 1:05 am
$
0
0
Hi Eric,

thank you for your quick reply! Adding the relevant libraries as references did not solve the problem. The log "acknowledges" that there are references set, but obviously MSBuild does not...

Markus
↧
Search

New Post: Code Group in Conceptual Topic

May 8, 2014, 10:13 am
$
0
0
Hello there.

First, I want to say thanks for the great tool！

In my project I want to show some sample codes, both in C# and VB.NET in my conceptual topics. The problem I got is when I place two <code/> elements, one for C# the other for VB.NET, in a conceptual topic, the code blocks does not fit together. On the output webpage, it shows two separate code blocks: one with C# code, and tab 'VB' disabled. And the other code block with VB.Net code and tab 'C#' disabled. I tested that if I put the those two <code/> elements in within comments (in my code file), it works well, i.e. there are only one code block with two enabled tabs.

My version of Sandcastle Help File Builder is v2014.4.22.0.

My code is something like this.
<topic ...>
  <developerConceptualDocument ...>
    <content>
        <code lang="C#" source="Samples.cs" region="TEST" />
        <code lang="VB.NET" source="Samples.vb" region="TEST" />
    </content>
  </developerConceptualDocument>
</topic>
And the output looks like this.
    |C#|  VB
    // Here goes my c# code
    ________________________________________

    C# |VB|
    // Blank, need to click on the tab 'VB' to show the VB.NET code
↧
↧

New Post: Code Group in Conceptual Topic

May 8, 2014, 10:58 am
$
0
0
This is a known issue with the current release and is related to the old branding transformations. They never handled code snippet grouping all that well. I've just recently completed the removal of the branding transformations and have completely reworked code snippet grouping and sorting so that it works correctly and logically based on what snippets are present and whether they are contiguous or standalone. Here's an example of the above case from the SHFB documentation that works as expected now: http://www.ewoodruff.us/shfbdocs/?topic=html/48f5a893-acde-4e50-8c17-72b83d9c3f9d.htm

These fixes will be in the next release. I don't have a planned release date yet and I'm still finishing up a few additional related features. If you need the changes sooner, most of the changes have been checked into source control so you can download the code and build it if necessary.

Eric
↧

New Post: Code Group in Conceptual Topic

May 8, 2014, 11:11 am
$
0
0
Thank you for your prompt response, Eric. I think I will need to build it myself.

BTW, in case some one met with the same issue and don't want to build from trunk, the <codeReference> tag and code snippets file can achieve the same purpose. But the indentation and syntax coloring does not work as well as the code block component plugin.

Thanks again for your help!

Wenqiang
↧

New Post: Table Of Content (TOC) Headache - Please Help!

May 8, 2014, 11:20 am
$
0
0
Thanks for your input.

I first found the search for the MSHelp:TocTitle or input HTML elements in the SandcastleHtmlExtract MSBuild Task.
I have good reason to think that this is the place that determines the on-screen title as it outputs the first TOC xml
containing title information. Also there's a clear part that defaults the title to the id in case both title HTML elements are missing.

Then I realized on what SandcastleHtmlExtract bases itself. It`s obvisouly not reflection info hence the name 'SandcastleHtmlExtract'. I found it's the output of the XSL Transformations that mentioned. I could put in my words and please correct me, it would be SandCastle itself as a sub-module of SHFB.

I guess I had to go through all of it to make links from the explanations.

OK, here's me questions:

1-Do you know if there's a field I could add to the reflection info that would actually be used as the topics titles?
2-Otherwise what proper thing could I do somewhere in BuildProcessso SandcastleHtmlExtract sees titles.

FYI Right now I'm using WebSite type of output only.

Thanks
↧

New Post: Table Of Content (TOC) Headache - Please Help!

May 8, 2014, 11:55 am
$
0
0
Topic titles in the XSL transformations are generated of the reflection data. In some cases it's the member name alone but in others it can include parameter type information and/or generic type information. You'll see templates in the XSL transformations such as t_topicTitlePlain and t_topicTitleDecorated. Those would be the place to start with regard to how the titles are formatted. You can track down where they are called and either call new templates instead, pass other parameters to them that alter their behavior, or utilize new reflection elements that you've added within them to get the title format you want.

Eric
↧
↧

New Post: Table Of Content (TOC) Headache - Please Help!

May 8, 2014, 12:38 pm
$
0
0
OK thanks. It's up to me now, I'll hopefully be back with the solution.
↧

New Post: Code Group in Conceptual Topic

May 8, 2014, 2:12 pm
$
0
0
I confirm that the code in trunk (r105807) fixed that issue and it groups code well. Great job, Eric!

One minor issue I found is it seems there is one extra blank line added for F#. For example,
    //#region Test
    let a = 1
    //#endregion
Will generate two lines:
    1| let a = 1
    2|
And the fix is put the //endregion right at end of the code like this:
    //#region Test
    let a = 1//#endregion
↧
Search

New Post: Sitemap node title not getting to webtoc.xml or index.html

May 9, 2014, 2:01 am
$
0
0
I am finding that nodes in a sitemap file are missing their titles when entered into the webtoc.xml and index.html, the nodes themselves are created but the title is blank and needs filling in by hand after the build. Any idea what is going on?


(Also found that fillnode.aspx AddToIndex causes a crash when a nodes==null when trying to expand nodes, that was easy to fix with a null check in the function)
↧

New Post: Table Of Content (TOC) Headache - Please Help!

May 9, 2014, 10:03 am
$
0
0
As promised.... I finally found the problem. Thing is, I took the whole beast apart to the bolts (believe me) to realize the issue was right under my nose.
I was building the api containers wrong in the reflection file. That's it.

At least I know more about SHFB than ever and if anyone have similar problem in the future, he`ll know what to do.

Please keep this in mind Eric, so we can spare a soul this trouble.

Thanks for your help!
↧
↧

New Post: Where should I insert my custom XSL Transformation

May 9, 2014, 10:10 am
$
0
0
Hi everyone,

I created an XSL Transformation file so I can rename apis in the reflection info file.
(Sounds weird I know, but I need to display the members in a user friendly fashion while a new syntax generator will display the actual syntax to use. I'm modifying only the name attributes.)

I would really want to avoid creating a plug-in since it's time consuming and to my opinion an overkill for my isolated needs.

Question: Where should I put (in config files) or execute my XSL Transformation file.
I know sandcastle.config contains many of them but I refuse putting it there while not knowing if it`s appropriate.

Thanks
↧

New Post: Tutorial: Debugging the SHFB Build Process

May 9, 2014, 10:28 am
$
0
0
Additional tips:

Sometimes processes spawning from MSBuild.exe building a SHFB Project execute so fast, the tool I provided can't catch it fast enough.

I found I trick to debug them thoroughly.

First follow this tutorial to activate the hidden /debug switch on the MSBuild.exe executable.
Add MSBuild.exe as an existing VS Project with parameter specifying your SHFB project.
Assuming that you have source code and have re-built SHFB in Debug mode (provides symbols and un-optimized debuggable code)
and replaced the binaries of installed SHFB.
Open BuildProcess.cs in your VS instance containing MSBuild.exe and add breakpoint before a child MSBuild.exe call.
Now find the complete MSBuild.exe command by inspecting variables.
Create a bat file containing the command and add the /Debug switch.

Visual studio will open and you'll be able to finely debug the child MSBuild.exe process.

The idea is to interrupt the BuildProcess and do a MSBuild.exe call in his place.

The profit of the debug switch is that it breaks at the very beginning of the project file
and also you get to debug the .proj file as well as the .cs ones.
↧

New Post: Where should I insert my custom XSL Transformation

May 9, 2014, 4:40 pm
$
0
0
In TransformManifest.proj, there`s a BeforeTransformManifest target.
If I could just override it somehow so I can add my appropriate xlstransform task to it.

If someone could just spare me hours of research.
↧
Viewing all 2184 articles
Browse latest View live
Search
<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>