Document! X

How to add a topic to a content file

Paul G — Wed, 08 Sep 2010 18:50:45 GMT

I must be missing something basic.

I have a Topic category with two existing topics. I create a new topic and I am happy with the content so i want to add it as a page. I see the dxc content page with the topic category and the original two topics but I do not see a way to add my new third topic.

I guess I am expecting an "Add Topic" choice similar to the Add image...

Thanks, Paul

How to Tag examples as VB, C#, C++, etc in code

Paul G — Thu, 22 Jul 2010 14:02:06 GMT

I know you can use the example and code tags but how does one note different languages (VB.Net, C#, C++)?

Thanks, Paul

Code widgets

Scott Plante — Wed, 08 Sep 2010 19:04:26 GMT

is anyone else having issues with the spacing of code snippets for examples etc? ideally i'd like to copy n paste from vs into the widget.. the colorizing is fine, it's just that all of the formatting is gone, and when i try to use the indent tool it leaves huge spaces between things etc.. is there a flag or something to set? how are other folks doing it?

URL to get the TOC frame with right-hand side content

Paul G — Thu, 02 Sep 2010 17:52:48 GMT

Is there a URL that can provide a browser with the TOC frame with right-hand side content?

Right now I can get the right-hand side content without the TOC frame.

Thanks, Paul

Does docX work with non-CLR C++ code through Visual Studio?

Paul G — Thu, 02 Sep 2010 15:25:40 GMT

We have unmanaged C++ code. Can we use the /// convention inline with code and get docX to spit out the comments?

Thanks, Paul

An internal file could not be created

Fred — Fri, 27 Aug 2010 09:57:29 GMT

Hello Innovasys team,

I've just downloaded Document! X to evaluate it on my projects and I meet the following errors:

HHC6000: Error: An internal file could not be created. Make certain there is enough disk space on the drive where you are compiling your file.

HHC5007: Error: Fatal navigational compilation error. This is likely the result of an invalid contents (.hhc) file.

Of course I have enough space on my disk and I really don't understand what's the problem.

Thank you for your help.

Fred

Assembly Object Generation

Scott Plante — Sun, 29 Aug 2010 20:41:22 GMT

in my assembly, i have a few data members that define a List<SomeType>. The problem arises when i go to view that member in the object model, it's missing. It's there when i view the members, and when i click on the link to drill down, it shows it correctly as a List<SomeType> in the detail page, but if i click on it, it takes me to the definition of a List<>, not my contained object..

obviously, i don't want to document what a List<> is, but my contained object.. how? and will it also work to show it in the object model as well?

Adding Logo image

Paul G — Tue, 06 Jul 2010 13:25:18 GMT

I have been asked to add a logo image to the top right corner of the generated help output - right of the feedback link.

I anticipate that I will have to create my first custom template to do this, but I thought I would see if there is some trick and links that will make life easier.

Thanks, Paul

64 bit binaries

Scott Plante — Sun, 29 Aug 2010 04:58:24 GMT

if i make a 64 bit binary and try to use that to document, it tells me that i need to open the 4.0 version of docx, which i do, but then in that version when i try to import it, it still says i need to use the 4.0 version.. ?

Build documentation project within Visual Studio

David — Fri, 27 Aug 2010 15:32:17 GMT

How can I build a Document! X project within Visual Studio 2010? I am currently using the right-click feature to Edit Documentation, and my comments are injected into my source code, but I don't know how to build and then access the project documentation as a whole.

I have tried opening the binaries in the Document! X application, but none of my comments are present.

Thanks in advance!

Examples in Table of Contents

David C — Thu, 26 Aug 2010 19:17:38 GMT

I am trying to streamline our table of contents for our solutions. The problem I'm having is adding a top level entry for examples. The way we build our products, is a single visual studio solution can have many projects (assemblies). One project we build if necessary is an "Examples" project which contains example code for more complex features. Currently our documentation TOC lists namespaces which contain the classes, interfaces, etc. WE don't list the assemblies in the TOC. What I'd like to do is place an "Examples" folder after all the namespaces so all the examples are under the one top-level branch. When I do this, it never generates the entries, but if I but that same branch under a class (that has an example) it works as expected. Any thoughts?

Best practice on how to include sample downloads

Paul G — Thu, 12 Aug 2010 15:22:50 GMT

I have samples that I include in the xml documentation which is picked up by DocX. What is the best practice on how to include sample downloads?

I have been using relative URLs to a samples dir which is good for different version builds and staging tests.

The problem is with a chm build.

I do not want to include the samples within the docX project because their sizes are huge which would considerably increase the chm size.

But with a relative location the chm file will choke on that clicked link.

I am considering entering the full URL

For example from:

/// <remarks>

/// Download <a href="samples/Sample.zip">sample</a>

/// </remarks>

/// <remarks>

/// Download <a href="http://mysite.com/samples/Sample.zip">sample</a>

/// </remarks>

Paul

Empty namespaces

Nicolai Pedersen — Fri, 13 Aug 2010 11:02:43 GMT

How do I avoid empty namespaces in my documentation?

I have namespaces with only Internal/Private types, and they are omitted in the documentation I build. But the namespace shows up in the TOC anyway - don't want that.

Convert a Help Studio project to Document! X 2010

brenneri — Wed, 11 Aug 2010 13:46:31 GMT

Is there an easy way to convert a Help Studio 3 project (*.dsp) into a Document! X project (*.dxp)? I have to "transport" about 800 topic files.

Is it possible to single-source exceptions

mheavin — Wed, 04 Aug 2010 13:03:56 GMT

I am including exceptions thrown in my .NET documentation. Some exceptions are used by many different methods, and I would like to create the description once for each and then include it in the Exceptions section by reference.

Thank you,

Mike

Problems with Document!X for .NET 4.0 (Type load error)

brenneri — Tue, 10 Aug 2010 11:32:12 GMT

I try to create a reference documentation for a .NET 4 class library based on a Document!X (Net 4.0) project. For one of the input assemblies (say A), the reference for a public class is is not generated - its signature being: public class SearchProperty : INotifyPropertyChanged {...}. To be more precise: the class is just not recognized. In the content editor for the assembly it does not appear (there is nothing special about it; it exposes one public property).

A second assembly (B) references the SearchProperty class, but I cannot add this second assembly to the Document! X project because it is not able to locate the class. There is an exception saying: "System.TypeLoadException. Could not load type ...SearchProperty from assembly A..." (Document! X obviously knows where to look for the class).

When I build the Document! X project (leaving aside assembly B), I get a "FileNotFoundException: Could not load file or assembly B..." because some other assembly in the project refernces assembly B.

So, there is no chance to build my document. Do you have any idea what may go wrong (I tried a lot; I also think about older versions of the assemblies still available in the GAC - though the project explicitly uses assemblies from a local folder)?

Remark: Inspecting / editing the documentation for class SearchProperty within Visual Studio 2010 is no problem.

Compiled help opens to a blank page and other questions

Scott Plante — Thu, 29 Jul 2010 17:51:01 GMT

i'm using docx 2010 and i'm using it to document a .Net assembly.

some questions:

Why is it when i open the compiled help file it's blank until i click somewhere else and then click back to it?
I read in another post about how to set the opening item, but for the life of me i cannot find anything called 'set page as default' etc. Can this be done?
Opening the included documentation for DocumentX! 2010, opens in a modal mode which can be problematic when trying to follow the tutorial videos since to get back to the application it requires me to close the help file. If i open the help outside of the application the videos are no longer embedded and are of poor quality as well as being extremely small.
Is there a way to expressly show the object model for all classes, even if it's just the root object? I'd like to do this for completeness. It just looks a little weird with some classes displaying object models and others not. It 'feels' like i clicked onto a page that is 'unfinished'. I mean, I understand why and what the object model is displaying, additional object references etc, but even if a class doesn't have any, i'd like to still display the model, even if it only displays the class object itself. Can this be done?
When designing a new custom template, is there a way to be able to edit pages in the template via the designer view as well, instead of just the html view?
Is there a way to modify the individual nodes, or types of the object model instead of just collections? For example, i'd like to be able to have the root object 1 color, while it's children another and so on.

In summary, i think 2010 is vastly more stable and feature packed than my previous version (docx 5) and I'm actually enjoying documenting my API with it. (wow, a developer not only creating documentation, but enjoying it as well? <grin>)

Support for code contracts?

lauraj — Wed, 28 Jul 2010 23:30:43 GMT

One of our engineers is considering adopting the use of code contracts in .NET 4.0. As I understand it, that will add new tags to the .XML file with info about the requirements of the member (parameter values, etc.). Does/will Document!X support this feature (i.e. process the new tags)?

Edited to add: I've since run a test case through Document!X. The new tag added is <requires> with a text string that one could simply display. DocX does not process that tag. I expect I could modify the template to do so; that's always painful -- has anyone here in the community done anything with <requires> ?

Auto-locate current active topic in the TOC

Nikolai — Wed, 21 Jul 2010 08:05:17 GMT

Hello, is it possible to track current active topic in the Table of Contents?

Default to specific level expanded TOC

Paul G — Thu, 15 Jul 2010 17:50:22 GMT

Right now DocX 2010 is defaulting to the collapsed top node. Obviously the first thing a user does is open the top level nodes to a couple levels down.

How can I start off with the nodes expanded to n levels?

Thanks, Paul (a satisfied DocX 2010 user)

Documentation c#

esneik — Fri, 09 Jul 2010 08:46:26 GMT

hi,

I work with Visual Studio 2010 and i want make documentation. I'm trying the demo version that it's on the web page and I can't save documentation: I can build it but haven't found any way to save the file for reading it without using the Visual Studio. This option is not created or I can't because I have the demo? I would like buy it because it seems a good program but I miss this option.

Sorry for my primitive english

Guidance on integrating help with Microsoft's .NET Framework

Paul G — Thu, 24 Jun 2010 18:07:35 GMT

Any guidance on how we should integrate with Microsoft's .NET Framework? I imagine that this is a problem that many people have experienced.

For example if I create a class that takes in a System.Drawing.Image param I would like to see a link that provides the user on that info.

Thanks, Paul

How to modify the contents of Requirements?

Paul G — Wed, 23 Jun 2010 20:49:30 GMT

I need to modify the Platforms supported and I would like to remove the path of the assembly in the assembly tag.

Where is the location in docX2010 to make these modifications?

Thanks, Paul

Platforms: Windows XP Professional, Windows Vista, Windows 7

Assembly: Scripting.Environment (in R:\source\Documentation\\binaries\Scripting.Environment.dll)

How do I set a topic to be the first page shown?

mheavin — Thu, 24 Jun 2010 13:58:41 GMT

I have a project with multiple assemblies. I created an Introduction topic to describe each of the assemblies and the product in general. I put the topic as the first item in the Table of Contents. When I generate the output, such as web help, the Table of Contents shows the Introduction first in the TOC, but displays the Overview page for the first assembly in the man documentation frame. How can I identify the Intro topic as the content to display initially in the man window?

Sourcegear Vault support?

kendallmiller — Tue, 15 Jun 2010 03:43:24 GMT

I noticed that in Document! X 2010 Sourcegear vault is no longer an option for source code control integration. Is this a permanent thing? We're a Vault customer and it's part of what has us "stuck" right now - we use Helpstudio 3 with Vault and migrating everything to DX 2010 would mean no source code control for us (or fully externalized, which is a pain)