Sandcastle Forum Rss Feed

New Post: Missing shared content item

trailway — Thu, 16 May 2013 16:32:18 GMT

I am running the 1.9.7.0 help file builder on Windows 8 x64 and am seeing the following warning:

Warn: SharedContentComponent: [Overload:NetworkEngineer.Sdk.Inventory.NEPortClass.Search] Missing shared content item. Tag: 'includeAttribute'; Id:'altText_pub'.

I have not installed any SandCastle related bits other than those installed by the the guided installer. I am building a chm file using the help file builder with a VS2010 presentation style. I have also tried VS2005 but that did not seem to help.

I am guessing that there is something about the overloaded method which is causing the problem. The particular assembly uses the 4.0 .NET framework.

New Post: generate doc. from website

EWoodruff — Tue, 23 Apr 2013 19:12:08 GMT

Its not enough just to modify the Web.config file. It must be able to find the web code provider assembly. That can be accomplished most easily by placing it in your project's .\bin folder as noted in the documentation. Also, since you appear to be using VS 2012, you'll need to update the compiler version value in the providerOptioon element to either "v4.0" or "v4.5" depending on which version of the framework you are targeting.

The VB.NET code provider doesn't always import all of the necessary namespaces either. As noted in the Usage Notes and Known Issues section of the documentation, you may need to add extra "/imports:XXXX" options in the compilerOptions attribute to define the missing namespaces. The other option is to add the necessary Imports statements to the code if they aren't there already.

Also, please note that this project has been discontinued and may not be monitored as frequently. For future questions concerning Sandcastle or SHFB, post them over on the Sandcastle Help File Builder project's discussion page. Thanks.

Eric

New Post: generate doc. from website

alebencz — Tue, 23 Apr 2013 16:16:23 GMT

I am trying to generate documentation for a WebSite, but, I don't have a project, in other words, I just go in Visual Studio and I Open a WebSite, I can't generate the XML documentation from this web project style:

And, I see in [that][2] documentation I need to put this:

      <system.codedom>
        <compilers>
          <compiler language="vb;vbs;visualbasic;vbscript" extension=".vb"
            compilerOptions="/docpath:C:\Publish\Docs"
            type="EWSoftware.CodeDom.VBCodeProviderWithDocs,
                  EWSoftware.CodeDom, Version=1.1.0.0, Culture=neutral,
                  PublicKeyToken=d633d7d5b41cbb65">
            <providerOption name="CompilerVersion" value="v2.0"/>
          </compiler>
        </compilers>
      </system.codedom>

Ok, but when i put this in my web.config, and When I try to build, the compiler return a lot of errors, like that:

    error BC30451: 'DDtoCC' is not declared. It may be inaccessible due to its protection level.
    0error BC30451: 'HojetoCC' is not declared. It may be inaccessible due to its protection level.
    error BC30451: 'CCtoDD' is not declared. It may be inaccessible due to its protection level.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlDataReader' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlDataReader' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlDataReader' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlDataReader' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlDataReader' is not defined.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30002: Type 'SqlDataReader' is not defined.
    error BC30451: 'DataDiff' is not declared. It may be inaccessible due to its protection level.
    error BC30451: 'AddDiastoCC' is not declared. It may be inaccessible due to its protection level.
    error BC30451: 'AddDiastoCC' is not declared. It may be inaccessible due to its protection level.
    error BC30451: 'QueryDB' is not declared. It may be inaccessible due to its protection level.
    error BC30451: 'AddDiastoCC' is not declared. It may be inaccessible due to its protection level.
    error BC30451: 'QueryDB' is not declared. It may be inaccessible due to its protection level.
    error BC30451: 'Truncate' is not declared. It may be inaccessible due to its protection level.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlDataReader' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30451: 'QueryDB' is not declared. It may be inaccessible due to its protection level.
    error BC30002: Type 'SqlConnection' is not defined.
    error BC30002: Type 'SqlCommand' is not defined.
    error BC30451: 'HojetoCC' is not declared. It may be inaccessible due to its protection level.

And, When I remove this, the code is compiled normaly ;x

And, I have tried to create a web project whit this code, BUt, I got the same error..
How I can generate the documentation of this web syte project ??

New Post: Custom Presentation Style with custom header layout

EWoodruff — Mon, 22 Apr 2013 21:10:40 GMT

The logo can be a permanent part of the style if you like. It's implemented in parameters in the existing styles since many people don't want a logo. The parameters are a convenience as then the implementation is part of the XSL transformations and the build tools do not need any special knowledge about how the presentation style is implemented beyond being given a set or parameters to pass in if used.

The header layout is mostly controlled by the XSL transformations. You'll need to modify them in order to alter how the header is rendered. The shared content items are mainly used to localize the text elements such as labels and link text.

Also, please note that this project has been discontinued and may not be monitored as frequently. For future questions concerning Sandcastle or SHFB, post them over on the Sandcastle Help File Builder project's discussion page. Thanks.

Eric

New Post: Custom Presentation Style with custom header layout

moleone — Fri, 19 Apr 2013 14:38:05 GMT

hi,

Version Compiler: 2.7.3.0
Version Builder: 1.9.7.0

I'm trying create acustom presentation style as described in the help. This results in two questions:

Can I bind the logo to the style, so I do not have to create an Icons\Logo.gif in each Sandcastle project and must enter it under the project properties?
What is the right way to completely overwrite the header layout. At first I thought I could do this with the MyStyle\Shared Content strategie. However, there seems to influence only part of the header.

And let me say: I'm new in using Sandcastle, but this tool inspires me a lot.

best regards
Mole

New Post: WCF Web Services and REST API Documentation.

YoGoUrT — Wed, 17 Apr 2013 19:31:14 GMT

Hi both of you. I'm also looking to document a web service and I would like to know if you found a solution to your problem ?

New Post: Link API Members from Conceptual

EWoodruff — Thu, 28 Mar 2013 19:40:21 GMT

If you want a list of all classes in a namespace, the namespace ID will work as noted above. If you want a list of all namespaces, the R:Project_[ProjectName] ID should do it. Replace "[ProjectName]" with the name from your SHFB Project's Help Name property with any spaces replaced by underscores.

If your intent is to list classes nested within some other arbitrary class, there isn't a way to do that since the presentation styles don't generate anything for nested classes within another class. Each class gets its own top-level entry in the TOC and the namespace list pages even if it's nested within another class. The nested classes are prefixed with their parent class's name.

Eric

New Post: Link API Members from Conceptual

TeaMaster — Thu, 28 Mar 2013 19:35:18 GMT

I meant something like this:

<codeEntityReference qualifyHint="false">Classes.T:NameSpace.Class</codeEntityReference>

But it doesn't seem to work

New Post: codeEntityReference - Change target online MSDN .Net Framework version

EWoodruff — Thu, 28 Mar 2013 19:34:35 GMT

That isn't currently supported. It's something I plan on looking into in a future release of the Sandcastle tools.

Also, please note that this project has been discontinued and may not be monitored as frequently. For future questions concerning Sandcastle or SHFB, post them over on the Sandcastle Help File Builder project's discussion page. Thanks.

Eric

New Post: Link API Members from Conceptual

EWoodruff — Thu, 28 Mar 2013 19:32:03 GMT

You can use the namespace ID to go to its page (N:NamespaceId). You can use the Entity References Window in the SHFB standalone GUI or Visual Studio package to add references to API members such as namespaces, types, and methods, etc. Select the Code Entities option in its drop down. It won't list the group entries such as AllMembers though since they are added at build time by the presentation style if it supports them.

Eric

New Post: codeEntityReference - Change target online MSDN .Net Framework version

Mythran — Thu, 28 Mar 2013 17:57:36 GMT

I have the following codeEntityReference:

<codeEntityReference>
    P:System.Web.Configuration.HttpCapabilitiesBase.Id
</codeEntityReference>

When compiled, I can click on the link and it opens the online MSDN library...but always selects the most recent version of the framework, instead of the targetted version! Is there a way for me to set the correct version so when the link is clicked, it will automatically target a different framework version?

Thanks! :)

New Post: Link API Members from Conceptual

TeaMaster — Thu, 28 Mar 2013 13:37:18 GMT

thanks!

The same way. How could I get the list of classes only?

New Post: Link API Members from Conceptual

EWoodruff — Wed, 27 Mar 2013 19:32:50 GMT

You just need to get the ID in the correct format:

<codeEntityReference qualifyHint="false">AllMembers.T:NameSpace.Class</codeEntityReference>

<codeEntityReference qualifyHint="false">Methods.T:NameSpace.Class</codeEntityReference>

Also, please note that this project has been discontinued and may not be monitored as frequently. For future questions concerning Sandcastle or SHFB, post them over on the Sandcastle Help File Builder project's discussion page. Thanks.

Eric

New Post: Link API Members from Conceptual

TeaMaster — Wed, 27 Mar 2013 17:31:34 GMT

Hi! I'm trying to link the "All methods"/members page of a class from the conceptual.

*The one that says The "class" type exposes the following members.

Something like this:

<codeEntityReference qualifyHint="false" autoUpgrade="true">Methods:NameSpace.Class</codeEntityReference>

New Post: Document to use SandCastle

mightymuke — Fri, 15 Mar 2013 13:09:14 GMT

Please note that this project has been discontinued and may not be monitored all that frequently. For documentation and other information concerning Sandcastle or SHFB, check out the Sandcastle Help File Builder project.

New Post: Document to use SandCastle

pradeepk85 — Fri, 15 Mar 2013 12:21:15 GMT

Hi,

I am new to SandCastle and not able to use this tool. Can anyone help me how to use this tool or any documentation present to use the same.

Thanks,
Pradeep

New Post: namespace heirarchy

EWoodruff — Fri, 18 Jan 2013 20:21:28 GMT

There isn't currently a way to do that. Most likely it would involve modifying the document model XSL transformation in .\ProductionTransforms\ApplyVSDocModel.xsl and probably the one that generates the TOC as well. The class prefixes are added by the presentation style so changes would be required in them too in order to remove the prefix if you didn't want it showing when nested.

Eric

New Post: namespace heirarchy

linny_ly — Mon, 14 Jan 2013 19:59:07 GMT

Is there a way to have the help topic display all the help topic for all class members under the class topic instead of having it flattened out with the dot identifier. For instance if I have a File Class and I have a structure named FileAccess declared within the File Class. Can I make SandCastle generate the help topic so that FileAccess is under File Class instead of having a separate help node called File.FileAccess Structure?

Thanks,

Linh

New Post: Oracle DLL

EWoodruff — Sat, 12 Jan 2013 20:42:40 GMT

If you are using the Sandcastle Help File Builder, you can use the Additional Reference Links plug-in to supress those messages. In short, you would create a project for the Oracle assemblies, add the Additional Reference Links plug-in to your main project's Plug-In Conifgurations, and configure it by specifying the project you created and the link type to use (i.e. None).

Eric

New Post: Oracle DLL

SelormeyPaul — Sat, 12 Jan 2013 03:22:33 GMT

Hello,

The ResolveReferenceLinksComponent2 cannot resolve links to third party sites, since these
do not provide API to their documentations sites.

ResolveReferenceLinksComponent2 requires the existence of links. For the tools I am working
on, the Sandcastle Assist, there is support for embedded links, which you can use to resolve third
party links. What it does it to include the documentation of the third party libraries, but will not
display them in the table of contents.

If you are using some tools to build your documents, you might need to find out if there is any similar
support for third party libraries.

Best regards,
Paul.