Hello.
I'm considering to migrate some my documentation onto Doc2Help. My documentation now consists of two parts: conceptual (several pretty big Word files) and reference documentation (generated from source code).
Now I'm using Doc-o-Matic. It generates CHM file from source code. Also I have some amount of conceptual help in DoM's project (it's generated with reference docs to the same CHM).
My dream :) to have a software which could produce one help (chm & help2 & help3 in the near future!) from all my sources (source code, Word files, existing CHM).
About converting CHM in Doc2Help I've been asking already.
Doc-to-Help seems to be the right tool for me ;)
But the major obstacle on my way is links creation between cenceptual doc and reference.
Yes, I know that I can create a link from Word doc to topic which has been created by sandcastle. It's ok. But the thing is that it's very time consuming. Due to the amount of words which should became links.
The tool I'm using now (DoM) is able to create link automatically. It's just a killing feature. It's just because I'm using it. (If you wonder what's wrong with DoM and why I consider to change a tool the answer is supporting of Word files. DoM doesn't support them at all).
So, what I'd want exactly. I'd like to use any class name in any place of a Word doc and that class name automatically became a link (in the project output of course, after building) to a reference topic (generated from source code). How is it possible? PascalCase! We just need to treat (try at least) a PascalCase name as a link to a keyword. Ok, it might be not fully automatically, I could mark class name in some way. But an idea is do not manually choose a topic from very very long flat list of all topics generated by sandcastle (and manually fixing after renaming). It's just waste of time.
What do you think?
<EvilShrike> wrote in message news:216167@10.0.1.98... Hello. I'm considering to migrate some my documentation onto Doc2Help. My documentation now consists of two parts: conceptual (several pretty big Word files) and reference documentation (generated from source code). Now I'm using Doc-o-Matic. It generates CHM file from source code. Also I have some amount of conceptual help in DoM's project (it's generated with reference docs to the same CHM). My dream :) to have a software which could produce one help (chm & help2 & help3 in the near future!) from all my sources (source code, Word files, existing CHM). About converting CHM in Doc2Help I've been asking already. Doc-to-Help seems to be the right tool for me ;) But the major obstacle on my way is links creation between cenceptual doc and reference. Yes, I know that I can create a link from Word doc to topic which has been created by sandcastle. It's ok. But the thing is that it's very time consuming. Due to the amount of words which should became links. The tool I'm using now (DoM) is able to create link automatically. It's just a killing feature. It's just because I'm using it. (If you wonder what's wrong with DoM and why I consider to change a tool the answer is supporting of Word files. DoM doesn't support them at all). So, what I'd want exactly. I'd like to use any class name in any place of a Word doc and that class name automatically became a link (in the project output of course, after building) to a reference topic (generated from source code). How is it possible? PascalCase! We just need to treat (try at least) a PascalCase name as a link to a keyword. Ok, it might be not fully automatically, I could mark class name in some way. But an idea is do not manually choose a topic from very very long flat list of all topics generated by sandcastle (and manually fixing after renaming). It's just waste of time. What do you think? http://helpcentral.componentone.com/cs/forums/p/78749/216167.aspx#216167
Hello, Andrew.
Any ideas?
Hello,
With reference to your query, I would like to inform you, that as on checking the Thread class link it was found that on clicking on the Thread link a new page document is been opening up, however in Doc-To-Help you can create links that exist in a document or hyperlinks
Are you willing to co-related the topics in one document with definitions in another document produced by sandcastle
Looking forward to hear from you
Regards,
Andrew Miller
<EvilShrike> wrote in message news:216308@10.0.1.98... Any ideas? http://helpcentral.componentone.com/cs/forums/p/78749/216308.aspx#216308
I see, there is some misunderstanding. By "link" and "linking" I mean runtime navigation, URLs. Not embeding a document produced by sandcastle into another one during design-time (but it's also nice idea! ;) ).
I'd like to get result help with URLs from class names in conceptual documentation to topics in reference documentation produced by sandcastle plugin.
With reference to your query, I would like to know from you that you are referring to two separate documents
In one document there are some .NET type name where as in other document there are some definitions related to those type names, and you wish to make a .NET type name as link
In such a manner that on clicking on the .NET type name link the corresponding definition in the second document should open in your help file
<C1_AndrewM> wrote in message news:216456@10.0.1.98... Hello, With reference to your query, I would like to inform you, that as on checking the ÂThread class link it was found that on clicking on the ÂThread link a new page document is been opening up, however in Doc-To-Help you can create links that exist in a document or hyperlinks Are you willing to co-related the topics in one document with definitions in another document produced by sandcastle Looking forward to hear from you Regards, Andrew Miller I would like to know that, you wish to co-related your topics in conceptual document <EvilShrike> wrote in message news:216308@10.0.1.98... Any ideas? http://helpcentral.componentone.com/cs/forums/p/78749/216308.aspx#216308 http://helpcentral.componentone.com/cs/forums/p/78749/216456.aspx#216456
With reference to your query, I would like to inform you, that as on checking the ÂThread class link it was found that on clicking on the ÂThread link a new page document is been opening up, however in Doc-To-Help you can create links that exist in a document or hyperlinks
Andrew, I'll try to explain what I want with an example. I'm attaching an archive with the post - TestLinks.rar.
When you extract it you'll find two subfolder: "Help" and "TestLib". TestLib folder contains a solution with C# class library project. There are two types in this project: SomeUsefullType and SomeUselessType.
In TestLib folder you'll find a DocToHelp project. It contains one Word file - "TestLib Fundamentals.docx" and attached sandcastle plugin output. As plugin's source TestLib.dll specified.
The result of building this project is TestLinks.chm (in Help\HTMLHelp). If you open it you can see a conceptual part from the Word doc and a reference part from the sandcastle plugin.
In topic Introuduction/What TestLib (conceptual part) you'll find this text: "Hi, TestLib consists of some types. One of them is SomeUsefullType. Another one is SomeUselessType".
"SomeUsefullType" and "SomeUselessType" are names of types from TestLib library.
I want to make them as links reference to appropriate topic": topic "SomeUsefullType Class " and topic "SomeUselessType Class".
To do this I have to open the word document ("TestLib Fundamentals"), select type name ("SomeUselessType"), on tab "Doc-To-Help" choose "Link" and choose topic "SomeUselessType class" from the list of all topics in opened dialog. Yes, it works.
The idea I'm talking from the begining is to making links from type names without manual connecting a type name with topic from sandcastle plugin.
If you wonder why and what's a problem with this operation I can answer. The time. Just realize really big project. Not TestLib with two types but with 1000 types or more. And now try to realize finding appropriate topic in list of these 1000 types when we're going to make a link in some word document.
It's possible but totaly inconvenient.
Another problem is that to create a link to topic of reference documentation (produced by sandcastle plugin) we have to build entire project. But it's very time taken procedure for large project. In my project we build our help during nightly build but not localy.
Any chance to get any feedback? Did I manage to describe my desires? Did you understand them?
Hello everyone. Nice to meet you all.
pret auto